90c12bfeeff84ed250f37f1e4c8430ce98504d0d
[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 #include <Ecore_Con.h>
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 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1259
1260    /**
1261     * Set a label of an object item
1262     *
1263     * @param it The Elementary object item
1264     * @param part The text part name to set (NULL for the default label)
1265     * @param label The new text of the label
1266     *
1267     * @note Elementary object items may have many labels
1268     * @deprecated Use elm_object_item_part_text_set instead.
1269     * @ingroup General
1270     */
1271    WILL_DEPRECATE  EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1272
1273    /**
1274     * Set a label of an object item
1275     *
1276     * @param it The Elementary object item
1277     * @param part The text part name to set (NULL for the default label)
1278     * @param label The new text of the label
1279     *
1280     * @note Elementary object items may have many labels
1281     *
1282     * @ingroup General
1283     */
1284    EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1285
1286 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1287
1288    /**
1289     * Get a label of an object item
1290     *
1291     * @param it The Elementary object item
1292     * @param part The text part name to get (NULL for the default label)
1293     * @return text of the label or NULL for any error
1294     *
1295     * @note Elementary object items may have many labels
1296     * @deprecated Use elm_object_item_part_text_get instead.
1297     * @ingroup General
1298     */
1299    WILL_DEPRECATE  EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1300    /**
1301     * Get a label of an object item
1302     *
1303     * @param it The Elementary object item
1304     * @param part The text part name to get (NULL for the default label)
1305     * @return text of the label or NULL for any error
1306     *
1307     * @note Elementary object items may have many labels
1308     *
1309     * @ingroup General
1310     */
1311    EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1312
1313    /**
1314     * Set the text to read out when in accessibility mode
1315     *
1316     * @param obj The object which is to be described
1317     * @param txt The text that describes the widget to people with poor or no vision
1318     *
1319     * @ingroup General
1320     */
1321    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1322
1323    /**
1324     * Set the text to read out when in accessibility mode
1325     *
1326     * @param it The object item which is to be described
1327     * @param txt The text that describes the widget to people with poor or no vision
1328     *
1329     * @ingroup General
1330     */
1331    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1332
1333 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1334
1335    /**
1336     * Set the text to read out when in accessibility mode
1337     *
1338     * @param it The object item which is to be described
1339     * @param txt The text that describes the widget to people with poor or no vision
1340     *
1341     * @ingroup General
1342     */
1343    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1344
1345    /**
1346     * Get the data associated with an object item
1347     * @param it The Elementary object item
1348     * @return The data associated with @p it
1349     *
1350     * @ingroup General
1351     */
1352    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1353
1354    /**
1355     * Set the data associated with an object item
1356     * @param it The Elementary object item
1357     * @param data The data to be associated with @p it
1358     *
1359     * @ingroup General
1360     */
1361    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1362
1363    /**
1364     * Send a signal to the edje object of the widget item.
1365     *
1366     * This function sends a signal to the edje object of the obj item. An
1367     * edje program can respond to a signal by specifying matching
1368     * 'signal' and 'source' fields.
1369     *
1370     * @param it The Elementary object item
1371     * @param emission The signal's name.
1372     * @param source The signal's source.
1373     * @ingroup General
1374     */
1375    EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1376
1377    /**
1378     * Set the disabled state of an widget item.
1379     *
1380     * @param obj The Elementary object item
1381     * @param disabled The state to put in in: @c EINA_TRUE for
1382     *        disabled, @c EINA_FALSE for enabled
1383     *
1384     * Elementary object item can be @b disabled, in which state they won't
1385     * receive input and, in general, will be themed differently from
1386     * their normal state, usually greyed out. Useful for contexts
1387     * where you don't want your users to interact with some of the
1388     * parts of you interface.
1389     *
1390     * This sets the state for the widget item, either disabling it or
1391     * enabling it back.
1392     *
1393     * @ingroup Styles
1394     */
1395    EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1396
1397    /**
1398     * Get the disabled state of an widget item.
1399     *
1400     * @param obj The Elementary object
1401     * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1402     *            if it's enabled (or on errors)
1403     *
1404     * This gets the state of the widget, which might be enabled or disabled.
1405     *
1406     * @ingroup Styles
1407     */
1408    EAPI Eina_Bool    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1409
1410    /**
1411     * @}
1412     */
1413
1414    /**
1415     * @defgroup Caches Caches
1416     *
1417     * These are functions which let one fine-tune some cache values for
1418     * Elementary applications, thus allowing for performance adjustments.
1419     *
1420     * @{
1421     */
1422
1423    /**
1424     * @brief Flush all caches.
1425     *
1426     * Frees all data that was in cache and is not currently being used to reduce
1427     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1428     * to calling all of the following functions:
1429     * @li edje_file_cache_flush()
1430     * @li edje_collection_cache_flush()
1431     * @li eet_clearcache()
1432     * @li evas_image_cache_flush()
1433     * @li evas_font_cache_flush()
1434     * @li evas_render_dump()
1435     * @note Evas caches are flushed for every canvas associated with a window.
1436     *
1437     * @ingroup Caches
1438     */
1439    EAPI void         elm_all_flush(void);
1440
1441    /**
1442     * Get the configured cache flush interval time
1443     *
1444     * This gets the globally configured cache flush interval time, in
1445     * ticks
1446     *
1447     * @return The cache flush interval time
1448     * @ingroup Caches
1449     *
1450     * @see elm_all_flush()
1451     */
1452    EAPI int          elm_cache_flush_interval_get(void);
1453
1454    /**
1455     * Set the configured cache flush interval time
1456     *
1457     * This sets the globally configured cache flush interval time, in ticks
1458     *
1459     * @param size The cache flush interval time
1460     * @ingroup Caches
1461     *
1462     * @see elm_all_flush()
1463     */
1464    EAPI void         elm_cache_flush_interval_set(int size);
1465
1466    /**
1467     * Set the configured cache flush interval time for all applications on the
1468     * display
1469     *
1470     * This sets the globally configured cache flush interval time -- in ticks
1471     * -- for all applications on the display.
1472     *
1473     * @param size The cache flush interval time
1474     * @ingroup Caches
1475     */
1476    EAPI void         elm_cache_flush_interval_all_set(int size);
1477
1478    /**
1479     * Get the configured cache flush enabled state
1480     *
1481     * This gets the globally configured cache flush state - if it is enabled
1482     * or not. When cache flushing is enabled, elementary will regularly
1483     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1484     * memory and allow usage to re-seed caches and data in memory where it
1485     * can do so. An idle application will thus minimise its memory usage as
1486     * data will be freed from memory and not be re-loaded as it is idle and
1487     * not rendering or doing anything graphically right now.
1488     *
1489     * @return The cache flush state
1490     * @ingroup Caches
1491     *
1492     * @see elm_all_flush()
1493     */
1494    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1495
1496    /**
1497     * Set the configured cache flush enabled state
1498     *
1499     * This sets the globally configured cache flush enabled state.
1500     *
1501     * @param size The cache flush enabled state
1502     * @ingroup Caches
1503     *
1504     * @see elm_all_flush()
1505     */
1506    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1507
1508    /**
1509     * Set the configured cache flush enabled state for all applications on the
1510     * display
1511     *
1512     * This sets the globally configured cache flush enabled state for all
1513     * applications on the display.
1514     *
1515     * @param size The cache flush enabled state
1516     * @ingroup Caches
1517     */
1518    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1519
1520    /**
1521     * Get the configured font cache size
1522     *
1523     * This gets the globally configured font cache size, in bytes.
1524     *
1525     * @return The font cache size
1526     * @ingroup Caches
1527     */
1528    EAPI int          elm_font_cache_get(void);
1529
1530    /**
1531     * Set the configured font cache size
1532     *
1533     * This sets the globally configured font cache size, in bytes
1534     *
1535     * @param size The font cache size
1536     * @ingroup Caches
1537     */
1538    EAPI void         elm_font_cache_set(int size);
1539
1540    /**
1541     * Set the configured font cache size for all applications on the
1542     * display
1543     *
1544     * This sets the globally configured font cache size -- in bytes
1545     * -- for all applications on the display.
1546     *
1547     * @param size The font cache size
1548     * @ingroup Caches
1549     */
1550    EAPI void         elm_font_cache_all_set(int size);
1551
1552    /**
1553     * Get the configured image cache size
1554     *
1555     * This gets the globally configured image cache size, in bytes
1556     *
1557     * @return The image cache size
1558     * @ingroup Caches
1559     */
1560    EAPI int          elm_image_cache_get(void);
1561
1562    /**
1563     * Set the configured image cache size
1564     *
1565     * This sets the globally configured image cache size, in bytes
1566     *
1567     * @param size The image cache size
1568     * @ingroup Caches
1569     */
1570    EAPI void         elm_image_cache_set(int size);
1571
1572    /**
1573     * Set the configured image cache size for all applications on the
1574     * display
1575     *
1576     * This sets the globally configured image cache size -- in bytes
1577     * -- for all applications on the display.
1578     *
1579     * @param size The image cache size
1580     * @ingroup Caches
1581     */
1582    EAPI void         elm_image_cache_all_set(int size);
1583
1584    /**
1585     * Get the configured edje file cache size.
1586     *
1587     * This gets the globally configured edje file cache size, in number
1588     * of files.
1589     *
1590     * @return The edje file cache size
1591     * @ingroup Caches
1592     */
1593    EAPI int          elm_edje_file_cache_get(void);
1594
1595    /**
1596     * Set the configured edje file cache size
1597     *
1598     * This sets the globally configured edje file cache size, in number
1599     * of files.
1600     *
1601     * @param size The edje file cache size
1602     * @ingroup Caches
1603     */
1604    EAPI void         elm_edje_file_cache_set(int size);
1605
1606    /**
1607     * Set the configured edje file cache size for all applications on the
1608     * display
1609     *
1610     * This sets the globally configured edje file cache size -- in number
1611     * of files -- for all applications on the display.
1612     *
1613     * @param size The edje file cache size
1614     * @ingroup Caches
1615     */
1616    EAPI void         elm_edje_file_cache_all_set(int size);
1617
1618    /**
1619     * Get the configured edje collections (groups) cache size.
1620     *
1621     * This gets the globally configured edje collections cache size, in
1622     * number of collections.
1623     *
1624     * @return The edje collections cache size
1625     * @ingroup Caches
1626     */
1627    EAPI int          elm_edje_collection_cache_get(void);
1628
1629    /**
1630     * Set the configured edje collections (groups) cache size
1631     *
1632     * This sets the globally configured edje collections cache size, in
1633     * number of collections.
1634     *
1635     * @param size The edje collections cache size
1636     * @ingroup Caches
1637     */
1638    EAPI void         elm_edje_collection_cache_set(int size);
1639
1640    /**
1641     * Set the configured edje collections (groups) cache size for all
1642     * applications on the display
1643     *
1644     * This sets the globally configured edje collections cache size -- in
1645     * number of collections -- for all applications on the display.
1646     *
1647     * @param size The edje collections cache size
1648     * @ingroup Caches
1649     */
1650    EAPI void         elm_edje_collection_cache_all_set(int size);
1651
1652    /**
1653     * @}
1654     */
1655
1656    /**
1657     * @defgroup Scaling Widget Scaling
1658     *
1659     * Different widgets can be scaled independently. These functions
1660     * allow you to manipulate this scaling on a per-widget basis. The
1661     * object and all its children get their scaling factors multiplied
1662     * by the scale factor set. This is multiplicative, in that if a
1663     * child also has a scale size set it is in turn multiplied by its
1664     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1665     * double size, @c 0.5 is half, etc.
1666     *
1667     * @ref general_functions_example_page "This" example contemplates
1668     * some of these functions.
1669     */
1670
1671    /**
1672     * Get the global scaling factor
1673     *
1674     * This gets the globally configured scaling factor that is applied to all
1675     * objects.
1676     *
1677     * @return The scaling factor
1678     * @ingroup Scaling
1679     */
1680    EAPI double       elm_scale_get(void);
1681
1682    /**
1683     * Set the global scaling factor
1684     *
1685     * This sets the globally configured scaling factor that is applied to all
1686     * objects.
1687     *
1688     * @param scale The scaling factor to set
1689     * @ingroup Scaling
1690     */
1691    EAPI void         elm_scale_set(double scale);
1692
1693    /**
1694     * Set the global scaling factor for all applications on the display
1695     *
1696     * This sets the globally configured scaling factor that is applied to all
1697     * objects for all applications.
1698     * @param scale The scaling factor to set
1699     * @ingroup Scaling
1700     */
1701    EAPI void         elm_scale_all_set(double scale);
1702
1703    /**
1704     * Set the scaling factor for a given Elementary object
1705     *
1706     * @param obj The Elementary to operate on
1707     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1708     * no scaling)
1709     *
1710     * @ingroup Scaling
1711     */
1712    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1713
1714    /**
1715     * Get the scaling factor for a given Elementary object
1716     *
1717     * @param obj The object
1718     * @return The scaling factor set by elm_object_scale_set()
1719     *
1720     * @ingroup Scaling
1721     */
1722    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1723
1724    /**
1725     * @defgroup Password_last_show Password last input show
1726     *
1727     * Last show feature of password mode enables user to view
1728     * the last input entered for few seconds before masking it.
1729     * These functions allow to set this feature in password mode
1730     * of entry widget and also allow to manipulate the duration
1731     * for which the input has to be visible.
1732     *
1733     * @{
1734     */
1735
1736    /**
1737     * Get show last setting of password mode.
1738     *
1739     * This gets the show last input setting of password mode which might be
1740     * enabled or disabled.
1741     *
1742     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1743     *            if it's disabled.
1744     * @ingroup Password_last_show
1745     */
1746    EAPI Eina_Bool elm_password_show_last_get(void);
1747
1748    /**
1749     * Set show last setting in password mode.
1750     *
1751     * This enables or disables show last setting of password mode.
1752     *
1753     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1754     * @see elm_password_show_last_timeout_set()
1755     * @ingroup Password_last_show
1756     */
1757    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1758
1759    /**
1760     * Get's the timeout value in last show password mode.
1761     *
1762     * This gets the time out value for which the last input entered in password
1763     * mode will be visible.
1764     *
1765     * @return The timeout value of last show password mode.
1766     * @ingroup Password_last_show
1767     */
1768    EAPI double elm_password_show_last_timeout_get(void);
1769
1770    /**
1771     * Set's the timeout value in last show password mode.
1772     *
1773     * This sets the time out value for which the last input entered in password
1774     * mode will be visible.
1775     *
1776     * @param password_show_last_timeout The timeout value.
1777     * @see elm_password_show_last_set()
1778     * @ingroup Password_last_show
1779     */
1780    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1781
1782    /**
1783     * @}
1784     */
1785
1786    /**
1787     * @defgroup UI-Mirroring Selective Widget mirroring
1788     *
1789     * These functions allow you to set ui-mirroring on specific
1790     * widgets or the whole interface. Widgets can be in one of two
1791     * modes, automatic and manual.  Automatic means they'll be changed
1792     * according to the system mirroring mode and manual means only
1793     * explicit changes will matter. You are not supposed to change
1794     * mirroring state of a widget set to automatic, will mostly work,
1795     * but the behavior is not really defined.
1796     *
1797     * @{
1798     */
1799
1800    EAPI Eina_Bool    elm_mirrored_get(void);
1801    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1802
1803    /**
1804     * Get the system mirrored mode. This determines the default mirrored mode
1805     * of widgets.
1806     *
1807     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1808     */
1809    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1810
1811    /**
1812     * Set the system mirrored mode. This determines the default mirrored mode
1813     * of widgets.
1814     *
1815     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1816     */
1817    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1818
1819    /**
1820     * Returns the widget's mirrored mode setting.
1821     *
1822     * @param obj The widget.
1823     * @return mirrored mode setting of the object.
1824     *
1825     **/
1826    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1827
1828    /**
1829     * Sets the widget's mirrored mode setting.
1830     * When widget in automatic mode, it follows the system mirrored mode set by
1831     * elm_mirrored_set().
1832     * @param obj The widget.
1833     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1834     */
1835    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1836
1837    /**
1838     * @}
1839     */
1840
1841    /**
1842     * Set the style to use by a widget
1843     *
1844     * Sets the style name that will define the appearance of a widget. Styles
1845     * vary from widget to widget and may also be defined by other themes
1846     * by means of extensions and overlays.
1847     *
1848     * @param obj The Elementary widget to style
1849     * @param style The style name to use
1850     *
1851     * @see elm_theme_extension_add()
1852     * @see elm_theme_extension_del()
1853     * @see elm_theme_overlay_add()
1854     * @see elm_theme_overlay_del()
1855     *
1856     * @ingroup Styles
1857     */
1858    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1859    /**
1860     * Get the style used by the widget
1861     *
1862     * This gets the style being used for that widget. Note that the string
1863     * pointer is only valid as longas the object is valid and the style doesn't
1864     * change.
1865     *
1866     * @param obj The Elementary widget to query for its style
1867     * @return The style name used
1868     *
1869     * @see elm_object_style_set()
1870     *
1871     * @ingroup Styles
1872     */
1873    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1874
1875    /**
1876     * @defgroup Styles Styles
1877     *
1878     * Widgets can have different styles of look. These generic API's
1879     * set styles of widgets, if they support them (and if the theme(s)
1880     * do).
1881     *
1882     * @ref general_functions_example_page "This" example contemplates
1883     * some of these functions.
1884     */
1885
1886    /**
1887     * Set the disabled state of an Elementary object.
1888     *
1889     * @param obj The Elementary object to operate on
1890     * @param disabled The state to put in in: @c EINA_TRUE for
1891     *        disabled, @c EINA_FALSE for enabled
1892     *
1893     * Elementary objects can be @b disabled, in which state they won't
1894     * receive input and, in general, will be themed differently from
1895     * their normal state, usually greyed out. Useful for contexts
1896     * where you don't want your users to interact with some of the
1897     * parts of you interface.
1898     *
1899     * This sets the state for the widget, either disabling it or
1900     * enabling it back.
1901     *
1902     * @ingroup Styles
1903     */
1904    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1905
1906    /**
1907     * Get the disabled state of an Elementary object.
1908     *
1909     * @param obj The Elementary object to operate on
1910     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1911     *            if it's enabled (or on errors)
1912     *
1913     * This gets the state of the widget, which might be enabled or disabled.
1914     *
1915     * @ingroup Styles
1916     */
1917    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1918
1919    /**
1920     * @defgroup WidgetNavigation Widget Tree Navigation.
1921     *
1922     * How to check if an Evas Object is an Elementary widget? How to
1923     * get the first elementary widget that is parent of the given
1924     * object?  These are all covered in widget tree navigation.
1925     *
1926     * @ref general_functions_example_page "This" example contemplates
1927     * some of these functions.
1928     */
1929
1930    /**
1931     * Check if the given Evas Object is an Elementary widget.
1932     *
1933     * @param obj the object to query.
1934     * @return @c EINA_TRUE if it is an elementary widget variant,
1935     *         @c EINA_FALSE otherwise
1936     * @ingroup WidgetNavigation
1937     */
1938    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1939
1940    /**
1941     * Get the first parent of the given object that is an Elementary
1942     * widget.
1943     *
1944     * @param obj the Elementary object to query parent from.
1945     * @return the parent object that is an Elementary widget, or @c
1946     *         NULL, if it was not found.
1947     *
1948     * Use this to query for an object's parent widget.
1949     *
1950     * @note Most of Elementary users wouldn't be mixing non-Elementary
1951     * smart objects in the objects tree of an application, as this is
1952     * an advanced usage of Elementary with Evas. So, except for the
1953     * application's window, which is the root of that tree, all other
1954     * objects would have valid Elementary widget parents.
1955     *
1956     * @ingroup WidgetNavigation
1957     */
1958    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1959
1960    /**
1961     * Get the top level parent of an Elementary widget.
1962     *
1963     * @param obj The object to query.
1964     * @return The top level Elementary widget, or @c NULL if parent cannot be
1965     * found.
1966     * @ingroup WidgetNavigation
1967     */
1968    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1969
1970    /**
1971     * Get the string that represents this Elementary widget.
1972     *
1973     * @note Elementary is weird and exposes itself as a single
1974     *       Evas_Object_Smart_Class of type "elm_widget", so
1975     *       evas_object_type_get() always return that, making debug and
1976     *       language bindings hard. This function tries to mitigate this
1977     *       problem, but the solution is to change Elementary to use
1978     *       proper inheritance.
1979     *
1980     * @param obj the object to query.
1981     * @return Elementary widget name, or @c NULL if not a valid widget.
1982     * @ingroup WidgetNavigation
1983     */
1984    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1985
1986    /**
1987     * @defgroup Config Elementary Config
1988     *
1989     * Elementary configuration is formed by a set options bounded to a
1990     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1991     * "finger size", etc. These are functions with which one syncronizes
1992     * changes made to those values to the configuration storing files, de
1993     * facto. You most probably don't want to use the functions in this
1994     * group unlees you're writing an elementary configuration manager.
1995     *
1996     * @{
1997     */
1998
1999    /**
2000     * Save back Elementary's configuration, so that it will persist on
2001     * future sessions.
2002     *
2003     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2004     * @ingroup Config
2005     *
2006     * This function will take effect -- thus, do I/O -- immediately. Use
2007     * it when you want to apply all configuration changes at once. The
2008     * current configuration set will get saved onto the current profile
2009     * configuration file.
2010     *
2011     */
2012    EAPI Eina_Bool    elm_config_save(void);
2013
2014    /**
2015     * Reload Elementary's configuration, bounded to current selected
2016     * profile.
2017     *
2018     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2019     * @ingroup Config
2020     *
2021     * Useful when you want to force reloading of configuration values for
2022     * a profile. If one removes user custom configuration directories,
2023     * for example, it will force a reload with system values instead.
2024     *
2025     */
2026    EAPI void         elm_config_reload(void);
2027
2028    /**
2029     * @}
2030     */
2031
2032    /**
2033     * @defgroup Profile Elementary Profile
2034     *
2035     * Profiles are pre-set options that affect the whole look-and-feel of
2036     * Elementary-based applications. There are, for example, profiles
2037     * aimed at desktop computer applications and others aimed at mobile,
2038     * touchscreen-based ones. You most probably don't want to use the
2039     * functions in this group unlees you're writing an elementary
2040     * configuration manager.
2041     *
2042     * @{
2043     */
2044
2045    /**
2046     * Get Elementary's profile in use.
2047     *
2048     * This gets the global profile that is applied to all Elementary
2049     * applications.
2050     *
2051     * @return The profile's name
2052     * @ingroup Profile
2053     */
2054    EAPI const char  *elm_profile_current_get(void);
2055
2056    /**
2057     * Get an Elementary's profile directory path in the filesystem. One
2058     * may want to fetch a system profile's dir or an user one (fetched
2059     * inside $HOME).
2060     *
2061     * @param profile The profile's name
2062     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2063     *                or a system one (@c EINA_FALSE)
2064     * @return The profile's directory path.
2065     * @ingroup Profile
2066     *
2067     * @note You must free it with elm_profile_dir_free().
2068     */
2069    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2070
2071    /**
2072     * Free an Elementary's profile directory path, as returned by
2073     * elm_profile_dir_get().
2074     *
2075     * @param p_dir The profile's path
2076     * @ingroup Profile
2077     *
2078     */
2079    EAPI void         elm_profile_dir_free(const char *p_dir);
2080
2081    /**
2082     * Get Elementary's list of available profiles.
2083     *
2084     * @return The profiles list. List node data are the profile name
2085     *         strings.
2086     * @ingroup Profile
2087     *
2088     * @note One must free this list, after usage, with the function
2089     *       elm_profile_list_free().
2090     */
2091    EAPI Eina_List   *elm_profile_list_get(void);
2092
2093    /**
2094     * Free Elementary's list of available profiles.
2095     *
2096     * @param l The profiles list, as returned by elm_profile_list_get().
2097     * @ingroup Profile
2098     *
2099     */
2100    EAPI void         elm_profile_list_free(Eina_List *l);
2101
2102    /**
2103     * Set Elementary's profile.
2104     *
2105     * This sets the global profile that is applied to Elementary
2106     * applications. Just the process the call comes from will be
2107     * affected.
2108     *
2109     * @param profile The profile's name
2110     * @ingroup Profile
2111     *
2112     */
2113    EAPI void         elm_profile_set(const char *profile);
2114
2115    /**
2116     * Set Elementary's profile.
2117     *
2118     * This sets the global profile that is applied to all Elementary
2119     * applications. All running Elementary windows will be affected.
2120     *
2121     * @param profile The profile's name
2122     * @ingroup Profile
2123     *
2124     */
2125    EAPI void         elm_profile_all_set(const char *profile);
2126
2127    /**
2128     * @}
2129     */
2130
2131    /**
2132     * @defgroup Engine Elementary Engine
2133     *
2134     * These are functions setting and querying which rendering engine
2135     * Elementary will use for drawing its windows' pixels.
2136     *
2137     * The following are the available engines:
2138     * @li "software_x11"
2139     * @li "fb"
2140     * @li "directfb"
2141     * @li "software_16_x11"
2142     * @li "software_8_x11"
2143     * @li "xrender_x11"
2144     * @li "opengl_x11"
2145     * @li "software_gdi"
2146     * @li "software_16_wince_gdi"
2147     * @li "sdl"
2148     * @li "software_16_sdl"
2149     * @li "opengl_sdl"
2150     * @li "buffer"
2151     * @li "ews"
2152     * @li "opengl_cocoa"
2153     * @li "psl1ght"
2154     *
2155     * @{
2156     */
2157
2158    /**
2159     * @brief Get Elementary's rendering engine in use.
2160     *
2161     * @return The rendering engine's name
2162     * @note there's no need to free the returned string, here.
2163     *
2164     * This gets the global rendering engine that is applied to all Elementary
2165     * applications.
2166     *
2167     * @see elm_engine_set()
2168     */
2169    EAPI const char  *elm_engine_current_get(void);
2170
2171    /**
2172     * @brief Set Elementary's rendering engine for use.
2173     *
2174     * @param engine The rendering engine's name
2175     *
2176     * This sets global rendering engine that is applied to all Elementary
2177     * applications. Note that it will take effect only to Elementary windows
2178     * created after this is called.
2179     *
2180     * @see elm_win_add()
2181     */
2182    EAPI void         elm_engine_set(const char *engine);
2183
2184    /**
2185     * @}
2186     */
2187
2188    /**
2189     * @defgroup Fonts Elementary Fonts
2190     *
2191     * These are functions dealing with font rendering, selection and the
2192     * like for Elementary applications. One might fetch which system
2193     * fonts are there to use and set custom fonts for individual classes
2194     * of UI items containing text (text classes).
2195     *
2196     * @{
2197     */
2198
2199   typedef struct _Elm_Text_Class
2200     {
2201        const char *name;
2202        const char *desc;
2203     } Elm_Text_Class;
2204
2205   typedef struct _Elm_Font_Overlay
2206     {
2207        const char     *text_class;
2208        const char     *font;
2209        Evas_Font_Size  size;
2210     } Elm_Font_Overlay;
2211
2212   typedef struct _Elm_Font_Properties
2213     {
2214        const char *name;
2215        Eina_List  *styles;
2216     } Elm_Font_Properties;
2217
2218    /**
2219     * Get Elementary's list of supported text classes.
2220     *
2221     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2222     * @ingroup Fonts
2223     *
2224     * Release the list with elm_text_classes_list_free().
2225     */
2226    EAPI const Eina_List     *elm_text_classes_list_get(void);
2227
2228    /**
2229     * Free Elementary's list of supported text classes.
2230     *
2231     * @ingroup Fonts
2232     *
2233     * @see elm_text_classes_list_get().
2234     */
2235    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2236
2237    /**
2238     * Get Elementary's list of font overlays, set with
2239     * elm_font_overlay_set().
2240     *
2241     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2242     * data.
2243     *
2244     * @ingroup Fonts
2245     *
2246     * For each text class, one can set a <b>font overlay</b> for it,
2247     * overriding the default font properties for that class coming from
2248     * the theme in use. There is no need to free this list.
2249     *
2250     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2251     */
2252    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2253
2254    /**
2255     * Set a font overlay for a given Elementary text class.
2256     *
2257     * @param text_class Text class name
2258     * @param font Font name and style string
2259     * @param size Font size
2260     *
2261     * @ingroup Fonts
2262     *
2263     * @p font has to be in the format returned by
2264     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2265     * and elm_font_overlay_unset().
2266     */
2267    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2268
2269    /**
2270     * Unset a font overlay for a given Elementary text class.
2271     *
2272     * @param text_class Text class name
2273     *
2274     * @ingroup Fonts
2275     *
2276     * This will bring back text elements belonging to text class
2277     * @p text_class back to their default font settings.
2278     */
2279    EAPI void                 elm_font_overlay_unset(const char *text_class);
2280
2281    /**
2282     * Apply the changes made with elm_font_overlay_set() and
2283     * elm_font_overlay_unset() on the current Elementary window.
2284     *
2285     * @ingroup Fonts
2286     *
2287     * This applies all font overlays set to all objects in the UI.
2288     */
2289    EAPI void                 elm_font_overlay_apply(void);
2290
2291    /**
2292     * Apply the changes made with elm_font_overlay_set() and
2293     * elm_font_overlay_unset() on all Elementary application windows.
2294     *
2295     * @ingroup Fonts
2296     *
2297     * This applies all font overlays set to all objects in the UI.
2298     */
2299    EAPI void                 elm_font_overlay_all_apply(void);
2300
2301    /**
2302     * Translate a font (family) name string in fontconfig's font names
2303     * syntax into an @c Elm_Font_Properties struct.
2304     *
2305     * @param font The font name and styles string
2306     * @return the font properties struct
2307     *
2308     * @ingroup Fonts
2309     *
2310     * @note The reverse translation can be achived with
2311     * elm_font_fontconfig_name_get(), for one style only (single font
2312     * instance, not family).
2313     */
2314    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2315
2316    /**
2317     * Free font properties return by elm_font_properties_get().
2318     *
2319     * @param efp the font properties struct
2320     *
2321     * @ingroup Fonts
2322     */
2323    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2324
2325    /**
2326     * Translate a font name, bound to a style, into fontconfig's font names
2327     * syntax.
2328     *
2329     * @param name The font (family) name
2330     * @param style The given style (may be @c NULL)
2331     *
2332     * @return the font name and style string
2333     *
2334     * @ingroup Fonts
2335     *
2336     * @note The reverse translation can be achived with
2337     * elm_font_properties_get(), for one style only (single font
2338     * instance, not family).
2339     */
2340    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2341
2342    /**
2343     * Free the font string return by elm_font_fontconfig_name_get().
2344     *
2345     * @param efp the font properties struct
2346     *
2347     * @ingroup Fonts
2348     */
2349    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2350
2351    /**
2352     * Create a font hash table of available system fonts.
2353     *
2354     * One must call it with @p list being the return value of
2355     * evas_font_available_list(). The hash will be indexed by font
2356     * (family) names, being its values @c Elm_Font_Properties blobs.
2357     *
2358     * @param list The list of available system fonts, as returned by
2359     * evas_font_available_list().
2360     * @return the font hash.
2361     *
2362     * @ingroup Fonts
2363     *
2364     * @note The user is supposed to get it populated at least with 3
2365     * default font families (Sans, Serif, Monospace), which should be
2366     * present on most systems.
2367     */
2368    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2369
2370    /**
2371     * Free the hash return by elm_font_available_hash_add().
2372     *
2373     * @param hash the hash to be freed.
2374     *
2375     * @ingroup Fonts
2376     */
2377    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2378
2379    /**
2380     * @}
2381     */
2382
2383    /**
2384     * @defgroup Fingers Fingers
2385     *
2386     * Elementary is designed to be finger-friendly for touchscreens,
2387     * and so in addition to scaling for display resolution, it can
2388     * also scale based on finger "resolution" (or size). You can then
2389     * customize the granularity of the areas meant to receive clicks
2390     * on touchscreens.
2391     *
2392     * Different profiles may have pre-set values for finger sizes.
2393     *
2394     * @ref general_functions_example_page "This" example contemplates
2395     * some of these functions.
2396     *
2397     * @{
2398     */
2399
2400    /**
2401     * Get the configured "finger size"
2402     *
2403     * @return The finger size
2404     *
2405     * This gets the globally configured finger size, <b>in pixels</b>
2406     *
2407     * @ingroup Fingers
2408     */
2409    EAPI Evas_Coord       elm_finger_size_get(void);
2410
2411    /**
2412     * Set the configured finger size
2413     *
2414     * This sets the globally configured finger size in pixels
2415     *
2416     * @param size The finger size
2417     * @ingroup Fingers
2418     */
2419    EAPI void             elm_finger_size_set(Evas_Coord size);
2420
2421    /**
2422     * Set the configured finger size for all applications on the display
2423     *
2424     * This sets the globally configured finger size in pixels for all
2425     * applications on the display
2426     *
2427     * @param size The finger size
2428     * @ingroup Fingers
2429     */
2430    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2431
2432    /**
2433     * @}
2434     */
2435
2436    /**
2437     * @defgroup Focus Focus
2438     *
2439     * An Elementary application has, at all times, one (and only one)
2440     * @b focused object. This is what determines where the input
2441     * events go to within the application's window. Also, focused
2442     * objects can be decorated differently, in order to signal to the
2443     * user where the input is, at a given moment.
2444     *
2445     * Elementary applications also have the concept of <b>focus
2446     * chain</b>: one can cycle through all the windows' focusable
2447     * objects by input (tab key) or programmatically. The default
2448     * focus chain for an application is the one define by the order in
2449     * which the widgets where added in code. One will cycle through
2450     * top level widgets, and, for each one containg sub-objects, cycle
2451     * through them all, before returning to the level
2452     * above. Elementary also allows one to set @b custom focus chains
2453     * for their applications.
2454     *
2455     * Besides the focused decoration a widget may exhibit, when it
2456     * gets focus, Elementary has a @b global focus highlight object
2457     * that can be enabled for a window. If one chooses to do so, this
2458     * extra highlight effect will surround the current focused object,
2459     * too.
2460     *
2461     * @note Some Elementary widgets are @b unfocusable, after
2462     * creation, by their very nature: they are not meant to be
2463     * interacted with input events, but are there just for visual
2464     * purposes.
2465     *
2466     * @ref general_functions_example_page "This" example contemplates
2467     * some of these functions.
2468     */
2469
2470    /**
2471     * Get the enable status of the focus highlight
2472     *
2473     * This gets whether the highlight on focused objects is enabled or not
2474     * @ingroup Focus
2475     */
2476    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2477
2478    /**
2479     * Set the enable status of the focus highlight
2480     *
2481     * Set whether to show or not the highlight on focused objects
2482     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2483     * @ingroup Focus
2484     */
2485    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2486
2487    /**
2488     * Get the enable status of the highlight animation
2489     *
2490     * Get whether the focus highlight, if enabled, will animate its switch from
2491     * one object to the next
2492     * @ingroup Focus
2493     */
2494    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2495
2496    /**
2497     * Set the enable status of the highlight animation
2498     *
2499     * Set whether the focus highlight, if enabled, will animate its switch from
2500     * one object to the next
2501     * @param animate Enable animation if EINA_TRUE, disable otherwise
2502     * @ingroup Focus
2503     */
2504    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2505
2506    /**
2507     * Get the whether an Elementary object has the focus or not.
2508     *
2509     * @param obj The Elementary object to get the information from
2510     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2511     *            not (and on errors).
2512     *
2513     * @see elm_object_focus_set()
2514     *
2515     * @ingroup Focus
2516     */
2517    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2518
2519    /**
2520     * Set/unset focus to a given Elementary object.
2521     *
2522     * @param obj The Elementary object to operate on.
2523     * @param enable @c EINA_TRUE Set focus to a given object,
2524     *               @c EINA_FALSE Unset focus to a given object.
2525     *
2526     * @note When you set focus to this object, if it can handle focus, will
2527     * take the focus away from the one who had it previously and will, for
2528     * now on, be the one receiving input events. Unsetting focus will remove
2529     * the focus from @p obj, passing it back to the previous element in the
2530     * focus chain list.
2531     *
2532     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2533     *
2534     * @ingroup Focus
2535     */
2536    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2537
2538    /**
2539     * Make a given Elementary object the focused one.
2540     *
2541     * @param obj The Elementary object to make focused.
2542     *
2543     * @note This object, if it can handle focus, will take the focus
2544     * away from the one who had it previously and will, for now on, be
2545     * the one receiving input events.
2546     *
2547     * @see elm_object_focus_get()
2548     * @deprecated use elm_object_focus_set() instead.
2549     *
2550     * @ingroup Focus
2551     */
2552    WILL_DEPRECATE  EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2553
2554    /**
2555     * Remove the focus from an Elementary object
2556     *
2557     * @param obj The Elementary to take focus from
2558     *
2559     * This removes the focus from @p obj, passing it back to the
2560     * previous element in the focus chain list.
2561     *
2562     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2563     * @deprecated use elm_object_focus_set() instead.
2564     *
2565     * @ingroup Focus
2566     */
2567    WILL_DEPRECATE  EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2568
2569    /**
2570     * Set the ability for an Element object to be focused
2571     *
2572     * @param obj The Elementary object to operate on
2573     * @param enable @c EINA_TRUE if the object can be focused, @c
2574     *        EINA_FALSE if not (and on errors)
2575     *
2576     * This sets whether the object @p obj is able to take focus or
2577     * not. Unfocusable objects do nothing when programmatically
2578     * focused, being the nearest focusable parent object the one
2579     * really getting focus. Also, when they receive mouse input, they
2580     * will get the event, but not take away the focus from where it
2581     * was previously.
2582     *
2583     * @ingroup Focus
2584     */
2585    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2586
2587    /**
2588     * Get whether an Elementary object is focusable or not
2589     *
2590     * @param obj The Elementary object to operate on
2591     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2592     *             EINA_FALSE if not (and on errors)
2593     *
2594     * @note Objects which are meant to be interacted with by input
2595     * events are created able to be focused, by default. All the
2596     * others are not.
2597     *
2598     * @ingroup Focus
2599     */
2600    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2601
2602    /**
2603     * Set custom focus chain.
2604     *
2605     * This function overwrites any previous custom focus chain within
2606     * the list of objects. The previous list will be deleted and this list
2607     * will be managed by elementary. After it is set, don't modify it.
2608     *
2609     * @note On focus cycle, only will be evaluated children of this container.
2610     *
2611     * @param obj The container object
2612     * @param objs Chain of objects to pass focus
2613     * @ingroup Focus
2614     */
2615    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2616
2617    /**
2618     * Unset a custom focus chain on a given Elementary widget
2619     *
2620     * @param obj The container object to remove focus chain from
2621     *
2622     * Any focus chain previously set on @p obj (for its child objects)
2623     * is removed entirely after this call.
2624     *
2625     * @ingroup Focus
2626     */
2627    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2628
2629    /**
2630     * Get custom focus chain
2631     *
2632     * @param obj The container object
2633     * @ingroup Focus
2634     */
2635    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2636
2637    /**
2638     * Append object to custom focus chain.
2639     *
2640     * @note If relative_child equal to NULL or not in custom chain, the object
2641     * will be added in end.
2642     *
2643     * @note On focus cycle, only will be evaluated children of this container.
2644     *
2645     * @param obj The container object
2646     * @param child The child to be added in custom chain
2647     * @param relative_child The relative object to position the child
2648     * @ingroup Focus
2649     */
2650    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2651
2652    /**
2653     * Prepend object to custom focus chain.
2654     *
2655     * @note If relative_child equal to NULL or not in custom chain, the object
2656     * will be added in begin.
2657     *
2658     * @note On focus cycle, only will be evaluated children of this container.
2659     *
2660     * @param obj The container object
2661     * @param child The child to be added in custom chain
2662     * @param relative_child The relative object to position the child
2663     * @ingroup Focus
2664     */
2665    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2666
2667    /**
2668     * Give focus to next object in object tree.
2669     *
2670     * Give focus to next object in focus chain of one object sub-tree.
2671     * If the last object of chain already have focus, the focus will go to the
2672     * first object of chain.
2673     *
2674     * @param obj The object root of sub-tree
2675     * @param dir Direction to cycle the focus
2676     *
2677     * @ingroup Focus
2678     */
2679    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2680
2681    /**
2682     * Give focus to near object in one direction.
2683     *
2684     * Give focus to near object in direction of one object.
2685     * If none focusable object in given direction, the focus will not change.
2686     *
2687     * @param obj The reference object
2688     * @param x Horizontal component of direction to focus
2689     * @param y Vertical component of direction to focus
2690     *
2691     * @ingroup Focus
2692     */
2693    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2694
2695    /**
2696     * Make the elementary object and its children to be unfocusable
2697     * (or focusable).
2698     *
2699     * @param obj The Elementary object to operate on
2700     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2701     *        @c EINA_FALSE for focusable.
2702     *
2703     * This sets whether the object @p obj and its children objects
2704     * are able to take focus or not. If the tree is set as unfocusable,
2705     * newest focused object which is not in this tree will get focus.
2706     * This API can be helpful for an object to be deleted.
2707     * When an object will be deleted soon, it and its children may not
2708     * want to get focus (by focus reverting or by other focus controls).
2709     * Then, just use this API before deleting.
2710     *
2711     * @see elm_object_tree_unfocusable_get()
2712     *
2713     * @ingroup Focus
2714     */
2715    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2716
2717    /**
2718     * Get whether an Elementary object and its children are unfocusable or not.
2719     *
2720     * @param obj The Elementary object to get the information from
2721     * @return @c EINA_TRUE, if the tree is unfocussable,
2722     *         @c EINA_FALSE if not (and on errors).
2723     *
2724     * @see elm_object_tree_unfocusable_set()
2725     *
2726     * @ingroup Focus
2727     */
2728    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2729
2730    /**
2731     * @defgroup Scrolling Scrolling
2732     *
2733     * These are functions setting how scrollable views in Elementary
2734     * widgets should behave on user interaction.
2735     *
2736     * @{
2737     */
2738
2739    /**
2740     * Get whether scrollers should bounce when they reach their
2741     * viewport's edge during a scroll.
2742     *
2743     * @return the thumb scroll bouncing state
2744     *
2745     * This is the default behavior for touch screens, in general.
2746     * @ingroup Scrolling
2747     */
2748    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2749
2750    /**
2751     * Set whether scrollers should bounce when they reach their
2752     * viewport's edge during a scroll.
2753     *
2754     * @param enabled the thumb scroll bouncing state
2755     *
2756     * @see elm_thumbscroll_bounce_enabled_get()
2757     * @ingroup Scrolling
2758     */
2759    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2760
2761    /**
2762     * Set whether scrollers should bounce when they reach their
2763     * viewport's edge during a scroll, for all Elementary application
2764     * windows.
2765     *
2766     * @param enabled the thumb scroll bouncing state
2767     *
2768     * @see elm_thumbscroll_bounce_enabled_get()
2769     * @ingroup Scrolling
2770     */
2771    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2772
2773    /**
2774     * Get the amount of inertia a scroller will impose at bounce
2775     * animations.
2776     *
2777     * @return the thumb scroll bounce friction
2778     *
2779     * @ingroup Scrolling
2780     */
2781    EAPI double           elm_scroll_bounce_friction_get(void);
2782
2783    /**
2784     * Set the amount of inertia a scroller will impose at bounce
2785     * animations.
2786     *
2787     * @param friction the thumb scroll bounce friction
2788     *
2789     * @see elm_thumbscroll_bounce_friction_get()
2790     * @ingroup Scrolling
2791     */
2792    EAPI void             elm_scroll_bounce_friction_set(double friction);
2793
2794    /**
2795     * Set the amount of inertia a scroller will impose at bounce
2796     * animations, for all Elementary application windows.
2797     *
2798     * @param friction the thumb scroll bounce friction
2799     *
2800     * @see elm_thumbscroll_bounce_friction_get()
2801     * @ingroup Scrolling
2802     */
2803    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2804
2805    /**
2806     * Get the amount of inertia a <b>paged</b> scroller will impose at
2807     * page fitting animations.
2808     *
2809     * @return the page scroll friction
2810     *
2811     * @ingroup Scrolling
2812     */
2813    EAPI double           elm_scroll_page_scroll_friction_get(void);
2814
2815    /**
2816     * Set the amount of inertia a <b>paged</b> scroller will impose at
2817     * page fitting animations.
2818     *
2819     * @param friction the page scroll friction
2820     *
2821     * @see elm_thumbscroll_page_scroll_friction_get()
2822     * @ingroup Scrolling
2823     */
2824    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2825
2826    /**
2827     * Set the amount of inertia a <b>paged</b> scroller will impose at
2828     * page fitting animations, for all Elementary application windows.
2829     *
2830     * @param friction the page scroll friction
2831     *
2832     * @see elm_thumbscroll_page_scroll_friction_get()
2833     * @ingroup Scrolling
2834     */
2835    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2836
2837    /**
2838     * Get the amount of inertia a scroller will impose at region bring
2839     * animations.
2840     *
2841     * @return the bring in scroll friction
2842     *
2843     * @ingroup Scrolling
2844     */
2845    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2846
2847    /**
2848     * Set the amount of inertia a scroller will impose at region bring
2849     * animations.
2850     *
2851     * @param friction the bring in scroll friction
2852     *
2853     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2854     * @ingroup Scrolling
2855     */
2856    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2857
2858    /**
2859     * Set the amount of inertia a scroller will impose at region bring
2860     * animations, for all Elementary application windows.
2861     *
2862     * @param friction the bring in scroll friction
2863     *
2864     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2865     * @ingroup Scrolling
2866     */
2867    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2868
2869    /**
2870     * Get the amount of inertia scrollers will impose at animations
2871     * triggered by Elementary widgets' zooming API.
2872     *
2873     * @return the zoom friction
2874     *
2875     * @ingroup Scrolling
2876     */
2877    EAPI double           elm_scroll_zoom_friction_get(void);
2878
2879    /**
2880     * Set the amount of inertia scrollers will impose at animations
2881     * triggered by Elementary widgets' zooming API.
2882     *
2883     * @param friction the zoom friction
2884     *
2885     * @see elm_thumbscroll_zoom_friction_get()
2886     * @ingroup Scrolling
2887     */
2888    EAPI void             elm_scroll_zoom_friction_set(double friction);
2889
2890    /**
2891     * Set the amount of inertia scrollers will impose at animations
2892     * triggered by Elementary widgets' zooming API, for all Elementary
2893     * application windows.
2894     *
2895     * @param friction the zoom friction
2896     *
2897     * @see elm_thumbscroll_zoom_friction_get()
2898     * @ingroup Scrolling
2899     */
2900    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2901
2902    /**
2903     * Get whether scrollers should be draggable from any point in their
2904     * views.
2905     *
2906     * @return the thumb scroll state
2907     *
2908     * @note This is the default behavior for touch screens, in general.
2909     * @note All other functions namespaced with "thumbscroll" will only
2910     *       have effect if this mode is enabled.
2911     *
2912     * @ingroup Scrolling
2913     */
2914    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2915
2916    /**
2917     * Set whether scrollers should be draggable from any point in their
2918     * views.
2919     *
2920     * @param enabled the thumb scroll state
2921     *
2922     * @see elm_thumbscroll_enabled_get()
2923     * @ingroup Scrolling
2924     */
2925    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2926
2927    /**
2928     * Set whether scrollers should be draggable from any point in their
2929     * views, for all Elementary application windows.
2930     *
2931     * @param enabled the thumb scroll state
2932     *
2933     * @see elm_thumbscroll_enabled_get()
2934     * @ingroup Scrolling
2935     */
2936    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2937
2938    /**
2939     * Get the number of pixels one should travel while dragging a
2940     * scroller's view to actually trigger scrolling.
2941     *
2942     * @return the thumb scroll threshould
2943     *
2944     * One would use higher values for touch screens, in general, because
2945     * of their inherent imprecision.
2946     * @ingroup Scrolling
2947     */
2948    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2949
2950    /**
2951     * Set the number of pixels one should travel while dragging a
2952     * scroller's view to actually trigger scrolling.
2953     *
2954     * @param threshold the thumb scroll threshould
2955     *
2956     * @see elm_thumbscroll_threshould_get()
2957     * @ingroup Scrolling
2958     */
2959    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2960
2961    /**
2962     * Set the number of pixels one should travel while dragging a
2963     * scroller's view to actually trigger scrolling, for all Elementary
2964     * application windows.
2965     *
2966     * @param threshold the thumb scroll threshould
2967     *
2968     * @see elm_thumbscroll_threshould_get()
2969     * @ingroup Scrolling
2970     */
2971    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2972
2973    /**
2974     * Get the minimum speed of mouse cursor movement which will trigger
2975     * list self scrolling animation after a mouse up event
2976     * (pixels/second).
2977     *
2978     * @return the thumb scroll momentum threshould
2979     *
2980     * @ingroup Scrolling
2981     */
2982    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2983
2984    /**
2985     * Set the minimum speed of mouse cursor movement which will trigger
2986     * list self scrolling animation after a mouse up event
2987     * (pixels/second).
2988     *
2989     * @param threshold the thumb scroll momentum threshould
2990     *
2991     * @see elm_thumbscroll_momentum_threshould_get()
2992     * @ingroup Scrolling
2993     */
2994    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2995
2996    /**
2997     * Set the minimum speed of mouse cursor movement which will trigger
2998     * list self scrolling animation after a mouse up event
2999     * (pixels/second), for all Elementary application windows.
3000     *
3001     * @param threshold the thumb scroll momentum threshould
3002     *
3003     * @see elm_thumbscroll_momentum_threshould_get()
3004     * @ingroup Scrolling
3005     */
3006    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3007
3008    /**
3009     * Get the amount of inertia a scroller will impose at self scrolling
3010     * animations.
3011     *
3012     * @return the thumb scroll friction
3013     *
3014     * @ingroup Scrolling
3015     */
3016    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3017
3018    /**
3019     * Set the amount of inertia a scroller will impose at self scrolling
3020     * animations.
3021     *
3022     * @param friction the thumb scroll friction
3023     *
3024     * @see elm_thumbscroll_friction_get()
3025     * @ingroup Scrolling
3026     */
3027    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3028
3029    /**
3030     * Set the amount of inertia a scroller will impose at self scrolling
3031     * animations, for all Elementary application windows.
3032     *
3033     * @param friction the thumb scroll friction
3034     *
3035     * @see elm_thumbscroll_friction_get()
3036     * @ingroup Scrolling
3037     */
3038    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3039
3040    /**
3041     * Get the amount of lag between your actual mouse cursor dragging
3042     * movement and a scroller's view movement itself, while pushing it
3043     * into bounce state manually.
3044     *
3045     * @return the thumb scroll border friction
3046     *
3047     * @ingroup Scrolling
3048     */
3049    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3050
3051    /**
3052     * Set the amount of lag between your actual mouse cursor dragging
3053     * movement and a scroller's view movement itself, while pushing it
3054     * into bounce state manually.
3055     *
3056     * @param friction the thumb scroll border friction. @c 0.0 for
3057     *        perfect synchrony between two movements, @c 1.0 for maximum
3058     *        lag.
3059     *
3060     * @see elm_thumbscroll_border_friction_get()
3061     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3062     *
3063     * @ingroup Scrolling
3064     */
3065    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3066
3067    /**
3068     * Set the amount of lag between your actual mouse cursor dragging
3069     * movement and a scroller's view movement itself, while pushing it
3070     * into bounce state manually, for all Elementary application windows.
3071     *
3072     * @param friction the thumb scroll border friction. @c 0.0 for
3073     *        perfect synchrony between two movements, @c 1.0 for maximum
3074     *        lag.
3075     *
3076     * @see elm_thumbscroll_border_friction_get()
3077     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3078     *
3079     * @ingroup Scrolling
3080     */
3081    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3082
3083    /**
3084     * Get the sensitivity amount which is be multiplied by the length of
3085     * mouse dragging.
3086     *
3087     * @return the thumb scroll sensitivity friction
3088     *
3089     * @ingroup Scrolling
3090     */
3091    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3092
3093    /**
3094     * Set the sensitivity amount which is be multiplied by the length of
3095     * mouse dragging.
3096     *
3097     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3098     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3099     *        is proper.
3100     *
3101     * @see elm_thumbscroll_sensitivity_friction_get()
3102     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3103     *
3104     * @ingroup Scrolling
3105     */
3106    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3107
3108    /**
3109     * Set the sensitivity amount which is be multiplied by the length of
3110     * mouse dragging, for all Elementary application windows.
3111     *
3112     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3113     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3114     *        is proper.
3115     *
3116     * @see elm_thumbscroll_sensitivity_friction_get()
3117     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3118     *
3119     * @ingroup Scrolling
3120     */
3121    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3122
3123    /**
3124     * @}
3125     */
3126
3127    /**
3128     * @defgroup Scrollhints Scrollhints
3129     *
3130     * Objects when inside a scroller can scroll, but this may not always be
3131     * desirable in certain situations. This allows an object to hint to itself
3132     * and parents to "not scroll" in one of 2 ways. If any child object of a
3133     * scroller has pushed a scroll freeze or hold then it affects all parent
3134     * scrollers until all children have released them.
3135     *
3136     * 1. To hold on scrolling. This means just flicking and dragging may no
3137     * longer scroll, but pressing/dragging near an edge of the scroller will
3138     * still scroll. This is automatically used by the entry object when
3139     * selecting text.
3140     *
3141     * 2. To totally freeze scrolling. This means it stops. until
3142     * popped/released.
3143     *
3144     * @{
3145     */
3146
3147    /**
3148     * Push the scroll hold by 1
3149     *
3150     * This increments the scroll hold count by one. If it is more than 0 it will
3151     * take effect on the parents of the indicated object.
3152     *
3153     * @param obj The object
3154     * @ingroup Scrollhints
3155     */
3156    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3157
3158    /**
3159     * Pop the scroll hold by 1
3160     *
3161     * This decrements the scroll hold count by one. If it is more than 0 it will
3162     * take effect on the parents of the indicated object.
3163     *
3164     * @param obj The object
3165     * @ingroup Scrollhints
3166     */
3167    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3168
3169    /**
3170     * Push the scroll freeze by 1
3171     *
3172     * This increments the scroll freeze count by one. If it is more
3173     * than 0 it will take effect on the parents of the indicated
3174     * object.
3175     *
3176     * @param obj The object
3177     * @ingroup Scrollhints
3178     */
3179    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3180
3181    /**
3182     * Pop the scroll freeze by 1
3183     *
3184     * This decrements the scroll freeze count by one. If it is more
3185     * than 0 it will take effect on the parents of the indicated
3186     * object.
3187     *
3188     * @param obj The object
3189     * @ingroup Scrollhints
3190     */
3191    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3192
3193    /**
3194     * Lock the scrolling of the given widget (and thus all parents)
3195     *
3196     * This locks the given object from scrolling in the X axis (and implicitly
3197     * also locks all parent scrollers too from doing the same).
3198     *
3199     * @param obj The object
3200     * @param lock The lock state (1 == locked, 0 == unlocked)
3201     * @ingroup Scrollhints
3202     */
3203    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3204
3205    /**
3206     * Lock the scrolling of the given widget (and thus all parents)
3207     *
3208     * This locks the given object from scrolling in the Y axis (and implicitly
3209     * also locks all parent scrollers too from doing the same).
3210     *
3211     * @param obj The object
3212     * @param lock The lock state (1 == locked, 0 == unlocked)
3213     * @ingroup Scrollhints
3214     */
3215    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3216
3217    /**
3218     * Get the scrolling lock of the given widget
3219     *
3220     * This gets the lock for X axis scrolling.
3221     *
3222     * @param obj The object
3223     * @ingroup Scrollhints
3224     */
3225    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3226
3227    /**
3228     * Get the scrolling lock of the given widget
3229     *
3230     * This gets the lock for X axis scrolling.
3231     *
3232     * @param obj The object
3233     * @ingroup Scrollhints
3234     */
3235    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3236
3237    /**
3238     * @}
3239     */
3240
3241    /**
3242     * Send a signal to the widget edje object.
3243     *
3244     * This function sends a signal to the edje object of the obj. An
3245     * edje program can respond to a signal by specifying matching
3246     * 'signal' and 'source' fields.
3247     *
3248     * @param obj The object
3249     * @param emission The signal's name.
3250     * @param source The signal's source.
3251     * @ingroup General
3252     */
3253    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3254
3255    /**
3256     * Add a callback for a signal emitted by widget edje object.
3257     *
3258     * This function connects a callback function to a signal emitted by the
3259     * edje object of the obj.
3260     * Globs can occur in either the emission or source name.
3261     *
3262     * @param obj The object
3263     * @param emission The signal's name.
3264     * @param source The signal's source.
3265     * @param func The callback function to be executed when the signal is
3266     * emitted.
3267     * @param data A pointer to data to pass in to the callback function.
3268     * @ingroup General
3269     */
3270    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);
3271
3272    /**
3273     * Remove a signal-triggered callback from a widget edje object.
3274     *
3275     * This function removes a callback, previoulsy attached to a
3276     * signal emitted by the edje object of the obj.  The parameters
3277     * emission, source and func must match exactly those passed to a
3278     * previous call to elm_object_signal_callback_add(). The data
3279     * pointer that was passed to this call will be returned.
3280     *
3281     * @param obj The object
3282     * @param emission The signal's name.
3283     * @param source The signal's source.
3284     * @param func The callback function to be executed when the signal is
3285     * emitted.
3286     * @return The data pointer
3287     * @ingroup General
3288     */
3289    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);
3290
3291    /**
3292     * Add a callback for input events (key up, key down, mouse wheel)
3293     * on a given Elementary widget
3294     *
3295     * @param obj The widget to add an event callback on
3296     * @param func The callback function to be executed when the event
3297     * happens
3298     * @param data Data to pass in to @p func
3299     *
3300     * Every widget in an Elementary interface set to receive focus,
3301     * with elm_object_focus_allow_set(), will propagate @b all of its
3302     * key up, key down and mouse wheel input events up to its parent
3303     * object, and so on. All of the focusable ones in this chain which
3304     * had an event callback set, with this call, will be able to treat
3305     * those events. There are two ways of making the propagation of
3306     * these event upwards in the tree of widgets to @b cease:
3307     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3308     *   the event was @b not processed, so the propagation will go on.
3309     * - The @c event_info pointer passed to @p func will contain the
3310     *   event's structure and, if you OR its @c event_flags inner
3311     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3312     *   one has already handled it, thus killing the event's
3313     *   propagation, too.
3314     *
3315     * @note Your event callback will be issued on those events taking
3316     * place only if no other child widget of @obj has consumed the
3317     * event already.
3318     *
3319     * @note Not to be confused with @c
3320     * evas_object_event_callback_add(), which will add event callbacks
3321     * per type on general Evas objects (no event propagation
3322     * infrastructure taken in account).
3323     *
3324     * @note Not to be confused with @c
3325     * elm_object_signal_callback_add(), which will add callbacks to @b
3326     * signals coming from a widget's theme, not input events.
3327     *
3328     * @note Not to be confused with @c
3329     * edje_object_signal_callback_add(), which does the same as
3330     * elm_object_signal_callback_add(), but directly on an Edje
3331     * object.
3332     *
3333     * @note Not to be confused with @c
3334     * evas_object_smart_callback_add(), which adds callbacks to smart
3335     * objects' <b>smart events</b>, and not input events.
3336     *
3337     * @see elm_object_event_callback_del()
3338     *
3339     * @ingroup General
3340     */
3341    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3342
3343    /**
3344     * Remove an event callback from a widget.
3345     *
3346     * This function removes a callback, previoulsy attached to event emission
3347     * by the @p obj.
3348     * The parameters func and data must match exactly those passed to
3349     * a previous call to elm_object_event_callback_add(). The data pointer that
3350     * was passed to this call will be returned.
3351     *
3352     * @param obj The object
3353     * @param func The callback function to be executed when the event is
3354     * emitted.
3355     * @param data Data to pass in to the callback function.
3356     * @return The data pointer
3357     * @ingroup General
3358     */
3359    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3360
3361    /**
3362     * Adjust size of an element for finger usage.
3363     *
3364     * @param times_w How many fingers should fit horizontally
3365     * @param w Pointer to the width size to adjust
3366     * @param times_h How many fingers should fit vertically
3367     * @param h Pointer to the height size to adjust
3368     *
3369     * This takes width and height sizes (in pixels) as input and a
3370     * size multiple (which is how many fingers you want to place
3371     * within the area, being "finger" the size set by
3372     * elm_finger_size_set()), and adjusts the size to be large enough
3373     * to accommodate the resulting size -- if it doesn't already
3374     * accommodate it. On return the @p w and @p h sizes pointed to by
3375     * these parameters will be modified, on those conditions.
3376     *
3377     * @note This is kind of a low level Elementary call, most useful
3378     * on size evaluation times for widgets. An external user wouldn't
3379     * be calling, most of the time.
3380     *
3381     * @ingroup Fingers
3382     */
3383    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3384
3385    /**
3386     * Get the duration for occuring long press event.
3387     *
3388     * @return Timeout for long press event
3389     * @ingroup Longpress
3390     */
3391    EAPI double           elm_longpress_timeout_get(void);
3392
3393    /**
3394     * Set the duration for occuring long press event.
3395     *
3396     * @param lonpress_timeout Timeout for long press event
3397     * @ingroup Longpress
3398     */
3399    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3400
3401    /**
3402     * @defgroup Debug Debug
3403     * don't use it unless you are sure
3404     *
3405     * @{
3406     */
3407
3408    /**
3409     * Print Tree object hierarchy in stdout
3410     *
3411     * @param obj The root object
3412     * @ingroup Debug
3413     */
3414    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3415    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3416
3417    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3418    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3419    /**
3420     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3421     *
3422     * @param obj The root object
3423     * @param file The path of output file
3424     * @ingroup Debug
3425     */
3426    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3427
3428    /**
3429     * @}
3430     */
3431
3432    /**
3433     * @defgroup Theme Theme
3434     *
3435     * Elementary uses Edje to theme its widgets, naturally. But for the most
3436     * part this is hidden behind a simpler interface that lets the user set
3437     * extensions and choose the style of widgets in a much easier way.
3438     *
3439     * Instead of thinking in terms of paths to Edje files and their groups
3440     * each time you want to change the appearance of a widget, Elementary
3441     * works so you can add any theme file with extensions or replace the
3442     * main theme at one point in the application, and then just set the style
3443     * of widgets with elm_object_style_set() and related functions. Elementary
3444     * will then look in its list of themes for a matching group and apply it,
3445     * and when the theme changes midway through the application, all widgets
3446     * will be updated accordingly.
3447     *
3448     * There are three concepts you need to know to understand how Elementary
3449     * theming works: default theme, extensions and overlays.
3450     *
3451     * Default theme, obviously enough, is the one that provides the default
3452     * look of all widgets. End users can change the theme used by Elementary
3453     * by setting the @c ELM_THEME environment variable before running an
3454     * application, or globally for all programs using the @c elementary_config
3455     * utility. Applications can change the default theme using elm_theme_set(),
3456     * but this can go against the user wishes, so it's not an adviced practice.
3457     *
3458     * Ideally, applications should find everything they need in the already
3459     * provided theme, but there may be occasions when that's not enough and
3460     * custom styles are required to correctly express the idea. For this
3461     * cases, Elementary has extensions.
3462     *
3463     * Extensions allow the application developer to write styles of its own
3464     * to apply to some widgets. This requires knowledge of how each widget
3465     * is themed, as extensions will always replace the entire group used by
3466     * the widget, so important signals and parts need to be there for the
3467     * object to behave properly (see documentation of Edje for details).
3468     * Once the theme for the extension is done, the application needs to add
3469     * it to the list of themes Elementary will look into, using
3470     * elm_theme_extension_add(), and set the style of the desired widgets as
3471     * he would normally with elm_object_style_set().
3472     *
3473     * Overlays, on the other hand, can replace the look of all widgets by
3474     * overriding the default style. Like extensions, it's up to the application
3475     * developer to write the theme for the widgets it wants, the difference
3476     * being that when looking for the theme, Elementary will check first the
3477     * list of overlays, then the set theme and lastly the list of extensions,
3478     * so with overlays it's possible to replace the default view and every
3479     * widget will be affected. This is very much alike to setting the whole
3480     * theme for the application and will probably clash with the end user
3481     * options, not to mention the risk of ending up with not matching styles
3482     * across the program. Unless there's a very special reason to use them,
3483     * overlays should be avoided for the resons exposed before.
3484     *
3485     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3486     * keeps one default internally and every function that receives one of
3487     * these can be called with NULL to refer to this default (except for
3488     * elm_theme_free()). It's possible to create a new instance of a
3489     * ::Elm_Theme to set other theme for a specific widget (and all of its
3490     * children), but this is as discouraged, if not even more so, than using
3491     * overlays. Don't use this unless you really know what you are doing.
3492     *
3493     * But to be less negative about things, you can look at the following
3494     * examples:
3495     * @li @ref theme_example_01 "Using extensions"
3496     * @li @ref theme_example_02 "Using overlays"
3497     *
3498     * @{
3499     */
3500    /**
3501     * @typedef Elm_Theme
3502     *
3503     * Opaque handler for the list of themes Elementary looks for when
3504     * rendering widgets.
3505     *
3506     * Stay out of this unless you really know what you are doing. For most
3507     * cases, sticking to the default is all a developer needs.
3508     */
3509    typedef struct _Elm_Theme Elm_Theme;
3510
3511    /**
3512     * Create a new specific theme
3513     *
3514     * This creates an empty specific theme that only uses the default theme. A
3515     * specific theme has its own private set of extensions and overlays too
3516     * (which are empty by default). Specific themes do not fall back to themes
3517     * of parent objects. They are not intended for this use. Use styles, overlays
3518     * and extensions when needed, but avoid specific themes unless there is no
3519     * other way (example: you want to have a preview of a new theme you are
3520     * selecting in a "theme selector" window. The preview is inside a scroller
3521     * and should display what the theme you selected will look like, but not
3522     * actually apply it yet. The child of the scroller will have a specific
3523     * theme set to show this preview before the user decides to apply it to all
3524     * applications).
3525     */
3526    EAPI Elm_Theme       *elm_theme_new(void);
3527    /**
3528     * Free a specific theme
3529     *
3530     * @param th The theme to free
3531     *
3532     * This frees a theme created with elm_theme_new().
3533     */
3534    EAPI void             elm_theme_free(Elm_Theme *th);
3535    /**
3536     * Copy the theme fom the source to the destination theme
3537     *
3538     * @param th The source theme to copy from
3539     * @param thdst The destination theme to copy data to
3540     *
3541     * This makes a one-time static copy of all the theme config, extensions
3542     * and overlays from @p th to @p thdst. If @p th references a theme, then
3543     * @p thdst is also set to reference it, with all the theme settings,
3544     * overlays and extensions that @p th had.
3545     */
3546    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3547    /**
3548     * Tell the source theme to reference the ref theme
3549     *
3550     * @param th The theme that will do the referencing
3551     * @param thref The theme that is the reference source
3552     *
3553     * This clears @p th to be empty and then sets it to refer to @p thref
3554     * so @p th acts as an override to @p thref, but where its overrides
3555     * don't apply, it will fall through to @p thref for configuration.
3556     */
3557    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3558    /**
3559     * Return the theme referred to
3560     *
3561     * @param th The theme to get the reference from
3562     * @return The referenced theme handle
3563     *
3564     * This gets the theme set as the reference theme by elm_theme_ref_set().
3565     * If no theme is set as a reference, NULL is returned.
3566     */
3567    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3568    /**
3569     * Return the default theme
3570     *
3571     * @return The default theme handle
3572     *
3573     * This returns the internal default theme setup handle that all widgets
3574     * use implicitly unless a specific theme is set. This is also often use
3575     * as a shorthand of NULL.
3576     */
3577    EAPI Elm_Theme       *elm_theme_default_get(void);
3578    /**
3579     * Prepends a theme overlay to the list of overlays
3580     *
3581     * @param th The theme to add to, or if NULL, the default theme
3582     * @param item The Edje file path to be used
3583     *
3584     * Use this if your application needs to provide some custom overlay theme
3585     * (An Edje file that replaces some default styles of widgets) where adding
3586     * new styles, or changing system theme configuration is not possible. Do
3587     * NOT use this instead of a proper system theme configuration. Use proper
3588     * configuration files, profiles, environment variables etc. to set a theme
3589     * so that the theme can be altered by simple confiugration by a user. Using
3590     * this call to achieve that effect is abusing the API and will create lots
3591     * of trouble.
3592     *
3593     * @see elm_theme_extension_add()
3594     */
3595    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3596    /**
3597     * Delete a theme overlay from the list of overlays
3598     *
3599     * @param th The theme to delete from, or if NULL, the default theme
3600     * @param item The name of the theme overlay
3601     *
3602     * @see elm_theme_overlay_add()
3603     */
3604    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3605    /**
3606     * Appends a theme extension to the list of extensions.
3607     *
3608     * @param th The theme to add to, or if NULL, the default theme
3609     * @param item The Edje file path to be used
3610     *
3611     * This is intended when an application needs more styles of widgets or new
3612     * widget themes that the default does not provide (or may not provide). The
3613     * application has "extended" usage by coming up with new custom style names
3614     * for widgets for specific uses, but as these are not "standard", they are
3615     * not guaranteed to be provided by a default theme. This means the
3616     * application is required to provide these extra elements itself in specific
3617     * Edje files. This call adds one of those Edje files to the theme search
3618     * path to be search after the default theme. The use of this call is
3619     * encouraged when default styles do not meet the needs of the application.
3620     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3621     *
3622     * @see elm_object_style_set()
3623     */
3624    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3625    /**
3626     * Deletes a theme extension from the list of extensions.
3627     *
3628     * @param th The theme to delete from, or if NULL, the default theme
3629     * @param item The name of the theme extension
3630     *
3631     * @see elm_theme_extension_add()
3632     */
3633    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3634    /**
3635     * Set the theme search order for the given theme
3636     *
3637     * @param th The theme to set the search order, or if NULL, the default theme
3638     * @param theme Theme search string
3639     *
3640     * This sets the search string for the theme in path-notation from first
3641     * theme to search, to last, delimited by the : character. Example:
3642     *
3643     * "shiny:/path/to/file.edj:default"
3644     *
3645     * See the ELM_THEME environment variable for more information.
3646     *
3647     * @see elm_theme_get()
3648     * @see elm_theme_list_get()
3649     */
3650    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3651    /**
3652     * Return the theme search order
3653     *
3654     * @param th The theme to get the search order, or if NULL, the default theme
3655     * @return The internal search order path
3656     *
3657     * This function returns a colon separated string of theme elements as
3658     * returned by elm_theme_list_get().
3659     *
3660     * @see elm_theme_set()
3661     * @see elm_theme_list_get()
3662     */
3663    EAPI const char      *elm_theme_get(Elm_Theme *th);
3664    /**
3665     * Return a list of theme elements to be used in a theme.
3666     *
3667     * @param th Theme to get the list of theme elements from.
3668     * @return The internal list of theme elements
3669     *
3670     * This returns the internal list of theme elements (will only be valid as
3671     * long as the theme is not modified by elm_theme_set() or theme is not
3672     * freed by elm_theme_free(). This is a list of strings which must not be
3673     * altered as they are also internal. If @p th is NULL, then the default
3674     * theme element list is returned.
3675     *
3676     * A theme element can consist of a full or relative path to a .edj file,
3677     * or a name, without extension, for a theme to be searched in the known
3678     * theme paths for Elemementary.
3679     *
3680     * @see elm_theme_set()
3681     * @see elm_theme_get()
3682     */
3683    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3684    /**
3685     * Return the full patrh for a theme element
3686     *
3687     * @param f The theme element name
3688     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3689     * @return The full path to the file found.
3690     *
3691     * This returns a string you should free with free() on success, NULL on
3692     * failure. This will search for the given theme element, and if it is a
3693     * full or relative path element or a simple searchable name. The returned
3694     * path is the full path to the file, if searched, and the file exists, or it
3695     * is simply the full path given in the element or a resolved path if
3696     * relative to home. The @p in_search_path boolean pointed to is set to
3697     * EINA_TRUE if the file was a searchable file andis in the search path,
3698     * and EINA_FALSE otherwise.
3699     */
3700    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3701    /**
3702     * Flush the current theme.
3703     *
3704     * @param th Theme to flush
3705     *
3706     * This flushes caches that let elementary know where to find theme elements
3707     * in the given theme. If @p th is NULL, then the default theme is flushed.
3708     * Call this function if source theme data has changed in such a way as to
3709     * make any caches Elementary kept invalid.
3710     */
3711    EAPI void             elm_theme_flush(Elm_Theme *th);
3712    /**
3713     * This flushes all themes (default and specific ones).
3714     *
3715     * This will flush all themes in the current application context, by calling
3716     * elm_theme_flush() on each of them.
3717     */
3718    EAPI void             elm_theme_full_flush(void);
3719    /**
3720     * Set the theme for all elementary using applications on the current display
3721     *
3722     * @param theme The name of the theme to use. Format same as the ELM_THEME
3723     * environment variable.
3724     */
3725    EAPI void             elm_theme_all_set(const char *theme);
3726    /**
3727     * Return a list of theme elements in the theme search path
3728     *
3729     * @return A list of strings that are the theme element names.
3730     *
3731     * This lists all available theme files in the standard Elementary search path
3732     * for theme elements, and returns them in alphabetical order as theme
3733     * element names in a list of strings. Free this with
3734     * elm_theme_name_available_list_free() when you are done with the list.
3735     */
3736    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3737    /**
3738     * Free the list returned by elm_theme_name_available_list_new()
3739     *
3740     * This frees the list of themes returned by
3741     * elm_theme_name_available_list_new(). Once freed the list should no longer
3742     * be used. a new list mys be created.
3743     */
3744    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3745    /**
3746     * Set a specific theme to be used for this object and its children
3747     *
3748     * @param obj The object to set the theme on
3749     * @param th The theme to set
3750     *
3751     * This sets a specific theme that will be used for the given object and any
3752     * child objects it has. If @p th is NULL then the theme to be used is
3753     * cleared and the object will inherit its theme from its parent (which
3754     * ultimately will use the default theme if no specific themes are set).
3755     *
3756     * Use special themes with great care as this will annoy users and make
3757     * configuration difficult. Avoid any custom themes at all if it can be
3758     * helped.
3759     */
3760    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3761    /**
3762     * Get the specific theme to be used
3763     *
3764     * @param obj The object to get the specific theme from
3765     * @return The specifc theme set.
3766     *
3767     * This will return a specific theme set, or NULL if no specific theme is
3768     * set on that object. It will not return inherited themes from parents, only
3769     * the specific theme set for that specific object. See elm_object_theme_set()
3770     * for more information.
3771     */
3772    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3773
3774    /**
3775     * Get a data item from a theme
3776     *
3777     * @param th The theme, or NULL for default theme
3778     * @param key The data key to search with
3779     * @return The data value, or NULL on failure
3780     *
3781     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3782     * It works the same way as edje_file_data_get() except that the return is stringshared.
3783     */
3784    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3785    /**
3786     * @}
3787     */
3788
3789    /* win */
3790    /** @defgroup Win Win
3791     *
3792     * @image html img/widget/win/preview-00.png
3793     * @image latex img/widget/win/preview-00.eps
3794     *
3795     * The window class of Elementary.  Contains functions to manipulate
3796     * windows. The Evas engine used to render the window contents is specified
3797     * in the system or user elementary config files (whichever is found last),
3798     * and can be overridden with the ELM_ENGINE environment variable for
3799     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3800     * compilation setup and modules actually installed at runtime) are (listed
3801     * in order of best supported and most likely to be complete and work to
3802     * lowest quality).
3803     *
3804     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3805     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3806     * rendering in X11)
3807     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3808     * exits)
3809     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3810     * rendering)
3811     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3812     * buffer)
3813     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3814     * rendering using SDL as the buffer)
3815     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3816     * GDI with software)
3817     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3818     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3819     * grayscale using dedicated 8bit software engine in X11)
3820     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3821     * X11 using 16bit software engine)
3822     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3823     * (Windows CE rendering via GDI with 16bit software renderer)
3824     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3825     * buffer with 16bit software renderer)
3826     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3827     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3828     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3829     *
3830     * All engines use a simple string to select the engine to render, EXCEPT
3831     * the "shot" engine. This actually encodes the output of the virtual
3832     * screenshot and how long to delay in the engine string. The engine string
3833     * is encoded in the following way:
3834     *
3835     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3836     *
3837     * Where options are separated by a ":" char if more than one option is
3838     * given, with delay, if provided being the first option and file the last
3839     * (order is important). The delay specifies how long to wait after the
3840     * window is shown before doing the virtual "in memory" rendering and then
3841     * save the output to the file specified by the file option (and then exit).
3842     * If no delay is given, the default is 0.5 seconds. If no file is given the
3843     * default output file is "out.png". Repeat option is for continous
3844     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3845     * fixed to "out001.png" Some examples of using the shot engine:
3846     *
3847     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3848     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3849     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3850     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3851     *   ELM_ENGINE="shot:" elementary_test
3852     *
3853     * Signals that you can add callbacks for are:
3854     *
3855     * @li "delete,request": the user requested to close the window. See
3856     * elm_win_autodel_set().
3857     * @li "focus,in": window got focus
3858     * @li "focus,out": window lost focus
3859     * @li "moved": window that holds the canvas was moved
3860     *
3861     * Examples:
3862     * @li @ref win_example_01
3863     *
3864     * @{
3865     */
3866    /**
3867     * Defines the types of window that can be created
3868     *
3869     * These are hints set on the window so that a running Window Manager knows
3870     * how the window should be handled and/or what kind of decorations it
3871     * should have.
3872     *
3873     * Currently, only the X11 backed engines use them.
3874     */
3875    typedef enum _Elm_Win_Type
3876      {
3877         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3878                          window. Almost every window will be created with this
3879                          type. */
3880         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3881         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3882                            window holding desktop icons. */
3883         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3884                         be kept on top of any other window by the Window
3885                         Manager. */
3886         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3887                            similar. */
3888         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3889         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3890                            pallete. */
3891         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3892         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3893                                  entry in a menubar is clicked. Typically used
3894                                  with elm_win_override_set(). This hint exists
3895                                  for completion only, as the EFL way of
3896                                  implementing a menu would not normally use a
3897                                  separate window for its contents. */
3898         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3899                               triggered by right-clicking an object. */
3900         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3901                            explanatory text that typically appear after the
3902                            mouse cursor hovers over an object for a while.
3903                            Typically used with elm_win_override_set() and also
3904                            not very commonly used in the EFL. */
3905         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3906                                 battery life or a new E-Mail received. */
3907         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3908                          usually used in the EFL. */
3909         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3910                        object being dragged across different windows, or even
3911                        applications. Typically used with
3912                        elm_win_override_set(). */
3913         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3914                                  buffer. No actual window is created for this
3915                                  type, instead the window and all of its
3916                                  contents will be rendered to an image buffer.
3917                                  This allows to have children window inside a
3918                                  parent one just like any other object would
3919                                  be, and do other things like applying @c
3920                                  Evas_Map effects to it. This is the only type
3921                                  of window that requires the @c parent
3922                                  parameter of elm_win_add() to be a valid @c
3923                                  Evas_Object. */
3924      } Elm_Win_Type;
3925
3926    /**
3927     * The differents layouts that can be requested for the virtual keyboard.
3928     *
3929     * When the application window is being managed by Illume, it may request
3930     * any of the following layouts for the virtual keyboard.
3931     */
3932    typedef enum _Elm_Win_Keyboard_Mode
3933      {
3934         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3935         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3936         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3937         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3938         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3939         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3940         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3941         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3942         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3943         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3944         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3945         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3946         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3947         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3948         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3949         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3950      } Elm_Win_Keyboard_Mode;
3951
3952    /**
3953     * Available commands that can be sent to the Illume manager.
3954     *
3955     * When running under an Illume session, a window may send commands to the
3956     * Illume manager to perform different actions.
3957     */
3958    typedef enum _Elm_Illume_Command
3959      {
3960         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3961                                          window */
3962         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3963                                             in the list */
3964         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3965                                          screen */
3966         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3967      } Elm_Illume_Command;
3968
3969    /**
3970     * Adds a window object. If this is the first window created, pass NULL as
3971     * @p parent.
3972     *
3973     * @param parent Parent object to add the window to, or NULL
3974     * @param name The name of the window
3975     * @param type The window type, one of #Elm_Win_Type.
3976     *
3977     * The @p parent paramter can be @c NULL for every window @p type except
3978     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3979     * which the image object will be created.
3980     *
3981     * @return The created object, or NULL on failure
3982     */
3983    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3984    /**
3985     * Adds a window object with standard setup
3986     *
3987     * @param name The name of the window
3988     * @param title The title for the window
3989     *
3990     * This creates a window like elm_win_add() but also puts in a standard
3991     * background with elm_bg_add(), as well as setting the window title to
3992     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3993     * as the parent widget.
3994     * 
3995     * @return The created object, or NULL on failure
3996     *
3997     * @see elm_win_add()
3998     */
3999    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4000    /**
4001     * Add @p subobj as a resize object of window @p obj.
4002     *
4003     *
4004     * Setting an object as a resize object of the window means that the
4005     * @p subobj child's size and position will be controlled by the window
4006     * directly. That is, the object will be resized to match the window size
4007     * and should never be moved or resized manually by the developer.
4008     *
4009     * In addition, resize objects of the window control what the minimum size
4010     * of it will be, as well as whether it can or not be resized by the user.
4011     *
4012     * For the end user to be able to resize a window by dragging the handles
4013     * or borders provided by the Window Manager, or using any other similar
4014     * mechanism, all of the resize objects in the window should have their
4015     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4016     *
4017     * @param obj The window object
4018     * @param subobj The resize object to add
4019     */
4020    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4021    /**
4022     * Delete @p subobj as a resize object of window @p obj.
4023     *
4024     * This function removes the object @p subobj from the resize objects of
4025     * the window @p obj. It will not delete the object itself, which will be
4026     * left unmanaged and should be deleted by the developer, manually handled
4027     * or set as child of some other container.
4028     *
4029     * @param obj The window object
4030     * @param subobj The resize object to add
4031     */
4032    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4033    /**
4034     * Set the title of the window
4035     *
4036     * @param obj The window object
4037     * @param title The title to set
4038     */
4039    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4040    /**
4041     * Get the title of the window
4042     *
4043     * The returned string is an internal one and should not be freed or
4044     * modified. It will also be rendered invalid if a new title is set or if
4045     * the window is destroyed.
4046     *
4047     * @param obj The window object
4048     * @return The title
4049     */
4050    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4051    /**
4052     * Set the window's autodel state.
4053     *
4054     * When closing the window in any way outside of the program control, like
4055     * pressing the X button in the titlebar or using a command from the
4056     * Window Manager, a "delete,request" signal is emitted to indicate that
4057     * this event occurred and the developer can take any action, which may
4058     * include, or not, destroying the window object.
4059     *
4060     * When the @p autodel parameter is set, the window will be automatically
4061     * destroyed when this event occurs, after the signal is emitted.
4062     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4063     * and is up to the program to do so when it's required.
4064     *
4065     * @param obj The window object
4066     * @param autodel If true, the window will automatically delete itself when
4067     * closed
4068     */
4069    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4070    /**
4071     * Get the window's autodel state.
4072     *
4073     * @param obj The window object
4074     * @return If the window will automatically delete itself when closed
4075     *
4076     * @see elm_win_autodel_set()
4077     */
4078    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4079    /**
4080     * Activate a window object.
4081     *
4082     * This function sends a request to the Window Manager to activate the
4083     * window pointed by @p obj. If honored by the WM, the window will receive
4084     * the keyboard focus.
4085     *
4086     * @note This is just a request that a Window Manager may ignore, so calling
4087     * this function does not ensure in any way that the window will be the
4088     * active one after it.
4089     *
4090     * @param obj The window object
4091     */
4092    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4093    /**
4094     * Lower a window object.
4095     *
4096     * Places the window pointed by @p obj at the bottom of the stack, so that
4097     * no other window is covered by it.
4098     *
4099     * If elm_win_override_set() is not set, the Window Manager may ignore this
4100     * request.
4101     *
4102     * @param obj The window object
4103     */
4104    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4105    /**
4106     * Raise a window object.
4107     *
4108     * Places the window pointed by @p obj at the top of the stack, so that it's
4109     * not covered by any other window.
4110     *
4111     * If elm_win_override_set() is not set, the Window Manager may ignore this
4112     * request.
4113     *
4114     * @param obj The window object
4115     */
4116    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4117    /**
4118     * Set the borderless state of a window.
4119     *
4120     * This function requests the Window Manager to not draw any decoration
4121     * around the window.
4122     *
4123     * @param obj The window object
4124     * @param borderless If true, the window is borderless
4125     */
4126    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4127    /**
4128     * Get the borderless state of a window.
4129     *
4130     * @param obj The window object
4131     * @return If true, the window is borderless
4132     */
4133    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4134    /**
4135     * Set the shaped state of a window.
4136     *
4137     * Shaped windows, when supported, will render the parts of the window that
4138     * has no content, transparent.
4139     *
4140     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4141     * background object or cover the entire window in any other way, or the
4142     * parts of the canvas that have no data will show framebuffer artifacts.
4143     *
4144     * @param obj The window object
4145     * @param shaped If true, the window is shaped
4146     *
4147     * @see elm_win_alpha_set()
4148     */
4149    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4150    /**
4151     * Get the shaped state of a window.
4152     *
4153     * @param obj The window object
4154     * @return If true, the window is shaped
4155     *
4156     * @see elm_win_shaped_set()
4157     */
4158    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4159    /**
4160     * Set the alpha channel state of a window.
4161     *
4162     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4163     * possibly making parts of the window completely or partially transparent.
4164     * This is also subject to the underlying system supporting it, like for
4165     * example, running under a compositing manager. If no compositing is
4166     * available, enabling this option will instead fallback to using shaped
4167     * windows, with elm_win_shaped_set().
4168     *
4169     * @param obj The window object
4170     * @param alpha If true, the window has an alpha channel
4171     *
4172     * @see elm_win_alpha_set()
4173     */
4174    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4175    /**
4176     * Get the transparency state of a window.
4177     *
4178     * @param obj The window object
4179     * @return If true, the window is transparent
4180     *
4181     * @see elm_win_transparent_set()
4182     */
4183    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4184    /**
4185     * Set the transparency state of a window.
4186     *
4187     * Use elm_win_alpha_set() instead.
4188     *
4189     * @param obj The window object
4190     * @param transparent If true, the window is transparent
4191     *
4192     * @see elm_win_alpha_set()
4193     */
4194    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4195    /**
4196     * Get the alpha channel state of a window.
4197     *
4198     * @param obj The window object
4199     * @return If true, the window has an alpha channel
4200     */
4201    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4202    /**
4203     * Set the override state of a window.
4204     *
4205     * A window with @p override set to EINA_TRUE will not be managed by the
4206     * Window Manager. This means that no decorations of any kind will be shown
4207     * for it, moving and resizing must be handled by the application, as well
4208     * as the window visibility.
4209     *
4210     * This should not be used for normal windows, and even for not so normal
4211     * ones, it should only be used when there's a good reason and with a lot
4212     * of care. Mishandling override windows may result situations that
4213     * disrupt the normal workflow of the end user.
4214     *
4215     * @param obj The window object
4216     * @param override If true, the window is overridden
4217     */
4218    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4219    /**
4220     * Get the override state of a window.
4221     *
4222     * @param obj The window object
4223     * @return If true, the window is overridden
4224     *
4225     * @see elm_win_override_set()
4226     */
4227    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4228    /**
4229     * Set the fullscreen state of a window.
4230     *
4231     * @param obj The window object
4232     * @param fullscreen If true, the window is fullscreen
4233     */
4234    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4235    /**
4236     * Get the fullscreen state of a window.
4237     *
4238     * @param obj The window object
4239     * @return If true, the window is fullscreen
4240     */
4241    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4242    /**
4243     * Set the maximized state of a window.
4244     *
4245     * @param obj The window object
4246     * @param maximized If true, the window is maximized
4247     */
4248    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4249    /**
4250     * Get the maximized state of a window.
4251     *
4252     * @param obj The window object
4253     * @return If true, the window is maximized
4254     */
4255    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4256    /**
4257     * Set the iconified state of a window.
4258     *
4259     * @param obj The window object
4260     * @param iconified If true, the window is iconified
4261     */
4262    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4263    /**
4264     * Get the iconified state of a window.
4265     *
4266     * @param obj The window object
4267     * @return If true, the window is iconified
4268     */
4269    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4270    /**
4271     * Set the layer of the window.
4272     *
4273     * What this means exactly will depend on the underlying engine used.
4274     *
4275     * In the case of X11 backed engines, the value in @p layer has the
4276     * following meanings:
4277     * @li < 3: The window will be placed below all others.
4278     * @li > 5: The window will be placed above all others.
4279     * @li other: The window will be placed in the default layer.
4280     *
4281     * @param obj The window object
4282     * @param layer The layer of the window
4283     */
4284    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4285    /**
4286     * Get the layer of the window.
4287     *
4288     * @param obj The window object
4289     * @return The layer of the window
4290     *
4291     * @see elm_win_layer_set()
4292     */
4293    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4294    /**
4295     * Set the rotation of the window.
4296     *
4297     * Most engines only work with multiples of 90.
4298     *
4299     * This function is used to set the orientation of the window @p obj to
4300     * match that of the screen. The window itself will be resized to adjust
4301     * to the new geometry of its contents. If you want to keep the window size,
4302     * see elm_win_rotation_with_resize_set().
4303     *
4304     * @param obj The window object
4305     * @param rotation The rotation of the window, in degrees (0-360),
4306     * counter-clockwise.
4307     */
4308    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4309    /**
4310     * Rotates the window and resizes it.
4311     *
4312     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4313     * that they fit inside the current window geometry.
4314     *
4315     * @param obj The window object
4316     * @param layer The rotation of the window in degrees (0-360),
4317     * counter-clockwise.
4318     */
4319    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4320    /**
4321     * Get the rotation of the window.
4322     *
4323     * @param obj The window object
4324     * @return The rotation of the window in degrees (0-360)
4325     *
4326     * @see elm_win_rotation_set()
4327     * @see elm_win_rotation_with_resize_set()
4328     */
4329    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330    /**
4331     * Set the sticky state of the window.
4332     *
4333     * Hints the Window Manager that the window in @p obj should be left fixed
4334     * at its position even when the virtual desktop it's on moves or changes.
4335     *
4336     * @param obj The window object
4337     * @param sticky If true, the window's sticky state is enabled
4338     */
4339    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4340    /**
4341     * Get the sticky state of the window.
4342     *
4343     * @param obj The window object
4344     * @return If true, the window's sticky state is enabled
4345     *
4346     * @see elm_win_sticky_set()
4347     */
4348    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4349    /**
4350     * Set if this window is an illume conformant window
4351     *
4352     * @param obj The window object
4353     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4354     */
4355    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4356    /**
4357     * Get if this window is an illume conformant window
4358     *
4359     * @param obj The window object
4360     * @return A boolean if this window is illume conformant or not
4361     */
4362    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4363    /**
4364     * Set a window to be an illume quickpanel window
4365     *
4366     * By default window objects are not quickpanel windows.
4367     *
4368     * @param obj The window object
4369     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4370     */
4371    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4372    /**
4373     * Get if this window is a quickpanel or not
4374     *
4375     * @param obj The window object
4376     * @return A boolean if this window is a quickpanel or not
4377     */
4378    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4379    /**
4380     * Set the major priority of a quickpanel window
4381     *
4382     * @param obj The window object
4383     * @param priority The major priority for this quickpanel
4384     */
4385    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4386    /**
4387     * Get the major priority of a quickpanel window
4388     *
4389     * @param obj The window object
4390     * @return The major priority of this quickpanel
4391     */
4392    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4393    /**
4394     * Set the minor priority of a quickpanel window
4395     *
4396     * @param obj The window object
4397     * @param priority The minor priority for this quickpanel
4398     */
4399    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4400    /**
4401     * Get the minor priority of a quickpanel window
4402     *
4403     * @param obj The window object
4404     * @return The minor priority of this quickpanel
4405     */
4406    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4407    /**
4408     * Set which zone this quickpanel should appear in
4409     *
4410     * @param obj The window object
4411     * @param zone The requested zone for this quickpanel
4412     */
4413    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4414    /**
4415     * Get which zone this quickpanel should appear in
4416     *
4417     * @param obj The window object
4418     * @return The requested zone for this quickpanel
4419     */
4420    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4421    /**
4422     * Set the window to be skipped by keyboard focus
4423     *
4424     * This sets the window to be skipped by normal keyboard input. This means
4425     * a window manager will be asked to not focus this window as well as omit
4426     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4427     *
4428     * Call this and enable it on a window BEFORE you show it for the first time,
4429     * otherwise it may have no effect.
4430     *
4431     * Use this for windows that have only output information or might only be
4432     * interacted with by the mouse or fingers, and never for typing input.
4433     * Be careful that this may have side-effects like making the window
4434     * non-accessible in some cases unless the window is specially handled. Use
4435     * this with care.
4436     *
4437     * @param obj The window object
4438     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4439     */
4440    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4441    /**
4442     * Send a command to the windowing environment
4443     *
4444     * This is intended to work in touchscreen or small screen device
4445     * environments where there is a more simplistic window management policy in
4446     * place. This uses the window object indicated to select which part of the
4447     * environment to control (the part that this window lives in), and provides
4448     * a command and an optional parameter structure (use NULL for this if not
4449     * needed).
4450     *
4451     * @param obj The window object that lives in the environment to control
4452     * @param command The command to send
4453     * @param params Optional parameters for the command
4454     */
4455    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4456    /**
4457     * Get the inlined image object handle
4458     *
4459     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4460     * then the window is in fact an evas image object inlined in the parent
4461     * canvas. You can get this object (be careful to not manipulate it as it
4462     * is under control of elementary), and use it to do things like get pixel
4463     * data, save the image to a file, etc.
4464     *
4465     * @param obj The window object to get the inlined image from
4466     * @return The inlined image object, or NULL if none exists
4467     */
4468    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4469    /**
4470     * Determine whether a window has focus
4471     * @param obj The window to query
4472     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4473     */
4474    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4475    /**
4476     * Get screen geometry details for the screen that a window is on
4477     * @param obj The window to query
4478     * @param x where to return the horizontal offset value. May be NULL.
4479     * @param y  where to return the vertical offset value. May be NULL.
4480     * @param w  where to return the width value. May be NULL.
4481     * @param h  where to return the height value. May be NULL.
4482     */
4483    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4484    /**
4485     * Set the enabled status for the focus highlight in a window
4486     *
4487     * This function will enable or disable the focus highlight only for the
4488     * given window, regardless of the global setting for it
4489     *
4490     * @param obj The window where to enable the highlight
4491     * @param enabled The enabled value for the highlight
4492     */
4493    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4494    /**
4495     * Get the enabled value of the focus highlight for this window
4496     *
4497     * @param obj The window in which to check if the focus highlight is enabled
4498     *
4499     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4500     */
4501    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4502    /**
4503     * Set the style for the focus highlight on this window
4504     *
4505     * Sets the style to use for theming the highlight of focused objects on
4506     * the given window. If @p style is NULL, the default will be used.
4507     *
4508     * @param obj The window where to set the style
4509     * @param style The style to set
4510     */
4511    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4512    /**
4513     * Get the style set for the focus highlight object
4514     *
4515     * Gets the style set for this windows highilght object, or NULL if none
4516     * is set.
4517     *
4518     * @param obj The window to retrieve the highlights style from
4519     *
4520     * @return The style set or NULL if none was. Default is used in that case.
4521     */
4522    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4523    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4524    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4525    /*...
4526     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4527     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4528     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4529     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4530     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4531     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4532     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4533     *
4534     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4535     * (blank mouse, private mouse obj, defaultmouse)
4536     *
4537     */
4538    /**
4539     * Sets the keyboard mode of the window.
4540     *
4541     * @param obj The window object
4542     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4543     */
4544    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4545    /**
4546     * Gets the keyboard mode of the window.
4547     *
4548     * @param obj The window object
4549     * @return The mode, one of #Elm_Win_Keyboard_Mode
4550     */
4551    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4552    /**
4553     * Sets whether the window is a keyboard.
4554     *
4555     * @param obj The window object
4556     * @param is_keyboard If true, the window is a virtual keyboard
4557     */
4558    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4559    /**
4560     * Gets whether the window is a keyboard.
4561     *
4562     * @param obj The window object
4563     * @return If the window is a virtual keyboard
4564     */
4565    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4566
4567    /**
4568     * Get the screen position of a window.
4569     *
4570     * @param obj The window object
4571     * @param x The int to store the x coordinate to
4572     * @param y The int to store the y coordinate to
4573     */
4574    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4575    /**
4576     * @}
4577     */
4578
4579    /**
4580     * @defgroup Inwin Inwin
4581     *
4582     * @image html img/widget/inwin/preview-00.png
4583     * @image latex img/widget/inwin/preview-00.eps
4584     * @image html img/widget/inwin/preview-01.png
4585     * @image latex img/widget/inwin/preview-01.eps
4586     * @image html img/widget/inwin/preview-02.png
4587     * @image latex img/widget/inwin/preview-02.eps
4588     *
4589     * An inwin is a window inside a window that is useful for a quick popup.
4590     * It does not hover.
4591     *
4592     * It works by creating an object that will occupy the entire window, so it
4593     * must be created using an @ref Win "elm_win" as parent only. The inwin
4594     * object can be hidden or restacked below every other object if it's
4595     * needed to show what's behind it without destroying it. If this is done,
4596     * the elm_win_inwin_activate() function can be used to bring it back to
4597     * full visibility again.
4598     *
4599     * There are three styles available in the default theme. These are:
4600     * @li default: The inwin is sized to take over most of the window it's
4601     * placed in.
4602     * @li minimal: The size of the inwin will be the minimum necessary to show
4603     * its contents.
4604     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4605     * possible, but it's sized vertically the most it needs to fit its\
4606     * contents.
4607     *
4608     * Some examples of Inwin can be found in the following:
4609     * @li @ref inwin_example_01
4610     *
4611     * @{
4612     */
4613    /**
4614     * Adds an inwin to the current window
4615     *
4616     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4617     * Never call this function with anything other than the top-most window
4618     * as its parameter, unless you are fond of undefined behavior.
4619     *
4620     * After creating the object, the widget will set itself as resize object
4621     * for the window with elm_win_resize_object_add(), so when shown it will
4622     * appear to cover almost the entire window (how much of it depends on its
4623     * content and the style used). It must not be added into other container
4624     * objects and it needs not be moved or resized manually.
4625     *
4626     * @param parent The parent object
4627     * @return The new object or NULL if it cannot be created
4628     */
4629    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4630    /**
4631     * Activates an inwin object, ensuring its visibility
4632     *
4633     * This function will make sure that the inwin @p obj is completely visible
4634     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4635     * to the front. It also sets the keyboard focus to it, which will be passed
4636     * onto its content.
4637     *
4638     * The object's theme will also receive the signal "elm,action,show" with
4639     * source "elm".
4640     *
4641     * @param obj The inwin to activate
4642     */
4643    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4644    /**
4645     * Set the content of an inwin object.
4646     *
4647     * Once the content object is set, a previously set one will be deleted.
4648     * If you want to keep that old content object, use the
4649     * elm_win_inwin_content_unset() function.
4650     *
4651     * @param obj The inwin object
4652     * @param content The object to set as content
4653     */
4654    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4655    /**
4656     * Get the content of an inwin object.
4657     *
4658     * Return the content object which is set for this widget.
4659     *
4660     * The returned object is valid as long as the inwin is still alive and no
4661     * other content is set on it. Deleting the object will notify the inwin
4662     * about it and this one will be left empty.
4663     *
4664     * If you need to remove an inwin's content to be reused somewhere else,
4665     * see elm_win_inwin_content_unset().
4666     *
4667     * @param obj The inwin object
4668     * @return The content that is being used
4669     */
4670    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4671    /**
4672     * Unset the content of an inwin object.
4673     *
4674     * Unparent and return the content object which was set for this widget.
4675     *
4676     * @param obj The inwin object
4677     * @return The content that was being used
4678     */
4679    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4680    /**
4681     * @}
4682     */
4683    /* X specific calls - won't work on non-x engines (return 0) */
4684
4685    /**
4686     * Get the Ecore_X_Window of an Evas_Object
4687     *
4688     * @param obj The object
4689     *
4690     * @return The Ecore_X_Window of @p obj
4691     *
4692     * @ingroup Win
4693     */
4694    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4695
4696    /* smart callbacks called:
4697     * "delete,request" - the user requested to delete the window
4698     * "focus,in" - window got focus
4699     * "focus,out" - window lost focus
4700     * "moved" - window that holds the canvas was moved
4701     */
4702
4703    /**
4704     * @defgroup Bg Bg
4705     *
4706     * @image html img/widget/bg/preview-00.png
4707     * @image latex img/widget/bg/preview-00.eps
4708     *
4709     * @brief Background object, used for setting a solid color, image or Edje
4710     * group as background to a window or any container object.
4711     *
4712     * The bg object is used for setting a solid background to a window or
4713     * packing into any container object. It works just like an image, but has
4714     * some properties useful to a background, like setting it to tiled,
4715     * centered, scaled or stretched.
4716     * 
4717     * Default contents parts of the bg widget that you can use for are:
4718     * @li "overlay" - overlay of the bg
4719     *
4720     * Here is some sample code using it:
4721     * @li @ref bg_01_example_page
4722     * @li @ref bg_02_example_page
4723     * @li @ref bg_03_example_page
4724     */
4725
4726    /* bg */
4727    typedef enum _Elm_Bg_Option
4728      {
4729         ELM_BG_OPTION_CENTER,  /**< center the background */
4730         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4731         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4732         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4733      } Elm_Bg_Option;
4734
4735    /**
4736     * Add a new background to the parent
4737     *
4738     * @param parent The parent object
4739     * @return The new object or NULL if it cannot be created
4740     *
4741     * @ingroup Bg
4742     */
4743    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4744
4745    /**
4746     * Set the file (image or edje) used for the background
4747     *
4748     * @param obj The bg object
4749     * @param file The file path
4750     * @param group Optional key (group in Edje) within the file
4751     *
4752     * This sets the image file used in the background object. The image (or edje)
4753     * will be stretched (retaining aspect if its an image file) to completely fill
4754     * the bg object. This may mean some parts are not visible.
4755     *
4756     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4757     * even if @p file is NULL.
4758     *
4759     * @ingroup Bg
4760     */
4761    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4762
4763    /**
4764     * Get the file (image or edje) used for the background
4765     *
4766     * @param obj The bg object
4767     * @param file The file path
4768     * @param group Optional key (group in Edje) within the file
4769     *
4770     * @ingroup Bg
4771     */
4772    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4773
4774    /**
4775     * Set the option used for the background image
4776     *
4777     * @param obj The bg object
4778     * @param option The desired background option (TILE, SCALE)
4779     *
4780     * This sets the option used for manipulating the display of the background
4781     * image. The image can be tiled or scaled.
4782     *
4783     * @ingroup Bg
4784     */
4785    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4786
4787    /**
4788     * Get the option used for the background image
4789     *
4790     * @param obj The bg object
4791     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4792     *
4793     * @ingroup Bg
4794     */
4795    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4796    /**
4797     * Set the option used for the background color
4798     *
4799     * @param obj The bg object
4800     * @param r
4801     * @param g
4802     * @param b
4803     *
4804     * This sets the color used for the background rectangle. Its range goes
4805     * from 0 to 255.
4806     *
4807     * @ingroup Bg
4808     */
4809    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4810    /**
4811     * Get the option used for the background color
4812     *
4813     * @param obj The bg object
4814     * @param r
4815     * @param g
4816     * @param b
4817     *
4818     * @ingroup Bg
4819     */
4820    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4821
4822    /**
4823     * Set the overlay object used for the background object.
4824     *
4825     * @param obj The bg object
4826     * @param overlay The overlay object
4827     *
4828     * This provides a way for elm_bg to have an 'overlay' that will be on top
4829     * of the bg. Once the over object is set, a previously set one will be
4830     * deleted, even if you set the new one to NULL. If you want to keep that
4831     * old content object, use the elm_bg_overlay_unset() function.
4832     *
4833     * @deprecated use elm_object_part_content_set() instead
4834     *
4835     * @ingroup Bg
4836     */
4837
4838    WILL_DEPRECATE  EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4839
4840    /**
4841     * Get the overlay object used for the background object.
4842     *
4843     * @param obj The bg object
4844     * @return The content that is being used
4845     *
4846     * Return the content object which is set for this widget
4847     *
4848     * @deprecated use elm_object_part_content_get() instead
4849     *
4850     * @ingroup Bg
4851     */
4852    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4853
4854    /**
4855     * Get the overlay object used for the background object.
4856     *
4857     * @param obj The bg object
4858     * @return The content that was being used
4859     *
4860     * Unparent and return the overlay object which was set for this widget
4861     *
4862     * @deprecated use elm_object_part_content_unset() instead
4863     *
4864     * @ingroup Bg
4865     */
4866    WILL_DEPRECATE  EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4867
4868    /**
4869     * Set the size of the pixmap representation of the image.
4870     *
4871     * This option just makes sense if an image is going to be set in the bg.
4872     *
4873     * @param obj The bg object
4874     * @param w The new width of the image pixmap representation.
4875     * @param h The new height of the image pixmap representation.
4876     *
4877     * This function sets a new size for pixmap representation of the given bg
4878     * image. It allows the image to be loaded already in the specified size,
4879     * reducing the memory usage and load time when loading a big image with load
4880     * size set to a smaller size.
4881     *
4882     * NOTE: this is just a hint, the real size of the pixmap may differ
4883     * depending on the type of image being loaded, being bigger than requested.
4884     *
4885     * @ingroup Bg
4886     */
4887    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4888    /* smart callbacks called:
4889     */
4890
4891    /**
4892     * @defgroup Icon Icon
4893     *
4894     * @image html img/widget/icon/preview-00.png
4895     * @image latex img/widget/icon/preview-00.eps
4896     *
4897     * An object that provides standard icon images (delete, edit, arrows, etc.)
4898     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4899     *
4900     * The icon image requested can be in the elementary theme, or in the
4901     * freedesktop.org paths. It's possible to set the order of preference from
4902     * where the image will be used.
4903     *
4904     * This API is very similar to @ref Image, but with ready to use images.
4905     *
4906     * Default images provided by the theme are described below.
4907     *
4908     * The first list contains icons that were first intended to be used in
4909     * toolbars, but can be used in many other places too:
4910     * @li home
4911     * @li close
4912     * @li apps
4913     * @li arrow_up
4914     * @li arrow_down
4915     * @li arrow_left
4916     * @li arrow_right
4917     * @li chat
4918     * @li clock
4919     * @li delete
4920     * @li edit
4921     * @li refresh
4922     * @li folder
4923     * @li file
4924     *
4925     * Now some icons that were designed to be used in menus (but again, you can
4926     * use them anywhere else):
4927     * @li menu/home
4928     * @li menu/close
4929     * @li menu/apps
4930     * @li menu/arrow_up
4931     * @li menu/arrow_down
4932     * @li menu/arrow_left
4933     * @li menu/arrow_right
4934     * @li menu/chat
4935     * @li menu/clock
4936     * @li menu/delete
4937     * @li menu/edit
4938     * @li menu/refresh
4939     * @li menu/folder
4940     * @li menu/file
4941     *
4942     * And here we have some media player specific icons:
4943     * @li media_player/forward
4944     * @li media_player/info
4945     * @li media_player/next
4946     * @li media_player/pause
4947     * @li media_player/play
4948     * @li media_player/prev
4949     * @li media_player/rewind
4950     * @li media_player/stop
4951     *
4952     * Signals that you can add callbacks for are:
4953     *
4954     * "clicked" - This is called when a user has clicked the icon
4955     *
4956     * An example of usage for this API follows:
4957     * @li @ref tutorial_icon
4958     */
4959
4960    /**
4961     * @addtogroup Icon
4962     * @{
4963     */
4964
4965    typedef enum _Elm_Icon_Type
4966      {
4967         ELM_ICON_NONE,
4968         ELM_ICON_FILE,
4969         ELM_ICON_STANDARD
4970      } Elm_Icon_Type;
4971    /**
4972     * @enum _Elm_Icon_Lookup_Order
4973     * @typedef Elm_Icon_Lookup_Order
4974     *
4975     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4976     * theme, FDO paths, or both?
4977     *
4978     * @ingroup Icon
4979     */
4980    typedef enum _Elm_Icon_Lookup_Order
4981      {
4982         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4983         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4984         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4985         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4986      } Elm_Icon_Lookup_Order;
4987
4988    /**
4989     * Add a new icon object to the parent.
4990     *
4991     * @param parent The parent object
4992     * @return The new object or NULL if it cannot be created
4993     *
4994     * @see elm_icon_file_set()
4995     *
4996     * @ingroup Icon
4997     */
4998    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4999    /**
5000     * Set the file that will be used as icon.
5001     *
5002     * @param obj The icon object
5003     * @param file The path to file that will be used as icon image
5004     * @param group The group that the icon belongs to an edje file
5005     *
5006     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5007     *
5008     * @note The icon image set by this function can be changed by
5009     * elm_icon_standard_set().
5010     *
5011     * @see elm_icon_file_get()
5012     *
5013     * @ingroup Icon
5014     */
5015    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5016    /**
5017     * Set a location in memory to be used as an icon
5018     *
5019     * @param obj The icon object
5020     * @param img The binary data that will be used as an image
5021     * @param size The size of binary data @p img
5022     * @param format Optional format of @p img to pass to the image loader
5023     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5024     *
5025     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5026     *
5027     * @note The icon image set by this function can be changed by
5028     * elm_icon_standard_set().
5029     *
5030     * @ingroup Icon
5031     */
5032    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);
5033    /**
5034     * Get the file that will be used as icon.
5035     *
5036     * @param obj The icon object
5037     * @param file The path to file that will be used as the icon image
5038     * @param group The group that the icon belongs to, in edje file
5039     *
5040     * @see elm_icon_file_set()
5041     *
5042     * @ingroup Icon
5043     */
5044    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5045    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5046    /**
5047     * Set the icon by icon standards names.
5048     *
5049     * @param obj The icon object
5050     * @param name The icon name
5051     *
5052     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5053     *
5054     * For example, freedesktop.org defines standard icon names such as "home",
5055     * "network", etc. There can be different icon sets to match those icon
5056     * keys. The @p name given as parameter is one of these "keys", and will be
5057     * used to look in the freedesktop.org paths and elementary theme. One can
5058     * change the lookup order with elm_icon_order_lookup_set().
5059     *
5060     * If name is not found in any of the expected locations and it is the
5061     * absolute path of an image file, this image will be used.
5062     *
5063     * @note The icon image set by this function can be changed by
5064     * elm_icon_file_set().
5065     *
5066     * @see elm_icon_standard_get()
5067     * @see elm_icon_file_set()
5068     *
5069     * @ingroup Icon
5070     */
5071    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5072    /**
5073     * Get the icon name set by icon standard names.
5074     *
5075     * @param obj The icon object
5076     * @return The icon name
5077     *
5078     * If the icon image was set using elm_icon_file_set() instead of
5079     * elm_icon_standard_set(), then this function will return @c NULL.
5080     *
5081     * @see elm_icon_standard_set()
5082     *
5083     * @ingroup Icon
5084     */
5085    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5086    /**
5087     * Set the smooth scaling for an icon object.
5088     *
5089     * @param obj The icon object
5090     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5091     * otherwise. Default is @c EINA_TRUE.
5092     *
5093     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5094     * scaling provides a better resulting image, but is slower.
5095     *
5096     * The smooth scaling should be disabled when making animations that change
5097     * the icon size, since they will be faster. Animations that don't require
5098     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5099     * is already scaled, since the scaled icon image will be cached).
5100     *
5101     * @see elm_icon_smooth_get()
5102     *
5103     * @ingroup Icon
5104     */
5105    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5106    /**
5107     * Get whether smooth scaling is enabled for an icon object.
5108     *
5109     * @param obj The icon object
5110     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5111     *
5112     * @see elm_icon_smooth_set()
5113     *
5114     * @ingroup Icon
5115     */
5116    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5117    /**
5118     * Disable scaling of this object.
5119     *
5120     * @param obj The icon object.
5121     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5122     * otherwise. Default is @c EINA_FALSE.
5123     *
5124     * This function disables scaling of the icon object through the function
5125     * elm_object_scale_set(). However, this does not affect the object
5126     * size/resize in any way. For that effect, take a look at
5127     * elm_icon_scale_set().
5128     *
5129     * @see elm_icon_no_scale_get()
5130     * @see elm_icon_scale_set()
5131     * @see elm_object_scale_set()
5132     *
5133     * @ingroup Icon
5134     */
5135    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5136    /**
5137     * Get whether scaling is disabled on the object.
5138     *
5139     * @param obj The icon object
5140     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5141     *
5142     * @see elm_icon_no_scale_set()
5143     *
5144     * @ingroup Icon
5145     */
5146    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5147    /**
5148     * Set if the object is (up/down) resizable.
5149     *
5150     * @param obj The icon object
5151     * @param scale_up A bool to set if the object is resizable up. Default is
5152     * @c EINA_TRUE.
5153     * @param scale_down A bool to set if the object is resizable down. Default
5154     * is @c EINA_TRUE.
5155     *
5156     * This function limits the icon object resize ability. If @p scale_up is set to
5157     * @c EINA_FALSE, the object can't have its height or width resized to a value
5158     * higher than the original icon size. Same is valid for @p scale_down.
5159     *
5160     * @see elm_icon_scale_get()
5161     *
5162     * @ingroup Icon
5163     */
5164    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5165    /**
5166     * Get if the object is (up/down) resizable.
5167     *
5168     * @param obj The icon object
5169     * @param scale_up A bool to set if the object is resizable up
5170     * @param scale_down A bool to set if the object is resizable down
5171     *
5172     * @see elm_icon_scale_set()
5173     *
5174     * @ingroup Icon
5175     */
5176    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5177    /**
5178     * Get the object's image size
5179     *
5180     * @param obj The icon object
5181     * @param w A pointer to store the width in
5182     * @param h A pointer to store the height in
5183     *
5184     * @ingroup Icon
5185     */
5186    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5187    /**
5188     * Set if the icon fill the entire object area.
5189     *
5190     * @param obj The icon object
5191     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5192     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5193     *
5194     * When the icon object is resized to a different aspect ratio from the
5195     * original icon image, the icon image will still keep its aspect. This flag
5196     * tells how the image should fill the object's area. They are: keep the
5197     * entire icon inside the limits of height and width of the object (@p
5198     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5199     * of the object, and the icon will fill the entire object (@p fill_outside
5200     * is @c EINA_TRUE).
5201     *
5202     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5203     * retain property to false. Thus, the icon image will always keep its
5204     * original aspect ratio.
5205     *
5206     * @see elm_icon_fill_outside_get()
5207     * @see elm_image_fill_outside_set()
5208     *
5209     * @ingroup Icon
5210     */
5211    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5212    /**
5213     * Get if the object is filled outside.
5214     *
5215     * @param obj The icon object
5216     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5217     *
5218     * @see elm_icon_fill_outside_set()
5219     *
5220     * @ingroup Icon
5221     */
5222    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5223    /**
5224     * Set the prescale size for the icon.
5225     *
5226     * @param obj The icon object
5227     * @param size The prescale size. This value is used for both width and
5228     * height.
5229     *
5230     * This function sets a new size for pixmap representation of the given
5231     * icon. It allows the icon to be loaded already in the specified size,
5232     * reducing the memory usage and load time when loading a big icon with load
5233     * size set to a smaller size.
5234     *
5235     * It's equivalent to the elm_bg_load_size_set() function for bg.
5236     *
5237     * @note this is just a hint, the real size of the pixmap may differ
5238     * depending on the type of icon being loaded, being bigger than requested.
5239     *
5240     * @see elm_icon_prescale_get()
5241     * @see elm_bg_load_size_set()
5242     *
5243     * @ingroup Icon
5244     */
5245    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5246    /**
5247     * Get the prescale size for the icon.
5248     *
5249     * @param obj The icon object
5250     * @return The prescale size
5251     *
5252     * @see elm_icon_prescale_set()
5253     *
5254     * @ingroup Icon
5255     */
5256    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5257    /**
5258     * Gets the image object of the icon. DO NOT MODIFY THIS.
5259     *
5260     * @param obj The icon object
5261     * @return The internal icon object
5262     *
5263     * @ingroup Icon
5264     */
5265    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5266    /**
5267     * Sets the icon lookup order used by elm_icon_standard_set().
5268     *
5269     * @param obj The icon object
5270     * @param order The icon lookup order (can be one of
5271     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5272     * or ELM_ICON_LOOKUP_THEME)
5273     *
5274     * @see elm_icon_order_lookup_get()
5275     * @see Elm_Icon_Lookup_Order
5276     *
5277     * @ingroup Icon
5278     */
5279    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5280    /**
5281     * Gets the icon lookup order.
5282     *
5283     * @param obj The icon object
5284     * @return The icon lookup order
5285     *
5286     * @see elm_icon_order_lookup_set()
5287     * @see Elm_Icon_Lookup_Order
5288     *
5289     * @ingroup Icon
5290     */
5291    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5292    /**
5293     * Enable or disable preloading of the icon
5294     *
5295     * @param obj The icon object
5296     * @param disable If EINA_TRUE, preloading will be disabled
5297     * @ingroup Icon
5298     */
5299    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5300    /**
5301     * Get if the icon supports animation or not.
5302     *
5303     * @param obj The icon object
5304     * @return @c EINA_TRUE if the icon supports animation,
5305     *         @c EINA_FALSE otherwise.
5306     *
5307     * Return if this elm icon's image can be animated. Currently Evas only
5308     * supports gif animation. If the return value is EINA_FALSE, other
5309     * elm_icon_animated_XXX APIs won't work.
5310     * @ingroup Icon
5311     */
5312    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5313    /**
5314     * Set animation mode of the icon.
5315     *
5316     * @param obj The icon object
5317     * @param anim @c EINA_TRUE if the object do animation job,
5318     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5319     *
5320     * Since the default animation mode is set to EINA_FALSE, 
5321     * the icon is shown without animation.
5322     * This might be desirable when the application developer wants to show
5323     * a snapshot of the animated icon.
5324     * Set it to EINA_TRUE when the icon needs to be animated.
5325     * @ingroup Icon
5326     */
5327    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5328    /**
5329     * Get animation mode of the icon.
5330     *
5331     * @param obj The icon object
5332     * @return The animation mode of the icon object
5333     * @see elm_icon_animated_set
5334     * @ingroup Icon
5335     */
5336    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5337    /**
5338     * Set animation play mode of the icon.
5339     *
5340     * @param obj The icon object
5341     * @param play @c EINA_TRUE the object play animation images,
5342     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5343     *
5344     * To play elm icon's animation, set play to EINA_TURE.
5345     * For example, you make gif player using this set/get API and click event.
5346     *
5347     * 1. Click event occurs
5348     * 2. Check play flag using elm_icon_animaged_play_get
5349     * 3. If elm icon was playing, set play to EINA_FALSE.
5350     *    Then animation will be stopped and vice versa
5351     * @ingroup Icon
5352     */
5353    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5354    /**
5355     * Get animation play mode of the icon.
5356     *
5357     * @param obj The icon object
5358     * @return The play mode of the icon object
5359     *
5360     * @see elm_icon_animated_play_get
5361     * @ingroup Icon
5362     */
5363    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5364
5365    /* compatibility code to avoid API and ABI breaks */
5366    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5367      {
5368         elm_icon_animated_set(obj, animated);
5369      }
5370
5371    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5372      {
5373         return elm_icon_animated_get(obj);
5374      }
5375
5376    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5377      {
5378         elm_icon_animated_play_set(obj, play);
5379      }
5380
5381    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5382      {
5383         return elm_icon_animated_play_get(obj);
5384      }
5385
5386    /**
5387     * @}
5388     */
5389
5390    /**
5391     * @defgroup Image Image
5392     *
5393     * @image html img/widget/image/preview-00.png
5394     * @image latex img/widget/image/preview-00.eps
5395
5396     *
5397     * An object that allows one to load an image file to it. It can be used
5398     * anywhere like any other elementary widget.
5399     *
5400     * This widget provides most of the functionality provided from @ref Bg or @ref
5401     * Icon, but with a slightly different API (use the one that fits better your
5402     * needs).
5403     *
5404     * The features not provided by those two other image widgets are:
5405     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5406     * @li change the object orientation with elm_image_orient_set();
5407     * @li and turning the image editable with elm_image_editable_set().
5408     *
5409     * Signals that you can add callbacks for are:
5410     *
5411     * @li @c "clicked" - This is called when a user has clicked the image
5412     *
5413     * An example of usage for this API follows:
5414     * @li @ref tutorial_image
5415     */
5416
5417    /**
5418     * @addtogroup Image
5419     * @{
5420     */
5421
5422    /**
5423     * @enum _Elm_Image_Orient
5424     * @typedef Elm_Image_Orient
5425     *
5426     * Possible orientation options for elm_image_orient_set().
5427     *
5428     * @image html elm_image_orient_set.png
5429     * @image latex elm_image_orient_set.eps width=\textwidth
5430     *
5431     * @ingroup Image
5432     */
5433    typedef enum _Elm_Image_Orient
5434      {
5435         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5436         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5437         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5438         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5439         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5440         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5441         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5442         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5443      } Elm_Image_Orient;
5444
5445    /**
5446     * Add a new image to the parent.
5447     *
5448     * @param parent The parent object
5449     * @return The new object or NULL if it cannot be created
5450     *
5451     * @see elm_image_file_set()
5452     *
5453     * @ingroup Image
5454     */
5455    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5456    /**
5457     * Set the file that will be used as image.
5458     *
5459     * @param obj The image object
5460     * @param file The path to file that will be used as image
5461     * @param group The group that the image belongs in edje file (if it's an
5462     * edje image)
5463     *
5464     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5465     *
5466     * @see elm_image_file_get()
5467     *
5468     * @ingroup Image
5469     */
5470    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5471    /**
5472     * Get the file that will be used as image.
5473     *
5474     * @param obj The image object
5475     * @param file The path to file
5476     * @param group The group that the image belongs in edje file
5477     *
5478     * @see elm_image_file_set()
5479     *
5480     * @ingroup Image
5481     */
5482    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5483    /**
5484     * Set the smooth effect for an image.
5485     *
5486     * @param obj The image object
5487     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5488     * otherwise. Default is @c EINA_TRUE.
5489     *
5490     * Set the scaling algorithm to be used when scaling the image. Smooth
5491     * scaling provides a better resulting image, but is slower.
5492     *
5493     * The smooth scaling should be disabled when making animations that change
5494     * the image size, since it will be faster. Animations that don't require
5495     * resizing of the image can keep the smooth scaling enabled (even if the
5496     * image is already scaled, since the scaled image will be cached).
5497     *
5498     * @see elm_image_smooth_get()
5499     *
5500     * @ingroup Image
5501     */
5502    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5503    /**
5504     * Get the smooth effect for an image.
5505     *
5506     * @param obj The image object
5507     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5508     *
5509     * @see elm_image_smooth_get()
5510     *
5511     * @ingroup Image
5512     */
5513    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5514
5515    /**
5516     * Gets the current size of the image.
5517     *
5518     * @param obj The image object.
5519     * @param w Pointer to store width, or NULL.
5520     * @param h Pointer to store height, or NULL.
5521     *
5522     * This is the real size of the image, not the size of the object.
5523     *
5524     * On error, neither w or h will be written.
5525     *
5526     * @ingroup Image
5527     */
5528    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5529    /**
5530     * Disable scaling of this object.
5531     *
5532     * @param obj The image object.
5533     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5534     * otherwise. Default is @c EINA_FALSE.
5535     *
5536     * This function disables scaling of the elm_image widget through the
5537     * function elm_object_scale_set(). However, this does not affect the widget
5538     * size/resize in any way. For that effect, take a look at
5539     * elm_image_scale_set().
5540     *
5541     * @see elm_image_no_scale_get()
5542     * @see elm_image_scale_set()
5543     * @see elm_object_scale_set()
5544     *
5545     * @ingroup Image
5546     */
5547    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5548    /**
5549     * Get whether scaling is disabled on the object.
5550     *
5551     * @param obj The image object
5552     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5553     *
5554     * @see elm_image_no_scale_set()
5555     *
5556     * @ingroup Image
5557     */
5558    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5559    /**
5560     * Set if the object is (up/down) resizable.
5561     *
5562     * @param obj The image object
5563     * @param scale_up A bool to set if the object is resizable up. Default is
5564     * @c EINA_TRUE.
5565     * @param scale_down A bool to set if the object is resizable down. Default
5566     * is @c EINA_TRUE.
5567     *
5568     * This function limits the image resize ability. If @p scale_up is set to
5569     * @c EINA_FALSE, the object can't have its height or width resized to a value
5570     * higher than the original image size. Same is valid for @p scale_down.
5571     *
5572     * @see elm_image_scale_get()
5573     *
5574     * @ingroup Image
5575     */
5576    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5577    /**
5578     * Get if the object is (up/down) resizable.
5579     *
5580     * @param obj The image object
5581     * @param scale_up A bool to set if the object is resizable up
5582     * @param scale_down A bool to set if the object is resizable down
5583     *
5584     * @see elm_image_scale_set()
5585     *
5586     * @ingroup Image
5587     */
5588    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5589    /**
5590     * Set if the image fills the entire object area, when keeping the aspect ratio.
5591     *
5592     * @param obj The image object
5593     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5594     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5595     *
5596     * When the image should keep its aspect ratio even if resized to another
5597     * aspect ratio, there are two possibilities to resize it: keep the entire
5598     * image inside the limits of height and width of the object (@p fill_outside
5599     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5600     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5601     *
5602     * @note This option will have no effect if
5603     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5604     *
5605     * @see elm_image_fill_outside_get()
5606     * @see elm_image_aspect_ratio_retained_set()
5607     *
5608     * @ingroup Image
5609     */
5610    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5611    /**
5612     * Get if the object is filled outside
5613     *
5614     * @param obj The image object
5615     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5616     *
5617     * @see elm_image_fill_outside_set()
5618     *
5619     * @ingroup Image
5620     */
5621    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5622    /**
5623     * Set the prescale size for the image
5624     *
5625     * @param obj The image object
5626     * @param size The prescale size. This value is used for both width and
5627     * height.
5628     *
5629     * This function sets a new size for pixmap representation of the given
5630     * image. It allows the image to be loaded already in the specified size,
5631     * reducing the memory usage and load time when loading a big image with load
5632     * size set to a smaller size.
5633     *
5634     * It's equivalent to the elm_bg_load_size_set() function for bg.
5635     *
5636     * @note this is just a hint, the real size of the pixmap may differ
5637     * depending on the type of image being loaded, being bigger than requested.
5638     *
5639     * @see elm_image_prescale_get()
5640     * @see elm_bg_load_size_set()
5641     *
5642     * @ingroup Image
5643     */
5644    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5645    /**
5646     * Get the prescale size for the image
5647     *
5648     * @param obj The image object
5649     * @return The prescale size
5650     *
5651     * @see elm_image_prescale_set()
5652     *
5653     * @ingroup Image
5654     */
5655    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5656    /**
5657     * Set the image orientation.
5658     *
5659     * @param obj The image object
5660     * @param orient The image orientation @ref Elm_Image_Orient
5661     *  Default is #ELM_IMAGE_ORIENT_NONE.
5662     *
5663     * This function allows to rotate or flip the given image.
5664     *
5665     * @see elm_image_orient_get()
5666     * @see @ref Elm_Image_Orient
5667     *
5668     * @ingroup Image
5669     */
5670    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5671    /**
5672     * Get the image orientation.
5673     *
5674     * @param obj The image object
5675     * @return The image orientation @ref Elm_Image_Orient
5676     *
5677     * @see elm_image_orient_set()
5678     * @see @ref Elm_Image_Orient
5679     *
5680     * @ingroup Image
5681     */
5682    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5683    /**
5684     * Make the image 'editable'.
5685     *
5686     * @param obj Image object.
5687     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5688     *
5689     * This means the image is a valid drag target for drag and drop, and can be
5690     * cut or pasted too.
5691     *
5692     * @ingroup Image
5693     */
5694    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5695    /**
5696     * Check if the image 'editable'.
5697     *
5698     * @param obj Image object.
5699     * @return Editability.
5700     *
5701     * A return value of EINA_TRUE means the image is a valid drag target
5702     * for drag and drop, and can be cut or pasted too.
5703     *
5704     * @ingroup Image
5705     */
5706    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5707    /**
5708     * Get the basic Evas_Image object from this object (widget).
5709     *
5710     * @param obj The image object to get the inlined image from
5711     * @return The inlined image object, or NULL if none exists
5712     *
5713     * This function allows one to get the underlying @c Evas_Object of type
5714     * Image from this elementary widget. It can be useful to do things like get
5715     * the pixel data, save the image to a file, etc.
5716     *
5717     * @note Be careful to not manipulate it, as it is under control of
5718     * elementary.
5719     *
5720     * @ingroup Image
5721     */
5722    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5723    /**
5724     * Set whether the original aspect ratio of the image should be kept on resize.
5725     *
5726     * @param obj The image object.
5727     * @param retained @c EINA_TRUE if the image should retain the aspect,
5728     * @c EINA_FALSE otherwise.
5729     *
5730     * The original aspect ratio (width / height) of the image is usually
5731     * distorted to match the object's size. Enabling this option will retain
5732     * this original aspect, and the way that the image is fit into the object's
5733     * area depends on the option set by elm_image_fill_outside_set().
5734     *
5735     * @see elm_image_aspect_ratio_retained_get()
5736     * @see elm_image_fill_outside_set()
5737     *
5738     * @ingroup Image
5739     */
5740    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5741    /**
5742     * Get if the object retains the original aspect ratio.
5743     *
5744     * @param obj The image object.
5745     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5746     * otherwise.
5747     *
5748     * @ingroup Image
5749     */
5750    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5751
5752    /**
5753     * @}
5754     */
5755
5756    /* glview */
5757    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5758
5759    /* old API compatibility */
5760    typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5761
5762    typedef enum _Elm_GLView_Mode
5763      {
5764         ELM_GLVIEW_ALPHA   = 1,
5765         ELM_GLVIEW_DEPTH   = 2,
5766         ELM_GLVIEW_STENCIL = 4
5767      } Elm_GLView_Mode;
5768
5769    /**
5770     * Defines a policy for the glview resizing.
5771     *
5772     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5773     */
5774    typedef enum _Elm_GLView_Resize_Policy
5775      {
5776         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5777         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5778      } Elm_GLView_Resize_Policy;
5779
5780    typedef enum _Elm_GLView_Render_Policy
5781      {
5782         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5783         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5784      } Elm_GLView_Render_Policy;
5785
5786    /**
5787     * @defgroup GLView
5788     *
5789     * A simple GLView widget that allows GL rendering.
5790     *
5791     * Signals that you can add callbacks for are:
5792     *
5793     * @{
5794     */
5795
5796    /**
5797     * Add a new glview to the parent
5798     *
5799     * @param parent The parent object
5800     * @return The new object or NULL if it cannot be created
5801     *
5802     * @ingroup GLView
5803     */
5804    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5805
5806    /**
5807     * Sets the size of the glview
5808     *
5809     * @param obj The glview object
5810     * @param width width of the glview object
5811     * @param height height of the glview object
5812     *
5813     * @ingroup GLView
5814     */
5815    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5816
5817    /**
5818     * Gets the size of the glview.
5819     *
5820     * @param obj The glview object
5821     * @param width width of the glview object
5822     * @param height height of the glview object
5823     *
5824     * Note that this function returns the actual image size of the
5825     * glview.  This means that when the scale policy is set to
5826     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5827     * size.
5828     *
5829     * @ingroup GLView
5830     */
5831    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5832
5833    /**
5834     * Gets the gl api struct for gl rendering
5835     *
5836     * @param obj The glview object
5837     * @return The api object or NULL if it cannot be created
5838     *
5839     * @ingroup GLView
5840     */
5841    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5842
5843    /**
5844     * Set the mode of the GLView. Supports Three simple modes.
5845     *
5846     * @param obj The glview object
5847     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5848     * @return True if set properly.
5849     *
5850     * @ingroup GLView
5851     */
5852    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5853
5854    /**
5855     * Set the resize policy for the glview object.
5856     *
5857     * @param obj The glview object.
5858     * @param policy The scaling policy.
5859     *
5860     * By default, the resize policy is set to
5861     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5862     * destroys the previous surface and recreates the newly specified
5863     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5864     * however, glview only scales the image object and not the underlying
5865     * GL Surface.
5866     *
5867     * @ingroup GLView
5868     */
5869    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5870
5871    /**
5872     * Set the render policy for the glview object.
5873     *
5874     * @param obj The glview object.
5875     * @param policy The render policy.
5876     *
5877     * By default, the render policy is set to
5878     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5879     * that during the render loop, glview is only redrawn if it needs
5880     * to be redrawn. (i.e. When it is visible) If the policy is set to
5881     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5882     * whether it is visible/need redrawing or not.
5883     *
5884     * @ingroup GLView
5885     */
5886    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5887
5888    /**
5889     * Set the init function that runs once in the main loop.
5890     *
5891     * @param obj The glview object.
5892     * @param func The init function to be registered.
5893     *
5894     * The registered init function gets called once during the render loop.
5895     *
5896     * @ingroup GLView
5897     */
5898    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5899
5900    /**
5901     * Set the render function that runs in the main loop.
5902     *
5903     * @param obj The glview object.
5904     * @param func The delete function to be registered.
5905     *
5906     * The registered del function gets called when GLView object is deleted.
5907     *
5908     * @ingroup GLView
5909     */
5910    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5911
5912    /**
5913     * Set the resize function that gets called when resize happens.
5914     *
5915     * @param obj The glview object.
5916     * @param func The resize function to be registered.
5917     *
5918     * @ingroup GLView
5919     */
5920    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5921
5922    /**
5923     * Set the render function that runs in the main loop.
5924     *
5925     * @param obj The glview object.
5926     * @param func The render function to be registered.
5927     *
5928     * @ingroup GLView
5929     */
5930    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5931
5932    /**
5933     * Notifies that there has been changes in the GLView.
5934     *
5935     * @param obj The glview object.
5936     *
5937     * @ingroup GLView
5938     */
5939    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5940
5941    /**
5942     * @}
5943     */
5944
5945    /* box */
5946    /**
5947     * @defgroup Box Box
5948     *
5949     * @image html img/widget/box/preview-00.png
5950     * @image latex img/widget/box/preview-00.eps width=\textwidth
5951     *
5952     * @image html img/box.png
5953     * @image latex img/box.eps width=\textwidth
5954     *
5955     * A box arranges objects in a linear fashion, governed by a layout function
5956     * that defines the details of this arrangement.
5957     *
5958     * By default, the box will use an internal function to set the layout to
5959     * a single row, either vertical or horizontal. This layout is affected
5960     * by a number of parameters, such as the homogeneous flag set by
5961     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5962     * elm_box_align_set() and the hints set to each object in the box.
5963     *
5964     * For this default layout, it's possible to change the orientation with
5965     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5966     * placing its elements ordered from top to bottom. When horizontal is set,
5967     * the order will go from left to right. If the box is set to be
5968     * homogeneous, every object in it will be assigned the same space, that
5969     * of the largest object. Padding can be used to set some spacing between
5970     * the cell given to each object. The alignment of the box, set with
5971     * elm_box_align_set(), determines how the bounding box of all the elements
5972     * will be placed within the space given to the box widget itself.
5973     *
5974     * The size hints of each object also affect how they are placed and sized
5975     * within the box. evas_object_size_hint_min_set() will give the minimum
5976     * size the object can have, and the box will use it as the basis for all
5977     * latter calculations. Elementary widgets set their own minimum size as
5978     * needed, so there's rarely any need to use it manually.
5979     *
5980     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5981     * used to tell whether the object will be allocated the minimum size it
5982     * needs or if the space given to it should be expanded. It's important
5983     * to realize that expanding the size given to the object is not the same
5984     * thing as resizing the object. It could very well end being a small
5985     * widget floating in a much larger empty space. If not set, the weight
5986     * for objects will normally be 0.0 for both axis, meaning the widget will
5987     * not be expanded. To take as much space possible, set the weight to
5988     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5989     *
5990     * Besides how much space each object is allocated, it's possible to control
5991     * how the widget will be placed within that space using
5992     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5993     * for both axis, meaning the object will be centered, but any value from
5994     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5995     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5996     * is -1.0, means the object will be resized to fill the entire space it
5997     * was allocated.
5998     *
5999     * In addition, customized functions to define the layout can be set, which
6000     * allow the application developer to organize the objects within the box
6001     * in any number of ways.
6002     *
6003     * The special elm_box_layout_transition() function can be used
6004     * to switch from one layout to another, animating the motion of the
6005     * children of the box.
6006     *
6007     * @note Objects should not be added to box objects using _add() calls.
6008     *
6009     * Some examples on how to use boxes follow:
6010     * @li @ref box_example_01
6011     * @li @ref box_example_02
6012     *
6013     * @{
6014     */
6015    /**
6016     * @typedef Elm_Box_Transition
6017     *
6018     * Opaque handler containing the parameters to perform an animated
6019     * transition of the layout the box uses.
6020     *
6021     * @see elm_box_transition_new()
6022     * @see elm_box_layout_set()
6023     * @see elm_box_layout_transition()
6024     */
6025    typedef struct _Elm_Box_Transition Elm_Box_Transition;
6026
6027    /**
6028     * Add a new box to the parent
6029     *
6030     * By default, the box will be in vertical mode and non-homogeneous.
6031     *
6032     * @param parent The parent object
6033     * @return The new object or NULL if it cannot be created
6034     */
6035    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6036    /**
6037     * Set the horizontal orientation
6038     *
6039     * By default, box object arranges their contents vertically from top to
6040     * bottom.
6041     * By calling this function with @p horizontal as EINA_TRUE, the box will
6042     * become horizontal, arranging contents from left to right.
6043     *
6044     * @note This flag is ignored if a custom layout function is set.
6045     *
6046     * @param obj The box object
6047     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6048     * EINA_FALSE = vertical)
6049     */
6050    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6051    /**
6052     * Get the horizontal orientation
6053     *
6054     * @param obj The box object
6055     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6056     */
6057    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6058    /**
6059     * Set the box to arrange its children homogeneously
6060     *
6061     * If enabled, homogeneous layout makes all items the same size, according
6062     * to the size of the largest of its children.
6063     *
6064     * @note This flag is ignored if a custom layout function is set.
6065     *
6066     * @param obj The box object
6067     * @param homogeneous The homogeneous flag
6068     */
6069    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6070    /**
6071     * Get whether the box is using homogeneous mode or not
6072     *
6073     * @param obj The box object
6074     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6075     */
6076    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6077    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6078    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6079    /**
6080     * Add an object to the beginning of the pack list
6081     *
6082     * Pack @p subobj into the box @p obj, placing it first in the list of
6083     * children objects. The actual position the object will get on screen
6084     * depends on the layout used. If no custom layout is set, it will be at
6085     * the top or left, depending if the box is vertical or horizontal,
6086     * respectively.
6087     *
6088     * @param obj The box object
6089     * @param subobj The object to add to the box
6090     *
6091     * @see elm_box_pack_end()
6092     * @see elm_box_pack_before()
6093     * @see elm_box_pack_after()
6094     * @see elm_box_unpack()
6095     * @see elm_box_unpack_all()
6096     * @see elm_box_clear()
6097     */
6098    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6099    /**
6100     * Add an object at the end of the pack list
6101     *
6102     * Pack @p subobj into the box @p obj, placing it last in the list of
6103     * children objects. The actual position the object will get on screen
6104     * depends on the layout used. If no custom layout is set, it will be at
6105     * the bottom or right, depending if the box is vertical or horizontal,
6106     * respectively.
6107     *
6108     * @param obj The box object
6109     * @param subobj The object to add to the box
6110     *
6111     * @see elm_box_pack_start()
6112     * @see elm_box_pack_before()
6113     * @see elm_box_pack_after()
6114     * @see elm_box_unpack()
6115     * @see elm_box_unpack_all()
6116     * @see elm_box_clear()
6117     */
6118    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6119    /**
6120     * Adds an object to the box before the indicated object
6121     *
6122     * This will add the @p subobj to the box indicated before the object
6123     * indicated with @p before. If @p before is not already in the box, results
6124     * are undefined. Before means either to the left of the indicated object or
6125     * above it depending on orientation.
6126     *
6127     * @param obj The box object
6128     * @param subobj The object to add to the box
6129     * @param before The object before which to add it
6130     *
6131     * @see elm_box_pack_start()
6132     * @see elm_box_pack_end()
6133     * @see elm_box_pack_after()
6134     * @see elm_box_unpack()
6135     * @see elm_box_unpack_all()
6136     * @see elm_box_clear()
6137     */
6138    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6139    /**
6140     * Adds an object to the box after the indicated object
6141     *
6142     * This will add the @p subobj to the box indicated after the object
6143     * indicated with @p after. If @p after is not already in the box, results
6144     * are undefined. After means either to the right of the indicated object or
6145     * below it depending on orientation.
6146     *
6147     * @param obj The box object
6148     * @param subobj The object to add to the box
6149     * @param after The object after which to add it
6150     *
6151     * @see elm_box_pack_start()
6152     * @see elm_box_pack_end()
6153     * @see elm_box_pack_before()
6154     * @see elm_box_unpack()
6155     * @see elm_box_unpack_all()
6156     * @see elm_box_clear()
6157     */
6158    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6159    /**
6160     * Clear the box of all children
6161     *
6162     * Remove all the elements contained by the box, deleting the respective
6163     * objects.
6164     *
6165     * @param obj The box object
6166     *
6167     * @see elm_box_unpack()
6168     * @see elm_box_unpack_all()
6169     */
6170    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6171    /**
6172     * Unpack a box item
6173     *
6174     * Remove the object given by @p subobj from the box @p obj without
6175     * deleting it.
6176     *
6177     * @param obj The box object
6178     *
6179     * @see elm_box_unpack_all()
6180     * @see elm_box_clear()
6181     */
6182    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6183    /**
6184     * Remove all items from the box, without deleting them
6185     *
6186     * Clear the box from all children, but don't delete the respective objects.
6187     * If no other references of the box children exist, the objects will never
6188     * be deleted, and thus the application will leak the memory. Make sure
6189     * when using this function that you hold a reference to all the objects
6190     * in the box @p obj.
6191     *
6192     * @param obj The box object
6193     *
6194     * @see elm_box_clear()
6195     * @see elm_box_unpack()
6196     */
6197    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6198    /**
6199     * Retrieve a list of the objects packed into the box
6200     *
6201     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6202     * The order of the list corresponds to the packing order the box uses.
6203     *
6204     * You must free this list with eina_list_free() once you are done with it.
6205     *
6206     * @param obj The box object
6207     */
6208    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6209    /**
6210     * Set the space (padding) between the box's elements.
6211     *
6212     * Extra space in pixels that will be added between a box child and its
6213     * neighbors after its containing cell has been calculated. This padding
6214     * is set for all elements in the box, besides any possible padding that
6215     * individual elements may have through their size hints.
6216     *
6217     * @param obj The box object
6218     * @param horizontal The horizontal space between elements
6219     * @param vertical The vertical space between elements
6220     */
6221    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6222    /**
6223     * Get the space (padding) between the box's elements.
6224     *
6225     * @param obj The box object
6226     * @param horizontal The horizontal space between elements
6227     * @param vertical The vertical space between elements
6228     *
6229     * @see elm_box_padding_set()
6230     */
6231    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6232    /**
6233     * Set the alignment of the whole bouding box of contents.
6234     *
6235     * Sets how the bounding box containing all the elements of the box, after
6236     * their sizes and position has been calculated, will be aligned within
6237     * the space given for the whole box widget.
6238     *
6239     * @param obj The box object
6240     * @param horizontal The horizontal alignment of elements
6241     * @param vertical The vertical alignment of elements
6242     */
6243    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6244    /**
6245     * Get the alignment of the whole bouding box of contents.
6246     *
6247     * @param obj The box object
6248     * @param horizontal The horizontal alignment of elements
6249     * @param vertical The vertical alignment of elements
6250     *
6251     * @see elm_box_align_set()
6252     */
6253    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6254
6255    /**
6256     * Force the box to recalculate its children packing.
6257     *
6258     * If any children was added or removed, box will not calculate the
6259     * values immediately rather leaving it to the next main loop
6260     * iteration. While this is great as it would save lots of
6261     * recalculation, whenever you need to get the position of a just
6262     * added item you must force recalculate before doing so.
6263     *
6264     * @param obj The box object.
6265     */
6266    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6267
6268    /**
6269     * Set the layout defining function to be used by the box
6270     *
6271     * Whenever anything changes that requires the box in @p obj to recalculate
6272     * the size and position of its elements, the function @p cb will be called
6273     * to determine what the layout of the children will be.
6274     *
6275     * Once a custom function is set, everything about the children layout
6276     * is defined by it. The flags set by elm_box_horizontal_set() and
6277     * elm_box_homogeneous_set() no longer have any meaning, and the values
6278     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6279     * layout function to decide if they are used and how. These last two
6280     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6281     * passed to @p cb. The @c Evas_Object the function receives is not the
6282     * Elementary widget, but the internal Evas Box it uses, so none of the
6283     * functions described here can be used on it.
6284     *
6285     * Any of the layout functions in @c Evas can be used here, as well as the
6286     * special elm_box_layout_transition().
6287     *
6288     * The final @p data argument received by @p cb is the same @p data passed
6289     * here, and the @p free_data function will be called to free it
6290     * whenever the box is destroyed or another layout function is set.
6291     *
6292     * Setting @p cb to NULL will revert back to the default layout function.
6293     *
6294     * @param obj The box object
6295     * @param cb The callback function used for layout
6296     * @param data Data that will be passed to layout function
6297     * @param free_data Function called to free @p data
6298     *
6299     * @see elm_box_layout_transition()
6300     */
6301    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);
6302    /**
6303     * Special layout function that animates the transition from one layout to another
6304     *
6305     * Normally, when switching the layout function for a box, this will be
6306     * reflected immediately on screen on the next render, but it's also
6307     * possible to do this through an animated transition.
6308     *
6309     * This is done by creating an ::Elm_Box_Transition and setting the box
6310     * layout to this function.
6311     *
6312     * For example:
6313     * @code
6314     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6315     *                            evas_object_box_layout_vertical, // start
6316     *                            NULL, // data for initial layout
6317     *                            NULL, // free function for initial data
6318     *                            evas_object_box_layout_horizontal, // end
6319     *                            NULL, // data for final layout
6320     *                            NULL, // free function for final data
6321     *                            anim_end, // will be called when animation ends
6322     *                            NULL); // data for anim_end function\
6323     * elm_box_layout_set(box, elm_box_layout_transition, t,
6324     *                    elm_box_transition_free);
6325     * @endcode
6326     *
6327     * @note This function can only be used with elm_box_layout_set(). Calling
6328     * it directly will not have the expected results.
6329     *
6330     * @see elm_box_transition_new
6331     * @see elm_box_transition_free
6332     * @see elm_box_layout_set
6333     */
6334    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6335    /**
6336     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6337     *
6338     * If you want to animate the change from one layout to another, you need
6339     * to set the layout function of the box to elm_box_layout_transition(),
6340     * passing as user data to it an instance of ::Elm_Box_Transition with the
6341     * necessary information to perform this animation. The free function to
6342     * set for the layout is elm_box_transition_free().
6343     *
6344     * The parameters to create an ::Elm_Box_Transition sum up to how long
6345     * will it be, in seconds, a layout function to describe the initial point,
6346     * another for the final position of the children and one function to be
6347     * called when the whole animation ends. This last function is useful to
6348     * set the definitive layout for the box, usually the same as the end
6349     * layout for the animation, but could be used to start another transition.
6350     *
6351     * @param start_layout The layout function that will be used to start the animation
6352     * @param start_layout_data The data to be passed the @p start_layout function
6353     * @param start_layout_free_data Function to free @p start_layout_data
6354     * @param end_layout The layout function that will be used to end the animation
6355     * @param end_layout_free_data The data to be passed the @p end_layout function
6356     * @param end_layout_free_data Function to free @p end_layout_data
6357     * @param transition_end_cb Callback function called when animation ends
6358     * @param transition_end_data Data to be passed to @p transition_end_cb
6359     * @return An instance of ::Elm_Box_Transition
6360     *
6361     * @see elm_box_transition_new
6362     * @see elm_box_layout_transition
6363     */
6364    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);
6365    /**
6366     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6367     *
6368     * This function is mostly useful as the @c free_data parameter in
6369     * elm_box_layout_set() when elm_box_layout_transition().
6370     *
6371     * @param data The Elm_Box_Transition instance to be freed.
6372     *
6373     * @see elm_box_transition_new
6374     * @see elm_box_layout_transition
6375     */
6376    EAPI void                elm_box_transition_free(void *data);
6377    /**
6378     * @}
6379     */
6380
6381    /* button */
6382    /**
6383     * @defgroup Button Button
6384     *
6385     * @image html img/widget/button/preview-00.png
6386     * @image latex img/widget/button/preview-00.eps
6387     * @image html img/widget/button/preview-01.png
6388     * @image latex img/widget/button/preview-01.eps
6389     * @image html img/widget/button/preview-02.png
6390     * @image latex img/widget/button/preview-02.eps
6391     *
6392     * This is a push-button. Press it and run some function. It can contain
6393     * a simple label and icon object and it also has an autorepeat feature.
6394     *
6395     * This widgets emits the following signals:
6396     * @li "clicked": the user clicked the button (press/release).
6397     * @li "repeated": the user pressed the button without releasing it.
6398     * @li "pressed": button was pressed.
6399     * @li "unpressed": button was released after being pressed.
6400     * In all three cases, the @c event parameter of the callback will be
6401     * @c NULL.
6402     *
6403     * Also, defined in the default theme, the button has the following styles
6404     * available:
6405     * @li default: a normal button.
6406     * @li anchor: Like default, but the button fades away when the mouse is not
6407     * over it, leaving only the text or icon.
6408     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6409     * continuous look across its options.
6410     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6411     *
6412     * Default contents parts of the button widget that you can use for are:
6413     * @li "icon" - A icon of the button
6414     *
6415     * Default text parts of the button widget that you can use for are:
6416     * @li "default" - Label of the button
6417     *
6418     * Follow through a complete example @ref button_example_01 "here".
6419     * @{
6420     */
6421
6422    typedef enum
6423      {
6424         UIControlStateDefault,
6425         UIControlStateHighlighted,
6426         UIControlStateDisabled,
6427         UIControlStateFocused,
6428         UIControlStateReserved
6429      } UIControlState;
6430
6431    /**
6432     * Add a new button to the parent's canvas
6433     *
6434     * @param parent The parent object
6435     * @return The new object or NULL if it cannot be created
6436     */
6437    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6438    /**
6439     * Set the label used in the button
6440     *
6441     * The passed @p label can be NULL to clean any existing text in it and
6442     * leave the button as an icon only object.
6443     *
6444     * @param obj The button object
6445     * @param label The text will be written on the button
6446     * @deprecated use elm_object_text_set() instead.
6447     */
6448    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6449    /**
6450     * Get the label set for the button
6451     *
6452     * The string returned is an internal pointer and should not be freed or
6453     * altered. It will also become invalid when the button is destroyed.
6454     * The string returned, if not NULL, is a stringshare, so if you need to
6455     * keep it around even after the button is destroyed, you can use
6456     * eina_stringshare_ref().
6457     *
6458     * @param obj The button object
6459     * @return The text set to the label, or NULL if nothing is set
6460     * @deprecated use elm_object_text_set() instead.
6461     */
6462    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6463    /**
6464     * Set the label for each state of button
6465     *
6466     * The passed @p label can be NULL to clean any existing text in it and
6467     * leave the button as an icon only object for the state.
6468     *
6469     * @param obj The button object
6470     * @param label The text will be written on the button
6471     * @param state The state of button
6472     *
6473     * @ingroup Button
6474     */
6475    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6476    /**
6477     * Get the label of button for each state
6478     *
6479     * The string returned is an internal pointer and should not be freed or
6480     * altered. It will also become invalid when the button is destroyed.
6481     * The string returned, if not NULL, is a stringshare, so if you need to
6482     * keep it around even after the button is destroyed, you can use
6483     * eina_stringshare_ref().
6484     *
6485     * @param obj The button object
6486     * @param state The state of button
6487     * @return The title of button for state
6488     *
6489     * @ingroup Button
6490     */
6491    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6492    /**
6493     * Set the icon used for the button
6494     *
6495     * Setting a new icon will delete any other that was previously set, making
6496     * any reference to them invalid. If you need to maintain the previous
6497     * object alive, unset it first with elm_button_icon_unset().
6498     *
6499     * @param obj The button object
6500     * @param icon The icon object for the button
6501     * @deprecated use elm_object_part_content_set() instead.
6502     */
6503    WILL_DEPRECATE  EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6504    /**
6505     * Get the icon used for the button
6506     *
6507     * Return the icon object which is set for this widget. If the button is
6508     * destroyed or another icon is set, the returned object will be deleted
6509     * and any reference to it will be invalid.
6510     *
6511     * @param obj The button object
6512     * @return The icon object that is being used
6513     *
6514     * @deprecated use elm_object_part_content_get() instead
6515     */
6516    WILL_DEPRECATE  EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6517    /**
6518     * Remove the icon set without deleting it and return the object
6519     *
6520     * This function drops the reference the button holds of the icon object
6521     * and returns this last object. It is used in case you want to remove any
6522     * icon, or set another one, without deleting the actual object. The button
6523     * will be left without an icon set.
6524     *
6525     * @param obj The button object
6526     * @return The icon object that was being used
6527     * @deprecated use elm_object_part_content_unset() instead.
6528     */
6529    WILL_DEPRECATE  EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6530    /**
6531     * Turn on/off the autorepeat event generated when the button is kept pressed
6532     *
6533     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6534     * signal when they are clicked.
6535     *
6536     * When on, keeping a button pressed will continuously emit a @c repeated
6537     * signal until the button is released. The time it takes until it starts
6538     * emitting the signal is given by
6539     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6540     * new emission by elm_button_autorepeat_gap_timeout_set().
6541     *
6542     * @param obj The button object
6543     * @param on  A bool to turn on/off the event
6544     */
6545    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6546    /**
6547     * Get whether the autorepeat feature is enabled
6548     *
6549     * @param obj The button object
6550     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6551     *
6552     * @see elm_button_autorepeat_set()
6553     */
6554    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6555    /**
6556     * Set the initial timeout before the autorepeat event is generated
6557     *
6558     * Sets the timeout, in seconds, since the button is pressed until the
6559     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6560     * won't be any delay and the even will be fired the moment the button is
6561     * pressed.
6562     *
6563     * @param obj The button object
6564     * @param t   Timeout in seconds
6565     *
6566     * @see elm_button_autorepeat_set()
6567     * @see elm_button_autorepeat_gap_timeout_set()
6568     */
6569    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6570    /**
6571     * Get the initial timeout before the autorepeat event is generated
6572     *
6573     * @param obj The button object
6574     * @return Timeout in seconds
6575     *
6576     * @see elm_button_autorepeat_initial_timeout_set()
6577     */
6578    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6579    /**
6580     * Set the interval between each generated autorepeat event
6581     *
6582     * After the first @c repeated event is fired, all subsequent ones will
6583     * follow after a delay of @p t seconds for each.
6584     *
6585     * @param obj The button object
6586     * @param t   Interval in seconds
6587     *
6588     * @see elm_button_autorepeat_initial_timeout_set()
6589     */
6590    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6591    /**
6592     * Get the interval between each generated autorepeat event
6593     *
6594     * @param obj The button object
6595     * @return Interval in seconds
6596     */
6597    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6598    /**
6599     * @}
6600     */
6601
6602    /**
6603     * @defgroup File_Selector_Button File Selector Button
6604     *
6605     * @image html img/widget/fileselector_button/preview-00.png
6606     * @image latex img/widget/fileselector_button/preview-00.eps
6607     * @image html img/widget/fileselector_button/preview-01.png
6608     * @image latex img/widget/fileselector_button/preview-01.eps
6609     * @image html img/widget/fileselector_button/preview-02.png
6610     * @image latex img/widget/fileselector_button/preview-02.eps
6611     *
6612     * This is a button that, when clicked, creates an Elementary
6613     * window (or inner window) <b> with a @ref Fileselector "file
6614     * selector widget" within</b>. When a file is chosen, the (inner)
6615     * window is closed and the button emits a signal having the
6616     * selected file as it's @c event_info.
6617     *
6618     * This widget encapsulates operations on its internal file
6619     * selector on its own API. There is less control over its file
6620     * selector than that one would have instatiating one directly.
6621     *
6622     * The following styles are available for this button:
6623     * @li @c "default"
6624     * @li @c "anchor"
6625     * @li @c "hoversel_vertical"
6626     * @li @c "hoversel_vertical_entry"
6627     *
6628     * Smart callbacks one can register to:
6629     * - @c "file,chosen" - the user has selected a path, whose string
6630     *   pointer comes as the @c event_info data (a stringshared
6631     *   string)
6632     *
6633     * Here is an example on its usage:
6634     * @li @ref fileselector_button_example
6635     *
6636     * @see @ref File_Selector_Entry for a similar widget.
6637     * @{
6638     */
6639
6640    /**
6641     * Add a new file selector button widget to the given parent
6642     * Elementary (container) object
6643     *
6644     * @param parent The parent object
6645     * @return a new file selector button widget handle or @c NULL, on
6646     * errors
6647     */
6648    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6649
6650    /**
6651     * Set the label for a given file selector button widget
6652     *
6653     * @param obj The file selector button widget
6654     * @param label The text label to be displayed on @p obj
6655     *
6656     * @deprecated use elm_object_text_set() instead.
6657     */
6658    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6659
6660    /**
6661     * Get the label set for a given file selector button widget
6662     *
6663     * @param obj The file selector button widget
6664     * @return The button label
6665     *
6666     * @deprecated use elm_object_text_set() instead.
6667     */
6668    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6669
6670    /**
6671     * Set the icon on a given file selector button widget
6672     *
6673     * @param obj The file selector button widget
6674     * @param icon The icon object for the button
6675     *
6676     * Once the icon object is set, a previously set one will be
6677     * deleted. If you want to keep the latter, use the
6678     * elm_fileselector_button_icon_unset() function.
6679     *
6680     * @see elm_fileselector_button_icon_get()
6681     */
6682    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6683
6684    /**
6685     * Get the icon set for a given file selector button widget
6686     *
6687     * @param obj The file selector button widget
6688     * @return The icon object currently set on @p obj or @c NULL, if
6689     * none is
6690     *
6691     * @see elm_fileselector_button_icon_set()
6692     */
6693    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6694
6695    /**
6696     * Unset the icon used in a given file selector button widget
6697     *
6698     * @param obj The file selector button widget
6699     * @return The icon object that was being used on @p obj or @c
6700     * NULL, on errors
6701     *
6702     * Unparent and return the icon object which was set for this
6703     * widget.
6704     *
6705     * @see elm_fileselector_button_icon_set()
6706     */
6707    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6708
6709    /**
6710     * Set the title for a given file selector button widget's window
6711     *
6712     * @param obj The file selector button widget
6713     * @param title The title string
6714     *
6715     * This will change the window's title, when the file selector pops
6716     * out after a click on the button. Those windows have the default
6717     * (unlocalized) value of @c "Select a file" as titles.
6718     *
6719     * @note It will only take any effect if the file selector
6720     * button widget is @b not under "inwin mode".
6721     *
6722     * @see elm_fileselector_button_window_title_get()
6723     */
6724    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6725
6726    /**
6727     * Get the title set for a given file selector button widget's
6728     * window
6729     *
6730     * @param obj The file selector button widget
6731     * @return Title of the file selector button's window
6732     *
6733     * @see elm_fileselector_button_window_title_get() for more details
6734     */
6735    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6736
6737    /**
6738     * Set the size of a given file selector button widget's window,
6739     * holding the file selector itself.
6740     *
6741     * @param obj The file selector button widget
6742     * @param width The window's width
6743     * @param height The window's height
6744     *
6745     * @note it will only take any effect if the file selector button
6746     * widget is @b not under "inwin mode". The default size for the
6747     * window (when applicable) is 400x400 pixels.
6748     *
6749     * @see elm_fileselector_button_window_size_get()
6750     */
6751    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6752
6753    /**
6754     * Get the size of a given file selector button widget's window,
6755     * holding the file selector itself.
6756     *
6757     * @param obj The file selector button widget
6758     * @param width Pointer into which to store the width value
6759     * @param height Pointer into which to store the height value
6760     *
6761     * @note Use @c NULL pointers on the size values you're not
6762     * interested in: they'll be ignored by the function.
6763     *
6764     * @see elm_fileselector_button_window_size_set(), for more details
6765     */
6766    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6767
6768    /**
6769     * Set the initial file system path for a given file selector
6770     * button widget
6771     *
6772     * @param obj The file selector button widget
6773     * @param path The path string
6774     *
6775     * It must be a <b>directory</b> path, which will have the contents
6776     * displayed initially in the file selector's view, when invoked
6777     * from @p obj. The default initial path is the @c "HOME"
6778     * environment variable's value.
6779     *
6780     * @see elm_fileselector_button_path_get()
6781     */
6782    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6783
6784    /**
6785     * Get the initial file system path set for a given file selector
6786     * button widget
6787     *
6788     * @param obj The file selector button widget
6789     * @return path The path string
6790     *
6791     * @see elm_fileselector_button_path_set() for more details
6792     */
6793    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6794
6795    /**
6796     * Enable/disable a tree view in the given file selector button
6797     * widget's internal file selector
6798     *
6799     * @param obj The file selector button widget
6800     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6801     * disable
6802     *
6803     * This has the same effect as elm_fileselector_expandable_set(),
6804     * but now applied to a file selector button's internal file
6805     * selector.
6806     *
6807     * @note There's no way to put a file selector button's internal
6808     * file selector in "grid mode", as one may do with "pure" file
6809     * selectors.
6810     *
6811     * @see elm_fileselector_expandable_get()
6812     */
6813    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6814
6815    /**
6816     * Get whether tree view is enabled for the given file selector
6817     * button widget's internal file selector
6818     *
6819     * @param obj The file selector button widget
6820     * @return @c EINA_TRUE if @p obj widget's internal file selector
6821     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6822     *
6823     * @see elm_fileselector_expandable_set() for more details
6824     */
6825    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6826
6827    /**
6828     * Set whether a given file selector button widget's internal file
6829     * selector is to display folders only or the directory contents,
6830     * as well.
6831     *
6832     * @param obj The file selector button widget
6833     * @param only @c EINA_TRUE to make @p obj widget's internal file
6834     * selector only display directories, @c EINA_FALSE to make files
6835     * to be displayed in it too
6836     *
6837     * This has the same effect as elm_fileselector_folder_only_set(),
6838     * but now applied to a file selector button's internal file
6839     * selector.
6840     *
6841     * @see elm_fileselector_folder_only_get()
6842     */
6843    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6844
6845    /**
6846     * Get whether a given file selector button widget's internal file
6847     * selector is displaying folders only or the directory contents,
6848     * as well.
6849     *
6850     * @param obj The file selector button widget
6851     * @return @c EINA_TRUE if @p obj widget's internal file
6852     * selector is only displaying directories, @c EINA_FALSE if files
6853     * are being displayed in it too (and on errors)
6854     *
6855     * @see elm_fileselector_button_folder_only_set() for more details
6856     */
6857    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6858
6859    /**
6860     * Enable/disable the file name entry box where the user can type
6861     * in a name for a file, in a given file selector button widget's
6862     * internal file selector.
6863     *
6864     * @param obj The file selector button widget
6865     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6866     * file selector a "saving dialog", @c EINA_FALSE otherwise
6867     *
6868     * This has the same effect as elm_fileselector_is_save_set(),
6869     * but now applied to a file selector button's internal file
6870     * selector.
6871     *
6872     * @see elm_fileselector_is_save_get()
6873     */
6874    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6875
6876    /**
6877     * Get whether the given file selector button widget's internal
6878     * file selector is in "saving dialog" mode
6879     *
6880     * @param obj The file selector button widget
6881     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6882     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6883     * errors)
6884     *
6885     * @see elm_fileselector_button_is_save_set() for more details
6886     */
6887    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6888
6889    /**
6890     * Set whether a given file selector button widget's internal file
6891     * selector will raise an Elementary "inner window", instead of a
6892     * dedicated Elementary window. By default, it won't.
6893     *
6894     * @param obj The file selector button widget
6895     * @param value @c EINA_TRUE to make it use an inner window, @c
6896     * EINA_TRUE to make it use a dedicated window
6897     *
6898     * @see elm_win_inwin_add() for more information on inner windows
6899     * @see elm_fileselector_button_inwin_mode_get()
6900     */
6901    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6902
6903    /**
6904     * Get whether a given file selector button widget's internal file
6905     * selector will raise an Elementary "inner window", instead of a
6906     * dedicated Elementary window.
6907     *
6908     * @param obj The file selector button widget
6909     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6910     * if it will use a dedicated window
6911     *
6912     * @see elm_fileselector_button_inwin_mode_set() for more details
6913     */
6914    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6915
6916    /**
6917     * @}
6918     */
6919
6920     /**
6921     * @defgroup File_Selector_Entry File Selector Entry
6922     *
6923     * @image html img/widget/fileselector_entry/preview-00.png
6924     * @image latex img/widget/fileselector_entry/preview-00.eps
6925     *
6926     * This is an entry made to be filled with or display a <b>file
6927     * system path string</b>. Besides the entry itself, the widget has
6928     * a @ref File_Selector_Button "file selector button" on its side,
6929     * which will raise an internal @ref Fileselector "file selector widget",
6930     * when clicked, for path selection aided by file system
6931     * navigation.
6932     *
6933     * This file selector may appear in an Elementary window or in an
6934     * inner window. When a file is chosen from it, the (inner) window
6935     * is closed and the selected file's path string is exposed both as
6936     * an smart event and as the new text on the entry.
6937     *
6938     * This widget encapsulates operations on its internal file
6939     * selector on its own API. There is less control over its file
6940     * selector than that one would have instatiating one directly.
6941     *
6942     * Smart callbacks one can register to:
6943     * - @c "changed" - The text within the entry was changed
6944     * - @c "activated" - The entry has had editing finished and
6945     *   changes are to be "committed"
6946     * - @c "press" - The entry has been clicked
6947     * - @c "longpressed" - The entry has been clicked (and held) for a
6948     *   couple seconds
6949     * - @c "clicked" - The entry has been clicked
6950     * - @c "clicked,double" - The entry has been double clicked
6951     * - @c "focused" - The entry has received focus
6952     * - @c "unfocused" - The entry has lost focus
6953     * - @c "selection,paste" - A paste action has occurred on the
6954     *   entry
6955     * - @c "selection,copy" - A copy action has occurred on the entry
6956     * - @c "selection,cut" - A cut action has occurred on the entry
6957     * - @c "unpressed" - The file selector entry's button was released
6958     *   after being pressed.
6959     * - @c "file,chosen" - The user has selected a path via the file
6960     *   selector entry's internal file selector, whose string pointer
6961     *   comes as the @c event_info data (a stringshared string)
6962     *
6963     * Here is an example on its usage:
6964     * @li @ref fileselector_entry_example
6965     *
6966     * @see @ref File_Selector_Button for a similar widget.
6967     * @{
6968     */
6969
6970    /**
6971     * Add a new file selector entry widget to the given parent
6972     * Elementary (container) object
6973     *
6974     * @param parent The parent object
6975     * @return a new file selector entry widget handle or @c NULL, on
6976     * errors
6977     */
6978    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6979
6980    /**
6981     * Set the label for a given file selector entry widget's button
6982     *
6983     * @param obj The file selector entry widget
6984     * @param label The text label to be displayed on @p obj widget's
6985     * button
6986     *
6987     * @deprecated use elm_object_text_set() instead.
6988     */
6989    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6990
6991    /**
6992     * Get the label set for a given file selector entry widget's button
6993     *
6994     * @param obj The file selector entry widget
6995     * @return The widget button's label
6996     *
6997     * @deprecated use elm_object_text_set() instead.
6998     */
6999    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7000
7001    /**
7002     * Set the icon on a given file selector entry widget's button
7003     *
7004     * @param obj The file selector entry widget
7005     * @param icon The icon object for the entry's button
7006     *
7007     * Once the icon object is set, a previously set one will be
7008     * deleted. If you want to keep the latter, use the
7009     * elm_fileselector_entry_button_icon_unset() function.
7010     *
7011     * @see elm_fileselector_entry_button_icon_get()
7012     */
7013    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7014
7015    /**
7016     * Get the icon set for a given file selector entry widget's button
7017     *
7018     * @param obj The file selector entry widget
7019     * @return The icon object currently set on @p obj widget's button
7020     * or @c NULL, if none is
7021     *
7022     * @see elm_fileselector_entry_button_icon_set()
7023     */
7024    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7025
7026    /**
7027     * Unset the icon used in a given file selector entry widget's
7028     * button
7029     *
7030     * @param obj The file selector entry widget
7031     * @return The icon object that was being used on @p obj widget's
7032     * button or @c NULL, on errors
7033     *
7034     * Unparent and return the icon object which was set for this
7035     * widget's button.
7036     *
7037     * @see elm_fileselector_entry_button_icon_set()
7038     */
7039    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7040
7041    /**
7042     * Set the title for a given file selector entry widget's window
7043     *
7044     * @param obj The file selector entry widget
7045     * @param title The title string
7046     *
7047     * This will change the window's title, when the file selector pops
7048     * out after a click on the entry's button. Those windows have the
7049     * default (unlocalized) value of @c "Select a file" as titles.
7050     *
7051     * @note It will only take any effect if the file selector
7052     * entry widget is @b not under "inwin mode".
7053     *
7054     * @see elm_fileselector_entry_window_title_get()
7055     */
7056    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7057
7058    /**
7059     * Get the title set for a given file selector entry widget's
7060     * window
7061     *
7062     * @param obj The file selector entry widget
7063     * @return Title of the file selector entry's window
7064     *
7065     * @see elm_fileselector_entry_window_title_get() for more details
7066     */
7067    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7068
7069    /**
7070     * Set the size of a given file selector entry widget's window,
7071     * holding the file selector itself.
7072     *
7073     * @param obj The file selector entry widget
7074     * @param width The window's width
7075     * @param height The window's height
7076     *
7077     * @note it will only take any effect if the file selector entry
7078     * widget is @b not under "inwin mode". The default size for the
7079     * window (when applicable) is 400x400 pixels.
7080     *
7081     * @see elm_fileselector_entry_window_size_get()
7082     */
7083    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7084
7085    /**
7086     * Get the size of a given file selector entry widget's window,
7087     * holding the file selector itself.
7088     *
7089     * @param obj The file selector entry widget
7090     * @param width Pointer into which to store the width value
7091     * @param height Pointer into which to store the height value
7092     *
7093     * @note Use @c NULL pointers on the size values you're not
7094     * interested in: they'll be ignored by the function.
7095     *
7096     * @see elm_fileselector_entry_window_size_set(), for more details
7097     */
7098    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7099
7100    /**
7101     * Set the initial file system path and the entry's path string for
7102     * a given file selector entry widget
7103     *
7104     * @param obj The file selector entry widget
7105     * @param path The path string
7106     *
7107     * It must be a <b>directory</b> path, which will have the contents
7108     * displayed initially in the file selector's view, when invoked
7109     * from @p obj. The default initial path is the @c "HOME"
7110     * environment variable's value.
7111     *
7112     * @see elm_fileselector_entry_path_get()
7113     */
7114    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7115
7116    /**
7117     * Get the entry's path string for a given file selector entry
7118     * widget
7119     *
7120     * @param obj The file selector entry widget
7121     * @return path The path string
7122     *
7123     * @see elm_fileselector_entry_path_set() for more details
7124     */
7125    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7126
7127    /**
7128     * Enable/disable a tree view in the given file selector entry
7129     * widget's internal file selector
7130     *
7131     * @param obj The file selector entry widget
7132     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7133     * disable
7134     *
7135     * This has the same effect as elm_fileselector_expandable_set(),
7136     * but now applied to a file selector entry's internal file
7137     * selector.
7138     *
7139     * @note There's no way to put a file selector entry's internal
7140     * file selector in "grid mode", as one may do with "pure" file
7141     * selectors.
7142     *
7143     * @see elm_fileselector_expandable_get()
7144     */
7145    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7146
7147    /**
7148     * Get whether tree view is enabled for the given file selector
7149     * entry widget's internal file selector
7150     *
7151     * @param obj The file selector entry widget
7152     * @return @c EINA_TRUE if @p obj widget's internal file selector
7153     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7154     *
7155     * @see elm_fileselector_expandable_set() for more details
7156     */
7157    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7158
7159    /**
7160     * Set whether a given file selector entry widget's internal file
7161     * selector is to display folders only or the directory contents,
7162     * as well.
7163     *
7164     * @param obj The file selector entry widget
7165     * @param only @c EINA_TRUE to make @p obj widget's internal file
7166     * selector only display directories, @c EINA_FALSE to make files
7167     * to be displayed in it too
7168     *
7169     * This has the same effect as elm_fileselector_folder_only_set(),
7170     * but now applied to a file selector entry's internal file
7171     * selector.
7172     *
7173     * @see elm_fileselector_folder_only_get()
7174     */
7175    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7176
7177    /**
7178     * Get whether a given file selector entry widget's internal file
7179     * selector is displaying folders only or the directory contents,
7180     * as well.
7181     *
7182     * @param obj The file selector entry widget
7183     * @return @c EINA_TRUE if @p obj widget's internal file
7184     * selector is only displaying directories, @c EINA_FALSE if files
7185     * are being displayed in it too (and on errors)
7186     *
7187     * @see elm_fileselector_entry_folder_only_set() for more details
7188     */
7189    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7190
7191    /**
7192     * Enable/disable the file name entry box where the user can type
7193     * in a name for a file, in a given file selector entry widget's
7194     * internal file selector.
7195     *
7196     * @param obj The file selector entry widget
7197     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7198     * file selector a "saving dialog", @c EINA_FALSE otherwise
7199     *
7200     * This has the same effect as elm_fileselector_is_save_set(),
7201     * but now applied to a file selector entry's internal file
7202     * selector.
7203     *
7204     * @see elm_fileselector_is_save_get()
7205     */
7206    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7207
7208    /**
7209     * Get whether the given file selector entry widget's internal
7210     * file selector is in "saving dialog" mode
7211     *
7212     * @param obj The file selector entry widget
7213     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7214     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7215     * errors)
7216     *
7217     * @see elm_fileselector_entry_is_save_set() for more details
7218     */
7219    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7220
7221    /**
7222     * Set whether a given file selector entry widget's internal file
7223     * selector will raise an Elementary "inner window", instead of a
7224     * dedicated Elementary window. By default, it won't.
7225     *
7226     * @param obj The file selector entry widget
7227     * @param value @c EINA_TRUE to make it use an inner window, @c
7228     * EINA_TRUE to make it use a dedicated window
7229     *
7230     * @see elm_win_inwin_add() for more information on inner windows
7231     * @see elm_fileselector_entry_inwin_mode_get()
7232     */
7233    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7234
7235    /**
7236     * Get whether a given file selector entry widget's internal file
7237     * selector will raise an Elementary "inner window", instead of a
7238     * dedicated Elementary window.
7239     *
7240     * @param obj The file selector entry widget
7241     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7242     * if it will use a dedicated window
7243     *
7244     * @see elm_fileselector_entry_inwin_mode_set() for more details
7245     */
7246    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7247
7248    /**
7249     * Set the initial file system path for a given file selector entry
7250     * widget
7251     *
7252     * @param obj The file selector entry widget
7253     * @param path The path string
7254     *
7255     * It must be a <b>directory</b> path, which will have the contents
7256     * displayed initially in the file selector's view, when invoked
7257     * from @p obj. The default initial path is the @c "HOME"
7258     * environment variable's value.
7259     *
7260     * @see elm_fileselector_entry_path_get()
7261     */
7262    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7263
7264    /**
7265     * Get the parent directory's path to the latest file selection on
7266     * a given filer selector entry widget
7267     *
7268     * @param obj The file selector object
7269     * @return The (full) path of the directory of the last selection
7270     * on @p obj widget, a @b stringshared string
7271     *
7272     * @see elm_fileselector_entry_path_set()
7273     */
7274    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7275
7276    /**
7277     * @}
7278     */
7279
7280    /**
7281     * @defgroup Scroller Scroller
7282     *
7283     * A scroller holds a single object and "scrolls it around". This means that
7284     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7285     * region around, allowing to move through a much larger object that is
7286     * contained in the scroller. The scroller will always have a small minimum
7287     * size by default as it won't be limited by the contents of the scroller.
7288     *
7289     * Signals that you can add callbacks for are:
7290     * @li "edge,left" - the left edge of the content has been reached
7291     * @li "edge,right" - the right edge of the content has been reached
7292     * @li "edge,top" - the top edge of the content has been reached
7293     * @li "edge,bottom" - the bottom edge of the content has been reached
7294     * @li "scroll" - the content has been scrolled (moved)
7295     * @li "scroll,anim,start" - scrolling animation has started
7296     * @li "scroll,anim,stop" - scrolling animation has stopped
7297     * @li "scroll,drag,start" - dragging the contents around has started
7298     * @li "scroll,drag,stop" - dragging the contents around has stopped
7299     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7300     * user intervetion.
7301     *
7302     * @note When Elemementary is in embedded mode the scrollbars will not be
7303     * dragable, they appear merely as indicators of how much has been scrolled.
7304     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7305     * fingerscroll) won't work.
7306     *
7307     * Default contents parts of the scroller widget that you can use for are:
7308     * @li "default" - A content of the scroller
7309     *
7310     * In @ref tutorial_scroller you'll find an example of how to use most of
7311     * this API.
7312     * @{
7313     */
7314    /**
7315     * @brief Type that controls when scrollbars should appear.
7316     *
7317     * @see elm_scroller_policy_set()
7318     */
7319    typedef enum _Elm_Scroller_Policy
7320      {
7321         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7322         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7323         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7324         ELM_SCROLLER_POLICY_LAST
7325      } Elm_Scroller_Policy;
7326    /**
7327     * @brief Add a new scroller to the parent
7328     *
7329     * @param parent The parent object
7330     * @return The new object or NULL if it cannot be created
7331     */
7332    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7333    /**
7334     * @brief Set the content of the scroller widget (the object to be scrolled around).
7335     *
7336     * @param obj The scroller object
7337     * @param content The new content object
7338     *
7339     * Once the content object is set, a previously set one will be deleted.
7340     * If you want to keep that old content object, use the
7341     * elm_scroller_content_unset() function.
7342     * @deprecated use elm_object_content_set() instead
7343     */
7344    WILL_DEPRECATE  EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7345    /**
7346     * @brief Get the content of the scroller widget
7347     *
7348     * @param obj The slider object
7349     * @return The content that is being used
7350     *
7351     * Return the content object which is set for this widget
7352     *
7353     * @see elm_scroller_content_set()
7354     * @deprecated use elm_object_content_get() instead.
7355     */
7356    WILL_DEPRECATE  EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7357    /**
7358     * @brief Unset the content of the scroller widget
7359     *
7360     * @param obj The slider object
7361     * @return The content that was being used
7362     *
7363     * Unparent and return the content object which was set for this widget
7364     *
7365     * @see elm_scroller_content_set()
7366     * @deprecated use elm_object_content_unset() instead.
7367     */
7368    WILL_DEPRECATE  EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7369    /**
7370     * @brief Set custom theme elements for the scroller
7371     *
7372     * @param obj The scroller object
7373     * @param widget The widget name to use (default is "scroller")
7374     * @param base The base name to use (default is "base")
7375     */
7376    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7377    /**
7378     * @brief Make the scroller minimum size limited to the minimum size of the content
7379     *
7380     * @param obj The scroller object
7381     * @param w Enable limiting minimum size horizontally
7382     * @param h Enable limiting minimum size vertically
7383     *
7384     * By default the scroller will be as small as its design allows,
7385     * irrespective of its content. This will make the scroller minimum size the
7386     * right size horizontally and/or vertically to perfectly fit its content in
7387     * that direction.
7388     */
7389    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7390    /**
7391     * @brief Show a specific virtual region within the scroller content object
7392     *
7393     * @param obj The scroller object
7394     * @param x X coordinate of the region
7395     * @param y Y coordinate of the region
7396     * @param w Width of the region
7397     * @param h Height of the region
7398     *
7399     * This will ensure all (or part if it does not fit) of the designated
7400     * region in the virtual content object (0, 0 starting at the top-left of the
7401     * virtual content object) is shown within the scroller.
7402     */
7403    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);
7404    /**
7405     * @brief Set the scrollbar visibility policy
7406     *
7407     * @param obj The scroller object
7408     * @param policy_h Horizontal scrollbar policy
7409     * @param policy_v Vertical scrollbar policy
7410     *
7411     * This sets the scrollbar visibility policy for the given scroller.
7412     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7413     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7414     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7415     * respectively for the horizontal and vertical scrollbars.
7416     */
7417    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7418    /**
7419     * @brief Gets scrollbar visibility policy
7420     *
7421     * @param obj The scroller object
7422     * @param policy_h Horizontal scrollbar policy
7423     * @param policy_v Vertical scrollbar policy
7424     *
7425     * @see elm_scroller_policy_set()
7426     */
7427    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7428    /**
7429     * @brief Get the currently visible content region
7430     *
7431     * @param obj The scroller object
7432     * @param x X coordinate of the region
7433     * @param y Y coordinate of the region
7434     * @param w Width of the region
7435     * @param h Height of the region
7436     *
7437     * This gets the current region in the content object that is visible through
7438     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7439     * w, @p h values pointed to.
7440     *
7441     * @note All coordinates are relative to the content.
7442     *
7443     * @see elm_scroller_region_show()
7444     */
7445    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);
7446    /**
7447     * @brief Get the size of the content object
7448     *
7449     * @param obj The scroller object
7450     * @param w Width of the content object.
7451     * @param h Height of the content object.
7452     *
7453     * This gets the size of the content object of the scroller.
7454     */
7455    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7456    /**
7457     * @brief Set bouncing behavior
7458     *
7459     * @param obj The scroller object
7460     * @param h_bounce Allow bounce horizontally
7461     * @param v_bounce Allow bounce vertically
7462     *
7463     * When scrolling, the scroller may "bounce" when reaching an edge of the
7464     * content object. This is a visual way to indicate the end has been reached.
7465     * This is enabled by default for both axis. This API will set if it is enabled
7466     * for the given axis with the boolean parameters for each axis.
7467     */
7468    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7469    /**
7470     * @brief Get the bounce behaviour
7471     *
7472     * @param obj The Scroller object
7473     * @param h_bounce Will the scroller bounce horizontally or not
7474     * @param v_bounce Will the scroller bounce vertically or not
7475     *
7476     * @see elm_scroller_bounce_set()
7477     */
7478    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7479    /**
7480     * @brief Set scroll page size relative to viewport size.
7481     *
7482     * @param obj The scroller object
7483     * @param h_pagerel The horizontal page relative size
7484     * @param v_pagerel The vertical page relative size
7485     *
7486     * The scroller is capable of limiting scrolling by the user to "pages". That
7487     * is to jump by and only show a "whole page" at a time as if the continuous
7488     * area of the scroller content is split into page sized pieces. This sets
7489     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7490     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7491     * axis. This is mutually exclusive with page size
7492     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7493     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7494     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7495     * the other axis.
7496     */
7497    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7498    /**
7499     * @brief Set scroll page size.
7500     *
7501     * @param obj The scroller object
7502     * @param h_pagesize The horizontal page size
7503     * @param v_pagesize The vertical page size
7504     *
7505     * This sets the page size to an absolute fixed value, with 0 turning it off
7506     * for that axis.
7507     *
7508     * @see elm_scroller_page_relative_set()
7509     */
7510    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7511    /**
7512     * @brief Get scroll current page number.
7513     *
7514     * @param obj The scroller object
7515     * @param h_pagenumber The horizontal page number
7516     * @param v_pagenumber The vertical page number
7517     *
7518     * The page number starts from 0. 0 is the first page.
7519     * Current page means the page which meets the top-left of the viewport.
7520     * If there are two or more pages in the viewport, it returns the number of the page
7521     * which meets the top-left of the viewport.
7522     *
7523     * @see elm_scroller_last_page_get()
7524     * @see elm_scroller_page_show()
7525     * @see elm_scroller_page_brint_in()
7526     */
7527    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7528    /**
7529     * @brief Get scroll last page number.
7530     *
7531     * @param obj The scroller object
7532     * @param h_pagenumber The horizontal page number
7533     * @param v_pagenumber The vertical page number
7534     *
7535     * The page number starts from 0. 0 is the first page.
7536     * This returns the last page number among the pages.
7537     *
7538     * @see elm_scroller_current_page_get()
7539     * @see elm_scroller_page_show()
7540     * @see elm_scroller_page_brint_in()
7541     */
7542    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7543    /**
7544     * Show a specific virtual region within the scroller content object by page number.
7545     *
7546     * @param obj The scroller object
7547     * @param h_pagenumber The horizontal page number
7548     * @param v_pagenumber The vertical page number
7549     *
7550     * 0, 0 of the indicated page is located at the top-left of the viewport.
7551     * This will jump to the page directly without animation.
7552     *
7553     * Example of usage:
7554     *
7555     * @code
7556     * sc = elm_scroller_add(win);
7557     * elm_scroller_content_set(sc, content);
7558     * elm_scroller_page_relative_set(sc, 1, 0);
7559     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7560     * elm_scroller_page_show(sc, h_page + 1, v_page);
7561     * @endcode
7562     *
7563     * @see elm_scroller_page_bring_in()
7564     */
7565    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7566    /**
7567     * Show a specific virtual region within the scroller content object by page number.
7568     *
7569     * @param obj The scroller object
7570     * @param h_pagenumber The horizontal page number
7571     * @param v_pagenumber The vertical page number
7572     *
7573     * 0, 0 of the indicated page is located at the top-left of the viewport.
7574     * This will slide to the page with animation.
7575     *
7576     * Example of usage:
7577     *
7578     * @code
7579     * sc = elm_scroller_add(win);
7580     * elm_scroller_content_set(sc, content);
7581     * elm_scroller_page_relative_set(sc, 1, 0);
7582     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7583     * elm_scroller_page_bring_in(sc, h_page, v_page);
7584     * @endcode
7585     *
7586     * @see elm_scroller_page_show()
7587     */
7588    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7589    /**
7590     * @brief Show a specific virtual region within the scroller content object.
7591     *
7592     * @param obj The scroller object
7593     * @param x X coordinate of the region
7594     * @param y Y coordinate of the region
7595     * @param w Width of the region
7596     * @param h Height of the region
7597     *
7598     * This will ensure all (or part if it does not fit) of the designated
7599     * region in the virtual content object (0, 0 starting at the top-left of the
7600     * virtual content object) is shown within the scroller. Unlike
7601     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7602     * to this location (if configuration in general calls for transitions). It
7603     * may not jump immediately to the new location and make take a while and
7604     * show other content along the way.
7605     *
7606     * @see elm_scroller_region_show()
7607     */
7608    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);
7609    /**
7610     * @brief Set event propagation on a scroller
7611     *
7612     * @param obj The scroller object
7613     * @param propagation If propagation is enabled or not
7614     *
7615     * This enables or disabled event propagation from the scroller content to
7616     * the scroller and its parent. By default event propagation is disabled.
7617     */
7618    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7619    /**
7620     * @brief Get event propagation for a scroller
7621     *
7622     * @param obj The scroller object
7623     * @return The propagation state
7624     *
7625     * This gets the event propagation for a scroller.
7626     *
7627     * @see elm_scroller_propagate_events_set()
7628     */
7629    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7630    /**
7631     * @brief Set scrolling gravity on a scroller
7632     *
7633     * @param obj The scroller object
7634     * @param x The scrolling horizontal gravity
7635     * @param y The scrolling vertical gravity
7636     *
7637     * The gravity, defines how the scroller will adjust its view
7638     * when the size of the scroller contents increase.
7639     *
7640     * The scroller will adjust the view to glue itself as follows.
7641     *
7642     *  x=0.0, for showing the left most region of the content.
7643     *  x=1.0, for showing the right most region of the content.
7644     *  y=0.0, for showing the bottom most region of the content.
7645     *  y=1.0, for showing the top most region of the content.
7646     *
7647     * Default values for x and y are 0.0
7648     */
7649    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7650    /**
7651     * @brief Get scrolling gravity values for a scroller
7652     *
7653     * @param obj The scroller object
7654     * @param x The scrolling horizontal gravity
7655     * @param y The scrolling vertical gravity
7656     *
7657     * This gets gravity values for a scroller.
7658     *
7659     * @see elm_scroller_gravity_set()
7660     *
7661     */
7662    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7663    /**
7664     * @}
7665     */
7666
7667    /**
7668     * @defgroup Label Label
7669     *
7670     * @image html img/widget/label/preview-00.png
7671     * @image latex img/widget/label/preview-00.eps
7672     *
7673     * @brief Widget to display text, with simple html-like markup.
7674     *
7675     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7676     * text doesn't fit the geometry of the label it will be ellipsized or be
7677     * cut. Elementary provides several styles for this widget:
7678     * @li default - No animation
7679     * @li marker - Centers the text in the label and make it bold by default
7680     * @li slide_long - The entire text appears from the right of the screen and
7681     * slides until it disappears in the left of the screen(reappering on the
7682     * right again).
7683     * @li slide_short - The text appears in the left of the label and slides to
7684     * the right to show the overflow. When all of the text has been shown the
7685     * position is reset.
7686     * @li slide_bounce - The text appears in the left of the label and slides to
7687     * the right to show the overflow. When all of the text has been shown the
7688     * animation reverses, moving the text to the left.
7689     *
7690     * Custom themes can of course invent new markup tags and style them any way
7691     * they like.
7692     *
7693     * The following signals may be emitted by the label widget:
7694     * @li "language,changed": The program's language changed.
7695     *
7696     * See @ref tutorial_label for a demonstration of how to use a label widget.
7697     * @{
7698     */
7699    /**
7700     * @brief Add a new label to the parent
7701     *
7702     * @param parent The parent object
7703     * @return The new object or NULL if it cannot be created
7704     */
7705    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7706    /**
7707     * @brief Set the label on the label object
7708     *
7709     * @param obj The label object
7710     * @param label The label will be used on the label object
7711     * @deprecated See elm_object_text_set()
7712     */
7713    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 */
7714    /**
7715     * @brief Get the label used on the label object
7716     *
7717     * @param obj The label object
7718     * @return The string inside the label
7719     * @deprecated See elm_object_text_get()
7720     */
7721    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7722    /**
7723     * @brief Set the wrapping behavior of the label
7724     *
7725     * @param obj The label object
7726     * @param wrap To wrap text or not
7727     *
7728     * By default no wrapping is done. Possible values for @p wrap are:
7729     * @li ELM_WRAP_NONE - No wrapping
7730     * @li ELM_WRAP_CHAR - wrap between characters
7731     * @li ELM_WRAP_WORD - wrap between words
7732     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7733     */
7734    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7735    /**
7736     * @brief Get the wrapping behavior of the label
7737     *
7738     * @param obj The label object
7739     * @return Wrap type
7740     *
7741     * @see elm_label_line_wrap_set()
7742     */
7743    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7744    /**
7745     * @brief Set wrap width of the label
7746     *
7747     * @param obj The label object
7748     * @param w The wrap width in pixels at a minimum where words need to wrap
7749     *
7750     * This function sets the maximum width size hint of the label.
7751     *
7752     * @warning This is only relevant if the label is inside a container.
7753     */
7754    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7755    /**
7756     * @brief Get wrap width of the label
7757     *
7758     * @param obj The label object
7759     * @return The wrap width in pixels at a minimum where words need to wrap
7760     *
7761     * @see elm_label_wrap_width_set()
7762     */
7763    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7764    /**
7765     * @brief Set wrap height of the label
7766     *
7767     * @param obj The label object
7768     * @param h The wrap height in pixels at a minimum where words need to wrap
7769     *
7770     * This function sets the maximum height size hint of the label.
7771     *
7772     * @warning This is only relevant if the label is inside a container.
7773     */
7774    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7775    /**
7776     * @brief get wrap width of the label
7777     *
7778     * @param obj The label object
7779     * @return The wrap height in pixels at a minimum where words need to wrap
7780     */
7781    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7782    /**
7783     * @brief Set the font size on the label object.
7784     *
7785     * @param obj The label object
7786     * @param size font size
7787     *
7788     * @warning NEVER use this. It is for hyper-special cases only. use styles
7789     * instead. e.g. "default", "marker", "slide_long" etc.
7790     */
7791    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7792    /**
7793     * @brief Set the text color on the label object
7794     *
7795     * @param obj The label object
7796     * @param r Red property background color of The label object
7797     * @param g Green property background color of The label object
7798     * @param b Blue property background color of The label object
7799     * @param a Alpha property background color of The label object
7800     *
7801     * @warning NEVER use this. It is for hyper-special cases only. use styles
7802     * instead. e.g. "default", "marker", "slide_long" etc.
7803     */
7804    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);
7805    /**
7806     * @brief Set the text align on the label object
7807     *
7808     * @param obj The label object
7809     * @param align align mode ("left", "center", "right")
7810     *
7811     * @warning NEVER use this. It is for hyper-special cases only. use styles
7812     * instead. e.g. "default", "marker", "slide_long" etc.
7813     */
7814    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7815    /**
7816     * @brief Set background color of the label
7817     *
7818     * @param obj The label object
7819     * @param r Red property background color of The label object
7820     * @param g Green property background color of The label object
7821     * @param b Blue property background color of The label object
7822     * @param a Alpha property background alpha of The label object
7823     *
7824     * @warning NEVER use this. It is for hyper-special cases only. use styles
7825     * instead. e.g. "default", "marker", "slide_long" etc.
7826     */
7827    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);
7828    /**
7829     * @brief Set the ellipsis behavior of the label
7830     *
7831     * @param obj The label object
7832     * @param ellipsis To ellipsis text or not
7833     *
7834     * If set to true and the text doesn't fit in the label an ellipsis("...")
7835     * will be shown at the end of the widget.
7836     *
7837     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7838     * choosen wrap method was ELM_WRAP_WORD.
7839     */
7840    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7841    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7842    /**
7843     * @brief Set the text slide of the label
7844     *
7845     * @param obj The label object
7846     * @param slide To start slide or stop
7847     *
7848     * If set to true, the text of the label will slide/scroll through the length of
7849     * label.
7850     *
7851     * @warning This only works with the themes "slide_short", "slide_long" and
7852     * "slide_bounce".
7853     */
7854    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7855    /**
7856     * @brief Get the text slide mode of the label
7857     *
7858     * @param obj The label object
7859     * @return slide slide mode value
7860     *
7861     * @see elm_label_slide_set()
7862     */
7863    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7864    /**
7865     * @brief Set the slide duration(speed) of the label
7866     *
7867     * @param obj The label object
7868     * @return The duration in seconds in moving text from slide begin position
7869     * to slide end position
7870     */
7871    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7872    /**
7873     * @brief Get the slide duration(speed) of the label
7874     *
7875     * @param obj The label object
7876     * @return The duration time in moving text from slide begin position to slide end position
7877     *
7878     * @see elm_label_slide_duration_set()
7879     */
7880    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7881    /**
7882     * @}
7883     */
7884
7885    /**
7886     * @defgroup Frame Frame
7887     *
7888     * @image html img/widget/frame/preview-00.png
7889     * @image latex img/widget/frame/preview-00.eps
7890     *
7891     * @brief Frame is a widget that holds some content and has a title.
7892     *
7893     * The default look is a frame with a title, but Frame supports multple
7894     * styles:
7895     * @li default
7896     * @li pad_small
7897     * @li pad_medium
7898     * @li pad_large
7899     * @li pad_huge
7900     * @li outdent_top
7901     * @li outdent_bottom
7902     *
7903     * Of all this styles only default shows the title. Frame emits no signals.
7904     *
7905     * Default contents parts of the frame widget that you can use for are:
7906     * @li "default" - A content of the frame
7907     *
7908     * Default text parts of the frame widget that you can use for are:
7909     * @li "elm.text" - Label of the frame
7910     *
7911     * For a detailed example see the @ref tutorial_frame.
7912     *
7913     * @{
7914     */
7915    /**
7916     * @brief Add a new frame to the parent
7917     *
7918     * @param parent The parent object
7919     * @return The new object or NULL if it cannot be created
7920     */
7921    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7922    /**
7923     * @brief Set the frame label
7924     *
7925     * @param obj The frame object
7926     * @param label The label of this frame object
7927     *
7928     * @deprecated use elm_object_text_set() instead.
7929     */
7930    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7931    /**
7932     * @brief Get the frame label
7933     *
7934     * @param obj The frame object
7935     *
7936     * @return The label of this frame objet or NULL if unable to get frame
7937     *
7938     * @deprecated use elm_object_text_get() instead.
7939     */
7940    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7941    /**
7942     * @brief Set the content of the frame widget
7943     *
7944     * Once the content object is set, a previously set one will be deleted.
7945     * If you want to keep that old content object, use the
7946     * elm_frame_content_unset() function.
7947     *
7948     * @param obj The frame object
7949     * @param content The content will be filled in this frame object
7950     *
7951     * @deprecated use elm_object_content_set() instead.
7952     */
7953    WILL_DEPRECATE  EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7954    /**
7955     * @brief Get the content of the frame widget
7956     *
7957     * Return the content object which is set for this widget
7958     *
7959     * @param obj The frame object
7960     * @return The content that is being used
7961     *
7962     * @deprecated use elm_object_content_get() instead.
7963     */
7964    WILL_DEPRECATE  EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7965    /**
7966     * @brief Unset the content of the frame widget
7967     *
7968     * Unparent and return the content object which was set for this widget
7969     *
7970     * @param obj The frame object
7971     * @return The content that was being used
7972     *
7973     * @deprecated use elm_object_content_unset() instead.
7974     */
7975    WILL_DEPRECATE  EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7976    /**
7977     * @}
7978     */
7979
7980    /**
7981     * @defgroup Table Table
7982     *
7983     * A container widget to arrange other widgets in a table where items can
7984     * also span multiple columns or rows - even overlap (and then be raised or
7985     * lowered accordingly to adjust stacking if they do overlap).
7986     *
7987     * For a Table widget the row/column count is not fixed.
7988     * The table widget adjusts itself when subobjects are added to it dynamically.
7989     *
7990     * The followin are examples of how to use a table:
7991     * @li @ref tutorial_table_01
7992     * @li @ref tutorial_table_02
7993     *
7994     * @{
7995     */
7996    /**
7997     * @brief Add a new table to the parent
7998     *
7999     * @param parent The parent object
8000     * @return The new object or NULL if it cannot be created
8001     */
8002    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8003    /**
8004     * @brief Set the homogeneous layout in the table
8005     *
8006     * @param obj The layout object
8007     * @param homogeneous A boolean to set if the layout is homogeneous in the
8008     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8009     */
8010    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8011    /**
8012     * @brief Get the current table homogeneous mode.
8013     *
8014     * @param obj The table object
8015     * @return A boolean to indicating if the layout is homogeneous in the table
8016     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8017     */
8018    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8019    /**
8020     * @warning <b>Use elm_table_homogeneous_set() instead</b>
8021     */
8022    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
8023    /**
8024     * @warning <b>Use elm_table_homogeneous_get() instead</b>
8025     */
8026    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8027    /**
8028     * @brief Set padding between cells.
8029     *
8030     * @param obj The layout object.
8031     * @param horizontal set the horizontal padding.
8032     * @param vertical set the vertical padding.
8033     *
8034     * Default value is 0.
8035     */
8036    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8037    /**
8038     * @brief Get padding between cells.
8039     *
8040     * @param obj The layout object.
8041     * @param horizontal set the horizontal padding.
8042     * @param vertical set the vertical padding.
8043     */
8044    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8045    /**
8046     * @brief Add a subobject on the table with the coordinates passed
8047     *
8048     * @param obj The table object
8049     * @param subobj The subobject to be added to the table
8050     * @param x Row number
8051     * @param y Column number
8052     * @param w rowspan
8053     * @param h colspan
8054     *
8055     * @note All positioning inside the table is relative to rows and columns, so
8056     * a value of 0 for x and y, means the top left cell of the table, and a
8057     * value of 1 for w and h means @p subobj only takes that 1 cell.
8058     */
8059    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8060    /**
8061     * @brief Remove child from table.
8062     *
8063     * @param obj The table object
8064     * @param subobj The subobject
8065     */
8066    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8067    /**
8068     * @brief Faster way to remove all child objects from a table object.
8069     *
8070     * @param obj The table object
8071     * @param clear If true, will delete children, else just remove from table.
8072     */
8073    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8074    /**
8075     * @brief Set the packing location of an existing child of the table
8076     *
8077     * @param subobj The subobject to be modified in the table
8078     * @param x Row number
8079     * @param y Column number
8080     * @param w rowspan
8081     * @param h colspan
8082     *
8083     * Modifies the position of an object already in the table.
8084     *
8085     * @note All positioning inside the table is relative to rows and columns, so
8086     * a value of 0 for x and y, means the top left cell of the table, and a
8087     * value of 1 for w and h means @p subobj only takes that 1 cell.
8088     */
8089    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8090    /**
8091     * @brief Get the packing location of an existing child of the table
8092     *
8093     * @param subobj The subobject to be modified in the table
8094     * @param x Row number
8095     * @param y Column number
8096     * @param w rowspan
8097     * @param h colspan
8098     *
8099     * @see elm_table_pack_set()
8100     */
8101    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8102    /**
8103     * @}
8104     */
8105
8106    /**
8107     * @defgroup Gengrid Gengrid (Generic grid)
8108     *
8109     * This widget aims to position objects in a grid layout while
8110     * actually creating and rendering only the visible ones, using the
8111     * same idea as the @ref Genlist "genlist": the user defines a @b
8112     * class for each item, specifying functions that will be called at
8113     * object creation, deletion, etc. When those items are selected by
8114     * the user, a callback function is issued. Users may interact with
8115     * a gengrid via the mouse (by clicking on items to select them and
8116     * clicking on the grid's viewport and swiping to pan the whole
8117     * view) or via the keyboard, navigating through item with the
8118     * arrow keys.
8119     *
8120     * @section Gengrid_Layouts Gengrid layouts
8121     *
8122     * Gengrid may layout its items in one of two possible layouts:
8123     * - horizontal or
8124     * - vertical.
8125     *
8126     * When in "horizontal mode", items will be placed in @b columns,
8127     * from top to bottom and, when the space for a column is filled,
8128     * another one is started on the right, thus expanding the grid
8129     * horizontally, making for horizontal scrolling. When in "vertical
8130     * mode" , though, items will be placed in @b rows, from left to
8131     * right and, when the space for a row is filled, another one is
8132     * started below, thus expanding the grid vertically (and making
8133     * for vertical scrolling).
8134     *
8135     * @section Gengrid_Items Gengrid items
8136     *
8137     * An item in a gengrid can have 0 or more text labels (they can be
8138     * regular text or textblock Evas objects - that's up to the style
8139     * to determine), 0 or more icons (which are simply objects
8140     * swallowed into the gengrid item's theming Edje object) and 0 or
8141     * more <b>boolean states</b>, which have the behavior left to the
8142     * user to define. The Edje part names for each of these properties
8143     * will be looked up, in the theme file for the gengrid, under the
8144     * Edje (string) data items named @c "labels", @c "icons" and @c
8145     * "states", respectively. For each of those properties, if more
8146     * than one part is provided, they must have names listed separated
8147     * by spaces in the data fields. For the default gengrid item
8148     * theme, we have @b one label part (@c "elm.text"), @b two icon
8149     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8150     * no state parts.
8151     *
8152     * A gengrid item may be at one of several styles. Elementary
8153     * provides one by default - "default", but this can be extended by
8154     * system or application custom themes/overlays/extensions (see
8155     * @ref Theme "themes" for more details).
8156     *
8157     * @section Gengrid_Item_Class Gengrid item classes
8158     *
8159     * In order to have the ability to add and delete items on the fly,
8160     * gengrid implements a class (callback) system where the
8161     * application provides a structure with information about that
8162     * type of item (gengrid may contain multiple different items with
8163     * different classes, states and styles). Gengrid will call the
8164     * functions in this struct (methods) when an item is "realized"
8165     * (i.e., created dynamically, while the user is scrolling the
8166     * grid). All objects will simply be deleted when no longer needed
8167     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8168     * contains the following members:
8169     * - @c item_style - This is a constant string and simply defines
8170     * the name of the item style. It @b must be specified and the
8171     * default should be @c "default".
8172     * - @c func.label_get - This function is called when an item
8173     * object is actually created. The @c data parameter will point to
8174     * the same data passed to elm_gengrid_item_append() and related
8175     * item creation functions. The @c obj parameter is the gengrid
8176     * object itself, while the @c part one is the name string of one
8177     * of the existing text parts in the Edje group implementing the
8178     * item's theme. This function @b must return a strdup'()ed string,
8179     * as the caller will free() it when done. See
8180     * #Elm_Gengrid_Item_Label_Get_Cb.
8181     * - @c func.content_get - This function is called when an item object
8182     * is actually created. The @c data parameter will point to the
8183     * same data passed to elm_gengrid_item_append() and related item
8184     * creation functions. The @c obj parameter is the gengrid object
8185     * itself, while the @c part one is the name string of one of the
8186     * existing (content) swallow parts in the Edje group implementing the
8187     * item's theme. It must return @c NULL, when no content is desired,
8188     * or a valid object handle, otherwise. The object will be deleted
8189     * by the gengrid on its deletion or when the item is "unrealized".
8190     * See #Elm_Gengrid_Item_Content_Get_Cb.
8191     * - @c func.state_get - This function is called when an item
8192     * object is actually created. The @c data parameter will point to
8193     * the same data passed to elm_gengrid_item_append() and related
8194     * item creation functions. The @c obj parameter is the gengrid
8195     * object itself, while the @c part one is the name string of one
8196     * of the state parts in the Edje group implementing the item's
8197     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8198     * true/on. Gengrids will emit a signal to its theming Edje object
8199     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8200     * "source" arguments, respectively, when the state is true (the
8201     * default is false), where @c XXX is the name of the (state) part.
8202     * See #Elm_Gengrid_Item_State_Get_Cb.
8203     * - @c func.del - This is called when elm_gengrid_item_del() is
8204     * called on an item or elm_gengrid_clear() is called on the
8205     * gengrid. This is intended for use when gengrid items are
8206     * deleted, so any data attached to the item (e.g. its data
8207     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8208     *
8209     * @section Gengrid_Usage_Hints Usage hints
8210     *
8211     * If the user wants to have multiple items selected at the same
8212     * time, elm_gengrid_multi_select_set() will permit it. If the
8213     * gengrid is single-selection only (the default), then
8214     * elm_gengrid_select_item_get() will return the selected item or
8215     * @c NULL, if none is selected. If the gengrid is under
8216     * multi-selection, then elm_gengrid_selected_items_get() will
8217     * return a list (that is only valid as long as no items are
8218     * modified (added, deleted, selected or unselected) of child items
8219     * on a gengrid.
8220     *
8221     * If an item changes (internal (boolean) state, label or content 
8222     * changes), then use elm_gengrid_item_update() to have gengrid
8223     * update the item with the new state. A gengrid will re-"realize"
8224     * the item, thus calling the functions in the
8225     * #Elm_Gengrid_Item_Class set for that item.
8226     *
8227     * To programmatically (un)select an item, use
8228     * elm_gengrid_item_selected_set(). To get its selected state use
8229     * elm_gengrid_item_selected_get(). To make an item disabled
8230     * (unable to be selected and appear differently) use
8231     * elm_gengrid_item_disabled_set() to set this and
8232     * elm_gengrid_item_disabled_get() to get the disabled state.
8233     *
8234     * Grid cells will only have their selection smart callbacks called
8235     * when firstly getting selected. Any further clicks will do
8236     * nothing, unless you enable the "always select mode", with
8237     * elm_gengrid_always_select_mode_set(), thus making every click to
8238     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8239     * turn off the ability to select items entirely in the widget and
8240     * they will neither appear selected nor call the selection smart
8241     * callbacks.
8242     *
8243     * Remember that you can create new styles and add your own theme
8244     * augmentation per application with elm_theme_extension_add(). If
8245     * you absolutely must have a specific style that overrides any
8246     * theme the user or system sets up you can use
8247     * elm_theme_overlay_add() to add such a file.
8248     *
8249     * @section Gengrid_Smart_Events Gengrid smart events
8250     *
8251     * Smart events that you can add callbacks for are:
8252     * - @c "activated" - The user has double-clicked or pressed
8253     *   (enter|return|spacebar) on an item. The @c event_info parameter
8254     *   is the gengrid item that was activated.
8255     * - @c "clicked,double" - The user has double-clicked an item.
8256     *   The @c event_info parameter is the gengrid item that was double-clicked.
8257     * - @c "longpressed" - This is called when the item is pressed for a certain
8258     *   amount of time. By default it's 1 second.
8259     * - @c "selected" - The user has made an item selected. The
8260     *   @c event_info parameter is the gengrid item that was selected.
8261     * - @c "unselected" - The user has made an item unselected. The
8262     *   @c event_info parameter is the gengrid item that was unselected.
8263     * - @c "realized" - This is called when the item in the gengrid
8264     *   has its implementing Evas object instantiated, de facto. @c
8265     *   event_info is the gengrid item that was created. The object
8266     *   may be deleted at any time, so it is highly advised to the
8267     *   caller @b not to use the object pointer returned from
8268     *   elm_gengrid_item_object_get(), because it may point to freed
8269     *   objects.
8270     * - @c "unrealized" - This is called when the implementing Evas
8271     *   object for this item is deleted. @c event_info is the gengrid
8272     *   item that was deleted.
8273     * - @c "changed" - Called when an item is added, removed, resized
8274     *   or moved and when the gengrid is resized or gets "horizontal"
8275     *   property changes.
8276     * - @c "scroll,anim,start" - This is called when scrolling animation has
8277     *   started.
8278     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8279     *   stopped.
8280     * - @c "drag,start,up" - Called when the item in the gengrid has
8281     *   been dragged (not scrolled) up.
8282     * - @c "drag,start,down" - Called when the item in the gengrid has
8283     *   been dragged (not scrolled) down.
8284     * - @c "drag,start,left" - Called when the item in the gengrid has
8285     *   been dragged (not scrolled) left.
8286     * - @c "drag,start,right" - Called when the item in the gengrid has
8287     *   been dragged (not scrolled) right.
8288     * - @c "drag,stop" - Called when the item in the gengrid has
8289     *   stopped being dragged.
8290     * - @c "drag" - Called when the item in the gengrid is being
8291     *   dragged.
8292     * - @c "scroll" - called when the content has been scrolled
8293     *   (moved).
8294     * - @c "scroll,drag,start" - called when dragging the content has
8295     *   started.
8296     * - @c "scroll,drag,stop" - called when dragging the content has
8297     *   stopped.
8298     * - @c "edge,top" - This is called when the gengrid is scrolled until
8299     *   the top edge.
8300     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8301     *   until the bottom edge.
8302     * - @c "edge,left" - This is called when the gengrid is scrolled
8303     *   until the left edge.
8304     * - @c "edge,right" - This is called when the gengrid is scrolled
8305     *   until the right edge.
8306     *
8307     * List of gengrid examples:
8308     * @li @ref gengrid_example
8309     */
8310
8311    /**
8312     * @addtogroup Gengrid
8313     * @{
8314     */
8315
8316    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8317    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8318    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8319    /**
8320     * Label fetching class function for Elm_Gen_Item_Class.
8321     * @param data The data passed in the item creation function
8322     * @param obj The base widget object
8323     * @param part The part name of the swallow
8324     * @return The allocated (NOT stringshared) string to set as the label
8325     */
8326    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8327    /**
8328     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8329     * @param data The data passed in the item creation function
8330     * @param obj The base widget object
8331     * @param part The part name of the swallow
8332     * @return The content object to swallow
8333     */
8334    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8335    /**
8336     * State fetching class function for Elm_Gen_Item_Class.
8337     * @param data The data passed in the item creation function
8338     * @param obj The base widget object
8339     * @param part The part name of the swallow
8340     * @return The hell if I know
8341     */
8342    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8343    /**
8344     * Deletion class function for Elm_Gen_Item_Class.
8345     * @param data The data passed in the item creation function
8346     * @param obj The base widget object
8347     */
8348    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8349
8350    /* temporary compatibility code */
8351    typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8352    typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8353    typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8354    typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8355
8356    /**
8357     * @struct _Elm_Gengrid_Item_Class
8358     *
8359     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8360     * field details.
8361     */
8362    struct _Elm_Gengrid_Item_Class
8363      {
8364         const char             *item_style;
8365         struct _Elm_Gengrid_Item_Class_Func
8366           {
8367              Elm_Gengrid_Item_Label_Get_Cb label_get;
8368              union { /* temporary compatibility code */
8369                Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8370                Elm_Gengrid_Item_Content_Get_Cb content_get;
8371              };
8372              Elm_Gengrid_Item_State_Get_Cb state_get;
8373              Elm_Gengrid_Item_Del_Cb       del;
8374           } func;
8375      }; /**< #Elm_Gengrid_Item_Class member definitions */
8376    /**
8377     * Add a new gengrid widget to the given parent Elementary
8378     * (container) object
8379     *
8380     * @param parent The parent object
8381     * @return a new gengrid widget handle or @c NULL, on errors
8382     *
8383     * This function inserts a new gengrid widget on the canvas.
8384     *
8385     * @see elm_gengrid_item_size_set()
8386     * @see elm_gengrid_group_item_size_set()
8387     * @see elm_gengrid_horizontal_set()
8388     * @see elm_gengrid_item_append()
8389     * @see elm_gengrid_item_del()
8390     * @see elm_gengrid_clear()
8391     *
8392     * @ingroup Gengrid
8393     */
8394    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8395
8396    /**
8397     * Set the size for the items of a given gengrid widget
8398     *
8399     * @param obj The gengrid object.
8400     * @param w The items' width.
8401     * @param h The items' height;
8402     *
8403     * A gengrid, after creation, has still no information on the size
8404     * to give to each of its cells. So, you most probably will end up
8405     * with squares one @ref Fingers "finger" wide, the default
8406     * size. Use this function to force a custom size for you items,
8407     * making them as big as you wish.
8408     *
8409     * @see elm_gengrid_item_size_get()
8410     *
8411     * @ingroup Gengrid
8412     */
8413    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8414
8415    /**
8416     * Get the size set for the items of a given gengrid widget
8417     *
8418     * @param obj The gengrid object.
8419     * @param w Pointer to a variable where to store the items' width.
8420     * @param h Pointer to a variable where to store the items' height.
8421     *
8422     * @note Use @c NULL pointers on the size values you're not
8423     * interested in: they'll be ignored by the function.
8424     *
8425     * @see elm_gengrid_item_size_get() for more details
8426     *
8427     * @ingroup Gengrid
8428     */
8429    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8430
8431    /**
8432     * Set the items grid's alignment within a given gengrid widget
8433     *
8434     * @param obj The gengrid object.
8435     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8436     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8437     *
8438     * This sets the alignment of the whole grid of items of a gengrid
8439     * within its given viewport. By default, those values are both
8440     * 0.5, meaning that the gengrid will have its items grid placed
8441     * exactly in the middle of its viewport.
8442     *
8443     * @note If given alignment values are out of the cited ranges,
8444     * they'll be changed to the nearest boundary values on the valid
8445     * ranges.
8446     *
8447     * @see elm_gengrid_align_get()
8448     *
8449     * @ingroup Gengrid
8450     */
8451    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8452
8453    /**
8454     * Get the items grid's alignment values within a given gengrid
8455     * widget
8456     *
8457     * @param obj The gengrid object.
8458     * @param align_x Pointer to a variable where to store the
8459     * horizontal alignment.
8460     * @param align_y Pointer to a variable where to store the vertical
8461     * alignment.
8462     *
8463     * @note Use @c NULL pointers on the alignment values you're not
8464     * interested in: they'll be ignored by the function.
8465     *
8466     * @see elm_gengrid_align_set() for more details
8467     *
8468     * @ingroup Gengrid
8469     */
8470    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8471
8472    /**
8473     * Set whether a given gengrid widget is or not able have items
8474     * @b reordered
8475     *
8476     * @param obj The gengrid object
8477     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8478     * @c EINA_FALSE to turn it off
8479     *
8480     * If a gengrid is set to allow reordering, a click held for more
8481     * than 0.5 over a given item will highlight it specially,
8482     * signalling the gengrid has entered the reordering state. From
8483     * that time on, the user will be able to, while still holding the
8484     * mouse button down, move the item freely in the gengrid's
8485     * viewport, replacing to said item to the locations it goes to.
8486     * The replacements will be animated and, whenever the user
8487     * releases the mouse button, the item being replaced gets a new
8488     * definitive place in the grid.
8489     *
8490     * @see elm_gengrid_reorder_mode_get()
8491     *
8492     * @ingroup Gengrid
8493     */
8494    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8495
8496    /**
8497     * Get whether a given gengrid widget is or not able have items
8498     * @b reordered
8499     *
8500     * @param obj The gengrid object
8501     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8502     * off
8503     *
8504     * @see elm_gengrid_reorder_mode_set() for more details
8505     *
8506     * @ingroup Gengrid
8507     */
8508    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8509
8510    /**
8511     * Append a new item in a given gengrid widget.
8512     *
8513     * @param obj The gengrid object.
8514     * @param gic The item class for the item.
8515     * @param data The item data.
8516     * @param func Convenience function called when the item is
8517     * selected.
8518     * @param func_data Data to be passed to @p func.
8519     * @return A handle to the item added or @c NULL, on errors.
8520     *
8521     * This adds an item to the beginning of the gengrid.
8522     *
8523     * @see elm_gengrid_item_prepend()
8524     * @see elm_gengrid_item_insert_before()
8525     * @see elm_gengrid_item_insert_after()
8526     * @see elm_gengrid_item_del()
8527     *
8528     * @ingroup Gengrid
8529     */
8530    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);
8531
8532    /**
8533     * Prepend a new item in a given gengrid widget.
8534     *
8535     * @param obj The gengrid object.
8536     * @param gic The item class for the item.
8537     * @param data The item data.
8538     * @param func Convenience function called when the item is
8539     * selected.
8540     * @param func_data Data to be passed to @p func.
8541     * @return A handle to the item added or @c NULL, on errors.
8542     *
8543     * This adds an item to the end of the gengrid.
8544     *
8545     * @see elm_gengrid_item_append()
8546     * @see elm_gengrid_item_insert_before()
8547     * @see elm_gengrid_item_insert_after()
8548     * @see elm_gengrid_item_del()
8549     *
8550     * @ingroup Gengrid
8551     */
8552    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);
8553
8554    /**
8555     * Insert an item before another in a gengrid widget
8556     *
8557     * @param obj The gengrid object.
8558     * @param gic The item class for the item.
8559     * @param data The item data.
8560     * @param relative The item to place this new one before.
8561     * @param func Convenience function called when the item is
8562     * selected.
8563     * @param func_data Data to be passed to @p func.
8564     * @return A handle to the item added or @c NULL, on errors.
8565     *
8566     * This inserts an item before another in the gengrid.
8567     *
8568     * @see elm_gengrid_item_append()
8569     * @see elm_gengrid_item_prepend()
8570     * @see elm_gengrid_item_insert_after()
8571     * @see elm_gengrid_item_del()
8572     *
8573     * @ingroup Gengrid
8574     */
8575    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);
8576
8577    /**
8578     * Insert an item after another in a gengrid widget
8579     *
8580     * @param obj The gengrid object.
8581     * @param gic The item class for the item.
8582     * @param data The item data.
8583     * @param relative The item to place this new one after.
8584     * @param func Convenience function called when the item is
8585     * selected.
8586     * @param func_data Data to be passed to @p func.
8587     * @return A handle to the item added or @c NULL, on errors.
8588     *
8589     * This inserts an item after another in the gengrid.
8590     *
8591     * @see elm_gengrid_item_append()
8592     * @see elm_gengrid_item_prepend()
8593     * @see elm_gengrid_item_insert_after()
8594     * @see elm_gengrid_item_del()
8595     *
8596     * @ingroup Gengrid
8597     */
8598    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);
8599
8600    /**
8601     * Insert an item in a gengrid widget using a user-defined sort function.
8602     *
8603     * @param obj The gengrid object.
8604     * @param gic The item class for the item.
8605     * @param data The item data.
8606     * @param comp User defined comparison function that defines the sort order based on
8607     * Elm_Gen_Item and its data param.
8608     * @param func Convenience function called when the item is selected.
8609     * @param func_data Data to be passed to @p func.
8610     * @return A handle to the item added or @c NULL, on errors.
8611     *
8612     * This inserts an item in the gengrid based on user defined comparison function.
8613     *
8614     * @see elm_gengrid_item_append()
8615     * @see elm_gengrid_item_prepend()
8616     * @see elm_gengrid_item_insert_after()
8617     * @see elm_gengrid_item_del()
8618     * @see elm_gengrid_item_direct_sorted_insert()
8619     *
8620     * @ingroup Gengrid
8621     */
8622    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);
8623
8624    /**
8625     * Insert an item in a gengrid widget using a user-defined sort function.
8626     *
8627     * @param obj The gengrid object.
8628     * @param gic The item class for the item.
8629     * @param data The item data.
8630     * @param comp User defined comparison function that defines the sort order based on
8631     * Elm_Gen_Item.
8632     * @param func Convenience function called when the item is selected.
8633     * @param func_data Data to be passed to @p func.
8634     * @return A handle to the item added or @c NULL, on errors.
8635     *
8636     * This inserts an item in the gengrid based on user defined comparison function.
8637     *
8638     * @see elm_gengrid_item_append()
8639     * @see elm_gengrid_item_prepend()
8640     * @see elm_gengrid_item_insert_after()
8641     * @see elm_gengrid_item_del()
8642     * @see elm_gengrid_item_sorted_insert()
8643     *
8644     * @ingroup Gengrid
8645     */
8646    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);
8647
8648    /**
8649     * Set whether items on a given gengrid widget are to get their
8650     * selection callbacks issued for @b every subsequent selection
8651     * click on them or just for the first click.
8652     *
8653     * @param obj The gengrid object
8654     * @param always_select @c EINA_TRUE to make items "always
8655     * selected", @c EINA_FALSE, otherwise
8656     *
8657     * By default, grid items will only call their selection callback
8658     * function when firstly getting selected, any subsequent further
8659     * clicks will do nothing. With this call, you make those
8660     * subsequent clicks also to issue the selection callbacks.
8661     *
8662     * @note <b>Double clicks</b> will @b always be reported on items.
8663     *
8664     * @see elm_gengrid_always_select_mode_get()
8665     *
8666     * @ingroup Gengrid
8667     */
8668    WILL_DEPRECATE  EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8669
8670    /**
8671     * Get whether items on a given gengrid widget have their selection
8672     * callbacks issued for @b every subsequent selection click on them
8673     * or just for the first click.
8674     *
8675     * @param obj The gengrid object.
8676     * @return @c EINA_TRUE if the gengrid items are "always selected",
8677     * @c EINA_FALSE, otherwise
8678     *
8679     * @see elm_gengrid_always_select_mode_set() for more details
8680     *
8681     * @ingroup Gengrid
8682     */
8683    WILL_DEPRECATE  EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8684
8685    /**
8686     * Set whether items on a given gengrid widget can be selected or not.
8687     *
8688     * @param obj The gengrid object
8689     * @param no_select @c EINA_TRUE to make items selectable,
8690     * @c EINA_FALSE otherwise
8691     *
8692     * This will make items in @p obj selectable or not. In the latter
8693     * case, any user interaction on the gengrid items will neither make
8694     * them appear selected nor them call their selection callback
8695     * functions.
8696     *
8697     * @see elm_gengrid_no_select_mode_get()
8698     *
8699     * @ingroup Gengrid
8700     */
8701    WILL_DEPRECATE  EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8702
8703    /**
8704     * Get whether items on a given gengrid widget can be selected or
8705     * not.
8706     *
8707     * @param obj The gengrid object
8708     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8709     * otherwise
8710     *
8711     * @see elm_gengrid_no_select_mode_set() for more details
8712     *
8713     * @ingroup Gengrid
8714     */
8715    WILL_DEPRECATE  EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8716
8717    /**
8718     * Enable or disable multi-selection in a given gengrid widget
8719     *
8720     * @param obj The gengrid object.
8721     * @param multi @c EINA_TRUE, to enable multi-selection,
8722     * @c EINA_FALSE to disable it.
8723     *
8724     * Multi-selection is the ability to have @b more than one
8725     * item selected, on a given gengrid, simultaneously. When it is
8726     * enabled, a sequence of clicks on different items will make them
8727     * all selected, progressively. A click on an already selected item
8728     * will unselect it. If interacting via the keyboard,
8729     * multi-selection is enabled while holding the "Shift" key.
8730     *
8731     * @note By default, multi-selection is @b disabled on gengrids
8732     *
8733     * @see elm_gengrid_multi_select_get()
8734     *
8735     * @ingroup Gengrid
8736     */
8737    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8738
8739    /**
8740     * Get whether multi-selection is enabled or disabled for a given
8741     * gengrid widget
8742     *
8743     * @param obj The gengrid object.
8744     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8745     * EINA_FALSE otherwise
8746     *
8747     * @see elm_gengrid_multi_select_set() for more details
8748     *
8749     * @ingroup Gengrid
8750     */
8751    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8752
8753    /**
8754     * Enable or disable bouncing effect for a given gengrid widget
8755     *
8756     * @param obj The gengrid object
8757     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8758     * @c EINA_FALSE to disable it
8759     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8760     * @c EINA_FALSE to disable it
8761     *
8762     * The bouncing effect occurs whenever one reaches the gengrid's
8763     * edge's while panning it -- it will scroll past its limits a
8764     * little bit and return to the edge again, in a animated for,
8765     * automatically.
8766     *
8767     * @note By default, gengrids have bouncing enabled on both axis
8768     *
8769     * @see elm_gengrid_bounce_get()
8770     *
8771     * @ingroup Gengrid
8772     */
8773    WILL_DEPRECATE  EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8774
8775    /**
8776     * Get whether bouncing effects are enabled or disabled, for a
8777     * given gengrid widget, on each axis
8778     *
8779     * @param obj The gengrid object
8780     * @param h_bounce Pointer to a variable where to store the
8781     * horizontal bouncing flag.
8782     * @param v_bounce Pointer to a variable where to store the
8783     * vertical bouncing flag.
8784     *
8785     * @see elm_gengrid_bounce_set() for more details
8786     *
8787     * @ingroup Gengrid
8788     */
8789    WILL_DEPRECATE  EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8790
8791    /**
8792     * Set a given gengrid widget's scrolling page size, relative to
8793     * its viewport size.
8794     *
8795     * @param obj The gengrid object
8796     * @param h_pagerel The horizontal page (relative) size
8797     * @param v_pagerel The vertical page (relative) size
8798     *
8799     * The gengrid's scroller is capable of binding scrolling by the
8800     * user to "pages". It means that, while scrolling and, specially
8801     * after releasing the mouse button, the grid will @b snap to the
8802     * nearest displaying page's area. When page sizes are set, the
8803     * grid's continuous content area is split into (equal) page sized
8804     * pieces.
8805     *
8806     * This function sets the size of a page <b>relatively to the
8807     * viewport dimensions</b> of the gengrid, for each axis. A value
8808     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8809     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8810     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8811     * 1.0. Values beyond those will make it behave behave
8812     * inconsistently. If you only want one axis to snap to pages, use
8813     * the value @c 0.0 for the other one.
8814     *
8815     * There is a function setting page size values in @b absolute
8816     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8817     * is mutually exclusive to this one.
8818     *
8819     * @see elm_gengrid_page_relative_get()
8820     *
8821     * @ingroup Gengrid
8822     */
8823    WILL_DEPRECATE  EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8824
8825    /**
8826     * Get a given gengrid widget's scrolling page size, relative to
8827     * its viewport size.
8828     *
8829     * @param obj The gengrid object
8830     * @param h_pagerel Pointer to a variable where to store the
8831     * horizontal page (relative) size
8832     * @param v_pagerel Pointer to a variable where to store the
8833     * vertical page (relative) size
8834     *
8835     * @see elm_gengrid_page_relative_set() for more details
8836     *
8837     * @ingroup Gengrid
8838     */
8839    WILL_DEPRECATE  EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8840
8841    /**
8842     * Set a given gengrid widget's scrolling page size
8843     *
8844     * @param obj The gengrid object
8845     * @param h_pagerel The horizontal page size, in pixels
8846     * @param v_pagerel The vertical page size, in pixels
8847     *
8848     * The gengrid's scroller is capable of binding scrolling by the
8849     * user to "pages". It means that, while scrolling and, specially
8850     * after releasing the mouse button, the grid will @b snap to the
8851     * nearest displaying page's area. When page sizes are set, the
8852     * grid's continuous content area is split into (equal) page sized
8853     * pieces.
8854     *
8855     * This function sets the size of a page of the gengrid, in pixels,
8856     * for each axis. Sane usable values are, between @c 0 and the
8857     * dimensions of @p obj, for each axis. Values beyond those will
8858     * make it behave behave inconsistently. If you only want one axis
8859     * to snap to pages, use the value @c 0 for the other one.
8860     *
8861     * There is a function setting page size values in @b relative
8862     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8863     * use is mutually exclusive to this one.
8864     *
8865     * @ingroup Gengrid
8866     */
8867    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8868
8869    /**
8870     * Set the direction in which a given gengrid widget will expand while
8871     * placing its items.
8872     *
8873     * @param obj The gengrid object.
8874     * @param setting @c EINA_TRUE to make the gengrid expand
8875     * horizontally, @c EINA_FALSE to expand vertically.
8876     *
8877     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8878     * in @b columns, from top to bottom and, when the space for a
8879     * column is filled, another one is started on the right, thus
8880     * expanding the grid horizontally. When in "vertical mode"
8881     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8882     * to right and, when the space for a row is filled, another one is
8883     * started below, thus expanding the grid vertically.
8884     *
8885     * @see elm_gengrid_horizontal_get()
8886     *
8887     * @ingroup Gengrid
8888     */
8889    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8890
8891    /**
8892     * Get for what direction a given gengrid widget will expand while
8893     * placing its items.
8894     *
8895     * @param obj The gengrid object.
8896     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8897     * @c EINA_FALSE if it's set to expand vertically.
8898     *
8899     * @see elm_gengrid_horizontal_set() for more detais
8900     *
8901     * @ingroup Gengrid
8902     */
8903    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8904
8905    /**
8906     * Get the first item in a given gengrid widget
8907     *
8908     * @param obj The gengrid object
8909     * @return The first item's handle or @c NULL, if there are no
8910     * items in @p obj (and on errors)
8911     *
8912     * This returns the first item in the @p obj's internal list of
8913     * items.
8914     *
8915     * @see elm_gengrid_last_item_get()
8916     *
8917     * @ingroup Gengrid
8918     */
8919    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8920
8921    /**
8922     * Get the last item in a given gengrid widget
8923     *
8924     * @param obj The gengrid object
8925     * @return The last item's handle or @c NULL, if there are no
8926     * items in @p obj (and on errors)
8927     *
8928     * This returns the last item in the @p obj's internal list of
8929     * items.
8930     *
8931     * @see elm_gengrid_first_item_get()
8932     *
8933     * @ingroup Gengrid
8934     */
8935    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8936
8937    /**
8938     * Get the @b next item in a gengrid widget's internal list of items,
8939     * given a handle to one of those items.
8940     *
8941     * @param item The gengrid item to fetch next from
8942     * @return The item after @p item, or @c NULL if there's none (and
8943     * on errors)
8944     *
8945     * This returns the item placed after the @p item, on the container
8946     * gengrid.
8947     *
8948     * @see elm_gengrid_item_prev_get()
8949     *
8950     * @ingroup Gengrid
8951     */
8952    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8953
8954    /**
8955     * Get the @b previous item in a gengrid widget's internal list of items,
8956     * given a handle to one of those items.
8957     *
8958     * @param item The gengrid item to fetch previous from
8959     * @return The item before @p item, or @c NULL if there's none (and
8960     * on errors)
8961     *
8962     * This returns the item placed before the @p item, on the container
8963     * gengrid.
8964     *
8965     * @see elm_gengrid_item_next_get()
8966     *
8967     * @ingroup Gengrid
8968     */
8969    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8970
8971    /**
8972     * Get the gengrid object's handle which contains a given gengrid
8973     * item
8974     *
8975     * @param item The item to fetch the container from
8976     * @return The gengrid (parent) object
8977     *
8978     * This returns the gengrid object itself that an item belongs to.
8979     *
8980     * @ingroup Gengrid
8981     */
8982    WILL_DEPRECATE EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8983
8984    /**
8985     * Remove a gengrid item from its parent, deleting it.
8986     *
8987     * @param item The item to be removed.
8988     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8989     *
8990     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8991     * once.
8992     *
8993     * @ingroup Gengrid
8994     */
8995    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8996
8997    /**
8998     * Update the contents of a given gengrid item
8999     *
9000     * @param item The gengrid item
9001     *
9002     * This updates an item by calling all the item class functions
9003     * again to get the contents, labels and states. Use this when the
9004     * original item data has changed and you want the changes to be
9005     * reflected.
9006     *
9007     * @ingroup Gengrid
9008     */
9009    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9010
9011    /**
9012     * Get the Gengrid Item class for the given Gengrid Item.
9013     *
9014     * @param item The gengrid item
9015     *
9016     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9017     * the function pointers and item_style.
9018     *
9019     * @ingroup Gengrid
9020     */
9021    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9022
9023    /**
9024     * Get the Gengrid Item class for the given Gengrid Item.
9025     *
9026     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9027     * the function pointers and item_style.
9028     *
9029     * @param item The gengrid item
9030     * @param gic The gengrid item class describing the function pointers and the item style.
9031     *
9032     * @ingroup Gengrid
9033     */
9034    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9035
9036    /**
9037     * Return the data associated to a given gengrid item
9038     *
9039     * @param item The gengrid item.
9040     * @return the data associated with this item.
9041     *
9042     * This returns the @c data value passed on the
9043     * elm_gengrid_item_append() and related item addition calls.
9044     *
9045     * @see elm_gengrid_item_append()
9046     * @see elm_gengrid_item_data_set()
9047     *
9048     * @ingroup Gengrid
9049     */
9050    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9051
9052    /**
9053     * Set the data associated with a given gengrid item
9054     *
9055     * @param item The gengrid item
9056     * @param data The data pointer to set on it
9057     *
9058     * This @b overrides the @c data value passed on the
9059     * elm_gengrid_item_append() and related item addition calls. This
9060     * function @b won't call elm_gengrid_item_update() automatically,
9061     * so you'd issue it afterwards if you want to have the item
9062     * updated to reflect the new data.
9063     *
9064     * @see elm_gengrid_item_data_get()
9065     * @see elm_gengrid_item_update()
9066     *
9067     * @ingroup Gengrid
9068     */
9069    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9070
9071    /**
9072     * Get a given gengrid item's position, relative to the whole
9073     * gengrid's grid area.
9074     *
9075     * @param item The Gengrid item.
9076     * @param x Pointer to variable to store the item's <b>row number</b>.
9077     * @param y Pointer to variable to store the item's <b>column number</b>.
9078     *
9079     * This returns the "logical" position of the item within the
9080     * gengrid. For example, @c (0, 1) would stand for first row,
9081     * second column.
9082     *
9083     * @ingroup Gengrid
9084     */
9085    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9086
9087    /**
9088     * Set whether a given gengrid item is selected or not
9089     *
9090     * @param item The gengrid item
9091     * @param selected Use @c EINA_TRUE, to make it selected, @c
9092     * EINA_FALSE to make it unselected
9093     *
9094     * This sets the selected state of an item. If multi-selection is
9095     * not enabled on the containing gengrid and @p selected is @c
9096     * EINA_TRUE, any other previously selected items will get
9097     * unselected in favor of this new one.
9098     *
9099     * @see elm_gengrid_item_selected_get()
9100     *
9101     * @ingroup Gengrid
9102     */
9103    WILL_DEPRECATE EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9104
9105    /**
9106     * Get whether a given gengrid item is selected or not
9107     *
9108     * @param item The gengrid item
9109     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9110     *
9111     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9112     *
9113     * @see elm_gengrid_item_selected_set() for more details
9114     *
9115     * @ingroup Gengrid
9116     */
9117    WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9118
9119    /**
9120     * Get the real Evas object created to implement the view of a
9121     * given gengrid item
9122     *
9123     * @param item The gengrid item.
9124     * @return the Evas object implementing this item's view.
9125     *
9126     * This returns the actual Evas object used to implement the
9127     * specified gengrid item's view. This may be @c NULL, as it may
9128     * not have been created or may have been deleted, at any time, by
9129     * the gengrid. <b>Do not modify this object</b> (move, resize,
9130     * show, hide, etc.), as the gengrid is controlling it. This
9131     * function is for querying, emitting custom signals or hooking
9132     * lower level callbacks for events on that object. Do not delete
9133     * this object under any circumstances.
9134     *
9135     * @see elm_gengrid_item_data_get()
9136     *
9137     * @ingroup Gengrid
9138     */
9139    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9140
9141    /**
9142     * Show the portion of a gengrid's internal grid containing a given
9143     * item, @b immediately.
9144     *
9145     * @param item The item to display
9146     *
9147     * This causes gengrid to @b redraw its viewport's contents to the
9148     * region contining the given @p item item, if it is not fully
9149     * visible.
9150     *
9151     * @see elm_gengrid_item_bring_in()
9152     *
9153     * @ingroup Gengrid
9154     */
9155    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9156
9157    /**
9158     * Animatedly bring in, to the visible area of a gengrid, a given
9159     * item on it.
9160     *
9161     * @param item The gengrid item to display
9162     *
9163     * This causes gengrid to jump to the given @p item and show
9164     * it (by scrolling), if it is not fully visible. This will use
9165     * animation to do so and take a period of time to complete.
9166     *
9167     * @see elm_gengrid_item_show()
9168     *
9169     * @ingroup Gengrid
9170     */
9171    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9172
9173    /**
9174     * Set whether a given gengrid item is disabled or not.
9175     *
9176     * @param item The gengrid item
9177     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9178     * to enable it back.
9179     *
9180     * A disabled item cannot be selected or unselected. It will also
9181     * change its appearance, to signal the user it's disabled.
9182     *
9183     * @see elm_gengrid_item_disabled_get()
9184     *
9185     * @ingroup Gengrid
9186     */
9187    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9188
9189    /**
9190     * Get whether a given gengrid item is disabled or not.
9191     *
9192     * @param item The gengrid item
9193     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9194     * (and on errors).
9195     *
9196     * @see elm_gengrid_item_disabled_set() for more details
9197     *
9198     * @ingroup Gengrid
9199     */
9200    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9201
9202    /**
9203     * Set the text to be shown in a given gengrid item's tooltips.
9204     *
9205     * @param item The gengrid item
9206     * @param text The text to set in the content
9207     *
9208     * This call will setup the text to be used as tooltip to that item
9209     * (analogous to elm_object_tooltip_text_set(), but being item
9210     * tooltips with higher precedence than object tooltips). It can
9211     * have only one tooltip at a time, so any previous tooltip data
9212     * will get removed.
9213     *
9214     * @ingroup Gengrid
9215     */
9216    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9217
9218    /**
9219     * Set the content to be shown in a given gengrid item's tooltip
9220     *
9221     * @param item The gengrid item.
9222     * @param func The function returning the tooltip contents.
9223     * @param data What to provide to @a func as callback data/context.
9224     * @param del_cb Called when data is not needed anymore, either when
9225     *        another callback replaces @p func, the tooltip is unset with
9226     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9227     *        dies. This callback receives as its first parameter the
9228     *        given @p data, being @c event_info the item handle.
9229     *
9230     * This call will setup the tooltip's contents to @p item
9231     * (analogous to elm_object_tooltip_content_cb_set(), but being
9232     * item tooltips with higher precedence than object tooltips). It
9233     * can have only one tooltip at a time, so any previous tooltip
9234     * content will get removed. @p func (with @p data) will be called
9235     * every time Elementary needs to show the tooltip and it should
9236     * return a valid Evas object, which will be fully managed by the
9237     * tooltip system, getting deleted when the tooltip is gone.
9238     *
9239     * @ingroup Gengrid
9240     */
9241    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);
9242
9243    /**
9244     * Unset a tooltip from a given gengrid item
9245     *
9246     * @param item gengrid item to remove a previously set tooltip from.
9247     *
9248     * This call removes any tooltip set on @p item. The callback
9249     * provided as @c del_cb to
9250     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9251     * notify it is not used anymore (and have resources cleaned, if
9252     * need be).
9253     *
9254     * @see elm_gengrid_item_tooltip_content_cb_set()
9255     *
9256     * @ingroup Gengrid
9257     */
9258    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9259
9260    /**
9261     * Set a different @b style for a given gengrid item's tooltip.
9262     *
9263     * @param item gengrid item with tooltip set
9264     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9265     * "default", @c "transparent", etc)
9266     *
9267     * Tooltips can have <b>alternate styles</b> to be displayed on,
9268     * which are defined by the theme set on Elementary. This function
9269     * works analogously as elm_object_tooltip_style_set(), but here
9270     * applied only to gengrid item objects. The default style for
9271     * tooltips is @c "default".
9272     *
9273     * @note before you set a style you should define a tooltip with
9274     *       elm_gengrid_item_tooltip_content_cb_set() or
9275     *       elm_gengrid_item_tooltip_text_set()
9276     *
9277     * @see elm_gengrid_item_tooltip_style_get()
9278     *
9279     * @ingroup Gengrid
9280     */
9281    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9282
9283    /**
9284     * Get the style set a given gengrid item's tooltip.
9285     *
9286     * @param item gengrid item with tooltip already set on.
9287     * @return style the theme style in use, which defaults to
9288     *         "default". If the object does not have a tooltip set,
9289     *         then @c NULL is returned.
9290     *
9291     * @see elm_gengrid_item_tooltip_style_set() for more details
9292     *
9293     * @ingroup Gengrid
9294     */
9295    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9296    /**
9297     * @brief Disable size restrictions on an object's tooltip
9298     * @param item The tooltip's anchor object
9299     * @param disable If EINA_TRUE, size restrictions are disabled
9300     * @return EINA_FALSE on failure, EINA_TRUE on success
9301     *
9302     * This function allows a tooltip to expand beyond its parant window's canvas.
9303     * It will instead be limited only by the size of the display.
9304     */
9305    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9306    /**
9307     * @brief Retrieve size restriction state of an object's tooltip
9308     * @param item The tooltip's anchor object
9309     * @return If EINA_TRUE, size restrictions are disabled
9310     *
9311     * This function returns whether a tooltip is allowed to expand beyond
9312     * its parant window's canvas.
9313     * It will instead be limited only by the size of the display.
9314     */
9315    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9316    /**
9317     * Set the type of mouse pointer/cursor decoration to be shown,
9318     * when the mouse pointer is over the given gengrid widget item
9319     *
9320     * @param item gengrid item to customize cursor on
9321     * @param cursor the cursor type's name
9322     *
9323     * This function works analogously as elm_object_cursor_set(), but
9324     * here the cursor's changing area is restricted to the item's
9325     * area, and not the whole widget's. Note that that item cursors
9326     * have precedence over widget cursors, so that a mouse over @p
9327     * item will always show cursor @p type.
9328     *
9329     * If this function is called twice for an object, a previously set
9330     * cursor will be unset on the second call.
9331     *
9332     * @see elm_object_cursor_set()
9333     * @see elm_gengrid_item_cursor_get()
9334     * @see elm_gengrid_item_cursor_unset()
9335     *
9336     * @ingroup Gengrid
9337     */
9338    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9339
9340    /**
9341     * Get the type of mouse pointer/cursor decoration set to be shown,
9342     * when the mouse pointer is over the given gengrid widget item
9343     *
9344     * @param item gengrid item with custom cursor set
9345     * @return the cursor type's name or @c NULL, if no custom cursors
9346     * were set to @p item (and on errors)
9347     *
9348     * @see elm_object_cursor_get()
9349     * @see elm_gengrid_item_cursor_set() for more details
9350     * @see elm_gengrid_item_cursor_unset()
9351     *
9352     * @ingroup Gengrid
9353     */
9354    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9355
9356    /**
9357     * Unset any custom mouse pointer/cursor decoration set to be
9358     * shown, when the mouse pointer is over the given gengrid widget
9359     * item, thus making it show the @b default cursor again.
9360     *
9361     * @param item a gengrid item
9362     *
9363     * Use this call to undo any custom settings on this item's cursor
9364     * decoration, bringing it back to defaults (no custom style set).
9365     *
9366     * @see elm_object_cursor_unset()
9367     * @see elm_gengrid_item_cursor_set() for more details
9368     *
9369     * @ingroup Gengrid
9370     */
9371    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9372
9373    /**
9374     * Set a different @b style for a given custom cursor set for a
9375     * gengrid item.
9376     *
9377     * @param item gengrid item with custom cursor set
9378     * @param style the <b>theme style</b> to use (e.g. @c "default",
9379     * @c "transparent", etc)
9380     *
9381     * This function only makes sense when one is using custom mouse
9382     * cursor decorations <b>defined in a theme file</b> , which can
9383     * have, given a cursor name/type, <b>alternate styles</b> on
9384     * it. It works analogously as elm_object_cursor_style_set(), but
9385     * here applied only to gengrid item objects.
9386     *
9387     * @warning Before you set a cursor style you should have defined a
9388     *       custom cursor previously on the item, with
9389     *       elm_gengrid_item_cursor_set()
9390     *
9391     * @see elm_gengrid_item_cursor_engine_only_set()
9392     * @see elm_gengrid_item_cursor_style_get()
9393     *
9394     * @ingroup Gengrid
9395     */
9396    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9397
9398    /**
9399     * Get the current @b style set for a given gengrid item's custom
9400     * cursor
9401     *
9402     * @param item gengrid item with custom cursor set.
9403     * @return style the cursor style in use. If the object does not
9404     *         have a cursor set, then @c NULL is returned.
9405     *
9406     * @see elm_gengrid_item_cursor_style_set() for more details
9407     *
9408     * @ingroup Gengrid
9409     */
9410    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9411
9412    /**
9413     * Set if the (custom) cursor for a given gengrid item should be
9414     * searched in its theme, also, or should only rely on the
9415     * rendering engine.
9416     *
9417     * @param item item with custom (custom) cursor already set on
9418     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9419     * only on those provided by the rendering engine, @c EINA_FALSE to
9420     * have them searched on the widget's theme, as well.
9421     *
9422     * @note This call is of use only if you've set a custom cursor
9423     * for gengrid items, with elm_gengrid_item_cursor_set().
9424     *
9425     * @note By default, cursors will only be looked for between those
9426     * provided by the rendering engine.
9427     *
9428     * @ingroup Gengrid
9429     */
9430    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9431
9432    /**
9433     * Get if the (custom) cursor for a given gengrid item is being
9434     * searched in its theme, also, or is only relying on the rendering
9435     * engine.
9436     *
9437     * @param item a gengrid item
9438     * @return @c EINA_TRUE, if cursors are being looked for only on
9439     * those provided by the rendering engine, @c EINA_FALSE if they
9440     * are being searched on the widget's theme, as well.
9441     *
9442     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9443     *
9444     * @ingroup Gengrid
9445     */
9446    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9447
9448    /**
9449     * Remove all items from a given gengrid widget
9450     *
9451     * @param obj The gengrid object.
9452     *
9453     * This removes (and deletes) all items in @p obj, leaving it
9454     * empty.
9455     *
9456     * @see elm_gengrid_item_del(), to remove just one item.
9457     *
9458     * @ingroup Gengrid
9459     */
9460    WILL_DEPRECATE EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9461
9462    /**
9463     * Get the selected item in a given gengrid widget
9464     *
9465     * @param obj The gengrid object.
9466     * @return The selected item's handleor @c NULL, if none is
9467     * selected at the moment (and on errors)
9468     *
9469     * This returns the selected item in @p obj. If multi selection is
9470     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9471     * the first item in the list is selected, which might not be very
9472     * useful. For that case, see elm_gengrid_selected_items_get().
9473     *
9474     * @ingroup Gengrid
9475     */
9476    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9477
9478    /**
9479     * Get <b>a list</b> of selected items in a given gengrid
9480     *
9481     * @param obj The gengrid object.
9482     * @return The list of selected items or @c NULL, if none is
9483     * selected at the moment (and on errors)
9484     *
9485     * This returns a list of the selected items, in the order that
9486     * they appear in the grid. This list is only valid as long as no
9487     * more items are selected or unselected (or unselected implictly
9488     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9489     * data, naturally.
9490     *
9491     * @see elm_gengrid_selected_item_get()
9492     *
9493     * @ingroup Gengrid
9494     */
9495    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9496
9497    /**
9498     * @}
9499     */
9500
9501    /**
9502     * @defgroup Clock Clock
9503     *
9504     * @image html img/widget/clock/preview-00.png
9505     * @image latex img/widget/clock/preview-00.eps
9506     *
9507     * This is a @b digital clock widget. In its default theme, it has a
9508     * vintage "flipping numbers clock" appearance, which will animate
9509     * sheets of individual algarisms individually as time goes by.
9510     *
9511     * A newly created clock will fetch system's time (already
9512     * considering local time adjustments) to start with, and will tick
9513     * accondingly. It may or may not show seconds.
9514     *
9515     * Clocks have an @b edition mode. When in it, the sheets will
9516     * display extra arrow indications on the top and bottom and the
9517     * user may click on them to raise or lower the time values. After
9518     * it's told to exit edition mode, it will keep ticking with that
9519     * new time set (it keeps the difference from local time).
9520     *
9521     * Also, when under edition mode, user clicks on the cited arrows
9522     * which are @b held for some time will make the clock to flip the
9523     * sheet, thus editing the time, continuosly and automatically for
9524     * the user. The interval between sheet flips will keep growing in
9525     * time, so that it helps the user to reach a time which is distant
9526     * from the one set.
9527     *
9528     * The time display is, by default, in military mode (24h), but an
9529     * am/pm indicator may be optionally shown, too, when it will
9530     * switch to 12h.
9531     *
9532     * Smart callbacks one can register to:
9533     * - "changed" - the clock's user changed the time
9534     *
9535     * Here is an example on its usage:
9536     * @li @ref clock_example
9537     */
9538
9539    /**
9540     * @addtogroup Clock
9541     * @{
9542     */
9543
9544    /**
9545     * Identifiers for which clock digits should be editable, when a
9546     * clock widget is in edition mode. Values may be ORed together to
9547     * make a mask, naturally.
9548     *
9549     * @see elm_clock_edit_set()
9550     * @see elm_clock_digit_edit_set()
9551     */
9552    typedef enum _Elm_Clock_Digedit
9553      {
9554         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9555         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9556         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9557         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9558         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9559         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9560         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9561         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9562      } Elm_Clock_Digedit;
9563
9564    /**
9565     * Add a new clock widget to the given parent Elementary
9566     * (container) object
9567     *
9568     * @param parent The parent object
9569     * @return a new clock widget handle or @c NULL, on errors
9570     *
9571     * This function inserts a new clock widget on the canvas.
9572     *
9573     * @ingroup Clock
9574     */
9575    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9576
9577    /**
9578     * Set a clock widget's time, programmatically
9579     *
9580     * @param obj The clock widget object
9581     * @param hrs The hours to set
9582     * @param min The minutes to set
9583     * @param sec The secondes to set
9584     *
9585     * This function updates the time that is showed by the clock
9586     * widget.
9587     *
9588     *  Values @b must be set within the following ranges:
9589     * - 0 - 23, for hours
9590     * - 0 - 59, for minutes
9591     * - 0 - 59, for seconds,
9592     *
9593     * even if the clock is not in "military" mode.
9594     *
9595     * @warning The behavior for values set out of those ranges is @b
9596     * undefined.
9597     *
9598     * @ingroup Clock
9599     */
9600    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9601
9602    /**
9603     * Get a clock widget's time values
9604     *
9605     * @param obj The clock object
9606     * @param[out] hrs Pointer to the variable to get the hours value
9607     * @param[out] min Pointer to the variable to get the minutes value
9608     * @param[out] sec Pointer to the variable to get the seconds value
9609     *
9610     * This function gets the time set for @p obj, returning
9611     * it on the variables passed as the arguments to function
9612     *
9613     * @note Use @c NULL pointers on the time values you're not
9614     * interested in: they'll be ignored by the function.
9615     *
9616     * @ingroup Clock
9617     */
9618    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9619
9620    /**
9621     * Set whether a given clock widget is under <b>edition mode</b> or
9622     * under (default) displaying-only mode.
9623     *
9624     * @param obj The clock object
9625     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9626     * put it back to "displaying only" mode
9627     *
9628     * This function makes a clock's time to be editable or not <b>by
9629     * user interaction</b>. When in edition mode, clocks @b stop
9630     * ticking, until one brings them back to canonical mode. The
9631     * elm_clock_digit_edit_set() function will influence which digits
9632     * of the clock will be editable. By default, all of them will be
9633     * (#ELM_CLOCK_NONE).
9634     *
9635     * @note am/pm sheets, if being shown, will @b always be editable
9636     * under edition mode.
9637     *
9638     * @see elm_clock_edit_get()
9639     *
9640     * @ingroup Clock
9641     */
9642    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9643
9644    /**
9645     * Retrieve whether a given clock widget is under <b>edition
9646     * mode</b> or under (default) displaying-only mode.
9647     *
9648     * @param obj The clock object
9649     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9650     * otherwise
9651     *
9652     * This function retrieves whether the clock's time can be edited
9653     * or not by user interaction.
9654     *
9655     * @see elm_clock_edit_set() for more details
9656     *
9657     * @ingroup Clock
9658     */
9659    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9660
9661    /**
9662     * Set what digits of the given clock widget should be editable
9663     * when in edition mode.
9664     *
9665     * @param obj The clock object
9666     * @param digedit Bit mask indicating the digits to be editable
9667     * (values in #Elm_Clock_Digedit).
9668     *
9669     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9670     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9671     * EINA_FALSE).
9672     *
9673     * @see elm_clock_digit_edit_get()
9674     *
9675     * @ingroup Clock
9676     */
9677    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9678
9679    /**
9680     * Retrieve what digits of the given clock widget should be
9681     * editable when in edition mode.
9682     *
9683     * @param obj The clock object
9684     * @return Bit mask indicating the digits to be editable
9685     * (values in #Elm_Clock_Digedit).
9686     *
9687     * @see elm_clock_digit_edit_set() for more details
9688     *
9689     * @ingroup Clock
9690     */
9691    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9692
9693    /**
9694     * Set if the given clock widget must show hours in military or
9695     * am/pm mode
9696     *
9697     * @param obj The clock object
9698     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9699     * to military mode
9700     *
9701     * This function sets if the clock must show hours in military or
9702     * am/pm mode. In some countries like Brazil the military mode
9703     * (00-24h-format) is used, in opposition to the USA, where the
9704     * am/pm mode is more commonly used.
9705     *
9706     * @see elm_clock_show_am_pm_get()
9707     *
9708     * @ingroup Clock
9709     */
9710    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9711
9712    /**
9713     * Get if the given clock widget shows hours in military or am/pm
9714     * mode
9715     *
9716     * @param obj The clock object
9717     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9718     * military
9719     *
9720     * This function gets if the clock shows hours in military or am/pm
9721     * mode.
9722     *
9723     * @see elm_clock_show_am_pm_set() for more details
9724     *
9725     * @ingroup Clock
9726     */
9727    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9728
9729    /**
9730     * Set if the given clock widget must show time with seconds or not
9731     *
9732     * @param obj The clock object
9733     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9734     *
9735     * This function sets if the given clock must show or not elapsed
9736     * seconds. By default, they are @b not shown.
9737     *
9738     * @see elm_clock_show_seconds_get()
9739     *
9740     * @ingroup Clock
9741     */
9742    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9743
9744    /**
9745     * Get whether the given clock widget is showing time with seconds
9746     * or not
9747     *
9748     * @param obj The clock object
9749     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9750     *
9751     * This function gets whether @p obj is showing or not the elapsed
9752     * seconds.
9753     *
9754     * @see elm_clock_show_seconds_set()
9755     *
9756     * @ingroup Clock
9757     */
9758    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9759
9760    /**
9761     * Set the interval on time updates for an user mouse button hold
9762     * on clock widgets' time edition.
9763     *
9764     * @param obj The clock object
9765     * @param interval The (first) interval value in seconds
9766     *
9767     * This interval value is @b decreased while the user holds the
9768     * mouse pointer either incrementing or decrementing a given the
9769     * clock digit's value.
9770     *
9771     * This helps the user to get to a given time distant from the
9772     * current one easier/faster, as it will start to flip quicker and
9773     * quicker on mouse button holds.
9774     *
9775     * The calculation for the next flip interval value, starting from
9776     * the one set with this call, is the previous interval divided by
9777     * 1.05, so it decreases a little bit.
9778     *
9779     * The default starting interval value for automatic flips is
9780     * @b 0.85 seconds.
9781     *
9782     * @see elm_clock_interval_get()
9783     *
9784     * @ingroup Clock
9785     */
9786    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9787
9788    /**
9789     * Get the interval on time updates for an user mouse button hold
9790     * on clock widgets' time edition.
9791     *
9792     * @param obj The clock object
9793     * @return The (first) interval value, in seconds, set on it
9794     *
9795     * @see elm_clock_interval_set() for more details
9796     *
9797     * @ingroup Clock
9798     */
9799    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9800
9801    /**
9802     * @}
9803     */
9804
9805    /**
9806     * @defgroup Layout Layout
9807     *
9808     * @image html img/widget/layout/preview-00.png
9809     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9810     *
9811     * @image html img/layout-predefined.png
9812     * @image latex img/layout-predefined.eps width=\textwidth
9813     *
9814     * This is a container widget that takes a standard Edje design file and
9815     * wraps it very thinly in a widget.
9816     *
9817     * An Edje design (theme) file has a very wide range of possibilities to
9818     * describe the behavior of elements added to the Layout. Check out the Edje
9819     * documentation and the EDC reference to get more information about what can
9820     * be done with Edje.
9821     *
9822     * Just like @ref List, @ref Box, and other container widgets, any
9823     * object added to the Layout will become its child, meaning that it will be
9824     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9825     *
9826     * The Layout widget can contain as many Contents, Boxes or Tables as
9827     * described in its theme file. For instance, objects can be added to
9828     * different Tables by specifying the respective Table part names. The same
9829     * is valid for Content and Box.
9830     *
9831     * The objects added as child of the Layout will behave as described in the
9832     * part description where they were added. There are 3 possible types of
9833     * parts where a child can be added:
9834     *
9835     * @section secContent Content (SWALLOW part)
9836     *
9837     * Only one object can be added to the @c SWALLOW part (but you still can
9838     * have many @c SWALLOW parts and one object on each of them). Use the @c
9839     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9840     * objects as content of the @c SWALLOW. After being set to this part, the 
9841     * object size, position, visibility, clipping and other description 
9842     * properties will be totally controled by the description of the given part 
9843     * (inside the Edje theme file).
9844     *
9845     * One can use @c evas_object_size_hint_* functions on the child to have some
9846     * kind of control over its behavior, but the resulting behavior will still
9847     * depend heavily on the @c SWALLOW part description.
9848     *
9849     * The Edje theme also can change the part description, based on signals or
9850     * scripts running inside the theme. This change can also be animated. All of
9851     * this will affect the child object set as content accordingly. The object
9852     * size will be changed if the part size is changed, it will animate move if
9853     * the part is moving, and so on.
9854     *
9855     * The following picture demonstrates a Layout widget with a child object
9856     * added to its @c SWALLOW:
9857     *
9858     * @image html layout_swallow.png
9859     * @image latex layout_swallow.eps width=\textwidth
9860     *
9861     * @section secBox Box (BOX part)
9862     *
9863     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9864     * allows one to add objects to the box and have them distributed along its
9865     * area, accordingly to the specified @a layout property (now by @a layout we
9866     * mean the chosen layouting design of the Box, not the Layout widget
9867     * itself).
9868     *
9869     * A similar effect for having a box with its position, size and other things
9870     * controled by the Layout theme would be to create an Elementary @ref Box
9871     * widget and add it as a Content in the @c SWALLOW part.
9872     *
9873     * The main difference of using the Layout Box is that its behavior, the box
9874     * properties like layouting format, padding, align, etc. will be all
9875     * controled by the theme. This means, for example, that a signal could be
9876     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9877     * handled the signal by changing the box padding, or align, or both. Using
9878     * the Elementary @ref Box widget is not necessarily harder or easier, it
9879     * just depends on the circunstances and requirements.
9880     *
9881     * The Layout Box can be used through the @c elm_layout_box_* set of
9882     * functions.
9883     *
9884     * The following picture demonstrates a Layout widget with many child objects
9885     * added to its @c BOX part:
9886     *
9887     * @image html layout_box.png
9888     * @image latex layout_box.eps width=\textwidth
9889     *
9890     * @section secTable Table (TABLE part)
9891     *
9892     * Just like the @ref secBox, the Layout Table is very similar to the
9893     * Elementary @ref Table widget. It allows one to add objects to the Table
9894     * specifying the row and column where the object should be added, and any
9895     * column or row span if necessary.
9896     *
9897     * Again, we could have this design by adding a @ref Table widget to the @c
9898     * SWALLOW part using elm_object_part_content_set(). The same difference happens
9899     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9900     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9901     *
9902     * The Layout Table can be used through the @c elm_layout_table_* set of
9903     * functions.
9904     *
9905     * The following picture demonstrates a Layout widget with many child objects
9906     * added to its @c TABLE part:
9907     *
9908     * @image html layout_table.png
9909     * @image latex layout_table.eps width=\textwidth
9910     *
9911     * @section secPredef Predefined Layouts
9912     *
9913     * Another interesting thing about the Layout widget is that it offers some
9914     * predefined themes that come with the default Elementary theme. These
9915     * themes can be set by the call elm_layout_theme_set(), and provide some
9916     * basic functionality depending on the theme used.
9917     *
9918     * Most of them already send some signals, some already provide a toolbar or
9919     * back and next buttons.
9920     *
9921     * These are available predefined theme layouts. All of them have class = @c
9922     * layout, group = @c application, and style = one of the following options:
9923     *
9924     * @li @c toolbar-content - application with toolbar and main content area
9925     * @li @c toolbar-content-back - application with toolbar and main content
9926     * area with a back button and title area
9927     * @li @c toolbar-content-back-next - application with toolbar and main
9928     * content area with a back and next buttons and title area
9929     * @li @c content-back - application with a main content area with a back
9930     * button and title area
9931     * @li @c content-back-next - application with a main content area with a
9932     * back and next buttons and title area
9933     * @li @c toolbar-vbox - application with toolbar and main content area as a
9934     * vertical box
9935     * @li @c toolbar-table - application with toolbar and main content area as a
9936     * table
9937     *
9938     * @section secExamples Examples
9939     *
9940     * Some examples of the Layout widget can be found here:
9941     * @li @ref layout_example_01
9942     * @li @ref layout_example_02
9943     * @li @ref layout_example_03
9944     * @li @ref layout_example_edc
9945     *
9946     */
9947
9948    /**
9949     * Add a new layout to the parent
9950     *
9951     * @param parent The parent object
9952     * @return The new object or NULL if it cannot be created
9953     *
9954     * @see elm_layout_file_set()
9955     * @see elm_layout_theme_set()
9956     *
9957     * @ingroup Layout
9958     */
9959    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9960    /**
9961     * Set the file that will be used as layout
9962     *
9963     * @param obj The layout object
9964     * @param file The path to file (edj) that will be used as layout
9965     * @param group The group that the layout belongs in edje file
9966     *
9967     * @return (1 = success, 0 = error)
9968     *
9969     * @ingroup Layout
9970     */
9971    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9972    /**
9973     * Set the edje group from the elementary theme that will be used as layout
9974     *
9975     * @param obj The layout object
9976     * @param clas the clas of the group
9977     * @param group the group
9978     * @param style the style to used
9979     *
9980     * @return (1 = success, 0 = error)
9981     *
9982     * @ingroup Layout
9983     */
9984    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9985    /**
9986     * Set the layout content.
9987     *
9988     * @param obj The layout object
9989     * @param swallow The swallow part name in the edje file
9990     * @param content The child that will be added in this layout object
9991     *
9992     * Once the content object is set, a previously set one will be deleted.
9993     * If you want to keep that old content object, use the
9994     * elm_object_part_content_unset() function.
9995     *
9996     * @note In an Edje theme, the part used as a content container is called @c
9997     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9998     * expected to be a part name just like the second parameter of
9999     * elm_layout_box_append().
10000     *
10001     * @see elm_layout_box_append()
10002     * @see elm_object_part_content_get()
10003     * @see elm_object_part_content_unset()
10004     * @see @ref secBox
10005     * @deprecated use elm_object_part_content_set() instead
10006     *
10007     * @ingroup Layout
10008     */
10009    WILL_DEPRECATE EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10010    /**
10011     * Get the child object in the given content part.
10012     *
10013     * @param obj The layout object
10014     * @param swallow The SWALLOW part to get its content
10015     *
10016     * @return The swallowed object or NULL if none or an error occurred
10017     *
10018     * @deprecated use elm_object_part_content_get() instead
10019     *
10020     * @ingroup Layout
10021     */
10022    WILL_DEPRECATE EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10023    /**
10024     * Unset the layout content.
10025     *
10026     * @param obj The layout object
10027     * @param swallow The swallow part name in the edje file
10028     * @return The content that was being used
10029     *
10030     * Unparent and return the content object which was set for this part.
10031     *
10032     * @deprecated use elm_object_part_content_unset() instead
10033     *
10034     * @ingroup Layout
10035     */
10036    WILL_DEPRECATE EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10037    /**
10038     * Set the text of the given part
10039     *
10040     * @param obj The layout object
10041     * @param part The TEXT part where to set the text
10042     * @param text The text to set
10043     *
10044     * @ingroup Layout
10045     * @deprecated use elm_object_part_text_set() instead.
10046     */
10047    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10048    /**
10049     * Get the text set in the given part
10050     *
10051     * @param obj The layout object
10052     * @param part The TEXT part to retrieve the text off
10053     *
10054     * @return The text set in @p part
10055     *
10056     * @ingroup Layout
10057     * @deprecated use elm_object_part_text_get() instead.
10058     */
10059    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10060    /**
10061     * Append child to layout box part.
10062     *
10063     * @param obj the layout object
10064     * @param part the box part to which the object will be appended.
10065     * @param child the child object to append to box.
10066     *
10067     * Once the object is appended, it will become child of the layout. Its
10068     * lifetime will be bound to the layout, whenever the layout dies the child
10069     * will be deleted automatically. One should use elm_layout_box_remove() to
10070     * make this layout forget about the object.
10071     *
10072     * @see elm_layout_box_prepend()
10073     * @see elm_layout_box_insert_before()
10074     * @see elm_layout_box_insert_at()
10075     * @see elm_layout_box_remove()
10076     *
10077     * @ingroup Layout
10078     */
10079    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10080    /**
10081     * Prepend child to layout box part.
10082     *
10083     * @param obj the layout object
10084     * @param part the box part to prepend.
10085     * @param child the child object to prepend to box.
10086     *
10087     * Once the object is prepended, it will become child of the layout. Its
10088     * lifetime will be bound to the layout, whenever the layout dies the child
10089     * will be deleted automatically. One should use elm_layout_box_remove() to
10090     * make this layout forget about the object.
10091     *
10092     * @see elm_layout_box_append()
10093     * @see elm_layout_box_insert_before()
10094     * @see elm_layout_box_insert_at()
10095     * @see elm_layout_box_remove()
10096     *
10097     * @ingroup Layout
10098     */
10099    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10100    /**
10101     * Insert child to layout box part before a reference object.
10102     *
10103     * @param obj the layout object
10104     * @param part the box part to insert.
10105     * @param child the child object to insert into box.
10106     * @param reference another reference object to insert before in box.
10107     *
10108     * Once the object is inserted, it will become child of the layout. Its
10109     * lifetime will be bound to the layout, whenever the layout dies the child
10110     * will be deleted automatically. One should use elm_layout_box_remove() to
10111     * make this layout forget about the object.
10112     *
10113     * @see elm_layout_box_append()
10114     * @see elm_layout_box_prepend()
10115     * @see elm_layout_box_insert_before()
10116     * @see elm_layout_box_remove()
10117     *
10118     * @ingroup Layout
10119     */
10120    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10121    /**
10122     * Insert child to layout box part at a given position.
10123     *
10124     * @param obj the layout object
10125     * @param part the box part to insert.
10126     * @param child the child object to insert into box.
10127     * @param pos the numeric position >=0 to insert the child.
10128     *
10129     * Once the object is inserted, it will become child of the layout. Its
10130     * lifetime will be bound to the layout, whenever the layout dies the child
10131     * will be deleted automatically. One should use elm_layout_box_remove() to
10132     * make this layout forget about the object.
10133     *
10134     * @see elm_layout_box_append()
10135     * @see elm_layout_box_prepend()
10136     * @see elm_layout_box_insert_before()
10137     * @see elm_layout_box_remove()
10138     *
10139     * @ingroup Layout
10140     */
10141    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10142    /**
10143     * Remove a child of the given part box.
10144     *
10145     * @param obj The layout object
10146     * @param part The box part name to remove child.
10147     * @param child The object to remove from box.
10148     * @return The object that was being used, or NULL if not found.
10149     *
10150     * The object will be removed from the box part and its lifetime will
10151     * not be handled by the layout anymore. This is equivalent to
10152     * elm_object_part_content_unset() for box.
10153     *
10154     * @see elm_layout_box_append()
10155     * @see elm_layout_box_remove_all()
10156     *
10157     * @ingroup Layout
10158     */
10159    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10160    /**
10161     * Remove all child of the given part box.
10162     *
10163     * @param obj The layout object
10164     * @param part The box part name to remove child.
10165     * @param clear If EINA_TRUE, then all objects will be deleted as
10166     *        well, otherwise they will just be removed and will be
10167     *        dangling on the canvas.
10168     *
10169     * The objects will be removed from the box part and their lifetime will
10170     * not be handled by the layout anymore. This is equivalent to
10171     * elm_layout_box_remove() for all box children.
10172     *
10173     * @see elm_layout_box_append()
10174     * @see elm_layout_box_remove()
10175     *
10176     * @ingroup Layout
10177     */
10178    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10179    /**
10180     * Insert child to layout table part.
10181     *
10182     * @param obj the layout object
10183     * @param part the box part to pack child.
10184     * @param child_obj the child object to pack into table.
10185     * @param col the column to which the child should be added. (>= 0)
10186     * @param row the row to which the child should be added. (>= 0)
10187     * @param colspan how many columns should be used to store this object. (>=
10188     *        1)
10189     * @param rowspan how many rows should be used to store this object. (>= 1)
10190     *
10191     * Once the object is inserted, it will become child of the table. Its
10192     * lifetime will be bound to the layout, and whenever the layout dies the
10193     * child will be deleted automatically. One should use
10194     * elm_layout_table_remove() to make this layout forget about the object.
10195     *
10196     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10197     * more space than a single cell. For instance, the following code:
10198     * @code
10199     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10200     * @endcode
10201     *
10202     * Would result in an object being added like the following picture:
10203     *
10204     * @image html layout_colspan.png
10205     * @image latex layout_colspan.eps width=\textwidth
10206     *
10207     * @see elm_layout_table_unpack()
10208     * @see elm_layout_table_clear()
10209     *
10210     * @ingroup Layout
10211     */
10212    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);
10213    /**
10214     * Unpack (remove) a child of the given part table.
10215     *
10216     * @param obj The layout object
10217     * @param part The table part name to remove child.
10218     * @param child_obj The object to remove from table.
10219     * @return The object that was being used, or NULL if not found.
10220     *
10221     * The object will be unpacked from the table part and its lifetime
10222     * will not be handled by the layout anymore. This is equivalent to
10223     * elm_object_part_content_unset() for table.
10224     *
10225     * @see elm_layout_table_pack()
10226     * @see elm_layout_table_clear()
10227     *
10228     * @ingroup Layout
10229     */
10230    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10231    /**
10232     * Remove all child of the given part table.
10233     *
10234     * @param obj The layout object
10235     * @param part The table part name to remove child.
10236     * @param clear If EINA_TRUE, then all objects will be deleted as
10237     *        well, otherwise they will just be removed and will be
10238     *        dangling on the canvas.
10239     *
10240     * The objects will be removed from the table part and their lifetime will
10241     * not be handled by the layout anymore. This is equivalent to
10242     * elm_layout_table_unpack() for all table children.
10243     *
10244     * @see elm_layout_table_pack()
10245     * @see elm_layout_table_unpack()
10246     *
10247     * @ingroup Layout
10248     */
10249    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10250    /**
10251     * Get the edje layout
10252     *
10253     * @param obj The layout object
10254     *
10255     * @return A Evas_Object with the edje layout settings loaded
10256     * with function elm_layout_file_set
10257     *
10258     * This returns the edje object. It is not expected to be used to then
10259     * swallow objects via edje_object_part_swallow() for example. Use
10260     * elm_object_part_content_set() instead so child object handling and sizing is
10261     * done properly.
10262     *
10263     * @note This function should only be used if you really need to call some
10264     * low level Edje function on this edje object. All the common stuff (setting
10265     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10266     * with proper elementary functions.
10267     *
10268     * @see elm_object_signal_callback_add()
10269     * @see elm_object_signal_emit()
10270     * @see elm_object_part_text_set()
10271     * @see elm_object_part_content_set()
10272     * @see elm_layout_box_append()
10273     * @see elm_layout_table_pack()
10274     * @see elm_layout_data_get()
10275     *
10276     * @ingroup Layout
10277     */
10278    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10279    /**
10280     * Get the edje data from the given layout
10281     *
10282     * @param obj The layout object
10283     * @param key The data key
10284     *
10285     * @return The edje data string
10286     *
10287     * This function fetches data specified inside the edje theme of this layout.
10288     * This function return NULL if data is not found.
10289     *
10290     * In EDC this comes from a data block within the group block that @p
10291     * obj was loaded from. E.g.
10292     *
10293     * @code
10294     * collections {
10295     *   group {
10296     *     name: "a_group";
10297     *     data {
10298     *       item: "key1" "value1";
10299     *       item: "key2" "value2";
10300     *     }
10301     *   }
10302     * }
10303     * @endcode
10304     *
10305     * @ingroup Layout
10306     */
10307    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10308    /**
10309     * Eval sizing
10310     *
10311     * @param obj The layout object
10312     *
10313     * Manually forces a sizing re-evaluation. This is useful when the minimum
10314     * size required by the edje theme of this layout has changed. The change on
10315     * the minimum size required by the edje theme is not immediately reported to
10316     * the elementary layout, so one needs to call this function in order to tell
10317     * the widget (layout) that it needs to reevaluate its own size.
10318     *
10319     * The minimum size of the theme is calculated based on minimum size of
10320     * parts, the size of elements inside containers like box and table, etc. All
10321     * of this can change due to state changes, and that's when this function
10322     * should be called.
10323     *
10324     * Also note that a standard signal of "size,eval" "elm" emitted from the
10325     * edje object will cause this to happen too.
10326     *
10327     * @ingroup Layout
10328     */
10329    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10330
10331    /**
10332     * Sets a specific cursor for an edje part.
10333     *
10334     * @param obj The layout object.
10335     * @param part_name a part from loaded edje group.
10336     * @param cursor cursor name to use, see Elementary_Cursor.h
10337     *
10338     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10339     *         part not exists or it has "mouse_events: 0".
10340     *
10341     * @ingroup Layout
10342     */
10343    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10344
10345    /**
10346     * Get the cursor to be shown when mouse is over an edje part
10347     *
10348     * @param obj The layout object.
10349     * @param part_name a part from loaded edje group.
10350     * @return the cursor name.
10351     *
10352     * @ingroup Layout
10353     */
10354    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10355
10356    /**
10357     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10358     *
10359     * @param obj The layout object.
10360     * @param part_name a part from loaded edje group, that had a cursor set
10361     *        with elm_layout_part_cursor_set().
10362     *
10363     * @ingroup Layout
10364     */
10365    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10366
10367    /**
10368     * Sets a specific cursor style for an edje part.
10369     *
10370     * @param obj The layout object.
10371     * @param part_name a part from loaded edje group.
10372     * @param style the theme style to use (default, transparent, ...)
10373     *
10374     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10375     *         part not exists or it did not had a cursor set.
10376     *
10377     * @ingroup Layout
10378     */
10379    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10380
10381    /**
10382     * Gets a specific cursor style for an edje part.
10383     *
10384     * @param obj The layout object.
10385     * @param part_name a part from loaded edje group.
10386     *
10387     * @return the theme style in use, defaults to "default". If the
10388     *         object does not have a cursor set, then NULL is returned.
10389     *
10390     * @ingroup Layout
10391     */
10392    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10393
10394    /**
10395     * Sets if the cursor set should be searched on the theme or should use
10396     * the provided by the engine, only.
10397     *
10398     * @note before you set if should look on theme you should define a
10399     * cursor with elm_layout_part_cursor_set(). By default it will only
10400     * look for cursors provided by the engine.
10401     *
10402     * @param obj The layout object.
10403     * @param part_name a part from loaded edje group.
10404     * @param engine_only if cursors should be just provided by the engine
10405     *        or should also search on widget's theme as well
10406     *
10407     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10408     *         part not exists or it did not had a cursor set.
10409     *
10410     * @ingroup Layout
10411     */
10412    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);
10413
10414    /**
10415     * Gets a specific cursor engine_only for an edje part.
10416     *
10417     * @param obj The layout object.
10418     * @param part_name a part from loaded edje group.
10419     *
10420     * @return whenever the cursor is just provided by engine or also from theme.
10421     *
10422     * @ingroup Layout
10423     */
10424    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10425
10426 /**
10427  * @def elm_layout_icon_set
10428  * Convienience macro to set the icon object in a layout that follows the
10429  * Elementary naming convention for its parts.
10430  *
10431  * @ingroup Layout
10432  */
10433 #define elm_layout_icon_set(_ly, _obj) \
10434   do { \
10435     const char *sig; \
10436     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10437     if ((_obj)) sig = "elm,state,icon,visible"; \
10438     else sig = "elm,state,icon,hidden"; \
10439     elm_object_signal_emit((_ly), sig, "elm"); \
10440   } while (0)
10441
10442 /**
10443  * @def elm_layout_icon_get
10444  * Convienience macro to get the icon object from a layout that follows the
10445  * Elementary naming convention for its parts.
10446  *
10447  * @ingroup Layout
10448  */
10449 #define elm_layout_icon_get(_ly) \
10450   elm_object_part_content_get((_ly), "elm.swallow.icon")
10451
10452 /**
10453  * @def elm_layout_end_set
10454  * Convienience macro to set the end object in a layout that follows the
10455  * Elementary naming convention for its parts.
10456  *
10457  * @ingroup Layout
10458  */
10459 #define elm_layout_end_set(_ly, _obj) \
10460   do { \
10461     const char *sig; \
10462     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10463     if ((_obj)) sig = "elm,state,end,visible"; \
10464     else sig = "elm,state,end,hidden"; \
10465     elm_object_signal_emit((_ly), sig, "elm"); \
10466   } while (0)
10467
10468 /**
10469  * @def elm_layout_end_get
10470  * Convienience macro to get the end object in a layout that follows the
10471  * Elementary naming convention for its parts.
10472  *
10473  * @ingroup Layout
10474  */
10475 #define elm_layout_end_get(_ly) \
10476   elm_object_part_content_get((_ly), "elm.swallow.end")
10477
10478 /**
10479  * @def elm_layout_label_set
10480  * Convienience macro to set the label in a layout that follows the
10481  * Elementary naming convention for its parts.
10482  *
10483  * @ingroup Layout
10484  * @deprecated use elm_object_text_set() instead.
10485  */
10486 #define elm_layout_label_set(_ly, _txt) \
10487   elm_layout_text_set((_ly), "elm.text", (_txt))
10488
10489 /**
10490  * @def elm_layout_label_get
10491  * Convenience macro to get the label in a layout that follows the
10492  * Elementary naming convention for its parts.
10493  *
10494  * @ingroup Layout
10495  * @deprecated use elm_object_text_set() instead.
10496  */
10497 #define elm_layout_label_get(_ly) \
10498   elm_layout_text_get((_ly), "elm.text")
10499
10500    /* smart callbacks called:
10501     * "theme,changed" - when elm theme is changed.
10502     */
10503
10504    /**
10505     * @defgroup Notify Notify
10506     *
10507     * @image html img/widget/notify/preview-00.png
10508     * @image latex img/widget/notify/preview-00.eps
10509     *
10510     * Display a container in a particular region of the parent(top, bottom,
10511     * etc).  A timeout can be set to automatically hide the notify. This is so
10512     * that, after an evas_object_show() on a notify object, if a timeout was set
10513     * on it, it will @b automatically get hidden after that time.
10514     *
10515     * Signals that you can add callbacks for are:
10516     * @li "timeout" - when timeout happens on notify and it's hidden
10517     * @li "block,clicked" - when a click outside of the notify happens
10518     *
10519     * Default contents parts of the notify widget that you can use for are:
10520     * @li "default" - A content of the notify
10521     *
10522     * @ref tutorial_notify show usage of the API.
10523     *
10524     * @{
10525     */
10526    /**
10527     * @brief Possible orient values for notify.
10528     *
10529     * This values should be used in conjunction to elm_notify_orient_set() to
10530     * set the position in which the notify should appear(relative to its parent)
10531     * and in conjunction with elm_notify_orient_get() to know where the notify
10532     * is appearing.
10533     */
10534    typedef enum _Elm_Notify_Orient
10535      {
10536         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10537         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10538         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10539         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10540         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10541         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10542         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10543         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10544         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10545         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10546      } Elm_Notify_Orient;
10547    /**
10548     * @brief Add a new notify to the parent
10549     *
10550     * @param parent The parent object
10551     * @return The new object or NULL if it cannot be created
10552     */
10553    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10554    /**
10555     * @brief Set the content of the notify widget
10556     *
10557     * @param obj The notify object
10558     * @param content The content will be filled in this notify object
10559     *
10560     * Once the content object is set, a previously set one will be deleted. If
10561     * you want to keep that old content object, use the
10562     * elm_notify_content_unset() function.
10563     *
10564     * @deprecated use elm_object_content_set() instead
10565     *
10566     */
10567    WILL_DEPRECATE EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10568    /**
10569     * @brief Unset the content of the notify widget
10570     *
10571     * @param obj The notify object
10572     * @return The content that was being used
10573     *
10574     * Unparent and return the content object which was set for this widget
10575     *
10576     * @see elm_notify_content_set()
10577     * @deprecated use elm_object_content_unset() instead
10578     *
10579     */
10580    WILL_DEPRECATE EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10581    /**
10582     * @brief Return the content of the notify widget
10583     *
10584     * @param obj The notify object
10585     * @return The content that is being used
10586     *
10587     * @see elm_notify_content_set()
10588     * @deprecated use elm_object_content_get() instead
10589     *
10590     */
10591    WILL_DEPRECATE EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10592    /**
10593     * @brief Set the notify parent
10594     *
10595     * @param obj The notify object
10596     * @param content The new parent
10597     *
10598     * Once the parent object is set, a previously set one will be disconnected
10599     * and replaced.
10600     */
10601    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10602    /**
10603     * @brief Get the notify parent
10604     *
10605     * @param obj The notify object
10606     * @return The parent
10607     *
10608     * @see elm_notify_parent_set()
10609     */
10610    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10611    /**
10612     * @brief Set the orientation
10613     *
10614     * @param obj The notify object
10615     * @param orient The new orientation
10616     *
10617     * Sets the position in which the notify will appear in its parent.
10618     *
10619     * @see @ref Elm_Notify_Orient for possible values.
10620     */
10621    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10622    /**
10623     * @brief Return the orientation
10624     * @param obj The notify object
10625     * @return The orientation of the notification
10626     *
10627     * @see elm_notify_orient_set()
10628     * @see Elm_Notify_Orient
10629     */
10630    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10631    /**
10632     * @brief Set the time interval after which the notify window is going to be
10633     * hidden.
10634     *
10635     * @param obj The notify object
10636     * @param time The timeout in seconds
10637     *
10638     * This function sets a timeout and starts the timer controlling when the
10639     * notify is hidden. Since calling evas_object_show() on a notify restarts
10640     * the timer controlling when the notify is hidden, setting this before the
10641     * notify is shown will in effect mean starting the timer when the notify is
10642     * shown.
10643     *
10644     * @note Set a value <= 0.0 to disable a running timer.
10645     *
10646     * @note If the value > 0.0 and the notify is previously visible, the
10647     * timer will be started with this value, canceling any running timer.
10648     */
10649    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10650    /**
10651     * @brief Return the timeout value (in seconds)
10652     * @param obj the notify object
10653     *
10654     * @see elm_notify_timeout_set()
10655     */
10656    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10657    /**
10658     * @brief Sets whether events should be passed to by a click outside
10659     * its area.
10660     *
10661     * @param obj The notify object
10662     * @param repeats EINA_TRUE Events are repeats, else no
10663     *
10664     * When true if the user clicks outside the window the events will be caught
10665     * by the others widgets, else the events are blocked.
10666     *
10667     * @note The default value is EINA_TRUE.
10668     */
10669    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10670    /**
10671     * @brief Return true if events are repeat below the notify object
10672     * @param obj the notify object
10673     *
10674     * @see elm_notify_repeat_events_set()
10675     */
10676    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10677    /**
10678     * @}
10679     */
10680
10681    /**
10682     * @defgroup Hover Hover
10683     *
10684     * @image html img/widget/hover/preview-00.png
10685     * @image latex img/widget/hover/preview-00.eps
10686     *
10687     * A Hover object will hover over its @p parent object at the @p target
10688     * location. Anything in the background will be given a darker coloring to
10689     * indicate that the hover object is on top (at the default theme). When the
10690     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10691     * clicked that @b doesn't cause the hover to be dismissed.
10692     *
10693     * A Hover object has two parents. One parent that owns it during creation
10694     * and the other parent being the one over which the hover object spans.
10695     *
10696     *
10697     * @note The hover object will take up the entire space of @p target
10698     * object.
10699     *
10700     * Elementary has the following styles for the hover widget:
10701     * @li default
10702     * @li popout
10703     * @li menu
10704     * @li hoversel_vertical
10705     *
10706     * The following are the available position for content:
10707     * @li left
10708     * @li top-left
10709     * @li top
10710     * @li top-right
10711     * @li right
10712     * @li bottom-right
10713     * @li bottom
10714     * @li bottom-left
10715     * @li middle
10716     * @li smart
10717     *
10718     * Signals that you can add callbacks for are:
10719     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10720     * @li "smart,changed" - a content object placed under the "smart"
10721     *                   policy was replaced to a new slot direction.
10722     *
10723     * See @ref tutorial_hover for more information.
10724     *
10725     * @{
10726     */
10727    typedef enum _Elm_Hover_Axis
10728      {
10729         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10730         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10731         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10732         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10733      } Elm_Hover_Axis;
10734    /**
10735     * @brief Adds a hover object to @p parent
10736     *
10737     * @param parent The parent object
10738     * @return The hover object or NULL if one could not be created
10739     */
10740    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10741    /**
10742     * @brief Sets the target object for the hover.
10743     *
10744     * @param obj The hover object
10745     * @param target The object to center the hover onto. The hover
10746     *
10747     * This function will cause the hover to be centered on the target object.
10748     */
10749    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10750    /**
10751     * @brief Gets the target object for the hover.
10752     *
10753     * @param obj The hover object
10754     * @param parent The object to locate the hover over.
10755     *
10756     * @see elm_hover_target_set()
10757     */
10758    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10759    /**
10760     * @brief Sets the parent object for the hover.
10761     *
10762     * @param obj The hover object
10763     * @param parent The object to locate the hover over.
10764     *
10765     * This function will cause the hover to take up the entire space that the
10766     * parent object fills.
10767     */
10768    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10769    /**
10770     * @brief Gets the parent object for the hover.
10771     *
10772     * @param obj The hover object
10773     * @return The parent object to locate the hover over.
10774     *
10775     * @see elm_hover_parent_set()
10776     */
10777    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10778    /**
10779     * @brief Sets the content of the hover object and the direction in which it
10780     * will pop out.
10781     *
10782     * @param obj The hover object
10783     * @param swallow The direction that the object will be displayed
10784     * at. Accepted values are "left", "top-left", "top", "top-right",
10785     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10786     * "smart".
10787     * @param content The content to place at @p swallow
10788     *
10789     * Once the content object is set for a given direction, a previously
10790     * set one (on the same direction) will be deleted. If you want to
10791     * keep that old content object, use the elm_hover_content_unset()
10792     * function.
10793     *
10794     * All directions may have contents at the same time, except for
10795     * "smart". This is a special placement hint and its use case
10796     * independs of the calculations coming from
10797     * elm_hover_best_content_location_get(). Its use is for cases when
10798     * one desires only one hover content, but with a dinamic special
10799     * placement within the hover area. The content's geometry, whenever
10800     * it changes, will be used to decide on a best location not
10801     * extrapolating the hover's parent object view to show it in (still
10802     * being the hover's target determinant of its medium part -- move and
10803     * resize it to simulate finger sizes, for example). If one of the
10804     * directions other than "smart" are used, a previously content set
10805     * using it will be deleted, and vice-versa.
10806     */
10807    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10808    /**
10809     * @brief Get the content of the hover object, in a given direction.
10810     *
10811     * Return the content object which was set for this widget in the
10812     * @p swallow direction.
10813     *
10814     * @param obj The hover object
10815     * @param swallow The direction that the object was display at.
10816     * @return The content that was being used
10817     *
10818     * @see elm_hover_content_set()
10819     */
10820    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10821    /**
10822     * @brief Unset the content of the hover object, in a given direction.
10823     *
10824     * Unparent and return the content object set at @p swallow direction.
10825     *
10826     * @param obj The hover object
10827     * @param swallow The direction that the object was display at.
10828     * @return The content that was being used.
10829     *
10830     * @see elm_hover_content_set()
10831     */
10832    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10833    /**
10834     * @brief Returns the best swallow location for content in the hover.
10835     *
10836     * @param obj The hover object
10837     * @param pref_axis The preferred orientation axis for the hover object to use
10838     * @return The edje location to place content into the hover or @c
10839     *         NULL, on errors.
10840     *
10841     * Best is defined here as the location at which there is the most available
10842     * space.
10843     *
10844     * @p pref_axis may be one of
10845     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10846     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10847     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10848     * - @c ELM_HOVER_AXIS_BOTH -- both
10849     *
10850     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10851     * nescessarily be along the horizontal axis("left" or "right"). If
10852     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10853     * be along the vertical axis("top" or "bottom"). Chossing
10854     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10855     * returned position may be in either axis.
10856     *
10857     * @see elm_hover_content_set()
10858     */
10859    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10860    /**
10861     * @}
10862     */
10863
10864    /* entry */
10865    /**
10866     * @defgroup Entry Entry
10867     *
10868     * @image html img/widget/entry/preview-00.png
10869     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10870     * @image html img/widget/entry/preview-01.png
10871     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10872     * @image html img/widget/entry/preview-02.png
10873     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10874     * @image html img/widget/entry/preview-03.png
10875     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10876     *
10877     * An entry is a convenience widget which shows a box that the user can
10878     * enter text into. Entries by default don't scroll, so they grow to
10879     * accomodate the entire text, resizing the parent window as needed. This
10880     * can be changed with the elm_entry_scrollable_set() function.
10881     *
10882     * They can also be single line or multi line (the default) and when set
10883     * to multi line mode they support text wrapping in any of the modes
10884     * indicated by #Elm_Wrap_Type.
10885     *
10886     * Other features include password mode, filtering of inserted text with
10887     * elm_entry_text_filter_append() and related functions, inline "items" and
10888     * formatted markup text.
10889     *
10890     * @section entry-markup Formatted text
10891     *
10892     * The markup tags supported by the Entry are defined by the theme, but
10893     * even when writing new themes or extensions it's a good idea to stick to
10894     * a sane default, to maintain coherency and avoid application breakages.
10895     * Currently defined by the default theme are the following tags:
10896     * @li \<br\>: Inserts a line break.
10897     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10898     * breaks.
10899     * @li \<tab\>: Inserts a tab.
10900     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10901     * enclosed text.
10902     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10903     * @li \<link\>...\</link\>: Underlines the enclosed text.
10904     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10905     *
10906     * @section entry-special Special markups
10907     *
10908     * Besides those used to format text, entries support two special markup
10909     * tags used to insert clickable portions of text or items inlined within
10910     * the text.
10911     *
10912     * @subsection entry-anchors Anchors
10913     *
10914     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10915     * \</a\> tags and an event will be generated when this text is clicked,
10916     * like this:
10917     *
10918     * @code
10919     * This text is outside <a href=anc-01>but this one is an anchor</a>
10920     * @endcode
10921     *
10922     * The @c href attribute in the opening tag gives the name that will be
10923     * used to identify the anchor and it can be any valid utf8 string.
10924     *
10925     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10926     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10927     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10928     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10929     * an anchor.
10930     *
10931     * @subsection entry-items Items
10932     *
10933     * Inlined in the text, any other @c Evas_Object can be inserted by using
10934     * \<item\> tags this way:
10935     *
10936     * @code
10937     * <item size=16x16 vsize=full href=emoticon/haha></item>
10938     * @endcode
10939     *
10940     * Just like with anchors, the @c href identifies each item, but these need,
10941     * in addition, to indicate their size, which is done using any one of
10942     * @c size, @c absize or @c relsize attributes. These attributes take their
10943     * value in the WxH format, where W is the width and H the height of the
10944     * item.
10945     *
10946     * @li absize: Absolute pixel size for the item. Whatever value is set will
10947     * be the item's size regardless of any scale value the object may have
10948     * been set to. The final line height will be adjusted to fit larger items.
10949     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10950     * for the object.
10951     * @li relsize: Size is adjusted for the item to fit within the current
10952     * line height.
10953     *
10954     * Besides their size, items are specificed a @c vsize value that affects
10955     * how their final size and position are calculated. The possible values
10956     * are:
10957     * @li ascent: Item will be placed within the line's baseline and its
10958     * ascent. That is, the height between the line where all characters are
10959     * positioned and the highest point in the line. For @c size and @c absize
10960     * items, the descent value will be added to the total line height to make
10961     * them fit. @c relsize items will be adjusted to fit within this space.
10962     * @li full: Items will be placed between the descent and ascent, or the
10963     * lowest point in the line and its highest.
10964     *
10965     * The next image shows different configurations of items and how they
10966     * are the previously mentioned options affect their sizes. In all cases,
10967     * the green line indicates the ascent, blue for the baseline and red for
10968     * the descent.
10969     *
10970     * @image html entry_item.png
10971     * @image latex entry_item.eps width=\textwidth
10972     *
10973     * And another one to show how size differs from absize. In the first one,
10974     * the scale value is set to 1.0, while the second one is using one of 2.0.
10975     *
10976     * @image html entry_item_scale.png
10977     * @image latex entry_item_scale.eps width=\textwidth
10978     *
10979     * After the size for an item is calculated, the entry will request an
10980     * object to place in its space. For this, the functions set with
10981     * elm_entry_item_provider_append() and related functions will be called
10982     * in order until one of them returns a @c non-NULL value. If no providers
10983     * are available, or all of them return @c NULL, then the entry falls back
10984     * to one of the internal defaults, provided the name matches with one of
10985     * them.
10986     *
10987     * All of the following are currently supported:
10988     *
10989     * - emoticon/angry
10990     * - emoticon/angry-shout
10991     * - emoticon/crazy-laugh
10992     * - emoticon/evil-laugh
10993     * - emoticon/evil
10994     * - emoticon/goggle-smile
10995     * - emoticon/grumpy
10996     * - emoticon/grumpy-smile
10997     * - emoticon/guilty
10998     * - emoticon/guilty-smile
10999     * - emoticon/haha
11000     * - emoticon/half-smile
11001     * - emoticon/happy-panting
11002     * - emoticon/happy
11003     * - emoticon/indifferent
11004     * - emoticon/kiss
11005     * - emoticon/knowing-grin
11006     * - emoticon/laugh
11007     * - emoticon/little-bit-sorry
11008     * - emoticon/love-lots
11009     * - emoticon/love
11010     * - emoticon/minimal-smile
11011     * - emoticon/not-happy
11012     * - emoticon/not-impressed
11013     * - emoticon/omg
11014     * - emoticon/opensmile
11015     * - emoticon/smile
11016     * - emoticon/sorry
11017     * - emoticon/squint-laugh
11018     * - emoticon/surprised
11019     * - emoticon/suspicious
11020     * - emoticon/tongue-dangling
11021     * - emoticon/tongue-poke
11022     * - emoticon/uh
11023     * - emoticon/unhappy
11024     * - emoticon/very-sorry
11025     * - emoticon/what
11026     * - emoticon/wink
11027     * - emoticon/worried
11028     * - emoticon/wtf
11029     *
11030     * Alternatively, an item may reference an image by its path, using
11031     * the URI form @c file:///path/to/an/image.png and the entry will then
11032     * use that image for the item.
11033     *
11034     * @section entry-files Loading and saving files
11035     *
11036     * Entries have convinience functions to load text from a file and save
11037     * changes back to it after a short delay. The automatic saving is enabled
11038     * by default, but can be disabled with elm_entry_autosave_set() and files
11039     * can be loaded directly as plain text or have any markup in them
11040     * recognized. See elm_entry_file_set() for more details.
11041     *
11042     * @section entry-signals Emitted signals
11043     *
11044     * This widget emits the following signals:
11045     *
11046     * @li "changed": The text within the entry was changed.
11047     * @li "changed,user": The text within the entry was changed because of user interaction.
11048     * @li "activated": The enter key was pressed on a single line entry.
11049     * @li "press": A mouse button has been pressed on the entry.
11050     * @li "longpressed": A mouse button has been pressed and held for a couple
11051     * seconds.
11052     * @li "clicked": The entry has been clicked (mouse press and release).
11053     * @li "clicked,double": The entry has been double clicked.
11054     * @li "clicked,triple": The entry has been triple clicked.
11055     * @li "focused": The entry has received focus.
11056     * @li "unfocused": The entry has lost focus.
11057     * @li "selection,paste": A paste of the clipboard contents was requested.
11058     * @li "selection,copy": A copy of the selected text into the clipboard was
11059     * requested.
11060     * @li "selection,cut": A cut of the selected text into the clipboard was
11061     * requested.
11062     * @li "selection,start": A selection has begun and no previous selection
11063     * existed.
11064     * @li "selection,changed": The current selection has changed.
11065     * @li "selection,cleared": The current selection has been cleared.
11066     * @li "cursor,changed": The cursor has changed position.
11067     * @li "anchor,clicked": An anchor has been clicked. The event_info
11068     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11069     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11070     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11071     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11072     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11073     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11074     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11075     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11076     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11077     * @li "preedit,changed": The preedit string has changed.
11078     * @li "language,changed": Program language changed.
11079     *
11080     * @section entry-examples
11081     *
11082     * An overview of the Entry API can be seen in @ref entry_example_01
11083     *
11084     * @{
11085     */
11086    /**
11087     * @typedef Elm_Entry_Anchor_Info
11088     *
11089     * The info sent in the callback for the "anchor,clicked" signals emitted
11090     * by entries.
11091     */
11092    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11093    /**
11094     * @struct _Elm_Entry_Anchor_Info
11095     *
11096     * The info sent in the callback for the "anchor,clicked" signals emitted
11097     * by entries.
11098     */
11099    struct _Elm_Entry_Anchor_Info
11100      {
11101         const char *name; /**< The name of the anchor, as stated in its href */
11102         int         button; /**< The mouse button used to click on it */
11103         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11104                     y, /**< Anchor geometry, relative to canvas */
11105                     w, /**< Anchor geometry, relative to canvas */
11106                     h; /**< Anchor geometry, relative to canvas */
11107      };
11108    /**
11109     * @typedef Elm_Entry_Filter_Cb
11110     * This callback type is used by entry filters to modify text.
11111     * @param data The data specified as the last param when adding the filter
11112     * @param entry The entry object
11113     * @param text A pointer to the location of the text being filtered. This data can be modified,
11114     * but any additional allocations must be managed by the user.
11115     * @see elm_entry_text_filter_append
11116     * @see elm_entry_text_filter_prepend
11117     */
11118    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11119
11120    /**
11121     * This adds an entry to @p parent object.
11122     *
11123     * By default, entries are:
11124     * @li not scrolled
11125     * @li multi-line
11126     * @li word wrapped
11127     * @li autosave is enabled
11128     *
11129     * @param parent The parent object
11130     * @return The new object or NULL if it cannot be created
11131     */
11132    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11133    /**
11134     * Sets the entry to single line mode.
11135     *
11136     * In single line mode, entries don't ever wrap when the text reaches the
11137     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11138     * key will generate an @c "activate" event instead of adding a new line.
11139     *
11140     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11141     * and pressing enter will break the text into a different line
11142     * without generating any events.
11143     *
11144     * @param obj The entry object
11145     * @param single_line If true, the text in the entry
11146     * will be on a single line.
11147     */
11148    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11149    /**
11150     * Gets whether the entry is set to be single line.
11151     *
11152     * @param obj The entry object
11153     * @return single_line If true, the text in the entry is set to display
11154     * on a single line.
11155     *
11156     * @see elm_entry_single_line_set()
11157     */
11158    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11159    /**
11160     * Sets the entry to password mode.
11161     *
11162     * In password mode, entries are implicitly single line and the display of
11163     * any text in them is replaced with asterisks (*).
11164     *
11165     * @param obj The entry object
11166     * @param password If true, password mode is enabled.
11167     */
11168    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11169    /**
11170     * Gets whether the entry is set to password mode.
11171     *
11172     * @param obj The entry object
11173     * @return If true, the entry is set to display all characters
11174     * as asterisks (*).
11175     *
11176     * @see elm_entry_password_set()
11177     */
11178    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11179    /**
11180     * This sets the text displayed within the entry to @p entry.
11181     *
11182     * @param obj The entry object
11183     * @param entry The text to be displayed
11184     *
11185     * @deprecated Use elm_object_text_set() instead.
11186     * @note Using this function bypasses text filters
11187     */
11188    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11189    /**
11190     * This returns the text currently shown in object @p entry.
11191     * See also elm_entry_entry_set().
11192     *
11193     * @param obj The entry object
11194     * @return The currently displayed text or NULL on failure
11195     *
11196     * @deprecated Use elm_object_text_get() instead.
11197     */
11198    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11199    /**
11200     * Appends @p entry to the text of the entry.
11201     *
11202     * Adds the text in @p entry to the end of any text already present in the
11203     * widget.
11204     *
11205     * The appended text is subject to any filters set for the widget.
11206     *
11207     * @param obj The entry object
11208     * @param entry The text to be displayed
11209     *
11210     * @see elm_entry_text_filter_append()
11211     */
11212    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11213    /**
11214     * Gets whether the entry is empty.
11215     *
11216     * Empty means no text at all. If there are any markup tags, like an item
11217     * tag for which no provider finds anything, and no text is displayed, this
11218     * function still returns EINA_FALSE.
11219     *
11220     * @param obj The entry object
11221     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11222     */
11223    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11224    /**
11225     * Gets any selected text within the entry.
11226     *
11227     * If there's any selected text in the entry, this function returns it as
11228     * a string in markup format. NULL is returned if no selection exists or
11229     * if an error occurred.
11230     *
11231     * The returned value points to an internal string and should not be freed
11232     * or modified in any way. If the @p entry object is deleted or its
11233     * contents are changed, the returned pointer should be considered invalid.
11234     *
11235     * @param obj The entry object
11236     * @return The selected text within the entry or NULL on failure
11237     */
11238    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11239    /**
11240     * Inserts the given text into the entry at the current cursor position.
11241     *
11242     * This inserts text at the cursor position as if it was typed
11243     * by the user (note that this also allows markup which a user
11244     * can't just "type" as it would be converted to escaped text, so this
11245     * call can be used to insert things like emoticon items or bold push/pop
11246     * tags, other font and color change tags etc.)
11247     *
11248     * If any selection exists, it will be replaced by the inserted text.
11249     *
11250     * The inserted text is subject to any filters set for the widget.
11251     *
11252     * @param obj The entry object
11253     * @param entry The text to insert
11254     *
11255     * @see elm_entry_text_filter_append()
11256     */
11257    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11258    /**
11259     * Set the line wrap type to use on multi-line entries.
11260     *
11261     * Sets the wrap type used by the entry to any of the specified in
11262     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11263     * line (without inserting a line break or paragraph separator) when it
11264     * reaches the far edge of the widget.
11265     *
11266     * Note that this only makes sense for multi-line entries. A widget set
11267     * to be single line will never wrap.
11268     *
11269     * @param obj The entry object
11270     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11271     */
11272    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11273    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11274    /**
11275     * Gets the wrap mode the entry was set to use.
11276     *
11277     * @param obj The entry object
11278     * @return Wrap type
11279     *
11280     * @see also elm_entry_line_wrap_set()
11281     */
11282    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11283    /**
11284     * Sets if the entry is to be editable or not.
11285     *
11286     * By default, entries are editable and when focused, any text input by the
11287     * user will be inserted at the current cursor position. But calling this
11288     * function with @p editable as EINA_FALSE will prevent the user from
11289     * inputting text into the entry.
11290     *
11291     * The only way to change the text of a non-editable entry is to use
11292     * elm_object_text_set(), elm_entry_entry_insert() and other related
11293     * functions.
11294     *
11295     * @param obj The entry object
11296     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11297     * if not, the entry is read-only and no user input is allowed.
11298     */
11299    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11300    /**
11301     * Gets whether the entry is editable or not.
11302     *
11303     * @param obj The entry object
11304     * @return If true, the entry is editable by the user.
11305     * If false, it is not editable by the user
11306     *
11307     * @see elm_entry_editable_set()
11308     */
11309    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11310    /**
11311     * This drops any existing text selection within the entry.
11312     *
11313     * @param obj The entry object
11314     */
11315    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11316    /**
11317     * This selects all text within the entry.
11318     *
11319     * @param obj The entry object
11320     */
11321    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11322    /**
11323     * This moves the cursor one place to the right within the entry.
11324     *
11325     * @param obj The entry object
11326     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11327     */
11328    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11329    /**
11330     * This moves the cursor one place to the left within the entry.
11331     *
11332     * @param obj The entry object
11333     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11334     */
11335    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11336    /**
11337     * This moves the cursor one line up within the entry.
11338     *
11339     * @param obj The entry object
11340     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11341     */
11342    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11343    /**
11344     * This moves the cursor one line down within the entry.
11345     *
11346     * @param obj The entry object
11347     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11348     */
11349    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11350    /**
11351     * This moves the cursor to the beginning of the entry.
11352     *
11353     * @param obj The entry object
11354     */
11355    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11356    /**
11357     * This moves the cursor to the end of the entry.
11358     *
11359     * @param obj The entry object
11360     */
11361    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11362    /**
11363     * This moves the cursor to the beginning of the current line.
11364     *
11365     * @param obj The entry object
11366     */
11367    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11368    /**
11369     * This moves the cursor to the end of the current line.
11370     *
11371     * @param obj The entry object
11372     */
11373    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11374    /**
11375     * This begins a selection within the entry as though
11376     * the user were holding down the mouse button to make a selection.
11377     *
11378     * @param obj The entry object
11379     */
11380    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11381    /**
11382     * This ends a selection within the entry as though
11383     * the user had just released the mouse button while making a selection.
11384     *
11385     * @param obj The entry object
11386     */
11387    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11388    /**
11389     * Gets whether a format node exists at the current cursor position.
11390     *
11391     * A format node is anything that defines how the text is rendered. It can
11392     * be a visible format node, such as a line break or a paragraph separator,
11393     * or an invisible one, such as bold begin or end tag.
11394     * This function returns whether any format node exists at the current
11395     * cursor position.
11396     *
11397     * @param obj The entry object
11398     * @return EINA_TRUE if the current cursor position contains a format node,
11399     * EINA_FALSE otherwise.
11400     *
11401     * @see elm_entry_cursor_is_visible_format_get()
11402     */
11403    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11404    /**
11405     * Gets if the current cursor position holds a visible format node.
11406     *
11407     * @param obj The entry object
11408     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11409     * if it's an invisible one or no format exists.
11410     *
11411     * @see elm_entry_cursor_is_format_get()
11412     */
11413    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11414    /**
11415     * Gets the character pointed by the cursor at its current position.
11416     *
11417     * This function returns a string with the utf8 character stored at the
11418     * current cursor position.
11419     * Only the text is returned, any format that may exist will not be part
11420     * of the return value.
11421     *
11422     * @param obj The entry object
11423     * @return The text pointed by the cursors.
11424     */
11425    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11426    /**
11427     * This function returns the geometry of the cursor.
11428     *
11429     * It's useful if you want to draw something on the cursor (or where it is),
11430     * or for example in the case of scrolled entry where you want to show the
11431     * cursor.
11432     *
11433     * @param obj The entry object
11434     * @param x returned geometry
11435     * @param y returned geometry
11436     * @param w returned geometry
11437     * @param h returned geometry
11438     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11439     */
11440    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);
11441    /**
11442     * Sets the cursor position in the entry to the given value
11443     *
11444     * The value in @p pos is the index of the character position within the
11445     * contents of the string as returned by elm_entry_cursor_pos_get().
11446     *
11447     * @param obj The entry object
11448     * @param pos The position of the cursor
11449     */
11450    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11451    /**
11452     * Retrieves the current position of the cursor in the entry
11453     *
11454     * @param obj The entry object
11455     * @return The cursor position
11456     */
11457    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11458    /**
11459     * This executes a "cut" action on the selected text in the entry.
11460     *
11461     * @param obj The entry object
11462     */
11463    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11464    /**
11465     * This executes a "copy" action on the selected text in the entry.
11466     *
11467     * @param obj The entry object
11468     */
11469    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11470    /**
11471     * This executes a "paste" action in the entry.
11472     *
11473     * @param obj The entry object
11474     */
11475    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11476    /**
11477     * This clears and frees the items in a entry's contextual (longpress)
11478     * menu.
11479     *
11480     * @param obj The entry object
11481     *
11482     * @see elm_entry_context_menu_item_add()
11483     */
11484    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11485    /**
11486     * This adds an item to the entry's contextual menu.
11487     *
11488     * A longpress on an entry will make the contextual menu show up, if this
11489     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11490     * By default, this menu provides a few options like enabling selection mode,
11491     * which is useful on embedded devices that need to be explicit about it,
11492     * and when a selection exists it also shows the copy and cut actions.
11493     *
11494     * With this function, developers can add other options to this menu to
11495     * perform any action they deem necessary.
11496     *
11497     * @param obj The entry object
11498     * @param label The item's text label
11499     * @param icon_file The item's icon file
11500     * @param icon_type The item's icon type
11501     * @param func The callback to execute when the item is clicked
11502     * @param data The data to associate with the item for related functions
11503     */
11504    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);
11505    /**
11506     * This disables the entry's contextual (longpress) menu.
11507     *
11508     * @param obj The entry object
11509     * @param disabled If true, the menu is disabled
11510     */
11511    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11512    /**
11513     * This returns whether the entry's contextual (longpress) menu is
11514     * disabled.
11515     *
11516     * @param obj The entry object
11517     * @return If true, the menu is disabled
11518     */
11519    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11520    /**
11521     * This appends a custom item provider to the list for that entry
11522     *
11523     * This appends the given callback. The list is walked from beginning to end
11524     * with each function called given the item href string in the text. If the
11525     * function returns an object handle other than NULL (it should create an
11526     * object to do this), then this object is used to replace that item. If
11527     * not the next provider is called until one provides an item object, or the
11528     * default provider in entry does.
11529     *
11530     * @param obj The entry object
11531     * @param func The function called to provide the item object
11532     * @param data The data passed to @p func
11533     *
11534     * @see @ref entry-items
11535     */
11536    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);
11537    /**
11538     * This prepends a custom item provider to the list for that entry
11539     *
11540     * This prepends the given callback. See elm_entry_item_provider_append() for
11541     * more information
11542     *
11543     * @param obj The entry object
11544     * @param func The function called to provide the item object
11545     * @param data The data passed to @p func
11546     */
11547    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);
11548    /**
11549     * This removes a custom item provider to the list for that entry
11550     *
11551     * This removes the given callback. See elm_entry_item_provider_append() for
11552     * more information
11553     *
11554     * @param obj The entry object
11555     * @param func The function called to provide the item object
11556     * @param data The data passed to @p func
11557     */
11558    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);
11559    /**
11560     * Append a filter function for text inserted in the entry
11561     *
11562     * Append the given callback to the list. This functions will be called
11563     * whenever any text is inserted into the entry, with the text to be inserted
11564     * as a parameter. The callback function is free to alter the text in any way
11565     * it wants, but it must remember to free the given pointer and update it.
11566     * If the new text is to be discarded, the function can free it and set its
11567     * text parameter to NULL. This will also prevent any following filters from
11568     * being called.
11569     *
11570     * @param obj The entry object
11571     * @param func The function to use as text filter
11572     * @param data User data to pass to @p func
11573     */
11574    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11575    /**
11576     * Prepend a filter function for text insdrted in the entry
11577     *
11578     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11579     * for more information
11580     *
11581     * @param obj The entry object
11582     * @param func The function to use as text filter
11583     * @param data User data to pass to @p func
11584     */
11585    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11586    /**
11587     * Remove a filter from the list
11588     *
11589     * Removes the given callback from the filter list. See
11590     * elm_entry_text_filter_append() for more information.
11591     *
11592     * @param obj The entry object
11593     * @param func The filter function to remove
11594     * @param data The user data passed when adding the function
11595     */
11596    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11597    /**
11598     * This converts a markup (HTML-like) string into UTF-8.
11599     *
11600     * The returned string is a malloc'ed buffer and it should be freed when
11601     * not needed anymore.
11602     *
11603     * @param s The string (in markup) to be converted
11604     * @return The converted string (in UTF-8). It should be freed.
11605     */
11606    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11607    /**
11608     * This converts a UTF-8 string into markup (HTML-like).
11609     *
11610     * The returned string is a malloc'ed buffer and it should be freed when
11611     * not needed anymore.
11612     *
11613     * @param s The string (in UTF-8) to be converted
11614     * @return The converted string (in markup). It should be freed.
11615     */
11616    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11617    /**
11618     * This sets the file (and implicitly loads it) for the text to display and
11619     * then edit. All changes are written back to the file after a short delay if
11620     * the entry object is set to autosave (which is the default).
11621     *
11622     * If the entry had any other file set previously, any changes made to it
11623     * will be saved if the autosave feature is enabled, otherwise, the file
11624     * will be silently discarded and any non-saved changes will be lost.
11625     *
11626     * @param obj The entry object
11627     * @param file The path to the file to load and save
11628     * @param format The file format
11629     */
11630    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11631    /**
11632     * Gets the file being edited by the entry.
11633     *
11634     * This function can be used to retrieve any file set on the entry for
11635     * edition, along with the format used to load and save it.
11636     *
11637     * @param obj The entry object
11638     * @param file The path to the file to load and save
11639     * @param format The file format
11640     */
11641    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11642    /**
11643     * This function writes any changes made to the file set with
11644     * elm_entry_file_set()
11645     *
11646     * @param obj The entry object
11647     */
11648    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11649    /**
11650     * This sets the entry object to 'autosave' the loaded text file or not.
11651     *
11652     * @param obj The entry object
11653     * @param autosave Autosave the loaded file or not
11654     *
11655     * @see elm_entry_file_set()
11656     */
11657    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11658    /**
11659     * This gets the entry object's 'autosave' status.
11660     *
11661     * @param obj The entry object
11662     * @return Autosave the loaded file or not
11663     *
11664     * @see elm_entry_file_set()
11665     */
11666    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11667    /**
11668     * Control pasting of text and images for the widget.
11669     *
11670     * Normally the entry allows both text and images to be pasted.  By setting
11671     * textonly to be true, this prevents images from being pasted.
11672     *
11673     * Note this only changes the behaviour of text.
11674     *
11675     * @param obj The entry object
11676     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11677     * text+image+other.
11678     */
11679    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11680    /**
11681     * Getting elm_entry text paste/drop mode.
11682     *
11683     * In textonly mode, only text may be pasted or dropped into the widget.
11684     *
11685     * @param obj The entry object
11686     * @return If the widget only accepts text from pastes.
11687     */
11688    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11689    /**
11690     * Enable or disable scrolling in entry
11691     *
11692     * Normally the entry is not scrollable unless you enable it with this call.
11693     *
11694     * @param obj The entry object
11695     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11696     */
11697    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11698    /**
11699     * Get the scrollable state of the entry
11700     *
11701     * Normally the entry is not scrollable. This gets the scrollable state
11702     * of the entry. See elm_entry_scrollable_set() for more information.
11703     *
11704     * @param obj The entry object
11705     * @return The scrollable state
11706     */
11707    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11708    /**
11709     * This sets a widget to be displayed to the left of a scrolled entry.
11710     *
11711     * @param obj The scrolled entry object
11712     * @param icon The widget to display on the left side of the scrolled
11713     * entry.
11714     *
11715     * @note A previously set widget will be destroyed.
11716     * @note If the object being set does not have minimum size hints set,
11717     * it won't get properly displayed.
11718     *
11719     * @see elm_entry_end_set()
11720     */
11721    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11722    /**
11723     * Gets the leftmost widget of the scrolled entry. This object is
11724     * owned by the scrolled entry and should not be modified.
11725     *
11726     * @param obj The scrolled entry object
11727     * @return the left widget inside the scroller
11728     */
11729    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11730    /**
11731     * Unset the leftmost widget of the scrolled entry, unparenting and
11732     * returning it.
11733     *
11734     * @param obj The scrolled entry object
11735     * @return the previously set icon sub-object of this entry, on
11736     * success.
11737     *
11738     * @see elm_entry_icon_set()
11739     */
11740    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11741    /**
11742     * Sets the visibility of the left-side widget of the scrolled entry,
11743     * set by elm_entry_icon_set().
11744     *
11745     * @param obj The scrolled entry object
11746     * @param setting EINA_TRUE if the object should be displayed,
11747     * EINA_FALSE if not.
11748     */
11749    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11750    /**
11751     * This sets a widget to be displayed to the end of a scrolled entry.
11752     *
11753     * @param obj The scrolled entry object
11754     * @param end The widget to display on the right side of the scrolled
11755     * entry.
11756     *
11757     * @note A previously set widget will be destroyed.
11758     * @note If the object being set does not have minimum size hints set,
11759     * it won't get properly displayed.
11760     *
11761     * @see elm_entry_icon_set
11762     */
11763    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11764    /**
11765     * Gets the endmost widget of the scrolled entry. This object is owned
11766     * by the scrolled entry and should not be modified.
11767     *
11768     * @param obj The scrolled entry object
11769     * @return the right widget inside the scroller
11770     */
11771    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11772    /**
11773     * Unset the endmost widget of the scrolled entry, unparenting and
11774     * returning it.
11775     *
11776     * @param obj The scrolled entry object
11777     * @return the previously set icon sub-object of this entry, on
11778     * success.
11779     *
11780     * @see elm_entry_icon_set()
11781     */
11782    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11783    /**
11784     * Sets the visibility of the end widget of the scrolled entry, set by
11785     * elm_entry_end_set().
11786     *
11787     * @param obj The scrolled entry object
11788     * @param setting EINA_TRUE if the object should be displayed,
11789     * EINA_FALSE if not.
11790     */
11791    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11792    /**
11793     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11794     * them).
11795     *
11796     * Setting an entry to single-line mode with elm_entry_single_line_set()
11797     * will automatically disable the display of scrollbars when the entry
11798     * moves inside its scroller.
11799     *
11800     * @param obj The scrolled entry object
11801     * @param h The horizontal scrollbar policy to apply
11802     * @param v The vertical scrollbar policy to apply
11803     */
11804    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11805    /**
11806     * This enables/disables bouncing within the entry.
11807     *
11808     * This function sets whether the entry will bounce when scrolling reaches
11809     * the end of the contained entry.
11810     *
11811     * @param obj The scrolled entry object
11812     * @param h The horizontal bounce state
11813     * @param v The vertical bounce state
11814     */
11815    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11816    /**
11817     * Get the bounce mode
11818     *
11819     * @param obj The Entry object
11820     * @param h_bounce Allow bounce horizontally
11821     * @param v_bounce Allow bounce vertically
11822     */
11823    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11824
11825    /* pre-made filters for entries */
11826    /**
11827     * @typedef Elm_Entry_Filter_Limit_Size
11828     *
11829     * Data for the elm_entry_filter_limit_size() entry filter.
11830     */
11831    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11832    /**
11833     * @struct _Elm_Entry_Filter_Limit_Size
11834     *
11835     * Data for the elm_entry_filter_limit_size() entry filter.
11836     */
11837    struct _Elm_Entry_Filter_Limit_Size
11838      {
11839         int max_char_count; /**< The maximum number of characters allowed. */
11840         int max_byte_count; /**< The maximum number of bytes allowed*/
11841      };
11842    /**
11843     * Filter inserted text based on user defined character and byte limits
11844     *
11845     * Add this filter to an entry to limit the characters that it will accept
11846     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11847     * The funtion works on the UTF-8 representation of the string, converting
11848     * it from the set markup, thus not accounting for any format in it.
11849     *
11850     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11851     * it as data when setting the filter. In it, it's possible to set limits
11852     * by character count or bytes (any of them is disabled if 0), and both can
11853     * be set at the same time. In that case, it first checks for characters,
11854     * then bytes.
11855     *
11856     * The function will cut the inserted text in order to allow only the first
11857     * number of characters that are still allowed. The cut is made in
11858     * characters, even when limiting by bytes, in order to always contain
11859     * valid ones and avoid half unicode characters making it in.
11860     *
11861     * This filter, like any others, does not apply when setting the entry text
11862     * directly with elm_object_text_set() (or the deprecated
11863     * elm_entry_entry_set()).
11864     */
11865    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11866    /**
11867     * @typedef Elm_Entry_Filter_Accept_Set
11868     *
11869     * Data for the elm_entry_filter_accept_set() entry filter.
11870     */
11871    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11872    /**
11873     * @struct _Elm_Entry_Filter_Accept_Set
11874     *
11875     * Data for the elm_entry_filter_accept_set() entry filter.
11876     */
11877    struct _Elm_Entry_Filter_Accept_Set
11878      {
11879         const char *accepted; /**< Set of characters accepted in the entry. */
11880         const char *rejected; /**< Set of characters rejected from the entry. */
11881      };
11882    /**
11883     * Filter inserted text based on accepted or rejected sets of characters
11884     *
11885     * Add this filter to an entry to restrict the set of accepted characters
11886     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11887     * This structure contains both accepted and rejected sets, but they are
11888     * mutually exclusive.
11889     *
11890     * The @c accepted set takes preference, so if it is set, the filter will
11891     * only work based on the accepted characters, ignoring anything in the
11892     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11893     *
11894     * In both cases, the function filters by matching utf8 characters to the
11895     * raw markup text, so it can be used to remove formatting tags.
11896     *
11897     * This filter, like any others, does not apply when setting the entry text
11898     * directly with elm_object_text_set() (or the deprecated
11899     * elm_entry_entry_set()).
11900     */
11901    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11902    /**
11903     * Set the input panel layout of the entry
11904     *
11905     * @param obj The entry object
11906     * @param layout layout type
11907     */
11908    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11909    /**
11910     * Get the input panel layout of the entry
11911     *
11912     * @param obj The entry object
11913     * @return layout type
11914     *
11915     * @see elm_entry_input_panel_layout_set
11916     */
11917    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11918    /**
11919     * Set the autocapitalization type on the immodule.
11920     *
11921     * @param obj The entry object
11922     * @param autocapital_type The type of autocapitalization
11923     */
11924    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11925    /**
11926     * Retrieve the autocapitalization type on the immodule.
11927     *
11928     * @param obj The entry object
11929     * @return autocapitalization type
11930     */
11931    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11932    /**
11933     * Sets the attribute to show the input panel automatically.
11934     *
11935     * @param obj The entry object
11936     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11937     */
11938    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11939    /**
11940     * Retrieve the attribute to show the input panel automatically.
11941     *
11942     * @param obj The entry object
11943     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11944     */
11945    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11946
11947    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11948    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11949    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11950    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11951    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11952    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11953    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11954
11955    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11956    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
11957    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11958    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11959    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11960
11961    /**
11962     * @}
11963     */
11964
11965    /* composite widgets - these basically put together basic widgets above
11966     * in convenient packages that do more than basic stuff */
11967
11968    /* anchorview */
11969    /**
11970     * @defgroup Anchorview Anchorview
11971     *
11972     * @image html img/widget/anchorview/preview-00.png
11973     * @image latex img/widget/anchorview/preview-00.eps
11974     *
11975     * Anchorview is for displaying text that contains markup with anchors
11976     * like <c>\<a href=1234\>something\</\></c> in it.
11977     *
11978     * Besides being styled differently, the anchorview widget provides the
11979     * necessary functionality so that clicking on these anchors brings up a
11980     * popup with user defined content such as "call", "add to contacts" or
11981     * "open web page". This popup is provided using the @ref Hover widget.
11982     *
11983     * This widget is very similar to @ref Anchorblock, so refer to that
11984     * widget for an example. The only difference Anchorview has is that the
11985     * widget is already provided with scrolling functionality, so if the
11986     * text set to it is too large to fit in the given space, it will scroll,
11987     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11988     * text can be displayed.
11989     *
11990     * This widget emits the following signals:
11991     * @li "anchor,clicked": will be called when an anchor is clicked. The
11992     * @p event_info parameter on the callback will be a pointer of type
11993     * ::Elm_Entry_Anchorview_Info.
11994     *
11995     * See @ref Anchorblock for an example on how to use both of them.
11996     *
11997     * @see Anchorblock
11998     * @see Entry
11999     * @see Hover
12000     *
12001     * @{
12002     */
12003    /**
12004     * @typedef Elm_Entry_Anchorview_Info
12005     *
12006     * The info sent in the callback for "anchor,clicked" signals emitted by
12007     * the Anchorview widget.
12008     */
12009    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12010    /**
12011     * @struct _Elm_Entry_Anchorview_Info
12012     *
12013     * The info sent in the callback for "anchor,clicked" signals emitted by
12014     * the Anchorview widget.
12015     */
12016    struct _Elm_Entry_Anchorview_Info
12017      {
12018         const char     *name; /**< Name of the anchor, as indicated in its href
12019                                    attribute */
12020         int             button; /**< The mouse button used to click on it */
12021         Evas_Object    *hover; /**< The hover object to use for the popup */
12022         struct {
12023              Evas_Coord    x, y, w, h;
12024         } anchor, /**< Geometry selection of text used as anchor */
12025           hover_parent; /**< Geometry of the object used as parent by the
12026                              hover */
12027         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12028                                              for content on the left side of
12029                                              the hover. Before calling the
12030                                              callback, the widget will make the
12031                                              necessary calculations to check
12032                                              which sides are fit to be set with
12033                                              content, based on the position the
12034                                              hover is activated and its distance
12035                                              to the edges of its parent object
12036                                              */
12037         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12038                                               the right side of the hover.
12039                                               See @ref hover_left */
12040         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12041                                             of the hover. See @ref hover_left */
12042         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12043                                                below the hover. See @ref
12044                                                hover_left */
12045      };
12046    /**
12047     * Add a new Anchorview object
12048     *
12049     * @param parent The parent object
12050     * @return The new object or NULL if it cannot be created
12051     */
12052    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12053    /**
12054     * Set the text to show in the anchorview
12055     *
12056     * Sets the text of the anchorview to @p text. This text can include markup
12057     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12058     * text that will be specially styled and react to click events, ended with
12059     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12060     * "anchor,clicked" signal that you can attach a callback to with
12061     * evas_object_smart_callback_add(). The name of the anchor given in the
12062     * event info struct will be the one set in the href attribute, in this
12063     * case, anchorname.
12064     *
12065     * Other markup can be used to style the text in different ways, but it's
12066     * up to the style defined in the theme which tags do what.
12067     * @deprecated use elm_object_text_set() instead.
12068     */
12069    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12070    /**
12071     * Get the markup text set for the anchorview
12072     *
12073     * Retrieves the text set on the anchorview, with markup tags included.
12074     *
12075     * @param obj The anchorview object
12076     * @return The markup text set or @c NULL if nothing was set or an error
12077     * occurred
12078     * @deprecated use elm_object_text_set() instead.
12079     */
12080    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12081    /**
12082     * Set the parent of the hover popup
12083     *
12084     * Sets the parent object to use by the hover created by the anchorview
12085     * when an anchor is clicked. See @ref Hover for more details on this.
12086     * If no parent is set, the same anchorview object will be used.
12087     *
12088     * @param obj The anchorview object
12089     * @param parent The object to use as parent for the hover
12090     */
12091    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12092    /**
12093     * Get the parent of the hover popup
12094     *
12095     * Get the object used as parent for the hover created by the anchorview
12096     * widget. See @ref Hover for more details on this.
12097     *
12098     * @param obj The anchorview object
12099     * @return The object used as parent for the hover, NULL if none is set.
12100     */
12101    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12102    /**
12103     * Set the style that the hover should use
12104     *
12105     * When creating the popup hover, anchorview will request that it's
12106     * themed according to @p style.
12107     *
12108     * @param obj The anchorview object
12109     * @param style The style to use for the underlying hover
12110     *
12111     * @see elm_object_style_set()
12112     */
12113    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12114    /**
12115     * Get the style that the hover should use
12116     *
12117     * Get the style the hover created by anchorview will use.
12118     *
12119     * @param obj The anchorview object
12120     * @return The style to use by the hover. NULL means the default is used.
12121     *
12122     * @see elm_object_style_set()
12123     */
12124    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12125    /**
12126     * Ends the hover popup in the anchorview
12127     *
12128     * When an anchor is clicked, the anchorview widget will create a hover
12129     * object to use as a popup with user provided content. This function
12130     * terminates this popup, returning the anchorview to its normal state.
12131     *
12132     * @param obj The anchorview object
12133     */
12134    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12135    /**
12136     * Set bouncing behaviour when the scrolled content reaches an edge
12137     *
12138     * Tell the internal scroller object whether it should bounce or not
12139     * when it reaches the respective edges for each axis.
12140     *
12141     * @param obj The anchorview object
12142     * @param h_bounce Whether to bounce or not in the horizontal axis
12143     * @param v_bounce Whether to bounce or not in the vertical axis
12144     *
12145     * @see elm_scroller_bounce_set()
12146     */
12147    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12148    /**
12149     * Get the set bouncing behaviour of the internal scroller
12150     *
12151     * Get whether the internal scroller should bounce when the edge of each
12152     * axis is reached scrolling.
12153     *
12154     * @param obj The anchorview object
12155     * @param h_bounce Pointer where to store the bounce state of the horizontal
12156     *                 axis
12157     * @param v_bounce Pointer where to store the bounce state of the vertical
12158     *                 axis
12159     *
12160     * @see elm_scroller_bounce_get()
12161     */
12162    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12163    /**
12164     * Appends a custom item provider to the given anchorview
12165     *
12166     * Appends the given function to the list of items providers. This list is
12167     * called, one function at a time, with the given @p data pointer, the
12168     * anchorview object and, in the @p item parameter, the item name as
12169     * referenced in its href string. Following functions in the list will be
12170     * called in order until one of them returns something different to NULL,
12171     * which should be an Evas_Object which will be used in place of the item
12172     * element.
12173     *
12174     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12175     * href=item/name\>\</item\>
12176     *
12177     * @param obj The anchorview object
12178     * @param func The function to add to the list of providers
12179     * @param data User data that will be passed to the callback function
12180     *
12181     * @see elm_entry_item_provider_append()
12182     */
12183    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);
12184    /**
12185     * Prepend a custom item provider to the given anchorview
12186     *
12187     * Like elm_anchorview_item_provider_append(), but it adds the function
12188     * @p func to the beginning of the list, instead of the end.
12189     *
12190     * @param obj The anchorview object
12191     * @param func The function to add to the list of providers
12192     * @param data User data that will be passed to the callback function
12193     */
12194    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);
12195    /**
12196     * Remove a custom item provider from the list of the given anchorview
12197     *
12198     * Removes the function and data pairing that matches @p func and @p data.
12199     * That is, unless the same function and same user data are given, the
12200     * function will not be removed from the list. This allows us to add the
12201     * same callback several times, with different @p data pointers and be
12202     * able to remove them later without conflicts.
12203     *
12204     * @param obj The anchorview object
12205     * @param func The function to remove from the list
12206     * @param data The data matching the function to remove from the list
12207     */
12208    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);
12209    /**
12210     * @}
12211     */
12212
12213    /* anchorblock */
12214    /**
12215     * @defgroup Anchorblock Anchorblock
12216     *
12217     * @image html img/widget/anchorblock/preview-00.png
12218     * @image latex img/widget/anchorblock/preview-00.eps
12219     *
12220     * Anchorblock is for displaying text that contains markup with anchors
12221     * like <c>\<a href=1234\>something\</\></c> in it.
12222     *
12223     * Besides being styled differently, the anchorblock widget provides the
12224     * necessary functionality so that clicking on these anchors brings up a
12225     * popup with user defined content such as "call", "add to contacts" or
12226     * "open web page". This popup is provided using the @ref Hover widget.
12227     *
12228     * This widget emits the following signals:
12229     * @li "anchor,clicked": will be called when an anchor is clicked. The
12230     * @p event_info parameter on the callback will be a pointer of type
12231     * ::Elm_Entry_Anchorblock_Info.
12232     *
12233     * @see Anchorview
12234     * @see Entry
12235     * @see Hover
12236     *
12237     * Since examples are usually better than plain words, we might as well
12238     * try @ref tutorial_anchorblock_example "one".
12239     */
12240    /**
12241     * @addtogroup Anchorblock
12242     * @{
12243     */
12244    /**
12245     * @typedef Elm_Entry_Anchorblock_Info
12246     *
12247     * The info sent in the callback for "anchor,clicked" signals emitted by
12248     * the Anchorblock widget.
12249     */
12250    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12251    /**
12252     * @struct _Elm_Entry_Anchorblock_Info
12253     *
12254     * The info sent in the callback for "anchor,clicked" signals emitted by
12255     * the Anchorblock widget.
12256     */
12257    struct _Elm_Entry_Anchorblock_Info
12258      {
12259         const char     *name; /**< Name of the anchor, as indicated in its href
12260                                    attribute */
12261         int             button; /**< The mouse button used to click on it */
12262         Evas_Object    *hover; /**< The hover object to use for the popup */
12263         struct {
12264              Evas_Coord    x, y, w, h;
12265         } anchor, /**< Geometry selection of text used as anchor */
12266           hover_parent; /**< Geometry of the object used as parent by the
12267                              hover */
12268         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12269                                              for content on the left side of
12270                                              the hover. Before calling the
12271                                              callback, the widget will make the
12272                                              necessary calculations to check
12273                                              which sides are fit to be set with
12274                                              content, based on the position the
12275                                              hover is activated and its distance
12276                                              to the edges of its parent object
12277                                              */
12278         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12279                                               the right side of the hover.
12280                                               See @ref hover_left */
12281         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12282                                             of the hover. See @ref hover_left */
12283         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12284                                                below the hover. See @ref
12285                                                hover_left */
12286      };
12287    /**
12288     * Add a new Anchorblock object
12289     *
12290     * @param parent The parent object
12291     * @return The new object or NULL if it cannot be created
12292     */
12293    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12294    /**
12295     * Set the text to show in the anchorblock
12296     *
12297     * Sets the text of the anchorblock to @p text. This text can include markup
12298     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12299     * of text that will be specially styled and react to click events, ended
12300     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12301     * "anchor,clicked" signal that you can attach a callback to with
12302     * evas_object_smart_callback_add(). The name of the anchor given in the
12303     * event info struct will be the one set in the href attribute, in this
12304     * case, anchorname.
12305     *
12306     * Other markup can be used to style the text in different ways, but it's
12307     * up to the style defined in the theme which tags do what.
12308     * @deprecated use elm_object_text_set() instead.
12309     */
12310    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12311    /**
12312     * Get the markup text set for the anchorblock
12313     *
12314     * Retrieves the text set on the anchorblock, with markup tags included.
12315     *
12316     * @param obj The anchorblock object
12317     * @return The markup text set or @c NULL if nothing was set or an error
12318     * occurred
12319     * @deprecated use elm_object_text_set() instead.
12320     */
12321    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12322    /**
12323     * Set the parent of the hover popup
12324     *
12325     * Sets the parent object to use by the hover created by the anchorblock
12326     * when an anchor is clicked. See @ref Hover for more details on this.
12327     *
12328     * @param obj The anchorblock object
12329     * @param parent The object to use as parent for the hover
12330     */
12331    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12332    /**
12333     * Get the parent of the hover popup
12334     *
12335     * Get the object used as parent for the hover created by the anchorblock
12336     * widget. See @ref Hover for more details on this.
12337     * If no parent is set, the same anchorblock object will be used.
12338     *
12339     * @param obj The anchorblock object
12340     * @return The object used as parent for the hover, NULL if none is set.
12341     */
12342    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12343    /**
12344     * Set the style that the hover should use
12345     *
12346     * When creating the popup hover, anchorblock will request that it's
12347     * themed according to @p style.
12348     *
12349     * @param obj The anchorblock object
12350     * @param style The style to use for the underlying hover
12351     *
12352     * @see elm_object_style_set()
12353     */
12354    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12355    /**
12356     * Get the style that the hover should use
12357     *
12358     * Get the style, the hover created by anchorblock will use.
12359     *
12360     * @param obj The anchorblock object
12361     * @return The style to use by the hover. NULL means the default is used.
12362     *
12363     * @see elm_object_style_set()
12364     */
12365    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12366    /**
12367     * Ends the hover popup in the anchorblock
12368     *
12369     * When an anchor is clicked, the anchorblock widget will create a hover
12370     * object to use as a popup with user provided content. This function
12371     * terminates this popup, returning the anchorblock to its normal state.
12372     *
12373     * @param obj The anchorblock object
12374     */
12375    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12376    /**
12377     * Appends a custom item provider to the given anchorblock
12378     *
12379     * Appends the given function to the list of items providers. This list is
12380     * called, one function at a time, with the given @p data pointer, the
12381     * anchorblock object and, in the @p item parameter, the item name as
12382     * referenced in its href string. Following functions in the list will be
12383     * called in order until one of them returns something different to NULL,
12384     * which should be an Evas_Object which will be used in place of the item
12385     * element.
12386     *
12387     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12388     * href=item/name\>\</item\>
12389     *
12390     * @param obj The anchorblock object
12391     * @param func The function to add to the list of providers
12392     * @param data User data that will be passed to the callback function
12393     *
12394     * @see elm_entry_item_provider_append()
12395     */
12396    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);
12397    /**
12398     * Prepend a custom item provider to the given anchorblock
12399     *
12400     * Like elm_anchorblock_item_provider_append(), but it adds the function
12401     * @p func to the beginning of the list, instead of the end.
12402     *
12403     * @param obj The anchorblock object
12404     * @param func The function to add to the list of providers
12405     * @param data User data that will be passed to the callback function
12406     */
12407    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);
12408    /**
12409     * Remove a custom item provider from the list of the given anchorblock
12410     *
12411     * Removes the function and data pairing that matches @p func and @p data.
12412     * That is, unless the same function and same user data are given, the
12413     * function will not be removed from the list. This allows us to add the
12414     * same callback several times, with different @p data pointers and be
12415     * able to remove them later without conflicts.
12416     *
12417     * @param obj The anchorblock object
12418     * @param func The function to remove from the list
12419     * @param data The data matching the function to remove from the list
12420     */
12421    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);
12422    /**
12423     * @}
12424     */
12425
12426    /**
12427     * @defgroup Bubble Bubble
12428     *
12429     * @image html img/widget/bubble/preview-00.png
12430     * @image latex img/widget/bubble/preview-00.eps
12431     * @image html img/widget/bubble/preview-01.png
12432     * @image latex img/widget/bubble/preview-01.eps
12433     * @image html img/widget/bubble/preview-02.png
12434     * @image latex img/widget/bubble/preview-02.eps
12435     *
12436     * @brief The Bubble is a widget to show text similar to how speech is
12437     * represented in comics.
12438     *
12439     * The bubble widget contains 5 important visual elements:
12440     * @li The frame is a rectangle with rounded edjes and an "arrow".
12441     * @li The @p icon is an image to which the frame's arrow points to.
12442     * @li The @p label is a text which appears to the right of the icon if the
12443     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12444     * otherwise.
12445     * @li The @p info is a text which appears to the right of the label. Info's
12446     * font is of a ligther color than label.
12447     * @li The @p content is an evas object that is shown inside the frame.
12448     *
12449     * The position of the arrow, icon, label and info depends on which corner is
12450     * selected. The four available corners are:
12451     * @li "top_left" - Default
12452     * @li "top_right"
12453     * @li "bottom_left"
12454     * @li "bottom_right"
12455     *
12456     * Signals that you can add callbacks for are:
12457     * @li "clicked" - This is called when a user has clicked the bubble.
12458     *
12459     * Default contents parts of the bubble that you can use for are:
12460     * @li "default" - A content of the bubble
12461     * @li "icon" - An icon of the bubble
12462     *
12463     * Default text parts of the button widget that you can use for are:
12464     * @li NULL - Label of the bubble
12465     * 
12466          * For an example of using a buble see @ref bubble_01_example_page "this".
12467     *
12468     * @{
12469     */
12470
12471    /**
12472     * Add a new bubble to the parent
12473     *
12474     * @param parent The parent object
12475     * @return The new object or NULL if it cannot be created
12476     *
12477     * This function adds a text bubble to the given parent evas object.
12478     */
12479    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12480    /**
12481     * Set the label of the bubble
12482     *
12483     * @param obj The bubble object
12484     * @param label The string to set in the label
12485     *
12486     * This function sets the title of the bubble. Where this appears depends on
12487     * the selected corner.
12488     * @deprecated use elm_object_text_set() instead.
12489     */
12490    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12491    /**
12492     * Get the label of the bubble
12493     *
12494     * @param obj The bubble object
12495     * @return The string of set in the label
12496     *
12497     * This function gets the title of the bubble.
12498     * @deprecated use elm_object_text_get() instead.
12499     */
12500    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12501    /**
12502     * Set the info of the bubble
12503     *
12504     * @param obj The bubble object
12505     * @param info The given info about the bubble
12506     *
12507     * This function sets the info of the bubble. Where this appears depends on
12508     * the selected corner.
12509     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12510     */
12511    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12512    /**
12513     * Get the info of the bubble
12514     *
12515     * @param obj The bubble object
12516     *
12517     * @return The "info" string of the bubble
12518     *
12519     * This function gets the info text.
12520     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12521     */
12522    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12523    /**
12524     * Set the content to be shown in the bubble
12525     *
12526     * Once the content object is set, a previously set one will be deleted.
12527     * If you want to keep the old content object, use the
12528     * elm_bubble_content_unset() function.
12529     *
12530     * @param obj The bubble object
12531     * @param content The given content of the bubble
12532     *
12533     * This function sets the content shown on the middle of the bubble.
12534     * 
12535     * @deprecated use elm_object_content_set() instead
12536     *
12537     */
12538    WILL_DEPRECATE  EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12539    /**
12540     * Get the content shown in the bubble
12541     *
12542     * Return the content object which is set for this widget.
12543     *
12544     * @param obj The bubble object
12545     * @return The content that is being used
12546     *
12547     * @deprecated use elm_object_content_get() instead
12548     *
12549     */
12550    WILL_DEPRECATE  EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12551    /**
12552     * Unset the content shown in the bubble
12553     *
12554     * Unparent and return the content object which was set for this widget.
12555     *
12556     * @param obj The bubble object
12557     * @return The content that was being used
12558     *
12559     * @deprecated use elm_object_content_unset() instead
12560     *
12561     */
12562    WILL_DEPRECATE  EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12563    /**
12564     * Set the icon of the bubble
12565     *
12566     * Once the icon object is set, a previously set one will be deleted.
12567     * If you want to keep the old content object, use the
12568     * elm_icon_content_unset() function.
12569     *
12570     * @param obj The bubble object
12571     * @param icon The given icon for the bubble
12572     *
12573     * @deprecated use elm_object_part_content_set() instead
12574     *
12575     */
12576    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12577    /**
12578     * Get the icon of the bubble
12579     *
12580     * @param obj The bubble object
12581     * @return The icon for the bubble
12582     *
12583     * This function gets the icon shown on the top left of bubble.
12584     *
12585     * @deprecated use elm_object_part_content_get() instead
12586     *
12587     */
12588    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12589    /**
12590     * Unset the icon of the bubble
12591     *
12592     * Unparent and return the icon object which was set for this widget.
12593     *
12594     * @param obj The bubble object
12595     * @return The icon that was being used
12596     *
12597     * @deprecated use elm_object_part_content_unset() instead
12598     *
12599     */
12600    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12601    /**
12602     * Set the corner of the bubble
12603     *
12604     * @param obj The bubble object.
12605     * @param corner The given corner for the bubble.
12606     *
12607     * This function sets the corner of the bubble. The corner will be used to
12608     * determine where the arrow in the frame points to and where label, icon and
12609     * info are shown.
12610     *
12611     * Possible values for corner are:
12612     * @li "top_left" - Default
12613     * @li "top_right"
12614     * @li "bottom_left"
12615     * @li "bottom_right"
12616     */
12617    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12618    /**
12619     * Get the corner of the bubble
12620     *
12621     * @param obj The bubble object.
12622     * @return The given corner for the bubble.
12623     *
12624     * This function gets the selected corner of the bubble.
12625     */
12626    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12627
12628    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12629    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12630
12631    /**
12632     * @}
12633     */
12634
12635    /**
12636     * @defgroup Photo Photo
12637     *
12638     * For displaying the photo of a person (contact). Simple, yet
12639     * with a very specific purpose.
12640     *
12641     * Signals that you can add callbacks for are:
12642     *
12643     * "clicked" - This is called when a user has clicked the photo
12644     * "drag,start" - Someone started dragging the image out of the object
12645     * "drag,end" - Dragged item was dropped (somewhere)
12646     *
12647     * @{
12648     */
12649
12650    /**
12651     * Add a new photo to the parent
12652     *
12653     * @param parent The parent object
12654     * @return The new object or NULL if it cannot be created
12655     *
12656     * @ingroup Photo
12657     */
12658    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12659
12660    /**
12661     * Set the file that will be used as photo
12662     *
12663     * @param obj The photo object
12664     * @param file The path to file that will be used as photo
12665     *
12666     * @return (1 = success, 0 = error)
12667     *
12668     * @ingroup Photo
12669     */
12670    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12671
12672     /**
12673     * Set the file that will be used as thumbnail in the photo.
12674     *
12675     * @param obj The photo object.
12676     * @param file The path to file that will be used as thumb.
12677     * @param group The key used in case of an EET file.
12678     *
12679     * @ingroup Photo
12680     */
12681    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12682
12683    /**
12684     * Set the size that will be used on the photo
12685     *
12686     * @param obj The photo object
12687     * @param size The size that the photo will be
12688     *
12689     * @ingroup Photo
12690     */
12691    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12692
12693    /**
12694     * Set if the photo should be completely visible or not.
12695     *
12696     * @param obj The photo object
12697     * @param fill if true the photo will be completely visible
12698     *
12699     * @ingroup Photo
12700     */
12701    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12702
12703    /**
12704     * Set editability of the photo.
12705     *
12706     * An editable photo can be dragged to or from, and can be cut or
12707     * pasted too.  Note that pasting an image or dropping an item on
12708     * the image will delete the existing content.
12709     *
12710     * @param obj The photo object.
12711     * @param set To set of clear editablity.
12712     */
12713    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12714
12715    /**
12716     * @}
12717     */
12718
12719    /* gesture layer */
12720    /**
12721     * @defgroup Elm_Gesture_Layer Gesture Layer
12722     * Gesture Layer Usage:
12723     *
12724     * Use Gesture Layer to detect gestures.
12725     * The advantage is that you don't have to implement
12726     * gesture detection, just set callbacks of gesture state.
12727     * By using gesture layer we make standard interface.
12728     *
12729     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12730     * with a parent object parameter.
12731     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12732     * call. Usually with same object as target (2nd parameter).
12733     *
12734     * Now you need to tell gesture layer what gestures you follow.
12735     * This is done with @ref elm_gesture_layer_cb_set call.
12736     * By setting the callback you actually saying to gesture layer:
12737     * I would like to know when the gesture @ref Elm_Gesture_Types
12738     * switches to state @ref Elm_Gesture_State.
12739     *
12740     * Next, you need to implement the actual action that follows the input
12741     * in your callback.
12742     *
12743     * Note that if you like to stop being reported about a gesture, just set
12744     * all callbacks referring this gesture to NULL.
12745     * (again with @ref elm_gesture_layer_cb_set)
12746     *
12747     * The information reported by gesture layer to your callback is depending
12748     * on @ref Elm_Gesture_Types:
12749     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12750     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12751     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12752     *
12753     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12754     * @ref ELM_GESTURE_MOMENTUM.
12755     *
12756     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12757     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12758     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12759     * Note that we consider a flick as a line-gesture that should be completed
12760     * in flick-time-limit as defined in @ref Config.
12761     *
12762     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12763     *
12764     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12765     *
12766     *
12767     * Gesture Layer Tweaks:
12768     *
12769     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12770     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12771     *
12772     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12773     * so gesture starts when user touches (a *DOWN event) touch-surface
12774     * and ends when no fingers touches surface (a *UP event).
12775     */
12776
12777    /**
12778     * @enum _Elm_Gesture_Types
12779     * Enum of supported gesture types.
12780     * @ingroup Elm_Gesture_Layer
12781     */
12782    enum _Elm_Gesture_Types
12783      {
12784         ELM_GESTURE_FIRST = 0,
12785
12786         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12787         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12788         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12789         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12790
12791         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12792
12793         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12794         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12795
12796         ELM_GESTURE_ZOOM, /**< Zoom */
12797         ELM_GESTURE_ROTATE, /**< Rotate */
12798
12799         ELM_GESTURE_LAST
12800      };
12801
12802    /**
12803     * @typedef Elm_Gesture_Types
12804     * gesture types enum
12805     * @ingroup Elm_Gesture_Layer
12806     */
12807    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12808
12809    /**
12810     * @enum _Elm_Gesture_State
12811     * Enum of gesture states.
12812     * @ingroup Elm_Gesture_Layer
12813     */
12814    enum _Elm_Gesture_State
12815      {
12816         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12817         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12818         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12819         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12820         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12821      };
12822
12823    /**
12824     * @typedef Elm_Gesture_State
12825     * gesture states enum
12826     * @ingroup Elm_Gesture_Layer
12827     */
12828    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12829
12830    /**
12831     * @struct _Elm_Gesture_Taps_Info
12832     * Struct holds taps info for user
12833     * @ingroup Elm_Gesture_Layer
12834     */
12835    struct _Elm_Gesture_Taps_Info
12836      {
12837         Evas_Coord x, y;         /**< Holds center point between fingers */
12838         unsigned int n;          /**< Number of fingers tapped           */
12839         unsigned int timestamp;  /**< event timestamp       */
12840      };
12841
12842    /**
12843     * @typedef Elm_Gesture_Taps_Info
12844     * holds taps info for user
12845     * @ingroup Elm_Gesture_Layer
12846     */
12847    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12848
12849    /**
12850     * @struct _Elm_Gesture_Momentum_Info
12851     * Struct holds momentum info for user
12852     * x1 and y1 are not necessarily in sync
12853     * x1 holds x value of x direction starting point
12854     * and same holds for y1.
12855     * This is noticeable when doing V-shape movement
12856     * @ingroup Elm_Gesture_Layer
12857     */
12858    struct _Elm_Gesture_Momentum_Info
12859      {  /* Report line ends, timestamps, and momentum computed        */
12860         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12861         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12862         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12863         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12864
12865         unsigned int tx; /**< Timestamp of start of final x-swipe */
12866         unsigned int ty; /**< Timestamp of start of final y-swipe */
12867
12868         Evas_Coord mx; /**< Momentum on X */
12869         Evas_Coord my; /**< Momentum on Y */
12870
12871         unsigned int n;  /**< Number of fingers */
12872      };
12873
12874    /**
12875     * @typedef Elm_Gesture_Momentum_Info
12876     * holds momentum info for user
12877     * @ingroup Elm_Gesture_Layer
12878     */
12879     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12880
12881    /**
12882     * @struct _Elm_Gesture_Line_Info
12883     * Struct holds line info for user
12884     * @ingroup Elm_Gesture_Layer
12885     */
12886    struct _Elm_Gesture_Line_Info
12887      {  /* Report line ends, timestamps, and momentum computed      */
12888         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12889         double angle;              /**< Angle (direction) of lines  */
12890      };
12891
12892    /**
12893     * @typedef Elm_Gesture_Line_Info
12894     * Holds line info for user
12895     * @ingroup Elm_Gesture_Layer
12896     */
12897     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12898
12899    /**
12900     * @struct _Elm_Gesture_Zoom_Info
12901     * Struct holds zoom info for user
12902     * @ingroup Elm_Gesture_Layer
12903     */
12904    struct _Elm_Gesture_Zoom_Info
12905      {
12906         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12907         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12908         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12909         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12910      };
12911
12912    /**
12913     * @typedef Elm_Gesture_Zoom_Info
12914     * Holds zoom info for user
12915     * @ingroup Elm_Gesture_Layer
12916     */
12917    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12918
12919    /**
12920     * @struct _Elm_Gesture_Rotate_Info
12921     * Struct holds rotation info for user
12922     * @ingroup Elm_Gesture_Layer
12923     */
12924    struct _Elm_Gesture_Rotate_Info
12925      {
12926         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12927         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12928         double base_angle; /**< Holds start-angle */
12929         double angle;      /**< Rotation value: 0.0 means no rotation         */
12930         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12931      };
12932
12933    /**
12934     * @typedef Elm_Gesture_Rotate_Info
12935     * Holds rotation info for user
12936     * @ingroup Elm_Gesture_Layer
12937     */
12938    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12939
12940    /**
12941     * @typedef Elm_Gesture_Event_Cb
12942     * User callback used to stream gesture info from gesture layer
12943     * @param data user data
12944     * @param event_info gesture report info
12945     * Returns a flag field to be applied on the causing event.
12946     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12947     * upon the event, in an irreversible way.
12948     *
12949     * @ingroup Elm_Gesture_Layer
12950     */
12951    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12952
12953    /**
12954     * Use function to set callbacks to be notified about
12955     * change of state of gesture.
12956     * When a user registers a callback with this function
12957     * this means this gesture has to be tested.
12958     *
12959     * When ALL callbacks for a gesture are set to NULL
12960     * it means user isn't interested in gesture-state
12961     * and it will not be tested.
12962     *
12963     * @param obj Pointer to gesture-layer.
12964     * @param idx The gesture you would like to track its state.
12965     * @param cb callback function pointer.
12966     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12967     * @param data user info to be sent to callback (usually, Smart Data)
12968     *
12969     * @ingroup Elm_Gesture_Layer
12970     */
12971    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);
12972
12973    /**
12974     * Call this function to get repeat-events settings.
12975     *
12976     * @param obj Pointer to gesture-layer.
12977     *
12978     * @return repeat events settings.
12979     * @see elm_gesture_layer_hold_events_set()
12980     * @ingroup Elm_Gesture_Layer
12981     */
12982    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12983
12984    /**
12985     * This function called in order to make gesture-layer repeat events.
12986     * Set this of you like to get the raw events only if gestures were not detected.
12987     * Clear this if you like gesture layer to fwd events as testing gestures.
12988     *
12989     * @param obj Pointer to gesture-layer.
12990     * @param r Repeat: TRUE/FALSE
12991     *
12992     * @ingroup Elm_Gesture_Layer
12993     */
12994    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12995
12996    /**
12997     * This function sets step-value for zoom action.
12998     * Set step to any positive value.
12999     * Cancel step setting by setting to 0.0
13000     *
13001     * @param obj Pointer to gesture-layer.
13002     * @param s new zoom step value.
13003     *
13004     * @ingroup Elm_Gesture_Layer
13005     */
13006    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13007
13008    /**
13009     * This function sets step-value for rotate action.
13010     * Set step to any positive value.
13011     * Cancel step setting by setting to 0.0
13012     *
13013     * @param obj Pointer to gesture-layer.
13014     * @param s new roatate step value.
13015     *
13016     * @ingroup Elm_Gesture_Layer
13017     */
13018    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13019
13020    /**
13021     * This function called to attach gesture-layer to an Evas_Object.
13022     * @param obj Pointer to gesture-layer.
13023     * @param t Pointer to underlying object (AKA Target)
13024     *
13025     * @return TRUE, FALSE on success, failure.
13026     *
13027     * @ingroup Elm_Gesture_Layer
13028     */
13029    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13030
13031    /**
13032     * Call this function to construct a new gesture-layer object.
13033     * This does not activate the gesture layer. You have to
13034     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13035     *
13036     * @param parent the parent object.
13037     *
13038     * @return Pointer to new gesture-layer object.
13039     *
13040     * @ingroup Elm_Gesture_Layer
13041     */
13042    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13043
13044    /**
13045     * @defgroup Thumb Thumb
13046     *
13047     * @image html img/widget/thumb/preview-00.png
13048     * @image latex img/widget/thumb/preview-00.eps
13049     *
13050     * A thumb object is used for displaying the thumbnail of an image or video.
13051     * You must have compiled Elementary with Ethumb_Client support and the DBus
13052     * service must be present and auto-activated in order to have thumbnails to
13053     * be generated.
13054     *
13055     * Once the thumbnail object becomes visible, it will check if there is a
13056     * previously generated thumbnail image for the file set on it. If not, it
13057     * will start generating this thumbnail.
13058     *
13059     * Different config settings will cause different thumbnails to be generated
13060     * even on the same file.
13061     *
13062     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13063     * Ethumb documentation to change this path, and to see other configuration
13064     * options.
13065     *
13066     * Signals that you can add callbacks for are:
13067     *
13068     * - "clicked" - This is called when a user has clicked the thumb without dragging
13069     *             around.
13070     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13071     * - "press" - This is called when a user has pressed down the thumb.
13072     * - "generate,start" - The thumbnail generation started.
13073     * - "generate,stop" - The generation process stopped.
13074     * - "generate,error" - The generation failed.
13075     * - "load,error" - The thumbnail image loading failed.
13076     *
13077     * available styles:
13078     * - default
13079     * - noframe
13080     *
13081     * An example of use of thumbnail:
13082     *
13083     * - @ref thumb_example_01
13084     */
13085
13086    /**
13087     * @addtogroup Thumb
13088     * @{
13089     */
13090
13091    /**
13092     * @enum _Elm_Thumb_Animation_Setting
13093     * @typedef Elm_Thumb_Animation_Setting
13094     *
13095     * Used to set if a video thumbnail is animating or not.
13096     *
13097     * @ingroup Thumb
13098     */
13099    typedef enum _Elm_Thumb_Animation_Setting
13100      {
13101         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13102         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13103         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13104         ELM_THUMB_ANIMATION_LAST
13105      } Elm_Thumb_Animation_Setting;
13106
13107    /**
13108     * Add a new thumb object to the parent.
13109     *
13110     * @param parent The parent object.
13111     * @return The new object or NULL if it cannot be created.
13112     *
13113     * @see elm_thumb_file_set()
13114     * @see elm_thumb_ethumb_client_get()
13115     *
13116     * @ingroup Thumb
13117     */
13118    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13119    /**
13120     * Reload thumbnail if it was generated before.
13121     *
13122     * @param obj The thumb object to reload
13123     *
13124     * This is useful if the ethumb client configuration changed, like its
13125     * size, aspect or any other property one set in the handle returned
13126     * by elm_thumb_ethumb_client_get().
13127     *
13128     * If the options didn't change, the thumbnail won't be generated again, but
13129     * the old one will still be used.
13130     *
13131     * @see elm_thumb_file_set()
13132     *
13133     * @ingroup Thumb
13134     */
13135    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13136    /**
13137     * Set the file that will be used as thumbnail.
13138     *
13139     * @param obj The thumb object.
13140     * @param file The path to file that will be used as thumb.
13141     * @param key The key used in case of an EET file.
13142     *
13143     * The file can be an image or a video (in that case, acceptable extensions are:
13144     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13145     * function elm_thumb_animate().
13146     *
13147     * @see elm_thumb_file_get()
13148     * @see elm_thumb_reload()
13149     * @see elm_thumb_animate()
13150     *
13151     * @ingroup Thumb
13152     */
13153    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13154    /**
13155     * Get the image or video path and key used to generate the thumbnail.
13156     *
13157     * @param obj The thumb object.
13158     * @param file Pointer to filename.
13159     * @param key Pointer to key.
13160     *
13161     * @see elm_thumb_file_set()
13162     * @see elm_thumb_path_get()
13163     *
13164     * @ingroup Thumb
13165     */
13166    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13167    /**
13168     * Get the path and key to the image or video generated by ethumb.
13169     *
13170     * One just need to make sure that the thumbnail was generated before getting
13171     * its path; otherwise, the path will be NULL. One way to do that is by asking
13172     * for the path when/after the "generate,stop" smart callback is called.
13173     *
13174     * @param obj The thumb object.
13175     * @param file Pointer to thumb path.
13176     * @param key Pointer to thumb key.
13177     *
13178     * @see elm_thumb_file_get()
13179     *
13180     * @ingroup Thumb
13181     */
13182    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13183    /**
13184     * Set the animation state for the thumb object. If its content is an animated
13185     * video, you may start/stop the animation or tell it to play continuously and
13186     * looping.
13187     *
13188     * @param obj The thumb object.
13189     * @param setting The animation setting.
13190     *
13191     * @see elm_thumb_file_set()
13192     *
13193     * @ingroup Thumb
13194     */
13195    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13196    /**
13197     * Get the animation state for the thumb object.
13198     *
13199     * @param obj The thumb object.
13200     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13201     * on errors.
13202     *
13203     * @see elm_thumb_animate_set()
13204     *
13205     * @ingroup Thumb
13206     */
13207    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13208    /**
13209     * Get the ethumb_client handle so custom configuration can be made.
13210     *
13211     * @return Ethumb_Client instance or NULL.
13212     *
13213     * This must be called before the objects are created to be sure no object is
13214     * visible and no generation started.
13215     *
13216     * Example of usage:
13217     *
13218     * @code
13219     * #include <Elementary.h>
13220     * #ifndef ELM_LIB_QUICKLAUNCH
13221     * EAPI_MAIN int
13222     * elm_main(int argc, char **argv)
13223     * {
13224     *    Ethumb_Client *client;
13225     *
13226     *    elm_need_ethumb();
13227     *
13228     *    // ... your code
13229     *
13230     *    client = elm_thumb_ethumb_client_get();
13231     *    if (!client)
13232     *      {
13233     *         ERR("could not get ethumb_client");
13234     *         return 1;
13235     *      }
13236     *    ethumb_client_size_set(client, 100, 100);
13237     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13238     *    // ... your code
13239     *
13240     *    // Create elm_thumb objects here
13241     *
13242     *    elm_run();
13243     *    elm_shutdown();
13244     *    return 0;
13245     * }
13246     * #endif
13247     * ELM_MAIN()
13248     * @endcode
13249     *
13250     * @note There's only one client handle for Ethumb, so once a configuration
13251     * change is done to it, any other request for thumbnails (for any thumbnail
13252     * object) will use that configuration. Thus, this configuration is global.
13253     *
13254     * @ingroup Thumb
13255     */
13256    EAPI void                        *elm_thumb_ethumb_client_get(void);
13257    /**
13258     * Get the ethumb_client connection state.
13259     *
13260     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13261     * otherwise.
13262     */
13263    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13264    /**
13265     * Make the thumbnail 'editable'.
13266     *
13267     * @param obj Thumb object.
13268     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13269     *
13270     * This means the thumbnail is a valid drag target for drag and drop, and can be
13271     * cut or pasted too.
13272     *
13273     * @see elm_thumb_editable_get()
13274     *
13275     * @ingroup Thumb
13276     */
13277    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13278    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13279    /**
13280     * Make the thumbnail 'editable'.
13281     *
13282     * @param obj Thumb object.
13283     * @return Editability.
13284     *
13285     * This means the thumbnail is a valid drag target for drag and drop, and can be
13286     * cut or pasted too.
13287     *
13288     * @see elm_thumb_editable_set()
13289     *
13290     * @ingroup Thumb
13291     */
13292    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13293
13294    /**
13295     * @}
13296     */
13297
13298    /**
13299     * @defgroup Web Web
13300     *
13301     * @image html img/widget/web/preview-00.png
13302     * @image latex img/widget/web/preview-00.eps
13303     *
13304     * A web object is used for displaying web pages (HTML/CSS/JS)
13305     * using WebKit-EFL. You must have compiled Elementary with
13306     * ewebkit support.
13307     *
13308     * Signals that you can add callbacks for are:
13309     * @li "download,request": A file download has been requested. Event info is
13310     * a pointer to a Elm_Web_Download
13311     * @li "editorclient,contents,changed": Editor client's contents changed
13312     * @li "editorclient,selection,changed": Editor client's selection changed
13313     * @li "frame,created": A new frame was created. Event info is an
13314     * Evas_Object which can be handled with WebKit's ewk_frame API
13315     * @li "icon,received": An icon was received by the main frame
13316     * @li "inputmethod,changed": Input method changed. Event info is an
13317     * Eina_Bool indicating whether it's enabled or not
13318     * @li "js,windowobject,clear": JS window object has been cleared
13319     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13320     * is a char *link[2], where the first string contains the URL the link
13321     * points to, and the second one the title of the link
13322     * @li "link,hover,out": Mouse cursor left the link
13323     * @li "load,document,finished": Loading of a document finished. Event info
13324     * is the frame that finished loading
13325     * @li "load,error": Load failed. Event info is a pointer to
13326     * Elm_Web_Frame_Load_Error
13327     * @li "load,finished": Load finished. Event info is NULL on success, on
13328     * error it's a pointer to Elm_Web_Frame_Load_Error
13329     * @li "load,newwindow,show": A new window was created and is ready to be
13330     * shown
13331     * @li "load,progress": Overall load progress. Event info is a pointer to
13332     * a double containing a value between 0.0 and 1.0
13333     * @li "load,provisional": Started provisional load
13334     * @li "load,started": Loading of a document started
13335     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13336     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13337     * the menubar is visible, or EINA_FALSE in case it's not
13338     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13339     * an Eina_Bool indicating the visibility
13340     * @li "popup,created": A dropdown widget was activated, requesting its
13341     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13342     * @li "popup,willdelete": The web object is ready to destroy the popup
13343     * object created. Event info is a pointer to Elm_Web_Menu
13344     * @li "ready": Page is fully loaded
13345     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13346     * info is a pointer to Eina_Bool where the visibility state should be set
13347     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13348     * is an Eina_Bool with the visibility state set
13349     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13350     * a string with the new text
13351     * @li "statusbar,visible,get": Queries visibility of the status bar.
13352     * Event info is a pointer to Eina_Bool where the visibility state should be
13353     * set.
13354     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13355     * an Eina_Bool with the visibility value
13356     * @li "title,changed": Title of the main frame changed. Event info is a
13357     * string with the new title
13358     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13359     * is a pointer to Eina_Bool where the visibility state should be set
13360     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13361     * info is an Eina_Bool with the visibility state
13362     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13363     * a string with the text to show
13364     * @li "uri,changed": URI of the main frame changed. Event info is a string
13365     * with the new URI
13366     * @li "view,resized": The web object internal's view changed sized
13367     * @li "windows,close,request": A JavaScript request to close the current
13368     * window was requested
13369     * @li "zoom,animated,end": Animated zoom finished
13370     *
13371     * available styles:
13372     * - default
13373     *
13374     * An example of use of web:
13375     *
13376     * - @ref web_example_01 TBD
13377     */
13378
13379    /**
13380     * @addtogroup Web
13381     * @{
13382     */
13383
13384    /**
13385     * Structure used to report load errors.
13386     *
13387     * Load errors are reported as signal by elm_web. All the strings are
13388     * temporary references and should @b not be used after the signal
13389     * callback returns. If it's required, make copies with strdup() or
13390     * eina_stringshare_add() (they are not even guaranteed to be
13391     * stringshared, so must use eina_stringshare_add() and not
13392     * eina_stringshare_ref()).
13393     */
13394    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13395    /**
13396     * Structure used to report load errors.
13397     *
13398     * Load errors are reported as signal by elm_web. All the strings are
13399     * temporary references and should @b not be used after the signal
13400     * callback returns. If it's required, make copies with strdup() or
13401     * eina_stringshare_add() (they are not even guaranteed to be
13402     * stringshared, so must use eina_stringshare_add() and not
13403     * eina_stringshare_ref()).
13404     */
13405    struct _Elm_Web_Frame_Load_Error
13406      {
13407         int code; /**< Numeric error code */
13408         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13409         const char *domain; /**< Error domain name */
13410         const char *description; /**< Error description (already localized) */
13411         const char *failing_url; /**< The URL that failed to load */
13412         Evas_Object *frame; /**< Frame object that produced the error */
13413      };
13414
13415    /**
13416     * The possibles types that the items in a menu can be
13417     */
13418    typedef enum _Elm_Web_Menu_Item_Type
13419      {
13420         ELM_WEB_MENU_SEPARATOR,
13421         ELM_WEB_MENU_GROUP,
13422         ELM_WEB_MENU_OPTION
13423      } Elm_Web_Menu_Item_Type;
13424
13425    /**
13426     * Structure describing the items in a menu
13427     */
13428    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13429    /**
13430     * Structure describing the items in a menu
13431     */
13432    struct _Elm_Web_Menu_Item
13433      {
13434         const char *text; /**< The text for the item */
13435         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13436      };
13437
13438    /**
13439     * Structure describing the menu of a popup
13440     *
13441     * This structure will be passed as the @c event_info for the "popup,create"
13442     * signal, which is emitted when a dropdown menu is opened. Users wanting
13443     * to handle these popups by themselves should listen to this signal and
13444     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13445     * property as @c EINA_FALSE means that the user will not handle the popup
13446     * and the default implementation will be used.
13447     *
13448     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13449     * will be emitted to notify the user that it can destroy any objects and
13450     * free all data related to it.
13451     *
13452     * @see elm_web_popup_selected_set()
13453     * @see elm_web_popup_destroy()
13454     */
13455    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13456    /**
13457     * Structure describing the menu of a popup
13458     *
13459     * This structure will be passed as the @c event_info for the "popup,create"
13460     * signal, which is emitted when a dropdown menu is opened. Users wanting
13461     * to handle these popups by themselves should listen to this signal and
13462     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13463     * property as @c EINA_FALSE means that the user will not handle the popup
13464     * and the default implementation will be used.
13465     *
13466     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13467     * will be emitted to notify the user that it can destroy any objects and
13468     * free all data related to it.
13469     *
13470     * @see elm_web_popup_selected_set()
13471     * @see elm_web_popup_destroy()
13472     */
13473    struct _Elm_Web_Menu
13474      {
13475         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13476         int x; /**< The X position of the popup, relative to the elm_web object */
13477         int y; /**< The Y position of the popup, relative to the elm_web object */
13478         int width; /**< Width of the popup menu */
13479         int height; /**< Height of the popup menu */
13480
13481         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. */
13482      };
13483
13484    typedef struct _Elm_Web_Download Elm_Web_Download;
13485    struct _Elm_Web_Download
13486      {
13487         const char *url;
13488      };
13489
13490    /**
13491     * Types of zoom available.
13492     */
13493    typedef enum _Elm_Web_Zoom_Mode
13494      {
13495         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13496         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13497         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13498         ELM_WEB_ZOOM_MODE_LAST
13499      } Elm_Web_Zoom_Mode;
13500    /**
13501     * Opaque handler containing the features (such as statusbar, menubar, etc)
13502     * that are to be set on a newly requested window.
13503     */
13504    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13505    /**
13506     * Callback type for the create_window hook.
13507     *
13508     * The function parameters are:
13509     * @li @p data User data pointer set when setting the hook function
13510     * @li @p obj The elm_web object requesting the new window
13511     * @li @p js Set to @c EINA_TRUE if the request was originated from
13512     * JavaScript. @c EINA_FALSE otherwise.
13513     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13514     * the features requested for the new window.
13515     *
13516     * The returned value of the function should be the @c elm_web widget where
13517     * the request will be loaded. That is, if a new window or tab is created,
13518     * the elm_web widget in it should be returned, and @b NOT the window
13519     * object.
13520     * Returning @c NULL should cancel the request.
13521     *
13522     * @see elm_web_window_create_hook_set()
13523     */
13524    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13525    /**
13526     * Callback type for the JS alert hook.
13527     *
13528     * The function parameters are:
13529     * @li @p data User data pointer set when setting the hook function
13530     * @li @p obj The elm_web object requesting the new window
13531     * @li @p message The message to show in the alert dialog
13532     *
13533     * The function should return the object representing the alert dialog.
13534     * Elm_Web will run a second main loop to handle the dialog and normal
13535     * flow of the application will be restored when the object is deleted, so
13536     * the user should handle the popup properly in order to delete the object
13537     * when the action is finished.
13538     * If the function returns @c NULL the popup will be ignored.
13539     *
13540     * @see elm_web_dialog_alert_hook_set()
13541     */
13542    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13543    /**
13544     * Callback type for the JS confirm hook.
13545     *
13546     * The function parameters are:
13547     * @li @p data User data pointer set when setting the hook function
13548     * @li @p obj The elm_web object requesting the new window
13549     * @li @p message The message to show in the confirm dialog
13550     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13551     * the user selected @c Ok, @c EINA_FALSE otherwise.
13552     *
13553     * The function should return the object representing the confirm dialog.
13554     * Elm_Web will run a second main loop to handle the dialog and normal
13555     * flow of the application will be restored when the object is deleted, so
13556     * the user should handle the popup properly in order to delete the object
13557     * when the action is finished.
13558     * If the function returns @c NULL the popup will be ignored.
13559     *
13560     * @see elm_web_dialog_confirm_hook_set()
13561     */
13562    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13563    /**
13564     * Callback type for the JS prompt hook.
13565     *
13566     * The function parameters are:
13567     * @li @p data User data pointer set when setting the hook function
13568     * @li @p obj The elm_web object requesting the new window
13569     * @li @p message The message to show in the prompt dialog
13570     * @li @p def_value The default value to present the user in the entry
13571     * @li @p value Pointer where to store the value given by the user. Must
13572     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13573     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13574     * the user selected @c Ok, @c EINA_FALSE otherwise.
13575     *
13576     * The function should return the object representing the prompt dialog.
13577     * Elm_Web will run a second main loop to handle the dialog and normal
13578     * flow of the application will be restored when the object is deleted, so
13579     * the user should handle the popup properly in order to delete the object
13580     * when the action is finished.
13581     * If the function returns @c NULL the popup will be ignored.
13582     *
13583     * @see elm_web_dialog_prompt_hook_set()
13584     */
13585    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13586    /**
13587     * Callback type for the JS file selector hook.
13588     *
13589     * The function parameters are:
13590     * @li @p data User data pointer set when setting the hook function
13591     * @li @p obj The elm_web object requesting the new window
13592     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13593     * @li @p accept_types Mime types accepted
13594     * @li @p selected Pointer where to store the list of malloc'ed strings
13595     * containing the path to each file selected. Must be @c NULL if the file
13596     * dialog is cancelled
13597     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13598     * the user selected @c Ok, @c EINA_FALSE otherwise.
13599     *
13600     * The function should return the object representing the file selector
13601     * dialog.
13602     * Elm_Web will run a second main loop to handle the dialog and normal
13603     * flow of the application will be restored when the object is deleted, so
13604     * the user should handle the popup properly in order to delete the object
13605     * when the action is finished.
13606     * If the function returns @c NULL the popup will be ignored.
13607     *
13608     * @see elm_web_dialog_file selector_hook_set()
13609     */
13610    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);
13611    /**
13612     * Callback type for the JS console message hook.
13613     *
13614     * When a console message is added from JavaScript, any set function to the
13615     * console message hook will be called for the user to handle. There is no
13616     * default implementation of this hook.
13617     *
13618     * The function parameters are:
13619     * @li @p data User data pointer set when setting the hook function
13620     * @li @p obj The elm_web object that originated the message
13621     * @li @p message The message sent
13622     * @li @p line_number The line number
13623     * @li @p source_id Source id
13624     *
13625     * @see elm_web_console_message_hook_set()
13626     */
13627    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13628    /**
13629     * Add a new web object to the parent.
13630     *
13631     * @param parent The parent object.
13632     * @return The new object or NULL if it cannot be created.
13633     *
13634     * @see elm_web_uri_set()
13635     * @see elm_web_webkit_view_get()
13636     */
13637    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13638
13639    /**
13640     * Get internal ewk_view object from web object.
13641     *
13642     * Elementary may not provide some low level features of EWebKit,
13643     * instead of cluttering the API with proxy methods we opted to
13644     * return the internal reference. Be careful using it as it may
13645     * interfere with elm_web behavior.
13646     *
13647     * @param obj The web object.
13648     * @return The internal ewk_view object or NULL if it does not
13649     *         exist. (Failure to create or Elementary compiled without
13650     *         ewebkit)
13651     *
13652     * @see elm_web_add()
13653     */
13654    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13655
13656    /**
13657     * Sets the function to call when a new window is requested
13658     *
13659     * This hook will be called when a request to create a new window is
13660     * issued from the web page loaded.
13661     * There is no default implementation for this feature, so leaving this
13662     * unset or passing @c NULL in @p func will prevent new windows from
13663     * opening.
13664     *
13665     * @param obj The web object where to set the hook function
13666     * @param func The hook function to be called when a window is requested
13667     * @param data User data
13668     */
13669    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13670    /**
13671     * Sets the function to call when an alert dialog
13672     *
13673     * This hook will be called when a JavaScript alert dialog is requested.
13674     * If no function is set or @c NULL is passed in @p func, the default
13675     * implementation will take place.
13676     *
13677     * @param obj The web object where to set the hook function
13678     * @param func The callback function to be used
13679     * @param data User data
13680     *
13681     * @see elm_web_inwin_mode_set()
13682     */
13683    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13684    /**
13685     * Sets the function to call when an confirm dialog
13686     *
13687     * This hook will be called when a JavaScript confirm dialog is requested.
13688     * If no function is set or @c NULL is passed in @p func, the default
13689     * implementation will take place.
13690     *
13691     * @param obj The web object where to set the hook function
13692     * @param func The callback function to be used
13693     * @param data User data
13694     *
13695     * @see elm_web_inwin_mode_set()
13696     */
13697    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13698    /**
13699     * Sets the function to call when an prompt dialog
13700     *
13701     * This hook will be called when a JavaScript prompt dialog is requested.
13702     * If no function is set or @c NULL is passed in @p func, the default
13703     * implementation will take place.
13704     *
13705     * @param obj The web object where to set the hook function
13706     * @param func The callback function to be used
13707     * @param data User data
13708     *
13709     * @see elm_web_inwin_mode_set()
13710     */
13711    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13712    /**
13713     * Sets the function to call when an file selector dialog
13714     *
13715     * This hook will be called when a JavaScript file selector dialog is
13716     * requested.
13717     * If no function is set or @c NULL is passed in @p func, the default
13718     * implementation will take place.
13719     *
13720     * @param obj The web object where to set the hook function
13721     * @param func The callback function to be used
13722     * @param data User data
13723     *
13724     * @see elm_web_inwin_mode_set()
13725     */
13726    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13727    /**
13728     * Sets the function to call when a console message is emitted from JS
13729     *
13730     * This hook will be called when a console message is emitted from
13731     * JavaScript. There is no default implementation for this feature.
13732     *
13733     * @param obj The web object where to set the hook function
13734     * @param func The callback function to be used
13735     * @param data User data
13736     */
13737    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13738    /**
13739     * Gets the status of the tab propagation
13740     *
13741     * @param obj The web object to query
13742     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13743     *
13744     * @see elm_web_tab_propagate_set()
13745     */
13746    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13747    /**
13748     * Sets whether to use tab propagation
13749     *
13750     * If tab propagation is enabled, whenever the user presses the Tab key,
13751     * Elementary will handle it and switch focus to the next widget.
13752     * The default value is disabled, where WebKit will handle the Tab key to
13753     * cycle focus though its internal objects, jumping to the next widget
13754     * only when that cycle ends.
13755     *
13756     * @param obj The web object
13757     * @param propagate Whether to propagate Tab keys to Elementary or not
13758     */
13759    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13760    /**
13761     * Sets the URI for the web object
13762     *
13763     * It must be a full URI, with resource included, in the form
13764     * http://www.enlightenment.org or file:///tmp/something.html
13765     *
13766     * @param obj The web object
13767     * @param uri The URI to set
13768     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13769     */
13770    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13771    /**
13772     * Gets the current URI for the object
13773     *
13774     * The returned string must not be freed and is guaranteed to be
13775     * stringshared.
13776     *
13777     * @param obj The web object
13778     * @return A stringshared internal string with the current URI, or NULL on
13779     * failure
13780     */
13781    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13782    /**
13783     * Gets the current title
13784     *
13785     * The returned string must not be freed and is guaranteed to be
13786     * stringshared.
13787     *
13788     * @param obj The web object
13789     * @return A stringshared internal string with the current title, or NULL on
13790     * failure
13791     */
13792    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13793    /**
13794     * Sets the background color to be used by the web object
13795     *
13796     * This is the color that will be used by default when the loaded page
13797     * does not set it's own. Color values are pre-multiplied.
13798     *
13799     * @param obj The web object
13800     * @param r Red component
13801     * @param g Green component
13802     * @param b Blue component
13803     * @param a Alpha component
13804     */
13805    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13806    /**
13807     * Gets the background color to be used by the web object
13808     *
13809     * This is the color that will be used by default when the loaded page
13810     * does not set it's own. Color values are pre-multiplied.
13811     *
13812     * @param obj The web object
13813     * @param r Red component
13814     * @param g Green component
13815     * @param b Blue component
13816     * @param a Alpha component
13817     */
13818    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13819    /**
13820     * Gets a copy of the currently selected text
13821     *
13822     * The string returned must be freed by the user when it's done with it.
13823     *
13824     * @param obj The web object
13825     * @return A newly allocated string, or NULL if nothing is selected or an
13826     * error occurred
13827     */
13828    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13829    /**
13830     * Tells the web object which index in the currently open popup was selected
13831     *
13832     * When the user handles the popup creation from the "popup,created" signal,
13833     * it needs to tell the web object which item was selected by calling this
13834     * function with the index corresponding to the item.
13835     *
13836     * @param obj The web object
13837     * @param index The index selected
13838     *
13839     * @see elm_web_popup_destroy()
13840     */
13841    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13842    /**
13843     * Dismisses an open dropdown popup
13844     *
13845     * When the popup from a dropdown widget is to be dismissed, either after
13846     * selecting an option or to cancel it, this function must be called, which
13847     * will later emit an "popup,willdelete" signal to notify the user that
13848     * any memory and objects related to this popup can be freed.
13849     *
13850     * @param obj The web object
13851     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13852     * if there was no menu to destroy
13853     */
13854    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13855    /**
13856     * Searches the given string in a document.
13857     *
13858     * @param obj The web object where to search the text
13859     * @param string String to search
13860     * @param case_sensitive If search should be case sensitive or not
13861     * @param forward If search is from cursor and on or backwards
13862     * @param wrap If search should wrap at the end
13863     *
13864     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13865     * or failure
13866     */
13867    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13868    /**
13869     * Marks matches of the given string in a document.
13870     *
13871     * @param obj The web object where to search text
13872     * @param string String to match
13873     * @param case_sensitive If match should be case sensitive or not
13874     * @param highlight If matches should be highlighted
13875     * @param limit Maximum amount of matches, or zero to unlimited
13876     *
13877     * @return number of matched @a string
13878     */
13879    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13880    /**
13881     * Clears all marked matches in the document
13882     *
13883     * @param obj The web object
13884     *
13885     * @return EINA_TRUE on success, EINA_FALSE otherwise
13886     */
13887    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13888    /**
13889     * Sets whether to highlight the matched marks
13890     *
13891     * If enabled, marks set with elm_web_text_matches_mark() will be
13892     * highlighted.
13893     *
13894     * @param obj The web object
13895     * @param highlight Whether to highlight the marks or not
13896     *
13897     * @return EINA_TRUE on success, EINA_FALSE otherwise
13898     */
13899    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13900    /**
13901     * Gets whether highlighting marks is enabled
13902     *
13903     * @param The web object
13904     *
13905     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13906     * otherwise
13907     */
13908    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13909    /**
13910     * Gets the overall loading progress of the page
13911     *
13912     * Returns the estimated loading progress of the page, with a value between
13913     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13914     * included in the page.
13915     *
13916     * @param The web object
13917     *
13918     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13919     * failure
13920     */
13921    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13922    /**
13923     * Stops loading the current page
13924     *
13925     * Cancels the loading of the current page in the web object. This will
13926     * cause a "load,error" signal to be emitted, with the is_cancellation
13927     * flag set to EINA_TRUE.
13928     *
13929     * @param obj The web object
13930     *
13931     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13932     */
13933    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13934    /**
13935     * Requests a reload of the current document in the object
13936     *
13937     * @param obj The web object
13938     *
13939     * @return EINA_TRUE on success, EINA_FALSE otherwise
13940     */
13941    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13942    /**
13943     * Requests a reload of the current document, avoiding any existing caches
13944     *
13945     * @param obj The web object
13946     *
13947     * @return EINA_TRUE on success, EINA_FALSE otherwise
13948     */
13949    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13950    /**
13951     * Goes back one step in the browsing history
13952     *
13953     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13954     *
13955     * @param obj The web object
13956     *
13957     * @return EINA_TRUE on success, EINA_FALSE otherwise
13958     *
13959     * @see elm_web_history_enable_set()
13960     * @see elm_web_back_possible()
13961     * @see elm_web_forward()
13962     * @see elm_web_navigate()
13963     */
13964    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13965    /**
13966     * Goes forward one step in the browsing history
13967     *
13968     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13969     *
13970     * @param obj The web object
13971     *
13972     * @return EINA_TRUE on success, EINA_FALSE otherwise
13973     *
13974     * @see elm_web_history_enable_set()
13975     * @see elm_web_forward_possible()
13976     * @see elm_web_back()
13977     * @see elm_web_navigate()
13978     */
13979    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13980    /**
13981     * Jumps the given number of steps in the browsing history
13982     *
13983     * The @p steps value can be a negative integer to back in history, or a
13984     * positive to move forward.
13985     *
13986     * @param obj The web object
13987     * @param steps The number of steps to jump
13988     *
13989     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13990     * history exists to jump the given number of steps
13991     *
13992     * @see elm_web_history_enable_set()
13993     * @see elm_web_navigate_possible()
13994     * @see elm_web_back()
13995     * @see elm_web_forward()
13996     */
13997    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13998    /**
13999     * Queries whether it's possible to go back in history
14000     *
14001     * @param obj The web object
14002     *
14003     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14004     * otherwise
14005     */
14006    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14007    /**
14008     * Queries whether it's possible to go forward in history
14009     *
14010     * @param obj The web object
14011     *
14012     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14013     * otherwise
14014     */
14015    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14016    /**
14017     * Queries whether it's possible to jump the given number of steps
14018     *
14019     * The @p steps value can be a negative integer to back in history, or a
14020     * positive to move forward.
14021     *
14022     * @param obj The web object
14023     * @param steps The number of steps to check for
14024     *
14025     * @return EINA_TRUE if enough history exists to perform the given jump,
14026     * EINA_FALSE otherwise
14027     */
14028    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14029    /**
14030     * Gets whether browsing history is enabled for the given object
14031     *
14032     * @param obj The web object
14033     *
14034     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14035     */
14036    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14037    /**
14038     * Enables or disables the browsing history
14039     *
14040     * @param obj The web object
14041     * @param enable Whether to enable or disable the browsing history
14042     */
14043    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14044    /**
14045     * Sets the zoom level of the web object
14046     *
14047     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14048     * values meaning zoom in and lower meaning zoom out. This function will
14049     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14050     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14051     *
14052     * @param obj The web object
14053     * @param zoom The zoom level to set
14054     */
14055    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14056    /**
14057     * Gets the current zoom level set on the web object
14058     *
14059     * Note that this is the zoom level set on the web object and not that
14060     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14061     * the two zoom levels should match, but for the other two modes the
14062     * Webkit zoom is calculated internally to match the chosen mode without
14063     * changing the zoom level set for the web object.
14064     *
14065     * @param obj The web object
14066     *
14067     * @return The zoom level set on the object
14068     */
14069    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14070    /**
14071     * Sets the zoom mode to use
14072     *
14073     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14074     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14075     *
14076     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14077     * with the elm_web_zoom_set() function.
14078     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14079     * make sure the entirety of the web object's contents are shown.
14080     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14081     * fit the contents in the web object's size, without leaving any space
14082     * unused.
14083     *
14084     * @param obj The web object
14085     * @param mode The mode to set
14086     */
14087    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14088    /**
14089     * Gets the currently set zoom mode
14090     *
14091     * @param obj The web object
14092     *
14093     * @return The current zoom mode set for the object, or
14094     * ::ELM_WEB_ZOOM_MODE_LAST on error
14095     */
14096    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14097    /**
14098     * Shows the given region in the web object
14099     *
14100     * @param obj The web object
14101     * @param x The x coordinate of the region to show
14102     * @param y The y coordinate of the region to show
14103     * @param w The width of the region to show
14104     * @param h The height of the region to show
14105     */
14106    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14107    /**
14108     * Brings in the region to the visible area
14109     *
14110     * Like elm_web_region_show(), but it animates the scrolling of the object
14111     * to show the area
14112     *
14113     * @param obj The web object
14114     * @param x The x coordinate of the region to show
14115     * @param y The y coordinate of the region to show
14116     * @param w The width of the region to show
14117     * @param h The height of the region to show
14118     */
14119    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14120    /**
14121     * Sets the default dialogs to use an Inwin instead of a normal window
14122     *
14123     * If set, then the default implementation for the JavaScript dialogs and
14124     * file selector will be opened in an Inwin. Otherwise they will use a
14125     * normal separated window.
14126     *
14127     * @param obj The web object
14128     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14129     */
14130    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14131    /**
14132     * Gets whether Inwin mode is set for the current object
14133     *
14134     * @param obj The web object
14135     *
14136     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14137     */
14138    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14139
14140    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14141    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14142    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);
14143    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14144
14145    /**
14146     * @}
14147     */
14148
14149    /**
14150     * @defgroup Hoversel Hoversel
14151     *
14152     * @image html img/widget/hoversel/preview-00.png
14153     * @image latex img/widget/hoversel/preview-00.eps
14154     *
14155     * A hoversel is a button that pops up a list of items (automatically
14156     * choosing the direction to display) that have a label and, optionally, an
14157     * icon to select from. It is a convenience widget to avoid the need to do
14158     * all the piecing together yourself. It is intended for a small number of
14159     * items in the hoversel menu (no more than 8), though is capable of many
14160     * more.
14161     *
14162     * Signals that you can add callbacks for are:
14163     * "clicked" - the user clicked the hoversel button and popped up the sel
14164     * "selected" - an item in the hoversel list is selected. event_info is the item
14165     * "dismissed" - the hover is dismissed
14166     *
14167     * See @ref tutorial_hoversel for an example.
14168     * @{
14169     */
14170    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14171    /**
14172     * @brief Add a new Hoversel object
14173     *
14174     * @param parent The parent object
14175     * @return The new object or NULL if it cannot be created
14176     */
14177    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14178    /**
14179     * @brief This sets the hoversel to expand horizontally.
14180     *
14181     * @param obj The hoversel object
14182     * @param horizontal If true, the hover will expand horizontally to the
14183     * right.
14184     *
14185     * @note The initial button will display horizontally regardless of this
14186     * setting.
14187     */
14188    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14189    /**
14190     * @brief This returns whether the hoversel is set to expand horizontally.
14191     *
14192     * @param obj The hoversel object
14193     * @return If true, the hover will expand horizontally to the right.
14194     *
14195     * @see elm_hoversel_horizontal_set()
14196     */
14197    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14198    /**
14199     * @brief Set the Hover parent
14200     *
14201     * @param obj The hoversel object
14202     * @param parent The parent to use
14203     *
14204     * Sets the hover parent object, the area that will be darkened when the
14205     * hoversel is clicked. Should probably be the window that the hoversel is
14206     * in. See @ref Hover objects for more information.
14207     */
14208    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14209    /**
14210     * @brief Get the Hover parent
14211     *
14212     * @param obj The hoversel object
14213     * @return The used parent
14214     *
14215     * Gets the hover parent object.
14216     *
14217     * @see elm_hoversel_hover_parent_set()
14218     */
14219    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14220    /**
14221     * @brief Set the hoversel button label
14222     *
14223     * @param obj The hoversel object
14224     * @param label The label text.
14225     *
14226     * This sets the label of the button that is always visible (before it is
14227     * clicked and expanded).
14228     *
14229     * @deprecated elm_object_text_set()
14230     */
14231    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14232    /**
14233     * @brief Get the hoversel button label
14234     *
14235     * @param obj The hoversel object
14236     * @return The label text.
14237     *
14238     * @deprecated elm_object_text_get()
14239     */
14240    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14241    /**
14242     * @brief Set the icon of the hoversel button
14243     *
14244     * @param obj The hoversel object
14245     * @param icon The icon object
14246     *
14247     * Sets the icon of the button that is always visible (before it is clicked
14248     * and expanded).  Once the icon object is set, a previously set one will be
14249     * deleted, if you want to keep that old content object, use the
14250     * elm_hoversel_icon_unset() function.
14251     *
14252     * @see elm_object_content_set() for the button widget
14253     */
14254    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14255    /**
14256     * @brief Get the icon of the hoversel button
14257     *
14258     * @param obj The hoversel object
14259     * @return The icon object
14260     *
14261     * Get the icon of the button that is always visible (before it is clicked
14262     * and expanded). Also see elm_object_content_get() for the button widget.
14263     *
14264     * @see elm_hoversel_icon_set()
14265     */
14266    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14267    /**
14268     * @brief Get and unparent the icon of the hoversel button
14269     *
14270     * @param obj The hoversel object
14271     * @return The icon object that was being used
14272     *
14273     * Unparent and return the icon of the button that is always visible
14274     * (before it is clicked and expanded).
14275     *
14276     * @see elm_hoversel_icon_set()
14277     * @see elm_object_content_unset() for the button widget
14278     */
14279    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14280    /**
14281     * @brief This triggers the hoversel popup from code, the same as if the user
14282     * had clicked the button.
14283     *
14284     * @param obj The hoversel object
14285     */
14286    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14287    /**
14288     * @brief This dismisses the hoversel popup as if the user had clicked
14289     * outside the hover.
14290     *
14291     * @param obj The hoversel object
14292     */
14293    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14294    /**
14295     * @brief Returns whether the hoversel is expanded.
14296     *
14297     * @param obj The hoversel object
14298     * @return  This will return EINA_TRUE if the hoversel is expanded or
14299     * EINA_FALSE if it is not expanded.
14300     */
14301    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14302    /**
14303     * @brief This will remove all the children items from the hoversel.
14304     *
14305     * @param obj The hoversel object
14306     *
14307     * @warning Should @b not be called while the hoversel is active; use
14308     * elm_hoversel_expanded_get() to check first.
14309     *
14310     * @see elm_hoversel_item_del_cb_set()
14311     * @see elm_hoversel_item_del()
14312     */
14313    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14314    /**
14315     * @brief Get the list of items within the given hoversel.
14316     *
14317     * @param obj The hoversel object
14318     * @return Returns a list of Elm_Hoversel_Item*
14319     *
14320     * @see elm_hoversel_item_add()
14321     */
14322    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14323    /**
14324     * @brief Add an item to the hoversel button
14325     *
14326     * @param obj The hoversel object
14327     * @param label The text label to use for the item (NULL if not desired)
14328     * @param icon_file An image file path on disk to use for the icon or standard
14329     * icon name (NULL if not desired)
14330     * @param icon_type The icon type if relevant
14331     * @param func Convenience function to call when this item is selected
14332     * @param data Data to pass to item-related functions
14333     * @return A handle to the item added.
14334     *
14335     * This adds an item to the hoversel to show when it is clicked. Note: if you
14336     * need to use an icon from an edje file then use
14337     * elm_hoversel_item_icon_set() right after the this function, and set
14338     * icon_file to NULL here.
14339     *
14340     * For more information on what @p icon_file and @p icon_type are see the
14341     * @ref Icon "icon documentation".
14342     */
14343    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);
14344    /**
14345     * @brief Delete an item from the hoversel
14346     *
14347     * @param item The item to delete
14348     *
14349     * This deletes the item from the hoversel (should not be called while the
14350     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14351     *
14352     * @see elm_hoversel_item_add()
14353     * @see elm_hoversel_item_del_cb_set()
14354     */
14355    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14356    /**
14357     * @brief Set the function to be called when an item from the hoversel is
14358     * freed.
14359     *
14360     * @param item The item to set the callback on
14361     * @param func The function called
14362     *
14363     * That function will receive these parameters:
14364     * @li void *item_data
14365     * @li Evas_Object *the_item_object
14366     * @li Elm_Hoversel_Item *the_object_struct
14367     *
14368     * @see elm_hoversel_item_add()
14369     */
14370    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14371    /**
14372     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14373     * that will be passed to associated function callbacks.
14374     *
14375     * @param item The item to get the data from
14376     * @return The data pointer set with elm_hoversel_item_add()
14377     *
14378     * @see elm_hoversel_item_add()
14379     */
14380    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14381    /**
14382     * @brief This returns the label text of the given hoversel item.
14383     *
14384     * @param item The item to get the label
14385     * @return The label text of the hoversel item
14386     *
14387     * @see elm_hoversel_item_add()
14388     */
14389    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14390    /**
14391     * @brief This sets the icon for the given hoversel item.
14392     *
14393     * @param item The item to set the icon
14394     * @param icon_file An image file path on disk to use for the icon or standard
14395     * icon name
14396     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14397     * to NULL if the icon is not an edje file
14398     * @param icon_type The icon type
14399     *
14400     * The icon can be loaded from the standard set, from an image file, or from
14401     * an edje file.
14402     *
14403     * @see elm_hoversel_item_add()
14404     */
14405    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);
14406    /**
14407     * @brief Get the icon object of the hoversel item
14408     *
14409     * @param item The item to get the icon from
14410     * @param icon_file The image file path on disk used for the icon or standard
14411     * icon name
14412     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14413     * if the icon is not an edje file
14414     * @param icon_type The icon type
14415     *
14416     * @see elm_hoversel_item_icon_set()
14417     * @see elm_hoversel_item_add()
14418     */
14419    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);
14420    /**
14421     * @}
14422     */
14423
14424    /**
14425     * @defgroup Toolbar Toolbar
14426     * @ingroup Elementary
14427     *
14428     * @image html img/widget/toolbar/preview-00.png
14429     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14430     *
14431     * @image html img/toolbar.png
14432     * @image latex img/toolbar.eps width=\textwidth
14433     *
14434     * A toolbar is a widget that displays a list of items inside
14435     * a box. It can be scrollable, show a menu with items that don't fit
14436     * to toolbar size or even crop them.
14437     *
14438     * Only one item can be selected at a time.
14439     *
14440     * Items can have multiple states, or show menus when selected by the user.
14441     *
14442     * Smart callbacks one can listen to:
14443     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14444     * - "language,changed" - when the program language changes
14445     *
14446     * Available styles for it:
14447     * - @c "default"
14448     * - @c "transparent" - no background or shadow, just show the content
14449     *
14450     * List of examples:
14451     * @li @ref toolbar_example_01
14452     * @li @ref toolbar_example_02
14453     * @li @ref toolbar_example_03
14454     */
14455
14456    /**
14457     * @addtogroup Toolbar
14458     * @{
14459     */
14460
14461    /**
14462     * @enum _Elm_Toolbar_Shrink_Mode
14463     * @typedef Elm_Toolbar_Shrink_Mode
14464     *
14465     * Set toolbar's items display behavior, it can be scrollabel,
14466     * show a menu with exceeding items, or simply hide them.
14467     *
14468     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14469     * from elm config.
14470     *
14471     * Values <b> don't </b> work as bitmask, only one can be choosen.
14472     *
14473     * @see elm_toolbar_mode_shrink_set()
14474     * @see elm_toolbar_mode_shrink_get()
14475     *
14476     * @ingroup Toolbar
14477     */
14478    typedef enum _Elm_Toolbar_Shrink_Mode
14479      {
14480         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14481         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14482         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14483         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14484         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14485      } Elm_Toolbar_Shrink_Mode;
14486
14487    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(). */
14488
14489    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(). */
14490
14491    /**
14492     * Add a new toolbar widget to the given parent Elementary
14493     * (container) object.
14494     *
14495     * @param parent The parent object.
14496     * @return a new toolbar widget handle or @c NULL, on errors.
14497     *
14498     * This function inserts a new toolbar widget on the canvas.
14499     *
14500     * @ingroup Toolbar
14501     */
14502    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14503
14504    /**
14505     * Set the icon size, in pixels, to be used by toolbar items.
14506     *
14507     * @param obj The toolbar object
14508     * @param icon_size The icon size in pixels
14509     *
14510     * @note Default value is @c 32. It reads value from elm config.
14511     *
14512     * @see elm_toolbar_icon_size_get()
14513     *
14514     * @ingroup Toolbar
14515     */
14516    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14517
14518    /**
14519     * Get the icon size, in pixels, to be used by toolbar items.
14520     *
14521     * @param obj The toolbar object.
14522     * @return The icon size in pixels.
14523     *
14524     * @see elm_toolbar_icon_size_set() for details.
14525     *
14526     * @ingroup Toolbar
14527     */
14528    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14529
14530    /**
14531     * Sets icon lookup order, for toolbar items' icons.
14532     *
14533     * @param obj The toolbar object.
14534     * @param order The icon lookup order.
14535     *
14536     * Icons added before calling this function will not be affected.
14537     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14538     *
14539     * @see elm_toolbar_icon_order_lookup_get()
14540     *
14541     * @ingroup Toolbar
14542     */
14543    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14544
14545    /**
14546     * Gets the icon lookup order.
14547     *
14548     * @param obj The toolbar object.
14549     * @return The icon lookup order.
14550     *
14551     * @see elm_toolbar_icon_order_lookup_set() for details.
14552     *
14553     * @ingroup Toolbar
14554     */
14555    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14556
14557    /**
14558     * Set whether the toolbar should always have an item selected.
14559     *
14560     * @param obj The toolbar object.
14561     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14562     * disable it.
14563     *
14564     * This will cause the toolbar to always have an item selected, and clicking
14565     * the selected item will not cause a selected event to be emitted. Enabling this mode
14566     * will immediately select the first toolbar item.
14567     *
14568     * Always-selected is disabled by default.
14569     *
14570     * @see elm_toolbar_always_select_mode_get().
14571     *
14572     * @ingroup Toolbar
14573     */
14574    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14575
14576    /**
14577     * Get whether the toolbar should always have an item selected.
14578     *
14579     * @param obj The toolbar object.
14580     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14581     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14582     *
14583     * @see elm_toolbar_always_select_mode_set() for details.
14584     *
14585     * @ingroup Toolbar
14586     */
14587    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14588
14589    /**
14590     * Set whether the toolbar items' should be selected by the user or not.
14591     *
14592     * @param obj The toolbar object.
14593     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14594     * enable it.
14595     *
14596     * This will turn off the ability to select items entirely and they will
14597     * neither appear selected nor emit selected signals. The clicked
14598     * callback function will still be called.
14599     *
14600     * Selection is enabled by default.
14601     *
14602     * @see elm_toolbar_no_select_mode_get().
14603     *
14604     * @ingroup Toolbar
14605     */
14606    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14607
14608    /**
14609     * Set whether the toolbar items' should be selected by the user or not.
14610     *
14611     * @param obj The toolbar object.
14612     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14613     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14614     *
14615     * @see elm_toolbar_no_select_mode_set() for details.
14616     *
14617     * @ingroup Toolbar
14618     */
14619    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14620
14621    /**
14622     * Append item to the toolbar.
14623     *
14624     * @param obj The toolbar object.
14625     * @param icon A string with icon name or the absolute path of an image file.
14626     * @param label The label of the item.
14627     * @param func The function to call when the item is clicked.
14628     * @param data The data to associate with the item for related callbacks.
14629     * @return The created item or @c NULL upon failure.
14630     *
14631     * A new item will be created and appended to the toolbar, i.e., will
14632     * be set as @b last item.
14633     *
14634     * Items created with this method can be deleted with
14635     * elm_toolbar_item_del().
14636     *
14637     * Associated @p data can be properly freed when item is deleted if a
14638     * callback function is set with elm_toolbar_item_del_cb_set().
14639     *
14640     * If a function is passed as argument, it will be called everytime this item
14641     * is selected, i.e., the user clicks over an unselected item.
14642     * If such function isn't needed, just passing
14643     * @c NULL as @p func is enough. The same should be done for @p data.
14644     *
14645     * Toolbar will load icon image from fdo or current theme.
14646     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14647     * If an absolute path is provided it will load it direct from a file.
14648     *
14649     * @see elm_toolbar_item_icon_set()
14650     * @see elm_toolbar_item_del()
14651     * @see elm_toolbar_item_del_cb_set()
14652     *
14653     * @ingroup Toolbar
14654     */
14655    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);
14656
14657    /**
14658     * Prepend item to the toolbar.
14659     *
14660     * @param obj The toolbar object.
14661     * @param icon A string with icon name or the absolute path of an image file.
14662     * @param label The label of the item.
14663     * @param func The function to call when the item is clicked.
14664     * @param data The data to associate with the item for related callbacks.
14665     * @return The created item or @c NULL upon failure.
14666     *
14667     * A new item will be created and prepended to the toolbar, i.e., will
14668     * be set as @b first item.
14669     *
14670     * Items created with this method can be deleted with
14671     * elm_toolbar_item_del().
14672     *
14673     * Associated @p data can be properly freed when item is deleted if a
14674     * callback function is set with elm_toolbar_item_del_cb_set().
14675     *
14676     * If a function is passed as argument, it will be called everytime this item
14677     * is selected, i.e., the user clicks over an unselected item.
14678     * If such function isn't needed, just passing
14679     * @c NULL as @p func is enough. The same should be done for @p data.
14680     *
14681     * Toolbar will load icon image from fdo or current theme.
14682     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14683     * If an absolute path is provided it will load it direct from a file.
14684     *
14685     * @see elm_toolbar_item_icon_set()
14686     * @see elm_toolbar_item_del()
14687     * @see elm_toolbar_item_del_cb_set()
14688     *
14689     * @ingroup Toolbar
14690     */
14691    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);
14692
14693    /**
14694     * Insert a new item into the toolbar object before item @p before.
14695     *
14696     * @param obj The toolbar object.
14697     * @param before The toolbar item to insert before.
14698     * @param icon A string with icon name or the absolute path of an image file.
14699     * @param label The label of the item.
14700     * @param func The function to call when the item is clicked.
14701     * @param data The data to associate with the item for related callbacks.
14702     * @return The created item or @c NULL upon failure.
14703     *
14704     * A new item will be created and added to the toolbar. Its position in
14705     * this toolbar will be just before item @p before.
14706     *
14707     * Items created with this method can be deleted with
14708     * elm_toolbar_item_del().
14709     *
14710     * Associated @p data can be properly freed when item is deleted if a
14711     * callback function is set with elm_toolbar_item_del_cb_set().
14712     *
14713     * If a function is passed as argument, it will be called everytime this item
14714     * is selected, i.e., the user clicks over an unselected item.
14715     * If such function isn't needed, just passing
14716     * @c NULL as @p func is enough. The same should be done for @p data.
14717     *
14718     * Toolbar will load icon image from fdo or current theme.
14719     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14720     * If an absolute path is provided it will load it direct from a file.
14721     *
14722     * @see elm_toolbar_item_icon_set()
14723     * @see elm_toolbar_item_del()
14724     * @see elm_toolbar_item_del_cb_set()
14725     *
14726     * @ingroup Toolbar
14727     */
14728    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);
14729
14730    /**
14731     * Insert a new item into the toolbar object after item @p after.
14732     *
14733     * @param obj The toolbar object.
14734     * @param after The toolbar item to insert after.
14735     * @param icon A string with icon name or the absolute path of an image file.
14736     * @param label The label of the item.
14737     * @param func The function to call when the item is clicked.
14738     * @param data The data to associate with the item for related callbacks.
14739     * @return The created item or @c NULL upon failure.
14740     *
14741     * A new item will be created and added to the toolbar. Its position in
14742     * this toolbar will be just after item @p after.
14743     *
14744     * Items created with this method can be deleted with
14745     * elm_toolbar_item_del().
14746     *
14747     * Associated @p data can be properly freed when item is deleted if a
14748     * callback function is set with elm_toolbar_item_del_cb_set().
14749     *
14750     * If a function is passed as argument, it will be called everytime this item
14751     * is selected, i.e., the user clicks over an unselected item.
14752     * If such function isn't needed, just passing
14753     * @c NULL as @p func is enough. The same should be done for @p data.
14754     *
14755     * Toolbar will load icon image from fdo or current theme.
14756     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14757     * If an absolute path is provided it will load it direct from a file.
14758     *
14759     * @see elm_toolbar_item_icon_set()
14760     * @see elm_toolbar_item_del()
14761     * @see elm_toolbar_item_del_cb_set()
14762     *
14763     * @ingroup Toolbar
14764     */
14765    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);
14766
14767    /**
14768     * Get the first item in the given toolbar widget's list of
14769     * items.
14770     *
14771     * @param obj The toolbar object
14772     * @return The first item or @c NULL, if it has no items (and on
14773     * errors)
14774     *
14775     * @see elm_toolbar_item_append()
14776     * @see elm_toolbar_last_item_get()
14777     *
14778     * @ingroup Toolbar
14779     */
14780    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14781
14782    /**
14783     * Get the last item in the given toolbar widget's list of
14784     * items.
14785     *
14786     * @param obj The toolbar object
14787     * @return The last item or @c NULL, if it has no items (and on
14788     * errors)
14789     *
14790     * @see elm_toolbar_item_prepend()
14791     * @see elm_toolbar_first_item_get()
14792     *
14793     * @ingroup Toolbar
14794     */
14795    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14796
14797    /**
14798     * Get the item after @p item in toolbar.
14799     *
14800     * @param item The toolbar item.
14801     * @return The item after @p item, or @c NULL if none or on failure.
14802     *
14803     * @note If it is the last item, @c NULL will be returned.
14804     *
14805     * @see elm_toolbar_item_append()
14806     *
14807     * @ingroup Toolbar
14808     */
14809    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14810
14811    /**
14812     * Get the item before @p item in toolbar.
14813     *
14814     * @param item The toolbar item.
14815     * @return The item before @p item, or @c NULL if none or on failure.
14816     *
14817     * @note If it is the first item, @c NULL will be returned.
14818     *
14819     * @see elm_toolbar_item_prepend()
14820     *
14821     * @ingroup Toolbar
14822     */
14823    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14824
14825    /**
14826     * Get the toolbar object from an item.
14827     *
14828     * @param item The item.
14829     * @return The toolbar object.
14830     *
14831     * This returns the toolbar object itself that an item belongs to.
14832     *
14833     * @ingroup Toolbar
14834     */
14835    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14836
14837    /**
14838     * Set the priority of a toolbar item.
14839     *
14840     * @param item The toolbar item.
14841     * @param priority The item priority. The default is zero.
14842     *
14843     * This is used only when the toolbar shrink mode is set to
14844     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14845     * When space is less than required, items with low priority
14846     * will be removed from the toolbar and added to a dynamically-created menu,
14847     * while items with higher priority will remain on the toolbar,
14848     * with the same order they were added.
14849     *
14850     * @see elm_toolbar_item_priority_get()
14851     *
14852     * @ingroup Toolbar
14853     */
14854    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14855
14856    /**
14857     * Get the priority of a toolbar item.
14858     *
14859     * @param item The toolbar item.
14860     * @return The @p item priority, or @c 0 on failure.
14861     *
14862     * @see elm_toolbar_item_priority_set() for details.
14863     *
14864     * @ingroup Toolbar
14865     */
14866    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14867
14868    /**
14869     * Get the label of item.
14870     *
14871     * @param item The item of toolbar.
14872     * @return The label of item.
14873     *
14874     * The return value is a pointer to the label associated to @p item when
14875     * it was created, with function elm_toolbar_item_append() or similar,
14876     * or later,
14877     * with function elm_toolbar_item_label_set. If no label
14878     * was passed as argument, it will return @c NULL.
14879     *
14880     * @see elm_toolbar_item_label_set() for more details.
14881     * @see elm_toolbar_item_append()
14882     *
14883     * @ingroup Toolbar
14884     */
14885    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14886
14887    /**
14888     * Set the label of item.
14889     *
14890     * @param item The item of toolbar.
14891     * @param text The label of item.
14892     *
14893     * The label to be displayed by the item.
14894     * Label will be placed at icons bottom (if set).
14895     *
14896     * If a label was passed as argument on item creation, with function
14897     * elm_toolbar_item_append() or similar, it will be already
14898     * displayed by the item.
14899     *
14900     * @see elm_toolbar_item_label_get()
14901     * @see elm_toolbar_item_append()
14902     *
14903     * @ingroup Toolbar
14904     */
14905    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14906
14907    /**
14908     * Return the data associated with a given toolbar widget item.
14909     *
14910     * @param item The toolbar widget item handle.
14911     * @return The data associated with @p item.
14912     *
14913     * @see elm_toolbar_item_data_set()
14914     *
14915     * @ingroup Toolbar
14916     */
14917    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14918
14919    /**
14920     * Set the data associated with a given toolbar widget item.
14921     *
14922     * @param item The toolbar widget item handle.
14923     * @param data The new data pointer to set to @p item.
14924     *
14925     * This sets new item data on @p item.
14926     *
14927     * @warning The old data pointer won't be touched by this function, so
14928     * the user had better to free that old data himself/herself.
14929     *
14930     * @ingroup Toolbar
14931     */
14932    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14933
14934    /**
14935     * Returns a pointer to a toolbar item by its label.
14936     *
14937     * @param obj The toolbar object.
14938     * @param label The label of the item to find.
14939     *
14940     * @return The pointer to the toolbar item matching @p label or @c NULL
14941     * on failure.
14942     *
14943     * @ingroup Toolbar
14944     */
14945    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14946
14947    /*
14948     * Get whether the @p item is selected or not.
14949     *
14950     * @param item The toolbar item.
14951     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14952     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14953     *
14954     * @see elm_toolbar_selected_item_set() for details.
14955     * @see elm_toolbar_item_selected_get()
14956     *
14957     * @ingroup Toolbar
14958     */
14959    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14960
14961    /**
14962     * Set the selected state of an item.
14963     *
14964     * @param item The toolbar item
14965     * @param selected The selected state
14966     *
14967     * This sets the selected state of the given item @p it.
14968     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14969     *
14970     * If a new item is selected the previosly selected will be unselected.
14971     * Previoulsy selected item can be get with function
14972     * elm_toolbar_selected_item_get().
14973     *
14974     * Selected items will be highlighted.
14975     *
14976     * @see elm_toolbar_item_selected_get()
14977     * @see elm_toolbar_selected_item_get()
14978     *
14979     * @ingroup Toolbar
14980     */
14981    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14982
14983    /**
14984     * Get the selected item.
14985     *
14986     * @param obj The toolbar object.
14987     * @return The selected toolbar item.
14988     *
14989     * The selected item can be unselected with function
14990     * elm_toolbar_item_selected_set().
14991     *
14992     * The selected item always will be highlighted on toolbar.
14993     *
14994     * @see elm_toolbar_selected_items_get()
14995     *
14996     * @ingroup Toolbar
14997     */
14998    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14999
15000    /**
15001     * Set the icon associated with @p item.
15002     *
15003     * @param obj The parent of this item.
15004     * @param item The toolbar item.
15005     * @param icon A string with icon name or the absolute path of an image file.
15006     *
15007     * Toolbar will load icon image from fdo or current theme.
15008     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15009     * If an absolute path is provided it will load it direct from a file.
15010     *
15011     * @see elm_toolbar_icon_order_lookup_set()
15012     * @see elm_toolbar_icon_order_lookup_get()
15013     *
15014     * @ingroup Toolbar
15015     */
15016    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15017
15018    /**
15019     * Get the string used to set the icon of @p item.
15020     *
15021     * @param item The toolbar item.
15022     * @return The string associated with the icon object.
15023     *
15024     * @see elm_toolbar_item_icon_set() for details.
15025     *
15026     * @ingroup Toolbar
15027     */
15028    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15029
15030    /**
15031     * Get the object of @p item.
15032     *
15033     * @param item The toolbar item.
15034     * @return The object
15035     *
15036     * @ingroup Toolbar
15037     */
15038    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15039
15040    /**
15041     * Get the icon object of @p item.
15042     *
15043     * @param item The toolbar item.
15044     * @return The icon object
15045     *
15046     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15047     *
15048     * @ingroup Toolbar
15049     */
15050    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15051
15052    /**
15053     * Set the icon associated with @p item to an image in a binary buffer.
15054     *
15055     * @param item The toolbar item.
15056     * @param img The binary data that will be used as an image
15057     * @param size The size of binary data @p img
15058     * @param format Optional format of @p img to pass to the image loader
15059     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15060     *
15061     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15062     *
15063     * @note The icon image set by this function can be changed by
15064     * elm_toolbar_item_icon_set().
15065     * 
15066     * @ingroup Toolbar
15067     */
15068    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);
15069
15070    /**
15071     * Delete them item from the toolbar.
15072     *
15073     * @param item The item of toolbar to be deleted.
15074     *
15075     * @see elm_toolbar_item_append()
15076     * @see elm_toolbar_item_del_cb_set()
15077     *
15078     * @ingroup Toolbar
15079     */
15080    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15081
15082    /**
15083     * Set the function called when a toolbar item is freed.
15084     *
15085     * @param item The item to set the callback on.
15086     * @param func The function called.
15087     *
15088     * If there is a @p func, then it will be called prior item's memory release.
15089     * That will be called with the following arguments:
15090     * @li item's data;
15091     * @li item's Evas object;
15092     * @li item itself;
15093     *
15094     * This way, a data associated to a toolbar item could be properly freed.
15095     *
15096     * @ingroup Toolbar
15097     */
15098    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15099
15100    /**
15101     * Get a value whether toolbar item is disabled or not.
15102     *
15103     * @param item The item.
15104     * @return The disabled state.
15105     *
15106     * @see elm_toolbar_item_disabled_set() for more details.
15107     *
15108     * @ingroup Toolbar
15109     */
15110    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15111
15112    /**
15113     * Sets the disabled/enabled state of a toolbar item.
15114     *
15115     * @param item The item.
15116     * @param disabled The disabled state.
15117     *
15118     * A disabled item cannot be selected or unselected. It will also
15119     * change its appearance (generally greyed out). This sets the
15120     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15121     * enabled).
15122     *
15123     * @ingroup Toolbar
15124     */
15125    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15126
15127    /**
15128     * Set or unset item as a separator.
15129     *
15130     * @param item The toolbar item.
15131     * @param setting @c EINA_TRUE to set item @p item as separator or
15132     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15133     *
15134     * Items aren't set as separator by default.
15135     *
15136     * If set as separator it will display separator theme, so won't display
15137     * icons or label.
15138     *
15139     * @see elm_toolbar_item_separator_get()
15140     *
15141     * @ingroup Toolbar
15142     */
15143    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15144
15145    /**
15146     * Get a value whether item is a separator or not.
15147     *
15148     * @param item The toolbar item.
15149     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15150     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15151     *
15152     * @see elm_toolbar_item_separator_set() for details.
15153     *
15154     * @ingroup Toolbar
15155     */
15156    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15157
15158    /**
15159     * Set the shrink state of toolbar @p obj.
15160     *
15161     * @param obj The toolbar object.
15162     * @param shrink_mode Toolbar's items display behavior.
15163     *
15164     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15165     * but will enforce a minimun size so all the items will fit, won't scroll
15166     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15167     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15168     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15169     *
15170     * @ingroup Toolbar
15171     */
15172    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15173
15174    /**
15175     * Get the shrink mode of toolbar @p obj.
15176     *
15177     * @param obj The toolbar object.
15178     * @return Toolbar's items display behavior.
15179     *
15180     * @see elm_toolbar_mode_shrink_set() for details.
15181     *
15182     * @ingroup Toolbar
15183     */
15184    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15185
15186    /**
15187     * Enable/disable homogenous mode.
15188     *
15189     * @param obj The toolbar object
15190     * @param homogeneous Assume the items within the toolbar are of the
15191     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15192     *
15193     * This will enable the homogeneous mode where items are of the same size.
15194     * @see elm_toolbar_homogeneous_get()
15195     *
15196     * @ingroup Toolbar
15197     */
15198    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15199
15200    /**
15201     * Get whether the homogenous mode is enabled.
15202     *
15203     * @param obj The toolbar object.
15204     * @return Assume the items within the toolbar are of the same height
15205     * and width (EINA_TRUE = on, EINA_FALSE = off).
15206     *
15207     * @see elm_toolbar_homogeneous_set()
15208     *
15209     * @ingroup Toolbar
15210     */
15211    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15212
15213    /**
15214     * Enable/disable homogenous mode.
15215     *
15216     * @param obj The toolbar object
15217     * @param homogeneous Assume the items within the toolbar are of the
15218     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15219     *
15220     * This will enable the homogeneous mode where items are of the same size.
15221     * @see elm_toolbar_homogeneous_get()
15222     *
15223     * @deprecated use elm_toolbar_homogeneous_set() instead.
15224     *
15225     * @ingroup Toolbar
15226     */
15227    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15228
15229    /**
15230     * Get whether the homogenous mode is enabled.
15231     *
15232     * @param obj The toolbar object.
15233     * @return Assume the items within the toolbar are of the same height
15234     * and width (EINA_TRUE = on, EINA_FALSE = off).
15235     *
15236     * @see elm_toolbar_homogeneous_set()
15237     * @deprecated use elm_toolbar_homogeneous_get() instead.
15238     *
15239     * @ingroup Toolbar
15240     */
15241    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15242
15243    /**
15244     * Set the parent object of the toolbar items' menus.
15245     *
15246     * @param obj The toolbar object.
15247     * @param parent The parent of the menu objects.
15248     *
15249     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15250     *
15251     * For more details about setting the parent for toolbar menus, see
15252     * elm_menu_parent_set().
15253     *
15254     * @see elm_menu_parent_set() for details.
15255     * @see elm_toolbar_item_menu_set() for details.
15256     *
15257     * @ingroup Toolbar
15258     */
15259    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15260
15261    /**
15262     * Get the parent object of the toolbar items' menus.
15263     *
15264     * @param obj The toolbar object.
15265     * @return The parent of the menu objects.
15266     *
15267     * @see elm_toolbar_menu_parent_set() for details.
15268     *
15269     * @ingroup Toolbar
15270     */
15271    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15272
15273    /**
15274     * Set the alignment of the items.
15275     *
15276     * @param obj The toolbar object.
15277     * @param align The new alignment, a float between <tt> 0.0 </tt>
15278     * and <tt> 1.0 </tt>.
15279     *
15280     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15281     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15282     * items.
15283     *
15284     * Centered items by default.
15285     *
15286     * @see elm_toolbar_align_get()
15287     *
15288     * @ingroup Toolbar
15289     */
15290    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15291
15292    /**
15293     * Get the alignment of the items.
15294     *
15295     * @param obj The toolbar object.
15296     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15297     * <tt> 1.0 </tt>.
15298     *
15299     * @see elm_toolbar_align_set() for details.
15300     *
15301     * @ingroup Toolbar
15302     */
15303    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15304
15305    /**
15306     * Set whether the toolbar item opens a menu.
15307     *
15308     * @param item The toolbar item.
15309     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15310     *
15311     * A toolbar item can be set to be a menu, using this function.
15312     *
15313     * Once it is set to be a menu, it can be manipulated through the
15314     * menu-like function elm_toolbar_menu_parent_set() and the other
15315     * elm_menu functions, using the Evas_Object @c menu returned by
15316     * elm_toolbar_item_menu_get().
15317     *
15318     * So, items to be displayed in this item's menu should be added with
15319     * elm_menu_item_add().
15320     *
15321     * The following code exemplifies the most basic usage:
15322     * @code
15323     * tb = elm_toolbar_add(win)
15324     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15325     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15326     * elm_toolbar_menu_parent_set(tb, win);
15327     * menu = elm_toolbar_item_menu_get(item);
15328     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15329     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15330     * NULL);
15331     * @endcode
15332     *
15333     * @see elm_toolbar_item_menu_get()
15334     *
15335     * @ingroup Toolbar
15336     */
15337    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15338
15339    /**
15340     * Get toolbar item's menu.
15341     *
15342     * @param item The toolbar item.
15343     * @return Item's menu object or @c NULL on failure.
15344     *
15345     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15346     * this function will set it.
15347     *
15348     * @see elm_toolbar_item_menu_set() for details.
15349     *
15350     * @ingroup Toolbar
15351     */
15352    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15353
15354    /**
15355     * Add a new state to @p item.
15356     *
15357     * @param item The item.
15358     * @param icon A string with icon name or the absolute path of an image file.
15359     * @param label The label of the new state.
15360     * @param func The function to call when the item is clicked when this
15361     * state is selected.
15362     * @param data The data to associate with the state.
15363     * @return The toolbar item state, or @c NULL upon failure.
15364     *
15365     * Toolbar will load icon image from fdo or current theme.
15366     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15367     * If an absolute path is provided it will load it direct from a file.
15368     *
15369     * States created with this function can be removed with
15370     * elm_toolbar_item_state_del().
15371     *
15372     * @see elm_toolbar_item_state_del()
15373     * @see elm_toolbar_item_state_sel()
15374     * @see elm_toolbar_item_state_get()
15375     *
15376     * @ingroup Toolbar
15377     */
15378    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);
15379
15380    /**
15381     * Delete a previoulsy added state to @p item.
15382     *
15383     * @param item The toolbar item.
15384     * @param state The state to be deleted.
15385     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15386     *
15387     * @see elm_toolbar_item_state_add()
15388     */
15389    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15390
15391    /**
15392     * Set @p state as the current state of @p it.
15393     *
15394     * @param it The item.
15395     * @param state The state to use.
15396     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15397     *
15398     * If @p state is @c NULL, it won't select any state and the default item's
15399     * icon and label will be used. It's the same behaviour than
15400     * elm_toolbar_item_state_unser().
15401     *
15402     * @see elm_toolbar_item_state_unset()
15403     *
15404     * @ingroup Toolbar
15405     */
15406    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15407
15408    /**
15409     * Unset the state of @p it.
15410     *
15411     * @param it The item.
15412     *
15413     * The default icon and label from this item will be displayed.
15414     *
15415     * @see elm_toolbar_item_state_set() for more details.
15416     *
15417     * @ingroup Toolbar
15418     */
15419    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15420
15421    /**
15422     * Get the current state of @p it.
15423     *
15424     * @param item The item.
15425     * @return The selected state or @c NULL if none is selected or on failure.
15426     *
15427     * @see elm_toolbar_item_state_set() for details.
15428     * @see elm_toolbar_item_state_unset()
15429     * @see elm_toolbar_item_state_add()
15430     *
15431     * @ingroup Toolbar
15432     */
15433    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15434
15435    /**
15436     * Get the state after selected state in toolbar's @p item.
15437     *
15438     * @param it The toolbar item to change state.
15439     * @return The state after current state, or @c NULL on failure.
15440     *
15441     * If last state is selected, this function will return first state.
15442     *
15443     * @see elm_toolbar_item_state_set()
15444     * @see elm_toolbar_item_state_add()
15445     *
15446     * @ingroup Toolbar
15447     */
15448    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15449
15450    /**
15451     * Get the state before selected state in toolbar's @p item.
15452     *
15453     * @param it The toolbar item to change state.
15454     * @return The state before current state, or @c NULL on failure.
15455     *
15456     * If first state is selected, this function will return last state.
15457     *
15458     * @see elm_toolbar_item_state_set()
15459     * @see elm_toolbar_item_state_add()
15460     *
15461     * @ingroup Toolbar
15462     */
15463    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15464
15465    /**
15466     * Set the text to be shown in a given toolbar item's tooltips.
15467     *
15468     * @param item Target item.
15469     * @param text The text to set in the content.
15470     *
15471     * Setup the text as tooltip to object. The item can have only one tooltip,
15472     * so any previous tooltip data - set with this function or
15473     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15474     *
15475     * @see elm_object_tooltip_text_set() for more details.
15476     *
15477     * @ingroup Toolbar
15478     */
15479    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15480
15481    /**
15482     * Set the content to be shown in the tooltip item.
15483     *
15484     * Setup the tooltip to item. The item can have only one tooltip,
15485     * so any previous tooltip data is removed. @p func(with @p data) will
15486     * be called every time that need show the tooltip and it should
15487     * return a valid Evas_Object. This object is then managed fully by
15488     * tooltip system and is deleted when the tooltip is gone.
15489     *
15490     * @param item the toolbar item being attached a tooltip.
15491     * @param func the function used to create the tooltip contents.
15492     * @param data what to provide to @a func as callback data/context.
15493     * @param del_cb called when data is not needed anymore, either when
15494     *        another callback replaces @a func, the tooltip is unset with
15495     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15496     *        dies. This callback receives as the first parameter the
15497     *        given @a data, and @c event_info is the item.
15498     *
15499     * @see elm_object_tooltip_content_cb_set() for more details.
15500     *
15501     * @ingroup Toolbar
15502     */
15503    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);
15504
15505    /**
15506     * Unset tooltip from item.
15507     *
15508     * @param item toolbar item to remove previously set tooltip.
15509     *
15510     * Remove tooltip from item. The callback provided as del_cb to
15511     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15512     * it is not used anymore.
15513     *
15514     * @see elm_object_tooltip_unset() for more details.
15515     * @see elm_toolbar_item_tooltip_content_cb_set()
15516     *
15517     * @ingroup Toolbar
15518     */
15519    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15520
15521    /**
15522     * Sets a different style for this item tooltip.
15523     *
15524     * @note before you set a style you should define a tooltip with
15525     *       elm_toolbar_item_tooltip_content_cb_set() or
15526     *       elm_toolbar_item_tooltip_text_set()
15527     *
15528     * @param item toolbar item with tooltip already set.
15529     * @param style the theme style to use (default, transparent, ...)
15530     *
15531     * @see elm_object_tooltip_style_set() for more details.
15532     *
15533     * @ingroup Toolbar
15534     */
15535    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15536
15537    /**
15538     * Get the style for this item tooltip.
15539     *
15540     * @param item toolbar item with tooltip already set.
15541     * @return style the theme style in use, defaults to "default". If the
15542     *         object does not have a tooltip set, then NULL is returned.
15543     *
15544     * @see elm_object_tooltip_style_get() for more details.
15545     * @see elm_toolbar_item_tooltip_style_set()
15546     *
15547     * @ingroup Toolbar
15548     */
15549    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15550
15551    /**
15552     * Set the type of mouse pointer/cursor decoration to be shown,
15553     * when the mouse pointer is over the given toolbar widget item
15554     *
15555     * @param item toolbar item to customize cursor on
15556     * @param cursor the cursor type's name
15557     *
15558     * This function works analogously as elm_object_cursor_set(), but
15559     * here the cursor's changing area is restricted to the item's
15560     * area, and not the whole widget's. Note that that item cursors
15561     * have precedence over widget cursors, so that a mouse over an
15562     * item with custom cursor set will always show @b that cursor.
15563     *
15564     * If this function is called twice for an object, a previously set
15565     * cursor will be unset on the second call.
15566     *
15567     * @see elm_object_cursor_set()
15568     * @see elm_toolbar_item_cursor_get()
15569     * @see elm_toolbar_item_cursor_unset()
15570     *
15571     * @ingroup Toolbar
15572     */
15573    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15574
15575    /*
15576     * Get the type of mouse pointer/cursor decoration set to be shown,
15577     * when the mouse pointer is over the given toolbar widget item
15578     *
15579     * @param item toolbar item with custom cursor set
15580     * @return the cursor type's name or @c NULL, if no custom cursors
15581     * were set to @p item (and on errors)
15582     *
15583     * @see elm_object_cursor_get()
15584     * @see elm_toolbar_item_cursor_set()
15585     * @see elm_toolbar_item_cursor_unset()
15586     *
15587     * @ingroup Toolbar
15588     */
15589    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15590
15591    /**
15592     * Unset any custom mouse pointer/cursor decoration set to be
15593     * shown, when the mouse pointer is over the given toolbar widget
15594     * item, thus making it show the @b default cursor again.
15595     *
15596     * @param item a toolbar item
15597     *
15598     * Use this call to undo any custom settings on this item's cursor
15599     * decoration, bringing it back to defaults (no custom style set).
15600     *
15601     * @see elm_object_cursor_unset()
15602     * @see elm_toolbar_item_cursor_set()
15603     *
15604     * @ingroup Toolbar
15605     */
15606    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15607
15608    /**
15609     * Set a different @b style for a given custom cursor set for a
15610     * toolbar item.
15611     *
15612     * @param item toolbar item with custom cursor set
15613     * @param style the <b>theme style</b> to use (e.g. @c "default",
15614     * @c "transparent", etc)
15615     *
15616     * This function only makes sense when one is using custom mouse
15617     * cursor decorations <b>defined in a theme file</b>, which can have,
15618     * given a cursor name/type, <b>alternate styles</b> on it. It
15619     * works analogously as elm_object_cursor_style_set(), but here
15620     * applyed only to toolbar item objects.
15621     *
15622     * @warning Before you set a cursor style you should have definen a
15623     *       custom cursor previously on the item, with
15624     *       elm_toolbar_item_cursor_set()
15625     *
15626     * @see elm_toolbar_item_cursor_engine_only_set()
15627     * @see elm_toolbar_item_cursor_style_get()
15628     *
15629     * @ingroup Toolbar
15630     */
15631    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15632
15633    /**
15634     * Get the current @b style set for a given toolbar item's custom
15635     * cursor
15636     *
15637     * @param item toolbar item with custom cursor set.
15638     * @return style the cursor style in use. If the object does not
15639     *         have a cursor set, then @c NULL is returned.
15640     *
15641     * @see elm_toolbar_item_cursor_style_set() for more details
15642     *
15643     * @ingroup Toolbar
15644     */
15645    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15646
15647    /**
15648     * Set if the (custom)cursor for a given toolbar item should be
15649     * searched in its theme, also, or should only rely on the
15650     * rendering engine.
15651     *
15652     * @param item item with custom (custom) cursor already set on
15653     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15654     * only on those provided by the rendering engine, @c EINA_FALSE to
15655     * have them searched on the widget's theme, as well.
15656     *
15657     * @note This call is of use only if you've set a custom cursor
15658     * for toolbar items, with elm_toolbar_item_cursor_set().
15659     *
15660     * @note By default, cursors will only be looked for between those
15661     * provided by the rendering engine.
15662     *
15663     * @ingroup Toolbar
15664     */
15665    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15666
15667    /**
15668     * Get if the (custom) cursor for a given toolbar item is being
15669     * searched in its theme, also, or is only relying on the rendering
15670     * engine.
15671     *
15672     * @param item a toolbar item
15673     * @return @c EINA_TRUE, if cursors are being looked for only on
15674     * those provided by the rendering engine, @c EINA_FALSE if they
15675     * are being searched on the widget's theme, as well.
15676     *
15677     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15678     *
15679     * @ingroup Toolbar
15680     */
15681    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15682
15683    /**
15684     * Change a toolbar's orientation
15685     * @param obj The toolbar object
15686     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15687     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15688     * @ingroup Toolbar
15689     * @deprecated use elm_toolbar_horizontal_set() instead.
15690     */
15691    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15692
15693    /**
15694     * Change a toolbar's orientation
15695     * @param obj The toolbar object
15696     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15697     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15698     * @ingroup Toolbar
15699     */
15700    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15701
15702    /**
15703     * Get a toolbar's orientation
15704     * @param obj The toolbar object
15705     * @return If @c EINA_TRUE, the toolbar is vertical
15706     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15707     * @ingroup Toolbar
15708     * @deprecated use elm_toolbar_horizontal_get() instead.
15709     */
15710    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15711
15712    /**
15713     * Get a toolbar's orientation
15714     * @param obj The toolbar object
15715     * @return If @c EINA_TRUE, the toolbar is horizontal
15716     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15717     * @ingroup Toolbar
15718     */
15719    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15720    /**
15721     * @}
15722     */
15723
15724    /**
15725     * @defgroup Tooltips Tooltips
15726     *
15727     * The Tooltip is an (internal, for now) smart object used to show a
15728     * content in a frame on mouse hover of objects(or widgets), with
15729     * tips/information about them.
15730     *
15731     * @{
15732     */
15733
15734    EAPI double       elm_tooltip_delay_get(void);
15735    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15736    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15737    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15738    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15739    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15740 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15741    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);
15742    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15743    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15744    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15745    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15746    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15747
15748    /**
15749     * @}
15750     */
15751
15752    /**
15753     * @defgroup Cursors Cursors
15754     *
15755     * The Elementary cursor is an internal smart object used to
15756     * customize the mouse cursor displayed over objects (or
15757     * widgets). In the most common scenario, the cursor decoration
15758     * comes from the graphical @b engine Elementary is running
15759     * on. Those engines may provide different decorations for cursors,
15760     * and Elementary provides functions to choose them (think of X11
15761     * cursors, as an example).
15762     *
15763     * There's also the possibility of, besides using engine provided
15764     * cursors, also use ones coming from Edje theming files. Both
15765     * globally and per widget, Elementary makes it possible for one to
15766     * make the cursors lookup to be held on engines only or on
15767     * Elementary's theme file, too. To set cursor's hot spot,
15768     * two data items should be added to cursor's theme: "hot_x" and
15769     * "hot_y", that are the offset from upper-left corner of the cursor
15770     * (coordinates 0,0).
15771     *
15772     * @{
15773     */
15774
15775    /**
15776     * Set the cursor to be shown when mouse is over the object
15777     *
15778     * Set the cursor that will be displayed when mouse is over the
15779     * object. The object can have only one cursor set to it, so if
15780     * this function is called twice for an object, the previous set
15781     * will be unset.
15782     * If using X cursors, a definition of all the valid cursor names
15783     * is listed on Elementary_Cursors.h. If an invalid name is set
15784     * the default cursor will be used.
15785     *
15786     * @param obj the object being set a cursor.
15787     * @param cursor the cursor name to be used.
15788     *
15789     * @ingroup Cursors
15790     */
15791    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15792
15793    /**
15794     * Get the cursor to be shown when mouse is over the object
15795     *
15796     * @param obj an object with cursor already set.
15797     * @return the cursor name.
15798     *
15799     * @ingroup Cursors
15800     */
15801    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15802
15803    /**
15804     * Unset cursor for object
15805     *
15806     * Unset cursor for object, and set the cursor to default if the mouse
15807     * was over this object.
15808     *
15809     * @param obj Target object
15810     * @see elm_object_cursor_set()
15811     *
15812     * @ingroup Cursors
15813     */
15814    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15815
15816    /**
15817     * Sets a different style for this object cursor.
15818     *
15819     * @note before you set a style you should define a cursor with
15820     *       elm_object_cursor_set()
15821     *
15822     * @param obj an object with cursor already set.
15823     * @param style the theme style to use (default, transparent, ...)
15824     *
15825     * @ingroup Cursors
15826     */
15827    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15828
15829    /**
15830     * Get the style for this object cursor.
15831     *
15832     * @param obj an object with cursor already set.
15833     * @return style the theme style in use, defaults to "default". If the
15834     *         object does not have a cursor set, then NULL is returned.
15835     *
15836     * @ingroup Cursors
15837     */
15838    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15839
15840    /**
15841     * Set if the cursor set should be searched on the theme or should use
15842     * the provided by the engine, only.
15843     *
15844     * @note before you set if should look on theme you should define a cursor
15845     * with elm_object_cursor_set(). By default it will only look for cursors
15846     * provided by the engine.
15847     *
15848     * @param obj an object with cursor already set.
15849     * @param engine_only boolean to define it cursors should be looked only
15850     * between the provided by the engine or searched on widget's theme as well.
15851     *
15852     * @ingroup Cursors
15853     */
15854    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15855
15856    /**
15857     * Get the cursor engine only usage for this object cursor.
15858     *
15859     * @param obj an object with cursor already set.
15860     * @return engine_only boolean to define it cursors should be
15861     * looked only between the provided by the engine or searched on
15862     * widget's theme as well. If the object does not have a cursor
15863     * set, then EINA_FALSE is returned.
15864     *
15865     * @ingroup Cursors
15866     */
15867    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15868
15869    /**
15870     * Get the configured cursor engine only usage
15871     *
15872     * This gets the globally configured exclusive usage of engine cursors.
15873     *
15874     * @return 1 if only engine cursors should be used
15875     * @ingroup Cursors
15876     */
15877    EAPI int          elm_cursor_engine_only_get(void);
15878
15879    /**
15880     * Set the configured cursor engine only usage
15881     *
15882     * This sets the globally configured exclusive usage of engine cursors.
15883     * It won't affect cursors set before changing this value.
15884     *
15885     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15886     * look for them on theme before.
15887     * @return EINA_TRUE if value is valid and setted (0 or 1)
15888     * @ingroup Cursors
15889     */
15890    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15891
15892    /**
15893     * @}
15894     */
15895
15896    /**
15897     * @defgroup Menu Menu
15898     *
15899     * @image html img/widget/menu/preview-00.png
15900     * @image latex img/widget/menu/preview-00.eps
15901     *
15902     * A menu is a list of items displayed above its parent. When the menu is
15903     * showing its parent is darkened. Each item can have a sub-menu. The menu
15904     * object can be used to display a menu on a right click event, in a toolbar,
15905     * anywhere.
15906     *
15907     * Signals that you can add callbacks for are:
15908     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15909     *             event_info is NULL.
15910     *
15911     * @see @ref tutorial_menu
15912     * @{
15913     */
15914    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15915    /**
15916     * @brief Add a new menu to the parent
15917     *
15918     * @param parent The parent object.
15919     * @return The new object or NULL if it cannot be created.
15920     */
15921    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15922    /**
15923     * @brief Set the parent for the given menu widget
15924     *
15925     * @param obj The menu object.
15926     * @param parent The new parent.
15927     */
15928    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15929    /**
15930     * @brief Get the parent for the given menu widget
15931     *
15932     * @param obj The menu object.
15933     * @return The parent.
15934     *
15935     * @see elm_menu_parent_set()
15936     */
15937    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15938    /**
15939     * @brief Move the menu to a new position
15940     *
15941     * @param obj The menu object.
15942     * @param x The new position.
15943     * @param y The new position.
15944     *
15945     * Sets the top-left position of the menu to (@p x,@p y).
15946     *
15947     * @note @p x and @p y coordinates are relative to parent.
15948     */
15949    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15950    /**
15951     * @brief Close a opened menu
15952     *
15953     * @param obj the menu object
15954     * @return void
15955     *
15956     * Hides the menu and all it's sub-menus.
15957     */
15958    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15959    /**
15960     * @brief Returns a list of @p item's items.
15961     *
15962     * @param obj The menu object
15963     * @return An Eina_List* of @p item's items
15964     */
15965    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15966    /**
15967     * @brief Get the Evas_Object of an Elm_Menu_Item
15968     *
15969     * @param item The menu item object.
15970     * @return The edje object containing the swallowed content
15971     *
15972     * @warning Don't manipulate this object!
15973     */
15974    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15975    /**
15976     * @brief Add an item at the end of the given menu widget
15977     *
15978     * @param obj The menu object.
15979     * @param parent The parent menu item (optional)
15980     * @param icon A icon display on the item. The icon will be destryed by the menu.
15981     * @param label The label of the item.
15982     * @param func Function called when the user select the item.
15983     * @param data Data sent by the callback.
15984     * @return Returns the new item.
15985     */
15986    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);
15987    /**
15988     * @brief Add an object swallowed in an item at the end of the given menu
15989     * widget
15990     *
15991     * @param obj The menu object.
15992     * @param parent The parent menu item (optional)
15993     * @param subobj The object to swallow
15994     * @param func Function called when the user select the item.
15995     * @param data Data sent by the callback.
15996     * @return Returns the new item.
15997     *
15998     * Add an evas object as an item to the menu.
15999     */
16000    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);
16001    /**
16002     * @brief Set the label of a menu item
16003     *
16004     * @param item The menu item object.
16005     * @param label The label to set for @p item
16006     *
16007     * @warning Don't use this funcion on items created with
16008     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16009     */
16010    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16011    /**
16012     * @brief Get the label of a menu item
16013     *
16014     * @param item The menu item object.
16015     * @return The label of @p item
16016     */
16017    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16018    /**
16019     * @brief Set the icon of a menu item to the standard icon with name @p icon
16020     *
16021     * @param item The menu item object.
16022     * @param icon The icon object to set for the content of @p item
16023     *
16024     * Once this icon is set, any previously set icon will be deleted.
16025     */
16026    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16027    /**
16028     * @brief Get the string representation from the icon of a menu item
16029     *
16030     * @param item The menu item object.
16031     * @return The string representation of @p item's icon or NULL
16032     *
16033     * @see elm_menu_item_object_icon_name_set()
16034     */
16035    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16036    /**
16037     * @brief Set the content object of a menu item
16038     *
16039     * @param item The menu item object
16040     * @param The content object or NULL
16041     * @return EINA_TRUE on success, else EINA_FALSE
16042     *
16043     * Use this function to change the object swallowed by a menu item, deleting
16044     * any previously swallowed object.
16045     */
16046    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16047    /**
16048     * @brief Get the content object of a menu item
16049     *
16050     * @param item The menu item object
16051     * @return The content object or NULL
16052     * @note If @p item was added with elm_menu_item_add_object, this
16053     * function will return the object passed, else it will return the
16054     * icon object.
16055     *
16056     * @see elm_menu_item_object_content_set()
16057     */
16058    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16059
16060    EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
16061      {
16062         elm_menu_item_object_icon_name_set(item, icon);
16063      }
16064
16065    EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16066      {
16067         return elm_menu_item_object_content_get(item);
16068      }
16069
16070    EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16071      {
16072         return elm_menu_item_object_icon_name_get(item);
16073      }
16074
16075    /**
16076     * @brief Set the selected state of @p item.
16077     *
16078     * @param item The menu item object.
16079     * @param selected The selected/unselected state of the item
16080     */
16081    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16082    /**
16083     * @brief Get the selected state of @p item.
16084     *
16085     * @param item The menu item object.
16086     * @return The selected/unselected state of the item
16087     *
16088     * @see elm_menu_item_selected_set()
16089     */
16090    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16091    /**
16092     * @brief Set the disabled state of @p item.
16093     *
16094     * @param item The menu item object.
16095     * @param disabled The enabled/disabled state of the item
16096     */
16097    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16098    /**
16099     * @brief Get the disabled state of @p item.
16100     *
16101     * @param item The menu item object.
16102     * @return The enabled/disabled state of the item
16103     *
16104     * @see elm_menu_item_disabled_set()
16105     */
16106    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16107    /**
16108     * @brief Add a separator item to menu @p obj under @p parent.
16109     *
16110     * @param obj The menu object
16111     * @param parent The item to add the separator under
16112     * @return The created item or NULL on failure
16113     *
16114     * This is item is a @ref Separator.
16115     */
16116    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16117    /**
16118     * @brief Returns whether @p item is a separator.
16119     *
16120     * @param item The item to check
16121     * @return If true, @p item is a separator
16122     *
16123     * @see elm_menu_item_separator_add()
16124     */
16125    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16126    /**
16127     * @brief Deletes an item from the menu.
16128     *
16129     * @param item The item to delete.
16130     *
16131     * @see elm_menu_item_add()
16132     */
16133    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16134    /**
16135     * @brief Set the function called when a menu item is deleted.
16136     *
16137     * @param item The item to set the callback on
16138     * @param func The function called
16139     *
16140     * @see elm_menu_item_add()
16141     * @see elm_menu_item_del()
16142     */
16143    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16144    /**
16145     * @brief Returns the data associated with menu item @p item.
16146     *
16147     * @param item The item
16148     * @return The data associated with @p item or NULL if none was set.
16149     *
16150     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16151     */
16152    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16153    /**
16154     * @brief Sets the data to be associated with menu item @p item.
16155     *
16156     * @param item The item
16157     * @param data The data to be associated with @p item
16158     */
16159    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16160    /**
16161     * @brief Returns a list of @p item's subitems.
16162     *
16163     * @param item The item
16164     * @return An Eina_List* of @p item's subitems
16165     *
16166     * @see elm_menu_add()
16167     */
16168    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16169    /**
16170     * @brief Get the position of a menu item
16171     *
16172     * @param item The menu item
16173     * @return The item's index
16174     *
16175     * This function returns the index position of a menu item in a menu.
16176     * For a sub-menu, this number is relative to the first item in the sub-menu.
16177     *
16178     * @note Index values begin with 0
16179     */
16180    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16181    /**
16182     * @brief @brief Return a menu item's owner menu
16183     *
16184     * @param item The menu item
16185     * @return The menu object owning @p item, or NULL on failure
16186     *
16187     * Use this function to get the menu object owning an item.
16188     */
16189    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16190    /**
16191     * @brief Get the selected item in the menu
16192     *
16193     * @param obj The menu object
16194     * @return The selected item, or NULL if none
16195     *
16196     * @see elm_menu_item_selected_get()
16197     * @see elm_menu_item_selected_set()
16198     */
16199    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16200    /**
16201     * @brief Get the last item in the menu
16202     *
16203     * @param obj The menu object
16204     * @return The last item, or NULL if none
16205     */
16206    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16207    /**
16208     * @brief Get the first item in the menu
16209     *
16210     * @param obj The menu object
16211     * @return The first item, or NULL if none
16212     */
16213    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16214    /**
16215     * @brief Get the next item in the menu.
16216     *
16217     * @param item The menu item object.
16218     * @return The item after it, or NULL if none
16219     */
16220    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16221    /**
16222     * @brief Get the previous item in the menu.
16223     *
16224     * @param item The menu item object.
16225     * @return The item before it, or NULL if none
16226     */
16227    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16228    /**
16229     * @}
16230     */
16231
16232    /**
16233     * @defgroup List List
16234     * @ingroup Elementary
16235     *
16236     * @image html img/widget/list/preview-00.png
16237     * @image latex img/widget/list/preview-00.eps width=\textwidth
16238     *
16239     * @image html img/list.png
16240     * @image latex img/list.eps width=\textwidth
16241     *
16242     * A list widget is a container whose children are displayed vertically or
16243     * horizontally, in order, and can be selected.
16244     * The list can accept only one or multiple items selection. Also has many
16245     * modes of items displaying.
16246     *
16247     * A list is a very simple type of list widget.  For more robust
16248     * lists, @ref Genlist should probably be used.
16249     *
16250     * Smart callbacks one can listen to:
16251     * - @c "activated" - The user has double-clicked or pressed
16252     *   (enter|return|spacebar) on an item. The @c event_info parameter
16253     *   is the item that was activated.
16254     * - @c "clicked,double" - The user has double-clicked an item.
16255     *   The @c event_info parameter is the item that was double-clicked.
16256     * - "selected" - when the user selected an item
16257     * - "unselected" - when the user unselected an item
16258     * - "longpressed" - an item in the list is long-pressed
16259     * - "edge,top" - the list is scrolled until the top edge
16260     * - "edge,bottom" - the list is scrolled until the bottom edge
16261     * - "edge,left" - the list is scrolled until the left edge
16262     * - "edge,right" - the list is scrolled until the right edge
16263     * - "language,changed" - the program's language changed
16264     *
16265     * Available styles for it:
16266     * - @c "default"
16267     *
16268     * List of examples:
16269     * @li @ref list_example_01
16270     * @li @ref list_example_02
16271     * @li @ref list_example_03
16272     */
16273
16274    /**
16275     * @addtogroup List
16276     * @{
16277     */
16278
16279    /**
16280     * @enum _Elm_List_Mode
16281     * @typedef Elm_List_Mode
16282     *
16283     * Set list's resize behavior, transverse axis scroll and
16284     * items cropping. See each mode's description for more details.
16285     *
16286     * @note Default value is #ELM_LIST_SCROLL.
16287     *
16288     * Values <b> don't </b> work as bitmask, only one can be choosen.
16289     *
16290     * @see elm_list_mode_set()
16291     * @see elm_list_mode_get()
16292     *
16293     * @ingroup List
16294     */
16295    typedef enum _Elm_List_Mode
16296      {
16297         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. */
16298         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). */
16299         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. */
16300         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. */
16301         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16302      } Elm_List_Mode;
16303
16304    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().  */
16305
16306    /**
16307     * Add a new list widget to the given parent Elementary
16308     * (container) object.
16309     *
16310     * @param parent The parent object.
16311     * @return a new list widget handle or @c NULL, on errors.
16312     *
16313     * This function inserts a new list widget on the canvas.
16314     *
16315     * @ingroup List
16316     */
16317    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16318
16319    /**
16320     * Starts the list.
16321     *
16322     * @param obj The list object
16323     *
16324     * @note Call before running show() on the list object.
16325     * @warning If not called, it won't display the list properly.
16326     *
16327     * @code
16328     * li = elm_list_add(win);
16329     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16330     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16331     * elm_list_go(li);
16332     * evas_object_show(li);
16333     * @endcode
16334     *
16335     * @ingroup List
16336     */
16337    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16338
16339    /**
16340     * Enable or disable multiple items selection on the list object.
16341     *
16342     * @param obj The list object
16343     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16344     * disable it.
16345     *
16346     * Disabled by default. If disabled, the user can select a single item of
16347     * the list each time. Selected items are highlighted on list.
16348     * If enabled, many items can be selected.
16349     *
16350     * If a selected item is selected again, it will be unselected.
16351     *
16352     * @see elm_list_multi_select_get()
16353     *
16354     * @ingroup List
16355     */
16356    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16357
16358    /**
16359     * Get a value whether multiple items selection is enabled or not.
16360     *
16361     * @see elm_list_multi_select_set() for details.
16362     *
16363     * @param obj The list object.
16364     * @return @c EINA_TRUE means multiple items selection is enabled.
16365     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16366     * @c EINA_FALSE is returned.
16367     *
16368     * @ingroup List
16369     */
16370    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16371
16372    /**
16373     * Set which mode to use for the list object.
16374     *
16375     * @param obj The list object
16376     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16377     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16378     *
16379     * Set list's resize behavior, transverse axis scroll and
16380     * items cropping. See each mode's description for more details.
16381     *
16382     * @note Default value is #ELM_LIST_SCROLL.
16383     *
16384     * Only one can be set, if a previous one was set, it will be changed
16385     * by the new mode set. Bitmask won't work as well.
16386     *
16387     * @see elm_list_mode_get()
16388     *
16389     * @ingroup List
16390     */
16391    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16392
16393    /**
16394     * Get the mode the list is at.
16395     *
16396     * @param obj The list object
16397     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16398     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16399     *
16400     * @note see elm_list_mode_set() for more information.
16401     *
16402     * @ingroup List
16403     */
16404    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16405
16406    /**
16407     * Enable or disable horizontal mode on the list object.
16408     *
16409     * @param obj The list object.
16410     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16411     * disable it, i.e., to enable vertical mode.
16412     *
16413     * @note Vertical mode is set by default.
16414     *
16415     * On horizontal mode items are displayed on list from left to right,
16416     * instead of from top to bottom. Also, the list will scroll horizontally.
16417     * Each item will presents left icon on top and right icon, or end, at
16418     * the bottom.
16419     *
16420     * @see elm_list_horizontal_get()
16421     *
16422     * @ingroup List
16423     */
16424    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16425
16426    /**
16427     * Get a value whether horizontal mode is enabled or not.
16428     *
16429     * @param obj The list object.
16430     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16431     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16432     * @c EINA_FALSE is returned.
16433     *
16434     * @see elm_list_horizontal_set() for details.
16435     *
16436     * @ingroup List
16437     */
16438    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16439
16440    /**
16441     * Enable or disable always select mode on the list object.
16442     *
16443     * @param obj The list object
16444     * @param always_select @c EINA_TRUE to enable always select mode or
16445     * @c EINA_FALSE to disable it.
16446     *
16447     * @note Always select mode is disabled by default.
16448     *
16449     * Default behavior of list items is to only call its callback function
16450     * the first time it's pressed, i.e., when it is selected. If a selected
16451     * item is pressed again, and multi-select is disabled, it won't call
16452     * this function (if multi-select is enabled it will unselect the item).
16453     *
16454     * If always select is enabled, it will call the callback function
16455     * everytime a item is pressed, so it will call when the item is selected,
16456     * and again when a selected item is pressed.
16457     *
16458     * @see elm_list_always_select_mode_get()
16459     * @see elm_list_multi_select_set()
16460     *
16461     * @ingroup List
16462     */
16463    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16464
16465    /**
16466     * Get a value whether always select mode is enabled or not, meaning that
16467     * an item will always call its callback function, even if already selected.
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_always_select_mode_set() for details.
16475     *
16476     * @ingroup List
16477     */
16478    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16479
16480    /**
16481     * Set bouncing behaviour when the scrolled content reaches an edge.
16482     *
16483     * Tell the internal scroller object whether it should bounce or not
16484     * when it reaches the respective edges for each axis.
16485     *
16486     * @param obj The list object
16487     * @param h_bounce Whether to bounce or not in the horizontal axis.
16488     * @param v_bounce Whether to bounce or not in the vertical axis.
16489     *
16490     * @see elm_scroller_bounce_set()
16491     *
16492     * @ingroup List
16493     */
16494    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16495
16496    /**
16497     * Get the bouncing behaviour of the internal scroller.
16498     *
16499     * Get whether the internal scroller should bounce when the edge of each
16500     * axis is reached scrolling.
16501     *
16502     * @param obj The list object.
16503     * @param h_bounce Pointer where to store the bounce state of the horizontal
16504     * axis.
16505     * @param v_bounce Pointer where to store the bounce state of the vertical
16506     * axis.
16507     *
16508     * @see elm_scroller_bounce_get()
16509     * @see elm_list_bounce_set()
16510     *
16511     * @ingroup List
16512     */
16513    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16514
16515    /**
16516     * Set the scrollbar policy.
16517     *
16518     * @param obj The list object
16519     * @param policy_h Horizontal scrollbar policy.
16520     * @param policy_v Vertical scrollbar policy.
16521     *
16522     * This sets the scrollbar visibility policy for the given scroller.
16523     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16524     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16525     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16526     * This applies respectively for the horizontal and vertical scrollbars.
16527     *
16528     * The both are disabled by default, i.e., are set to
16529     * #ELM_SCROLLER_POLICY_OFF.
16530     *
16531     * @ingroup List
16532     */
16533    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16534
16535    /**
16536     * Get the scrollbar policy.
16537     *
16538     * @see elm_list_scroller_policy_get() for details.
16539     *
16540     * @param obj The list object.
16541     * @param policy_h Pointer where to store horizontal scrollbar policy.
16542     * @param policy_v Pointer where to store vertical scrollbar policy.
16543     *
16544     * @ingroup List
16545     */
16546    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);
16547
16548    /**
16549     * Append a new item to the list object.
16550     *
16551     * @param obj The list object.
16552     * @param label The label of the list item.
16553     * @param icon The icon object to use for the left side of the item. An
16554     * icon can be any Evas object, but usually it is an icon created
16555     * with elm_icon_add().
16556     * @param end The icon object to use for the right side of the item. An
16557     * icon can be any Evas object.
16558     * @param func The function to call when the item is clicked.
16559     * @param data The data to associate with the item for related callbacks.
16560     *
16561     * @return The created item or @c NULL upon failure.
16562     *
16563     * A new item will be created and appended to the list, i.e., will
16564     * be set as @b last item.
16565     *
16566     * Items created with this method can be deleted with
16567     * elm_list_item_del().
16568     *
16569     * Associated @p data can be properly freed when item is deleted if a
16570     * callback function is set with elm_list_item_del_cb_set().
16571     *
16572     * If a function is passed as argument, it will be called everytime this item
16573     * is selected, i.e., the user clicks over an unselected item.
16574     * If always select is enabled it will call this function every time
16575     * user clicks over an item (already selected or not).
16576     * If such function isn't needed, just passing
16577     * @c NULL as @p func is enough. The same should be done for @p data.
16578     *
16579     * Simple example (with no function callback or data associated):
16580     * @code
16581     * li = elm_list_add(win);
16582     * ic = elm_icon_add(win);
16583     * elm_icon_file_set(ic, "path/to/image", NULL);
16584     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16585     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16586     * elm_list_go(li);
16587     * evas_object_show(li);
16588     * @endcode
16589     *
16590     * @see elm_list_always_select_mode_set()
16591     * @see elm_list_item_del()
16592     * @see elm_list_item_del_cb_set()
16593     * @see elm_list_clear()
16594     * @see elm_icon_add()
16595     *
16596     * @ingroup List
16597     */
16598    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);
16599
16600    /**
16601     * Prepend a new item to the list object.
16602     *
16603     * @param obj The list object.
16604     * @param label The label of the list item.
16605     * @param icon The icon object to use for the left side of the item. An
16606     * icon can be any Evas object, but usually it is an icon created
16607     * with elm_icon_add().
16608     * @param end The icon object to use for the right side of the item. An
16609     * icon can be any Evas object.
16610     * @param func The function to call when the item is clicked.
16611     * @param data The data to associate with the item for related callbacks.
16612     *
16613     * @return The created item or @c NULL upon failure.
16614     *
16615     * A new item will be created and prepended to the list, i.e., will
16616     * be set as @b first item.
16617     *
16618     * Items created with this method can be deleted with
16619     * elm_list_item_del().
16620     *
16621     * Associated @p data can be properly freed when item is deleted if a
16622     * callback function is set with elm_list_item_del_cb_set().
16623     *
16624     * If a function is passed as argument, it will be called everytime this item
16625     * is selected, i.e., the user clicks over an unselected item.
16626     * If always select is enabled it will call this function every time
16627     * user clicks over an item (already selected or not).
16628     * If such function isn't needed, just passing
16629     * @c NULL as @p func is enough. The same should be done for @p data.
16630     *
16631     * @see elm_list_item_append() for a simple code example.
16632     * @see elm_list_always_select_mode_set()
16633     * @see elm_list_item_del()
16634     * @see elm_list_item_del_cb_set()
16635     * @see elm_list_clear()
16636     * @see elm_icon_add()
16637     *
16638     * @ingroup List
16639     */
16640    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);
16641
16642    /**
16643     * Insert a new item into the list object before item @p before.
16644     *
16645     * @param obj The list object.
16646     * @param before The list item to insert before.
16647     * @param label The label of the list item.
16648     * @param icon The icon object to use for the left side of the item. An
16649     * icon can be any Evas object, but usually it is an icon created
16650     * with elm_icon_add().
16651     * @param end The icon object to use for the right side of the item. An
16652     * icon can be any Evas object.
16653     * @param func The function to call when the item is clicked.
16654     * @param data The data to associate with the item for related callbacks.
16655     *
16656     * @return The created item or @c NULL upon failure.
16657     *
16658     * A new item will be created and added to the list. Its position in
16659     * this list will be just before item @p before.
16660     *
16661     * Items created with this method can be deleted with
16662     * elm_list_item_del().
16663     *
16664     * Associated @p data can be properly freed when item is deleted if a
16665     * callback function is set with elm_list_item_del_cb_set().
16666     *
16667     * If a function is passed as argument, it will be called everytime this item
16668     * is selected, i.e., the user clicks over an unselected item.
16669     * If always select is enabled it will call this function every time
16670     * user clicks over an item (already selected or not).
16671     * If such function isn't needed, just passing
16672     * @c NULL as @p func is enough. The same should be done for @p data.
16673     *
16674     * @see elm_list_item_append() for a simple code example.
16675     * @see elm_list_always_select_mode_set()
16676     * @see elm_list_item_del()
16677     * @see elm_list_item_del_cb_set()
16678     * @see elm_list_clear()
16679     * @see elm_icon_add()
16680     *
16681     * @ingroup List
16682     */
16683    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);
16684
16685    /**
16686     * Insert a new item into the list object after item @p after.
16687     *
16688     * @param obj The list object.
16689     * @param after The list item to insert after.
16690     * @param label The label of the list item.
16691     * @param icon The icon object to use for the left side of the item. An
16692     * icon can be any Evas object, but usually it is an icon created
16693     * with elm_icon_add().
16694     * @param end The icon object to use for the right side of the item. An
16695     * icon can be any Evas object.
16696     * @param func The function to call when the item is clicked.
16697     * @param data The data to associate with the item for related callbacks.
16698     *
16699     * @return The created item or @c NULL upon failure.
16700     *
16701     * A new item will be created and added to the list. Its position in
16702     * this list will be just after item @p after.
16703     *
16704     * Items created with this method can be deleted with
16705     * elm_list_item_del().
16706     *
16707     * Associated @p data can be properly freed when item is deleted if a
16708     * callback function is set with elm_list_item_del_cb_set().
16709     *
16710     * If a function is passed as argument, it will be called everytime this item
16711     * is selected, i.e., the user clicks over an unselected item.
16712     * If always select is enabled it will call this function every time
16713     * user clicks over an item (already selected or not).
16714     * If such function isn't needed, just passing
16715     * @c NULL as @p func is enough. The same should be done for @p data.
16716     *
16717     * @see elm_list_item_append() for a simple code example.
16718     * @see elm_list_always_select_mode_set()
16719     * @see elm_list_item_del()
16720     * @see elm_list_item_del_cb_set()
16721     * @see elm_list_clear()
16722     * @see elm_icon_add()
16723     *
16724     * @ingroup List
16725     */
16726    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);
16727
16728    /**
16729     * Insert a new item into the sorted list object.
16730     *
16731     * @param obj The list object.
16732     * @param label The label of the list item.
16733     * @param icon The icon object to use for the left side of the item. An
16734     * icon can be any Evas object, but usually it is an icon created
16735     * with elm_icon_add().
16736     * @param end The icon object to use for the right side of the item. An
16737     * icon can be any Evas object.
16738     * @param func The function to call when the item is clicked.
16739     * @param data The data to associate with the item for related callbacks.
16740     * @param cmp_func The comparing function to be used to sort list
16741     * items <b>by #Elm_List_Item item handles</b>. This function will
16742     * receive two items and compare them, returning a non-negative integer
16743     * if the second item should be place after the first, or negative value
16744     * if should be placed before.
16745     *
16746     * @return The created item or @c NULL upon failure.
16747     *
16748     * @note This function inserts values into a list object assuming it was
16749     * sorted and the result will be sorted.
16750     *
16751     * A new item will be created and added to the list. Its position in
16752     * this list will be found comparing the new item with previously inserted
16753     * items using function @p cmp_func.
16754     *
16755     * Items created with this method can be deleted with
16756     * elm_list_item_del().
16757     *
16758     * Associated @p data can be properly freed when item is deleted if a
16759     * callback function is set with elm_list_item_del_cb_set().
16760     *
16761     * If a function is passed as argument, it will be called everytime this item
16762     * is selected, i.e., the user clicks over an unselected item.
16763     * If always select is enabled it will call this function every time
16764     * user clicks over an item (already selected or not).
16765     * If such function isn't needed, just passing
16766     * @c NULL as @p func is enough. The same should be done for @p data.
16767     *
16768     * @see elm_list_item_append() for a simple code example.
16769     * @see elm_list_always_select_mode_set()
16770     * @see elm_list_item_del()
16771     * @see elm_list_item_del_cb_set()
16772     * @see elm_list_clear()
16773     * @see elm_icon_add()
16774     *
16775     * @ingroup List
16776     */
16777    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);
16778
16779    /**
16780     * Remove all list's items.
16781     *
16782     * @param obj The list object
16783     *
16784     * @see elm_list_item_del()
16785     * @see elm_list_item_append()
16786     *
16787     * @ingroup List
16788     */
16789    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16790
16791    /**
16792     * Get a list of all the list items.
16793     *
16794     * @param obj The list object
16795     * @return An @c Eina_List of list items, #Elm_List_Item,
16796     * or @c NULL on failure.
16797     *
16798     * @see elm_list_item_append()
16799     * @see elm_list_item_del()
16800     * @see elm_list_clear()
16801     *
16802     * @ingroup List
16803     */
16804    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16805
16806    /**
16807     * Get the selected item.
16808     *
16809     * @param obj The list object.
16810     * @return The selected list item.
16811     *
16812     * The selected item can be unselected with function
16813     * elm_list_item_selected_set().
16814     *
16815     * The selected item always will be highlighted on list.
16816     *
16817     * @see elm_list_selected_items_get()
16818     *
16819     * @ingroup List
16820     */
16821    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16822
16823    /**
16824     * Return a list of the currently selected list items.
16825     *
16826     * @param obj The list object.
16827     * @return An @c Eina_List of list items, #Elm_List_Item,
16828     * or @c NULL on failure.
16829     *
16830     * Multiple items can be selected if multi select is enabled. It can be
16831     * done with elm_list_multi_select_set().
16832     *
16833     * @see elm_list_selected_item_get()
16834     * @see elm_list_multi_select_set()
16835     *
16836     * @ingroup List
16837     */
16838    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16839
16840    /**
16841     * Set the selected state of an item.
16842     *
16843     * @param item The list item
16844     * @param selected The selected state
16845     *
16846     * This sets the selected state of the given item @p it.
16847     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16848     *
16849     * If a new item is selected the previosly selected will be unselected,
16850     * unless multiple selection is enabled with elm_list_multi_select_set().
16851     * Previoulsy selected item can be get with function
16852     * elm_list_selected_item_get().
16853     *
16854     * Selected items will be highlighted.
16855     *
16856     * @see elm_list_item_selected_get()
16857     * @see elm_list_selected_item_get()
16858     * @see elm_list_multi_select_set()
16859     *
16860     * @ingroup List
16861     */
16862    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16863
16864    /*
16865     * Get whether the @p item is selected or not.
16866     *
16867     * @param item The list item.
16868     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16869     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16870     *
16871     * @see elm_list_selected_item_set() for details.
16872     * @see elm_list_item_selected_get()
16873     *
16874     * @ingroup List
16875     */
16876    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16877
16878    /**
16879     * Set or unset item as a separator.
16880     *
16881     * @param it The list item.
16882     * @param setting @c EINA_TRUE to set item @p it as separator or
16883     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16884     *
16885     * Items aren't set as separator by default.
16886     *
16887     * If set as separator it will display separator theme, so won't display
16888     * icons or label.
16889     *
16890     * @see elm_list_item_separator_get()
16891     *
16892     * @ingroup List
16893     */
16894    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16895
16896    /**
16897     * Get a value whether item is a separator or not.
16898     *
16899     * @see elm_list_item_separator_set() for details.
16900     *
16901     * @param it The list item.
16902     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16903     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16904     *
16905     * @ingroup List
16906     */
16907    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16908
16909    /**
16910     * Show @p item in the list view.
16911     *
16912     * @param item The list item to be shown.
16913     *
16914     * It won't animate list until item is visible. If such behavior is wanted,
16915     * use elm_list_bring_in() intead.
16916     *
16917     * @ingroup List
16918     */
16919    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16920
16921    /**
16922     * Bring in the given item to list view.
16923     *
16924     * @param item The item.
16925     *
16926     * This causes list to jump to the given item @p item and show it
16927     * (by scrolling), if it is not fully visible.
16928     *
16929     * This may use animation to do so and take a period of time.
16930     *
16931     * If animation isn't wanted, elm_list_item_show() can be used.
16932     *
16933     * @ingroup List
16934     */
16935    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16936
16937    /**
16938     * Delete them item from the list.
16939     *
16940     * @param item The item of list to be deleted.
16941     *
16942     * If deleting all list items is required, elm_list_clear()
16943     * should be used instead of getting items list and deleting each one.
16944     *
16945     * @see elm_list_clear()
16946     * @see elm_list_item_append()
16947     * @see elm_list_item_del_cb_set()
16948     *
16949     * @ingroup List
16950     */
16951    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16952
16953    /**
16954     * Set the function called when a list item is freed.
16955     *
16956     * @param item The item to set the callback on
16957     * @param func The function called
16958     *
16959     * If there is a @p func, then it will be called prior item's memory release.
16960     * That will be called with the following arguments:
16961     * @li item's data;
16962     * @li item's Evas object;
16963     * @li item itself;
16964     *
16965     * This way, a data associated to a list item could be properly freed.
16966     *
16967     * @ingroup List
16968     */
16969    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16970
16971    /**
16972     * Get the data associated to the item.
16973     *
16974     * @param item The list item
16975     * @return The data associated to @p item
16976     *
16977     * The return value is a pointer to data associated to @p item when it was
16978     * created, with function elm_list_item_append() or similar. If no data
16979     * was passed as argument, it will return @c NULL.
16980     *
16981     * @see elm_list_item_append()
16982     *
16983     * @ingroup List
16984     */
16985    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16986
16987    /**
16988     * Get the left side icon associated to the item.
16989     *
16990     * @param item The list item
16991     * @return The left side icon associated to @p item
16992     *
16993     * The return value is a pointer to the icon associated to @p item when
16994     * it was
16995     * created, with function elm_list_item_append() or similar, or later
16996     * with function elm_list_item_icon_set(). If no icon
16997     * was passed as argument, it will return @c NULL.
16998     *
16999     * @see elm_list_item_append()
17000     * @see elm_list_item_icon_set()
17001     *
17002     * @ingroup List
17003     */
17004    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17005
17006    /**
17007     * Set the left side icon associated to the item.
17008     *
17009     * @param item The list item
17010     * @param icon The left side icon object to associate with @p item
17011     *
17012     * The icon object to use at left side of the item. An
17013     * icon can be any Evas object, but usually it is an icon created
17014     * with elm_icon_add().
17015     *
17016     * Once the icon object is set, a previously set one will be deleted.
17017     * @warning Setting the same icon for two items will cause the icon to
17018     * dissapear from the first item.
17019     *
17020     * If an icon was passed as argument on item creation, with function
17021     * elm_list_item_append() or similar, it will be already
17022     * associated to the item.
17023     *
17024     * @see elm_list_item_append()
17025     * @see elm_list_item_icon_get()
17026     *
17027     * @ingroup List
17028     */
17029    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17030
17031    /**
17032     * Get the right side icon associated to the item.
17033     *
17034     * @param item The list item
17035     * @return The right side icon associated to @p item
17036     *
17037     * The return value is a pointer to the icon associated to @p item when
17038     * it was
17039     * created, with function elm_list_item_append() or similar, or later
17040     * with function elm_list_item_icon_set(). If no icon
17041     * was passed as argument, it will return @c NULL.
17042     *
17043     * @see elm_list_item_append()
17044     * @see elm_list_item_icon_set()
17045     *
17046     * @ingroup List
17047     */
17048    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17049
17050    /**
17051     * Set the right side icon associated to the item.
17052     *
17053     * @param item The list item
17054     * @param end The right side icon object to associate with @p item
17055     *
17056     * The icon object to use at right side of the item. An
17057     * icon can be any Evas object, but usually it is an icon created
17058     * with elm_icon_add().
17059     *
17060     * Once the icon object is set, a previously set one will be deleted.
17061     * @warning Setting the same icon for two items will cause the icon to
17062     * dissapear from the first item.
17063     *
17064     * If an icon was passed as argument on item creation, with function
17065     * elm_list_item_append() or similar, it will be already
17066     * associated to the item.
17067     *
17068     * @see elm_list_item_append()
17069     * @see elm_list_item_end_get()
17070     *
17071     * @ingroup List
17072     */
17073    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17074    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17075
17076    /**
17077     * Gets the base object of the item.
17078     *
17079     * @param item The list item
17080     * @return The base object associated with @p item
17081     *
17082     * Base object is the @c Evas_Object that represents that item.
17083     *
17084     * @ingroup List
17085     */
17086    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17087
17088    /**
17089     * Get the label of item.
17090     *
17091     * @param item The item of list.
17092     * @return The label of item.
17093     *
17094     * The return value is a pointer to the label associated to @p item when
17095     * it was created, with function elm_list_item_append(), or later
17096     * with function elm_list_item_label_set. If no label
17097     * was passed as argument, it will return @c NULL.
17098     *
17099     * @see elm_list_item_label_set() for more details.
17100     * @see elm_list_item_append()
17101     *
17102     * @ingroup List
17103     */
17104    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17105
17106    /**
17107     * Set the label of item.
17108     *
17109     * @param item The item of list.
17110     * @param text The label of item.
17111     *
17112     * The label to be displayed by the item.
17113     * Label will be placed between left and right side icons (if set).
17114     *
17115     * If a label was passed as argument on item creation, with function
17116     * elm_list_item_append() or similar, it will be already
17117     * displayed by the item.
17118     *
17119     * @see elm_list_item_label_get()
17120     * @see elm_list_item_append()
17121     *
17122     * @ingroup List
17123     */
17124    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17125
17126
17127    /**
17128     * Get the item before @p it in list.
17129     *
17130     * @param it The list item.
17131     * @return The item before @p it, or @c NULL if none or on failure.
17132     *
17133     * @note If it is the first item, @c NULL will be returned.
17134     *
17135     * @see elm_list_item_append()
17136     * @see elm_list_items_get()
17137     *
17138     * @ingroup List
17139     */
17140    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17141
17142    /**
17143     * Get the item after @p it in list.
17144     *
17145     * @param it The list item.
17146     * @return The item after @p it, or @c NULL if none or on failure.
17147     *
17148     * @note If it is the last item, @c NULL will be returned.
17149     *
17150     * @see elm_list_item_append()
17151     * @see elm_list_items_get()
17152     *
17153     * @ingroup List
17154     */
17155    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17156
17157    /**
17158     * Sets the disabled/enabled state of a list item.
17159     *
17160     * @param it The item.
17161     * @param disabled The disabled state.
17162     *
17163     * A disabled item cannot be selected or unselected. It will also
17164     * change its appearance (generally greyed out). This sets the
17165     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17166     * enabled).
17167     *
17168     * @ingroup List
17169     */
17170    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17171
17172    /**
17173     * Get a value whether list item is disabled or not.
17174     *
17175     * @param it The item.
17176     * @return The disabled state.
17177     *
17178     * @see elm_list_item_disabled_set() for more details.
17179     *
17180     * @ingroup List
17181     */
17182    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17183
17184    /**
17185     * Set the text to be shown in a given list item's tooltips.
17186     *
17187     * @param item Target item.
17188     * @param text The text to set in the content.
17189     *
17190     * Setup the text as tooltip to object. The item can have only one tooltip,
17191     * so any previous tooltip data - set with this function or
17192     * elm_list_item_tooltip_content_cb_set() - is removed.
17193     *
17194     * @see elm_object_tooltip_text_set() for more details.
17195     *
17196     * @ingroup List
17197     */
17198    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17199
17200
17201    /**
17202     * @brief Disable size restrictions on an object's tooltip
17203     * @param item The tooltip's anchor object
17204     * @param disable If EINA_TRUE, size restrictions are disabled
17205     * @return EINA_FALSE on failure, EINA_TRUE on success
17206     *
17207     * This function allows a tooltip to expand beyond its parant window's canvas.
17208     * It will instead be limited only by the size of the display.
17209     */
17210    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17211    /**
17212     * @brief Retrieve size restriction state of an object's tooltip
17213     * @param obj The tooltip's anchor object
17214     * @return If EINA_TRUE, size restrictions are disabled
17215     *
17216     * This function returns whether a tooltip is allowed to expand beyond
17217     * its parant window's canvas.
17218     * It will instead be limited only by the size of the display.
17219     */
17220    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17221
17222    /**
17223     * Set the content to be shown in the tooltip item.
17224     *
17225     * Setup the tooltip to item. The item can have only one tooltip,
17226     * so any previous tooltip data is removed. @p func(with @p data) will
17227     * be called every time that need show the tooltip and it should
17228     * return a valid Evas_Object. This object is then managed fully by
17229     * tooltip system and is deleted when the tooltip is gone.
17230     *
17231     * @param item the list item being attached a tooltip.
17232     * @param func the function used to create the tooltip contents.
17233     * @param data what to provide to @a func as callback data/context.
17234     * @param del_cb called when data is not needed anymore, either when
17235     *        another callback replaces @a func, the tooltip is unset with
17236     *        elm_list_item_tooltip_unset() or the owner @a item
17237     *        dies. This callback receives as the first parameter the
17238     *        given @a data, and @c event_info is the item.
17239     *
17240     * @see elm_object_tooltip_content_cb_set() for more details.
17241     *
17242     * @ingroup List
17243     */
17244    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);
17245
17246    /**
17247     * Unset tooltip from item.
17248     *
17249     * @param item list item to remove previously set tooltip.
17250     *
17251     * Remove tooltip from item. The callback provided as del_cb to
17252     * elm_list_item_tooltip_content_cb_set() will be called to notify
17253     * it is not used anymore.
17254     *
17255     * @see elm_object_tooltip_unset() for more details.
17256     * @see elm_list_item_tooltip_content_cb_set()
17257     *
17258     * @ingroup List
17259     */
17260    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17261
17262    /**
17263     * Sets a different style for this item tooltip.
17264     *
17265     * @note before you set a style you should define a tooltip with
17266     *       elm_list_item_tooltip_content_cb_set() or
17267     *       elm_list_item_tooltip_text_set()
17268     *
17269     * @param item list item with tooltip already set.
17270     * @param style the theme style to use (default, transparent, ...)
17271     *
17272     * @see elm_object_tooltip_style_set() for more details.
17273     *
17274     * @ingroup List
17275     */
17276    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17277
17278    /**
17279     * Get the style for this item tooltip.
17280     *
17281     * @param item list item with tooltip already set.
17282     * @return style the theme style in use, defaults to "default". If the
17283     *         object does not have a tooltip set, then NULL is returned.
17284     *
17285     * @see elm_object_tooltip_style_get() for more details.
17286     * @see elm_list_item_tooltip_style_set()
17287     *
17288     * @ingroup List
17289     */
17290    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17291
17292    /**
17293     * Set the type of mouse pointer/cursor decoration to be shown,
17294     * when the mouse pointer is over the given list widget item
17295     *
17296     * @param item list item to customize cursor on
17297     * @param cursor the cursor type's name
17298     *
17299     * This function works analogously as elm_object_cursor_set(), but
17300     * here the cursor's changing area is restricted to the item's
17301     * area, and not the whole widget's. Note that that item cursors
17302     * have precedence over widget cursors, so that a mouse over an
17303     * item with custom cursor set will always show @b that cursor.
17304     *
17305     * If this function is called twice for an object, a previously set
17306     * cursor will be unset on the second call.
17307     *
17308     * @see elm_object_cursor_set()
17309     * @see elm_list_item_cursor_get()
17310     * @see elm_list_item_cursor_unset()
17311     *
17312     * @ingroup List
17313     */
17314    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17315
17316    /*
17317     * Get the type of mouse pointer/cursor decoration set to be shown,
17318     * when the mouse pointer is over the given list widget item
17319     *
17320     * @param item list item with custom cursor set
17321     * @return the cursor type's name or @c NULL, if no custom cursors
17322     * were set to @p item (and on errors)
17323     *
17324     * @see elm_object_cursor_get()
17325     * @see elm_list_item_cursor_set()
17326     * @see elm_list_item_cursor_unset()
17327     *
17328     * @ingroup List
17329     */
17330    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17331
17332    /**
17333     * Unset any custom mouse pointer/cursor decoration set to be
17334     * shown, when the mouse pointer is over the given list widget
17335     * item, thus making it show the @b default cursor again.
17336     *
17337     * @param item a list item
17338     *
17339     * Use this call to undo any custom settings on this item's cursor
17340     * decoration, bringing it back to defaults (no custom style set).
17341     *
17342     * @see elm_object_cursor_unset()
17343     * @see elm_list_item_cursor_set()
17344     *
17345     * @ingroup List
17346     */
17347    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17348
17349    /**
17350     * Set a different @b style for a given custom cursor set for a
17351     * list item.
17352     *
17353     * @param item list item with custom cursor set
17354     * @param style the <b>theme style</b> to use (e.g. @c "default",
17355     * @c "transparent", etc)
17356     *
17357     * This function only makes sense when one is using custom mouse
17358     * cursor decorations <b>defined in a theme file</b>, which can have,
17359     * given a cursor name/type, <b>alternate styles</b> on it. It
17360     * works analogously as elm_object_cursor_style_set(), but here
17361     * applyed only to list item objects.
17362     *
17363     * @warning Before you set a cursor style you should have definen a
17364     *       custom cursor previously on the item, with
17365     *       elm_list_item_cursor_set()
17366     *
17367     * @see elm_list_item_cursor_engine_only_set()
17368     * @see elm_list_item_cursor_style_get()
17369     *
17370     * @ingroup List
17371     */
17372    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17373
17374    /**
17375     * Get the current @b style set for a given list item's custom
17376     * cursor
17377     *
17378     * @param item list item with custom cursor set.
17379     * @return style the cursor style in use. If the object does not
17380     *         have a cursor set, then @c NULL is returned.
17381     *
17382     * @see elm_list_item_cursor_style_set() for more details
17383     *
17384     * @ingroup List
17385     */
17386    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17387
17388    /**
17389     * Set if the (custom)cursor for a given list item should be
17390     * searched in its theme, also, or should only rely on the
17391     * rendering engine.
17392     *
17393     * @param item item with custom (custom) cursor already set on
17394     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17395     * only on those provided by the rendering engine, @c EINA_FALSE to
17396     * have them searched on the widget's theme, as well.
17397     *
17398     * @note This call is of use only if you've set a custom cursor
17399     * for list items, with elm_list_item_cursor_set().
17400     *
17401     * @note By default, cursors will only be looked for between those
17402     * provided by the rendering engine.
17403     *
17404     * @ingroup List
17405     */
17406    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17407
17408    /**
17409     * Get if the (custom) cursor for a given list item is being
17410     * searched in its theme, also, or is only relying on the rendering
17411     * engine.
17412     *
17413     * @param item a list item
17414     * @return @c EINA_TRUE, if cursors are being looked for only on
17415     * those provided by the rendering engine, @c EINA_FALSE if they
17416     * are being searched on the widget's theme, as well.
17417     *
17418     * @see elm_list_item_cursor_engine_only_set(), for more details
17419     *
17420     * @ingroup List
17421     */
17422    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17423
17424    /**
17425     * @}
17426     */
17427
17428    /**
17429     * @defgroup Slider Slider
17430     * @ingroup Elementary
17431     *
17432     * @image html img/widget/slider/preview-00.png
17433     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17434     *
17435     * The slider adds a dragable “slider” widget for selecting the value of
17436     * something within a range.
17437     *
17438     * A slider can be horizontal or vertical. It can contain an Icon and has a
17439     * primary label as well as a units label (that is formatted with floating
17440     * point values and thus accepts a printf-style format string, like
17441     * “%1.2f units”. There is also an indicator string that may be somewhere
17442     * else (like on the slider itself) that also accepts a format string like
17443     * units. Label, Icon Unit and Indicator strings/objects are optional.
17444     *
17445     * A slider may be inverted which means values invert, with high vales being
17446     * on the left or top and low values on the right or bottom (as opposed to
17447     * normally being low on the left or top and high on the bottom and right).
17448     *
17449     * The slider should have its minimum and maximum values set by the
17450     * application with  elm_slider_min_max_set() and value should also be set by
17451     * the application before use with  elm_slider_value_set(). The span of the
17452     * slider is its length (horizontally or vertically). This will be scaled by
17453     * the object or applications scaling factor. At any point code can query the
17454     * slider for its value with elm_slider_value_get().
17455     *
17456     * Smart callbacks one can listen to:
17457     * - "changed" - Whenever the slider value is changed by the user.
17458     * - "slider,drag,start" - dragging the slider indicator around has started.
17459     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17460     * - "delay,changed" - A short time after the value is changed by the user.
17461     * This will be called only when the user stops dragging for
17462     * a very short period or when they release their
17463     * finger/mouse, so it avoids possibly expensive reactions to
17464     * the value change.
17465     *
17466     * Available styles for it:
17467     * - @c "default"
17468     *
17469     * Default contents parts of the slider widget that you can use for are:
17470     * @li "icon" - A icon of the slider
17471     * @li "end" - A end part content of the slider
17472     * 
17473     * Default text parts of the silder widget that you can use for are:
17474     * @li "default" - Label of the silder
17475     * Here is an example on its usage:
17476     * @li @ref slider_example
17477     */
17478
17479    /**
17480     * @addtogroup Slider
17481     * @{
17482     */
17483
17484    /**
17485     * Add a new slider widget to the given parent Elementary
17486     * (container) object.
17487     *
17488     * @param parent The parent object.
17489     * @return a new slider widget handle or @c NULL, on errors.
17490     *
17491     * This function inserts a new slider widget on the canvas.
17492     *
17493     * @ingroup Slider
17494     */
17495    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17496
17497    /**
17498     * Set the label of a given slider widget
17499     *
17500     * @param obj The progress bar object
17501     * @param label The text label string, in UTF-8
17502     *
17503     * @ingroup Slider
17504     * @deprecated use elm_object_text_set() instead.
17505     */
17506    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17507
17508    /**
17509     * Get the label of a given slider widget
17510     *
17511     * @param obj The progressbar object
17512     * @return The text label string, in UTF-8
17513     *
17514     * @ingroup Slider
17515     * @deprecated use elm_object_text_get() instead.
17516     */
17517    WILL_DEPRECATE  EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17518
17519    /**
17520     * Set the icon object of the slider object.
17521     *
17522     * @param obj The slider object.
17523     * @param icon The icon object.
17524     *
17525     * On horizontal mode, icon is placed at left, and on vertical mode,
17526     * placed at top.
17527     *
17528     * @note Once the icon object is set, a previously set one will be deleted.
17529     * If you want to keep that old content object, use the
17530     * elm_slider_icon_unset() function.
17531     *
17532     * @warning If the object being set does not have minimum size hints set,
17533     * it won't get properly displayed.
17534     *
17535     * @ingroup Slider
17536     * @deprecated use elm_object_part_content_set() instead.
17537     */
17538    WILL_DEPRECATE  EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17539
17540    /**
17541     * Unset an icon set on a given slider widget.
17542     *
17543     * @param obj The slider object.
17544     * @return The icon object that was being used, if any was set, or
17545     * @c NULL, otherwise (and on errors).
17546     *
17547     * On horizontal mode, icon is placed at left, and on vertical mode,
17548     * placed at top.
17549     *
17550     * This call will unparent and return the icon object which was set
17551     * for this widget, previously, on success.
17552     *
17553     * @see elm_slider_icon_set() for more details
17554     * @see elm_slider_icon_get()
17555     * @deprecated use elm_object_part_content_unset() instead.
17556     *
17557     * @ingroup Slider
17558     */
17559    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17560
17561    /**
17562     * Retrieve the icon object set for a given slider widget.
17563     *
17564     * @param obj The slider object.
17565     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17566     * otherwise (and on errors).
17567     *
17568     * On horizontal mode, icon is placed at left, and on vertical mode,
17569     * placed at top.
17570     *
17571     * @see elm_slider_icon_set() for more details
17572     * @see elm_slider_icon_unset()
17573     *
17574     * @deprecated use elm_object_part_content_get() instead.
17575     *
17576     * @ingroup Slider
17577     */
17578    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17579
17580    /**
17581     * Set the end object of the slider object.
17582     *
17583     * @param obj The slider object.
17584     * @param end The end object.
17585     *
17586     * On horizontal mode, end is placed at left, and on vertical mode,
17587     * placed at bottom.
17588     *
17589     * @note Once the icon object is set, a previously set one will be deleted.
17590     * If you want to keep that old content object, use the
17591     * elm_slider_end_unset() function.
17592     *
17593     * @warning If the object being set does not have minimum size hints set,
17594     * it won't get properly displayed.
17595     *
17596     * @deprecated use elm_object_part_content_set() instead.
17597     *
17598     * @ingroup Slider
17599     */
17600    WILL_DEPRECATE  EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17601
17602    /**
17603     * Unset an end object set on a given slider widget.
17604     *
17605     * @param obj The slider object.
17606     * @return The end object that was being used, if any was set, or
17607     * @c NULL, otherwise (and on errors).
17608     *
17609     * On horizontal mode, end is placed at left, and on vertical mode,
17610     * placed at bottom.
17611     *
17612     * This call will unparent and return the icon object which was set
17613     * for this widget, previously, on success.
17614     *
17615     * @see elm_slider_end_set() for more details.
17616     * @see elm_slider_end_get()
17617     *
17618     * @deprecated use elm_object_part_content_unset() instead
17619     * instead.
17620     *
17621     * @ingroup Slider
17622     */
17623    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17624
17625    /**
17626     * Retrieve the end object set for a given slider widget.
17627     *
17628     * @param obj The slider object.
17629     * @return The end object's handle, if @p obj had one set, or @c NULL,
17630     * otherwise (and on errors).
17631     *
17632     * On horizontal mode, icon is placed at right, and on vertical mode,
17633     * placed at bottom.
17634     *
17635     * @see elm_slider_end_set() for more details.
17636     * @see elm_slider_end_unset()
17637     *
17638     *
17639     * @deprecated use elm_object_part_content_get() instead 
17640     * instead.
17641     *
17642     * @ingroup Slider
17643     */
17644    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17645
17646    /**
17647     * Set the (exact) length of the bar region of a given slider widget.
17648     *
17649     * @param obj The slider object.
17650     * @param size The length of the slider's bar region.
17651     *
17652     * This sets the minimum width (when in horizontal mode) or height
17653     * (when in vertical mode) of the actual bar area of the slider
17654     * @p obj. This in turn affects the object's minimum size. Use
17655     * this when you're not setting other size hints expanding on the
17656     * given direction (like weight and alignment hints) and you would
17657     * like it to have a specific size.
17658     *
17659     * @note Icon, end, label, indicator and unit text around @p obj
17660     * will require their
17661     * own space, which will make @p obj to require more the @p size,
17662     * actually.
17663     *
17664     * @see elm_slider_span_size_get()
17665     *
17666     * @ingroup Slider
17667     */
17668    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17669
17670    /**
17671     * Get the length set for the bar region of a given slider widget
17672     *
17673     * @param obj The slider object.
17674     * @return The length of the slider's bar region.
17675     *
17676     * If that size was not set previously, with
17677     * elm_slider_span_size_set(), this call will return @c 0.
17678     *
17679     * @ingroup Slider
17680     */
17681    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17682
17683    /**
17684     * Set the format string for the unit label.
17685     *
17686     * @param obj The slider object.
17687     * @param format The format string for the unit display.
17688     *
17689     * Unit label is displayed all the time, if set, after slider's bar.
17690     * In horizontal mode, at right and in vertical mode, at bottom.
17691     *
17692     * If @c NULL, unit label won't be visible. If not it sets the format
17693     * string for the label text. To the label text is provided a floating point
17694     * value, so the label text can display up to 1 floating point value.
17695     * Note that this is optional.
17696     *
17697     * Use a format string such as "%1.2f meters" for example, and it will
17698     * display values like: "3.14 meters" for a value equal to 3.14159.
17699     *
17700     * Default is unit label disabled.
17701     *
17702     * @see elm_slider_indicator_format_get()
17703     *
17704     * @ingroup Slider
17705     */
17706    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17707
17708    /**
17709     * Get the unit label format of the slider.
17710     *
17711     * @param obj The slider object.
17712     * @return The unit label format string in UTF-8.
17713     *
17714     * Unit label is displayed all the time, if set, after slider's bar.
17715     * In horizontal mode, at right and in vertical mode, at bottom.
17716     *
17717     * @see elm_slider_unit_format_set() for more
17718     * information on how this works.
17719     *
17720     * @ingroup Slider
17721     */
17722    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17723
17724    /**
17725     * Set the format string for the indicator label.
17726     *
17727     * @param obj The slider object.
17728     * @param indicator The format string for the indicator display.
17729     *
17730     * The slider may display its value somewhere else then unit label,
17731     * for example, above the slider knob that is dragged around. This function
17732     * sets the format string used for this.
17733     *
17734     * If @c NULL, indicator label won't be visible. If not it sets the format
17735     * string for the label text. To the label text is provided a floating point
17736     * value, so the label text can display up to 1 floating point value.
17737     * Note that this is optional.
17738     *
17739     * Use a format string such as "%1.2f meters" for example, and it will
17740     * display values like: "3.14 meters" for a value equal to 3.14159.
17741     *
17742     * Default is indicator label disabled.
17743     *
17744     * @see elm_slider_indicator_format_get()
17745     *
17746     * @ingroup Slider
17747     */
17748    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17749
17750    /**
17751     * Get the indicator label format of the slider.
17752     *
17753     * @param obj The slider object.
17754     * @return The indicator label format string in UTF-8.
17755     *
17756     * The slider may display its value somewhere else then unit label,
17757     * for example, above the slider knob that is dragged around. This function
17758     * gets the format string used for this.
17759     *
17760     * @see elm_slider_indicator_format_set() for more
17761     * information on how this works.
17762     *
17763     * @ingroup Slider
17764     */
17765    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17766
17767    /**
17768     * Set the format function pointer for the indicator label
17769     *
17770     * @param obj The slider object.
17771     * @param func The indicator format function.
17772     * @param free_func The freeing function for the format string.
17773     *
17774     * Set the callback function to format the indicator string.
17775     *
17776     * @see elm_slider_indicator_format_set() for more info on how this works.
17777     *
17778     * @ingroup Slider
17779     */
17780   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);
17781
17782   /**
17783    * Set the format function pointer for the units label
17784    *
17785    * @param obj The slider object.
17786    * @param func The units format function.
17787    * @param free_func The freeing function for the format string.
17788    *
17789    * Set the callback function to format the indicator string.
17790    *
17791    * @see elm_slider_units_format_set() for more info on how this works.
17792    *
17793    * @ingroup Slider
17794    */
17795   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);
17796
17797   /**
17798    * Set the orientation of a given slider widget.
17799    *
17800    * @param obj The slider object.
17801    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17802    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17803    *
17804    * Use this function to change how your slider is to be
17805    * disposed: vertically or horizontally.
17806    *
17807    * By default it's displayed horizontally.
17808    *
17809    * @see elm_slider_horizontal_get()
17810    *
17811    * @ingroup Slider
17812    */
17813    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17814
17815    /**
17816     * Retrieve the orientation of a given slider widget
17817     *
17818     * @param obj The slider object.
17819     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17820     * @c EINA_FALSE if it's @b vertical (and on errors).
17821     *
17822     * @see elm_slider_horizontal_set() for more details.
17823     *
17824     * @ingroup Slider
17825     */
17826    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17827
17828    /**
17829     * Set the minimum and maximum values for the slider.
17830     *
17831     * @param obj The slider object.
17832     * @param min The minimum value.
17833     * @param max The maximum value.
17834     *
17835     * Define the allowed range of values to be selected by the user.
17836     *
17837     * If actual value is less than @p min, it will be updated to @p min. If it
17838     * is bigger then @p max, will be updated to @p max. Actual value can be
17839     * get with elm_slider_value_get().
17840     *
17841     * By default, min is equal to 0.0, and max is equal to 1.0.
17842     *
17843     * @warning Maximum must be greater than minimum, otherwise behavior
17844     * is undefined.
17845     *
17846     * @see elm_slider_min_max_get()
17847     *
17848     * @ingroup Slider
17849     */
17850    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17851
17852    /**
17853     * Get the minimum and maximum values of the slider.
17854     *
17855     * @param obj The slider object.
17856     * @param min Pointer where to store the minimum value.
17857     * @param max Pointer where to store the maximum value.
17858     *
17859     * @note If only one value is needed, the other pointer can be passed
17860     * as @c NULL.
17861     *
17862     * @see elm_slider_min_max_set() for details.
17863     *
17864     * @ingroup Slider
17865     */
17866    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17867
17868    /**
17869     * Set the value the slider displays.
17870     *
17871     * @param obj The slider object.
17872     * @param val The value to be displayed.
17873     *
17874     * Value will be presented on the unit label following format specified with
17875     * elm_slider_unit_format_set() and on indicator with
17876     * elm_slider_indicator_format_set().
17877     *
17878     * @warning The value must to be between min and max values. This values
17879     * are set by elm_slider_min_max_set().
17880     *
17881     * @see elm_slider_value_get()
17882     * @see elm_slider_unit_format_set()
17883     * @see elm_slider_indicator_format_set()
17884     * @see elm_slider_min_max_set()
17885     *
17886     * @ingroup Slider
17887     */
17888    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17889
17890    /**
17891     * Get the value displayed by the spinner.
17892     *
17893     * @param obj The spinner object.
17894     * @return The value displayed.
17895     *
17896     * @see elm_spinner_value_set() for details.
17897     *
17898     * @ingroup Slider
17899     */
17900    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17901
17902    /**
17903     * Invert a given slider widget's displaying values order
17904     *
17905     * @param obj The slider object.
17906     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17907     * @c EINA_FALSE to bring it back to default, non-inverted values.
17908     *
17909     * A slider may be @b inverted, in which state it gets its
17910     * values inverted, with high vales being on the left or top and
17911     * low values on the right or bottom, as opposed to normally have
17912     * the low values on the former and high values on the latter,
17913     * respectively, for horizontal and vertical modes.
17914     *
17915     * @see elm_slider_inverted_get()
17916     *
17917     * @ingroup Slider
17918     */
17919    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17920
17921    /**
17922     * Get whether a given slider widget's displaying values are
17923     * inverted or not.
17924     *
17925     * @param obj The slider object.
17926     * @return @c EINA_TRUE, if @p obj has inverted values,
17927     * @c EINA_FALSE otherwise (and on errors).
17928     *
17929     * @see elm_slider_inverted_set() for more details.
17930     *
17931     * @ingroup Slider
17932     */
17933    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17934
17935    /**
17936     * Set whether to enlarge slider indicator (augmented knob) or not.
17937     *
17938     * @param obj The slider object.
17939     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17940     * let the knob always at default size.
17941     *
17942     * By default, indicator will be bigger while dragged by the user.
17943     *
17944     * @warning It won't display values set with
17945     * elm_slider_indicator_format_set() if you disable indicator.
17946     *
17947     * @ingroup Slider
17948     */
17949    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17950
17951    /**
17952     * Get whether a given slider widget's enlarging indicator or not.
17953     *
17954     * @param obj The slider object.
17955     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17956     * @c EINA_FALSE otherwise (and on errors).
17957     *
17958     * @see elm_slider_indicator_show_set() for details.
17959     *
17960     * @ingroup Slider
17961     */
17962    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17963
17964    /**
17965     * @}
17966     */
17967
17968    /**
17969     * @addtogroup Actionslider Actionslider
17970     *
17971     * @image html img/widget/actionslider/preview-00.png
17972     * @image latex img/widget/actionslider/preview-00.eps
17973     *
17974     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17975     * properties. The user drags and releases the indicator, to choose a label.
17976     *
17977     * Labels occupy the following positions.
17978     * a. Left
17979     * b. Right
17980     * c. Center
17981     *
17982     * Positions can be enabled or disabled.
17983     *
17984     * Magnets can be set on the above positions.
17985     *
17986     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17987     *
17988     * @note By default all positions are set as enabled.
17989     *
17990     * Signals that you can add callbacks for are:
17991     *
17992     * "selected" - when user selects an enabled position (the label is passed
17993     *              as event info)".
17994     * @n
17995     * "pos_changed" - when the indicator reaches any of the positions("left",
17996     *                 "right" or "center").
17997     *
17998     * See an example of actionslider usage @ref actionslider_example_page "here"
17999     * @{
18000     */
18001
18002    typedef enum _Elm_Actionslider_Indicator_Pos
18003      {
18004         ELM_ACTIONSLIDER_INDICATOR_NONE,
18005         ELM_ACTIONSLIDER_INDICATOR_LEFT,
18006         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
18007         ELM_ACTIONSLIDER_INDICATOR_CENTER
18008      } Elm_Actionslider_Indicator_Pos;
18009
18010    typedef enum _Elm_Actionslider_Magnet_Pos
18011      {
18012         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
18013         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
18014         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
18015         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
18016         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
18017         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
18018      } Elm_Actionslider_Magnet_Pos;
18019
18020    typedef enum _Elm_Actionslider_Label_Pos
18021      {
18022         ELM_ACTIONSLIDER_LABEL_LEFT,
18023         ELM_ACTIONSLIDER_LABEL_RIGHT,
18024         ELM_ACTIONSLIDER_LABEL_CENTER,
18025         ELM_ACTIONSLIDER_LABEL_BUTTON
18026      } Elm_Actionslider_Label_Pos;
18027
18028    /* smart callbacks called:
18029     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
18030     */
18031
18032    /**
18033     * Add a new actionslider to the parent.
18034     *
18035     * @param parent The parent object
18036     * @return The new actionslider object or NULL if it cannot be created
18037     */
18038    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18039
18040    /**
18041    * Set actionslider label.
18042    *
18043    * @param[in] obj The actionslider object
18044    * @param[in] pos The position of the label.
18045    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
18046    * @param label The label which is going to be set.
18047    */
18048    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
18049    /**
18050     * Get actionslider labels.
18051     *
18052     * @param obj The actionslider object
18053     * @param left_label A char** to place the left_label of @p obj into.
18054     * @param center_label A char** to place the center_label of @p obj into.
18055     * @param right_label A char** to place the right_label of @p obj into.
18056     */
18057    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);
18058    /**
18059     * Get actionslider selected label.
18060     *
18061     * @param obj The actionslider object
18062     * @return The selected label
18063     */
18064    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18065    /**
18066     * Set actionslider indicator position.
18067     *
18068     * @param obj The actionslider object.
18069     * @param pos The position of the indicator.
18070     */
18071    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
18072    /**
18073     * Get actionslider indicator position.
18074     *
18075     * @param obj The actionslider object.
18076     * @return The position of the indicator.
18077     */
18078    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18079    /**
18080     * Set actionslider magnet position. To make multiple positions magnets @c or
18081     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
18082     *
18083     * @param obj The actionslider object.
18084     * @param pos Bit mask indicating the magnet positions.
18085     */
18086    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18087    /**
18088     * Get actionslider magnet position.
18089     *
18090     * @param obj The actionslider object.
18091     * @return The positions with magnet property.
18092     */
18093    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18094    /**
18095     * Set actionslider enabled position. To set multiple positions as enabled @c or
18096     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
18097     *
18098     * @note All the positions are enabled by default.
18099     *
18100     * @param obj The actionslider object.
18101     * @param pos Bit mask indicating the enabled positions.
18102     */
18103    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18104    /**
18105     * Get actionslider enabled position.
18106     *
18107     * @param obj The actionslider object.
18108     * @return The enabled positions.
18109     */
18110    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18111    /**
18112     * Set the label used on the indicator.
18113     *
18114     * @param obj The actionslider object
18115     * @param label The label to be set on the indicator.
18116     * @deprecated use elm_object_text_set() instead.
18117     */
18118    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18119    /**
18120     * Get the label used on the indicator object.
18121     *
18122     * @param obj The actionslider object
18123     * @return The indicator label
18124     * @deprecated use elm_object_text_get() instead.
18125     */
18126    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18127
18128    /**
18129    * Hold actionslider object movement.
18130    *
18131    * @param[in] obj The actionslider object
18132    * @param[in] flag Actionslider hold/release
18133    * (EINA_TURE = hold/EIN_FALSE = release)
18134    *
18135    * @ingroup Actionslider
18136    */
18137    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18138
18139
18140    /**
18141     * @}
18142     */
18143
18144    /**
18145     * @defgroup Genlist Genlist
18146     *
18147     * @image html img/widget/genlist/preview-00.png
18148     * @image latex img/widget/genlist/preview-00.eps
18149     * @image html img/genlist.png
18150     * @image latex img/genlist.eps
18151     *
18152     * This widget aims to have more expansive list than the simple list in
18153     * Elementary that could have more flexible items and allow many more entries
18154     * while still being fast and low on memory usage. At the same time it was
18155     * also made to be able to do tree structures. But the price to pay is more
18156     * complexity when it comes to usage. If all you want is a simple list with
18157     * icons and a single label, use the normal @ref List object.
18158     *
18159     * Genlist has a fairly large API, mostly because it's relatively complex,
18160     * trying to be both expansive, powerful and efficient. First we will begin
18161     * an overview on the theory behind genlist.
18162     *
18163     * @section Genlist_Item_Class Genlist item classes - creating items
18164     *
18165     * In order to have the ability to add and delete items on the fly, genlist
18166     * implements a class (callback) system where the application provides a
18167     * structure with information about that type of item (genlist may contain
18168     * multiple different items with different classes, states and styles).
18169     * Genlist will call the functions in this struct (methods) when an item is
18170     * "realized" (i.e., created dynamically, while the user is scrolling the
18171     * grid). All objects will simply be deleted when no longer needed with
18172     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18173     * following members:
18174     * - @c item_style - This is a constant string and simply defines the name
18175     *   of the item style. It @b must be specified and the default should be @c
18176     *   "default".
18177     *
18178     * - @c func - A struct with pointers to functions that will be called when
18179     *   an item is going to be actually created. All of them receive a @c data
18180     *   parameter that will point to the same data passed to
18181     *   elm_genlist_item_append() and related item creation functions, and a @c
18182     *   obj parameter that points to the genlist object itself.
18183     *
18184     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18185     * state_get and @c del. The 3 first functions also receive a @c part
18186     * parameter described below. A brief description of these functions follows:
18187     *
18188     * - @c label_get - The @c part parameter is the name string of one of the
18189     *   existing text parts in the Edje group implementing the item's theme.
18190     *   This function @b must return a strdup'()ed string, as the caller will
18191     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18192     * - @c content_get - The @c part parameter is the name string of one of the
18193     *   existing (content) swallow parts in the Edje group implementing the item's
18194     *   theme. It must return @c NULL, when no content is desired, or a valid
18195     *   object handle, otherwise.  The object will be deleted by the genlist on
18196     *   its deletion or when the item is "unrealized".  See
18197     *   #Elm_Genlist_Item_Content_Get_Cb.
18198     * - @c func.state_get - The @c part parameter is the name string of one of
18199     *   the state parts in the Edje group implementing the item's theme. Return
18200     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18201     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18202     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18203     *   the state is true (the default is false), where @c XXX is the name of
18204     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18205     * - @c func.del - This is intended for use when genlist items are deleted,
18206     *   so any data attached to the item (e.g. its data parameter on creation)
18207     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18208     *
18209     * available item styles:
18210     * - default
18211     * - default_style - The text part is a textblock
18212     *
18213     * @image html img/widget/genlist/preview-04.png
18214     * @image latex img/widget/genlist/preview-04.eps
18215     *
18216     * - double_label
18217     *
18218     * @image html img/widget/genlist/preview-01.png
18219     * @image latex img/widget/genlist/preview-01.eps
18220     *
18221     * - icon_top_text_bottom
18222     *
18223     * @image html img/widget/genlist/preview-02.png
18224     * @image latex img/widget/genlist/preview-02.eps
18225     *
18226     * - group_index
18227     *
18228     * @image html img/widget/genlist/preview-03.png
18229     * @image latex img/widget/genlist/preview-03.eps
18230     *
18231     * @section Genlist_Items Structure of items
18232     *
18233     * An item in a genlist can have 0 or more text labels (they can be regular
18234     * text or textblock Evas objects - that's up to the style to determine), 0
18235     * or more contents (which are simply objects swallowed into the genlist item's
18236     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18237     * behavior left to the user to define. The Edje part names for each of
18238     * these properties will be looked up, in the theme file for the genlist,
18239     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18240     * "states", respectively. For each of those properties, if more than one
18241     * part is provided, they must have names listed separated by spaces in the
18242     * data fields. For the default genlist item theme, we have @b one label
18243     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18244     * "elm.swallow.end") and @b no state parts.
18245     *
18246     * A genlist item may be at one of several styles. Elementary provides one
18247     * by default - "default", but this can be extended by system or application
18248     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18249     * details).
18250     *
18251     * @section Genlist_Manipulation Editing and Navigating
18252     *
18253     * Items can be added by several calls. All of them return a @ref
18254     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18255     * They all take a data parameter that is meant to be used for a handle to
18256     * the applications internal data (eg the struct with the original item
18257     * data). The parent parameter is the parent genlist item this belongs to if
18258     * it is a tree or an indexed group, and NULL if there is no parent. The
18259     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18260     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18261     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18262     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18263     * is set then this item is group index item that is displayed at the top
18264     * until the next group comes. The func parameter is a convenience callback
18265     * that is called when the item is selected and the data parameter will be
18266     * the func_data parameter, obj be the genlist object and event_info will be
18267     * the genlist item.
18268     *
18269     * elm_genlist_item_append() adds an item to the end of the list, or if
18270     * there is a parent, to the end of all the child items of the parent.
18271     * elm_genlist_item_prepend() is the same but adds to the beginning of
18272     * the list or children list. elm_genlist_item_insert_before() inserts at
18273     * item before another item and elm_genlist_item_insert_after() inserts after
18274     * the indicated item.
18275     *
18276     * The application can clear the list with elm_gen_clear() which deletes
18277     * all the items in the list and elm_genlist_item_del() will delete a specific
18278     * item. elm_genlist_item_subitems_clear() will clear all items that are
18279     * children of the indicated parent item.
18280     *
18281     * To help inspect list items you can jump to the item at the top of the list
18282     * with elm_genlist_first_item_get() which will return the item pointer, and
18283     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18284     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18285     * and previous items respectively relative to the indicated item. Using
18286     * these calls you can walk the entire item list/tree. Note that as a tree
18287     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18288     * let you know which item is the parent (and thus know how to skip them if
18289     * wanted).
18290     *
18291     * @section Genlist_Muti_Selection Multi-selection
18292     *
18293     * If the application wants multiple items to be able to be selected,
18294     * elm_genlist_multi_select_set() can enable this. If the list is
18295     * single-selection only (the default), then elm_genlist_selected_item_get()
18296     * will return the selected item, if any, or NULL if none is selected. If the
18297     * list is multi-select then elm_genlist_selected_items_get() will return a
18298     * list (that is only valid as long as no items are modified (added, deleted,
18299     * selected or unselected)).
18300     *
18301     * @section Genlist_Usage_Hints Usage hints
18302     *
18303     * There are also convenience functions. elm_gen_item_genlist_get() will
18304     * return the genlist object the item belongs to. elm_genlist_item_show()
18305     * will make the scroller scroll to show that specific item so its visible.
18306     * elm_genlist_item_data_get() returns the data pointer set by the item
18307     * creation functions.
18308     *
18309     * If an item changes (state of boolean changes, label or contents change),
18310     * then use elm_genlist_item_update() to have genlist update the item with
18311     * the new state. Genlist will re-realize the item thus call the functions
18312     * in the _Elm_Genlist_Item_Class for that item.
18313     *
18314     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18315     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18316     * to expand/contract an item and get its expanded state, use
18317     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18318     * again to make an item disabled (unable to be selected and appear
18319     * differently) use elm_genlist_item_disabled_set() to set this and
18320     * elm_genlist_item_disabled_get() to get the disabled state.
18321     *
18322     * In general to indicate how the genlist should expand items horizontally to
18323     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18324     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18325     * mode means that if items are too wide to fit, the scroller will scroll
18326     * horizontally. Otherwise items are expanded to fill the width of the
18327     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18328     * to the viewport width and limited to that size. This can be combined with
18329     * a different style that uses edjes' ellipsis feature (cutting text off like
18330     * this: "tex...").
18331     *
18332     * Items will only call their selection func and callback when first becoming
18333     * selected. Any further clicks will do nothing, unless you enable always
18334     * select with elm_gen_always_select_mode_set(). This means even if
18335     * selected, every click will make the selected callbacks be called.
18336     * elm_genlist_no_select_mode_set() will turn off the ability to select
18337     * items entirely and they will neither appear selected nor call selected
18338     * callback functions.
18339     *
18340     * Remember that you can create new styles and add your own theme augmentation
18341     * per application with elm_theme_extension_add(). If you absolutely must
18342     * have a specific style that overrides any theme the user or system sets up
18343     * you can use elm_theme_overlay_add() to add such a file.
18344     *
18345     * @section Genlist_Implementation Implementation
18346     *
18347     * Evas tracks every object you create. Every time it processes an event
18348     * (mouse move, down, up etc.) it needs to walk through objects and find out
18349     * what event that affects. Even worse every time it renders display updates,
18350     * in order to just calculate what to re-draw, it needs to walk through many
18351     * many many objects. Thus, the more objects you keep active, the more
18352     * overhead Evas has in just doing its work. It is advisable to keep your
18353     * active objects to the minimum working set you need. Also remember that
18354     * object creation and deletion carries an overhead, so there is a
18355     * middle-ground, which is not easily determined. But don't keep massive lists
18356     * of objects you can't see or use. Genlist does this with list objects. It
18357     * creates and destroys them dynamically as you scroll around. It groups them
18358     * into blocks so it can determine the visibility etc. of a whole block at
18359     * once as opposed to having to walk the whole list. This 2-level list allows
18360     * for very large numbers of items to be in the list (tests have used up to
18361     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18362     * may be different sizes, every item added needs to be calculated as to its
18363     * size and thus this presents a lot of overhead on populating the list, this
18364     * genlist employs a queue. Any item added is queued and spooled off over
18365     * time, actually appearing some time later, so if your list has many members
18366     * you may find it takes a while for them to all appear, with your process
18367     * consuming a lot of CPU while it is busy spooling.
18368     *
18369     * Genlist also implements a tree structure, but it does so with callbacks to
18370     * the application, with the application filling in tree structures when
18371     * requested (allowing for efficient building of a very deep tree that could
18372     * even be used for file-management). See the above smart signal callbacks for
18373     * details.
18374     *
18375     * @section Genlist_Smart_Events Genlist smart events
18376     *
18377     * Signals that you can add callbacks for are:
18378     * - @c "activated" - The user has double-clicked or pressed
18379     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18380     *   item that was activated.
18381     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18382     *   event_info parameter is the item that was double-clicked.
18383     * - @c "selected" - This is called when a user has made an item selected.
18384     *   The event_info parameter is the genlist item that was selected.
18385     * - @c "unselected" - This is called when a user has made an item
18386     *   unselected. The event_info parameter is the genlist item that was
18387     *   unselected.
18388     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18389     *   called and the item is now meant to be expanded. The event_info
18390     *   parameter is the genlist item that was indicated to expand.  It is the
18391     *   job of this callback to then fill in the child items.
18392     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18393     *   called and the item is now meant to be contracted. The event_info
18394     *   parameter is the genlist item that was indicated to contract. It is the
18395     *   job of this callback to then delete the child items.
18396     * - @c "expand,request" - This is called when a user has indicated they want
18397     *   to expand a tree branch item. The callback should decide if the item can
18398     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18399     *   appropriately to set the state. The event_info parameter is the genlist
18400     *   item that was indicated to expand.
18401     * - @c "contract,request" - This is called when a user has indicated they
18402     *   want to contract a tree branch item. The callback should decide if the
18403     *   item can contract (has any children) and then call
18404     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18405     *   event_info parameter is the genlist item that was indicated to contract.
18406     * - @c "realized" - This is called when the item in the list is created as a
18407     *   real evas object. event_info parameter is the genlist item that was
18408     *   created. The object may be deleted at any time, so it is up to the
18409     *   caller to not use the object pointer from elm_genlist_item_object_get()
18410     *   in a way where it may point to freed objects.
18411     * - @c "unrealized" - This is called just before an item is unrealized.
18412     *   After this call content objects provided will be deleted and the item
18413     *   object itself delete or be put into a floating cache.
18414     * - @c "drag,start,up" - This is called when the item in the list has been
18415     *   dragged (not scrolled) up.
18416     * - @c "drag,start,down" - This is called when the item in the list has been
18417     *   dragged (not scrolled) down.
18418     * - @c "drag,start,left" - This is called when the item in the list has been
18419     *   dragged (not scrolled) left.
18420     * - @c "drag,start,right" - This is called when the item in the list has
18421     *   been dragged (not scrolled) right.
18422     * - @c "drag,stop" - This is called when the item in the list has stopped
18423     *   being dragged.
18424     * - @c "drag" - This is called when the item in the list is being dragged.
18425     * - @c "longpressed" - This is called when the item is pressed for a certain
18426     *   amount of time. By default it's 1 second.
18427     * - @c "scroll,anim,start" - This is called when scrolling animation has
18428     *   started.
18429     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18430     *   stopped.
18431     * - @c "scroll,drag,start" - This is called when dragging the content has
18432     *   started.
18433     * - @c "scroll,drag,stop" - This is called when dragging the content has
18434     *   stopped.
18435     * - @c "edge,top" - This is called when the genlist is scrolled until
18436     *   the top edge.
18437     * - @c "edge,bottom" - This is called when the genlist is scrolled
18438     *   until the bottom edge.
18439     * - @c "edge,left" - This is called when the genlist is scrolled
18440     *   until the left edge.
18441     * - @c "edge,right" - This is called when the genlist is scrolled
18442     *   until the right edge.
18443     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18444     *   swiped left.
18445     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18446     *   swiped right.
18447     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18448     *   swiped up.
18449     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18450     *   swiped down.
18451     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18452     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18453     *   multi-touch pinched in.
18454     * - @c "swipe" - This is called when the genlist is swiped.
18455     * - @c "moved" - This is called when a genlist item is moved.
18456     * - @c "language,changed" - This is called when the program's language is
18457     *   changed.
18458     *
18459     * @section Genlist_Examples Examples
18460     *
18461     * Here is a list of examples that use the genlist, trying to show some of
18462     * its capabilities:
18463     * - @ref genlist_example_01
18464     * - @ref genlist_example_02
18465     * - @ref genlist_example_03
18466     * - @ref genlist_example_04
18467     * - @ref genlist_example_05
18468     */
18469
18470    /**
18471     * @addtogroup Genlist
18472     * @{
18473     */
18474
18475    /**
18476     * @enum _Elm_Genlist_Item_Flags
18477     * @typedef Elm_Genlist_Item_Flags
18478     *
18479     * Defines if the item is of any special type (has subitems or it's the
18480     * index of a group), or is just a simple item.
18481     *
18482     * @ingroup Genlist
18483     */
18484    typedef enum _Elm_Genlist_Item_Flags
18485      {
18486         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18487         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18488         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18489      } Elm_Genlist_Item_Flags;
18490    typedef enum _Elm_Genlist_Item_Field_Flags
18491      {
18492         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18493         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18494         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18495         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18496      } Elm_Genlist_Item_Field_Flags;
18497    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18498    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18499    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18500    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18501    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
18502    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18503    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
18504    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18505
18506    /**
18507     * @struct _Elm_Genlist_Item_Class
18508     *
18509     * Genlist item class definition structs.
18510     *
18511     * This struct contains the style and fetching functions that will define the
18512     * contents of each item.
18513     *
18514     * @see @ref Genlist_Item_Class
18515     */
18516    struct _Elm_Genlist_Item_Class
18517      {
18518         const char                *item_style;
18519         struct {
18520           GenlistItemLabelGetFunc  label_get;
18521           GenlistItemIconGetFunc   icon_get;
18522           GenlistItemStateGetFunc  state_get;
18523           GenlistItemDelFunc       del;
18524           GenlistItemMovedFunc     moved;
18525         } func;
18526         const char *edit_item_style;
18527         const char                *mode_item_style;
18528      };
18529    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18530    /**
18531     * Add a new genlist widget to the given parent Elementary
18532     * (container) object
18533     *
18534     * @param parent The parent object
18535     * @return a new genlist widget handle or @c NULL, on errors
18536     *
18537     * This function inserts a new genlist widget on the canvas.
18538     *
18539     * @see elm_genlist_item_append()
18540     * @see elm_genlist_item_del()
18541     * @see elm_gen_clear()
18542     *
18543     * @ingroup Genlist
18544     */
18545    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18546    /**
18547     * Remove all items from a given genlist widget.
18548     *
18549     * @param obj The genlist object
18550     *
18551     * This removes (and deletes) all items in @p obj, leaving it empty.
18552     *
18553     * This is deprecated. Please use elm_gen_clear() instead.
18554     * 
18555     * @see elm_genlist_item_del(), to remove just one item.
18556     *
18557     * @ingroup Genlist
18558     */
18559    WILL_DEPRECATE  EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18560    /**
18561     * Enable or disable multi-selection in the genlist
18562     *
18563     * @param obj The genlist object
18564     * @param multi Multi-select enable/disable. Default is disabled.
18565     *
18566     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18567     * the list. This allows more than 1 item to be selected. To retrieve the list
18568     * of selected items, use elm_genlist_selected_items_get().
18569     *
18570     * @see elm_genlist_selected_items_get()
18571     * @see elm_genlist_multi_select_get()
18572     *
18573     * @ingroup Genlist
18574     */
18575    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18576    /**
18577     * Gets if multi-selection in genlist is enabled or disabled.
18578     *
18579     * @param obj The genlist object
18580     * @return Multi-select enabled/disabled
18581     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18582     *
18583     * @see elm_genlist_multi_select_set()
18584     *
18585     * @ingroup Genlist
18586     */
18587    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18588    /**
18589     * This sets the horizontal stretching mode.
18590     *
18591     * @param obj The genlist object
18592     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18593     *
18594     * This sets the mode used for sizing items horizontally. Valid modes
18595     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18596     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18597     * the scroller will scroll horizontally. Otherwise items are expanded
18598     * to fill the width of the viewport of the scroller. If it is
18599     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18600     * limited to that size.
18601     *
18602     * @see elm_genlist_horizontal_get()
18603     *
18604     * @ingroup Genlist
18605     */
18606    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18607    /**
18608     * Gets the horizontal stretching mode.
18609     *
18610     * @param obj The genlist object
18611     * @return The mode to use
18612     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18613     *
18614     * @see elm_genlist_horizontal_set()
18615     *
18616     * @ingroup Genlist
18617     */
18618    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18619    /**
18620     * Set the always select mode.
18621     *
18622     * @param obj The genlist object
18623     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18624     * EINA_FALSE = off). Default is @c EINA_FALSE.
18625     *
18626     * Items will only call their selection func and callback when first
18627     * becoming selected. Any further clicks will do nothing, unless you
18628     * enable always select with elm_gen_always_select_mode_set().
18629     * This means that, even if selected, every click will make the selected
18630     * callbacks be called.
18631     * 
18632     * This function is deprecated. please see elm_gen_always_select_mode_set()
18633     *
18634     * @see elm_genlist_always_select_mode_get()
18635     *
18636     * @ingroup Genlist
18637     */
18638    WILL_DEPRECATE  EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18639    /**
18640     * Get the always select mode.
18641     *
18642     * @param obj The genlist object
18643     * @return The always select mode
18644     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18645     *
18646     * @see elm_genlist_always_select_mode_set()
18647     *
18648     * @ingroup Genlist
18649     */
18650    WILL_DEPRECATE  EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18651    /**
18652     * Enable/disable the no select mode.
18653     *
18654     * @param obj The genlist object
18655     * @param no_select The no select mode
18656     * (EINA_TRUE = on, EINA_FALSE = off)
18657     *
18658     * This will turn off the ability to select items entirely and they
18659     * will neither appear selected nor call selected callback functions.
18660     *
18661     * @see elm_genlist_no_select_mode_get()
18662     *
18663     * @ingroup Genlist
18664     */
18665    WILL_DEPRECATE  EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18666    /**
18667     * Gets whether the no select mode is enabled.
18668     *
18669     * @param obj The genlist object
18670     * @return The no select mode
18671     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18672     *
18673     * @see elm_genlist_no_select_mode_set()
18674     *
18675     * @ingroup Genlist
18676     */
18677    WILL_DEPRECATE  EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18678    /**
18679     * Enable/disable compress mode.
18680     *
18681     * @param obj The genlist object
18682     * @param compress The compress mode
18683     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18684     *
18685     * This will enable the compress mode where items are "compressed"
18686     * horizontally to fit the genlist scrollable viewport width. This is
18687     * special for genlist.  Do not rely on
18688     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18689     * work as genlist needs to handle it specially.
18690     *
18691     * @see elm_genlist_compress_mode_get()
18692     *
18693     * @ingroup Genlist
18694     */
18695    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18696    /**
18697     * Get whether the compress mode is enabled.
18698     *
18699     * @param obj The genlist object
18700     * @return The compress mode
18701     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18702     *
18703     * @see elm_genlist_compress_mode_set()
18704     *
18705     * @ingroup Genlist
18706     */
18707    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18708    /**
18709     * Enable/disable height-for-width mode.
18710     *
18711     * @param obj The genlist object
18712     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18713     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18714     *
18715     * With height-for-width mode the item width will be fixed (restricted
18716     * to a minimum of) to the list width when calculating its size in
18717     * order to allow the height to be calculated based on it. This allows,
18718     * for instance, text block to wrap lines if the Edje part is
18719     * configured with "text.min: 0 1".
18720     *
18721     * @note This mode will make list resize slower as it will have to
18722     *       recalculate every item height again whenever the list width
18723     *       changes!
18724     *
18725     * @note When height-for-width mode is enabled, it also enables
18726     *       compress mode (see elm_genlist_compress_mode_set()) and
18727     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18728     *
18729     * @ingroup Genlist
18730     */
18731    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18732    /**
18733     * Get whether the height-for-width mode is enabled.
18734     *
18735     * @param obj The genlist object
18736     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18737     * off)
18738     *
18739     * @ingroup Genlist
18740     */
18741    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18742    /**
18743     * Enable/disable horizontal and vertical bouncing effect.
18744     *
18745     * @param obj The genlist object
18746     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18747     * EINA_FALSE = off). Default is @c EINA_FALSE.
18748     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18749     * EINA_FALSE = off). Default is @c EINA_TRUE.
18750     *
18751     * This will enable or disable the scroller bouncing effect for the
18752     * genlist. See elm_scroller_bounce_set() for details.
18753     *
18754     * @see elm_scroller_bounce_set()
18755     * @see elm_genlist_bounce_get()
18756     *
18757     * @ingroup Genlist
18758     */
18759    WILL_DEPRECATE  EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18760    /**
18761     * Get whether the horizontal and vertical bouncing effect is enabled.
18762     *
18763     * @param obj The genlist object
18764     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18765     * option is set.
18766     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18767     * option is set.
18768     *
18769     * @see elm_genlist_bounce_set()
18770     *
18771     * @ingroup Genlist
18772     */
18773    WILL_DEPRECATE  EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18774    /**
18775     * Enable/disable homogenous mode.
18776     *
18777     * @param obj The genlist object
18778     * @param homogeneous Assume the items within the genlist are of the
18779     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18780     * EINA_FALSE.
18781     *
18782     * This will enable the homogeneous mode where items are of the same
18783     * height and width so that genlist may do the lazy-loading at its
18784     * maximum (which increases the performance for scrolling the list). This
18785     * implies 'compressed' mode.
18786     *
18787     * @see elm_genlist_compress_mode_set()
18788     * @see elm_genlist_homogeneous_get()
18789     *
18790     * @ingroup Genlist
18791     */
18792    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18793    /**
18794     * Get whether the homogenous mode is enabled.
18795     *
18796     * @param obj The genlist object
18797     * @return Assume the items within the genlist are of the same height
18798     * and width (EINA_TRUE = on, EINA_FALSE = off)
18799     *
18800     * @see elm_genlist_homogeneous_set()
18801     *
18802     * @ingroup Genlist
18803     */
18804    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18805    /**
18806     * Set the maximum number of items within an item block
18807     *
18808     * @param obj The genlist object
18809     * @param n   Maximum number of items within an item block. Default is 32.
18810     *
18811     * This will configure the block count to tune to the target with
18812     * particular performance matrix.
18813     *
18814     * A block of objects will be used to reduce the number of operations due to
18815     * many objects in the screen. It can determine the visibility, or if the
18816     * object has changed, it theme needs to be updated, etc. doing this kind of
18817     * calculation to the entire block, instead of per object.
18818     *
18819     * The default value for the block count is enough for most lists, so unless
18820     * you know you will have a lot of objects visible in the screen at the same
18821     * time, don't try to change this.
18822     *
18823     * @see elm_genlist_block_count_get()
18824     * @see @ref Genlist_Implementation
18825     *
18826     * @ingroup Genlist
18827     */
18828    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18829    /**
18830     * Get the maximum number of items within an item block
18831     *
18832     * @param obj The genlist object
18833     * @return Maximum number of items within an item block
18834     *
18835     * @see elm_genlist_block_count_set()
18836     *
18837     * @ingroup Genlist
18838     */
18839    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18840    /**
18841     * Set the timeout in seconds for the longpress event.
18842     *
18843     * @param obj The genlist object
18844     * @param timeout timeout in seconds. Default is 1.
18845     *
18846     * This option will change how long it takes to send an event "longpressed"
18847     * after the mouse down signal is sent to the list. If this event occurs, no
18848     * "clicked" event will be sent.
18849     *
18850     * @see elm_genlist_longpress_timeout_set()
18851     *
18852     * @ingroup Genlist
18853     */
18854    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18855    /**
18856     * Get the timeout in seconds for the longpress event.
18857     *
18858     * @param obj The genlist object
18859     * @return timeout in seconds
18860     *
18861     * @see elm_genlist_longpress_timeout_get()
18862     *
18863     * @ingroup Genlist
18864     */
18865    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18866    /**
18867     * Append a new item in a given genlist widget.
18868     *
18869     * @param obj The genlist object
18870     * @param itc The item class for the item
18871     * @param data The item data
18872     * @param parent The parent item, or NULL if none
18873     * @param flags Item flags
18874     * @param func Convenience function called when the item is selected
18875     * @param func_data Data passed to @p func above.
18876     * @return A handle to the item added or @c NULL if not possible
18877     *
18878     * This adds the given item to the end of the list or the end of
18879     * the children list if the @p parent is given.
18880     *
18881     * @see elm_genlist_item_prepend()
18882     * @see elm_genlist_item_insert_before()
18883     * @see elm_genlist_item_insert_after()
18884     * @see elm_genlist_item_del()
18885     *
18886     * @ingroup Genlist
18887     */
18888    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);
18889    /**
18890     * Prepend a new item in a given genlist widget.
18891     *
18892     * @param obj The genlist object
18893     * @param itc The item class for the item
18894     * @param data The item data
18895     * @param parent The parent item, or NULL if none
18896     * @param flags Item flags
18897     * @param func Convenience function called when the item is selected
18898     * @param func_data Data passed to @p func above.
18899     * @return A handle to the item added or NULL if not possible
18900     *
18901     * This adds an item to the beginning of the list or beginning of the
18902     * children of the parent if given.
18903     *
18904     * @see elm_genlist_item_append()
18905     * @see elm_genlist_item_insert_before()
18906     * @see elm_genlist_item_insert_after()
18907     * @see elm_genlist_item_del()
18908     *
18909     * @ingroup Genlist
18910     */
18911    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);
18912    /**
18913     * Insert an item before another in a genlist widget
18914     *
18915     * @param obj The genlist object
18916     * @param itc The item class for the item
18917     * @param data The item data
18918     * @param before The item to place this new one before.
18919     * @param flags Item flags
18920     * @param func Convenience function called when the item is selected
18921     * @param func_data Data passed to @p func above.
18922     * @return A handle to the item added or @c NULL if not possible
18923     *
18924     * This inserts an item before another in the list. It will be in the
18925     * same tree level or group as the item it is inserted before.
18926     *
18927     * @see elm_genlist_item_append()
18928     * @see elm_genlist_item_prepend()
18929     * @see elm_genlist_item_insert_after()
18930     * @see elm_genlist_item_del()
18931     *
18932     * @ingroup Genlist
18933     */
18934    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);
18935    /**
18936     * Insert an item after another in a genlist widget
18937     *
18938     * @param obj The genlist object
18939     * @param itc The item class for the item
18940     * @param data The item data
18941     * @param after The item to place this new one after.
18942     * @param flags Item flags
18943     * @param func Convenience function called when the item is selected
18944     * @param func_data Data passed to @p func above.
18945     * @return A handle to the item added or @c NULL if not possible
18946     *
18947     * This inserts an item after another in the list. It will be in the
18948     * same tree level or group as the item it is inserted after.
18949     *
18950     * @see elm_genlist_item_append()
18951     * @see elm_genlist_item_prepend()
18952     * @see elm_genlist_item_insert_before()
18953     * @see elm_genlist_item_del()
18954     *
18955     * @ingroup Genlist
18956     */
18957    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);
18958    /**
18959     * Insert a new item into the sorted genlist object
18960     *
18961     * @param obj The genlist object
18962     * @param itc The item class for the item
18963     * @param data The item data
18964     * @param parent The parent item, or NULL if none
18965     * @param flags Item flags
18966     * @param comp The function called for the sort
18967     * @param func Convenience function called when item selected
18968     * @param func_data Data passed to @p func above.
18969     * @return A handle to the item added or NULL if not possible
18970     *
18971     * @ingroup Genlist
18972     */
18973    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);
18974    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);
18975    /* operations to retrieve existing items */
18976    /**
18977     * Get the selectd item in the genlist.
18978     *
18979     * @param obj The genlist object
18980     * @return The selected item, or NULL if none is selected.
18981     *
18982     * This gets the selected item in the list (if multi-selection is enabled, only
18983     * the item that was first selected in the list is returned - which is not very
18984     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18985     * used).
18986     *
18987     * If no item is selected, NULL is returned.
18988     *
18989     * @see elm_genlist_selected_items_get()
18990     *
18991     * @ingroup Genlist
18992     */
18993    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18994    /**
18995     * Get a list of selected items in the genlist.
18996     *
18997     * @param obj The genlist object
18998     * @return The list of selected items, or NULL if none are selected.
18999     *
19000     * It returns a list of the selected items. This list pointer is only valid so
19001     * long as the selection doesn't change (no items are selected or unselected, or
19002     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19003     * pointers. The order of the items in this list is the order which they were
19004     * selected, i.e. the first item in this list is the first item that was
19005     * selected, and so on.
19006     *
19007     * @note If not in multi-select mode, consider using function
19008     * elm_genlist_selected_item_get() instead.
19009     *
19010     * @see elm_genlist_multi_select_set()
19011     * @see elm_genlist_selected_item_get()
19012     *
19013     * @ingroup Genlist
19014     */
19015    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19016    /**
19017     * Get the mode item style of items in the genlist
19018     * @param obj The genlist object
19019     * @return The mode item style string, or NULL if none is specified
19020     * 
19021     * This is a constant string and simply defines the name of the
19022     * style that will be used for mode animations. It can be
19023     * @c NULL if you don't plan to use Genlist mode. See
19024     * elm_genlist_item_mode_set() for more info.
19025     * 
19026     * @ingroup Genlist
19027     */
19028    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19029    /**
19030     * Set the mode item style of items in the genlist
19031     * @param obj The genlist object
19032     * @param style The mode item style string, or NULL if none is desired
19033     * 
19034     * This is a constant string and simply defines the name of the
19035     * style that will be used for mode animations. It can be
19036     * @c NULL if you don't plan to use Genlist mode. See
19037     * elm_genlist_item_mode_set() for more info.
19038     * 
19039     * @ingroup Genlist
19040     */
19041    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19042    /**
19043     * Get a list of realized items in genlist
19044     *
19045     * @param obj The genlist object
19046     * @return The list of realized items, nor NULL if none are realized.
19047     *
19048     * This returns a list of the realized items in the genlist. The list
19049     * contains Elm_Genlist_Item pointers. The list must be freed by the
19050     * caller when done with eina_list_free(). The item pointers in the
19051     * list are only valid so long as those items are not deleted or the
19052     * genlist is not deleted.
19053     *
19054     * @see elm_genlist_realized_items_update()
19055     *
19056     * @ingroup Genlist
19057     */
19058    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19059    /**
19060     * Get the item that is at the x, y canvas coords.
19061     *
19062     * @param obj The gelinst object.
19063     * @param x The input x coordinate
19064     * @param y The input y coordinate
19065     * @param posret The position relative to the item returned here
19066     * @return The item at the coordinates or NULL if none
19067     *
19068     * This returns the item at the given coordinates (which are canvas
19069     * relative, not object-relative). If an item is at that coordinate,
19070     * that item handle is returned, and if @p posret is not NULL, the
19071     * integer pointed to is set to a value of -1, 0 or 1, depending if
19072     * the coordinate is on the upper portion of that item (-1), on the
19073     * middle section (0) or on the lower part (1). If NULL is returned as
19074     * an item (no item found there), then posret may indicate -1 or 1
19075     * based if the coordinate is above or below all items respectively in
19076     * the genlist.
19077     *
19078     * @ingroup Genlist
19079     */
19080    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);
19081    /**
19082     * Get the first item in the genlist
19083     *
19084     * This returns the first item in the list.
19085     *
19086     * @param obj The genlist object
19087     * @return The first item, or NULL if none
19088     *
19089     * @ingroup Genlist
19090     */
19091    WILL_DEPRECATE  EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19092    /**
19093     * Get the last item in the genlist
19094     *
19095     * This returns the last item in the list.
19096     *
19097     * @return The last item, or NULL if none
19098     *
19099     * @ingroup Genlist
19100     */
19101    WILL_DEPRECATE  EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19102    /**
19103     * Set the scrollbar policy
19104     *
19105     * @param obj The genlist object
19106     * @param policy_h Horizontal scrollbar policy.
19107     * @param policy_v Vertical scrollbar policy.
19108     *
19109     * This sets the scrollbar visibility policy for the given genlist
19110     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19111     * made visible if it is needed, and otherwise kept hidden.
19112     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19113     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19114     * respectively for the horizontal and vertical scrollbars. Default is
19115     * #ELM_SMART_SCROLLER_POLICY_AUTO
19116     *
19117     * @see elm_genlist_scroller_policy_get()
19118     *
19119     * @ingroup Genlist
19120     */
19121    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19122    /**
19123     * Get the scrollbar policy
19124     *
19125     * @param obj The genlist object
19126     * @param policy_h Pointer to store the horizontal scrollbar policy.
19127     * @param policy_v Pointer to store the vertical scrollbar policy.
19128     *
19129     * @see elm_genlist_scroller_policy_set()
19130     *
19131     * @ingroup Genlist
19132     */
19133    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);
19134    /**
19135     * Get the @b next item in a genlist widget's internal list of items,
19136     * given a handle to one of those items.
19137     *
19138     * @param item The genlist item to fetch next from
19139     * @return The item after @p item, or @c NULL if there's none (and
19140     * on errors)
19141     *
19142     * This returns the item placed after the @p item, on the container
19143     * genlist.
19144     *
19145     * @see elm_genlist_item_prev_get()
19146     *
19147     * @ingroup Genlist
19148     */
19149    WILL_DEPRECATE  EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19150    /**
19151     * Get the @b previous item in a genlist widget's internal list of items,
19152     * given a handle to one of those items.
19153     *
19154     * @param item The genlist item to fetch previous from
19155     * @return The item before @p item, or @c NULL if there's none (and
19156     * on errors)
19157     *
19158     * This returns the item placed before the @p item, on the container
19159     * genlist.
19160     *
19161     * @see elm_genlist_item_next_get()
19162     *
19163     * @ingroup Genlist
19164     */
19165    WILL_DEPRECATE  EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19166    /**
19167     * Get the genlist object's handle which contains a given genlist
19168     * item
19169     *
19170     * @param item The item to fetch the container from
19171     * @return The genlist (parent) object
19172     *
19173     * This returns the genlist object itself that an item belongs to.
19174     *
19175     * This function is deprecated. Please use elm_gen_item_widget_get()
19176     * 
19177     * @ingroup Genlist
19178     */
19179    WILL_DEPRECATE  EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19180    /**
19181     * Get the parent item of the given item
19182     *
19183     * @param it The item
19184     * @return The parent of the item or @c NULL if it has no parent.
19185     *
19186     * This returns the item that was specified as parent of the item @p it on
19187     * elm_genlist_item_append() and insertion related functions.
19188     *
19189     * @ingroup Genlist
19190     */
19191    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19192    /**
19193     * Remove all sub-items (children) of the given item
19194     *
19195     * @param it The item
19196     *
19197     * This removes all items that are children (and their descendants) of the
19198     * given item @p it.
19199     *
19200     * @see elm_genlist_clear()
19201     * @see elm_genlist_item_del()
19202     *
19203     * @ingroup Genlist
19204     */
19205    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19206    /**
19207     * Set whether a given genlist item is selected or not
19208     *
19209     * @param it The item
19210     * @param selected Use @c EINA_TRUE, to make it selected, @c
19211     * EINA_FALSE to make it unselected
19212     *
19213     * This sets the selected state of an item. If multi selection is
19214     * not enabled on the containing genlist and @p selected is @c
19215     * EINA_TRUE, any other previously selected items will get
19216     * unselected in favor of this new one.
19217     *
19218     * @see elm_genlist_item_selected_get()
19219     *
19220     * @ingroup Genlist
19221     */
19222    WILL_DEPRECATE  EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19223    /**
19224     * Get whether a given genlist item is selected or not
19225     *
19226     * @param it The item
19227     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19228     *
19229     * @see elm_genlist_item_selected_set() for more details
19230     *
19231     * @ingroup Genlist
19232     */
19233    WILL_DEPRECATE  EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19234    /**
19235     * Sets the expanded state of an item.
19236     *
19237     * @param it The item
19238     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19239     *
19240     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19241     * expanded or not.
19242     *
19243     * The theme will respond to this change visually, and a signal "expanded" or
19244     * "contracted" will be sent from the genlist with a pointer to the item that
19245     * has been expanded/contracted.
19246     *
19247     * Calling this function won't show or hide any child of this item (if it is
19248     * a parent). You must manually delete and create them on the callbacks fo
19249     * the "expanded" or "contracted" signals.
19250     *
19251     * @see elm_genlist_item_expanded_get()
19252     *
19253     * @ingroup Genlist
19254     */
19255    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19256    /**
19257     * Get the expanded state of an item
19258     *
19259     * @param it The item
19260     * @return The expanded state
19261     *
19262     * This gets the expanded state of an item.
19263     *
19264     * @see elm_genlist_item_expanded_set()
19265     *
19266     * @ingroup Genlist
19267     */
19268    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19269    /**
19270     * Get the depth of expanded item
19271     *
19272     * @param it The genlist item object
19273     * @return The depth of expanded item
19274     *
19275     * @ingroup Genlist
19276     */
19277    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19278    /**
19279     * Set whether a given genlist item is disabled or not.
19280     *
19281     * @param it The item
19282     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19283     * to enable it back.
19284     *
19285     * A disabled item cannot be selected or unselected. It will also
19286     * change its appearance, to signal the user it's disabled.
19287     *
19288     * @see elm_genlist_item_disabled_get()
19289     *
19290     * @ingroup Genlist
19291     */
19292    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19293    /**
19294     * Get whether a given genlist item is disabled or not.
19295     *
19296     * @param it The item
19297     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19298     * (and on errors).
19299     *
19300     * @see elm_genlist_item_disabled_set() for more details
19301     *
19302     * @ingroup Genlist
19303     */
19304    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19305    /**
19306     * Sets the display only state of an item.
19307     *
19308     * @param it The item
19309     * @param display_only @c EINA_TRUE if the item is display only, @c
19310     * EINA_FALSE otherwise.
19311     *
19312     * A display only item cannot be selected or unselected. It is for
19313     * display only and not selecting or otherwise clicking, dragging
19314     * etc. by the user, thus finger size rules will not be applied to
19315     * this item.
19316     *
19317     * It's good to set group index items to display only state.
19318     *
19319     * @see elm_genlist_item_display_only_get()
19320     *
19321     * @ingroup Genlist
19322     */
19323    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19324    /**
19325     * Get the display only state of an item
19326     *
19327     * @param it The item
19328     * @return @c EINA_TRUE if the item is display only, @c
19329     * EINA_FALSE otherwise.
19330     *
19331     * @see elm_genlist_item_display_only_set()
19332     *
19333     * @ingroup Genlist
19334     */
19335    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19336    /**
19337     * Show the portion of a genlist's internal list containing a given
19338     * item, immediately.
19339     *
19340     * @param it The item to display
19341     *
19342     * This causes genlist to jump to the given item @p it and show it (by
19343     * immediately scrolling to that position), if it is not fully visible.
19344     *
19345     * @see elm_genlist_item_bring_in()
19346     * @see elm_genlist_item_top_show()
19347     * @see elm_genlist_item_middle_show()
19348     *
19349     * @ingroup Genlist
19350     */
19351    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19352    /**
19353     * Animatedly bring in, to the visible are of a genlist, a given
19354     * item on it.
19355     *
19356     * @param it The item to display
19357     *
19358     * This causes genlist to jump to the given item @p it and show it (by
19359     * animatedly scrolling), if it is not fully visible. This may use animation
19360     * to do so and take a period of time
19361     *
19362     * @see elm_genlist_item_show()
19363     * @see elm_genlist_item_top_bring_in()
19364     * @see elm_genlist_item_middle_bring_in()
19365     *
19366     * @ingroup Genlist
19367     */
19368    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19369    /**
19370     * Show the portion of a genlist's internal list containing a given
19371     * item, immediately.
19372     *
19373     * @param it The item to display
19374     *
19375     * This causes genlist to jump to the given item @p it and show it (by
19376     * immediately scrolling to that position), if it is not fully visible.
19377     *
19378     * The item will be positioned at the top of the genlist viewport.
19379     *
19380     * @see elm_genlist_item_show()
19381     * @see elm_genlist_item_top_bring_in()
19382     *
19383     * @ingroup Genlist
19384     */
19385    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19386    /**
19387     * Animatedly bring in, to the visible are of a genlist, a given
19388     * item on it.
19389     *
19390     * @param it The item
19391     *
19392     * This causes genlist to jump to the given item @p it and show it (by
19393     * animatedly scrolling), if it is not fully visible. This may use animation
19394     * to do so and take a period of time
19395     *
19396     * The item will be positioned at the top of the genlist viewport.
19397     *
19398     * @see elm_genlist_item_bring_in()
19399     * @see elm_genlist_item_top_show()
19400     *
19401     * @ingroup Genlist
19402     */
19403    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19404    /**
19405     * Show the portion of a genlist's internal list containing a given
19406     * item, immediately.
19407     *
19408     * @param it The item to display
19409     *
19410     * This causes genlist to jump to the given item @p it and show it (by
19411     * immediately scrolling to that position), if it is not fully visible.
19412     *
19413     * The item will be positioned at the middle of the genlist viewport.
19414     *
19415     * @see elm_genlist_item_show()
19416     * @see elm_genlist_item_middle_bring_in()
19417     *
19418     * @ingroup Genlist
19419     */
19420    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19421    /**
19422     * Animatedly bring in, to the visible are of a genlist, a given
19423     * item on it.
19424     *
19425     * @param it The item
19426     *
19427     * This causes genlist to jump to the given item @p it and show it (by
19428     * animatedly scrolling), if it is not fully visible. This may use animation
19429     * to do so and take a period of time
19430     *
19431     * The item will be positioned at the middle of the genlist viewport.
19432     *
19433     * @see elm_genlist_item_bring_in()
19434     * @see elm_genlist_item_middle_show()
19435     *
19436     * @ingroup Genlist
19437     */
19438    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19439    /**
19440     * Remove a genlist item from the its parent, deleting it.
19441     *
19442     * @param item The item to be removed.
19443     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19444     *
19445     * @see elm_genlist_clear(), to remove all items in a genlist at
19446     * once.
19447     *
19448     * @ingroup Genlist
19449     */
19450    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19451    /**
19452     * Return the data associated to a given genlist item
19453     *
19454     * @param item The genlist item.
19455     * @return the data associated to this item.
19456     *
19457     * This returns the @c data value passed on the
19458     * elm_genlist_item_append() and related item addition calls.
19459     *
19460     * @see elm_genlist_item_append()
19461     * @see elm_genlist_item_data_set()
19462     *
19463     * @ingroup Genlist
19464     */
19465    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19466    /**
19467     * Set the data associated to a given genlist item
19468     *
19469     * @param item The genlist item
19470     * @param data The new data pointer to set on it
19471     *
19472     * This @b overrides the @c data value passed on the
19473     * elm_genlist_item_append() and related item addition calls. This
19474     * function @b won't call elm_genlist_item_update() automatically,
19475     * so you'd issue it afterwards if you want to hove the item
19476     * updated to reflect the that new data.
19477     *
19478     * @see elm_genlist_item_data_get()
19479     *
19480     * @ingroup Genlist
19481     */
19482    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19483    /**
19484     * Tells genlist to "orphan" icons fetchs by the item class
19485     *
19486     * @param it The item
19487     *
19488     * This instructs genlist to release references to icons in the item,
19489     * meaning that they will no longer be managed by genlist and are
19490     * floating "orphans" that can be re-used elsewhere if the user wants
19491     * to.
19492     *
19493     * @ingroup Genlist
19494     */
19495    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19496    WILL_DEPRECATE  EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19497    /**
19498     * Get the real Evas object created to implement the view of a
19499     * given genlist item
19500     *
19501     * @param item The genlist item.
19502     * @return the Evas object implementing this item's view.
19503     *
19504     * This returns the actual Evas object used to implement the
19505     * specified genlist item's view. This may be @c NULL, as it may
19506     * not have been created or may have been deleted, at any time, by
19507     * the genlist. <b>Do not modify this object</b> (move, resize,
19508     * show, hide, etc.), as the genlist is controlling it. This
19509     * function is for querying, emitting custom signals or hooking
19510     * lower level callbacks for events on that object. Do not delete
19511     * this object under any circumstances.
19512     *
19513     * @see elm_genlist_item_data_get()
19514     *
19515     * @ingroup Genlist
19516     */
19517    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19518    /**
19519     * Update the contents of an item
19520     *
19521     * @param it The item
19522     *
19523     * This updates an item by calling all the item class functions again
19524     * to get the icons, labels and states. Use this when the original
19525     * item data has changed and the changes are desired to be reflected.
19526     *
19527     * Use elm_genlist_realized_items_update() to update all already realized
19528     * items.
19529     *
19530     * @see elm_genlist_realized_items_update()
19531     *
19532     * @ingroup Genlist
19533     */
19534    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19535    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19536    /**
19537     * Update the item class of an item
19538     *
19539     * @param it The item
19540     * @param itc The item class for the item
19541     *
19542     * This sets another class fo the item, changing the way that it is
19543     * displayed. After changing the item class, elm_genlist_item_update() is
19544     * called on the item @p it.
19545     *
19546     * @ingroup Genlist
19547     */
19548    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19549    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19550    /**
19551     * Set the text to be shown in a given genlist item's tooltips.
19552     *
19553     * @param item The genlist item
19554     * @param text The text to set in the content
19555     *
19556     * This call will setup the text to be used as tooltip to that item
19557     * (analogous to elm_object_tooltip_text_set(), but being item
19558     * tooltips with higher precedence than object tooltips). It can
19559     * have only one tooltip at a time, so any previous tooltip data
19560     * will get removed.
19561     *
19562     * In order to set an icon or something else as a tooltip, look at
19563     * elm_genlist_item_tooltip_content_cb_set().
19564     *
19565     * @ingroup Genlist
19566     */
19567    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19568    /**
19569     * Set the content to be shown in a given genlist item's tooltips
19570     *
19571     * @param item The genlist item.
19572     * @param func The function returning the tooltip contents.
19573     * @param data What to provide to @a func as callback data/context.
19574     * @param del_cb Called when data is not needed anymore, either when
19575     *        another callback replaces @p func, the tooltip is unset with
19576     *        elm_genlist_item_tooltip_unset() or the owner @p item
19577     *        dies. This callback receives as its first parameter the
19578     *        given @p data, being @c event_info the item handle.
19579     *
19580     * This call will setup the tooltip's contents to @p item
19581     * (analogous to elm_object_tooltip_content_cb_set(), but being
19582     * item tooltips with higher precedence than object tooltips). It
19583     * can have only one tooltip at a time, so any previous tooltip
19584     * content will get removed. @p func (with @p data) will be called
19585     * every time Elementary needs to show the tooltip and it should
19586     * return a valid Evas object, which will be fully managed by the
19587     * tooltip system, getting deleted when the tooltip is gone.
19588     *
19589     * In order to set just a text as a tooltip, look at
19590     * elm_genlist_item_tooltip_text_set().
19591     *
19592     * @ingroup Genlist
19593     */
19594    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);
19595    /**
19596     * Unset a tooltip from a given genlist item
19597     *
19598     * @param item genlist item to remove a previously set tooltip from.
19599     *
19600     * This call removes any tooltip set on @p item. The callback
19601     * provided as @c del_cb to
19602     * elm_genlist_item_tooltip_content_cb_set() will be called to
19603     * notify it is not used anymore (and have resources cleaned, if
19604     * need be).
19605     *
19606     * @see elm_genlist_item_tooltip_content_cb_set()
19607     *
19608     * @ingroup Genlist
19609     */
19610    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19611    /**
19612     * Set a different @b style for a given genlist item's tooltip.
19613     *
19614     * @param item genlist item with tooltip set
19615     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19616     * "default", @c "transparent", etc)
19617     *
19618     * Tooltips can have <b>alternate styles</b> to be displayed on,
19619     * which are defined by the theme set on Elementary. This function
19620     * works analogously as elm_object_tooltip_style_set(), but here
19621     * applied only to genlist item objects. The default style for
19622     * tooltips is @c "default".
19623     *
19624     * @note before you set a style you should define a tooltip with
19625     *       elm_genlist_item_tooltip_content_cb_set() or
19626     *       elm_genlist_item_tooltip_text_set()
19627     *
19628     * @see elm_genlist_item_tooltip_style_get()
19629     *
19630     * @ingroup Genlist
19631     */
19632    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19633    /**
19634     * Get the style set a given genlist item's tooltip.
19635     *
19636     * @param item genlist item with tooltip already set on.
19637     * @return style the theme style in use, which defaults to
19638     *         "default". If the object does not have a tooltip set,
19639     *         then @c NULL is returned.
19640     *
19641     * @see elm_genlist_item_tooltip_style_set() for more details
19642     *
19643     * @ingroup Genlist
19644     */
19645    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19646    /**
19647     * @brief Disable size restrictions on an object's tooltip
19648     * @param item The tooltip's anchor object
19649     * @param disable If EINA_TRUE, size restrictions are disabled
19650     * @return EINA_FALSE on failure, EINA_TRUE on success
19651     *
19652     * This function allows a tooltip to expand beyond its parant window's canvas.
19653     * It will instead be limited only by the size of the display.
19654     */
19655    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19656    /**
19657     * @brief Retrieve size restriction state of an object's tooltip
19658     * @param item The tooltip's anchor object
19659     * @return If EINA_TRUE, size restrictions are disabled
19660     *
19661     * This function returns whether a tooltip is allowed to expand beyond
19662     * its parant window's canvas.
19663     * It will instead be limited only by the size of the display.
19664     */
19665    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19666    /**
19667     * Set the type of mouse pointer/cursor decoration to be shown,
19668     * when the mouse pointer is over the given genlist widget item
19669     *
19670     * @param item genlist item to customize cursor on
19671     * @param cursor the cursor type's name
19672     *
19673     * This function works analogously as elm_object_cursor_set(), but
19674     * here the cursor's changing area is restricted to the item's
19675     * area, and not the whole widget's. Note that that item cursors
19676     * have precedence over widget cursors, so that a mouse over @p
19677     * item will always show cursor @p type.
19678     *
19679     * If this function is called twice for an object, a previously set
19680     * cursor will be unset on the second call.
19681     *
19682     * @see elm_object_cursor_set()
19683     * @see elm_genlist_item_cursor_get()
19684     * @see elm_genlist_item_cursor_unset()
19685     *
19686     * @ingroup Genlist
19687     */
19688    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19689    /**
19690     * Get the type of mouse pointer/cursor decoration set to be shown,
19691     * when the mouse pointer is over the given genlist widget item
19692     *
19693     * @param item genlist item with custom cursor set
19694     * @return the cursor type's name or @c NULL, if no custom cursors
19695     * were set to @p item (and on errors)
19696     *
19697     * @see elm_object_cursor_get()
19698     * @see elm_genlist_item_cursor_set() for more details
19699     * @see elm_genlist_item_cursor_unset()
19700     *
19701     * @ingroup Genlist
19702     */
19703    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19704    /**
19705     * Unset any custom mouse pointer/cursor decoration set to be
19706     * shown, when the mouse pointer is over the given genlist widget
19707     * item, thus making it show the @b default cursor again.
19708     *
19709     * @param item a genlist item
19710     *
19711     * Use this call to undo any custom settings on this item's cursor
19712     * decoration, bringing it back to defaults (no custom style set).
19713     *
19714     * @see elm_object_cursor_unset()
19715     * @see elm_genlist_item_cursor_set() for more details
19716     *
19717     * @ingroup Genlist
19718     */
19719    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19720    /**
19721     * Set a different @b style for a given custom cursor set for a
19722     * genlist item.
19723     *
19724     * @param item genlist item with custom cursor set
19725     * @param style the <b>theme style</b> to use (e.g. @c "default",
19726     * @c "transparent", etc)
19727     *
19728     * This function only makes sense when one is using custom mouse
19729     * cursor decorations <b>defined in a theme file</b> , which can
19730     * have, given a cursor name/type, <b>alternate styles</b> on
19731     * it. It works analogously as elm_object_cursor_style_set(), but
19732     * here applied only to genlist item objects.
19733     *
19734     * @warning Before you set a cursor style you should have defined a
19735     *       custom cursor previously on the item, with
19736     *       elm_genlist_item_cursor_set()
19737     *
19738     * @see elm_genlist_item_cursor_engine_only_set()
19739     * @see elm_genlist_item_cursor_style_get()
19740     *
19741     * @ingroup Genlist
19742     */
19743    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19744    /**
19745     * Get the current @b style set for a given genlist item's custom
19746     * cursor
19747     *
19748     * @param item genlist item with custom cursor set.
19749     * @return style the cursor style in use. If the object does not
19750     *         have a cursor set, then @c NULL is returned.
19751     *
19752     * @see elm_genlist_item_cursor_style_set() for more details
19753     *
19754     * @ingroup Genlist
19755     */
19756    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19757    /**
19758     * Set if the (custom) cursor for a given genlist item should be
19759     * searched in its theme, also, or should only rely on the
19760     * rendering engine.
19761     *
19762     * @param item item with custom (custom) cursor already set on
19763     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19764     * only on those provided by the rendering engine, @c EINA_FALSE to
19765     * have them searched on the widget's theme, as well.
19766     *
19767     * @note This call is of use only if you've set a custom cursor
19768     * for genlist items, with elm_genlist_item_cursor_set().
19769     *
19770     * @note By default, cursors will only be looked for between those
19771     * provided by the rendering engine.
19772     *
19773     * @ingroup Genlist
19774     */
19775    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19776    /**
19777     * Get if the (custom) cursor for a given genlist item is being
19778     * searched in its theme, also, or is only relying on the rendering
19779     * engine.
19780     *
19781     * @param item a genlist item
19782     * @return @c EINA_TRUE, if cursors are being looked for only on
19783     * those provided by the rendering engine, @c EINA_FALSE if they
19784     * are being searched on the widget's theme, as well.
19785     *
19786     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19787     *
19788     * @ingroup Genlist
19789     */
19790    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19791    /**
19792     * Update the contents of all realized items.
19793     *
19794     * @param obj The genlist object.
19795     *
19796     * This updates all realized items by calling all the item class functions again
19797     * to get the icons, labels and states. Use this when the original
19798     * item data has changed and the changes are desired to be reflected.
19799     *
19800     * To update just one item, use elm_genlist_item_update().
19801     *
19802     * @see elm_genlist_realized_items_get()
19803     * @see elm_genlist_item_update()
19804     *
19805     * @ingroup Genlist
19806     */
19807    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19808    /**
19809     * Activate a genlist mode on an item
19810     *
19811     * @param item The genlist item
19812     * @param mode Mode name
19813     * @param mode_set Boolean to define set or unset mode.
19814     *
19815     * A genlist mode is a different way of selecting an item. Once a mode is
19816     * activated on an item, any other selected item is immediately unselected.
19817     * This feature provides an easy way of implementing a new kind of animation
19818     * for selecting an item, without having to entirely rewrite the item style
19819     * theme. However, the elm_genlist_selected_* API can't be used to get what
19820     * item is activate for a mode.
19821     *
19822     * The current item style will still be used, but applying a genlist mode to
19823     * an item will select it using a different kind of animation.
19824     *
19825     * The current active item for a mode can be found by
19826     * elm_genlist_mode_item_get().
19827     *
19828     * The characteristics of genlist mode are:
19829     * - Only one mode can be active at any time, and for only one item.
19830     * - Genlist handles deactivating other items when one item is activated.
19831     * - A mode is defined in the genlist theme (edc), and more modes can easily
19832     *   be added.
19833     * - A mode style and the genlist item style are different things. They
19834     *   can be combined to provide a default style to the item, with some kind
19835     *   of animation for that item when the mode is activated.
19836     *
19837     * When a mode is activated on an item, a new view for that item is created.
19838     * The theme of this mode defines the animation that will be used to transit
19839     * the item from the old view to the new view. This second (new) view will be
19840     * active for that item while the mode is active on the item, and will be
19841     * destroyed after the mode is totally deactivated from that item.
19842     *
19843     * @see elm_genlist_mode_get()
19844     * @see elm_genlist_mode_item_get()
19845     *
19846     * @ingroup Genlist
19847     */
19848    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19849    /**
19850     * Get the last (or current) genlist mode used.
19851     *
19852     * @param obj The genlist object
19853     *
19854     * This function just returns the name of the last used genlist mode. It will
19855     * be the current mode if it's still active.
19856     *
19857     * @see elm_genlist_item_mode_set()
19858     * @see elm_genlist_mode_item_get()
19859     *
19860     * @ingroup Genlist
19861     */
19862    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19863    /**
19864     * Get active genlist mode item
19865     *
19866     * @param obj The genlist object
19867     * @return The active item for that current mode. Or @c NULL if no item is
19868     * activated with any mode.
19869     *
19870     * This function returns the item that was activated with a mode, by the
19871     * function elm_genlist_item_mode_set().
19872     *
19873     * @see elm_genlist_item_mode_set()
19874     * @see elm_genlist_mode_get()
19875     *
19876     * @ingroup Genlist
19877     */
19878    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19879
19880    /**
19881     * Set reorder mode
19882     *
19883     * @param obj The genlist object
19884     * @param reorder_mode The reorder mode
19885     * (EINA_TRUE = on, EINA_FALSE = off)
19886     *
19887     * @ingroup Genlist
19888     */
19889    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19890
19891    /**
19892     * Get the reorder mode
19893     *
19894     * @param obj The genlist object
19895     * @return The reorder mode
19896     * (EINA_TRUE = on, EINA_FALSE = off)
19897     *
19898     * @ingroup Genlist
19899     */
19900    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19901
19902    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19903    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19904    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19905    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19906    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19907    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19908    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19909    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19910    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19911    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19912
19913    /**
19914     * @}
19915     */
19916
19917    /**
19918     * @defgroup Check Check
19919     *
19920     * @image html img/widget/check/preview-00.png
19921     * @image latex img/widget/check/preview-00.eps
19922     * @image html img/widget/check/preview-01.png
19923     * @image latex img/widget/check/preview-01.eps
19924     * @image html img/widget/check/preview-02.png
19925     * @image latex img/widget/check/preview-02.eps
19926     *
19927     * @brief The check widget allows for toggling a value between true and
19928     * false.
19929     *
19930     * Check objects are a lot like radio objects in layout and functionality
19931     * except they do not work as a group, but independently and only toggle the
19932     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19933     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19934     * returns the current state. For convenience, like the radio objects, you
19935     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19936     * for it to modify.
19937     *
19938     * Signals that you can add callbacks for are:
19939     * "changed" - This is called whenever the user changes the state of one of
19940     *             the check object(event_info is NULL).
19941     *
19942     * Default contents parts of the check widget that you can use for are:
19943     * @li "icon" - A icon of the check
19944     *
19945     * Default text parts of the check widget that you can use for are:
19946     * @li "elm.text" - Label of the check
19947     *
19948     * @ref tutorial_check should give you a firm grasp of how to use this widget
19949     * .
19950     * @{
19951     */
19952    /**
19953     * @brief Add a new Check object
19954     *
19955     * @param parent The parent object
19956     * @return The new object or NULL if it cannot be created
19957     */
19958    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19959    /**
19960     * @brief Set the text label of the check object
19961     *
19962     * @param obj The check object
19963     * @param label The text label string in UTF-8
19964     *
19965     * @deprecated use elm_object_text_set() instead.
19966     */
19967    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19968    /**
19969     * @brief Get the text label of the check object
19970     *
19971     * @param obj The check object
19972     * @return The text label string in UTF-8
19973     *
19974     * @deprecated use elm_object_text_get() instead.
19975     */
19976    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19977    /**
19978     * @brief Set the icon object of the check object
19979     *
19980     * @param obj The check object
19981     * @param icon The icon object
19982     *
19983     * Once the icon object is set, a previously set one will be deleted.
19984     * If you want to keep that old content object, use the
19985     * elm_object_content_unset() function.
19986     *
19987     * @deprecated use elm_object_part_content_set() instead.
19988     *
19989     */
19990    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19991    /**
19992     * @brief Get the icon object of the check object
19993     *
19994     * @param obj The check object
19995     * @return The icon object
19996     *
19997     * @deprecated use elm_object_part_content_get() instead.
19998     *  
19999     */
20000    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20001    /**
20002     * @brief Unset the icon used for the check object
20003     *
20004     * @param obj The check object
20005     * @return The icon object that was being used
20006     *
20007     * Unparent and return the icon object which was set for this widget.
20008     *
20009     * @deprecated use elm_object_part_content_unset() instead.
20010     *
20011     */
20012    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20013    /**
20014     * @brief Set the on/off state of the check object
20015     *
20016     * @param obj The check object
20017     * @param state The state to use (1 == on, 0 == off)
20018     *
20019     * This sets the state of the check. If set
20020     * with elm_check_state_pointer_set() the state of that variable is also
20021     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20022     */
20023    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20024    /**
20025     * @brief Get the state of the check object
20026     *
20027     * @param obj The check object
20028     * @return The boolean state
20029     */
20030    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20031    /**
20032     * @brief Set a convenience pointer to a boolean to change
20033     *
20034     * @param obj The check object
20035     * @param statep Pointer to the boolean to modify
20036     *
20037     * This sets a pointer to a boolean, that, in addition to the check objects
20038     * state will also be modified directly. To stop setting the object pointed
20039     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20040     * then when this is called, the check objects state will also be modified to
20041     * reflect the value of the boolean @p statep points to, just like calling
20042     * elm_check_state_set().
20043     */
20044    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20045    /**
20046     * @}
20047     */
20048
20049    /* compatibility code for toggle controls */
20050
20051    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
20052      {
20053         Evas_Object *obj;
20054
20055         obj = elm_check_add(parent);
20056         elm_object_style_set(obj, "toggle");
20057         elm_object_part_text_set(obj, "on", "ON");
20058         elm_object_part_text_set(obj, "off", "OFF");
20059         return obj;
20060      }
20061
20062    EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
20063      {
20064         elm_object_text_set(obj, label);
20065      }
20066
20067    EINA_DEPRECATED EAPI extern inline const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20068      {
20069         return elm_object_text_get(obj);
20070      }
20071
20072    EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
20073      {
20074         elm_object_content_set(obj, icon);
20075      }
20076
20077    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20078      {
20079         return elm_object_content_get(obj);
20080      }
20081
20082    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
20083      {
20084         return elm_object_content_unset(obj);
20085      }
20086
20087    EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
20088      {
20089         elm_object_part_text_set(obj, "on", onlabel);
20090         elm_object_part_text_set(obj, "off", offlabel);
20091      }
20092
20093    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)
20094      {
20095         if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
20096         if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
20097      }
20098
20099    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
20100      {
20101         elm_check_state_set(obj, state);
20102      }
20103
20104    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20105      {
20106         return elm_check_state_get(obj);
20107      }
20108
20109    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
20110      {
20111         elm_check_state_pointer_set(obj, statep);
20112      }
20113
20114    /**
20115     * @defgroup Radio Radio
20116     *
20117     * @image html img/widget/radio/preview-00.png
20118     * @image latex img/widget/radio/preview-00.eps
20119     *
20120     * @brief Radio is a widget that allows for 1 or more options to be displayed
20121     * and have the user choose only 1 of them.
20122     *
20123     * A radio object contains an indicator, an optional Label and an optional
20124     * icon object. While it's possible to have a group of only one radio they,
20125     * are normally used in groups of 2 or more. To add a radio to a group use
20126     * elm_radio_group_add(). The radio object(s) will select from one of a set
20127     * of integer values, so any value they are configuring needs to be mapped to
20128     * a set of integers. To configure what value that radio object represents,
20129     * use  elm_radio_state_value_set() to set the integer it represents. To set
20130     * the value the whole group(which one is currently selected) is to indicate
20131     * use elm_radio_value_set() on any group member, and to get the groups value
20132     * use elm_radio_value_get(). For convenience the radio objects are also able
20133     * to directly set an integer(int) to the value that is selected. To specify
20134     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20135     * The radio objects will modify this directly. That implies the pointer must
20136     * point to valid memory for as long as the radio objects exist.
20137     *
20138     * Signals that you can add callbacks for are:
20139     * @li changed - This is called whenever the user changes the state of one of
20140     * the radio objects within the group of radio objects that work together.
20141     *
20142     * Default contents parts of the radio widget that you can use for are:
20143     * @li "icon" - A icon of the radio
20144     *
20145     * @ref tutorial_radio show most of this API in action.
20146     * @{
20147     */
20148    /**
20149     * @brief Add a new radio to the parent
20150     *
20151     * @param parent The parent object
20152     * @return The new object or NULL if it cannot be created
20153     */
20154    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20155    /**
20156     * @brief Set the text label of the radio object
20157     *
20158     * @param obj The radio object
20159     * @param label The text label string in UTF-8
20160     *
20161     * @deprecated use elm_object_text_set() instead.
20162     */
20163    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20164    /**
20165     * @brief Get the text label of the radio object
20166     *
20167     * @param obj The radio object
20168     * @return The text label string in UTF-8
20169     *
20170     * @deprecated use elm_object_text_set() instead.
20171     */
20172    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20173    /**
20174     * @brief Set the icon object of the radio object
20175     *
20176     * @param obj The radio object
20177     * @param icon The icon object
20178     *
20179     * Once the icon object is set, a previously set one will be deleted. If you
20180     * want to keep that old content object, use the elm_radio_icon_unset()
20181     * function.
20182     *
20183     * @deprecated use elm_object_part_content_set() instead.
20184     *
20185     */
20186    WILL_DEPRECATE  EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20187    /**
20188     * @brief Get the icon object of the radio object
20189     *
20190     * @param obj The radio object
20191     * @return The icon object
20192     *
20193     * @see elm_radio_icon_set()
20194     *
20195     * @deprecated use elm_object_part_content_get() instead.
20196     *
20197     */
20198    WILL_DEPRECATE  EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20199    /**
20200     * @brief Unset the icon used for the radio object
20201     *
20202     * @param obj The radio object
20203     * @return The icon object that was being used
20204     *
20205     * Unparent and return the icon object which was set for this widget.
20206     *
20207     * @see elm_radio_icon_set()
20208     * @deprecated use elm_object_part_content_unset() instead.
20209     *
20210     */
20211    WILL_DEPRECATE  EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20212    /**
20213     * @brief Add this radio to a group of other radio objects
20214     *
20215     * @param obj The radio object
20216     * @param group Any object whose group the @p obj is to join.
20217     *
20218     * Radio objects work in groups. Each member should have a different integer
20219     * value assigned. In order to have them work as a group, they need to know
20220     * about each other. This adds the given radio object to the group of which
20221     * the group object indicated is a member.
20222     */
20223    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20224    /**
20225     * @brief Set the integer value that this radio object represents
20226     *
20227     * @param obj The radio object
20228     * @param value The value to use if this radio object is selected
20229     *
20230     * This sets the value of the radio.
20231     */
20232    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20233    /**
20234     * @brief Get the integer value that this radio object represents
20235     *
20236     * @param obj The radio object
20237     * @return The value used if this radio object is selected
20238     *
20239     * This gets the value of the radio.
20240     *
20241     * @see elm_radio_value_set()
20242     */
20243    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20244    /**
20245     * @brief Set the value of the radio.
20246     *
20247     * @param obj The radio object
20248     * @param value The value to use for the group
20249     *
20250     * This sets the value of the radio group and will also set the value if
20251     * pointed to, to the value supplied, but will not call any callbacks.
20252     */
20253    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20254    /**
20255     * @brief Get the state of the radio object
20256     *
20257     * @param obj The radio object
20258     * @return The integer state
20259     */
20260    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20261    /**
20262     * @brief Set a convenience pointer to a integer to change
20263     *
20264     * @param obj The radio object
20265     * @param valuep Pointer to the integer to modify
20266     *
20267     * This sets a pointer to a integer, that, in addition to the radio objects
20268     * state will also be modified directly. To stop setting the object pointed
20269     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20270     * when this is called, the radio objects state will also be modified to
20271     * reflect the value of the integer valuep points to, just like calling
20272     * elm_radio_value_set().
20273     */
20274    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20275    /**
20276     * @}
20277     */
20278
20279    /**
20280     * @defgroup Pager Pager
20281     *
20282     * @image html img/widget/pager/preview-00.png
20283     * @image latex img/widget/pager/preview-00.eps
20284     *
20285     * @brief Widget that allows flipping between one or more “pages”
20286     * of objects.
20287     *
20288     * The flipping between pages of objects is animated. All content
20289     * in the pager is kept in a stack, being the last content added
20290     * (visible one) on the top of that stack.
20291     *
20292     * Objects can be pushed or popped from the stack or deleted as
20293     * well. Pushes and pops will animate the widget accordingly to its
20294     * style (a pop will also delete the child object once the
20295     * animation is finished). Any object already in the pager can be
20296     * promoted to the top (from its current stacking position) through
20297     * the use of elm_pager_content_promote(). New objects are pushed
20298     * to the top with elm_pager_content_push(). When the top item is
20299     * no longer wanted, simply pop it with elm_pager_content_pop() and
20300     * it will also be deleted. If an object is no longer needed and is
20301     * not the top item, just delete it as normal. You can query which
20302     * objects are the top and bottom with
20303     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20304     *
20305     * Signals that you can add callbacks for are:
20306     * - @c "show,finished" - when a new page is actually shown on the top
20307     * - @c "hide,finished" - when a previous page is hidden
20308     *
20309     * Only after the first of that signals the child object is
20310     * guaranteed to be visible, as in @c evas_object_visible_get().
20311     *
20312     * This widget has the following styles available:
20313     * - @c "default"
20314     * - @c "fade"
20315     * - @c "fade_translucide"
20316     * - @c "fade_invisible"
20317     *
20318     * @note These styles affect only the flipping animations on the
20319     * default theme; the appearance when not animating is unaffected
20320     * by them.
20321     *
20322     * @ref tutorial_pager gives a good overview of the usage of the API.
20323     * @{
20324     */
20325
20326    /**
20327     * Add a new pager to the parent
20328     *
20329     * @param parent The parent object
20330     * @return The new object or NULL if it cannot be created
20331     *
20332     * @ingroup Pager
20333     */
20334    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20335
20336    /**
20337     * @brief Push an object to the top of the pager stack (and show it).
20338     *
20339     * @param obj The pager object
20340     * @param content The object to push
20341     *
20342     * The object pushed becomes a child of the pager, it will be controlled and
20343     * deleted when the pager is deleted.
20344     *
20345     * @note If the content is already in the stack use
20346     * elm_pager_content_promote().
20347     * @warning Using this function on @p content already in the stack results in
20348     * undefined behavior.
20349     */
20350    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20351
20352    /**
20353     * @brief Pop the object that is on top of the stack
20354     *
20355     * @param obj The pager object
20356     *
20357     * This pops the object that is on the top(visible) of the pager, makes it
20358     * disappear, then deletes the object. The object that was underneath it on
20359     * the stack will become visible.
20360     */
20361    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20362
20363    /**
20364     * @brief Moves an object already in the pager stack to the top of the stack.
20365     *
20366     * @param obj The pager object
20367     * @param content The object to promote
20368     *
20369     * This will take the @p content and move it to the top of the stack as
20370     * if it had been pushed there.
20371     *
20372     * @note If the content isn't already in the stack use
20373     * elm_pager_content_push().
20374     * @warning Using this function on @p content not already in the stack
20375     * results in undefined behavior.
20376     */
20377    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20378
20379    /**
20380     * @brief Return the object at the bottom of the pager stack
20381     *
20382     * @param obj The pager object
20383     * @return The bottom object or NULL if none
20384     */
20385    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20386
20387    /**
20388     * @brief  Return the object at the top of the pager stack
20389     *
20390     * @param obj The pager object
20391     * @return The top object or NULL if none
20392     */
20393    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20394
20395    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20396    EINA_DEPRECATED    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20397
20398    /**
20399     * @}
20400     */
20401
20402    /**
20403     * @defgroup Slideshow Slideshow
20404     *
20405     * @image html img/widget/slideshow/preview-00.png
20406     * @image latex img/widget/slideshow/preview-00.eps
20407     *
20408     * This widget, as the name indicates, is a pre-made image
20409     * slideshow panel, with API functions acting on (child) image
20410     * items presentation. Between those actions, are:
20411     * - advance to next/previous image
20412     * - select the style of image transition animation
20413     * - set the exhibition time for each image
20414     * - start/stop the slideshow
20415     *
20416     * The transition animations are defined in the widget's theme,
20417     * consequently new animations can be added without having to
20418     * update the widget's code.
20419     *
20420     * @section Slideshow_Items Slideshow items
20421     *
20422     * For slideshow items, just like for @ref Genlist "genlist" ones,
20423     * the user defines a @b classes, specifying functions that will be
20424     * called on the item's creation and deletion times.
20425     *
20426     * The #Elm_Slideshow_Item_Class structure contains the following
20427     * members:
20428     *
20429     * - @c func.get - When an item is displayed, this function is
20430     *   called, and it's where one should create the item object, de
20431     *   facto. For example, the object can be a pure Evas image object
20432     *   or an Elementary @ref Photocam "photocam" widget. See
20433     *   #SlideshowItemGetFunc.
20434     * - @c func.del - When an item is no more displayed, this function
20435     *   is called, where the user must delete any data associated to
20436     *   the item. See #SlideshowItemDelFunc.
20437     *
20438     * @section Slideshow_Caching Slideshow caching
20439     *
20440     * The slideshow provides facilities to have items adjacent to the
20441     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20442     * you, so that the system does not have to decode image data
20443     * anymore at the time it has to actually switch images on its
20444     * viewport. The user is able to set the numbers of items to be
20445     * cached @b before and @b after the current item, in the widget's
20446     * item list.
20447     *
20448     * Smart events one can add callbacks for are:
20449     *
20450     * - @c "changed" - when the slideshow switches its view to a new
20451     *   item
20452     *
20453     * List of examples for the slideshow widget:
20454     * @li @ref slideshow_example
20455     */
20456
20457    /**
20458     * @addtogroup Slideshow
20459     * @{
20460     */
20461
20462    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20463    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20464    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20465    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20466    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20467
20468    /**
20469     * @struct _Elm_Slideshow_Item_Class
20470     *
20471     * Slideshow item class definition. See @ref Slideshow_Items for
20472     * field details.
20473     */
20474    struct _Elm_Slideshow_Item_Class
20475      {
20476         struct _Elm_Slideshow_Item_Class_Func
20477           {
20478              SlideshowItemGetFunc get;
20479              SlideshowItemDelFunc del;
20480           } func;
20481      }; /**< #Elm_Slideshow_Item_Class member definitions */
20482
20483    /**
20484     * Add a new slideshow widget to the given parent Elementary
20485     * (container) object
20486     *
20487     * @param parent The parent object
20488     * @return A new slideshow widget handle or @c NULL, on errors
20489     *
20490     * This function inserts a new slideshow widget on the canvas.
20491     *
20492     * @ingroup Slideshow
20493     */
20494    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20495
20496    /**
20497     * Add (append) a new item in a given slideshow widget.
20498     *
20499     * @param obj The slideshow object
20500     * @param itc The item class for the item
20501     * @param data The item's data
20502     * @return A handle to the item added or @c NULL, on errors
20503     *
20504     * Add a new item to @p obj's internal list of items, appending it.
20505     * The item's class must contain the function really fetching the
20506     * image object to show for this item, which could be an Evas image
20507     * object or an Elementary photo, for example. The @p data
20508     * parameter is going to be passed to both class functions of the
20509     * item.
20510     *
20511     * @see #Elm_Slideshow_Item_Class
20512     * @see elm_slideshow_item_sorted_insert()
20513     *
20514     * @ingroup Slideshow
20515     */
20516    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20517
20518    /**
20519     * Insert a new item into the given slideshow widget, using the @p func
20520     * function to sort items (by item handles).
20521     *
20522     * @param obj The slideshow object
20523     * @param itc The item class for the item
20524     * @param data The item's data
20525     * @param func The comparing function to be used to sort slideshow
20526     * items <b>by #Elm_Slideshow_Item item handles</b>
20527     * @return Returns The slideshow item handle, on success, or
20528     * @c NULL, on errors
20529     *
20530     * Add a new item to @p obj's internal list of items, in a position
20531     * determined by the @p func comparing function. The item's class
20532     * must contain the function really fetching the image object to
20533     * show for this item, which could be an Evas image object or an
20534     * Elementary photo, for example. The @p data parameter is going to
20535     * be passed to both class functions of the item.
20536     *
20537     * @see #Elm_Slideshow_Item_Class
20538     * @see elm_slideshow_item_add()
20539     *
20540     * @ingroup Slideshow
20541     */
20542    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);
20543
20544    /**
20545     * Display a given slideshow widget's item, programmatically.
20546     *
20547     * @param obj The slideshow object
20548     * @param item The item to display on @p obj's viewport
20549     *
20550     * The change between the current item and @p item will use the
20551     * transition @p obj is set to use (@see
20552     * elm_slideshow_transition_set()).
20553     *
20554     * @ingroup Slideshow
20555     */
20556    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20557
20558    /**
20559     * Slide to the @b next item, in a given slideshow widget
20560     *
20561     * @param obj The slideshow object
20562     *
20563     * The sliding animation @p obj is set to use will be the
20564     * transition effect used, after this call is issued.
20565     *
20566     * @note If the end of the slideshow's internal list of items is
20567     * reached, it'll wrap around to the list's beginning, again.
20568     *
20569     * @ingroup Slideshow
20570     */
20571    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20572
20573    /**
20574     * Slide to the @b previous item, in a given slideshow widget
20575     *
20576     * @param obj The slideshow object
20577     *
20578     * The sliding animation @p obj is set to use will be the
20579     * transition effect used, after this call is issued.
20580     *
20581     * @note If the beginning of the slideshow's internal list of items
20582     * is reached, it'll wrap around to the list's end, again.
20583     *
20584     * @ingroup Slideshow
20585     */
20586    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20587
20588    /**
20589     * Returns the list of sliding transition/effect names available, for a
20590     * given slideshow widget.
20591     *
20592     * @param obj The slideshow object
20593     * @return The list of transitions (list of @b stringshared strings
20594     * as data)
20595     *
20596     * The transitions, which come from @p obj's theme, must be an EDC
20597     * data item named @c "transitions" on the theme file, with (prefix)
20598     * names of EDC programs actually implementing them.
20599     *
20600     * The available transitions for slideshows on the default theme are:
20601     * - @c "fade" - the current item fades out, while the new one
20602     *   fades in to the slideshow's viewport.
20603     * - @c "black_fade" - the current item fades to black, and just
20604     *   then, the new item will fade in.
20605     * - @c "horizontal" - the current item slides horizontally, until
20606     *   it gets out of the slideshow's viewport, while the new item
20607     *   comes from the left to take its place.
20608     * - @c "vertical" - the current item slides vertically, until it
20609     *   gets out of the slideshow's viewport, while the new item comes
20610     *   from the bottom to take its place.
20611     * - @c "square" - the new item starts to appear from the middle of
20612     *   the current one, but with a tiny size, growing until its
20613     *   target (full) size and covering the old one.
20614     *
20615     * @warning The stringshared strings get no new references
20616     * exclusive to the user grabbing the list, here, so if you'd like
20617     * to use them out of this call's context, you'd better @c
20618     * eina_stringshare_ref() them.
20619     *
20620     * @see elm_slideshow_transition_set()
20621     *
20622     * @ingroup Slideshow
20623     */
20624    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20625
20626    /**
20627     * Set the current slide transition/effect in use for a given
20628     * slideshow widget
20629     *
20630     * @param obj The slideshow object
20631     * @param transition The new transition's name string
20632     *
20633     * If @p transition is implemented in @p obj's theme (i.e., is
20634     * contained in the list returned by
20635     * elm_slideshow_transitions_get()), this new sliding effect will
20636     * be used on the widget.
20637     *
20638     * @see elm_slideshow_transitions_get() for more details
20639     *
20640     * @ingroup Slideshow
20641     */
20642    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20643
20644    /**
20645     * Get the current slide transition/effect in use for a given
20646     * slideshow widget
20647     *
20648     * @param obj The slideshow object
20649     * @return The current transition's name
20650     *
20651     * @see elm_slideshow_transition_set() for more details
20652     *
20653     * @ingroup Slideshow
20654     */
20655    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20656
20657    /**
20658     * Set the interval between each image transition on a given
20659     * slideshow widget, <b>and start the slideshow, itself</b>
20660     *
20661     * @param obj The slideshow object
20662     * @param timeout The new displaying timeout for images
20663     *
20664     * After this call, the slideshow widget will start cycling its
20665     * view, sequentially and automatically, with the images of the
20666     * items it has. The time between each new image displayed is going
20667     * to be @p timeout, in @b seconds. If a different timeout was set
20668     * previously and an slideshow was in progress, it will continue
20669     * with the new time between transitions, after this call.
20670     *
20671     * @note A value less than or equal to 0 on @p timeout will disable
20672     * the widget's internal timer, thus halting any slideshow which
20673     * could be happening on @p obj.
20674     *
20675     * @see elm_slideshow_timeout_get()
20676     *
20677     * @ingroup Slideshow
20678     */
20679    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20680
20681    /**
20682     * Get the interval set for image transitions on a given slideshow
20683     * widget.
20684     *
20685     * @param obj The slideshow object
20686     * @return Returns the timeout set on it
20687     *
20688     * @see elm_slideshow_timeout_set() for more details
20689     *
20690     * @ingroup Slideshow
20691     */
20692    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20693
20694    /**
20695     * Set if, after a slideshow is started, for a given slideshow
20696     * widget, its items should be displayed cyclically or not.
20697     *
20698     * @param obj The slideshow object
20699     * @param loop Use @c EINA_TRUE to make it cycle through items or
20700     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20701     * list of items
20702     *
20703     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20704     * ignore what is set by this functions, i.e., they'll @b always
20705     * cycle through items. This affects only the "automatic"
20706     * slideshow, as set by elm_slideshow_timeout_set().
20707     *
20708     * @see elm_slideshow_loop_get()
20709     *
20710     * @ingroup Slideshow
20711     */
20712    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20713
20714    /**
20715     * Get if, after a slideshow is started, for a given slideshow
20716     * widget, its items are to be displayed cyclically or not.
20717     *
20718     * @param obj The slideshow object
20719     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20720     * through or @c EINA_FALSE, otherwise
20721     *
20722     * @see elm_slideshow_loop_set() for more details
20723     *
20724     * @ingroup Slideshow
20725     */
20726    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20727
20728    /**
20729     * Remove all items from a given slideshow widget
20730     *
20731     * @param obj The slideshow object
20732     *
20733     * This removes (and deletes) all items in @p obj, leaving it
20734     * empty.
20735     *
20736     * @see elm_slideshow_item_del(), to remove just one item.
20737     *
20738     * @ingroup Slideshow
20739     */
20740    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20741
20742    /**
20743     * Get the internal list of items in a given slideshow widget.
20744     *
20745     * @param obj The slideshow object
20746     * @return The list of items (#Elm_Slideshow_Item as data) or
20747     * @c NULL on errors.
20748     *
20749     * This list is @b not to be modified in any way and must not be
20750     * freed. Use the list members with functions like
20751     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20752     *
20753     * @warning This list is only valid until @p obj object's internal
20754     * items list is changed. It should be fetched again with another
20755     * call to this function when changes happen.
20756     *
20757     * @ingroup Slideshow
20758     */
20759    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20760
20761    /**
20762     * Delete a given item from a slideshow widget.
20763     *
20764     * @param item The slideshow item
20765     *
20766     * @ingroup Slideshow
20767     */
20768    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20769
20770    /**
20771     * Return the data associated with a given slideshow item
20772     *
20773     * @param item The slideshow item
20774     * @return Returns the data associated to this item
20775     *
20776     * @ingroup Slideshow
20777     */
20778    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20779
20780    /**
20781     * Returns the currently displayed item, in a given slideshow widget
20782     *
20783     * @param obj The slideshow object
20784     * @return A handle to the item being displayed in @p obj or
20785     * @c NULL, if none is (and on errors)
20786     *
20787     * @ingroup Slideshow
20788     */
20789    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20790
20791    /**
20792     * Get the real Evas object created to implement the view of a
20793     * given slideshow item
20794     *
20795     * @param item The slideshow item.
20796     * @return the Evas object implementing this item's view.
20797     *
20798     * This returns the actual Evas object used to implement the
20799     * specified slideshow item's view. This may be @c NULL, as it may
20800     * not have been created or may have been deleted, at any time, by
20801     * the slideshow. <b>Do not modify this object</b> (move, resize,
20802     * show, hide, etc.), as the slideshow is controlling it. This
20803     * function is for querying, emitting custom signals or hooking
20804     * lower level callbacks for events on that object. Do not delete
20805     * this object under any circumstances.
20806     *
20807     * @see elm_slideshow_item_data_get()
20808     *
20809     * @ingroup Slideshow
20810     */
20811    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20812
20813    /**
20814     * Get the the item, in a given slideshow widget, placed at
20815     * position @p nth, in its internal items list
20816     *
20817     * @param obj The slideshow object
20818     * @param nth The number of the item to grab a handle to (0 being
20819     * the first)
20820     * @return The item stored in @p obj at position @p nth or @c NULL,
20821     * if there's no item with that index (and on errors)
20822     *
20823     * @ingroup Slideshow
20824     */
20825    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20826
20827    /**
20828     * Set the current slide layout in use for a given slideshow widget
20829     *
20830     * @param obj The slideshow object
20831     * @param layout The new layout's name string
20832     *
20833     * If @p layout is implemented in @p obj's theme (i.e., is contained
20834     * in the list returned by elm_slideshow_layouts_get()), this new
20835     * images layout will be used on the widget.
20836     *
20837     * @see elm_slideshow_layouts_get() for more details
20838     *
20839     * @ingroup Slideshow
20840     */
20841    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20842
20843    /**
20844     * Get the current slide layout in use for a given slideshow widget
20845     *
20846     * @param obj The slideshow object
20847     * @return The current layout's name
20848     *
20849     * @see elm_slideshow_layout_set() for more details
20850     *
20851     * @ingroup Slideshow
20852     */
20853    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20854
20855    /**
20856     * Returns the list of @b layout names available, for a given
20857     * slideshow widget.
20858     *
20859     * @param obj The slideshow object
20860     * @return The list of layouts (list of @b stringshared strings
20861     * as data)
20862     *
20863     * Slideshow layouts will change how the widget is to dispose each
20864     * image item in its viewport, with regard to cropping, scaling,
20865     * etc.
20866     *
20867     * The layouts, which come from @p obj's theme, must be an EDC
20868     * data item name @c "layouts" on the theme file, with (prefix)
20869     * names of EDC programs actually implementing them.
20870     *
20871     * The available layouts for slideshows on the default theme are:
20872     * - @c "fullscreen" - item images with original aspect, scaled to
20873     *   touch top and down slideshow borders or, if the image's heigh
20874     *   is not enough, left and right slideshow borders.
20875     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20876     *   one, but always leaving 10% of the slideshow's dimensions of
20877     *   distance between the item image's borders and the slideshow
20878     *   borders, for each axis.
20879     *
20880     * @warning The stringshared strings get no new references
20881     * exclusive to the user grabbing the list, here, so if you'd like
20882     * to use them out of this call's context, you'd better @c
20883     * eina_stringshare_ref() them.
20884     *
20885     * @see elm_slideshow_layout_set()
20886     *
20887     * @ingroup Slideshow
20888     */
20889    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20890
20891    /**
20892     * Set the number of items to cache, on a given slideshow widget,
20893     * <b>before the current item</b>
20894     *
20895     * @param obj The slideshow object
20896     * @param count Number of items to cache before the current one
20897     *
20898     * The default value for this property is @c 2. See
20899     * @ref Slideshow_Caching "slideshow caching" for more details.
20900     *
20901     * @see elm_slideshow_cache_before_get()
20902     *
20903     * @ingroup Slideshow
20904     */
20905    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20906
20907    /**
20908     * Retrieve the number of items to cache, on a given slideshow widget,
20909     * <b>before the current item</b>
20910     *
20911     * @param obj The slideshow object
20912     * @return The number of items set to be cached before the current one
20913     *
20914     * @see elm_slideshow_cache_before_set() for more details
20915     *
20916     * @ingroup Slideshow
20917     */
20918    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20919
20920    /**
20921     * Set the number of items to cache, on a given slideshow widget,
20922     * <b>after the current item</b>
20923     *
20924     * @param obj The slideshow object
20925     * @param count Number of items to cache after the current one
20926     *
20927     * The default value for this property is @c 2. See
20928     * @ref Slideshow_Caching "slideshow caching" for more details.
20929     *
20930     * @see elm_slideshow_cache_after_get()
20931     *
20932     * @ingroup Slideshow
20933     */
20934    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20935
20936    /**
20937     * Retrieve the number of items to cache, on a given slideshow widget,
20938     * <b>after the current item</b>
20939     *
20940     * @param obj The slideshow object
20941     * @return The number of items set to be cached after the current one
20942     *
20943     * @see elm_slideshow_cache_after_set() for more details
20944     *
20945     * @ingroup Slideshow
20946     */
20947    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20948
20949    /**
20950     * Get the number of items stored in a given slideshow widget
20951     *
20952     * @param obj The slideshow object
20953     * @return The number of items on @p obj, at the moment of this call
20954     *
20955     * @ingroup Slideshow
20956     */
20957    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20958
20959    /**
20960     * @}
20961     */
20962
20963    /**
20964     * @defgroup Fileselector File Selector
20965     *
20966     * @image html img/widget/fileselector/preview-00.png
20967     * @image latex img/widget/fileselector/preview-00.eps
20968     *
20969     * A file selector is a widget that allows a user to navigate
20970     * through a file system, reporting file selections back via its
20971     * API.
20972     *
20973     * It contains shortcut buttons for home directory (@c ~) and to
20974     * jump one directory upwards (..), as well as cancel/ok buttons to
20975     * confirm/cancel a given selection. After either one of those two
20976     * former actions, the file selector will issue its @c "done" smart
20977     * callback.
20978     *
20979     * There's a text entry on it, too, showing the name of the current
20980     * selection. There's the possibility of making it editable, so it
20981     * is useful on file saving dialogs on applications, where one
20982     * gives a file name to save contents to, in a given directory in
20983     * the system. This custom file name will be reported on the @c
20984     * "done" smart callback (explained in sequence).
20985     *
20986     * Finally, it has a view to display file system items into in two
20987     * possible forms:
20988     * - list
20989     * - grid
20990     *
20991     * If Elementary is built with support of the Ethumb thumbnailing
20992     * library, the second form of view will display preview thumbnails
20993     * of files which it supports.
20994     *
20995     * Smart callbacks one can register to:
20996     *
20997     * - @c "selected" - the user has clicked on a file (when not in
20998     *      folders-only mode) or directory (when in folders-only mode)
20999     * - @c "directory,open" - the list has been populated with new
21000     *      content (@c event_info is a pointer to the directory's
21001     *      path, a @b stringshared string)
21002     * - @c "done" - the user has clicked on the "ok" or "cancel"
21003     *      buttons (@c event_info is a pointer to the selection's
21004     *      path, a @b stringshared string)
21005     *
21006     * Here is an example on its usage:
21007     * @li @ref fileselector_example
21008     */
21009
21010    /**
21011     * @addtogroup Fileselector
21012     * @{
21013     */
21014
21015    /**
21016     * Defines how a file selector widget is to layout its contents
21017     * (file system entries).
21018     */
21019    typedef enum _Elm_Fileselector_Mode
21020      {
21021         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21022         ELM_FILESELECTOR_GRID, /**< layout as a grid */
21023         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21024      } Elm_Fileselector_Mode;
21025
21026    /**
21027     * Add a new file selector widget to the given parent Elementary
21028     * (container) object
21029     *
21030     * @param parent The parent object
21031     * @return a new file selector widget handle or @c NULL, on errors
21032     *
21033     * This function inserts a new file selector widget on the canvas.
21034     *
21035     * @ingroup Fileselector
21036     */
21037    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21038
21039    /**
21040     * Enable/disable the file name entry box where the user can type
21041     * in a name for a file, in a given file selector widget
21042     *
21043     * @param obj The file selector object
21044     * @param is_save @c EINA_TRUE to make the file selector a "saving
21045     * dialog", @c EINA_FALSE otherwise
21046     *
21047     * Having the entry editable is useful on file saving dialogs on
21048     * applications, where one gives a file name to save contents to,
21049     * in a given directory in the system. This custom file name will
21050     * be reported on the @c "done" smart callback.
21051     *
21052     * @see elm_fileselector_is_save_get()
21053     *
21054     * @ingroup Fileselector
21055     */
21056    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21057
21058    /**
21059     * Get whether the given file selector is in "saving dialog" mode
21060     *
21061     * @param obj The file selector object
21062     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21063     * mode, @c EINA_FALSE otherwise (and on errors)
21064     *
21065     * @see elm_fileselector_is_save_set() for more details
21066     *
21067     * @ingroup Fileselector
21068     */
21069    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21070
21071    /**
21072     * Enable/disable folder-only view for a given file selector widget
21073     *
21074     * @param obj The file selector object
21075     * @param only @c EINA_TRUE to make @p obj only display
21076     * directories, @c EINA_FALSE to make files to be displayed in it
21077     * too
21078     *
21079     * If enabled, the widget's view will only display folder items,
21080     * naturally.
21081     *
21082     * @see elm_fileselector_folder_only_get()
21083     *
21084     * @ingroup Fileselector
21085     */
21086    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21087
21088    /**
21089     * Get whether folder-only view is set for a given file selector
21090     * widget
21091     *
21092     * @param obj The file selector object
21093     * @return only @c EINA_TRUE if @p obj is only displaying
21094     * directories, @c EINA_FALSE if files are being displayed in it
21095     * too (and on errors)
21096     *
21097     * @see elm_fileselector_folder_only_get()
21098     *
21099     * @ingroup Fileselector
21100     */
21101    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21102
21103    /**
21104     * Enable/disable the "ok" and "cancel" buttons on a given file
21105     * selector widget
21106     *
21107     * @param obj The file selector object
21108     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21109     *
21110     * @note A file selector without those buttons will never emit the
21111     * @c "done" smart event, and is only usable if one is just hooking
21112     * to the other two events.
21113     *
21114     * @see elm_fileselector_buttons_ok_cancel_get()
21115     *
21116     * @ingroup Fileselector
21117     */
21118    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21119
21120    /**
21121     * Get whether the "ok" and "cancel" buttons on a given file
21122     * selector widget are being shown.
21123     *
21124     * @param obj The file selector object
21125     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21126     * otherwise (and on errors)
21127     *
21128     * @see elm_fileselector_buttons_ok_cancel_set() for more details
21129     *
21130     * @ingroup Fileselector
21131     */
21132    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21133
21134    /**
21135     * Enable/disable a tree view in the given file selector widget,
21136     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21137     *
21138     * @param obj The file selector object
21139     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21140     * disable
21141     *
21142     * In a tree view, arrows are created on the sides of directories,
21143     * allowing them to expand in place.
21144     *
21145     * @note If it's in other mode, the changes made by this function
21146     * will only be visible when one switches back to "list" mode.
21147     *
21148     * @see elm_fileselector_expandable_get()
21149     *
21150     * @ingroup Fileselector
21151     */
21152    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21153
21154    /**
21155     * Get whether tree view is enabled for the given file selector
21156     * widget
21157     *
21158     * @param obj The file selector object
21159     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21160     * otherwise (and or errors)
21161     *
21162     * @see elm_fileselector_expandable_set() for more details
21163     *
21164     * @ingroup Fileselector
21165     */
21166    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21167
21168    /**
21169     * Set, programmatically, the @b directory that a given file
21170     * selector widget will display contents from
21171     *
21172     * @param obj The file selector object
21173     * @param path The path to display in @p obj
21174     *
21175     * This will change the @b directory that @p obj is displaying. It
21176     * will also clear the text entry area on the @p obj object, which
21177     * displays select files' names.
21178     *
21179     * @see elm_fileselector_path_get()
21180     *
21181     * @ingroup Fileselector
21182     */
21183    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21184
21185    /**
21186     * Get the parent directory's path that a given file selector
21187     * widget is displaying
21188     *
21189     * @param obj The file selector object
21190     * @return The (full) path of the directory the file selector is
21191     * displaying, a @b stringshared string
21192     *
21193     * @see elm_fileselector_path_set()
21194     *
21195     * @ingroup Fileselector
21196     */
21197    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21198
21199    /**
21200     * Set, programmatically, the currently selected file/directory in
21201     * the given file selector widget
21202     *
21203     * @param obj The file selector object
21204     * @param path The (full) path to a file or directory
21205     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21206     * latter case occurs if the directory or file pointed to do not
21207     * exist.
21208     *
21209     * @see elm_fileselector_selected_get()
21210     *
21211     * @ingroup Fileselector
21212     */
21213    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21214
21215    /**
21216     * Get the currently selected item's (full) path, in the given file
21217     * selector widget
21218     *
21219     * @param obj The file selector object
21220     * @return The absolute path of the selected item, a @b
21221     * stringshared string
21222     *
21223     * @note Custom editions on @p obj object's text entry, if made,
21224     * will appear on the return string of this function, naturally.
21225     *
21226     * @see elm_fileselector_selected_set() for more details
21227     *
21228     * @ingroup Fileselector
21229     */
21230    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21231
21232    /**
21233     * Set the mode in which a given file selector widget will display
21234     * (layout) file system entries in its view
21235     *
21236     * @param obj The file selector object
21237     * @param mode The mode of the fileselector, being it one of
21238     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21239     * first one, naturally, will display the files in a list. The
21240     * latter will make the widget to display its entries in a grid
21241     * form.
21242     *
21243     * @note By using elm_fileselector_expandable_set(), the user may
21244     * trigger a tree view for that list.
21245     *
21246     * @note If Elementary is built with support of the Ethumb
21247     * thumbnailing library, the second form of view will display
21248     * preview thumbnails of files which it supports. You must have
21249     * elm_need_ethumb() called in your Elementary for thumbnailing to
21250     * work, though.
21251     *
21252     * @see elm_fileselector_expandable_set().
21253     * @see elm_fileselector_mode_get().
21254     *
21255     * @ingroup Fileselector
21256     */
21257    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21258
21259    /**
21260     * Get the mode in which a given file selector widget is displaying
21261     * (layouting) file system entries in its view
21262     *
21263     * @param obj The fileselector object
21264     * @return The mode in which the fileselector is at
21265     *
21266     * @see elm_fileselector_mode_set() for more details
21267     *
21268     * @ingroup Fileselector
21269     */
21270    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21271
21272    /**
21273     * @}
21274     */
21275
21276    /**
21277     * @defgroup Progressbar Progress bar
21278     *
21279     * The progress bar is a widget for visually representing the
21280     * progress status of a given job/task.
21281     *
21282     * A progress bar may be horizontal or vertical. It may display an
21283     * icon besides it, as well as primary and @b units labels. The
21284     * former is meant to label the widget as a whole, while the
21285     * latter, which is formatted with floating point values (and thus
21286     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21287     * units"</c>), is meant to label the widget's <b>progress
21288     * value</b>. Label, icon and unit strings/objects are @b optional
21289     * for progress bars.
21290     *
21291     * A progress bar may be @b inverted, in which state it gets its
21292     * values inverted, with high values being on the left or top and
21293     * low values on the right or bottom, as opposed to normally have
21294     * the low values on the former and high values on the latter,
21295     * respectively, for horizontal and vertical modes.
21296     *
21297     * The @b span of the progress, as set by
21298     * elm_progressbar_span_size_set(), is its length (horizontally or
21299     * vertically), unless one puts size hints on the widget to expand
21300     * on desired directions, by any container. That length will be
21301     * scaled by the object or applications scaling factor. At any
21302     * point code can query the progress bar for its value with
21303     * elm_progressbar_value_get().
21304     *
21305     * Available widget styles for progress bars:
21306     * - @c "default"
21307     * - @c "wheel" (simple style, no text, no progression, only
21308     *      "pulse" effect is available)
21309     *
21310     * Default contents parts of the progressbar widget that you can use for are:
21311     * @li "icon" - A icon of the progressbar
21312     * 
21313     * Here is an example on its usage:
21314     * @li @ref progressbar_example
21315     */
21316
21317    /**
21318     * Add a new progress bar widget to the given parent Elementary
21319     * (container) object
21320     *
21321     * @param parent The parent object
21322     * @return a new progress bar widget handle or @c NULL, on errors
21323     *
21324     * This function inserts a new progress bar widget on the canvas.
21325     *
21326     * @ingroup Progressbar
21327     */
21328    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21329
21330    /**
21331     * Set whether a given progress bar widget is at "pulsing mode" or
21332     * not.
21333     *
21334     * @param obj The progress bar object
21335     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21336     * @c EINA_FALSE to put it back to its default one
21337     *
21338     * By default, progress bars will display values from the low to
21339     * high value boundaries. There are, though, contexts in which the
21340     * state of progression of a given task is @b unknown.  For those,
21341     * one can set a progress bar widget to a "pulsing state", to give
21342     * the user an idea that some computation is being held, but
21343     * without exact progress values. In the default theme it will
21344     * animate its bar with the contents filling in constantly and back
21345     * to non-filled, in a loop. To start and stop this pulsing
21346     * animation, one has to explicitly call elm_progressbar_pulse().
21347     *
21348     * @see elm_progressbar_pulse_get()
21349     * @see elm_progressbar_pulse()
21350     *
21351     * @ingroup Progressbar
21352     */
21353    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21354
21355    /**
21356     * Get whether a given progress bar widget is at "pulsing mode" or
21357     * not.
21358     *
21359     * @param obj The progress bar object
21360     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21361     * if it's in the default one (and on errors)
21362     *
21363     * @ingroup Progressbar
21364     */
21365    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21366
21367    /**
21368     * Start/stop a given progress bar "pulsing" animation, if its
21369     * under that mode
21370     *
21371     * @param obj The progress bar object
21372     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21373     * @c EINA_FALSE to @b stop it
21374     *
21375     * @note This call won't do anything if @p obj is not under "pulsing mode".
21376     *
21377     * @see elm_progressbar_pulse_set() for more details.
21378     *
21379     * @ingroup Progressbar
21380     */
21381    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21382
21383    /**
21384     * Set the progress value (in percentage) on a given progress bar
21385     * widget
21386     *
21387     * @param obj The progress bar object
21388     * @param val The progress value (@b must be between @c 0.0 and @c
21389     * 1.0)
21390     *
21391     * Use this call to set progress bar levels.
21392     *
21393     * @note If you passes a value out of the specified range for @p
21394     * val, it will be interpreted as the @b closest of the @b boundary
21395     * values in the range.
21396     *
21397     * @ingroup Progressbar
21398     */
21399    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21400
21401    /**
21402     * Get the progress value (in percentage) on a given progress bar
21403     * widget
21404     *
21405     * @param obj The progress bar object
21406     * @return The value of the progressbar
21407     *
21408     * @see elm_progressbar_value_set() for more details
21409     *
21410     * @ingroup Progressbar
21411     */
21412    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21413
21414    /**
21415     * Set the label of a given progress bar widget
21416     *
21417     * @param obj The progress bar object
21418     * @param label The text label string, in UTF-8
21419     *
21420     * @ingroup Progressbar
21421     * @deprecated use elm_object_text_set() instead.
21422     */
21423    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21424
21425    /**
21426     * Get the label of a given progress bar widget
21427     *
21428     * @param obj The progressbar object
21429     * @return The text label string, in UTF-8
21430     *
21431     * @ingroup Progressbar
21432     * @deprecated use elm_object_text_set() instead.
21433     */
21434    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21435
21436    /**
21437     * Set the icon object of a given progress bar widget
21438     *
21439     * @param obj The progress bar object
21440     * @param icon The icon object
21441     *
21442     * Use this call to decorate @p obj with an icon next to it.
21443     *
21444     * @note Once the icon object is set, a previously set one will be
21445     * deleted. If you want to keep that old content object, use the
21446     * elm_progressbar_icon_unset() function.
21447     *
21448     * @see elm_progressbar_icon_get()
21449     * @deprecated use elm_object_part_content_set() instead.
21450     *
21451     * @ingroup Progressbar
21452     */
21453    WILL_DEPRECATE  EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21454
21455    /**
21456     * Retrieve the icon object set for a given progress bar widget
21457     *
21458     * @param obj The progress bar object
21459     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21460     * otherwise (and on errors)
21461     *
21462     * @see elm_progressbar_icon_set() for more details
21463     * @deprecated use elm_object_part_content_get() instead.
21464     *
21465     * @ingroup Progressbar
21466     */
21467    WILL_DEPRECATE  EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21468
21469    /**
21470     * Unset an icon set on a given progress bar widget
21471     *
21472     * @param obj The progress bar object
21473     * @return The icon object that was being used, if any was set, or
21474     * @c NULL, otherwise (and on errors)
21475     *
21476     * This call will unparent and return the icon object which was set
21477     * for this widget, previously, on success.
21478     *
21479     * @see elm_progressbar_icon_set() for more details
21480     * @deprecated use elm_object_part_content_unset() instead.
21481     *
21482     * @ingroup Progressbar
21483     */
21484    WILL_DEPRECATE  EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21485
21486    /**
21487     * Set the (exact) length of the bar region of a given progress bar
21488     * widget
21489     *
21490     * @param obj The progress bar object
21491     * @param size The length of the progress bar's bar region
21492     *
21493     * This sets the minimum width (when in horizontal mode) or height
21494     * (when in vertical mode) of the actual bar area of the progress
21495     * bar @p obj. This in turn affects the object's minimum size. Use
21496     * this when you're not setting other size hints expanding on the
21497     * given direction (like weight and alignment hints) and you would
21498     * like it to have a specific size.
21499     *
21500     * @note Icon, label and unit text around @p obj will require their
21501     * own space, which will make @p obj to require more the @p size,
21502     * actually.
21503     *
21504     * @see elm_progressbar_span_size_get()
21505     *
21506     * @ingroup Progressbar
21507     */
21508    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21509
21510    /**
21511     * Get the length set for the bar region of a given progress bar
21512     * widget
21513     *
21514     * @param obj The progress bar object
21515     * @return The length of the progress bar's bar region
21516     *
21517     * If that size was not set previously, with
21518     * elm_progressbar_span_size_set(), this call will return @c 0.
21519     *
21520     * @ingroup Progressbar
21521     */
21522    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21523
21524    /**
21525     * Set the format string for a given progress bar widget's units
21526     * label
21527     *
21528     * @param obj The progress bar object
21529     * @param format The format string for @p obj's units label
21530     *
21531     * If @c NULL is passed on @p format, it will make @p obj's units
21532     * area to be hidden completely. If not, it'll set the <b>format
21533     * string</b> for the units label's @b text. The units label is
21534     * provided a floating point value, so the units text is up display
21535     * at most one floating point falue. Note that the units label is
21536     * optional. Use a format string such as "%1.2f meters" for
21537     * example.
21538     *
21539     * @note The default format string for a progress bar is an integer
21540     * percentage, as in @c "%.0f %%".
21541     *
21542     * @see elm_progressbar_unit_format_get()
21543     *
21544     * @ingroup Progressbar
21545     */
21546    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21547
21548    /**
21549     * Retrieve the format string set for a given progress bar widget's
21550     * units label
21551     *
21552     * @param obj The progress bar object
21553     * @return The format set string for @p obj's units label or
21554     * @c NULL, if none was set (and on errors)
21555     *
21556     * @see elm_progressbar_unit_format_set() for more details
21557     *
21558     * @ingroup Progressbar
21559     */
21560    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21561
21562    /**
21563     * Set the orientation of a given progress bar widget
21564     *
21565     * @param obj The progress bar object
21566     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21567     * @b horizontal, @c EINA_FALSE to make it @b vertical
21568     *
21569     * Use this function to change how your progress bar is to be
21570     * disposed: vertically or horizontally.
21571     *
21572     * @see elm_progressbar_horizontal_get()
21573     *
21574     * @ingroup Progressbar
21575     */
21576    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21577
21578    /**
21579     * Retrieve the orientation of a given progress bar widget
21580     *
21581     * @param obj The progress bar object
21582     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21583     * @c EINA_FALSE if it's @b vertical (and on errors)
21584     *
21585     * @see elm_progressbar_horizontal_set() for more details
21586     *
21587     * @ingroup Progressbar
21588     */
21589    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21590
21591    /**
21592     * Invert a given progress bar widget's displaying values order
21593     *
21594     * @param obj The progress bar object
21595     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21596     * @c EINA_FALSE to bring it back to default, non-inverted values.
21597     *
21598     * A progress bar may be @b inverted, in which state it gets its
21599     * values inverted, with high values being on the left or top and
21600     * low values on the right or bottom, as opposed to normally have
21601     * the low values on the former and high values on the latter,
21602     * respectively, for horizontal and vertical modes.
21603     *
21604     * @see elm_progressbar_inverted_get()
21605     *
21606     * @ingroup Progressbar
21607     */
21608    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21609
21610    /**
21611     * Get whether a given progress bar widget's displaying values are
21612     * inverted or not
21613     *
21614     * @param obj The progress bar object
21615     * @return @c EINA_TRUE, if @p obj has inverted values,
21616     * @c EINA_FALSE otherwise (and on errors)
21617     *
21618     * @see elm_progressbar_inverted_set() for more details
21619     *
21620     * @ingroup Progressbar
21621     */
21622    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21623
21624    /**
21625     * @defgroup Separator Separator
21626     *
21627     * @brief Separator is a very thin object used to separate other objects.
21628     *
21629     * A separator can be vertical or horizontal.
21630     *
21631     * @ref tutorial_separator is a good example of how to use a separator.
21632     * @{
21633     */
21634    /**
21635     * @brief Add a separator object to @p parent
21636     *
21637     * @param parent The parent object
21638     *
21639     * @return The separator object, or NULL upon failure
21640     */
21641    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21642    /**
21643     * @brief Set the horizontal mode of a separator object
21644     *
21645     * @param obj The separator object
21646     * @param horizontal If true, the separator is horizontal
21647     */
21648    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21649    /**
21650     * @brief Get the horizontal mode of a separator object
21651     *
21652     * @param obj The separator object
21653     * @return If true, the separator is horizontal
21654     *
21655     * @see elm_separator_horizontal_set()
21656     */
21657    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21658    /**
21659     * @}
21660     */
21661
21662    /**
21663     * @defgroup Spinner Spinner
21664     * @ingroup Elementary
21665     *
21666     * @image html img/widget/spinner/preview-00.png
21667     * @image latex img/widget/spinner/preview-00.eps
21668     *
21669     * A spinner is a widget which allows the user to increase or decrease
21670     * numeric values using arrow buttons, or edit values directly, clicking
21671     * over it and typing the new value.
21672     *
21673     * By default the spinner will not wrap and has a label
21674     * of "%.0f" (just showing the integer value of the double).
21675     *
21676     * A spinner has a label that is formatted with floating
21677     * point values and thus accepts a printf-style format string, like
21678     * “%1.2f units”.
21679     *
21680     * It also allows specific values to be replaced by pre-defined labels.
21681     *
21682     * Smart callbacks one can register to:
21683     *
21684     * - "changed" - Whenever the spinner value is changed.
21685     * - "delay,changed" - A short time after the value is changed by the user.
21686     *    This will be called only when the user stops dragging for a very short
21687     *    period or when they release their finger/mouse, so it avoids possibly
21688     *    expensive reactions to the value change.
21689     *
21690     * Available styles for it:
21691     * - @c "default";
21692     * - @c "vertical": up/down buttons at the right side and text left aligned.
21693     *
21694     * Here is an example on its usage:
21695     * @ref spinner_example
21696     */
21697
21698    /**
21699     * @addtogroup Spinner
21700     * @{
21701     */
21702
21703    /**
21704     * Add a new spinner widget to the given parent Elementary
21705     * (container) object.
21706     *
21707     * @param parent The parent object.
21708     * @return a new spinner widget handle or @c NULL, on errors.
21709     *
21710     * This function inserts a new spinner widget on the canvas.
21711     *
21712     * @ingroup Spinner
21713     *
21714     */
21715    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21716
21717    /**
21718     * Set the format string of the displayed label.
21719     *
21720     * @param obj The spinner object.
21721     * @param fmt The format string for the label display.
21722     *
21723     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21724     * string for the label text. The label text is provided a floating point
21725     * value, so the label text can display up to 1 floating point value.
21726     * Note that this is optional.
21727     *
21728     * Use a format string such as "%1.2f meters" for example, and it will
21729     * display values like: "3.14 meters" for a value equal to 3.14159.
21730     *
21731     * Default is "%0.f".
21732     *
21733     * @see elm_spinner_label_format_get()
21734     *
21735     * @ingroup Spinner
21736     */
21737    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21738
21739    /**
21740     * Get the label format of the spinner.
21741     *
21742     * @param obj The spinner object.
21743     * @return The text label format string in UTF-8.
21744     *
21745     * @see elm_spinner_label_format_set() for details.
21746     *
21747     * @ingroup Spinner
21748     */
21749    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21750
21751    /**
21752     * Set the minimum and maximum values for the spinner.
21753     *
21754     * @param obj The spinner object.
21755     * @param min The minimum value.
21756     * @param max The maximum value.
21757     *
21758     * Define the allowed range of values to be selected by the user.
21759     *
21760     * If actual value is less than @p min, it will be updated to @p min. If it
21761     * is bigger then @p max, will be updated to @p max. Actual value can be
21762     * get with elm_spinner_value_get().
21763     *
21764     * By default, min is equal to 0, and max is equal to 100.
21765     *
21766     * @warning Maximum must be greater than minimum.
21767     *
21768     * @see elm_spinner_min_max_get()
21769     *
21770     * @ingroup Spinner
21771     */
21772    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21773
21774    /**
21775     * Get the minimum and maximum values of the spinner.
21776     *
21777     * @param obj The spinner object.
21778     * @param min Pointer where to store the minimum value.
21779     * @param max Pointer where to store the maximum value.
21780     *
21781     * @note If only one value is needed, the other pointer can be passed
21782     * as @c NULL.
21783     *
21784     * @see elm_spinner_min_max_set() for details.
21785     *
21786     * @ingroup Spinner
21787     */
21788    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21789
21790    /**
21791     * Set the step used to increment or decrement the spinner value.
21792     *
21793     * @param obj The spinner object.
21794     * @param step The step value.
21795     *
21796     * This value will be incremented or decremented to the displayed value.
21797     * It will be incremented while the user keep right or top arrow pressed,
21798     * and will be decremented while the user keep left or bottom arrow pressed.
21799     *
21800     * The interval to increment / decrement can be set with
21801     * elm_spinner_interval_set().
21802     *
21803     * By default step value is equal to 1.
21804     *
21805     * @see elm_spinner_step_get()
21806     *
21807     * @ingroup Spinner
21808     */
21809    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21810
21811    /**
21812     * Get the step used to increment or decrement the spinner value.
21813     *
21814     * @param obj The spinner object.
21815     * @return The step value.
21816     *
21817     * @see elm_spinner_step_get() for more details.
21818     *
21819     * @ingroup Spinner
21820     */
21821    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21822
21823    /**
21824     * Set the value the spinner displays.
21825     *
21826     * @param obj The spinner object.
21827     * @param val The value to be displayed.
21828     *
21829     * Value will be presented on the label following format specified with
21830     * elm_spinner_format_set().
21831     *
21832     * @warning The value must to be between min and max values. This values
21833     * are set by elm_spinner_min_max_set().
21834     *
21835     * @see elm_spinner_value_get().
21836     * @see elm_spinner_format_set().
21837     * @see elm_spinner_min_max_set().
21838     *
21839     * @ingroup Spinner
21840     */
21841    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21842
21843    /**
21844     * Get the value displayed by the spinner.
21845     *
21846     * @param obj The spinner object.
21847     * @return The value displayed.
21848     *
21849     * @see elm_spinner_value_set() for details.
21850     *
21851     * @ingroup Spinner
21852     */
21853    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21854
21855    /**
21856     * Set whether the spinner should wrap when it reaches its
21857     * minimum or maximum value.
21858     *
21859     * @param obj The spinner object.
21860     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21861     * disable it.
21862     *
21863     * Disabled by default. If disabled, when the user tries to increment the
21864     * value,
21865     * but displayed value plus step value is bigger than maximum value,
21866     * the spinner
21867     * won't allow it. The same happens when the user tries to decrement it,
21868     * but the value less step is less than minimum value.
21869     *
21870     * When wrap is enabled, in such situations it will allow these changes,
21871     * but will get the value that would be less than minimum and subtracts
21872     * from maximum. Or add the value that would be more than maximum to
21873     * the minimum.
21874     *
21875     * E.g.:
21876     * @li min value = 10
21877     * @li max value = 50
21878     * @li step value = 20
21879     * @li displayed value = 20
21880     *
21881     * When the user decrement value (using left or bottom arrow), it will
21882     * displays @c 40, because max - (min - (displayed - step)) is
21883     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21884     *
21885     * @see elm_spinner_wrap_get().
21886     *
21887     * @ingroup Spinner
21888     */
21889    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21890
21891    /**
21892     * Get whether the spinner should wrap when it reaches its
21893     * minimum or maximum value.
21894     *
21895     * @param obj The spinner object
21896     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21897     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21898     *
21899     * @see elm_spinner_wrap_set() for details.
21900     *
21901     * @ingroup Spinner
21902     */
21903    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21904
21905    /**
21906     * Set whether the spinner can be directly edited by the user or not.
21907     *
21908     * @param obj The spinner object.
21909     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21910     * don't allow users to edit it directly.
21911     *
21912     * Spinner objects can have edition @b disabled, in which state they will
21913     * be changed only by arrows.
21914     * Useful for contexts
21915     * where you don't want your users to interact with it writting the value.
21916     * Specially
21917     * when using special values, the user can see real value instead
21918     * of special label on edition.
21919     *
21920     * It's enabled by default.
21921     *
21922     * @see elm_spinner_editable_get()
21923     *
21924     * @ingroup Spinner
21925     */
21926    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21927
21928    /**
21929     * Get whether the spinner can be directly edited by the user or not.
21930     *
21931     * @param obj The spinner object.
21932     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21933     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21934     *
21935     * @see elm_spinner_editable_set() for details.
21936     *
21937     * @ingroup Spinner
21938     */
21939    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21940
21941    /**
21942     * Set a special string to display in the place of the numerical value.
21943     *
21944     * @param obj The spinner object.
21945     * @param value The value to be replaced.
21946     * @param label The label to be used.
21947     *
21948     * It's useful for cases when a user should select an item that is
21949     * better indicated by a label than a value. For example, weekdays or months.
21950     *
21951     * E.g.:
21952     * @code
21953     * sp = elm_spinner_add(win);
21954     * elm_spinner_min_max_set(sp, 1, 3);
21955     * elm_spinner_special_value_add(sp, 1, "January");
21956     * elm_spinner_special_value_add(sp, 2, "February");
21957     * elm_spinner_special_value_add(sp, 3, "March");
21958     * evas_object_show(sp);
21959     * @endcode
21960     *
21961     * @ingroup Spinner
21962     */
21963    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21964
21965    /**
21966     * Set the interval on time updates for an user mouse button hold
21967     * on spinner widgets' arrows.
21968     *
21969     * @param obj The spinner object.
21970     * @param interval The (first) interval value in seconds.
21971     *
21972     * This interval value is @b decreased while the user holds the
21973     * mouse pointer either incrementing or decrementing spinner's value.
21974     *
21975     * This helps the user to get to a given value distant from the
21976     * current one easier/faster, as it will start to change quicker and
21977     * quicker on mouse button holds.
21978     *
21979     * The calculation for the next change interval value, starting from
21980     * the one set with this call, is the previous interval divided by
21981     * @c 1.05, so it decreases a little bit.
21982     *
21983     * The default starting interval value for automatic changes is
21984     * @c 0.85 seconds.
21985     *
21986     * @see elm_spinner_interval_get()
21987     *
21988     * @ingroup Spinner
21989     */
21990    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21991
21992    /**
21993     * Get the interval on time updates for an user mouse button hold
21994     * on spinner widgets' arrows.
21995     *
21996     * @param obj The spinner object.
21997     * @return The (first) interval value, in seconds, set on it.
21998     *
21999     * @see elm_spinner_interval_set() for more details.
22000     *
22001     * @ingroup Spinner
22002     */
22003    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22004
22005    /**
22006     * @}
22007     */
22008
22009    /**
22010     * @defgroup Index Index
22011     *
22012     * @image html img/widget/index/preview-00.png
22013     * @image latex img/widget/index/preview-00.eps
22014     *
22015     * An index widget gives you an index for fast access to whichever
22016     * group of other UI items one might have. It's a list of text
22017     * items (usually letters, for alphabetically ordered access).
22018     *
22019     * Index widgets are by default hidden and just appear when the
22020     * user clicks over it's reserved area in the canvas. In its
22021     * default theme, it's an area one @ref Fingers "finger" wide on
22022     * the right side of the index widget's container.
22023     *
22024     * When items on the index are selected, smart callbacks get
22025     * called, so that its user can make other container objects to
22026     * show a given area or child object depending on the index item
22027     * selected. You'd probably be using an index together with @ref
22028     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22029     * "general grids".
22030     *
22031     * Smart events one  can add callbacks for are:
22032     * - @c "changed" - When the selected index item changes. @c
22033     *      event_info is the selected item's data pointer.
22034     * - @c "delay,changed" - When the selected index item changes, but
22035     *      after a small idling period. @c event_info is the selected
22036     *      item's data pointer.
22037     * - @c "selected" - When the user releases a mouse button and
22038     *      selects an item. @c event_info is the selected item's data
22039     *      pointer.
22040     * - @c "level,up" - when the user moves a finger from the first
22041     *      level to the second level
22042     * - @c "level,down" - when the user moves a finger from the second
22043     *      level to the first level
22044     *
22045     * The @c "delay,changed" event is so that it'll wait a small time
22046     * before actually reporting those events and, moreover, just the
22047     * last event happening on those time frames will actually be
22048     * reported.
22049     *
22050     * Here are some examples on its usage:
22051     * @li @ref index_example_01
22052     * @li @ref index_example_02
22053     */
22054
22055    /**
22056     * @addtogroup Index
22057     * @{
22058     */
22059
22060    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22061
22062    /**
22063     * Add a new index widget to the given parent Elementary
22064     * (container) object
22065     *
22066     * @param parent The parent object
22067     * @return a new index widget handle or @c NULL, on errors
22068     *
22069     * This function inserts a new index widget on the canvas.
22070     *
22071     * @ingroup Index
22072     */
22073    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22074
22075    /**
22076     * Set whether a given index widget is or not visible,
22077     * programatically.
22078     *
22079     * @param obj The index object
22080     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22081     *
22082     * Not to be confused with visible as in @c evas_object_show() --
22083     * visible with regard to the widget's auto hiding feature.
22084     *
22085     * @see elm_index_active_get()
22086     *
22087     * @ingroup Index
22088     */
22089    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22090
22091    /**
22092     * Get whether a given index widget is currently visible or not.
22093     *
22094     * @param obj The index object
22095     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22096     *
22097     * @see elm_index_active_set() for more details
22098     *
22099     * @ingroup Index
22100     */
22101    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22102
22103    /**
22104     * Set the items level for a given index widget.
22105     *
22106     * @param obj The index object.
22107     * @param level @c 0 or @c 1, the currently implemented levels.
22108     *
22109     * @see elm_index_item_level_get()
22110     *
22111     * @ingroup Index
22112     */
22113    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22114
22115    /**
22116     * Get the items level set for a given index widget.
22117     *
22118     * @param obj The index object.
22119     * @return @c 0 or @c 1, which are the levels @p obj might be at.
22120     *
22121     * @see elm_index_item_level_set() for more information
22122     *
22123     * @ingroup Index
22124     */
22125    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22126
22127    /**
22128     * Returns the last selected item's data, for a given index widget.
22129     *
22130     * @param obj The index object.
22131     * @return The item @b data associated to the last selected item on
22132     * @p obj (or @c NULL, on errors).
22133     *
22134     * @warning The returned value is @b not an #Elm_Index_Item item
22135     * handle, but the data associated to it (see the @c item parameter
22136     * in elm_index_item_append(), as an example).
22137     *
22138     * @ingroup Index
22139     */
22140    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22141
22142    /**
22143     * Append a new item on a given index widget.
22144     *
22145     * @param obj The index object.
22146     * @param letter Letter under which the item should be indexed
22147     * @param item The item data to set for the index's item
22148     *
22149     * Despite the most common usage of the @p letter argument is for
22150     * single char strings, one could use arbitrary strings as index
22151     * entries.
22152     *
22153     * @c item will be the pointer returned back on @c "changed", @c
22154     * "delay,changed" and @c "selected" smart events.
22155     *
22156     * @ingroup Index
22157     */
22158    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22159
22160    /**
22161     * Prepend a new item on a given index widget.
22162     *
22163     * @param obj The index object.
22164     * @param letter Letter under which the item should be indexed
22165     * @param item The item data to set for the index's item
22166     *
22167     * Despite the most common usage of the @p letter argument is for
22168     * single char strings, one could use arbitrary strings as index
22169     * entries.
22170     *
22171     * @c item will be the pointer returned back on @c "changed", @c
22172     * "delay,changed" and @c "selected" smart events.
22173     *
22174     * @ingroup Index
22175     */
22176    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22177
22178    /**
22179     * Append a new item, on a given index widget, <b>after the item
22180     * having @p relative as data</b>.
22181     *
22182     * @param obj The index object.
22183     * @param letter Letter under which the item should be indexed
22184     * @param item The item data to set for the index's item
22185     * @param relative The item data of the index item to be the
22186     * predecessor of this new one
22187     *
22188     * Despite the most common usage of the @p letter argument is for
22189     * single char strings, one could use arbitrary strings as index
22190     * entries.
22191     *
22192     * @c item will be the pointer returned back on @c "changed", @c
22193     * "delay,changed" and @c "selected" smart events.
22194     *
22195     * @note If @p relative is @c NULL or if it's not found to be data
22196     * set on any previous item on @p obj, this function will behave as
22197     * elm_index_item_append().
22198     *
22199     * @ingroup Index
22200     */
22201    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22202
22203    /**
22204     * Prepend a new item, on a given index widget, <b>after the item
22205     * having @p relative as data</b>.
22206     *
22207     * @param obj The index object.
22208     * @param letter Letter under which the item should be indexed
22209     * @param item The item data to set for the index's item
22210     * @param relative The item data of the index item to be the
22211     * successor of this new one
22212     *
22213     * Despite the most common usage of the @p letter argument is for
22214     * single char strings, one could use arbitrary strings as index
22215     * entries.
22216     *
22217     * @c item will be the pointer returned back on @c "changed", @c
22218     * "delay,changed" and @c "selected" smart events.
22219     *
22220     * @note If @p relative is @c NULL or if it's not found to be data
22221     * set on any previous item on @p obj, this function will behave as
22222     * elm_index_item_prepend().
22223     *
22224     * @ingroup Index
22225     */
22226    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22227
22228    /**
22229     * Insert a new item into the given index widget, using @p cmp_func
22230     * function to sort items (by item handles).
22231     *
22232     * @param obj The index object.
22233     * @param letter Letter under which the item should be indexed
22234     * @param item The item data to set for the index's item
22235     * @param cmp_func The comparing function to be used to sort index
22236     * items <b>by #Elm_Index_Item item handles</b>
22237     * @param cmp_data_func A @b fallback function to be called for the
22238     * sorting of index items <b>by item data</b>). It will be used
22239     * when @p cmp_func returns @c 0 (equality), which means an index
22240     * item with provided item data already exists. To decide which
22241     * data item should be pointed to by the index item in question, @p
22242     * cmp_data_func will be used. If @p cmp_data_func returns a
22243     * non-negative value, the previous index item data will be
22244     * replaced by the given @p item pointer. If the previous data need
22245     * to be freed, it should be done by the @p cmp_data_func function,
22246     * because all references to it will be lost. If this function is
22247     * not provided (@c NULL is given), index items will be @b
22248     * duplicated, if @p cmp_func returns @c 0.
22249     *
22250     * Despite the most common usage of the @p letter argument is for
22251     * single char strings, one could use arbitrary strings as index
22252     * entries.
22253     *
22254     * @c item will be the pointer returned back on @c "changed", @c
22255     * "delay,changed" and @c "selected" smart events.
22256     *
22257     * @ingroup Index
22258     */
22259    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);
22260
22261    /**
22262     * Remove an item from a given index widget, <b>to be referenced by
22263     * it's data value</b>.
22264     *
22265     * @param obj The index object
22266     * @param item The item's data pointer for the item to be removed
22267     * from @p obj
22268     *
22269     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22270     * that callback function will be called by this one.
22271     *
22272     * @warning The item to be removed from @p obj will be found via
22273     * its item data pointer, and not by an #Elm_Index_Item handle.
22274     *
22275     * @ingroup Index
22276     */
22277    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22278
22279    /**
22280     * Find a given index widget's item, <b>using item data</b>.
22281     *
22282     * @param obj The index object
22283     * @param item The item data pointed to by the desired index item
22284     * @return The index item handle, if found, or @c NULL otherwise
22285     *
22286     * @ingroup Index
22287     */
22288    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22289
22290    /**
22291     * Removes @b all items from a given index widget.
22292     *
22293     * @param obj The index object.
22294     *
22295     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22296     * that callback function will be called for each item in @p obj.
22297     *
22298     * @ingroup Index
22299     */
22300    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22301
22302    /**
22303     * Go to a given items level on a index widget
22304     *
22305     * @param obj The index object
22306     * @param level The index level (one of @c 0 or @c 1)
22307     *
22308     * @ingroup Index
22309     */
22310    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22311
22312    /**
22313     * Return the data associated with a given index widget item
22314     *
22315     * @param it The index widget item handle
22316     * @return The data associated with @p it
22317     *
22318     * @see elm_index_item_data_set()
22319     *
22320     * @ingroup Index
22321     */
22322    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22323
22324    /**
22325     * Set the data associated with a given index widget item
22326     *
22327     * @param it The index widget item handle
22328     * @param data The new data pointer to set to @p it
22329     *
22330     * This sets new item data on @p it.
22331     *
22332     * @warning The old data pointer won't be touched by this function, so
22333     * the user had better to free that old data himself/herself.
22334     *
22335     * @ingroup Index
22336     */
22337    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22338
22339    /**
22340     * Set the function to be called when a given index widget item is freed.
22341     *
22342     * @param it The item to set the callback on
22343     * @param func The function to call on the item's deletion
22344     *
22345     * When called, @p func will have both @c data and @c event_info
22346     * arguments with the @p it item's data value and, naturally, the
22347     * @c obj argument with a handle to the parent index widget.
22348     *
22349     * @ingroup Index
22350     */
22351    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22352
22353    /**
22354     * Get the letter (string) set on a given index widget item.
22355     *
22356     * @param it The index item handle
22357     * @return The letter string set on @p it
22358     *
22359     * @ingroup Index
22360     */
22361    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22362
22363    /**
22364     */
22365    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22366
22367    /**
22368     * @}
22369     */
22370
22371    /**
22372     * @defgroup Photocam Photocam
22373     *
22374     * @image html img/widget/photocam/preview-00.png
22375     * @image latex img/widget/photocam/preview-00.eps
22376     *
22377     * This is a widget specifically for displaying high-resolution digital
22378     * camera photos giving speedy feedback (fast load), low memory footprint
22379     * and zooming and panning as well as fitting logic. It is entirely focused
22380     * on jpeg images, and takes advantage of properties of the jpeg format (via
22381     * evas loader features in the jpeg loader).
22382     *
22383     * Signals that you can add callbacks for are:
22384     * @li "clicked" - This is called when a user has clicked the photo without
22385     *                 dragging around.
22386     * @li "press" - This is called when a user has pressed down on the photo.
22387     * @li "longpressed" - This is called when a user has pressed down on the
22388     *                     photo for a long time without dragging around.
22389     * @li "clicked,double" - This is called when a user has double-clicked the
22390     *                        photo.
22391     * @li "load" - Photo load begins.
22392     * @li "loaded" - This is called when the image file load is complete for the
22393     *                first view (low resolution blurry version).
22394     * @li "load,detail" - Photo detailed data load begins.
22395     * @li "loaded,detail" - This is called when the image file load is complete
22396     *                      for the detailed image data (full resolution needed).
22397     * @li "zoom,start" - Zoom animation started.
22398     * @li "zoom,stop" - Zoom animation stopped.
22399     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22400     * @li "scroll" - the content has been scrolled (moved)
22401     * @li "scroll,anim,start" - scrolling animation has started
22402     * @li "scroll,anim,stop" - scrolling animation has stopped
22403     * @li "scroll,drag,start" - dragging the contents around has started
22404     * @li "scroll,drag,stop" - dragging the contents around has stopped
22405     *
22406     * @ref tutorial_photocam shows the API in action.
22407     * @{
22408     */
22409    /**
22410     * @brief Types of zoom available.
22411     */
22412    typedef enum _Elm_Photocam_Zoom_Mode
22413      {
22414         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22415         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22416         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22417         ELM_PHOTOCAM_ZOOM_MODE_LAST
22418      } Elm_Photocam_Zoom_Mode;
22419    /**
22420     * @brief Add a new Photocam object
22421     *
22422     * @param parent The parent object
22423     * @return The new object or NULL if it cannot be created
22424     */
22425    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22426    /**
22427     * @brief Set the photo file to be shown
22428     *
22429     * @param obj The photocam object
22430     * @param file The photo file
22431     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22432     *
22433     * This sets (and shows) the specified file (with a relative or absolute
22434     * path) and will return a load error (same error that
22435     * evas_object_image_load_error_get() will return). The image will change and
22436     * adjust its size at this point and begin a background load process for this
22437     * photo that at some time in the future will be displayed at the full
22438     * quality needed.
22439     */
22440    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22441    /**
22442     * @brief Returns the path of the current image file
22443     *
22444     * @param obj The photocam object
22445     * @return Returns the path
22446     *
22447     * @see elm_photocam_file_set()
22448     */
22449    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22450    /**
22451     * @brief Set the zoom level of the photo
22452     *
22453     * @param obj The photocam object
22454     * @param zoom The zoom level to set
22455     *
22456     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22457     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22458     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22459     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22460     * 16, 32, etc.).
22461     */
22462    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22463    /**
22464     * @brief Get the zoom level of the photo
22465     *
22466     * @param obj The photocam object
22467     * @return The current zoom level
22468     *
22469     * This returns the current zoom level of the photocam object. Note that if
22470     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22471     * (which is the default), the zoom level may be changed at any time by the
22472     * photocam object itself to account for photo size and photocam viewpoer
22473     * size.
22474     *
22475     * @see elm_photocam_zoom_set()
22476     * @see elm_photocam_zoom_mode_set()
22477     */
22478    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22479    /**
22480     * @brief Set the zoom mode
22481     *
22482     * @param obj The photocam object
22483     * @param mode The desired mode
22484     *
22485     * This sets the zoom mode to manual or one of several automatic levels.
22486     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22487     * elm_photocam_zoom_set() and will stay at that level until changed by code
22488     * or until zoom mode is changed. This is the default mode. The Automatic
22489     * modes will allow the photocam object to automatically adjust zoom mode
22490     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22491     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22492     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22493     * pixels within the frame are left unfilled.
22494     */
22495    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22496    /**
22497     * @brief Get the zoom mode
22498     *
22499     * @param obj The photocam object
22500     * @return The current zoom mode
22501     *
22502     * This gets the current zoom mode of the photocam object.
22503     *
22504     * @see elm_photocam_zoom_mode_set()
22505     */
22506    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22507    /**
22508     * @brief Get the current image pixel width and height
22509     *
22510     * @param obj The photocam object
22511     * @param w A pointer to the width return
22512     * @param h A pointer to the height return
22513     *
22514     * This gets the current photo pixel width and height (for the original).
22515     * The size will be returned in the integers @p w and @p h that are pointed
22516     * to.
22517     */
22518    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22519    /**
22520     * @brief Get the area of the image that is currently shown
22521     *
22522     * @param obj
22523     * @param x A pointer to the X-coordinate of region
22524     * @param y A pointer to the Y-coordinate of region
22525     * @param w A pointer to the width
22526     * @param h A pointer to the height
22527     *
22528     * @see elm_photocam_image_region_show()
22529     * @see elm_photocam_image_region_bring_in()
22530     */
22531    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22532    /**
22533     * @brief Set the viewed portion of the image
22534     *
22535     * @param obj The photocam object
22536     * @param x X-coordinate of region in image original pixels
22537     * @param y Y-coordinate of region in image original pixels
22538     * @param w Width of region in image original pixels
22539     * @param h Height of region in image original pixels
22540     *
22541     * This shows the region of the image without using animation.
22542     */
22543    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22544    /**
22545     * @brief Bring in the viewed portion of the image
22546     *
22547     * @param obj The photocam object
22548     * @param x X-coordinate of region in image original pixels
22549     * @param y Y-coordinate of region in image original pixels
22550     * @param w Width of region in image original pixels
22551     * @param h Height of region in image original pixels
22552     *
22553     * This shows the region of the image using animation.
22554     */
22555    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22556    /**
22557     * @brief Set the paused state for photocam
22558     *
22559     * @param obj The photocam object
22560     * @param paused The pause state to set
22561     *
22562     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22563     * photocam. The default is off. This will stop zooming using animation on
22564     * zoom levels changes and change instantly. This will stop any existing
22565     * animations that are running.
22566     */
22567    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22568    /**
22569     * @brief Get the paused state for photocam
22570     *
22571     * @param obj The photocam object
22572     * @return The current paused state
22573     *
22574     * This gets the current paused state for the photocam object.
22575     *
22576     * @see elm_photocam_paused_set()
22577     */
22578    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22579    /**
22580     * @brief Get the internal low-res image used for photocam
22581     *
22582     * @param obj The photocam object
22583     * @return The internal image object handle, or NULL if none exists
22584     *
22585     * This gets the internal image object inside photocam. Do not modify it. It
22586     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22587     * deleted at any time as well.
22588     */
22589    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22590    /**
22591     * @brief Set the photocam scrolling bouncing.
22592     *
22593     * @param obj The photocam object
22594     * @param h_bounce bouncing for horizontal
22595     * @param v_bounce bouncing for vertical
22596     */
22597    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22598    /**
22599     * @brief Get the photocam scrolling bouncing.
22600     *
22601     * @param obj The photocam object
22602     * @param h_bounce bouncing for horizontal
22603     * @param v_bounce bouncing for vertical
22604     *
22605     * @see elm_photocam_bounce_set()
22606     */
22607    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22608    /**
22609     * @}
22610     */
22611
22612    /**
22613     * @defgroup Map Map
22614     * @ingroup Elementary
22615     *
22616     * @image html img/widget/map/preview-00.png
22617     * @image latex img/widget/map/preview-00.eps
22618     *
22619     * This is a widget specifically for displaying a map. It uses basically
22620     * OpenStreetMap provider http://www.openstreetmap.org/,
22621     * but custom providers can be added.
22622     *
22623     * It supports some basic but yet nice features:
22624     * @li zoom and scroll
22625     * @li markers with content to be displayed when user clicks over it
22626     * @li group of markers
22627     * @li routes
22628     *
22629     * Smart callbacks one can listen to:
22630     *
22631     * - "clicked" - This is called when a user has clicked the map without
22632     *   dragging around.
22633     * - "press" - This is called when a user has pressed down on the map.
22634     * - "longpressed" - This is called when a user has pressed down on the map
22635     *   for a long time without dragging around.
22636     * - "clicked,double" - This is called when a user has double-clicked
22637     *   the map.
22638     * - "load,detail" - Map detailed data load begins.
22639     * - "loaded,detail" - This is called when all currently visible parts of
22640     *   the map are loaded.
22641     * - "zoom,start" - Zoom animation started.
22642     * - "zoom,stop" - Zoom animation stopped.
22643     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22644     * - "scroll" - the content has been scrolled (moved).
22645     * - "scroll,anim,start" - scrolling animation has started.
22646     * - "scroll,anim,stop" - scrolling animation has stopped.
22647     * - "scroll,drag,start" - dragging the contents around has started.
22648     * - "scroll,drag,stop" - dragging the contents around has stopped.
22649     * - "downloaded" - This is called when all currently required map images
22650     *   are downloaded.
22651     * - "route,load" - This is called when route request begins.
22652     * - "route,loaded" - This is called when route request ends.
22653     * - "name,load" - This is called when name request begins.
22654     * - "name,loaded- This is called when name request ends.
22655     *
22656     * Available style for map widget:
22657     * - @c "default"
22658     *
22659     * Available style for markers:
22660     * - @c "radio"
22661     * - @c "radio2"
22662     * - @c "empty"
22663     *
22664     * Available style for marker bubble:
22665     * - @c "default"
22666     *
22667     * List of examples:
22668     * @li @ref map_example_01
22669     * @li @ref map_example_02
22670     * @li @ref map_example_03
22671     */
22672
22673    /**
22674     * @addtogroup Map
22675     * @{
22676     */
22677
22678    /**
22679     * @enum _Elm_Map_Zoom_Mode
22680     * @typedef Elm_Map_Zoom_Mode
22681     *
22682     * Set map's zoom behavior. It can be set to manual or automatic.
22683     *
22684     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22685     *
22686     * Values <b> don't </b> work as bitmask, only one can be choosen.
22687     *
22688     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22689     * than the scroller view.
22690     *
22691     * @see elm_map_zoom_mode_set()
22692     * @see elm_map_zoom_mode_get()
22693     *
22694     * @ingroup Map
22695     */
22696    typedef enum _Elm_Map_Zoom_Mode
22697      {
22698         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22699         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22700         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22701         ELM_MAP_ZOOM_MODE_LAST
22702      } Elm_Map_Zoom_Mode;
22703
22704    /**
22705     * @enum _Elm_Map_Route_Sources
22706     * @typedef Elm_Map_Route_Sources
22707     *
22708     * Set route service to be used. By default used source is
22709     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22710     *
22711     * @see elm_map_route_source_set()
22712     * @see elm_map_route_source_get()
22713     *
22714     * @ingroup Map
22715     */
22716    typedef enum _Elm_Map_Route_Sources
22717      {
22718         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22719         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. */
22720         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22721         ELM_MAP_ROUTE_SOURCE_LAST
22722      } Elm_Map_Route_Sources;
22723
22724    typedef enum _Elm_Map_Name_Sources
22725      {
22726         ELM_MAP_NAME_SOURCE_NOMINATIM,
22727         ELM_MAP_NAME_SOURCE_LAST
22728      } Elm_Map_Name_Sources;
22729
22730    /**
22731     * @enum _Elm_Map_Route_Type
22732     * @typedef Elm_Map_Route_Type
22733     *
22734     * Set type of transport used on route.
22735     *
22736     * @see elm_map_route_add()
22737     *
22738     * @ingroup Map
22739     */
22740    typedef enum _Elm_Map_Route_Type
22741      {
22742         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22743         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22744         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22745         ELM_MAP_ROUTE_TYPE_LAST
22746      } Elm_Map_Route_Type;
22747
22748    /**
22749     * @enum _Elm_Map_Route_Method
22750     * @typedef Elm_Map_Route_Method
22751     *
22752     * Set the routing method, what should be priorized, time or distance.
22753     *
22754     * @see elm_map_route_add()
22755     *
22756     * @ingroup Map
22757     */
22758    typedef enum _Elm_Map_Route_Method
22759      {
22760         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22761         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22762         ELM_MAP_ROUTE_METHOD_LAST
22763      } Elm_Map_Route_Method;
22764
22765    typedef enum _Elm_Map_Name_Method
22766      {
22767         ELM_MAP_NAME_METHOD_SEARCH,
22768         ELM_MAP_NAME_METHOD_REVERSE,
22769         ELM_MAP_NAME_METHOD_LAST
22770      } Elm_Map_Name_Method;
22771
22772    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(). */
22773    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(). */
22774    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(). */
22775    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(). */
22776    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22777    typedef struct _Elm_Map_Track           Elm_Map_Track;
22778
22779    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. */
22780    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22781    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22782    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22783
22784    typedef char        *(*ElmMapModuleSourceFunc) (void);
22785    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22786    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22787    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22788    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22789    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22790    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22791    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22792    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22793
22794    /**
22795     * Add a new map widget to the given parent Elementary (container) object.
22796     *
22797     * @param parent The parent object.
22798     * @return a new map widget handle or @c NULL, on errors.
22799     *
22800     * This function inserts a new map widget on the canvas.
22801     *
22802     * @ingroup Map
22803     */
22804    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22805
22806    /**
22807     * Set the zoom level of the map.
22808     *
22809     * @param obj The map object.
22810     * @param zoom The zoom level to set.
22811     *
22812     * This sets the zoom level.
22813     *
22814     * It will respect limits defined by elm_map_source_zoom_min_set() and
22815     * elm_map_source_zoom_max_set().
22816     *
22817     * By default these values are 0 (world map) and 18 (maximum zoom).
22818     *
22819     * This function should be used when zoom mode is set to
22820     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22821     * with elm_map_zoom_mode_set().
22822     *
22823     * @see elm_map_zoom_mode_set().
22824     * @see elm_map_zoom_get().
22825     *
22826     * @ingroup Map
22827     */
22828    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22829
22830    /**
22831     * Get the zoom level of the map.
22832     *
22833     * @param obj The map object.
22834     * @return The current zoom level.
22835     *
22836     * This returns the current zoom level of the map object.
22837     *
22838     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22839     * (which is the default), the zoom level may be changed at any time by the
22840     * map object itself to account for map size and map viewport size.
22841     *
22842     * @see elm_map_zoom_set() for details.
22843     *
22844     * @ingroup Map
22845     */
22846    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22847
22848    /**
22849     * Set the zoom mode used by the map object.
22850     *
22851     * @param obj The map object.
22852     * @param mode The zoom mode of the map, being it one of
22853     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22854     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22855     *
22856     * This sets the zoom mode to manual or one of the automatic levels.
22857     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22858     * elm_map_zoom_set() and will stay at that level until changed by code
22859     * or until zoom mode is changed. This is the default mode.
22860     *
22861     * The Automatic modes will allow the map object to automatically
22862     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22863     * adjust zoom so the map fits inside the scroll frame with no pixels
22864     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22865     * ensure no pixels within the frame are left unfilled. Do not forget that
22866     * the valid sizes are 2^zoom, consequently the map may be smaller than
22867     * the scroller view.
22868     *
22869     * @see elm_map_zoom_set()
22870     *
22871     * @ingroup Map
22872     */
22873    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22874
22875    /**
22876     * Get the zoom mode used by the map object.
22877     *
22878     * @param obj The map object.
22879     * @return The zoom mode of the map, being it one of
22880     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22881     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22882     *
22883     * This function returns the current zoom mode used by the map object.
22884     *
22885     * @see elm_map_zoom_mode_set() for more details.
22886     *
22887     * @ingroup Map
22888     */
22889    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22890
22891    /**
22892     * Get the current coordinates of the map.
22893     *
22894     * @param obj The map object.
22895     * @param lon Pointer where to store longitude.
22896     * @param lat Pointer where to store latitude.
22897     *
22898     * This gets the current center coordinates of the map object. It can be
22899     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22900     *
22901     * @see elm_map_geo_region_bring_in()
22902     * @see elm_map_geo_region_show()
22903     *
22904     * @ingroup Map
22905     */
22906    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22907
22908    /**
22909     * Animatedly bring in given coordinates to the center of the map.
22910     *
22911     * @param obj The map object.
22912     * @param lon Longitude to center at.
22913     * @param lat Latitude to center at.
22914     *
22915     * This causes map to jump to the given @p lat and @p lon coordinates
22916     * and show it (by scrolling) in the center of the viewport, if it is not
22917     * already centered. This will use animation to do so and take a period
22918     * of time to complete.
22919     *
22920     * @see elm_map_geo_region_show() for a function to avoid animation.
22921     * @see elm_map_geo_region_get()
22922     *
22923     * @ingroup Map
22924     */
22925    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22926
22927    /**
22928     * Show the given coordinates at the center of the map, @b immediately.
22929     *
22930     * @param obj The map object.
22931     * @param lon Longitude to center at.
22932     * @param lat Latitude to center at.
22933     *
22934     * This causes map to @b redraw its viewport's contents to the
22935     * region contining the given @p lat and @p lon, that will be moved to the
22936     * center of the map.
22937     *
22938     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22939     * @see elm_map_geo_region_get()
22940     *
22941     * @ingroup Map
22942     */
22943    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22944
22945    /**
22946     * Pause or unpause the map.
22947     *
22948     * @param obj The map object.
22949     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22950     * to unpause it.
22951     *
22952     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22953     * for map.
22954     *
22955     * The default is off.
22956     *
22957     * This will stop zooming using animation, changing zoom levels will
22958     * change instantly. This will stop any existing animations that are running.
22959     *
22960     * @see elm_map_paused_get()
22961     *
22962     * @ingroup Map
22963     */
22964    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22965
22966    /**
22967     * Get a value whether map is paused or not.
22968     *
22969     * @param obj The map object.
22970     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22971     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22972     *
22973     * This gets the current paused state for the map object.
22974     *
22975     * @see elm_map_paused_set() for details.
22976     *
22977     * @ingroup Map
22978     */
22979    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22980
22981    /**
22982     * Set to show markers during zoom level changes or not.
22983     *
22984     * @param obj The map object.
22985     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22986     * to show them.
22987     *
22988     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22989     * for map.
22990     *
22991     * The default is off.
22992     *
22993     * This will stop zooming using animation, changing zoom levels will
22994     * change instantly. This will stop any existing animations that are running.
22995     *
22996     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22997     * for the markers.
22998     *
22999     * The default  is off.
23000     *
23001     * Enabling it will force the map to stop displaying the markers during
23002     * zoom level changes. Set to on if you have a large number of markers.
23003     *
23004     * @see elm_map_paused_markers_get()
23005     *
23006     * @ingroup Map
23007     */
23008    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23009
23010    /**
23011     * Get a value whether markers will be displayed on zoom level changes or not
23012     *
23013     * @param obj The map object.
23014     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23015     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23016     *
23017     * This gets the current markers paused state for the map object.
23018     *
23019     * @see elm_map_paused_markers_set() for details.
23020     *
23021     * @ingroup Map
23022     */
23023    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23024
23025    /**
23026     * Get the information of downloading status.
23027     *
23028     * @param obj The map object.
23029     * @param try_num Pointer where to store number of tiles being downloaded.
23030     * @param finish_num Pointer where to store number of tiles successfully
23031     * downloaded.
23032     *
23033     * This gets the current downloading status for the map object, the number
23034     * of tiles being downloaded and the number of tiles already downloaded.
23035     *
23036     * @ingroup Map
23037     */
23038    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23039
23040    /**
23041     * Convert a pixel coordinate (x,y) into a geographic coordinate
23042     * (longitude, latitude).
23043     *
23044     * @param obj The map object.
23045     * @param x the coordinate.
23046     * @param y the coordinate.
23047     * @param size the size in pixels of the map.
23048     * The map is a square and generally his size is : pow(2.0, zoom)*256.
23049     * @param lon Pointer where to store the longitude that correspond to x.
23050     * @param lat Pointer where to store the latitude that correspond to y.
23051     *
23052     * @note Origin pixel point is the top left corner of the viewport.
23053     * Map zoom and size are taken on account.
23054     *
23055     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23056     *
23057     * @ingroup Map
23058     */
23059    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);
23060
23061    /**
23062     * Convert a geographic coordinate (longitude, latitude) into a pixel
23063     * coordinate (x, y).
23064     *
23065     * @param obj The map object.
23066     * @param lon the longitude.
23067     * @param lat the latitude.
23068     * @param size the size in pixels of the map. The map is a square
23069     * and generally his size is : pow(2.0, zoom)*256.
23070     * @param x Pointer where to store the horizontal pixel coordinate that
23071     * correspond to the longitude.
23072     * @param y Pointer where to store the vertical pixel coordinate that
23073     * correspond to the latitude.
23074     *
23075     * @note Origin pixel point is the top left corner of the viewport.
23076     * Map zoom and size are taken on account.
23077     *
23078     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23079     *
23080     * @ingroup Map
23081     */
23082    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);
23083
23084    /**
23085     * Convert a geographic coordinate (longitude, latitude) into a name
23086     * (address).
23087     *
23088     * @param obj The map object.
23089     * @param lon the longitude.
23090     * @param lat the latitude.
23091     * @return name A #Elm_Map_Name handle for this coordinate.
23092     *
23093     * To get the string for this address, elm_map_name_address_get()
23094     * should be used.
23095     *
23096     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23097     *
23098     * @ingroup Map
23099     */
23100    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23101
23102    /**
23103     * Convert a name (address) into a geographic coordinate
23104     * (longitude, latitude).
23105     *
23106     * @param obj The map object.
23107     * @param name The address.
23108     * @return name A #Elm_Map_Name handle for this address.
23109     *
23110     * To get the longitude and latitude, elm_map_name_region_get()
23111     * should be used.
23112     *
23113     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23114     *
23115     * @ingroup Map
23116     */
23117    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23118
23119    /**
23120     * Convert a pixel coordinate into a rotated pixel coordinate.
23121     *
23122     * @param obj The map object.
23123     * @param x horizontal coordinate of the point to rotate.
23124     * @param y vertical coordinate of the point to rotate.
23125     * @param cx rotation's center horizontal position.
23126     * @param cy rotation's center vertical position.
23127     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23128     * @param xx Pointer where to store rotated x.
23129     * @param yy Pointer where to store rotated y.
23130     *
23131     * @ingroup Map
23132     */
23133    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);
23134
23135    /**
23136     * Add a new marker to the map object.
23137     *
23138     * @param obj The map object.
23139     * @param lon The longitude of the marker.
23140     * @param lat The latitude of the marker.
23141     * @param clas The class, to use when marker @b isn't grouped to others.
23142     * @param clas_group The class group, to use when marker is grouped to others
23143     * @param data The data passed to the callbacks.
23144     *
23145     * @return The created marker or @c NULL upon failure.
23146     *
23147     * A marker will be created and shown in a specific point of the map, defined
23148     * by @p lon and @p lat.
23149     *
23150     * It will be displayed using style defined by @p class when this marker
23151     * is displayed alone (not grouped). A new class can be created with
23152     * elm_map_marker_class_new().
23153     *
23154     * If the marker is grouped to other markers, it will be displayed with
23155     * style defined by @p class_group. Markers with the same group are grouped
23156     * if they are close. A new group class can be created with
23157     * elm_map_marker_group_class_new().
23158     *
23159     * Markers created with this method can be deleted with
23160     * elm_map_marker_remove().
23161     *
23162     * A marker can have associated content to be displayed by a bubble,
23163     * when a user click over it, as well as an icon. These objects will
23164     * be fetch using class' callback functions.
23165     *
23166     * @see elm_map_marker_class_new()
23167     * @see elm_map_marker_group_class_new()
23168     * @see elm_map_marker_remove()
23169     *
23170     * @ingroup Map
23171     */
23172    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);
23173
23174    /**
23175     * Set the maximum numbers of markers' content to be displayed in a group.
23176     *
23177     * @param obj The map object.
23178     * @param max The maximum numbers of items displayed in a bubble.
23179     *
23180     * A bubble will be displayed when the user clicks over the group,
23181     * and will place the content of markers that belong to this group
23182     * inside it.
23183     *
23184     * A group can have a long list of markers, consequently the creation
23185     * of the content of the bubble can be very slow.
23186     *
23187     * In order to avoid this, a maximum number of items is displayed
23188     * in a bubble.
23189     *
23190     * By default this number is 30.
23191     *
23192     * Marker with the same group class are grouped if they are close.
23193     *
23194     * @see elm_map_marker_add()
23195     *
23196     * @ingroup Map
23197     */
23198    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23199
23200    /**
23201     * Remove a marker from the map.
23202     *
23203     * @param marker The marker to remove.
23204     *
23205     * @see elm_map_marker_add()
23206     *
23207     * @ingroup Map
23208     */
23209    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23210
23211    /**
23212     * Get the current coordinates of the marker.
23213     *
23214     * @param marker marker.
23215     * @param lat Pointer where to store the marker's latitude.
23216     * @param lon Pointer where to store the marker's longitude.
23217     *
23218     * These values are set when adding markers, with function
23219     * elm_map_marker_add().
23220     *
23221     * @see elm_map_marker_add()
23222     *
23223     * @ingroup Map
23224     */
23225    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23226
23227    /**
23228     * Animatedly bring in given marker to the center of the map.
23229     *
23230     * @param marker The marker to center at.
23231     *
23232     * This causes map to jump to the given @p marker's coordinates
23233     * and show it (by scrolling) in the center of the viewport, if it is not
23234     * already centered. This will use animation to do so and take a period
23235     * of time to complete.
23236     *
23237     * @see elm_map_marker_show() for a function to avoid animation.
23238     * @see elm_map_marker_region_get()
23239     *
23240     * @ingroup Map
23241     */
23242    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23243
23244    /**
23245     * Show the given marker at the center of the map, @b immediately.
23246     *
23247     * @param marker The marker to center at.
23248     *
23249     * This causes map to @b redraw its viewport's contents to the
23250     * region contining the given @p marker's coordinates, that will be
23251     * moved to the center of the map.
23252     *
23253     * @see elm_map_marker_bring_in() for a function to move with animation.
23254     * @see elm_map_markers_list_show() if more than one marker need to be
23255     * displayed.
23256     * @see elm_map_marker_region_get()
23257     *
23258     * @ingroup Map
23259     */
23260    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23261
23262    /**
23263     * Move and zoom the map to display a list of markers.
23264     *
23265     * @param markers A list of #Elm_Map_Marker handles.
23266     *
23267     * The map will be centered on the center point of the markers in the list.
23268     * Then the map will be zoomed in order to fit the markers using the maximum
23269     * zoom which allows display of all the markers.
23270     *
23271     * @warning All the markers should belong to the same map object.
23272     *
23273     * @see elm_map_marker_show() to show a single marker.
23274     * @see elm_map_marker_bring_in()
23275     *
23276     * @ingroup Map
23277     */
23278    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23279
23280    /**
23281     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23282     *
23283     * @param marker The marker wich content should be returned.
23284     * @return Return the evas object if it exists, else @c NULL.
23285     *
23286     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23287     * elm_map_marker_class_get_cb_set() should be used.
23288     *
23289     * This content is what will be inside the bubble that will be displayed
23290     * when an user clicks over the marker.
23291     *
23292     * This returns the actual Evas object used to be placed inside
23293     * the bubble. This may be @c NULL, as it may
23294     * not have been created or may have been deleted, at any time, by
23295     * the map. <b>Do not modify this object</b> (move, resize,
23296     * show, hide, etc.), as the map is controlling it. This
23297     * function is for querying, emitting custom signals or hooking
23298     * lower level callbacks for events on that object. Do not delete
23299     * this object under any circumstances.
23300     *
23301     * @ingroup Map
23302     */
23303    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23304
23305    /**
23306     * Update the marker
23307     *
23308     * @param marker The marker to be updated.
23309     *
23310     * If a content is set to this marker, it will call function to delete it,
23311     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23312     * #ElmMapMarkerGetFunc.
23313     *
23314     * These functions are set for the marker class with
23315     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23316     *
23317     * @ingroup Map
23318     */
23319    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23320
23321    /**
23322     * Close all the bubbles opened by the user.
23323     *
23324     * @param obj The map object.
23325     *
23326     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23327     * when the user clicks on a marker.
23328     *
23329     * This functions is set for the marker class with
23330     * elm_map_marker_class_get_cb_set().
23331     *
23332     * @ingroup Map
23333     */
23334    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23335
23336    /**
23337     * Create a new group class.
23338     *
23339     * @param obj The map object.
23340     * @return Returns the new group class.
23341     *
23342     * Each marker must be associated to a group class. Markers in the same
23343     * group are grouped if they are close.
23344     *
23345     * The group class defines the style of the marker when a marker is grouped
23346     * to others markers. When it is alone, another class will be used.
23347     *
23348     * A group class will need to be provided when creating a marker with
23349     * elm_map_marker_add().
23350     *
23351     * Some properties and functions can be set by class, as:
23352     * - style, with elm_map_group_class_style_set()
23353     * - data - to be associated to the group class. It can be set using
23354     *   elm_map_group_class_data_set().
23355     * - min zoom to display markers, set with
23356     *   elm_map_group_class_zoom_displayed_set().
23357     * - max zoom to group markers, set using
23358     *   elm_map_group_class_zoom_grouped_set().
23359     * - visibility - set if markers will be visible or not, set with
23360     *   elm_map_group_class_hide_set().
23361     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23362     *   It can be set using elm_map_group_class_icon_cb_set().
23363     *
23364     * @see elm_map_marker_add()
23365     * @see elm_map_group_class_style_set()
23366     * @see elm_map_group_class_data_set()
23367     * @see elm_map_group_class_zoom_displayed_set()
23368     * @see elm_map_group_class_zoom_grouped_set()
23369     * @see elm_map_group_class_hide_set()
23370     * @see elm_map_group_class_icon_cb_set()
23371     *
23372     * @ingroup Map
23373     */
23374    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23375
23376    /**
23377     * Set the marker's style of a group class.
23378     *
23379     * @param clas The group class.
23380     * @param style The style to be used by markers.
23381     *
23382     * Each marker must be associated to a group class, and will use the style
23383     * defined by such class when grouped to other markers.
23384     *
23385     * The following styles are provided by default theme:
23386     * @li @c radio - blue circle
23387     * @li @c radio2 - green circle
23388     * @li @c empty
23389     *
23390     * @see elm_map_group_class_new() for more details.
23391     * @see elm_map_marker_add()
23392     *
23393     * @ingroup Map
23394     */
23395    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23396
23397    /**
23398     * Set the icon callback function of a group class.
23399     *
23400     * @param clas The group class.
23401     * @param icon_get The callback function that will return the icon.
23402     *
23403     * Each marker must be associated to a group class, and it can display a
23404     * custom icon. The function @p icon_get must return this icon.
23405     *
23406     * @see elm_map_group_class_new() for more details.
23407     * @see elm_map_marker_add()
23408     *
23409     * @ingroup Map
23410     */
23411    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23412
23413    /**
23414     * Set the data associated to the group class.
23415     *
23416     * @param clas The group class.
23417     * @param data The new user data.
23418     *
23419     * This data will be passed for callback functions, like icon get callback,
23420     * that can be set with elm_map_group_class_icon_cb_set().
23421     *
23422     * If a data was previously set, the object will lose the pointer for it,
23423     * so if needs to be freed, you must do it yourself.
23424     *
23425     * @see elm_map_group_class_new() for more details.
23426     * @see elm_map_group_class_icon_cb_set()
23427     * @see elm_map_marker_add()
23428     *
23429     * @ingroup Map
23430     */
23431    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23432
23433    /**
23434     * Set the minimum zoom from where the markers are displayed.
23435     *
23436     * @param clas The group class.
23437     * @param zoom The minimum zoom.
23438     *
23439     * Markers only will be displayed when the map is displayed at @p zoom
23440     * or bigger.
23441     *
23442     * @see elm_map_group_class_new() for more details.
23443     * @see elm_map_marker_add()
23444     *
23445     * @ingroup Map
23446     */
23447    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23448
23449    /**
23450     * Set the zoom from where the markers are no more grouped.
23451     *
23452     * @param clas The group class.
23453     * @param zoom The maximum zoom.
23454     *
23455     * Markers only will be grouped when the map is displayed at
23456     * less than @p zoom.
23457     *
23458     * @see elm_map_group_class_new() for more details.
23459     * @see elm_map_marker_add()
23460     *
23461     * @ingroup Map
23462     */
23463    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23464
23465    /**
23466     * Set if the markers associated to the group class @clas are hidden or not.
23467     *
23468     * @param clas The group class.
23469     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23470     * to show them.
23471     *
23472     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23473     * is to show them.
23474     *
23475     * @ingroup Map
23476     */
23477    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23478
23479    /**
23480     * Create a new marker class.
23481     *
23482     * @param obj The map object.
23483     * @return Returns the new group class.
23484     *
23485     * Each marker must be associated to a class.
23486     *
23487     * The marker class defines the style of the marker when a marker is
23488     * displayed alone, i.e., not grouped to to others markers. When grouped
23489     * it will use group class style.
23490     *
23491     * A marker class will need to be provided when creating a marker with
23492     * elm_map_marker_add().
23493     *
23494     * Some properties and functions can be set by class, as:
23495     * - style, with elm_map_marker_class_style_set()
23496     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23497     *   It can be set using elm_map_marker_class_icon_cb_set().
23498     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23499     *   Set using elm_map_marker_class_get_cb_set().
23500     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23501     *   Set using elm_map_marker_class_del_cb_set().
23502     *
23503     * @see elm_map_marker_add()
23504     * @see elm_map_marker_class_style_set()
23505     * @see elm_map_marker_class_icon_cb_set()
23506     * @see elm_map_marker_class_get_cb_set()
23507     * @see elm_map_marker_class_del_cb_set()
23508     *
23509     * @ingroup Map
23510     */
23511    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23512
23513    /**
23514     * Set the marker's style of a marker class.
23515     *
23516     * @param clas The marker class.
23517     * @param style The style to be used by markers.
23518     *
23519     * Each marker must be associated to a marker class, and will use the style
23520     * defined by such class when alone, i.e., @b not grouped to other markers.
23521     *
23522     * The following styles are provided by default theme:
23523     * @li @c radio
23524     * @li @c radio2
23525     * @li @c empty
23526     *
23527     * @see elm_map_marker_class_new() for more details.
23528     * @see elm_map_marker_add()
23529     *
23530     * @ingroup Map
23531     */
23532    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23533
23534    /**
23535     * Set the icon callback function of a marker class.
23536     *
23537     * @param clas The marker class.
23538     * @param icon_get The callback function that will return the icon.
23539     *
23540     * Each marker must be associated to a marker class, and it can display a
23541     * custom icon. The function @p icon_get must return this icon.
23542     *
23543     * @see elm_map_marker_class_new() for more details.
23544     * @see elm_map_marker_add()
23545     *
23546     * @ingroup Map
23547     */
23548    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23549
23550    /**
23551     * Set the bubble content callback function of a marker class.
23552     *
23553     * @param clas The marker class.
23554     * @param get The callback function that will return the content.
23555     *
23556     * Each marker must be associated to a marker class, and it can display a
23557     * a content on a bubble that opens when the user click over the marker.
23558     * The function @p get must return this content object.
23559     *
23560     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23561     * can be used.
23562     *
23563     * @see elm_map_marker_class_new() for more details.
23564     * @see elm_map_marker_class_del_cb_set()
23565     * @see elm_map_marker_add()
23566     *
23567     * @ingroup Map
23568     */
23569    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23570
23571    /**
23572     * Set the callback function used to delete bubble content of a marker class.
23573     *
23574     * @param clas The marker class.
23575     * @param del The callback function that will delete the content.
23576     *
23577     * Each marker must be associated to a marker class, and it can display a
23578     * a content on a bubble that opens when the user click over the marker.
23579     * The function to return such content can be set with
23580     * elm_map_marker_class_get_cb_set().
23581     *
23582     * If this content must be freed, a callback function need to be
23583     * set for that task with this function.
23584     *
23585     * If this callback is defined it will have to delete (or not) the
23586     * object inside, but if the callback is not defined the object will be
23587     * destroyed with evas_object_del().
23588     *
23589     * @see elm_map_marker_class_new() for more details.
23590     * @see elm_map_marker_class_get_cb_set()
23591     * @see elm_map_marker_add()
23592     *
23593     * @ingroup Map
23594     */
23595    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23596
23597    /**
23598     * Get the list of available sources.
23599     *
23600     * @param obj The map object.
23601     * @return The source names list.
23602     *
23603     * It will provide a list with all available sources, that can be set as
23604     * current source with elm_map_source_name_set(), or get with
23605     * elm_map_source_name_get().
23606     *
23607     * Available sources:
23608     * @li "Mapnik"
23609     * @li "Osmarender"
23610     * @li "CycleMap"
23611     * @li "Maplint"
23612     *
23613     * @see elm_map_source_name_set() for more details.
23614     * @see elm_map_source_name_get()
23615     *
23616     * @ingroup Map
23617     */
23618    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23619
23620    /**
23621     * Set the source of the map.
23622     *
23623     * @param obj The map object.
23624     * @param source The source to be used.
23625     *
23626     * Map widget retrieves images that composes the map from a web service.
23627     * This web service can be set with this method.
23628     *
23629     * A different service can return a different maps with different
23630     * information and it can use different zoom values.
23631     *
23632     * The @p source_name need to match one of the names provided by
23633     * elm_map_source_names_get().
23634     *
23635     * The current source can be get using elm_map_source_name_get().
23636     *
23637     * @see elm_map_source_names_get()
23638     * @see elm_map_source_name_get()
23639     *
23640     *
23641     * @ingroup Map
23642     */
23643    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23644
23645    /**
23646     * Get the name of currently used source.
23647     *
23648     * @param obj The map object.
23649     * @return Returns the name of the source in use.
23650     *
23651     * @see elm_map_source_name_set() for more details.
23652     *
23653     * @ingroup Map
23654     */
23655    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23656
23657    /**
23658     * Set the source of the route service to be used by the map.
23659     *
23660     * @param obj The map object.
23661     * @param source The route service to be used, being it one of
23662     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23663     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23664     *
23665     * Each one has its own algorithm, so the route retrieved may
23666     * differ depending on the source route. Now, only the default is working.
23667     *
23668     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23669     * http://www.yournavigation.org/.
23670     *
23671     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23672     * assumptions. Its routing core is based on Contraction Hierarchies.
23673     *
23674     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23675     *
23676     * @see elm_map_route_source_get().
23677     *
23678     * @ingroup Map
23679     */
23680    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23681
23682    /**
23683     * Get the current route source.
23684     *
23685     * @param obj The map object.
23686     * @return The source of the route service used by the map.
23687     *
23688     * @see elm_map_route_source_set() for details.
23689     *
23690     * @ingroup Map
23691     */
23692    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23693
23694    /**
23695     * Set the minimum zoom of the source.
23696     *
23697     * @param obj The map object.
23698     * @param zoom New minimum zoom value to be used.
23699     *
23700     * By default, it's 0.
23701     *
23702     * @ingroup Map
23703     */
23704    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23705
23706    /**
23707     * Get the minimum zoom of the source.
23708     *
23709     * @param obj The map object.
23710     * @return Returns the minimum zoom of the source.
23711     *
23712     * @see elm_map_source_zoom_min_set() for details.
23713     *
23714     * @ingroup Map
23715     */
23716    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23717
23718    /**
23719     * Set the maximum zoom of the source.
23720     *
23721     * @param obj The map object.
23722     * @param zoom New maximum zoom value to be used.
23723     *
23724     * By default, it's 18.
23725     *
23726     * @ingroup Map
23727     */
23728    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23729
23730    /**
23731     * Get the maximum zoom of the source.
23732     *
23733     * @param obj The map object.
23734     * @return Returns the maximum zoom of the source.
23735     *
23736     * @see elm_map_source_zoom_min_set() for details.
23737     *
23738     * @ingroup Map
23739     */
23740    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23741
23742    /**
23743     * Set the user agent used by the map object to access routing services.
23744     *
23745     * @param obj The map object.
23746     * @param user_agent The user agent to be used by the map.
23747     *
23748     * User agent is a client application implementing a network protocol used
23749     * in communications within a client–server distributed computing system
23750     *
23751     * The @p user_agent identification string will transmitted in a header
23752     * field @c User-Agent.
23753     *
23754     * @see elm_map_user_agent_get()
23755     *
23756     * @ingroup Map
23757     */
23758    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23759
23760    /**
23761     * Get the user agent used by the map object.
23762     *
23763     * @param obj The map object.
23764     * @return The user agent identification string used by the map.
23765     *
23766     * @see elm_map_user_agent_set() for details.
23767     *
23768     * @ingroup Map
23769     */
23770    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23771
23772    /**
23773     * Add a new route to the map object.
23774     *
23775     * @param obj The map object.
23776     * @param type The type of transport to be considered when tracing a route.
23777     * @param method The routing method, what should be priorized.
23778     * @param flon The start longitude.
23779     * @param flat The start latitude.
23780     * @param tlon The destination longitude.
23781     * @param tlat The destination latitude.
23782     *
23783     * @return The created route or @c NULL upon failure.
23784     *
23785     * A route will be traced by point on coordinates (@p flat, @p flon)
23786     * to point on coordinates (@p tlat, @p tlon), using the route service
23787     * set with elm_map_route_source_set().
23788     *
23789     * It will take @p type on consideration to define the route,
23790     * depending if the user will be walking or driving, the route may vary.
23791     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23792     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23793     *
23794     * Another parameter is what the route should priorize, the minor distance
23795     * or the less time to be spend on the route. So @p method should be one
23796     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23797     *
23798     * Routes created with this method can be deleted with
23799     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23800     * and distance can be get with elm_map_route_distance_get().
23801     *
23802     * @see elm_map_route_remove()
23803     * @see elm_map_route_color_set()
23804     * @see elm_map_route_distance_get()
23805     * @see elm_map_route_source_set()
23806     *
23807     * @ingroup Map
23808     */
23809    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);
23810
23811    /**
23812     * Remove a route from the map.
23813     *
23814     * @param route The route to remove.
23815     *
23816     * @see elm_map_route_add()
23817     *
23818     * @ingroup Map
23819     */
23820    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23821
23822    /**
23823     * Set the route color.
23824     *
23825     * @param route The route object.
23826     * @param r Red channel value, from 0 to 255.
23827     * @param g Green channel value, from 0 to 255.
23828     * @param b Blue channel value, from 0 to 255.
23829     * @param a Alpha channel value, from 0 to 255.
23830     *
23831     * It uses an additive color model, so each color channel represents
23832     * how much of each primary colors must to be used. 0 represents
23833     * ausence of this color, so if all of the three are set to 0,
23834     * the color will be black.
23835     *
23836     * These component values should be integers in the range 0 to 255,
23837     * (single 8-bit byte).
23838     *
23839     * This sets the color used for the route. By default, it is set to
23840     * solid red (r = 255, g = 0, b = 0, a = 255).
23841     *
23842     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23843     *
23844     * @see elm_map_route_color_get()
23845     *
23846     * @ingroup Map
23847     */
23848    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23849
23850    /**
23851     * Get the route color.
23852     *
23853     * @param route The route object.
23854     * @param r Pointer where to store the red channel value.
23855     * @param g Pointer where to store the green channel value.
23856     * @param b Pointer where to store the blue channel value.
23857     * @param a Pointer where to store the alpha channel value.
23858     *
23859     * @see elm_map_route_color_set() for details.
23860     *
23861     * @ingroup Map
23862     */
23863    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23864
23865    /**
23866     * Get the route distance in kilometers.
23867     *
23868     * @param route The route object.
23869     * @return The distance of route (unit : km).
23870     *
23871     * @ingroup Map
23872     */
23873    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23874
23875    /**
23876     * Get the information of route nodes.
23877     *
23878     * @param route The route object.
23879     * @return Returns a string with the nodes of route.
23880     *
23881     * @ingroup Map
23882     */
23883    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23884
23885    /**
23886     * Get the information of route waypoint.
23887     *
23888     * @param route the route object.
23889     * @return Returns a string with information about waypoint of route.
23890     *
23891     * @ingroup Map
23892     */
23893    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23894
23895    /**
23896     * Get the address of the name.
23897     *
23898     * @param name The name handle.
23899     * @return Returns the address string of @p name.
23900     *
23901     * This gets the coordinates of the @p name, created with one of the
23902     * conversion functions.
23903     *
23904     * @see elm_map_utils_convert_name_into_coord()
23905     * @see elm_map_utils_convert_coord_into_name()
23906     *
23907     * @ingroup Map
23908     */
23909    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23910
23911    /**
23912     * Get the current coordinates of the name.
23913     *
23914     * @param name The name handle.
23915     * @param lat Pointer where to store the latitude.
23916     * @param lon Pointer where to store The longitude.
23917     *
23918     * This gets the coordinates of the @p name, created with one of the
23919     * conversion functions.
23920     *
23921     * @see elm_map_utils_convert_name_into_coord()
23922     * @see elm_map_utils_convert_coord_into_name()
23923     *
23924     * @ingroup Map
23925     */
23926    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23927
23928    /**
23929     * Remove a name from the map.
23930     *
23931     * @param name The name to remove.
23932     *
23933     * Basically the struct handled by @p name will be freed, so convertions
23934     * between address and coordinates will be lost.
23935     *
23936     * @see elm_map_utils_convert_name_into_coord()
23937     * @see elm_map_utils_convert_coord_into_name()
23938     *
23939     * @ingroup Map
23940     */
23941    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23942
23943    /**
23944     * Rotate the map.
23945     *
23946     * @param obj The map object.
23947     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23948     * @param cx Rotation's center horizontal position.
23949     * @param cy Rotation's center vertical position.
23950     *
23951     * @see elm_map_rotate_get()
23952     *
23953     * @ingroup Map
23954     */
23955    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23956
23957    /**
23958     * Get the rotate degree of the map
23959     *
23960     * @param obj The map object
23961     * @param degree Pointer where to store degrees from 0.0 to 360.0
23962     * to rotate arount Z axis.
23963     * @param cx Pointer where to store rotation's center horizontal position.
23964     * @param cy Pointer where to store rotation's center vertical position.
23965     *
23966     * @see elm_map_rotate_set() to set map rotation.
23967     *
23968     * @ingroup Map
23969     */
23970    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);
23971
23972    /**
23973     * Enable or disable mouse wheel to be used to zoom in / out the map.
23974     *
23975     * @param obj The map object.
23976     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23977     * to enable it.
23978     *
23979     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23980     *
23981     * It's disabled by default.
23982     *
23983     * @see elm_map_wheel_disabled_get()
23984     *
23985     * @ingroup Map
23986     */
23987    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23988
23989    /**
23990     * Get a value whether mouse wheel is enabled or not.
23991     *
23992     * @param obj The map object.
23993     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23994     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23995     *
23996     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23997     *
23998     * @see elm_map_wheel_disabled_set() for details.
23999     *
24000     * @ingroup Map
24001     */
24002    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24003
24004 #ifdef ELM_EMAP
24005    /**
24006     * Add a track on the map
24007     *
24008     * @param obj The map object.
24009     * @param emap The emap route object.
24010     * @return The route object. This is an elm object of type Route.
24011     *
24012     * @see elm_route_add() for details.
24013     *
24014     * @ingroup Map
24015     */
24016    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24017 #endif
24018
24019    /**
24020     * Remove a track from the map
24021     *
24022     * @param obj The map object.
24023     * @param route The track to remove.
24024     *
24025     * @ingroup Map
24026     */
24027    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24028
24029    /**
24030     * @}
24031     */
24032
24033    /* Route */
24034    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24035 #ifdef ELM_EMAP
24036    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24037 #endif
24038    EAPI double elm_route_lon_min_get(Evas_Object *obj);
24039    EAPI double elm_route_lat_min_get(Evas_Object *obj);
24040    EAPI double elm_route_lon_max_get(Evas_Object *obj);
24041    EAPI double elm_route_lat_max_get(Evas_Object *obj);
24042
24043
24044    /**
24045     * @defgroup Panel Panel
24046     *
24047     * @image html img/widget/panel/preview-00.png
24048     * @image latex img/widget/panel/preview-00.eps
24049     *
24050     * @brief A panel is a type of animated container that contains subobjects.
24051     * It can be expanded or contracted by clicking the button on it's edge.
24052     *
24053     * Orientations are as follows:
24054     * @li ELM_PANEL_ORIENT_TOP
24055     * @li ELM_PANEL_ORIENT_LEFT
24056     * @li ELM_PANEL_ORIENT_RIGHT
24057     *
24058     * Default contents parts of the panel widget that you can use for are:
24059     * @li "default" - A content of the panel
24060     *
24061     * @ref tutorial_panel shows one way to use this widget.
24062     * @{
24063     */
24064    typedef enum _Elm_Panel_Orient
24065      {
24066         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24067         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24068         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24069         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24070      } Elm_Panel_Orient;
24071    /**
24072     * @brief Adds a panel object
24073     *
24074     * @param parent The parent object
24075     *
24076     * @return The panel object, or NULL on failure
24077     */
24078    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24079    /**
24080     * @brief Sets the orientation of the panel
24081     *
24082     * @param parent The parent object
24083     * @param orient The panel orientation. Can be one of the following:
24084     * @li ELM_PANEL_ORIENT_TOP
24085     * @li ELM_PANEL_ORIENT_LEFT
24086     * @li ELM_PANEL_ORIENT_RIGHT
24087     *
24088     * Sets from where the panel will (dis)appear.
24089     */
24090    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24091    /**
24092     * @brief Get the orientation of the panel.
24093     *
24094     * @param obj The panel object
24095     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24096     */
24097    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24098    /**
24099     * @brief Set the content of the panel.
24100     *
24101     * @param obj The panel object
24102     * @param content The panel content
24103     *
24104     * Once the content object is set, a previously set one will be deleted.
24105     * If you want to keep that old content object, use the
24106     * elm_panel_content_unset() function.
24107     *
24108     * @deprecated use elm_object_content_set() instead
24109     *
24110     */
24111    WILL_DEPRECATE  EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24112    /**
24113     * @brief Get the content of the panel.
24114     *
24115     * @param obj The panel object
24116     * @return The content that is being used
24117     *
24118     * Return the content object which is set for this widget.
24119     *
24120     * @see elm_panel_content_set()
24121     * 
24122     * @deprecated use elm_object_content_get() instead
24123     *
24124     */
24125    WILL_DEPRECATE  EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24126    /**
24127     * @brief Unset the content of the panel.
24128     *
24129     * @param obj The panel object
24130     * @return The content that was being used
24131     *
24132     * Unparent and return the content object which was set for this widget.
24133     *
24134     * @see elm_panel_content_set()
24135     *
24136     * @deprecated use elm_object_content_unset() instead
24137     *
24138     */
24139    WILL_DEPRECATE  EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24140    /**
24141     * @brief Set the state of the panel.
24142     *
24143     * @param obj The panel object
24144     * @param hidden If true, the panel will run the animation to contract
24145     */
24146    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24147    /**
24148     * @brief Get the state of the panel.
24149     *
24150     * @param obj The panel object
24151     * @param hidden If true, the panel is in the "hide" state
24152     */
24153    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24154    /**
24155     * @brief Toggle the hidden state of the panel from code
24156     *
24157     * @param obj The panel object
24158     */
24159    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24160    /**
24161     * @}
24162     */
24163
24164    /**
24165     * @defgroup Panes Panes
24166     * @ingroup Elementary
24167     *
24168     * @image html img/widget/panes/preview-00.png
24169     * @image latex img/widget/panes/preview-00.eps width=\textwidth
24170     *
24171     * @image html img/panes.png
24172     * @image latex img/panes.eps width=\textwidth
24173     *
24174     * The panes adds a dragable bar between two contents. When dragged
24175     * this bar will resize contents size.
24176     *
24177     * Panes can be displayed vertically or horizontally, and contents
24178     * size proportion can be customized (homogeneous by default).
24179     *
24180     * Smart callbacks one can listen to:
24181     * - "press" - The panes has been pressed (button wasn't released yet).
24182     * - "unpressed" - The panes was released after being pressed.
24183     * - "clicked" - The panes has been clicked>
24184     * - "clicked,double" - The panes has been double clicked
24185     *
24186     * Available styles for it:
24187     * - @c "default"
24188     *
24189     * Default contents parts of the panes widget that you can use for are:
24190     * @li "left" - A leftside content of the panes
24191     * @li "right" - A rightside content of the panes
24192     *
24193     * If panes is displayed vertically, left content will be displayed at
24194     * top.
24195     * 
24196     * Here is an example on its usage:
24197     * @li @ref panes_example
24198     */
24199
24200    /**
24201     * @addtogroup Panes
24202     * @{
24203     */
24204
24205    /**
24206     * Add a new panes widget to the given parent Elementary
24207     * (container) object.
24208     *
24209     * @param parent The parent object.
24210     * @return a new panes widget handle or @c NULL, on errors.
24211     *
24212     * This function inserts a new panes widget on the canvas.
24213     *
24214     * @ingroup Panes
24215     */
24216    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24217
24218    /**
24219     * Set the left content of the panes widget.
24220     *
24221     * @param obj The panes object.
24222     * @param content The new left content object.
24223     *
24224     * Once the content object is set, a previously set one will be deleted.
24225     * If you want to keep that old content object, use the
24226     * elm_panes_content_left_unset() function.
24227     *
24228     * If panes is displayed vertically, left content will be displayed at
24229     * top.
24230     *
24231     * @see elm_panes_content_left_get()
24232     * @see elm_panes_content_right_set() to set content on the other side.
24233     *
24234     * @deprecated use elm_object_part_content_set() instead
24235     *
24236     * @ingroup Panes
24237     */
24238    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24239
24240    /**
24241     * Set the right content of the panes widget.
24242     *
24243     * @param obj The panes object.
24244     * @param content The new right content object.
24245     *
24246     * Once the content object is set, a previously set one will be deleted.
24247     * If you want to keep that old content object, use the
24248     * elm_panes_content_right_unset() function.
24249     *
24250     * If panes is displayed vertically, left content will be displayed at
24251     * bottom.
24252     *
24253     * @see elm_panes_content_right_get()
24254     * @see elm_panes_content_left_set() to set content on the other side.
24255     *
24256     * @deprecated use elm_object_part_content_set() instead
24257     *
24258     * @ingroup Panes
24259     */
24260    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24261
24262    /**
24263     * Get the left content of the panes.
24264     *
24265     * @param obj The panes object.
24266     * @return The left content object that is being used.
24267     *
24268     * Return the left content object which is set for this widget.
24269     *
24270     * @see elm_panes_content_left_set() for details.
24271     *
24272     * @deprecated use elm_object_part_content_get() instead
24273     *
24274     * @ingroup Panes
24275     */
24276    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24277
24278    /**
24279     * Get the right content of the panes.
24280     *
24281     * @param obj The panes object
24282     * @return The right content object that is being used
24283     *
24284     * Return the right content object which is set for this widget.
24285     *
24286     * @see elm_panes_content_right_set() for details.
24287     *
24288     * @deprecated use elm_object_part_content_get() instead
24289     *
24290     * @ingroup Panes
24291     */
24292    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24293
24294    /**
24295     * Unset the left content used for the panes.
24296     *
24297     * @param obj The panes object.
24298     * @return The left content object that was being used.
24299     *
24300     * Unparent and return the left content object which was set for this widget.
24301     *
24302     * @see elm_panes_content_left_set() for details.
24303     * @see elm_panes_content_left_get().
24304     *
24305     * @deprecated use elm_object_part_content_unset() instead
24306     *
24307     * @ingroup Panes
24308     */
24309    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24310
24311    /**
24312     * Unset the right content used for the panes.
24313     *
24314     * @param obj The panes object.
24315     * @return The right content object that was being used.
24316     *
24317     * Unparent and return the right content object which was set for this
24318     * widget.
24319     *
24320     * @see elm_panes_content_right_set() for details.
24321     * @see elm_panes_content_right_get().
24322     *
24323     * @deprecated use elm_object_part_content_unset() instead
24324     *
24325     * @ingroup Panes
24326     */
24327    WILL_DEPRECATE  EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24328
24329    /**
24330     * Get the size proportion of panes widget's left side.
24331     *
24332     * @param obj The panes object.
24333     * @return float value between 0.0 and 1.0 representing size proportion
24334     * of left side.
24335     *
24336     * @see elm_panes_content_left_size_set() for more details.
24337     *
24338     * @ingroup Panes
24339     */
24340    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24341
24342    /**
24343     * Set the size proportion of panes widget's left side.
24344     *
24345     * @param obj The panes object.
24346     * @param size Value between 0.0 and 1.0 representing size proportion
24347     * of left side.
24348     *
24349     * By default it's homogeneous, i.e., both sides have the same size.
24350     *
24351     * If something different is required, it can be set with this function.
24352     * For example, if the left content should be displayed over
24353     * 75% of the panes size, @p size should be passed as @c 0.75.
24354     * This way, right content will be resized to 25% of panes size.
24355     *
24356     * If displayed vertically, left content is displayed at top, and
24357     * right content at bottom.
24358     *
24359     * @note This proportion will change when user drags the panes bar.
24360     *
24361     * @see elm_panes_content_left_size_get()
24362     *
24363     * @ingroup Panes
24364     */
24365    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24366
24367   /**
24368    * Set the orientation of a given panes widget.
24369    *
24370    * @param obj The panes object.
24371    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24372    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24373    *
24374    * Use this function to change how your panes is to be
24375    * disposed: vertically or horizontally.
24376    *
24377    * By default it's displayed horizontally.
24378    *
24379    * @see elm_panes_horizontal_get()
24380    *
24381    * @ingroup Panes
24382    */
24383    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24384
24385    /**
24386     * Retrieve the orientation of a given panes widget.
24387     *
24388     * @param obj The panes object.
24389     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24390     * @c EINA_FALSE if it's @b vertical (and on errors).
24391     *
24392     * @see elm_panes_horizontal_set() for more details.
24393     *
24394     * @ingroup Panes
24395     */
24396    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24397    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24398    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24399
24400    /**
24401     * @}
24402     */
24403
24404    /**
24405     * @defgroup Flip Flip
24406     *
24407     * @image html img/widget/flip/preview-00.png
24408     * @image latex img/widget/flip/preview-00.eps
24409     *
24410     * This widget holds 2 content objects(Evas_Object): one on the front and one
24411     * on the back. It allows you to flip from front to back and vice-versa using
24412     * various animations.
24413     *
24414     * If either the front or back contents are not set the flip will treat that
24415     * as transparent. So if you wore to set the front content but not the back,
24416     * and then call elm_flip_go() you would see whatever is below the flip.
24417     *
24418     * For a list of supported animations see elm_flip_go().
24419     *
24420     * Signals that you can add callbacks for are:
24421     * "animate,begin" - when a flip animation was started
24422     * "animate,done" - when a flip animation is finished
24423     *
24424     * @ref tutorial_flip show how to use most of the API.
24425     *
24426     * @{
24427     */
24428    typedef enum _Elm_Flip_Mode
24429      {
24430         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24431         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24432         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24433         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24434         ELM_FLIP_CUBE_LEFT,
24435         ELM_FLIP_CUBE_RIGHT,
24436         ELM_FLIP_CUBE_UP,
24437         ELM_FLIP_CUBE_DOWN,
24438         ELM_FLIP_PAGE_LEFT,
24439         ELM_FLIP_PAGE_RIGHT,
24440         ELM_FLIP_PAGE_UP,
24441         ELM_FLIP_PAGE_DOWN
24442      } Elm_Flip_Mode;
24443    typedef enum _Elm_Flip_Interaction
24444      {
24445         ELM_FLIP_INTERACTION_NONE,
24446         ELM_FLIP_INTERACTION_ROTATE,
24447         ELM_FLIP_INTERACTION_CUBE,
24448         ELM_FLIP_INTERACTION_PAGE
24449      } Elm_Flip_Interaction;
24450    typedef enum _Elm_Flip_Direction
24451      {
24452         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24453         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24454         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24455         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24456      } Elm_Flip_Direction;
24457    /**
24458     * @brief Add a new flip to the parent
24459     *
24460     * @param parent The parent object
24461     * @return The new object or NULL if it cannot be created
24462     */
24463    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24464    /**
24465     * @brief Set the front content of the flip widget.
24466     *
24467     * @param obj The flip object
24468     * @param content The new front content object
24469     *
24470     * Once the content object is set, a previously set one will be deleted.
24471     * If you want to keep that old content object, use the
24472     * elm_flip_content_front_unset() function.
24473     */
24474    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24475    /**
24476     * @brief Set the back content of the flip widget.
24477     *
24478     * @param obj The flip object
24479     * @param content The new back content object
24480     *
24481     * Once the content object is set, a previously set one will be deleted.
24482     * If you want to keep that old content object, use the
24483     * elm_flip_content_back_unset() function.
24484     */
24485    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24486    /**
24487     * @brief Get the front content used for the flip
24488     *
24489     * @param obj The flip object
24490     * @return The front content object that is being used
24491     *
24492     * Return the front content object which is set for this widget.
24493     */
24494    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24495    /**
24496     * @brief Get the back content used for the flip
24497     *
24498     * @param obj The flip object
24499     * @return The back content object that is being used
24500     *
24501     * Return the back content object which is set for this widget.
24502     */
24503    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24504    /**
24505     * @brief Unset the front content used for the flip
24506     *
24507     * @param obj The flip object
24508     * @return The front content object that was being used
24509     *
24510     * Unparent and return the front content object which was set for this widget.
24511     */
24512    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24513    /**
24514     * @brief Unset the back content used for the flip
24515     *
24516     * @param obj The flip object
24517     * @return The back content object that was being used
24518     *
24519     * Unparent and return the back content object which was set for this widget.
24520     */
24521    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24522    /**
24523     * @brief Get flip front visibility state
24524     *
24525     * @param obj The flip objct
24526     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24527     * showing.
24528     */
24529    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24530    /**
24531     * @brief Set flip perspective
24532     *
24533     * @param obj The flip object
24534     * @param foc The coordinate to set the focus on
24535     * @param x The X coordinate
24536     * @param y The Y coordinate
24537     *
24538     * @warning This function currently does nothing.
24539     */
24540    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24541    /**
24542     * @brief Runs the flip animation
24543     *
24544     * @param obj The flip object
24545     * @param mode The mode type
24546     *
24547     * Flips the front and back contents using the @p mode animation. This
24548     * efectively hides the currently visible content and shows the hidden one.
24549     *
24550     * There a number of possible animations to use for the flipping:
24551     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24552     * around a horizontal axis in the middle of its height, the other content
24553     * is shown as the other side of the flip.
24554     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24555     * around a vertical axis in the middle of its width, the other content is
24556     * shown as the other side of the flip.
24557     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24558     * around a diagonal axis in the middle of its width, the other content is
24559     * shown as the other side of the flip.
24560     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24561     * around a diagonal axis in the middle of its height, the other content is
24562     * shown as the other side of the flip.
24563     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24564     * as if the flip was a cube, the other content is show as the right face of
24565     * the cube.
24566     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24567     * right as if the flip was a cube, the other content is show as the left
24568     * face of the cube.
24569     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24570     * flip was a cube, the other content is show as the bottom face of the cube.
24571     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24572     * the flip was a cube, the other content is show as the upper face of the
24573     * cube.
24574     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24575     * if the flip was a book, the other content is shown as the page below that.
24576     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24577     * as if the flip was a book, the other content is shown as the page below
24578     * that.
24579     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24580     * flip was a book, the other content is shown as the page below that.
24581     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24582     * flip was a book, the other content is shown as the page below that.
24583     *
24584     * @image html elm_flip.png
24585     * @image latex elm_flip.eps width=\textwidth
24586     */
24587    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24588    /**
24589     * @brief Set the interactive flip mode
24590     *
24591     * @param obj The flip object
24592     * @param mode The interactive flip mode to use
24593     *
24594     * This sets if the flip should be interactive (allow user to click and
24595     * drag a side of the flip to reveal the back page and cause it to flip).
24596     * By default a flip is not interactive. You may also need to set which
24597     * sides of the flip are "active" for flipping and how much space they use
24598     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24599     * and elm_flip_interacton_direction_hitsize_set()
24600     *
24601     * The four avilable mode of interaction are:
24602     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24603     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24604     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24605     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24606     *
24607     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24608     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24609     * happen, those can only be acheived with elm_flip_go();
24610     */
24611    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24612    /**
24613     * @brief Get the interactive flip mode
24614     *
24615     * @param obj The flip object
24616     * @return The interactive flip mode
24617     *
24618     * Returns the interactive flip mode set by elm_flip_interaction_set()
24619     */
24620    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24621    /**
24622     * @brief Set which directions of the flip respond to interactive flip
24623     *
24624     * @param obj The flip object
24625     * @param dir The direction to change
24626     * @param enabled If that direction is enabled or not
24627     *
24628     * By default all directions are disabled, so you may want to enable the
24629     * desired directions for flipping if you need interactive flipping. You must
24630     * call this function once for each direction that should be enabled.
24631     *
24632     * @see elm_flip_interaction_set()
24633     */
24634    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24635    /**
24636     * @brief Get the enabled state of that flip direction
24637     *
24638     * @param obj The flip object
24639     * @param dir The direction to check
24640     * @return If that direction is enabled or not
24641     *
24642     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24643     *
24644     * @see elm_flip_interaction_set()
24645     */
24646    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24647    /**
24648     * @brief Set the amount of the flip that is sensitive to interactive flip
24649     *
24650     * @param obj The flip object
24651     * @param dir The direction to modify
24652     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24653     *
24654     * Set the amount of the flip that is sensitive to interactive flip, with 0
24655     * representing no area in the flip and 1 representing the entire flip. There
24656     * is however a consideration to be made in that the area will never be
24657     * smaller than the finger size set(as set in your Elementary configuration).
24658     *
24659     * @see elm_flip_interaction_set()
24660     */
24661    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24662    /**
24663     * @brief Get the amount of the flip that is sensitive to interactive flip
24664     *
24665     * @param obj The flip object
24666     * @param dir The direction to check
24667     * @return The size set for that direction
24668     *
24669     * Returns the amount os sensitive area set by
24670     * elm_flip_interacton_direction_hitsize_set().
24671     */
24672    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24673    /**
24674     * @}
24675     */
24676
24677    /* scrolledentry */
24678    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24679    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24680    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24681    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24682    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24683    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24684    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24685    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24686    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24687    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24688    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24689    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24690    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24691    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24692    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24693    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24694    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24695    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24696    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24697    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24698    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24699    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24700    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24701    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24702    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24703    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24704    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24705    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24706    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24707    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24708    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24709    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24710    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24711    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24712    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24713    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);
24714    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24715    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24716    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);
24717    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24718    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);
24719    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24720    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24721    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24722    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24723    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24724    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24725    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24726    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24727    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);
24728    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);
24729    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);
24730    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);
24731    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);
24732    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);
24733    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24734    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24735    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24736    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24737    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24738    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24739    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24740    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24741    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24742    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24743    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24744    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24745    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24746
24747    /**
24748     * @defgroup Conformant Conformant
24749     * @ingroup Elementary
24750     *
24751     * @image html img/widget/conformant/preview-00.png
24752     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24753     *
24754     * @image html img/conformant.png
24755     * @image latex img/conformant.eps width=\textwidth
24756     *
24757     * The aim is to provide a widget that can be used in elementary apps to
24758     * account for space taken up by the indicator, virtual keypad & softkey
24759     * windows when running the illume2 module of E17.
24760     *
24761     * So conformant content will be sized and positioned considering the
24762     * space required for such stuff, and when they popup, as a keyboard
24763     * shows when an entry is selected, conformant content won't change.
24764     *
24765     * Available styles for it:
24766     * - @c "default"
24767     *
24768     * Default contents parts of the conformant widget that you can use for are:
24769     * @li "default" - A content of the conformant
24770     *
24771     * See how to use this widget in this example:
24772     * @ref conformant_example
24773     */
24774
24775    /**
24776     * @addtogroup Conformant
24777     * @{
24778     */
24779
24780    /**
24781     * Add a new conformant widget to the given parent Elementary
24782     * (container) object.
24783     *
24784     * @param parent The parent object.
24785     * @return A new conformant widget handle or @c NULL, on errors.
24786     *
24787     * This function inserts a new conformant widget on the canvas.
24788     *
24789     * @ingroup Conformant
24790     */
24791    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24792
24793    /**
24794     * Set the content of the conformant widget.
24795     *
24796     * @param obj The conformant object.
24797     * @param content The content to be displayed by the conformant.
24798     *
24799     * Content will be sized and positioned considering the space required
24800     * to display a virtual keyboard. So it won't fill all the conformant
24801     * size. This way is possible to be sure that content won't resize
24802     * or be re-positioned after the keyboard is displayed.
24803     *
24804     * Once the content object is set, a previously set one will be deleted.
24805     * If you want to keep that old content object, use the
24806     * elm_object_content_unset() function.
24807     *
24808     * @see elm_object_content_unset()
24809     * @see elm_object_content_get()
24810     *
24811     * @deprecated use elm_object_content_set() instead
24812     *
24813     * @ingroup Conformant
24814     */
24815    WILL_DEPRECATE  EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24816
24817    /**
24818     * Get the content of the conformant widget.
24819     *
24820     * @param obj The conformant object.
24821     * @return The content that is being used.
24822     *
24823     * Return the content object which is set for this widget.
24824     * It won't be unparent from conformant. For that, use
24825     * elm_object_content_unset().
24826     *
24827     * @see elm_object_content_set().
24828     * @see elm_object_content_unset()
24829     *
24830     * @deprecated use elm_object_content_get() instead
24831     *
24832     * @ingroup Conformant
24833     */
24834    WILL_DEPRECATE  EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24835
24836    /**
24837     * Unset the content of the conformant widget.
24838     *
24839     * @param obj The conformant object.
24840     * @return The content that was being used.
24841     *
24842     * Unparent and return the content object which was set for this widget.
24843     *
24844     * @see elm_object_content_set().
24845     *
24846     * @deprecated use elm_object_content_unset() instead
24847     *
24848     * @ingroup Conformant
24849     */
24850    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24851
24852    /**
24853     * Returns the Evas_Object that represents the content area.
24854     *
24855     * @param obj The conformant object.
24856     * @return The content area of the widget.
24857     *
24858     * @ingroup Conformant
24859     */
24860    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24861
24862    /**
24863     * @}
24864     */
24865
24866    /**
24867     * @defgroup Mapbuf Mapbuf
24868     * @ingroup Elementary
24869     *
24870     * @image html img/widget/mapbuf/preview-00.png
24871     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24872     *
24873     * This holds one content object and uses an Evas Map of transformation
24874     * points to be later used with this content. So the content will be
24875     * moved, resized, etc as a single image. So it will improve performance
24876     * when you have a complex interafce, with a lot of elements, and will
24877     * need to resize or move it frequently (the content object and its
24878     * children).
24879     *
24880     * Default contents parts of the mapbuf widget that you can use for are:
24881     * @li "default" - A content of the mapbuf
24882     *
24883     * To enable map, elm_mapbuf_enabled_set() should be used.
24884     * 
24885     * See how to use this widget in this example:
24886     * @ref mapbuf_example
24887     */
24888
24889    /**
24890     * @addtogroup Mapbuf
24891     * @{
24892     */
24893
24894    /**
24895     * Add a new mapbuf widget to the given parent Elementary
24896     * (container) object.
24897     *
24898     * @param parent The parent object.
24899     * @return A new mapbuf widget handle or @c NULL, on errors.
24900     *
24901     * This function inserts a new mapbuf widget on the canvas.
24902     *
24903     * @ingroup Mapbuf
24904     */
24905    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24906
24907    /**
24908     * Set the content of the mapbuf.
24909     *
24910     * @param obj The mapbuf object.
24911     * @param content The content that will be filled in this mapbuf object.
24912     *
24913     * Once the content object is set, a previously set one will be deleted.
24914     * If you want to keep that old content object, use the
24915     * elm_mapbuf_content_unset() function.
24916     *
24917     * To enable map, elm_mapbuf_enabled_set() should be used.
24918     *
24919     * @deprecated use elm_object_content_set() instead
24920     *
24921     * @ingroup Mapbuf
24922     */
24923    WILL_DEPRECATE  EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24924
24925    /**
24926     * Get the content of the mapbuf.
24927     *
24928     * @param obj The mapbuf object.
24929     * @return The content that is being used.
24930     *
24931     * Return the content object which is set for this widget.
24932     *
24933     * @see elm_mapbuf_content_set() for details.
24934     *
24935     * @deprecated use elm_object_content_get() instead
24936     *
24937     * @ingroup Mapbuf
24938     */
24939    WILL_DEPRECATE  EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24940
24941    /**
24942     * Unset the content of the mapbuf.
24943     *
24944     * @param obj The mapbuf object.
24945     * @return The content that was being used.
24946     *
24947     * Unparent and return the content object which was set for this widget.
24948     *
24949     * @see elm_mapbuf_content_set() for details.
24950     *
24951     * @deprecated use elm_object_content_unset() instead
24952     *
24953     * @ingroup Mapbuf
24954     */
24955    WILL_DEPRECATE  EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24956
24957    /**
24958     * Enable or disable the map.
24959     *
24960     * @param obj The mapbuf object.
24961     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24962     *
24963     * This enables the map that is set or disables it. On enable, the object
24964     * geometry will be saved, and the new geometry will change (position and
24965     * size) to reflect the map geometry set.
24966     *
24967     * Also, when enabled, alpha and smooth states will be used, so if the
24968     * content isn't solid, alpha should be enabled, for example, otherwise
24969     * a black retangle will fill the content.
24970     *
24971     * When disabled, the stored map will be freed and geometry prior to
24972     * enabling the map will be restored.
24973     *
24974     * It's disabled by default.
24975     *
24976     * @see elm_mapbuf_alpha_set()
24977     * @see elm_mapbuf_smooth_set()
24978     *
24979     * @ingroup Mapbuf
24980     */
24981    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24982
24983    /**
24984     * Get a value whether map is enabled or not.
24985     *
24986     * @param obj The mapbuf object.
24987     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24988     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24989     *
24990     * @see elm_mapbuf_enabled_set() for details.
24991     *
24992     * @ingroup Mapbuf
24993     */
24994    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24995
24996    /**
24997     * Enable or disable smooth map rendering.
24998     *
24999     * @param obj The mapbuf object.
25000     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25001     * to disable it.
25002     *
25003     * This sets smoothing for map rendering. If the object is a type that has
25004     * its own smoothing settings, then both the smooth settings for this object
25005     * and the map must be turned off.
25006     *
25007     * By default smooth maps are enabled.
25008     *
25009     * @ingroup Mapbuf
25010     */
25011    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25012
25013    /**
25014     * Get a value whether smooth map rendering is enabled or not.
25015     *
25016     * @param obj The mapbuf object.
25017     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25018     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25019     *
25020     * @see elm_mapbuf_smooth_set() for details.
25021     *
25022     * @ingroup Mapbuf
25023     */
25024    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25025
25026    /**
25027     * Set or unset alpha flag for map rendering.
25028     *
25029     * @param obj The mapbuf object.
25030     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25031     * to disable it.
25032     *
25033     * This sets alpha flag for map rendering. If the object is a type that has
25034     * its own alpha settings, then this will take precedence. Only image objects
25035     * have this currently. It stops alpha blending of the map area, and is
25036     * useful if you know the object and/or all sub-objects is 100% solid.
25037     *
25038     * Alpha is enabled by default.
25039     *
25040     * @ingroup Mapbuf
25041     */
25042    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25043
25044    /**
25045     * Get a value whether alpha blending is enabled or not.
25046     *
25047     * @param obj The mapbuf object.
25048     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25049     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25050     *
25051     * @see elm_mapbuf_alpha_set() for details.
25052     *
25053     * @ingroup Mapbuf
25054     */
25055    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25056
25057    /**
25058     * @}
25059     */
25060
25061    /**
25062     * @defgroup Flipselector Flip Selector
25063     *
25064     * @image html img/widget/flipselector/preview-00.png
25065     * @image latex img/widget/flipselector/preview-00.eps
25066     *
25067     * A flip selector is a widget to show a set of @b text items, one
25068     * at a time, with the same sheet switching style as the @ref Clock
25069     * "clock" widget, when one changes the current displaying sheet
25070     * (thus, the "flip" in the name).
25071     *
25072     * User clicks to flip sheets which are @b held for some time will
25073     * make the flip selector to flip continuosly and automatically for
25074     * the user. The interval between flips will keep growing in time,
25075     * so that it helps the user to reach an item which is distant from
25076     * the current selection.
25077     *
25078     * Smart callbacks one can register to:
25079     * - @c "selected" - when the widget's selected text item is changed
25080     * - @c "overflowed" - when the widget's current selection is changed
25081     *   from the first item in its list to the last
25082     * - @c "underflowed" - when the widget's current selection is changed
25083     *   from the last item in its list to the first
25084     *
25085     * Available styles for it:
25086     * - @c "default"
25087     *
25088          * To set/get the label of the flipselector item, you can use
25089          * elm_object_item_text_set/get APIs.
25090          * Once the text is set, a previously set one will be deleted.
25091          * 
25092     * Here is an example on its usage:
25093     * @li @ref flipselector_example
25094     */
25095
25096    /**
25097     * @addtogroup Flipselector
25098     * @{
25099     */
25100
25101    /**
25102     * Add a new flip selector widget to the given parent Elementary
25103     * (container) widget
25104     *
25105     * @param parent The parent object
25106     * @return a new flip selector widget handle or @c NULL, on errors
25107     *
25108     * This function inserts a new flip selector widget on the canvas.
25109     *
25110     * @ingroup Flipselector
25111     */
25112    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25113
25114    /**
25115     * Programmatically select the next item of a flip selector widget
25116     *
25117     * @param obj The flipselector object
25118     *
25119     * @note The selection will be animated. Also, if it reaches the
25120     * end of its list of member items, it will continue with the first
25121     * one onwards.
25122     *
25123     * @ingroup Flipselector
25124     */
25125    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25126
25127    /**
25128     * Programmatically select the previous item of a flip selector
25129     * widget
25130     *
25131     * @param obj The flipselector object
25132     *
25133     * @note The selection will be animated.  Also, if it reaches the
25134     * beginning of its list of member items, it will continue with the
25135     * last one backwards.
25136     *
25137     * @ingroup Flipselector
25138     */
25139    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25140
25141    /**
25142     * Append a (text) item to a flip selector widget
25143     *
25144     * @param obj The flipselector object
25145     * @param label The (text) label of the new item
25146     * @param func Convenience callback function to take place when
25147     * item is selected
25148     * @param data Data passed to @p func, above
25149     * @return A handle to the item added or @c NULL, on errors
25150     *
25151     * The widget's list of labels to show will be appended with the
25152     * given value. If the user wishes so, a callback function pointer
25153     * can be passed, which will get called when this same item is
25154     * selected.
25155     *
25156     * @note The current selection @b won't be modified by appending an
25157     * element to the list.
25158     *
25159     * @note The maximum length of the text label is going to be
25160     * determined <b>by the widget's theme</b>. Strings larger than
25161     * that value are going to be @b truncated.
25162     *
25163     * @ingroup Flipselector
25164     */
25165    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25166
25167    /**
25168     * Prepend a (text) item to a flip selector widget
25169     *
25170     * @param obj The flipselector object
25171     * @param label The (text) label of the new item
25172     * @param func Convenience callback function to take place when
25173     * item is selected
25174     * @param data Data passed to @p func, above
25175     * @return A handle to the item added or @c NULL, on errors
25176     *
25177     * The widget's list of labels to show will be prepended with the
25178     * given value. If the user wishes so, a callback function pointer
25179     * can be passed, which will get called when this same item is
25180     * selected.
25181     *
25182     * @note The current selection @b won't be modified by prepending
25183     * an element to the list.
25184     *
25185     * @note The maximum length of the text label is going to be
25186     * determined <b>by the widget's theme</b>. Strings larger than
25187     * that value are going to be @b truncated.
25188     *
25189     * @ingroup Flipselector
25190     */
25191    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25192
25193    /**
25194     * Get the internal list of items in a given flip selector widget.
25195     *
25196     * @param obj The flipselector object
25197     * @return The list of items (#Elm_Object_Item as data) or
25198     * @c NULL on errors.
25199     *
25200     * This list is @b not to be modified in any way and must not be
25201     * freed. Use the list members with functions like
25202     * elm_object_item_text_set(),
25203     * elm_object_item_text_get(),
25204     * elm_flipselector_item_del(),
25205     * elm_flipselector_item_selected_get(),
25206     * elm_flipselector_item_selected_set().
25207     *
25208     * @warning This list is only valid until @p obj object's internal
25209     * items list is changed. It should be fetched again with another
25210     * call to this function when changes happen.
25211     *
25212     * @ingroup Flipselector
25213     */
25214    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25215
25216    /**
25217     * Get the first item in the given flip selector widget's list of
25218     * items.
25219     *
25220     * @param obj The flipselector object
25221     * @return The first item or @c NULL, if it has no items (and on
25222     * errors)
25223     *
25224     * @see elm_flipselector_item_append()
25225     * @see elm_flipselector_last_item_get()
25226     *
25227     * @ingroup Flipselector
25228     */
25229    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25230
25231    /**
25232     * Get the last item in the given flip selector widget's list of
25233     * items.
25234     *
25235     * @param obj The flipselector object
25236     * @return The last item or @c NULL, if it has no items (and on
25237     * errors)
25238     *
25239     * @see elm_flipselector_item_prepend()
25240     * @see elm_flipselector_first_item_get()
25241     *
25242     * @ingroup Flipselector
25243     */
25244    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25245
25246    /**
25247     * Get the currently selected item in a flip selector widget.
25248     *
25249     * @param obj The flipselector object
25250     * @return The selected item or @c NULL, if the widget has no items
25251     * (and on erros)
25252     *
25253     * @ingroup Flipselector
25254     */
25255    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25256
25257    /**
25258     * Set whether a given flip selector widget's item should be the
25259     * currently selected one.
25260     *
25261     * @param it The flip selector item
25262     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25263     *
25264     * This sets whether @p item is or not the selected (thus, under
25265     * display) one. If @p item is different than one under display,
25266     * the latter will be unselected. If the @p item is set to be
25267     * unselected, on the other hand, the @b first item in the widget's
25268     * internal members list will be the new selected one.
25269     *
25270     * @see elm_flipselector_item_selected_get()
25271     *
25272     * @ingroup Flipselector
25273     */
25274    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25275
25276    /**
25277     * Get whether a given flip selector widget's item is the currently
25278     * selected one.
25279     *
25280     * @param it The flip selector item
25281     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25282     * (or on errors).
25283     *
25284     * @see elm_flipselector_item_selected_set()
25285     *
25286     * @ingroup Flipselector
25287     */
25288    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25289
25290    /**
25291     * Delete a given item from a flip selector widget.
25292     *
25293     * @param it The item to delete
25294     *
25295     * @ingroup Flipselector
25296     */
25297    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25298
25299    /**
25300     * Get the label of a given flip selector widget's item.
25301     *
25302     * @param it The item to get label from
25303     * @return The text label of @p item or @c NULL, on errors
25304     *
25305     * @see elm_object_item_text_set()
25306     *
25307     * @deprecated see elm_object_item_text_get() instead
25308     * @ingroup Flipselector
25309     */
25310    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25311
25312    /**
25313     * Set the label of a given flip selector widget's item.
25314     *
25315     * @param it The item to set label on
25316     * @param label The text label string, in UTF-8 encoding
25317     *
25318     * @see elm_object_item_text_get()
25319     *
25320          * @deprecated see elm_object_item_text_set() instead
25321     * @ingroup Flipselector
25322     */
25323    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25324
25325    /**
25326     * Gets the item before @p item in a flip selector widget's
25327     * internal list of items.
25328     *
25329     * @param it The item to fetch previous from
25330     * @return The item before the @p item, in its parent's list. If
25331     *         there is no previous item for @p item or there's an
25332     *         error, @c NULL is returned.
25333     *
25334     * @see elm_flipselector_item_next_get()
25335     *
25336     * @ingroup Flipselector
25337     */
25338    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25339
25340    /**
25341     * Gets the item after @p item in a flip selector widget's
25342     * internal list of items.
25343     *
25344     * @param it The item to fetch next from
25345     * @return The item after the @p item, in its parent's list. If
25346     *         there is no next item for @p item or there's an
25347     *         error, @c NULL is returned.
25348     *
25349     * @see elm_flipselector_item_next_get()
25350     *
25351     * @ingroup Flipselector
25352     */
25353    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25354
25355    /**
25356     * Set the interval on time updates for an user mouse button hold
25357     * on a flip selector widget.
25358     *
25359     * @param obj The flip selector object
25360     * @param interval The (first) interval value in seconds
25361     *
25362     * This interval value is @b decreased while the user holds the
25363     * mouse pointer either flipping up or flipping doww a given flip
25364     * selector.
25365     *
25366     * This helps the user to get to a given item distant from the
25367     * current one easier/faster, as it will start to flip quicker and
25368     * quicker on mouse button holds.
25369     *
25370     * The calculation for the next flip interval value, starting from
25371     * the one set with this call, is the previous interval divided by
25372     * 1.05, so it decreases a little bit.
25373     *
25374     * The default starting interval value for automatic flips is
25375     * @b 0.85 seconds.
25376     *
25377     * @see elm_flipselector_interval_get()
25378     *
25379     * @ingroup Flipselector
25380     */
25381    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25382
25383    /**
25384     * Get the interval on time updates for an user mouse button hold
25385     * on a flip selector widget.
25386     *
25387     * @param obj The flip selector object
25388     * @return The (first) interval value, in seconds, set on it
25389     *
25390     * @see elm_flipselector_interval_set() for more details
25391     *
25392     * @ingroup Flipselector
25393     */
25394    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25395    /**
25396     * @}
25397     */
25398
25399    /**
25400     * @addtogroup Calendar
25401     * @{
25402     */
25403
25404    /**
25405     * @enum _Elm_Calendar_Mark_Repeat
25406     * @typedef Elm_Calendar_Mark_Repeat
25407     *
25408     * Event periodicity, used to define if a mark should be repeated
25409     * @b beyond event's day. It's set when a mark is added.
25410     *
25411     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25412     * there will be marks every week after this date. Marks will be displayed
25413     * at 13th, 20th, 27th, 3rd June ...
25414     *
25415     * Values don't work as bitmask, only one can be choosen.
25416     *
25417     * @see elm_calendar_mark_add()
25418     *
25419     * @ingroup Calendar
25420     */
25421    typedef enum _Elm_Calendar_Mark_Repeat
25422      {
25423         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25424         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25425         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25426         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*/
25427         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. */
25428      } Elm_Calendar_Mark_Repeat;
25429
25430    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(). */
25431
25432    /**
25433     * Add a new calendar widget to the given parent Elementary
25434     * (container) object.
25435     *
25436     * @param parent The parent object.
25437     * @return a new calendar widget handle or @c NULL, on errors.
25438     *
25439     * This function inserts a new calendar widget on the canvas.
25440     *
25441     * @ref calendar_example_01
25442     *
25443     * @ingroup Calendar
25444     */
25445    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25446
25447    /**
25448     * Get weekdays names displayed by the calendar.
25449     *
25450     * @param obj The calendar object.
25451     * @return Array of seven strings to be used as weekday names.
25452     *
25453     * By default, weekdays abbreviations get from system are displayed:
25454     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25455     * The first string is related to Sunday, the second to Monday...
25456     *
25457     * @see elm_calendar_weekdays_name_set()
25458     *
25459     * @ref calendar_example_05
25460     *
25461     * @ingroup Calendar
25462     */
25463    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25464
25465    /**
25466     * Set weekdays names to be displayed by the calendar.
25467     *
25468     * @param obj The calendar object.
25469     * @param weekdays Array of seven strings to be used as weekday names.
25470     * @warning It must have 7 elements, or it will access invalid memory.
25471     * @warning The strings must be NULL terminated ('@\0').
25472     *
25473     * By default, weekdays abbreviations get from system are displayed:
25474     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25475     *
25476     * The first string should be related to Sunday, the second to Monday...
25477     *
25478     * The usage should be like this:
25479     * @code
25480     *   const char *weekdays[] =
25481     *   {
25482     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25483     *      "Thursday", "Friday", "Saturday"
25484     *   };
25485     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25486     * @endcode
25487     *
25488     * @see elm_calendar_weekdays_name_get()
25489     *
25490     * @ref calendar_example_02
25491     *
25492     * @ingroup Calendar
25493     */
25494    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25495
25496    /**
25497     * Set the minimum and maximum values for the year
25498     *
25499     * @param obj The calendar object
25500     * @param min The minimum year, greater than 1901;
25501     * @param max The maximum year;
25502     *
25503     * Maximum must be greater than minimum, except if you don't wan't to set
25504     * maximum year.
25505     * Default values are 1902 and -1.
25506     *
25507     * If the maximum year is a negative value, it will be limited depending
25508     * on the platform architecture (year 2037 for 32 bits);
25509     *
25510     * @see elm_calendar_min_max_year_get()
25511     *
25512     * @ref calendar_example_03
25513     *
25514     * @ingroup Calendar
25515     */
25516    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25517
25518    /**
25519     * Get the minimum and maximum values for the year
25520     *
25521     * @param obj The calendar object.
25522     * @param min The minimum year.
25523     * @param max The maximum year.
25524     *
25525     * Default values are 1902 and -1.
25526     *
25527     * @see elm_calendar_min_max_year_get() for more details.
25528     *
25529     * @ref calendar_example_05
25530     *
25531     * @ingroup Calendar
25532     */
25533    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25534
25535    /**
25536     * Enable or disable day selection
25537     *
25538     * @param obj The calendar object.
25539     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25540     * disable it.
25541     *
25542     * Enabled by default. If disabled, the user still can select months,
25543     * but not days. Selected days are highlighted on calendar.
25544     * It should be used if you won't need such selection for the widget usage.
25545     *
25546     * When a day is selected, or month is changed, smart callbacks for
25547     * signal "changed" will be called.
25548     *
25549     * @see elm_calendar_day_selection_enable_get()
25550     *
25551     * @ref calendar_example_04
25552     *
25553     * @ingroup Calendar
25554     */
25555    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25556
25557    /**
25558     * Get a value whether day selection is enabled or not.
25559     *
25560     * @see elm_calendar_day_selection_enable_set() for details.
25561     *
25562     * @param obj The calendar object.
25563     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25564     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25565     *
25566     * @ref calendar_example_05
25567     *
25568     * @ingroup Calendar
25569     */
25570    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25571
25572
25573    /**
25574     * Set selected date to be highlighted on calendar.
25575     *
25576     * @param obj The calendar object.
25577     * @param selected_time A @b tm struct to represent the selected date.
25578     *
25579     * Set the selected date, changing the displayed month if needed.
25580     * Selected date changes when the user goes to next/previous month or
25581     * select a day pressing over it on calendar.
25582     *
25583     * @see elm_calendar_selected_time_get()
25584     *
25585     * @ref calendar_example_04
25586     *
25587     * @ingroup Calendar
25588     */
25589    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25590
25591    /**
25592     * Get selected date.
25593     *
25594     * @param obj The calendar object
25595     * @param selected_time A @b tm struct to point to selected date
25596     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25597     * be considered.
25598     *
25599     * Get date selected by the user or set by function
25600     * elm_calendar_selected_time_set().
25601     * Selected date changes when the user goes to next/previous month or
25602     * select a day pressing over it on calendar.
25603     *
25604     * @see elm_calendar_selected_time_get()
25605     *
25606     * @ref calendar_example_05
25607     *
25608     * @ingroup Calendar
25609     */
25610    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25611
25612    /**
25613     * Set a function to format the string that will be used to display
25614     * month and year;
25615     *
25616     * @param obj The calendar object
25617     * @param format_function Function to set the month-year string given
25618     * the selected date
25619     *
25620     * By default it uses strftime with "%B %Y" format string.
25621     * It should allocate the memory that will be used by the string,
25622     * that will be freed by the widget after usage.
25623     * A pointer to the string and a pointer to the time struct will be provided.
25624     *
25625     * Example:
25626     * @code
25627     * static char *
25628     * _format_month_year(struct tm *selected_time)
25629     * {
25630     *    char buf[32];
25631     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25632     *    return strdup(buf);
25633     * }
25634     *
25635     * elm_calendar_format_function_set(calendar, _format_month_year);
25636     * @endcode
25637     *
25638     * @ref calendar_example_02
25639     *
25640     * @ingroup Calendar
25641     */
25642    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25643
25644    /**
25645     * Add a new mark to the calendar
25646     *
25647     * @param obj The calendar object
25648     * @param mark_type A string used to define the type of mark. It will be
25649     * emitted to the theme, that should display a related modification on these
25650     * days representation.
25651     * @param mark_time A time struct to represent the date of inclusion of the
25652     * mark. For marks that repeats it will just be displayed after the inclusion
25653     * date in the calendar.
25654     * @param repeat Repeat the event following this periodicity. Can be a unique
25655     * mark (that don't repeat), daily, weekly, monthly or annually.
25656     * @return The created mark or @p NULL upon failure.
25657     *
25658     * Add a mark that will be drawn in the calendar respecting the insertion
25659     * time and periodicity. It will emit the type as signal to the widget theme.
25660     * Default theme supports "holiday" and "checked", but it can be extended.
25661     *
25662     * It won't immediately update the calendar, drawing the marks.
25663     * For this, call elm_calendar_marks_draw(). However, when user selects
25664     * next or previous month calendar forces marks drawn.
25665     *
25666     * Marks created with this method can be deleted with
25667     * elm_calendar_mark_del().
25668     *
25669     * Example
25670     * @code
25671     * struct tm selected_time;
25672     * time_t current_time;
25673     *
25674     * current_time = time(NULL) + 5 * 84600;
25675     * localtime_r(&current_time, &selected_time);
25676     * elm_calendar_mark_add(cal, "holiday", selected_time,
25677     *     ELM_CALENDAR_ANNUALLY);
25678     *
25679     * current_time = time(NULL) + 1 * 84600;
25680     * localtime_r(&current_time, &selected_time);
25681     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25682     *
25683     * elm_calendar_marks_draw(cal);
25684     * @endcode
25685     *
25686     * @see elm_calendar_marks_draw()
25687     * @see elm_calendar_mark_del()
25688     *
25689     * @ref calendar_example_06
25690     *
25691     * @ingroup Calendar
25692     */
25693    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);
25694
25695    /**
25696     * Delete mark from the calendar.
25697     *
25698     * @param mark The mark to be deleted.
25699     *
25700     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25701     * should be used instead of getting marks list and deleting each one.
25702     *
25703     * @see elm_calendar_mark_add()
25704     *
25705     * @ref calendar_example_06
25706     *
25707     * @ingroup Calendar
25708     */
25709    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25710
25711    /**
25712     * Remove all calendar's marks
25713     *
25714     * @param obj The calendar object.
25715     *
25716     * @see elm_calendar_mark_add()
25717     * @see elm_calendar_mark_del()
25718     *
25719     * @ingroup Calendar
25720     */
25721    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25722
25723
25724    /**
25725     * Get a list of all the calendar marks.
25726     *
25727     * @param obj The calendar object.
25728     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25729     *
25730     * @see elm_calendar_mark_add()
25731     * @see elm_calendar_mark_del()
25732     * @see elm_calendar_marks_clear()
25733     *
25734     * @ingroup Calendar
25735     */
25736    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25737
25738    /**
25739     * Draw calendar marks.
25740     *
25741     * @param obj The calendar object.
25742     *
25743     * Should be used after adding, removing or clearing marks.
25744     * It will go through the entire marks list updating the calendar.
25745     * If lots of marks will be added, add all the marks and then call
25746     * this function.
25747     *
25748     * When the month is changed, i.e. user selects next or previous month,
25749     * marks will be drawed.
25750     *
25751     * @see elm_calendar_mark_add()
25752     * @see elm_calendar_mark_del()
25753     * @see elm_calendar_marks_clear()
25754     *
25755     * @ref calendar_example_06
25756     *
25757     * @ingroup Calendar
25758     */
25759    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25760
25761    /**
25762     * Set a day text color to the same that represents Saturdays.
25763     *
25764     * @param obj The calendar object.
25765     * @param pos The text position. Position is the cell counter, from left
25766     * to right, up to down. It starts on 0 and ends on 41.
25767     *
25768     * @deprecated use elm_calendar_mark_add() instead like:
25769     *
25770     * @code
25771     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25772     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25773     * @endcode
25774     *
25775     * @see elm_calendar_mark_add()
25776     *
25777     * @ingroup Calendar
25778     */
25779    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25780
25781    /**
25782     * Set a day text color to the same that represents Sundays.
25783     *
25784     * @param obj The calendar object.
25785     * @param pos The text position. Position is the cell counter, from left
25786     * to right, up to down. It starts on 0 and ends on 41.
25787
25788     * @deprecated use elm_calendar_mark_add() instead like:
25789     *
25790     * @code
25791     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25792     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25793     * @endcode
25794     *
25795     * @see elm_calendar_mark_add()
25796     *
25797     * @ingroup Calendar
25798     */
25799    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25800
25801    /**
25802     * Set a day text color to the same that represents Weekdays.
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, 1, 0, 0, 0, 0, -1 };
25812     *
25813     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25814     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25815     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25816     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25817     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25818     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25819     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25820     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25821     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25822     * @endcode
25823     *
25824     * @see elm_calendar_mark_add()
25825     *
25826     * @ingroup Calendar
25827     */
25828    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25829
25830    /**
25831     * Set the interval on time updates for an user mouse button hold
25832     * on calendar widgets' month selection.
25833     *
25834     * @param obj The calendar object
25835     * @param interval The (first) interval value in seconds
25836     *
25837     * This interval value is @b decreased while the user holds the
25838     * mouse pointer either selecting next or previous month.
25839     *
25840     * This helps the user to get to a given month distant from the
25841     * current one easier/faster, as it will start to change quicker and
25842     * quicker on mouse button holds.
25843     *
25844     * The calculation for the next change interval value, starting from
25845     * the one set with this call, is the previous interval divided by
25846     * 1.05, so it decreases a little bit.
25847     *
25848     * The default starting interval value for automatic changes is
25849     * @b 0.85 seconds.
25850     *
25851     * @see elm_calendar_interval_get()
25852     *
25853     * @ingroup Calendar
25854     */
25855    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25856
25857    /**
25858     * Get the interval on time updates for an user mouse button hold
25859     * on calendar widgets' month selection.
25860     *
25861     * @param obj The calendar object
25862     * @return The (first) interval value, in seconds, set on it
25863     *
25864     * @see elm_calendar_interval_set() for more details
25865     *
25866     * @ingroup Calendar
25867     */
25868    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25869
25870    /**
25871     * @}
25872     */
25873
25874    /**
25875     * @defgroup Diskselector Diskselector
25876     * @ingroup Elementary
25877     *
25878     * @image html img/widget/diskselector/preview-00.png
25879     * @image latex img/widget/diskselector/preview-00.eps
25880     *
25881     * A diskselector is a kind of list widget. It scrolls horizontally,
25882     * and can contain label and icon objects. Three items are displayed
25883     * with the selected one in the middle.
25884     *
25885     * It can act like a circular list with round mode and labels can be
25886     * reduced for a defined length for side items.
25887     *
25888     * Smart callbacks one can listen to:
25889     * - "selected" - when item is selected, i.e. scroller stops.
25890     *
25891     * Available styles for it:
25892     * - @c "default"
25893     *
25894     * List of examples:
25895     * @li @ref diskselector_example_01
25896     * @li @ref diskselector_example_02
25897     */
25898
25899    /**
25900     * @addtogroup Diskselector
25901     * @{
25902     */
25903
25904    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(). */
25905
25906    /**
25907     * Add a new diskselector widget to the given parent Elementary
25908     * (container) object.
25909     *
25910     * @param parent The parent object.
25911     * @return a new diskselector widget handle or @c NULL, on errors.
25912     *
25913     * This function inserts a new diskselector widget on the canvas.
25914     *
25915     * @ingroup Diskselector
25916     */
25917    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25918
25919    /**
25920     * Enable or disable round mode.
25921     *
25922     * @param obj The diskselector object.
25923     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25924     * disable it.
25925     *
25926     * Disabled by default. If round mode is enabled the items list will
25927     * work like a circle list, so when the user reaches the last item,
25928     * the first one will popup.
25929     *
25930     * @see elm_diskselector_round_get()
25931     *
25932     * @ingroup Diskselector
25933     */
25934    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25935
25936    /**
25937     * Get a value whether round mode is enabled or not.
25938     *
25939     * @see elm_diskselector_round_set() for details.
25940     *
25941     * @param obj The diskselector object.
25942     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25943     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25944     *
25945     * @ingroup Diskselector
25946     */
25947    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25948
25949    /**
25950     * Get the side labels max length.
25951     *
25952     * @deprecated use elm_diskselector_side_label_length_get() instead:
25953     *
25954     * @param obj The diskselector object.
25955     * @return The max length defined for side labels, or 0 if not a valid
25956     * diskselector.
25957     *
25958     * @ingroup Diskselector
25959     */
25960    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25961
25962    /**
25963     * Set the side labels max length.
25964     *
25965     * @deprecated use elm_diskselector_side_label_length_set() instead:
25966     *
25967     * @param obj The diskselector object.
25968     * @param len The max length defined for side labels.
25969     *
25970     * @ingroup Diskselector
25971     */
25972    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25973
25974    /**
25975     * Get the side labels max length.
25976     *
25977     * @see elm_diskselector_side_label_length_set() for details.
25978     *
25979     * @param obj The diskselector object.
25980     * @return The max length defined for side labels, or 0 if not a valid
25981     * diskselector.
25982     *
25983     * @ingroup Diskselector
25984     */
25985    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25986
25987    /**
25988     * Set the side labels max length.
25989     *
25990     * @param obj The diskselector object.
25991     * @param len The max length defined for side labels.
25992     *
25993     * Length is the number of characters of items' label that will be
25994     * visible when it's set on side positions. It will just crop
25995     * the string after defined size. E.g.:
25996     *
25997     * An item with label "January" would be displayed on side position as
25998     * "Jan" if max length is set to 3, or "Janu", if this property
25999     * is set to 4.
26000     *
26001     * When it's selected, the entire label will be displayed, except for
26002     * width restrictions. In this case label will be cropped and "..."
26003     * will be concatenated.
26004     *
26005     * Default side label max length is 3.
26006     *
26007     * This property will be applyed over all items, included before or
26008     * later this function call.
26009     *
26010     * @ingroup Diskselector
26011     */
26012    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26013
26014    /**
26015     * Set the number of items to be displayed.
26016     *
26017     * @param obj The diskselector object.
26018     * @param num The number of items the diskselector will display.
26019     *
26020     * Default value is 3, and also it's the minimun. If @p num is less
26021     * than 3, it will be set to 3.
26022     *
26023     * Also, it can be set on theme, using data item @c display_item_num
26024     * on group "elm/diskselector/item/X", where X is style set.
26025     * E.g.:
26026     *
26027     * group { name: "elm/diskselector/item/X";
26028     * data {
26029     *     item: "display_item_num" "5";
26030     *     }
26031     *
26032     * @ingroup Diskselector
26033     */
26034    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26035
26036    /**
26037     * Get the number of items in the diskselector object.
26038     *
26039     * @param obj The diskselector object.
26040     *
26041     * @ingroup Diskselector
26042     */
26043    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26044
26045    /**
26046     * Set bouncing behaviour when the scrolled content reaches an edge.
26047     *
26048     * Tell the internal scroller object whether it should bounce or not
26049     * when it reaches the respective edges for each axis.
26050     *
26051     * @param obj The diskselector object.
26052     * @param h_bounce Whether to bounce or not in the horizontal axis.
26053     * @param v_bounce Whether to bounce or not in the vertical axis.
26054     *
26055     * @see elm_scroller_bounce_set()
26056     *
26057     * @ingroup Diskselector
26058     */
26059    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26060
26061    /**
26062     * Get the bouncing behaviour of the internal scroller.
26063     *
26064     * Get whether the internal scroller should bounce when the edge of each
26065     * axis is reached scrolling.
26066     *
26067     * @param obj The diskselector object.
26068     * @param h_bounce Pointer where to store the bounce state of the horizontal
26069     * axis.
26070     * @param v_bounce Pointer where to store the bounce state of the vertical
26071     * axis.
26072     *
26073     * @see elm_scroller_bounce_get()
26074     * @see elm_diskselector_bounce_set()
26075     *
26076     * @ingroup Diskselector
26077     */
26078    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26079
26080    /**
26081     * Get the scrollbar policy.
26082     *
26083     * @see elm_diskselector_scroller_policy_get() for details.
26084     *
26085     * @param obj The diskselector object.
26086     * @param policy_h Pointer where to store horizontal scrollbar policy.
26087     * @param policy_v Pointer where to store vertical scrollbar policy.
26088     *
26089     * @ingroup Diskselector
26090     */
26091    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);
26092
26093    /**
26094     * Set the scrollbar policy.
26095     *
26096     * @param obj The diskselector object.
26097     * @param policy_h Horizontal scrollbar policy.
26098     * @param policy_v Vertical scrollbar policy.
26099     *
26100     * This sets the scrollbar visibility policy for the given scroller.
26101     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26102     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26103     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26104     * This applies respectively for the horizontal and vertical scrollbars.
26105     *
26106     * The both are disabled by default, i.e., are set to
26107     * #ELM_SCROLLER_POLICY_OFF.
26108     *
26109     * @ingroup Diskselector
26110     */
26111    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26112
26113    /**
26114     * Remove all diskselector's items.
26115     *
26116     * @param obj The diskselector object.
26117     *
26118     * @see elm_diskselector_item_del()
26119     * @see elm_diskselector_item_append()
26120     *
26121     * @ingroup Diskselector
26122     */
26123    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26124
26125    /**
26126     * Get a list of all the diskselector items.
26127     *
26128     * @param obj The diskselector object.
26129     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26130     * or @c NULL on failure.
26131     *
26132     * @see elm_diskselector_item_append()
26133     * @see elm_diskselector_item_del()
26134     * @see elm_diskselector_clear()
26135     *
26136     * @ingroup Diskselector
26137     */
26138    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26139
26140    /**
26141     * Appends a new item to the diskselector object.
26142     *
26143     * @param obj The diskselector object.
26144     * @param label The label of the diskselector item.
26145     * @param icon The icon object to use at left side of the item. An
26146     * icon can be any Evas object, but usually it is an icon created
26147     * with elm_icon_add().
26148     * @param func The function to call when the item is selected.
26149     * @param data The data to associate with the item for related callbacks.
26150     *
26151     * @return The created item or @c NULL upon failure.
26152     *
26153     * A new item will be created and appended to the diskselector, i.e., will
26154     * be set as last item. Also, if there is no selected item, it will
26155     * be selected. This will always happens for the first appended item.
26156     *
26157     * If no icon is set, label will be centered on item position, otherwise
26158     * the icon will be placed at left of the label, that will be shifted
26159     * to the right.
26160     *
26161     * Items created with this method can be deleted with
26162     * elm_diskselector_item_del().
26163     *
26164     * Associated @p data can be properly freed when item is deleted if a
26165     * callback function is set with elm_diskselector_item_del_cb_set().
26166     *
26167     * If a function is passed as argument, it will be called everytime this item
26168     * is selected, i.e., the user stops the diskselector with this
26169     * item on center position. If such function isn't needed, just passing
26170     * @c NULL as @p func is enough. The same should be done for @p data.
26171     *
26172     * Simple example (with no function callback or data associated):
26173     * @code
26174     * disk = elm_diskselector_add(win);
26175     * ic = elm_icon_add(win);
26176     * elm_icon_file_set(ic, "path/to/image", NULL);
26177     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26178     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26179     * @endcode
26180     *
26181     * @see elm_diskselector_item_del()
26182     * @see elm_diskselector_item_del_cb_set()
26183     * @see elm_diskselector_clear()
26184     * @see elm_icon_add()
26185     *
26186     * @ingroup Diskselector
26187     */
26188    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);
26189
26190
26191    /**
26192     * Delete them item from the diskselector.
26193     *
26194     * @param it The item of diskselector to be deleted.
26195     *
26196     * If deleting all diskselector items is required, elm_diskselector_clear()
26197     * should be used instead of getting items list and deleting each one.
26198     *
26199     * @see elm_diskselector_clear()
26200     * @see elm_diskselector_item_append()
26201     * @see elm_diskselector_item_del_cb_set()
26202     *
26203     * @ingroup Diskselector
26204     */
26205    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26206
26207    /**
26208     * Set the function called when a diskselector item is freed.
26209     *
26210     * @param it The item to set the callback on
26211     * @param func The function called
26212     *
26213     * If there is a @p func, then it will be called prior item's memory release.
26214     * That will be called with the following arguments:
26215     * @li item's data;
26216     * @li item's Evas object;
26217     * @li item itself;
26218     *
26219     * This way, a data associated to a diskselector item could be properly
26220     * freed.
26221     *
26222     * @ingroup Diskselector
26223     */
26224    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26225
26226    /**
26227     * Get the data associated to the item.
26228     *
26229     * @param it The diskselector item
26230     * @return The data associated to @p it
26231     *
26232     * The return value is a pointer to data associated to @p item when it was
26233     * created, with function elm_diskselector_item_append(). If no data
26234     * was passed as argument, it will return @c NULL.
26235     *
26236     * @see elm_diskselector_item_append()
26237     *
26238     * @ingroup Diskselector
26239     */
26240    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26241
26242    /**
26243     * Set the icon associated to the item.
26244     *
26245     * @param it The diskselector item
26246     * @param icon The icon object to associate with @p it
26247     *
26248     * The icon object to use at left side of the item. An
26249     * icon can be any Evas object, but usually it is an icon created
26250     * with elm_icon_add().
26251     *
26252     * Once the icon object is set, a previously set one will be deleted.
26253     * @warning Setting the same icon for two items will cause the icon to
26254     * dissapear from the first item.
26255     *
26256     * If an icon was passed as argument on item creation, with function
26257     * elm_diskselector_item_append(), it will be already
26258     * associated to the item.
26259     *
26260     * @see elm_diskselector_item_append()
26261     * @see elm_diskselector_item_icon_get()
26262     *
26263     * @ingroup Diskselector
26264     */
26265    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26266
26267    /**
26268     * Get the icon associated to the item.
26269     *
26270     * @param it The diskselector item
26271     * @return The icon associated to @p it
26272     *
26273     * The return value is a pointer to the icon associated to @p item when it was
26274     * created, with function elm_diskselector_item_append(), or later
26275     * with function elm_diskselector_item_icon_set. If no icon
26276     * was passed as argument, it will return @c NULL.
26277     *
26278     * @see elm_diskselector_item_append()
26279     * @see elm_diskselector_item_icon_set()
26280     *
26281     * @ingroup Diskselector
26282     */
26283    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26284
26285    /**
26286     * Set the label of item.
26287     *
26288     * @param it The item of diskselector.
26289     * @param label The label of item.
26290     *
26291     * The label to be displayed by the item.
26292     *
26293     * If no icon is set, label will be centered on item position, otherwise
26294     * the icon will be placed at left of the label, that will be shifted
26295     * to the right.
26296     *
26297     * An item with label "January" would be displayed on side position as
26298     * "Jan" if max length is set to 3 with function
26299     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26300     * is set to 4.
26301     *
26302     * When this @p item is selected, the entire label will be displayed,
26303     * except for width restrictions.
26304     * In this case label will be cropped and "..." will be concatenated,
26305     * but only for display purposes. It will keep the entire string, so
26306     * if diskselector is resized the remaining characters will be displayed.
26307     *
26308     * If a label was passed as argument on item creation, with function
26309     * elm_diskselector_item_append(), it will be already
26310     * displayed by the item.
26311     *
26312     * @see elm_diskselector_side_label_lenght_set()
26313     * @see elm_diskselector_item_label_get()
26314     * @see elm_diskselector_item_append()
26315     *
26316     * @ingroup Diskselector
26317     */
26318    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26319
26320    /**
26321     * Get the label of item.
26322     *
26323     * @param it The item of diskselector.
26324     * @return The label of item.
26325     *
26326     * The return value is a pointer to the label associated to @p item when it was
26327     * created, with function elm_diskselector_item_append(), or later
26328     * with function elm_diskselector_item_label_set. If no label
26329     * was passed as argument, it will return @c NULL.
26330     *
26331     * @see elm_diskselector_item_label_set() for more details.
26332     * @see elm_diskselector_item_append()
26333     *
26334     * @ingroup Diskselector
26335     */
26336    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26337
26338    /**
26339     * Get the selected item.
26340     *
26341     * @param obj The diskselector object.
26342     * @return The selected diskselector item.
26343     *
26344     * The selected item can be unselected with function
26345     * elm_diskselector_item_selected_set(), and the first item of
26346     * diskselector will be selected.
26347     *
26348     * The selected item always will be centered on diskselector, with
26349     * full label displayed, i.e., max lenght set to side labels won't
26350     * apply on the selected item. More details on
26351     * elm_diskselector_side_label_length_set().
26352     *
26353     * @ingroup Diskselector
26354     */
26355    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26356
26357    /**
26358     * Set the selected state of an item.
26359     *
26360     * @param it The diskselector item
26361     * @param selected The selected state
26362     *
26363     * This sets the selected state of the given item @p it.
26364     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26365     *
26366     * If a new item is selected the previosly selected will be unselected.
26367     * Previoulsy selected item can be get with function
26368     * elm_diskselector_selected_item_get().
26369     *
26370     * If the item @p it is unselected, the first item of diskselector will
26371     * be selected.
26372     *
26373     * Selected items will be visible on center position of diskselector.
26374     * So if it was on another position before selected, or was invisible,
26375     * diskselector will animate items until the selected item reaches center
26376     * position.
26377     *
26378     * @see elm_diskselector_item_selected_get()
26379     * @see elm_diskselector_selected_item_get()
26380     *
26381     * @ingroup Diskselector
26382     */
26383    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26384
26385    /*
26386     * Get whether the @p item is selected or not.
26387     *
26388     * @param it The diskselector item.
26389     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26390     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26391     *
26392     * @see elm_diskselector_selected_item_set() for details.
26393     * @see elm_diskselector_item_selected_get()
26394     *
26395     * @ingroup Diskselector
26396     */
26397    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26398
26399    /**
26400     * Get the first item of the diskselector.
26401     *
26402     * @param obj The diskselector object.
26403     * @return The first item, or @c NULL if none.
26404     *
26405     * The list of items follows append order. So it will return the first
26406     * item appended to the widget that wasn't deleted.
26407     *
26408     * @see elm_diskselector_item_append()
26409     * @see elm_diskselector_items_get()
26410     *
26411     * @ingroup Diskselector
26412     */
26413    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26414
26415    /**
26416     * Get the last item of the diskselector.
26417     *
26418     * @param obj The diskselector object.
26419     * @return The last item, or @c NULL if none.
26420     *
26421     * The list of items follows append order. So it will return last first
26422     * item appended to the widget that wasn't deleted.
26423     *
26424     * @see elm_diskselector_item_append()
26425     * @see elm_diskselector_items_get()
26426     *
26427     * @ingroup Diskselector
26428     */
26429    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26430
26431    /**
26432     * Get the item before @p item in diskselector.
26433     *
26434     * @param it The diskselector item.
26435     * @return The item before @p item, or @c NULL if none or on failure.
26436     *
26437     * The list of items follows append order. So it will return item appended
26438     * just before @p item and that wasn't deleted.
26439     *
26440     * If it is the first item, @c NULL will be returned.
26441     * First item can be get by elm_diskselector_first_item_get().
26442     *
26443     * @see elm_diskselector_item_append()
26444     * @see elm_diskselector_items_get()
26445     *
26446     * @ingroup Diskselector
26447     */
26448    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26449
26450    /**
26451     * Get the item after @p item in diskselector.
26452     *
26453     * @param it The diskselector item.
26454     * @return The item after @p item, or @c NULL if none or on failure.
26455     *
26456     * The list of items follows append order. So it will return item appended
26457     * just after @p item and that wasn't deleted.
26458     *
26459     * If it is the last item, @c NULL will be returned.
26460     * Last item can be get by elm_diskselector_last_item_get().
26461     *
26462     * @see elm_diskselector_item_append()
26463     * @see elm_diskselector_items_get()
26464     *
26465     * @ingroup Diskselector
26466     */
26467    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26468
26469    /**
26470     * Set the text to be shown in the diskselector item.
26471     *
26472     * @param item Target item
26473     * @param text The text to set in the content
26474     *
26475     * Setup the text as tooltip to object. The item can have only one tooltip,
26476     * so any previous tooltip data is removed.
26477     *
26478     * @see elm_object_tooltip_text_set() for more details.
26479     *
26480     * @ingroup Diskselector
26481     */
26482    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26483
26484    /**
26485     * Set the content to be shown in the tooltip item.
26486     *
26487     * Setup the tooltip to item. The item can have only one tooltip,
26488     * so any previous tooltip data is removed. @p func(with @p data) will
26489     * be called every time that need show the tooltip and it should
26490     * return a valid Evas_Object. This object is then managed fully by
26491     * tooltip system and is deleted when the tooltip is gone.
26492     *
26493     * @param item the diskselector item being attached a tooltip.
26494     * @param func the function used to create the tooltip contents.
26495     * @param data what to provide to @a func as callback data/context.
26496     * @param del_cb called when data is not needed anymore, either when
26497     *        another callback replaces @p func, the tooltip is unset with
26498     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26499     *        dies. This callback receives as the first parameter the
26500     *        given @a data, and @c event_info is the item.
26501     *
26502     * @see elm_object_tooltip_content_cb_set() for more details.
26503     *
26504     * @ingroup Diskselector
26505     */
26506    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);
26507
26508    /**
26509     * Unset tooltip from item.
26510     *
26511     * @param item diskselector item to remove previously set tooltip.
26512     *
26513     * Remove tooltip from item. The callback provided as del_cb to
26514     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26515     * it is not used anymore.
26516     *
26517     * @see elm_object_tooltip_unset() for more details.
26518     * @see elm_diskselector_item_tooltip_content_cb_set()
26519     *
26520     * @ingroup Diskselector
26521     */
26522    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26523
26524
26525    /**
26526     * Sets a different style for this item tooltip.
26527     *
26528     * @note before you set a style you should define a tooltip with
26529     *       elm_diskselector_item_tooltip_content_cb_set() or
26530     *       elm_diskselector_item_tooltip_text_set()
26531     *
26532     * @param item diskselector item with tooltip already set.
26533     * @param style the theme style to use (default, transparent, ...)
26534     *
26535     * @see elm_object_tooltip_style_set() for more details.
26536     *
26537     * @ingroup Diskselector
26538     */
26539    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26540
26541    /**
26542     * Get the style for this item tooltip.
26543     *
26544     * @param item diskselector item with tooltip already set.
26545     * @return style the theme style in use, defaults to "default". If the
26546     *         object does not have a tooltip set, then NULL is returned.
26547     *
26548     * @see elm_object_tooltip_style_get() for more details.
26549     * @see elm_diskselector_item_tooltip_style_set()
26550     *
26551     * @ingroup Diskselector
26552     */
26553    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26554
26555    /**
26556     * Set the cursor to be shown when mouse is over the diskselector item
26557     *
26558     * @param item Target item
26559     * @param cursor the cursor name to be used.
26560     *
26561     * @see elm_object_cursor_set() for more details.
26562     *
26563     * @ingroup Diskselector
26564     */
26565    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26566
26567    /**
26568     * Get the cursor to be shown when mouse is over the diskselector item
26569     *
26570     * @param item diskselector item with cursor already set.
26571     * @return the cursor name.
26572     *
26573     * @see elm_object_cursor_get() for more details.
26574     * @see elm_diskselector_cursor_set()
26575     *
26576     * @ingroup Diskselector
26577     */
26578    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26579
26580
26581    /**
26582     * Unset the cursor to be shown when mouse is over the diskselector item
26583     *
26584     * @param item Target item
26585     *
26586     * @see elm_object_cursor_unset() for more details.
26587     * @see elm_diskselector_cursor_set()
26588     *
26589     * @ingroup Diskselector
26590     */
26591    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26592
26593    /**
26594     * Sets a different style for this item cursor.
26595     *
26596     * @note before you set a style you should define a cursor with
26597     *       elm_diskselector_item_cursor_set()
26598     *
26599     * @param item diskselector item with cursor already set.
26600     * @param style the theme style to use (default, transparent, ...)
26601     *
26602     * @see elm_object_cursor_style_set() for more details.
26603     *
26604     * @ingroup Diskselector
26605     */
26606    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26607
26608
26609    /**
26610     * Get the style for this item cursor.
26611     *
26612     * @param item diskselector item with cursor already set.
26613     * @return style the theme style in use, defaults to "default". If the
26614     *         object does not have a cursor set, then @c NULL is returned.
26615     *
26616     * @see elm_object_cursor_style_get() for more details.
26617     * @see elm_diskselector_item_cursor_style_set()
26618     *
26619     * @ingroup Diskselector
26620     */
26621    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26622
26623
26624    /**
26625     * Set if the cursor set should be searched on the theme or should use
26626     * the provided by the engine, only.
26627     *
26628     * @note before you set if should look on theme you should define a cursor
26629     * with elm_diskselector_item_cursor_set().
26630     * By default it will only look for cursors provided by the engine.
26631     *
26632     * @param item widget item with cursor already set.
26633     * @param engine_only boolean to define if cursors set with
26634     * elm_diskselector_item_cursor_set() should be searched only
26635     * between cursors provided by the engine or searched on widget's
26636     * theme as well.
26637     *
26638     * @see elm_object_cursor_engine_only_set() for more details.
26639     *
26640     * @ingroup Diskselector
26641     */
26642    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26643
26644    /**
26645     * Get the cursor engine only usage for this item cursor.
26646     *
26647     * @param item widget item with cursor already set.
26648     * @return engine_only boolean to define it cursors should be looked only
26649     * between the provided by the engine or searched on widget's theme as well.
26650     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26651     *
26652     * @see elm_object_cursor_engine_only_get() for more details.
26653     * @see elm_diskselector_item_cursor_engine_only_set()
26654     *
26655     * @ingroup Diskselector
26656     */
26657    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26658
26659    /**
26660     * @}
26661     */
26662
26663    /**
26664     * @defgroup Colorselector Colorselector
26665     *
26666     * @{
26667     *
26668     * @image html img/widget/colorselector/preview-00.png
26669     * @image latex img/widget/colorselector/preview-00.eps
26670     *
26671     * @brief Widget for user to select a color.
26672     *
26673     * Signals that you can add callbacks for are:
26674     * "changed" - When the color value changes(event_info is NULL).
26675     *
26676     * See @ref tutorial_colorselector.
26677     */
26678    /**
26679     * @brief Add a new colorselector to the parent
26680     *
26681     * @param parent The parent object
26682     * @return The new object or NULL if it cannot be created
26683     *
26684     * @ingroup Colorselector
26685     */
26686    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26687    /**
26688     * Set a color for the colorselector
26689     *
26690     * @param obj   Colorselector object
26691     * @param r     r-value of color
26692     * @param g     g-value of color
26693     * @param b     b-value of color
26694     * @param a     a-value of color
26695     *
26696     * @ingroup Colorselector
26697     */
26698    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26699    /**
26700     * Get a color from the colorselector
26701     *
26702     * @param obj   Colorselector object
26703     * @param r     integer pointer for r-value of color
26704     * @param g     integer pointer for g-value of color
26705     * @param b     integer pointer for b-value of color
26706     * @param a     integer pointer for a-value of color
26707     *
26708     * @ingroup Colorselector
26709     */
26710    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26711    /**
26712     * @}
26713     */
26714
26715    /**
26716     * @defgroup Ctxpopup Ctxpopup
26717     *
26718     * @image html img/widget/ctxpopup/preview-00.png
26719     * @image latex img/widget/ctxpopup/preview-00.eps
26720     *
26721     * @brief Context popup widet.
26722     *
26723     * A ctxpopup is a widget that, when shown, pops up a list of items.
26724     * It automatically chooses an area inside its parent object's view
26725     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26726     * optimally fit into it. In the default theme, it will also point an
26727     * arrow to it's top left position at the time one shows it. Ctxpopup
26728     * items have a label and/or an icon. It is intended for a small
26729     * number of items (hence the use of list, not genlist).
26730     *
26731     * @note Ctxpopup is a especialization of @ref Hover.
26732     *
26733     * Signals that you can add callbacks for are:
26734     * "dismissed" - the ctxpopup was dismissed
26735     *
26736     * Default contents parts of the ctxpopup widget that you can use for are:
26737     * @li "default" - A content of the ctxpopup
26738     *
26739     * Default contents parts of the naviframe items that you can use for are:
26740     * @li "icon" - A icon in the title area
26741     * 
26742     * Default text parts of the naviframe items that you can use for are:
26743     * @li "default" - Title label in the title area
26744     *
26745     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26746     * @{
26747     */
26748    typedef enum _Elm_Ctxpopup_Direction
26749      {
26750         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26751                                           area */
26752         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26753                                            the clicked area */
26754         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26755                                           the clicked area */
26756         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26757                                         area */
26758         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26759      } Elm_Ctxpopup_Direction;
26760 #define Elm_Ctxpopup_Item Elm_Object_Item
26761
26762    /**
26763     * @brief Add a new Ctxpopup object to the parent.
26764     *
26765     * @param parent Parent object
26766     * @return New object or @c NULL, if it cannot be created
26767     */
26768    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26769    /**
26770     * @brief Set the Ctxpopup's parent
26771     *
26772     * @param obj The ctxpopup object
26773     * @param area The parent to use
26774     *
26775     * Set the parent object.
26776     *
26777     * @note elm_ctxpopup_add() will automatically call this function
26778     * with its @c parent argument.
26779     *
26780     * @see elm_ctxpopup_add()
26781     * @see elm_hover_parent_set()
26782     */
26783    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26784    /**
26785     * @brief Get the Ctxpopup's parent
26786     *
26787     * @param obj The ctxpopup object
26788     *
26789     * @see elm_ctxpopup_hover_parent_set() for more information
26790     */
26791    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26792    /**
26793     * @brief Clear all items in the given ctxpopup object.
26794     *
26795     * @param obj Ctxpopup object
26796     */
26797    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26798    /**
26799     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26800     *
26801     * @param obj Ctxpopup object
26802     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26803     */
26804    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26805    /**
26806     * @brief Get the value of current ctxpopup object's orientation.
26807     *
26808     * @param obj Ctxpopup object
26809     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26810     *
26811     * @see elm_ctxpopup_horizontal_set()
26812     */
26813    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26814    /**
26815     * @brief Add a new item to a ctxpopup object.
26816     *
26817     * @param obj Ctxpopup object
26818     * @param icon Icon to be set on new item
26819     * @param label The Label of the new item
26820     * @param func Convenience function called when item selected
26821     * @param data Data passed to @p func
26822     * @return A handle to the item added or @c NULL, on errors
26823     *
26824     * @warning Ctxpopup can't hold both an item list and a content at the same
26825     * time. When an item is added, any previous content will be removed.
26826     *
26827     * @see elm_ctxpopup_content_set()
26828     */
26829    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);
26830    /**
26831     * @brief Delete the given item in a ctxpopup object.
26832     *
26833     * @param it Ctxpopup item to be deleted
26834     *
26835     * @see elm_ctxpopup_item_append()
26836     */
26837    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26838    /**
26839     * @brief Set the ctxpopup item's state as disabled or enabled.
26840     *
26841     * @param it Ctxpopup item to be enabled/disabled
26842     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26843     *
26844     * When disabled the item is greyed out to indicate it's state.
26845     * @deprecated use elm_object_item_disabled_set() instead
26846     */
26847    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26848    /**
26849     * @brief Get the ctxpopup item's disabled/enabled state.
26850     *
26851     * @param it Ctxpopup item to be enabled/disabled
26852     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26853     *
26854     * @see elm_ctxpopup_item_disabled_set()
26855     * @deprecated use elm_object_item_disabled_get() instead
26856     */
26857    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26858    /**
26859     * @brief Get the icon object for the given ctxpopup item.
26860     *
26861     * @param it Ctxpopup item
26862     * @return icon object or @c NULL, if the item does not have icon or an error
26863     * occurred
26864     *
26865     * @see elm_ctxpopup_item_append()
26866     * @see elm_ctxpopup_item_icon_set()
26867     *
26868     * @deprecated use elm_object_item_part_content_get() instead
26869     */
26870    WILL_DEPRECATE  EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26871    /**
26872     * @brief Sets the side icon associated with the ctxpopup item
26873     *
26874     * @param it Ctxpopup item
26875     * @param icon Icon object to be set
26876     *
26877     * Once the icon object is set, a previously set one will be deleted.
26878     * @warning Setting the same icon for two items will cause the icon to
26879     * dissapear from the first item.
26880     *
26881     * @see elm_ctxpopup_item_append()
26882     *  
26883     * @deprecated use elm_object_item_part_content_set() instead
26884     *
26885     */
26886    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26887    /**
26888     * @brief Get the label for the given ctxpopup item.
26889     *
26890     * @param it Ctxpopup item
26891     * @return label string or @c NULL, if the item does not have label or an
26892     * error occured
26893     *
26894     * @see elm_ctxpopup_item_append()
26895     * @see elm_ctxpopup_item_label_set()
26896     *
26897     * @deprecated use elm_object_item_text_get() instead
26898     */
26899    WILL_DEPRECATE  EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26900    /**
26901     * @brief (Re)set the label on the given ctxpopup item.
26902     *
26903     * @param it Ctxpopup item
26904     * @param label String to set as label
26905     *
26906     * @deprecated use elm_object_item_text_set() instead
26907     */
26908    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26909    /**
26910     * @brief Set an elm widget as the content of the ctxpopup.
26911     *
26912     * @param obj Ctxpopup object
26913     * @param content Content to be swallowed
26914     *
26915     * If the content object is already set, a previous one will bedeleted. If
26916     * you want to keep that old content object, use the
26917     * elm_ctxpopup_content_unset() function.
26918     *
26919     * @warning Ctxpopup can't hold both a item list and a content at the same
26920     * time. When a content is set, any previous items will be removed.
26921     * 
26922     * @deprecated use elm_object_content_set() instead
26923     *
26924     */
26925    WILL_DEPRECATE  EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26926    /**
26927     * @brief Unset the ctxpopup content
26928     *
26929     * @param obj Ctxpopup object
26930     * @return The content that was being used
26931     *
26932     * Unparent and return the content object which was set for this widget.
26933     *
26934     * @deprecated use elm_object_content_unset()
26935     *
26936     * @see elm_ctxpopup_content_set()
26937     *
26938     * @deprecated use elm_object_content_unset() instead
26939     *
26940     */
26941    WILL_DEPRECATE  EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26942    /**
26943     * @brief Set the direction priority of a ctxpopup.
26944     *
26945     * @param obj Ctxpopup object
26946     * @param first 1st priority of direction
26947     * @param second 2nd priority of direction
26948     * @param third 3th priority of direction
26949     * @param fourth 4th priority of direction
26950     *
26951     * This functions gives a chance to user to set the priority of ctxpopup
26952     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26953     * requested direction.
26954     *
26955     * @see Elm_Ctxpopup_Direction
26956     */
26957    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);
26958    /**
26959     * @brief Get the direction priority of a ctxpopup.
26960     *
26961     * @param obj Ctxpopup object
26962     * @param first 1st priority of direction to be returned
26963     * @param second 2nd priority of direction to be returned
26964     * @param third 3th priority of direction to be returned
26965     * @param fourth 4th priority of direction to be returned
26966     *
26967     * @see elm_ctxpopup_direction_priority_set() for more information.
26968     */
26969    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);
26970
26971    /**
26972     * @brief Get the current direction of a ctxpopup.
26973     *
26974     * @param obj Ctxpopup object
26975     * @return current direction of a ctxpopup
26976     *
26977     * @warning Once the ctxpopup showed up, the direction would be determined
26978     */
26979    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26980
26981    /**
26982     * @}
26983     */
26984
26985    /* transit */
26986    /**
26987     *
26988     * @defgroup Transit Transit
26989     * @ingroup Elementary
26990     *
26991     * Transit is designed to apply various animated transition effects to @c
26992     * Evas_Object, such like translation, rotation, etc. For using these
26993     * effects, create an @ref Elm_Transit and add the desired transition effects.
26994     *
26995     * Once the effects are added into transit, they will be automatically
26996     * managed (their callback will be called until the duration is ended, and
26997     * they will be deleted on completion).
26998     *
26999     * Example:
27000     * @code
27001     * Elm_Transit *trans = elm_transit_add();
27002     * elm_transit_object_add(trans, obj);
27003     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27004     * elm_transit_duration_set(transit, 1);
27005     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27006     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27007     * elm_transit_repeat_times_set(transit, 3);
27008     * @endcode
27009     *
27010     * Some transition effects are used to change the properties of objects. They
27011     * are:
27012     * @li @ref elm_transit_effect_translation_add
27013     * @li @ref elm_transit_effect_color_add
27014     * @li @ref elm_transit_effect_rotation_add
27015     * @li @ref elm_transit_effect_wipe_add
27016     * @li @ref elm_transit_effect_zoom_add
27017     * @li @ref elm_transit_effect_resizing_add
27018     *
27019     * Other transition effects are used to make one object disappear and another
27020     * object appear on its old place. These effects are:
27021     *
27022     * @li @ref elm_transit_effect_flip_add
27023     * @li @ref elm_transit_effect_resizable_flip_add
27024     * @li @ref elm_transit_effect_fade_add
27025     * @li @ref elm_transit_effect_blend_add
27026     *
27027     * It's also possible to make a transition chain with @ref
27028     * elm_transit_chain_transit_add.
27029     *
27030     * @warning We strongly recommend to use elm_transit just when edje can not do
27031     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27032     * animations can be manipulated inside the theme.
27033     *
27034     * List of examples:
27035     * @li @ref transit_example_01_explained
27036     * @li @ref transit_example_02_explained
27037     * @li @ref transit_example_03_c
27038     * @li @ref transit_example_04_c
27039     *
27040     * @{
27041     */
27042
27043    /**
27044     * @enum Elm_Transit_Tween_Mode
27045     *
27046     * The type of acceleration used in the transition.
27047     */
27048    typedef enum
27049      {
27050         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27051         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27052                                              over time, then decrease again
27053                                              and stop slowly */
27054         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27055                                              speed over time */
27056         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27057                                             over time */
27058      } Elm_Transit_Tween_Mode;
27059
27060    /**
27061     * @enum Elm_Transit_Effect_Flip_Axis
27062     *
27063     * The axis where flip effect should be applied.
27064     */
27065    typedef enum
27066      {
27067         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27068         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27069      } Elm_Transit_Effect_Flip_Axis;
27070    /**
27071     * @enum Elm_Transit_Effect_Wipe_Dir
27072     *
27073     * The direction where the wipe effect should occur.
27074     */
27075    typedef enum
27076      {
27077         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27078         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27079         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27080         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27081      } Elm_Transit_Effect_Wipe_Dir;
27082    /** @enum Elm_Transit_Effect_Wipe_Type
27083     *
27084     * Whether the wipe effect should show or hide the object.
27085     */
27086    typedef enum
27087      {
27088         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27089                                              animation */
27090         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27091                                             animation */
27092      } Elm_Transit_Effect_Wipe_Type;
27093
27094    /**
27095     * @typedef Elm_Transit
27096     *
27097     * The Transit created with elm_transit_add(). This type has the information
27098     * about the objects which the transition will be applied, and the
27099     * transition effects that will be used. It also contains info about
27100     * duration, number of repetitions, auto-reverse, etc.
27101     */
27102    typedef struct _Elm_Transit Elm_Transit;
27103    typedef void Elm_Transit_Effect;
27104    /**
27105     * @typedef Elm_Transit_Effect_Transition_Cb
27106     *
27107     * Transition callback called for this effect on each transition iteration.
27108     */
27109    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27110    /**
27111     * Elm_Transit_Effect_End_Cb
27112     *
27113     * Transition callback called for this effect when the transition is over.
27114     */
27115    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27116
27117    /**
27118     * Elm_Transit_Del_Cb
27119     *
27120     * A callback called when the transit is deleted.
27121     */
27122    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27123
27124    /**
27125     * Add new transit.
27126     *
27127     * @note Is not necessary to delete the transit object, it will be deleted at
27128     * the end of its operation.
27129     * @note The transit will start playing when the program enter in the main loop, is not
27130     * necessary to give a start to the transit.
27131     *
27132     * @return The transit object.
27133     *
27134     * @ingroup Transit
27135     */
27136    EAPI Elm_Transit                *elm_transit_add(void);
27137
27138    /**
27139     * Stops the animation and delete the @p transit object.
27140     *
27141     * Call this function if you wants to stop the animation before the duration
27142     * time. Make sure the @p transit object is still alive with
27143     * elm_transit_del_cb_set() function.
27144     * All added effects will be deleted, calling its repective data_free_cb
27145     * functions. The function setted by elm_transit_del_cb_set() will be called.
27146     *
27147     * @see elm_transit_del_cb_set()
27148     *
27149     * @param transit The transit object to be deleted.
27150     *
27151     * @ingroup Transit
27152     * @warning Just call this function if you are sure the transit is alive.
27153     */
27154    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27155
27156    /**
27157     * Add a new effect to the transit.
27158     *
27159     * @note The cb function and the data are the key to the effect. If you try to
27160     * add an already added effect, nothing is done.
27161     * @note After the first addition of an effect in @p transit, if its
27162     * effect list become empty again, the @p transit will be killed by
27163     * elm_transit_del(transit) function.
27164     *
27165     * Exemple:
27166     * @code
27167     * Elm_Transit *transit = elm_transit_add();
27168     * elm_transit_effect_add(transit,
27169     *                        elm_transit_effect_blend_op,
27170     *                        elm_transit_effect_blend_context_new(),
27171     *                        elm_transit_effect_blend_context_free);
27172     * @endcode
27173     *
27174     * @param transit The transit object.
27175     * @param transition_cb The operation function. It is called when the
27176     * animation begins, it is the function that actually performs the animation.
27177     * It is called with the @p data, @p transit and the time progression of the
27178     * animation (a double value between 0.0 and 1.0).
27179     * @param effect The context data of the effect.
27180     * @param end_cb The function to free the context data, it will be called
27181     * at the end of the effect, it must finalize the animation and free the
27182     * @p data.
27183     *
27184     * @ingroup Transit
27185     * @warning The transit free the context data at the and of the transition with
27186     * the data_free_cb function, do not use the context data in another transit.
27187     */
27188    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);
27189
27190    /**
27191     * Delete an added effect.
27192     *
27193     * This function will remove the effect from the @p transit, calling the
27194     * data_free_cb to free the @p data.
27195     *
27196     * @see elm_transit_effect_add()
27197     *
27198     * @note If the effect is not found, nothing is done.
27199     * @note If the effect list become empty, this function will call
27200     * elm_transit_del(transit), that is, it will kill the @p transit.
27201     *
27202     * @param transit The transit object.
27203     * @param transition_cb The operation function.
27204     * @param effect The context data of the effect.
27205     *
27206     * @ingroup Transit
27207     */
27208    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);
27209
27210    /**
27211     * Add new object to apply the effects.
27212     *
27213     * @note After the first addition of an object in @p transit, if its
27214     * object list become empty again, the @p transit will be killed by
27215     * elm_transit_del(transit) function.
27216     * @note If the @p obj belongs to another transit, the @p obj will be
27217     * removed from it and it will only belong to the @p transit. If the old
27218     * transit stays without objects, it will die.
27219     * @note When you add an object into the @p transit, its state from
27220     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27221     * transit ends, if you change this state whith evas_object_pass_events_set()
27222     * after add the object, this state will change again when @p transit stops to
27223     * run.
27224     *
27225     * @param transit The transit object.
27226     * @param obj Object to be animated.
27227     *
27228     * @ingroup Transit
27229     * @warning It is not allowed to add a new object after transit begins to go.
27230     */
27231    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27232
27233    /**
27234     * Removes an added object from the transit.
27235     *
27236     * @note If the @p obj is not in the @p transit, nothing is done.
27237     * @note If the list become empty, this function will call
27238     * elm_transit_del(transit), that is, it will kill the @p transit.
27239     *
27240     * @param transit The transit object.
27241     * @param obj Object to be removed from @p transit.
27242     *
27243     * @ingroup Transit
27244     * @warning It is not allowed to remove objects after transit begins to go.
27245     */
27246    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27247
27248    /**
27249     * Get the objects of the transit.
27250     *
27251     * @param transit The transit object.
27252     * @return a Eina_List with the objects from the transit.
27253     *
27254     * @ingroup Transit
27255     */
27256    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27257
27258    /**
27259     * Enable/disable keeping up the objects states.
27260     * If it is not kept, the objects states will be reset when transition ends.
27261     *
27262     * @note @p transit can not be NULL.
27263     * @note One state includes geometry, color, map data.
27264     *
27265     * @param transit The transit object.
27266     * @param state_keep Keeping or Non Keeping.
27267     *
27268     * @ingroup Transit
27269     */
27270    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27271
27272    /**
27273     * Get a value whether the objects states will be reset or not.
27274     *
27275     * @note @p transit can not be NULL
27276     *
27277     * @see elm_transit_objects_final_state_keep_set()
27278     *
27279     * @param transit The transit object.
27280     * @return EINA_TRUE means the states of the objects will be reset.
27281     * If @p transit is NULL, EINA_FALSE is returned
27282     *
27283     * @ingroup Transit
27284     */
27285    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27286
27287    /**
27288     * Set the event enabled when transit is operating.
27289     *
27290     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27291     * events from mouse and keyboard during the animation.
27292     * @note When you add an object with elm_transit_object_add(), its state from
27293     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27294     * transit ends, if you change this state with evas_object_pass_events_set()
27295     * after adding the object, this state will change again when @p transit stops
27296     * to run.
27297     *
27298     * @param transit The transit object.
27299     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27300     * ignored otherwise.
27301     *
27302     * @ingroup Transit
27303     */
27304    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27305
27306    /**
27307     * Get the value of event enabled status.
27308     *
27309     * @see elm_transit_event_enabled_set()
27310     *
27311     * @param transit The Transit object
27312     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27313     * EINA_FALSE is returned
27314     *
27315     * @ingroup Transit
27316     */
27317    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27318
27319    /**
27320     * Set the user-callback function when the transit is deleted.
27321     *
27322     * @note Using this function twice will overwrite the first function setted.
27323     * @note the @p transit object will be deleted after call @p cb function.
27324     *
27325     * @param transit The transit object.
27326     * @param cb Callback function pointer. This function will be called before
27327     * the deletion of the transit.
27328     * @param data Callback funtion user data. It is the @p op parameter.
27329     *
27330     * @ingroup Transit
27331     */
27332    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27333
27334    /**
27335     * Set reverse effect automatically.
27336     *
27337     * If auto reverse is setted, after running the effects with the progress
27338     * parameter from 0 to 1, it will call the effecs again with the progress
27339     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27340     * where the duration was setted with the function elm_transit_add and
27341     * the repeat with the function elm_transit_repeat_times_set().
27342     *
27343     * @param transit The transit object.
27344     * @param reverse EINA_TRUE means the auto_reverse is on.
27345     *
27346     * @ingroup Transit
27347     */
27348    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27349
27350    /**
27351     * Get if the auto reverse is on.
27352     *
27353     * @see elm_transit_auto_reverse_set()
27354     *
27355     * @param transit The transit object.
27356     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27357     * EINA_FALSE is returned
27358     *
27359     * @ingroup Transit
27360     */
27361    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27362
27363    /**
27364     * Set the transit repeat count. Effect will be repeated by repeat count.
27365     *
27366     * This function sets the number of repetition the transit will run after
27367     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27368     * If the @p repeat is a negative number, it will repeat infinite times.
27369     *
27370     * @note If this function is called during the transit execution, the transit
27371     * will run @p repeat times, ignoring the times it already performed.
27372     *
27373     * @param transit The transit object
27374     * @param repeat Repeat count
27375     *
27376     * @ingroup Transit
27377     */
27378    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27379
27380    /**
27381     * Get the transit repeat count.
27382     *
27383     * @see elm_transit_repeat_times_set()
27384     *
27385     * @param transit The Transit object.
27386     * @return The repeat count. If @p transit is NULL
27387     * 0 is returned
27388     *
27389     * @ingroup Transit
27390     */
27391    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27392
27393    /**
27394     * Set the transit animation acceleration type.
27395     *
27396     * This function sets the tween mode of the transit that can be:
27397     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27398     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27399     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27400     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27401     *
27402     * @param transit The transit object.
27403     * @param tween_mode The tween type.
27404     *
27405     * @ingroup Transit
27406     */
27407    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27408
27409    /**
27410     * Get the transit animation acceleration type.
27411     *
27412     * @note @p transit can not be NULL
27413     *
27414     * @param transit The transit object.
27415     * @return The tween type. If @p transit is NULL
27416     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27417     *
27418     * @ingroup Transit
27419     */
27420    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27421
27422    /**
27423     * Set the transit animation time
27424     *
27425     * @note @p transit can not be NULL
27426     *
27427     * @param transit The transit object.
27428     * @param duration The animation time.
27429     *
27430     * @ingroup Transit
27431     */
27432    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27433
27434    /**
27435     * Get the transit animation time
27436     *
27437     * @note @p transit can not be NULL
27438     *
27439     * @param transit The transit object.
27440     *
27441     * @return The transit animation time.
27442     *
27443     * @ingroup Transit
27444     */
27445    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27446
27447    /**
27448     * Starts the transition.
27449     * Once this API is called, the transit begins to measure the time.
27450     *
27451     * @note @p transit can not be NULL
27452     *
27453     * @param transit The transit object.
27454     *
27455     * @ingroup Transit
27456     */
27457    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27458
27459    /**
27460     * Pause/Resume the transition.
27461     *
27462     * If you call elm_transit_go again, the transit will be started from the
27463     * beginning, and will be unpaused.
27464     *
27465     * @note @p transit can not be NULL
27466     *
27467     * @param transit The transit object.
27468     * @param paused Whether the transition should be paused or not.
27469     *
27470     * @ingroup Transit
27471     */
27472    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27473
27474    /**
27475     * Get the value of paused status.
27476     *
27477     * @see elm_transit_paused_set()
27478     *
27479     * @note @p transit can not be NULL
27480     *
27481     * @param transit The transit object.
27482     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27483     * EINA_FALSE is returned
27484     *
27485     * @ingroup Transit
27486     */
27487    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27488
27489    /**
27490     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27491     *
27492     * The value returned is a fraction (current time / total time). It
27493     * represents the progression position relative to the total.
27494     *
27495     * @note @p transit can not be NULL
27496     *
27497     * @param transit The transit object.
27498     *
27499     * @return The time progression value. If @p transit is NULL
27500     * 0 is returned
27501     *
27502     * @ingroup Transit
27503     */
27504    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27505
27506    /**
27507     * Makes the chain relationship between two transits.
27508     *
27509     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27510     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27511     *
27512     * @param transit The transit object.
27513     * @param chain_transit The chain transit object. This transit will be operated
27514     *        after transit is done.
27515     *
27516     * This function adds @p chain_transit transition to a chain after the @p
27517     * transit, and will be started as soon as @p transit ends. See @ref
27518     * transit_example_02_explained for a full example.
27519     *
27520     * @ingroup Transit
27521     */
27522    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27523
27524    /**
27525     * Cut off the chain relationship between two transits.
27526     *
27527     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27528     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27529     *
27530     * @param transit The transit object.
27531     * @param chain_transit The chain transit object.
27532     *
27533     * This function remove the @p chain_transit transition from the @p transit.
27534     *
27535     * @ingroup Transit
27536     */
27537    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27538
27539    /**
27540     * Get the current chain transit list.
27541     *
27542     * @note @p transit can not be NULL.
27543     *
27544     * @param transit The transit object.
27545     * @return chain transit list.
27546     *
27547     * @ingroup Transit
27548     */
27549    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27550
27551    /**
27552     * Add the Resizing Effect to Elm_Transit.
27553     *
27554     * @note This API is one of the facades. It creates resizing effect context
27555     * and add it's required APIs to elm_transit_effect_add.
27556     *
27557     * @see elm_transit_effect_add()
27558     *
27559     * @param transit Transit object.
27560     * @param from_w Object width size when effect begins.
27561     * @param from_h Object height size when effect begins.
27562     * @param to_w Object width size when effect ends.
27563     * @param to_h Object height size when effect ends.
27564     * @return Resizing effect context data.
27565     *
27566     * @ingroup Transit
27567     */
27568    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);
27569
27570    /**
27571     * Add the Translation Effect to Elm_Transit.
27572     *
27573     * @note This API is one of the facades. It creates translation effect context
27574     * and add it's required APIs to elm_transit_effect_add.
27575     *
27576     * @see elm_transit_effect_add()
27577     *
27578     * @param transit Transit object.
27579     * @param from_dx X Position variation when effect begins.
27580     * @param from_dy Y Position variation when effect begins.
27581     * @param to_dx X Position variation when effect ends.
27582     * @param to_dy Y Position variation when effect ends.
27583     * @return Translation effect context data.
27584     *
27585     * @ingroup Transit
27586     * @warning It is highly recommended just create a transit with this effect when
27587     * the window that the objects of the transit belongs has already been created.
27588     * This is because this effect needs the geometry information about the objects,
27589     * and if the window was not created yet, it can get a wrong information.
27590     */
27591    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);
27592
27593    /**
27594     * Add the Zoom Effect to Elm_Transit.
27595     *
27596     * @note This API is one of the facades. It creates zoom effect context
27597     * and add it's required APIs to elm_transit_effect_add.
27598     *
27599     * @see elm_transit_effect_add()
27600     *
27601     * @param transit Transit object.
27602     * @param from_rate Scale rate when effect begins (1 is current rate).
27603     * @param to_rate Scale rate when effect ends.
27604     * @return Zoom effect context data.
27605     *
27606     * @ingroup Transit
27607     * @warning It is highly recommended just create a transit with this effect when
27608     * the window that the objects of the transit belongs has already been created.
27609     * This is because this effect needs the geometry information about the objects,
27610     * and if the window was not created yet, it can get a wrong information.
27611     */
27612    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27613
27614    /**
27615     * Add the Flip Effect to Elm_Transit.
27616     *
27617     * @note This API is one of the facades. It creates flip effect context
27618     * and add it's required APIs to elm_transit_effect_add.
27619     * @note This effect is applied to each pair of objects in the order they are listed
27620     * in the transit list of objects. The first object in the pair will be the
27621     * "front" object and the second will be the "back" object.
27622     *
27623     * @see elm_transit_effect_add()
27624     *
27625     * @param transit Transit object.
27626     * @param axis Flipping Axis(X or Y).
27627     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27628     * @return Flip effect context data.
27629     *
27630     * @ingroup Transit
27631     * @warning It is highly recommended just create a transit with this effect when
27632     * the window that the objects of the transit belongs has already been created.
27633     * This is because this effect needs the geometry information about the objects,
27634     * and if the window was not created yet, it can get a wrong information.
27635     */
27636    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27637
27638    /**
27639     * Add the Resizable Flip Effect to Elm_Transit.
27640     *
27641     * @note This API is one of the facades. It creates resizable flip effect context
27642     * and add it's required APIs to elm_transit_effect_add.
27643     * @note This effect is applied to each pair of objects in the order they are listed
27644     * in the transit list of objects. The first object in the pair will be the
27645     * "front" object and the second will be the "back" object.
27646     *
27647     * @see elm_transit_effect_add()
27648     *
27649     * @param transit Transit object.
27650     * @param axis Flipping Axis(X or Y).
27651     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27652     * @return Resizable flip effect context data.
27653     *
27654     * @ingroup Transit
27655     * @warning It is highly recommended just create a transit with this effect when
27656     * the window that the objects of the transit belongs has already been created.
27657     * This is because this effect needs the geometry information about the objects,
27658     * and if the window was not created yet, it can get a wrong information.
27659     */
27660    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27661
27662    /**
27663     * Add the Wipe Effect to Elm_Transit.
27664     *
27665     * @note This API is one of the facades. It creates wipe effect context
27666     * and add it's required APIs to elm_transit_effect_add.
27667     *
27668     * @see elm_transit_effect_add()
27669     *
27670     * @param transit Transit object.
27671     * @param type Wipe type. Hide or show.
27672     * @param dir Wipe Direction.
27673     * @return Wipe effect context data.
27674     *
27675     * @ingroup Transit
27676     * @warning It is highly recommended just create a transit with this effect when
27677     * the window that the objects of the transit belongs has already been created.
27678     * This is because this effect needs the geometry information about the objects,
27679     * and if the window was not created yet, it can get a wrong information.
27680     */
27681    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27682
27683    /**
27684     * Add the Color Effect to Elm_Transit.
27685     *
27686     * @note This API is one of the facades. It creates color effect context
27687     * and add it's required APIs to elm_transit_effect_add.
27688     *
27689     * @see elm_transit_effect_add()
27690     *
27691     * @param transit        Transit object.
27692     * @param  from_r        RGB R when effect begins.
27693     * @param  from_g        RGB G when effect begins.
27694     * @param  from_b        RGB B when effect begins.
27695     * @param  from_a        RGB A when effect begins.
27696     * @param  to_r          RGB R when effect ends.
27697     * @param  to_g          RGB G when effect ends.
27698     * @param  to_b          RGB B when effect ends.
27699     * @param  to_a          RGB A when effect ends.
27700     * @return               Color effect context data.
27701     *
27702     * @ingroup Transit
27703     */
27704    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);
27705
27706    /**
27707     * Add the Fade Effect to Elm_Transit.
27708     *
27709     * @note This API is one of the facades. It creates fade effect context
27710     * and add it's required APIs to elm_transit_effect_add.
27711     * @note This effect is applied to each pair of objects in the order they are listed
27712     * in the transit list of objects. The first object in the pair will be the
27713     * "before" object and the second will be the "after" object.
27714     *
27715     * @see elm_transit_effect_add()
27716     *
27717     * @param transit Transit object.
27718     * @return Fade effect context data.
27719     *
27720     * @ingroup Transit
27721     * @warning It is highly recommended just create a transit with this effect when
27722     * the window that the objects of the transit belongs has already been created.
27723     * This is because this effect needs the color information about the objects,
27724     * and if the window was not created yet, it can get a wrong information.
27725     */
27726    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27727
27728    /**
27729     * Add the Blend Effect to Elm_Transit.
27730     *
27731     * @note This API is one of the facades. It creates blend effect context
27732     * and add it's required APIs to elm_transit_effect_add.
27733     * @note This effect is applied to each pair of objects in the order they are listed
27734     * in the transit list of objects. The first object in the pair will be the
27735     * "before" object and the second will be the "after" object.
27736     *
27737     * @see elm_transit_effect_add()
27738     *
27739     * @param transit Transit object.
27740     * @return Blend effect context data.
27741     *
27742     * @ingroup Transit
27743     * @warning It is highly recommended just create a transit with this effect when
27744     * the window that the objects of the transit belongs has already been created.
27745     * This is because this effect needs the color information about the objects,
27746     * and if the window was not created yet, it can get a wrong information.
27747     */
27748    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27749
27750    /**
27751     * Add the Rotation Effect to Elm_Transit.
27752     *
27753     * @note This API is one of the facades. It creates rotation effect context
27754     * and add it's required APIs to elm_transit_effect_add.
27755     *
27756     * @see elm_transit_effect_add()
27757     *
27758     * @param transit Transit object.
27759     * @param from_degree Degree when effect begins.
27760     * @param to_degree Degree when effect is ends.
27761     * @return Rotation effect context data.
27762     *
27763     * @ingroup Transit
27764     * @warning It is highly recommended just create a transit with this effect when
27765     * the window that the objects of the transit belongs has already been created.
27766     * This is because this effect needs the geometry information about the objects,
27767     * and if the window was not created yet, it can get a wrong information.
27768     */
27769    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27770
27771    /**
27772     * Add the ImageAnimation Effect to Elm_Transit.
27773     *
27774     * @note This API is one of the facades. It creates image animation effect context
27775     * and add it's required APIs to elm_transit_effect_add.
27776     * The @p images parameter is a list images paths. This list and
27777     * its contents will be deleted at the end of the effect by
27778     * elm_transit_effect_image_animation_context_free() function.
27779     *
27780     * Example:
27781     * @code
27782     * char buf[PATH_MAX];
27783     * Eina_List *images = NULL;
27784     * Elm_Transit *transi = elm_transit_add();
27785     *
27786     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27787     * images = eina_list_append(images, eina_stringshare_add(buf));
27788     *
27789     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27790     * images = eina_list_append(images, eina_stringshare_add(buf));
27791     * elm_transit_effect_image_animation_add(transi, images);
27792     *
27793     * @endcode
27794     *
27795     * @see elm_transit_effect_add()
27796     *
27797     * @param transit Transit object.
27798     * @param images Eina_List of images file paths. This list and
27799     * its contents will be deleted at the end of the effect by
27800     * elm_transit_effect_image_animation_context_free() function.
27801     * @return Image Animation effect context data.
27802     *
27803     * @ingroup Transit
27804     */
27805    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27806    /**
27807     * @}
27808     */
27809
27810    /* Store */
27811    typedef struct _Elm_Store                      Elm_Store;
27812    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
27813    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27814    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27815    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
27816    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27817    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27818    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27819    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27820    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27821    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27822    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27823    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27824
27825    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27826    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27827    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27828    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27829    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27830    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27831    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27832
27833    typedef enum
27834      {
27835         ELM_STORE_ITEM_MAPPING_NONE = 0,
27836         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27837         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27838         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27839         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27840         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27841         // can add more here as needed by common apps
27842         ELM_STORE_ITEM_MAPPING_LAST
27843      } Elm_Store_Item_Mapping_Type;
27844
27845    struct _Elm_Store_Item_Mapping_Icon
27846      {
27847         // FIXME: allow edje file icons
27848         int                   w, h;
27849         Elm_Icon_Lookup_Order lookup_order;
27850         Eina_Bool             standard_name : 1;
27851         Eina_Bool             no_scale : 1;
27852         Eina_Bool             smooth : 1;
27853         Eina_Bool             scale_up : 1;
27854         Eina_Bool             scale_down : 1;
27855      };
27856
27857    struct _Elm_Store_Item_Mapping_Empty
27858      {
27859         Eina_Bool             dummy;
27860      };
27861
27862    struct _Elm_Store_Item_Mapping_Photo
27863      {
27864         int                   size;
27865      };
27866
27867    struct _Elm_Store_Item_Mapping_Custom
27868      {
27869         Elm_Store_Item_Mapping_Cb func;
27870      };
27871
27872    struct _Elm_Store_Item_Mapping
27873      {
27874         Elm_Store_Item_Mapping_Type     type;
27875         const char                     *part;
27876         int                             offset;
27877         union
27878           {
27879              Elm_Store_Item_Mapping_Empty  empty;
27880              Elm_Store_Item_Mapping_Icon   icon;
27881              Elm_Store_Item_Mapping_Photo  photo;
27882              Elm_Store_Item_Mapping_Custom custom;
27883              // add more types here
27884           } details;
27885      };
27886
27887    struct _Elm_Store_Item_Info
27888      {
27889         int                           index;
27890         int                           item_type;
27891         int                           group_index;
27892         Eina_Bool                     rec_item;
27893         int                           pre_group_index;
27894
27895         Elm_Genlist_Item_Class       *item_class;
27896         const Elm_Store_Item_Mapping *mapping;
27897         void                         *data;
27898         char                         *sort_id;
27899      };
27900
27901    struct _Elm_Store_Item_Info_Filesystem
27902      {
27903         Elm_Store_Item_Info  base;
27904         char                *path;
27905      };
27906
27907 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27908 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27909
27910    EAPI Elm_Store              *elm_store_dbsystem_new(void);
27911    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27912    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27913    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27914    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27915    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27916    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27917    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27918    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27919    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27920    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27921    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27922    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27923    EAPI void                    elm_store_free(Elm_Store *st);
27924    EAPI Elm_Store              *elm_store_filesystem_new(void);
27925    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27926    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27927    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27928
27929    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27930
27931    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27932    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27933    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27934    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27935    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27936    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27937
27938    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27939    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27940    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27941    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27942    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27943    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27944    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27945
27946    /**
27947     * @defgroup SegmentControl SegmentControl
27948     * @ingroup Elementary
27949     *
27950     * @image html img/widget/segment_control/preview-00.png
27951     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27952     *
27953     * @image html img/segment_control.png
27954     * @image latex img/segment_control.eps width=\textwidth
27955     *
27956     * Segment control widget is a horizontal control made of multiple segment
27957     * items, each segment item functioning similar to discrete two state button.
27958     * A segment control groups the items together and provides compact
27959     * single button with multiple equal size segments.
27960     *
27961     * Segment item size is determined by base widget
27962     * size and the number of items added.
27963     * Only one segment item can be at selected state. A segment item can display
27964     * combination of Text and any Evas_Object like Images or other widget.
27965     *
27966     * Smart callbacks one can listen to:
27967     * - "changed" - When the user clicks on a segment item which is not
27968     *   previously selected and get selected. The event_info parameter is the
27969     *   segment item pointer.
27970     *
27971     * Available styles for it:
27972     * - @c "default"
27973     *
27974     * Here is an example on its usage:
27975     * @li @ref segment_control_example
27976     */
27977
27978    /**
27979     * @addtogroup SegmentControl
27980     * @{
27981     */
27982
27983    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27984
27985    /**
27986     * Add a new segment control widget to the given parent Elementary
27987     * (container) object.
27988     *
27989     * @param parent The parent object.
27990     * @return a new segment control widget handle or @c NULL, on errors.
27991     *
27992     * This function inserts a new segment control widget on the canvas.
27993     *
27994     * @ingroup SegmentControl
27995     */
27996    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27997
27998    /**
27999     * Append a new item to the segment control object.
28000     *
28001     * @param obj The segment control object.
28002     * @param icon The icon object to use for the left side of the item. An
28003     * icon can be any Evas object, but usually it is an icon created
28004     * with elm_icon_add().
28005     * @param label The label of the item.
28006     *        Note that, NULL is different from empty string "".
28007     * @return The created item or @c NULL upon failure.
28008     *
28009     * A new item will be created and appended to the segment control, i.e., will
28010     * be set as @b last item.
28011     *
28012     * If it should be inserted at another position,
28013     * elm_segment_control_item_insert_at() should be used instead.
28014     *
28015     * Items created with this function can be deleted with function
28016     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28017     *
28018     * @note @p label set to @c NULL is different from empty string "".
28019     * If an item
28020     * only has icon, it will be displayed bigger and centered. If it has
28021     * icon and label, even that an empty string, icon will be smaller and
28022     * positioned at left.
28023     *
28024     * Simple example:
28025     * @code
28026     * sc = elm_segment_control_add(win);
28027     * ic = elm_icon_add(win);
28028     * elm_icon_file_set(ic, "path/to/image", NULL);
28029     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28030     * elm_segment_control_item_add(sc, ic, "label");
28031     * evas_object_show(sc);
28032     * @endcode
28033     *
28034     * @see elm_segment_control_item_insert_at()
28035     * @see elm_segment_control_item_del()
28036     *
28037     * @ingroup SegmentControl
28038     */
28039    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28040
28041    /**
28042     * Insert a new item to the segment control object at specified position.
28043     *
28044     * @param obj The segment control object.
28045     * @param icon The icon object to use for the left side of the item. An
28046     * icon can be any Evas object, but usually it is an icon created
28047     * with elm_icon_add().
28048     * @param label The label of the item.
28049     * @param index Item position. Value should be between 0 and items count.
28050     * @return The created item or @c NULL upon failure.
28051
28052     * Index values must be between @c 0, when item will be prepended to
28053     * segment control, and items count, that can be get with
28054     * elm_segment_control_item_count_get(), case when item will be appended
28055     * to segment control, just like elm_segment_control_item_add().
28056     *
28057     * Items created with this function can be deleted with function
28058     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28059     *
28060     * @note @p label set to @c NULL is different from empty string "".
28061     * If an item
28062     * only has icon, it will be displayed bigger and centered. If it has
28063     * icon and label, even that an empty string, icon will be smaller and
28064     * positioned at left.
28065     *
28066     * @see elm_segment_control_item_add()
28067     * @see elm_segment_control_item_count_get()
28068     * @see elm_segment_control_item_del()
28069     *
28070     * @ingroup SegmentControl
28071     */
28072    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);
28073
28074    /**
28075     * Remove a segment control item from its parent, deleting it.
28076     *
28077     * @param it The item to be removed.
28078     *
28079     * Items can be added with elm_segment_control_item_add() or
28080     * elm_segment_control_item_insert_at().
28081     *
28082     * @ingroup SegmentControl
28083     */
28084    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28085
28086    /**
28087     * Remove a segment control item at given index from its parent,
28088     * deleting it.
28089     *
28090     * @param obj The segment control object.
28091     * @param index The position of the segment control item to be deleted.
28092     *
28093     * Items can be added with elm_segment_control_item_add() or
28094     * elm_segment_control_item_insert_at().
28095     *
28096     * @ingroup SegmentControl
28097     */
28098    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28099
28100    /**
28101     * Get the Segment items count from segment control.
28102     *
28103     * @param obj The segment control object.
28104     * @return Segment items count.
28105     *
28106     * It will just return the number of items added to segment control @p obj.
28107     *
28108     * @ingroup SegmentControl
28109     */
28110    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28111
28112    /**
28113     * Get the item placed at specified index.
28114     *
28115     * @param obj The segment control object.
28116     * @param index The index of the segment item.
28117     * @return The segment control item or @c NULL on failure.
28118     *
28119     * Index is the position of an item in segment control widget. Its
28120     * range is from @c 0 to <tt> count - 1 </tt>.
28121     * Count is the number of items, that can be get with
28122     * elm_segment_control_item_count_get().
28123     *
28124     * @ingroup SegmentControl
28125     */
28126    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28127
28128    /**
28129     * Get the label of item.
28130     *
28131     * @param obj The segment control object.
28132     * @param index The index of the segment item.
28133     * @return The label of the item at @p index.
28134     *
28135     * The return value is a pointer to the label associated to the item when
28136     * it was created, with function elm_segment_control_item_add(), or later
28137     * with function elm_segment_control_item_label_set. If no label
28138     * was passed as argument, it will return @c NULL.
28139     *
28140     * @see elm_segment_control_item_label_set() for more details.
28141     * @see elm_segment_control_item_add()
28142     *
28143     * @ingroup SegmentControl
28144     */
28145    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28146
28147    /**
28148     * Set the label of item.
28149     *
28150     * @param it The item of segment control.
28151     * @param text The label of item.
28152     *
28153     * The label to be displayed by the item.
28154     * Label will be at right of the icon (if set).
28155     *
28156     * If a label was passed as argument on item creation, with function
28157     * elm_control_segment_item_add(), it will be already
28158     * displayed by the item.
28159     *
28160     * @see elm_segment_control_item_label_get()
28161     * @see elm_segment_control_item_add()
28162     *
28163     * @ingroup SegmentControl
28164     */
28165    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28166
28167    /**
28168     * Get the icon associated to the item.
28169     *
28170     * @param obj The segment control object.
28171     * @param index The index of the segment item.
28172     * @return The left side icon associated to the item at @p index.
28173     *
28174     * The return value is a pointer to the icon associated to the item when
28175     * it was created, with function elm_segment_control_item_add(), or later
28176     * with function elm_segment_control_item_icon_set(). If no icon
28177     * was passed as argument, it will return @c NULL.
28178     *
28179     * @see elm_segment_control_item_add()
28180     * @see elm_segment_control_item_icon_set()
28181     *
28182     * @ingroup SegmentControl
28183     */
28184    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28185
28186    /**
28187     * Set the icon associated to the item.
28188     *
28189     * @param it The segment control item.
28190     * @param icon The icon object to associate with @p it.
28191     *
28192     * The icon object to use at left side of the item. An
28193     * icon can be any Evas object, but usually it is an icon created
28194     * with elm_icon_add().
28195     *
28196     * Once the icon object is set, a previously set one will be deleted.
28197     * @warning Setting the same icon for two items will cause the icon to
28198     * dissapear from the first item.
28199     *
28200     * If an icon was passed as argument on item creation, with function
28201     * elm_segment_control_item_add(), it will be already
28202     * associated to the item.
28203     *
28204     * @see elm_segment_control_item_add()
28205     * @see elm_segment_control_item_icon_get()
28206     *
28207     * @ingroup SegmentControl
28208     */
28209    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28210
28211    /**
28212     * Get the index of an item.
28213     *
28214     * @param it The segment control item.
28215     * @return The position of item in segment control widget.
28216     *
28217     * Index is the position of an item in segment control widget. Its
28218     * range is from @c 0 to <tt> count - 1 </tt>.
28219     * Count is the number of items, that can be get with
28220     * elm_segment_control_item_count_get().
28221     *
28222     * @ingroup SegmentControl
28223     */
28224    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28225
28226    /**
28227     * Get the base object of the item.
28228     *
28229     * @param it The segment control item.
28230     * @return The base object associated with @p it.
28231     *
28232     * Base object is the @c Evas_Object that represents that item.
28233     *
28234     * @ingroup SegmentControl
28235     */
28236    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28237
28238    /**
28239     * Get the selected item.
28240     *
28241     * @param obj The segment control object.
28242     * @return The selected item or @c NULL if none of segment items is
28243     * selected.
28244     *
28245     * The selected item can be unselected with function
28246     * elm_segment_control_item_selected_set().
28247     *
28248     * The selected item always will be highlighted on segment control.
28249     *
28250     * @ingroup SegmentControl
28251     */
28252    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28253
28254    /**
28255     * Set the selected state of an item.
28256     *
28257     * @param it The segment control item
28258     * @param select The selected state
28259     *
28260     * This sets the selected state of the given item @p it.
28261     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28262     *
28263     * If a new item is selected the previosly selected will be unselected.
28264     * Previoulsy selected item can be get with function
28265     * elm_segment_control_item_selected_get().
28266     *
28267     * The selected item always will be highlighted on segment control.
28268     *
28269     * @see elm_segment_control_item_selected_get()
28270     *
28271     * @ingroup SegmentControl
28272     */
28273    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28274
28275    /**
28276     * @}
28277     */
28278
28279    /**
28280     * @defgroup Grid Grid
28281     *
28282     * The grid is a grid layout widget that lays out a series of children as a
28283     * fixed "grid" of widgets using a given percentage of the grid width and
28284     * height each using the child object.
28285     *
28286     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28287     * widgets size itself. The default is 100 x 100, so that means the
28288     * position and sizes of children will effectively be percentages (0 to 100)
28289     * of the width or height of the grid widget
28290     *
28291     * @{
28292     */
28293
28294    /**
28295     * Add a new grid to the parent
28296     *
28297     * @param parent The parent object
28298     * @return The new object or NULL if it cannot be created
28299     *
28300     * @ingroup Grid
28301     */
28302    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28303
28304    /**
28305     * Set the virtual size of the grid
28306     *
28307     * @param obj The grid object
28308     * @param w The virtual width of the grid
28309     * @param h The virtual height of the grid
28310     *
28311     * @ingroup Grid
28312     */
28313    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28314
28315    /**
28316     * Get the virtual size of the grid
28317     *
28318     * @param obj The grid object
28319     * @param w Pointer to integer to store the virtual width of the grid
28320     * @param h Pointer to integer to store the virtual height of the grid
28321     *
28322     * @ingroup Grid
28323     */
28324    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28325
28326    /**
28327     * Pack child at given position and size
28328     *
28329     * @param obj The grid object
28330     * @param subobj The child to pack
28331     * @param x The virtual x coord at which to pack it
28332     * @param y The virtual y coord at which to pack it
28333     * @param w The virtual width at which to pack it
28334     * @param h The virtual height at which to pack it
28335     *
28336     * @ingroup Grid
28337     */
28338    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28339
28340    /**
28341     * Unpack a child from a grid object
28342     *
28343     * @param obj The grid object
28344     * @param subobj The child to unpack
28345     *
28346     * @ingroup Grid
28347     */
28348    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28349
28350    /**
28351     * Faster way to remove all child objects from a grid object.
28352     *
28353     * @param obj The grid object
28354     * @param clear If true, it will delete just removed children
28355     *
28356     * @ingroup Grid
28357     */
28358    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28359
28360    /**
28361     * Set packing of an existing child at to position and size
28362     *
28363     * @param subobj The child to set packing of
28364     * @param x The virtual x coord at which to pack it
28365     * @param y The virtual y coord at which to pack it
28366     * @param w The virtual width at which to pack it
28367     * @param h The virtual height at which to pack it
28368     *
28369     * @ingroup Grid
28370     */
28371    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28372
28373    /**
28374     * get packing of a child
28375     *
28376     * @param subobj The child to query
28377     * @param x Pointer to integer to store the virtual x coord
28378     * @param y Pointer to integer to store the virtual y coord
28379     * @param w Pointer to integer to store the virtual width
28380     * @param h Pointer to integer to store the virtual height
28381     *
28382     * @ingroup Grid
28383     */
28384    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28385
28386    /**
28387     * @}
28388     */
28389
28390    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28391    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28392    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28393    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28394    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28395    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28396
28397    /**
28398     * @defgroup Video Video
28399     *
28400     * @addtogroup Video
28401     * @{
28402     *
28403     * Elementary comes with two object that help design application that need
28404     * to display video. The main one, Elm_Video, display a video by using Emotion.
28405     * It does embedded the video inside an Edje object, so you can do some
28406     * animation depending on the video state change. It does also implement a
28407     * ressource management policy to remove this burden from the application writer.
28408     *
28409     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28410     * It take care of updating its content according to Emotion event and provide a
28411     * way to theme itself. It also does automatically raise the priority of the
28412     * linked Elm_Video so it will use the video decoder if available. It also does
28413     * activate the remember function on the linked Elm_Video object.
28414     *
28415     * Signals that you can add callback for are :
28416     *
28417     * "forward,clicked" - the user clicked the forward button.
28418     * "info,clicked" - the user clicked the info button.
28419     * "next,clicked" - the user clicked the next button.
28420     * "pause,clicked" - the user clicked the pause button.
28421     * "play,clicked" - the user clicked the play button.
28422     * "prev,clicked" - the user clicked the prev button.
28423     * "rewind,clicked" - the user clicked the rewind button.
28424     * "stop,clicked" - the user clicked the stop button.
28425     * 
28426     * Default contents parts of the player widget that you can use for are:
28427     * @li "video" - A video of the player
28428     * 
28429     */
28430
28431    /**
28432     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28433     *
28434     * @param parent The parent object
28435     * @return a new player widget handle or @c NULL, on errors.
28436     *
28437     * This function inserts a new player widget on the canvas.
28438     *
28439     * @see elm_object_part_content_set()
28440     *
28441     * @ingroup Video
28442     */
28443    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28444
28445    /**
28446     * @brief Link a Elm_Payer with an Elm_Video object.
28447     *
28448     * @param player the Elm_Player object.
28449     * @param video The Elm_Video object.
28450     *
28451     * This mean that action on the player widget will affect the
28452     * video object and the state of the video will be reflected in
28453     * the player itself.
28454     *
28455     * @see elm_player_add()
28456     * @see elm_video_add()
28457     * @deprecated use elm_object_part_content_set() instead
28458     *
28459     * @ingroup Video
28460     */
28461    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28462
28463    /**
28464     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28465     *
28466     * @param parent The parent object
28467     * @return a new video widget handle or @c NULL, on errors.
28468     *
28469     * This function inserts a new video widget on the canvas.
28470     *
28471     * @seeelm_video_file_set()
28472     * @see elm_video_uri_set()
28473     *
28474     * @ingroup Video
28475     */
28476    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28477
28478    /**
28479     * @brief Define the file that will be the video source.
28480     *
28481     * @param video The video object to define the file for.
28482     * @param filename The file to target.
28483     *
28484     * This function will explicitly define a filename as a source
28485     * for the video of the Elm_Video object.
28486     *
28487     * @see elm_video_uri_set()
28488     * @see elm_video_add()
28489     * @see elm_player_add()
28490     *
28491     * @ingroup Video
28492     */
28493    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28494
28495    /**
28496     * @brief Define the uri that will be the video source.
28497     *
28498     * @param video The video object to define the file for.
28499     * @param uri The uri to target.
28500     *
28501     * This function will define an uri as a source for the video of the
28502     * Elm_Video object. URI could be remote source of video, like http:// or local source
28503     * like for example WebCam who are most of the time v4l2:// (but that depend and
28504     * you should use Emotion API to request and list the available Webcam on your system).
28505     *
28506     * @see elm_video_file_set()
28507     * @see elm_video_add()
28508     * @see elm_player_add()
28509     *
28510     * @ingroup Video
28511     */
28512    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28513
28514    /**
28515     * @brief Get the underlying Emotion object.
28516     *
28517     * @param video The video object to proceed the request on.
28518     * @return the underlying Emotion object.
28519     *
28520     * @ingroup Video
28521     */
28522    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28523
28524    /**
28525     * @brief Start to play the video
28526     *
28527     * @param video The video object to proceed the request on.
28528     *
28529     * Start to play the video and cancel all suspend state.
28530     *
28531     * @ingroup Video
28532     */
28533    EAPI void elm_video_play(Evas_Object *video);
28534
28535    /**
28536     * @brief Pause the video
28537     *
28538     * @param video The video object to proceed the request on.
28539     *
28540     * Pause the video and start a timer to trigger suspend mode.
28541     *
28542     * @ingroup Video
28543     */
28544    EAPI void elm_video_pause(Evas_Object *video);
28545
28546    /**
28547     * @brief Stop the video
28548     *
28549     * @param video The video object to proceed the request on.
28550     *
28551     * Stop the video and put the emotion in deep sleep mode.
28552     *
28553     * @ingroup Video
28554     */
28555    EAPI void elm_video_stop(Evas_Object *video);
28556
28557    /**
28558     * @brief Is the video actually playing.
28559     *
28560     * @param video The video object to proceed the request on.
28561     * @return EINA_TRUE if the video is actually playing.
28562     *
28563     * You should consider watching event on the object instead of polling
28564     * the object state.
28565     *
28566     * @ingroup Video
28567     */
28568    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28569
28570    /**
28571     * @brief Is it possible to seek inside the video.
28572     *
28573     * @param video The video object to proceed the request on.
28574     * @return EINA_TRUE if is possible to seek inside the video.
28575     *
28576     * @ingroup Video
28577     */
28578    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28579
28580    /**
28581     * @brief Is the audio muted.
28582     *
28583     * @param video The video object to proceed the request on.
28584     * @return EINA_TRUE if the audio is muted.
28585     *
28586     * @ingroup Video
28587     */
28588    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28589
28590    /**
28591     * @brief Change the mute state of the Elm_Video object.
28592     *
28593     * @param video The video object to proceed the request on.
28594     * @param mute The new mute state.
28595     *
28596     * @ingroup Video
28597     */
28598    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28599
28600    /**
28601     * @brief Get the audio level of the current video.
28602     *
28603     * @param video The video object to proceed the request on.
28604     * @return the current audio level.
28605     *
28606     * @ingroup Video
28607     */
28608    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28609
28610    /**
28611     * @brief Set the audio level of anElm_Video object.
28612     *
28613     * @param video The video object to proceed the request on.
28614     * @param volume The new audio volume.
28615     *
28616     * @ingroup Video
28617     */
28618    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28619
28620    EAPI double elm_video_play_position_get(const Evas_Object *video);
28621    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28622    EAPI double elm_video_play_length_get(const Evas_Object *video);
28623    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28624    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28625    EAPI const char *elm_video_title_get(const Evas_Object *video);
28626    /**
28627     * @}
28628     */
28629
28630    // FIXME: incomplete - carousel. don't use this until this comment is removed
28631    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28632    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
28633    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28634    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
28635    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
28636    /* smart callbacks called:
28637     * "clicked" - when the user clicks on a carousel item and becomes selected
28638     */
28639
28640    /* datefield */
28641
28642    typedef enum _Elm_Datefield_ItemType
28643      {
28644         ELM_DATEFIELD_YEAR = 0,
28645         ELM_DATEFIELD_MONTH,
28646         ELM_DATEFIELD_DATE,
28647         ELM_DATEFIELD_HOUR,
28648         ELM_DATEFIELD_MINUTE,
28649         ELM_DATEFIELD_AMPM
28650      } Elm_Datefield_ItemType;
28651
28652    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28653    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28654    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
28655    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28656    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28657    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28658    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28659    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28660    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28661    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28662    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28663    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28664    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28665  
28666    /* smart callbacks called:
28667    * "changed" - when datefield value is changed, this signal is sent.
28668    */
28669
28670 ////////////////////// DEPRECATED ///////////////////////////////////
28671
28672    typedef enum _Elm_Datefield_Layout
28673      {
28674         ELM_DATEFIELD_LAYOUT_TIME,
28675         ELM_DATEFIELD_LAYOUT_DATE,
28676         ELM_DATEFIELD_LAYOUT_DATEANDTIME
28677      } Elm_Datefield_Layout;
28678
28679    EINA_DEPRECATED EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28680    EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28681    EINA_DEPRECATED EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28682    EINA_DEPRECATED EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
28683    EINA_DEPRECATED EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28684    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
28685    EINA_DEPRECATED EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28686    EINA_DEPRECATED EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28687    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28688    EINA_DEPRECATED EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28689    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28690    EINA_DEPRECATED EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28691    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);
28692    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28693 /////////////////////////////////////////////////////////////////////
28694
28695    /* popup */
28696    typedef enum _Elm_Popup_Response
28697      {
28698         ELM_POPUP_RESPONSE_NONE = -1,
28699         ELM_POPUP_RESPONSE_TIMEOUT = -2,
28700         ELM_POPUP_RESPONSE_OK = -3,
28701         ELM_POPUP_RESPONSE_CANCEL = -4,
28702         ELM_POPUP_RESPONSE_CLOSE = -5
28703      } Elm_Popup_Response;
28704
28705    typedef enum _Elm_Popup_Mode
28706      {
28707         ELM_POPUP_TYPE_NONE = 0,
28708         ELM_POPUP_TYPE_ALERT = (1 << 0)
28709      } Elm_Popup_Mode;
28710
28711    typedef enum _Elm_Popup_Orient
28712      {
28713         ELM_POPUP_ORIENT_TOP,
28714         ELM_POPUP_ORIENT_CENTER,
28715         ELM_POPUP_ORIENT_BOTTOM,
28716         ELM_POPUP_ORIENT_LEFT,
28717         ELM_POPUP_ORIENT_RIGHT,
28718         ELM_POPUP_ORIENT_TOP_LEFT,
28719         ELM_POPUP_ORIENT_TOP_RIGHT,
28720         ELM_POPUP_ORIENT_BOTTOM_LEFT,
28721         ELM_POPUP_ORIENT_BOTTOM_RIGHT
28722      } Elm_Popup_Orient;
28723
28724    /* smart callbacks called:
28725     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28726     */
28727
28728    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28729    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
28730    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
28731    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
28732    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
28733    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28734    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28735    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28736    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28737    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
28738    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, ... );
28739    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
28740    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28741    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
28742    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28743    EAPI int          elm_popup_run(Evas_Object *obj);
28744
28745    /* NavigationBar */
28746    #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28747    #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28748
28749    typedef enum
28750      {
28751         ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28752         ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28753         ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28754         ELM_NAVIGATIONBAR_BACK_BUTTON
28755      } Elm_Navi_Button_Type;
28756
28757    EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28758    EINA_DEPRECATED    EAPI void         elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
28759    EINA_DEPRECATED    EAPI void         elm_navigationbar_pop(Evas_Object *obj);
28760    EINA_DEPRECATED    EAPI void         elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28761    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28762    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28763    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28764    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28765    EINA_DEPRECATED    EAPI Eina_List   *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28766    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28767    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28768    EINA_DEPRECATED    EAPI void         elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28769    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28770    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28771    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28772    EINA_DEPRECATED    EAPI void         elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28773    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28774    EINA_DEPRECATED    EAPI void         elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28775    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28776    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28777    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28778    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28779
28780    /* NavigationBar */
28781    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28782    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28783
28784    typedef enum
28785      {
28786         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28787         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28788         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28789         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28790         ELM_NAVIGATIONBAR_EX_MAX
28791      } Elm_Navi_ex_Button_Type;
28792    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28793
28794    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28795    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28796    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
28797    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28798    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28799    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28800    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28801    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28802    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28803    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);
28804    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28805    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28806    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28807    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28808    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28809    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28810    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28811    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28812    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28813    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28814    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28815    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28816    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28817    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28818    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28819    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28820    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28821    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28822
28823    /**
28824     * @defgroup Naviframe Naviframe
28825     * @ingroup Elementary
28826     *
28827     * @brief Naviframe is a kind of view manager for the applications.
28828     *
28829     * Naviframe provides functions to switch different pages with stack
28830     * mechanism. It means if one page(item) needs to be changed to the new one,
28831     * then naviframe would push the new page to it's internal stack. Of course,
28832     * it can be back to the previous page by popping the top page. Naviframe
28833     * provides some transition effect while the pages are switching (same as
28834     * pager).
28835     *
28836     * Since each item could keep the different styles, users could keep the
28837     * same look & feel for the pages or different styles for the items in it's
28838     * application.
28839     *
28840     * Signals that you can add callback for are:
28841     * @li "transition,finished" - When the transition is finished in changing
28842     *     the item
28843     * @li "title,clicked" - User clicked title area
28844     *
28845     * Default contents parts of the naviframe items that you can use for are:
28846     * @li "default" - A main content of the page
28847     * @li "icon" - A icon in the title area
28848     * @li "prev_btn" - A button to go to the previous page
28849     * @li "next_btn" - A button to go to the next page
28850     *
28851     * Default text parts of the naviframe items that you can use for are:
28852     * @li "default" - Title label in the title area
28853     * @li "subtitle" - Sub-title label in the title area
28854     *
28855     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28856     */
28857
28858   //Available commonly
28859   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28860   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28861   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28862   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28863   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28864   #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28865   #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28866   #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28867   #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28868   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28869   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28870   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28871   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28872   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28873   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28874   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28875   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28876
28877    //Available only in a style - "2line"
28878   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28879
28880   //Available only in a style - "segment"
28881   #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28882   #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28883
28884    /**
28885     * @addtogroup Naviframe
28886     * @{
28887     */
28888
28889    /**
28890     * @brief Add a new Naviframe object to the parent.
28891     *
28892     * @param parent Parent object
28893     * @return New object or @c NULL, if it cannot be created
28894     *
28895     * @ingroup Naviframe
28896     */
28897    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28898    /**
28899     * @brief Push a new item to the top of the naviframe stack (and show it).
28900     *
28901     * @param obj The naviframe object
28902     * @param title_label The label in the title area. The name of the title
28903     *        label part is "elm.text.title"
28904     * @param prev_btn The button to go to the previous item. If it is NULL,
28905     *        then naviframe will create a back button automatically. The name of
28906     *        the prev_btn part is "elm.swallow.prev_btn"
28907     * @param next_btn The button to go to the next item. Or It could be just an
28908     *        extra function button. The name of the next_btn part is
28909     *        "elm.swallow.next_btn"
28910     * @param content The main content object. The name of content part is
28911     *        "elm.swallow.content"
28912     * @param item_style The current item style name. @c NULL would be default.
28913     * @return The created item or @c NULL upon failure.
28914     *
28915     * The item pushed becomes one page of the naviframe, this item will be
28916     * deleted when it is popped.
28917     *
28918     * @see also elm_naviframe_item_style_set()
28919     * @see also elm_naviframe_item_insert_before()
28920     * @see also elm_naviframe_item_insert_after()
28921     *
28922     * The following styles are available for this item:
28923     * @li @c "default"
28924     *
28925     * @ingroup Naviframe
28926     */
28927    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);
28928     /**
28929     * @brief Insert a new item into the naviframe before item @p before.
28930     *
28931     * @param before The naviframe item to insert before.
28932     * @param title_label The label in the title area. The name of the title
28933     *        label part is "elm.text.title"
28934     * @param prev_btn The button to go to the previous item. If it is NULL,
28935     *        then naviframe will create a back button automatically. The name of
28936     *        the prev_btn part is "elm.swallow.prev_btn"
28937     * @param next_btn The button to go to the next item. Or It could be just an
28938     *        extra function button. The name of the next_btn part is
28939     *        "elm.swallow.next_btn"
28940     * @param content The main content object. The name of content part is
28941     *        "elm.swallow.content"
28942     * @param item_style The current item style name. @c NULL would be default.
28943     * @return The created item or @c NULL upon failure.
28944     *
28945     * The item is inserted into the naviframe straight away without any
28946     * transition operations. This item will be deleted when it is popped.
28947     *
28948     * @see also elm_naviframe_item_style_set()
28949     * @see also elm_naviframe_item_push()
28950     * @see also elm_naviframe_item_insert_after()
28951     *
28952     * The following styles are available for this item:
28953     * @li @c "default"
28954     *
28955     * @ingroup Naviframe
28956     */
28957    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);
28958    /**
28959     * @brief Insert a new item into the naviframe after item @p after.
28960     *
28961     * @param after The naviframe item to insert after.
28962     * @param title_label The label in the title area. The name of the title
28963     *        label part is "elm.text.title"
28964     * @param prev_btn The button to go to the previous item. If it is NULL,
28965     *        then naviframe will create a back button automatically. The name of
28966     *        the prev_btn part is "elm.swallow.prev_btn"
28967     * @param next_btn The button to go to the next item. Or It could be just an
28968     *        extra function button. The name of the next_btn part is
28969     *        "elm.swallow.next_btn"
28970     * @param content The main content object. The name of content part is
28971     *        "elm.swallow.content"
28972     * @param item_style The current item style name. @c NULL would be default.
28973     * @return The created item or @c NULL upon failure.
28974     *
28975     * The item is inserted into the naviframe straight away without any
28976     * transition operations. This item will be deleted when it is popped.
28977     *
28978     * @see also elm_naviframe_item_style_set()
28979     * @see also elm_naviframe_item_push()
28980     * @see also elm_naviframe_item_insert_before()
28981     *
28982     * The following styles are available for this item:
28983     * @li @c "default"
28984     *
28985     * @ingroup Naviframe
28986     */
28987    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);
28988    /**
28989     * @brief Pop an item that is on top of the stack
28990     *
28991     * @param obj The naviframe object
28992     * @return @c NULL or the content object(if the
28993     *         elm_naviframe_content_preserve_on_pop_get is true).
28994     *
28995     * This pops an item that is on the top(visible) of the naviframe, makes it
28996     * disappear, then deletes the item. The item that was underneath it on the
28997     * stack will become visible.
28998     *
28999     * @see also elm_naviframe_content_preserve_on_pop_get()
29000     *
29001     * @ingroup Naviframe
29002     */
29003    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29004    /**
29005     * @brief Pop the items between the top and the above one on the given item.
29006     *
29007     * @param it The naviframe item
29008     *
29009     * @ingroup Naviframe
29010     */
29011    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29012    /**
29013    * Promote an item already in the naviframe stack to the top of the stack
29014    *
29015    * @param it The naviframe item
29016    *
29017    * This will take the indicated item and promote it to the top of the stack
29018    * as if it had been pushed there. The item must already be inside the
29019    * naviframe stack to work.
29020    *
29021    */
29022    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29023    /**
29024     * @brief Delete the given item instantly.
29025     *
29026     * @param it The naviframe item
29027     *
29028     * This just deletes the given item from the naviframe item list instantly.
29029     * So this would not emit any signals for view transitions but just change
29030     * the current view if the given item is a top one.
29031     *
29032     * @ingroup Naviframe
29033     */
29034    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29035    /**
29036     * @brief preserve the content objects when items are popped.
29037     *
29038     * @param obj The naviframe object
29039     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29040     *
29041     * @see also elm_naviframe_content_preserve_on_pop_get()
29042     *
29043     * @ingroup Naviframe
29044     */
29045    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29046    /**
29047     * @brief Get a value whether preserve mode is enabled or not.
29048     *
29049     * @param obj The naviframe object
29050     * @return If @c EINA_TRUE, preserve mode is enabled
29051     *
29052     * @see also elm_naviframe_content_preserve_on_pop_set()
29053     *
29054     * @ingroup Naviframe
29055     */
29056    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29057    /**
29058     * @brief Get a top item on the naviframe stack
29059     *
29060     * @param obj The naviframe object
29061     * @return The top item on the naviframe stack or @c NULL, if the stack is
29062     *         empty
29063     *
29064     * @ingroup Naviframe
29065     */
29066    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29067    /**
29068     * @brief Get a bottom item on the naviframe stack
29069     *
29070     * @param obj The naviframe object
29071     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29072     *         empty
29073     *
29074     * @ingroup Naviframe
29075     */
29076    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29077    /**
29078     * @brief Set an item style
29079     *
29080     * @param obj The naviframe item
29081     * @param item_style The current item style name. @c NULL would be default
29082     *
29083     * The following styles are available for this item:
29084     * @li @c "default"
29085     *
29086     * @see also elm_naviframe_item_style_get()
29087     *
29088     * @ingroup Naviframe
29089     */
29090    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29091    /**
29092     * @brief Get an item style
29093     *
29094     * @param obj The naviframe item
29095     * @return The current item style name
29096     *
29097     * @see also elm_naviframe_item_style_set()
29098     *
29099     * @ingroup Naviframe
29100     */
29101    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29102    /**
29103     * @brief Show/Hide the title area
29104     *
29105     * @param it The naviframe item
29106     * @param visible If @c EINA_TRUE, title area will be visible, hidden
29107     *        otherwise
29108     *
29109     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
29110     *
29111     * @see also elm_naviframe_item_title_visible_get()
29112     *
29113     * @ingroup Naviframe
29114     */
29115    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29116    /**
29117     * @brief Get a value whether title area is visible or not.
29118     *
29119     * @param it The naviframe item
29120     * @return If @c EINA_TRUE, title area is visible
29121     *
29122     * @see also elm_naviframe_item_title_visible_set()
29123     *
29124     * @ingroup Naviframe
29125     */
29126    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29127
29128    /**
29129     * @brief Set creating prev button automatically or not
29130     *
29131     * @param obj The naviframe object
29132     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29133     *        be created internally when you pass the @c NULL to the prev_btn
29134     *        parameter in elm_naviframe_item_push
29135     *
29136     * @see also elm_naviframe_item_push()
29137     */
29138    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29139    /**
29140     * @brief Get a value whether prev button(back button) will be auto pushed or
29141     *        not.
29142     *
29143     * @param obj The naviframe object
29144     * @return If @c EINA_TRUE, prev button will be auto pushed.
29145     *
29146     * @see also elm_naviframe_item_push()
29147     *           elm_naviframe_prev_btn_auto_pushed_set()
29148     */
29149    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29150    /**
29151     * @brief Get a list of all the naviframe items.
29152     *
29153     * @param obj The naviframe object
29154     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29155     * or @c NULL on failure.
29156     */
29157    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29158
29159    /**
29160     * @}
29161     */
29162
29163    /* Control Bar */
29164    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29165    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29166    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29167    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29168    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29169    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29170    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29171    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29172    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29173
29174    typedef enum _Elm_Controlbar_Mode_Type
29175      {
29176         ELM_CONTROLBAR_MODE_DEFAULT = 0,
29177         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29178         ELM_CONTROLBAR_MODE_TRANSPARENCY,
29179         ELM_CONTROLBAR_MODE_LARGE,
29180         ELM_CONTROLBAR_MODE_SMALL,
29181         ELM_CONTROLBAR_MODE_LEFT,
29182         ELM_CONTROLBAR_MODE_RIGHT
29183      } Elm_Controlbar_Mode_Type;
29184
29185    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29186    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29187    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29188    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29189    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);
29190    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);
29191    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);
29192    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);
29193    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);
29194    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);
29195    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29196    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29197    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29198    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29199    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29200    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
29201    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
29202    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29203    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29204    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29205    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29206    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29207    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29208    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29209    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29210    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29211    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29212    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29213    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
29214    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29215    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29216    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29217    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29218    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29219    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29220    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
29221    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29222    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29223    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29224
29225    /* SearchBar */
29226    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29227    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29228    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
29229    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29230    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29231    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29232    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29233    EAPI void         elm_searchbar_clear(Evas_Object *obj);
29234    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29235
29236    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29237    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29238    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29239    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29240
29241    /* NoContents */
29242    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29243    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
29244    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
29245    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29246    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29247
29248    /* TickerNoti */
29249    typedef enum
29250      {
29251         ELM_TICKERNOTI_ORIENT_TOP = 0,
29252         ELM_TICKERNOTI_ORIENT_BOTTOM,
29253         ELM_TICKERNOTI_ORIENT_LAST
29254      }  Elm_Tickernoti_Orient;
29255
29256    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
29257    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29258    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29259    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29260    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29261    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29262    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29263    typedef enum
29264     {
29265        ELM_TICKERNOTI_DEFAULT,
29266        ELM_TICKERNOTI_DETAILVIEW
29267     } Elm_Tickernoti_Mode;
29268    EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29269    EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29270    EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29271    EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29272    EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29273    EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29274    EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29275    EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29276    EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29277    EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29278    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29279    EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29280    EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29281    EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29282    EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29283    EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29284    EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29285    /* ############################################################################### */
29286    /*
29287     * Parts which can be used with elm_object_text_part_set() and
29288     * elm_object_text_part_get():
29289     *
29290     * @li NULL/"default" - Operates on tickernoti content-text
29291     *
29292     * Parts which can be used with elm_object_content_part_set(),
29293     * elm_object_content_part_get() and elm_object_content_part_unset():
29294     *
29295     * @li "icon" - Operates on tickernoti's icon
29296     * @li "button" - Operates on tickernoti's button
29297     *
29298     * smart callbacks called:
29299     * @li "clicked" - emitted when tickernoti is clicked, except at the
29300     * swallow/button region, if any.
29301     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29302     * any hide animation, this signal is emitted after the animation.
29303     */
29304
29305    /* colorpalette */
29306    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29307
29308    struct _Colorpalette_Color
29309      {
29310         unsigned int r, g, b;
29311      };
29312
29313    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29314    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29315    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29316    /* smart callbacks called:
29317     * "clicked" - when image clicked
29318     */
29319
29320    /* editfield */
29321    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29322    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
29323    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
29324    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29325    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
29326    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29327 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29328    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29329    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29330    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29331    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29332    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29333    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
29334    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29335    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
29336    /* smart callbacks called:
29337     * "clicked" - when an editfield is clicked
29338     * "unfocused" - when an editfield is unfocused
29339     */
29340
29341
29342    /* Sliding Drawer */
29343    typedef enum _Elm_SlidingDrawer_Pos
29344      {
29345         ELM_SLIDINGDRAWER_BOTTOM,
29346         ELM_SLIDINGDRAWER_LEFT,
29347         ELM_SLIDINGDRAWER_RIGHT,
29348         ELM_SLIDINGDRAWER_TOP
29349      } Elm_SlidingDrawer_Pos;
29350
29351    typedef struct _Elm_SlidingDrawer_Drag_Value
29352      {
29353         double x, y;
29354      } Elm_SlidingDrawer_Drag_Value;
29355
29356    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
29357    EINA_DEPRECATED EAPI void         elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
29358    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
29359    EINA_DEPRECATED EAPI void         elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
29360    EINA_DEPRECATED EAPI void         elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw,  double dh);
29361    EINA_DEPRECATED EAPI void         elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
29362
29363    /* multibuttonentry */
29364    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29365    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29366    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
29367    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj);
29368    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29369    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29370    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29371    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29372    EAPI int                        elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29373    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29374    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29375    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29376    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29377    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29378    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj);
29379    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29380    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29381    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29382    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29383    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29384    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29385    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
29386    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29387    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29388    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29389    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29390    EAPI void                      *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29391    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29392    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29393    /* smart callback called:
29394     * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29395     * "added" - This signal is emitted when a new multibuttonentry item is added.
29396     * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29397     * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29398     * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29399     * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29400     * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29401     * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29402     * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29403     * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29404     * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29405     * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29406     */
29407    /* available styles:
29408     * default
29409     */
29410
29411    /* stackedicon */
29412    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29413    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
29414    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29415    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29416    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29417    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
29418    /* smart callback called:
29419     * "expanded" - This signal is emitted when a stackedicon is expanded.
29420     * "clicked" - This signal is emitted when a stackedicon is clicked.
29421     */
29422    /* available styles:
29423     * default
29424     */
29425
29426    /* dialoguegroup */
29427    typedef struct _Dialogue_Item Dialogue_Item;
29428
29429    typedef enum _Elm_Dialoguegourp_Item_Style
29430      {
29431         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29432         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29433         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29434         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29435         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29436         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29437         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29438         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29439         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29440         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29441         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29442      } Elm_Dialoguegroup_Item_Style;
29443
29444    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
29445    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29446    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29447    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29448    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29449    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
29450    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
29451    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29452    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
29453    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29454    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29455    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29456    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29457    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29458    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29459    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29460
29461    /* Dayselector */
29462    typedef enum
29463      {
29464         ELM_DAYSELECTOR_SUN,
29465         ELM_DAYSELECTOR_MON,
29466         ELM_DAYSELECTOR_TUE,
29467         ELM_DAYSELECTOR_WED,
29468         ELM_DAYSELECTOR_THU,
29469         ELM_DAYSELECTOR_FRI,
29470         ELM_DAYSELECTOR_SAT
29471      } Elm_DaySelector_Day;
29472
29473    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29474    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29475    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29476
29477    /* Image Slider */
29478    typedef struct _Imageslider_Item Elm_Imageslider_Item;
29479    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29480    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29481    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);
29482    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);
29483    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);
29484    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29485    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29486    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29487    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29488    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29489    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29490    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29491    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29492    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29493    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29494    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29495 #ifdef __cplusplus
29496 }
29497 #endif
29498
29499 #endif