43419fb0c345e30ce47eb93e92a89fff9c95d247
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.8.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    return 0;
237 }
238 ELM_MAIN()
239 @endcode
240    *
241    */
242
243 /**
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@@gmail.com>
288 @author Thierry el Borgi <thierry@@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
290 @author Chanwook Jung <joey.jung@@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
293 @author Kim Yunhan <spbear@@gmail.com>
294 @author Bluezery <ohpowel@@gmail.com>
295 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
296 @author Sanjeev BA <iamsanjeev@@gmail.com>
297
298 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
299 contact with the developers and maintainers.
300  */
301
302 #ifndef ELEMENTARY_H
303 #define ELEMENTARY_H
304
305 /**
306  * @file Elementary.h
307  * @brief Elementary's API
308  *
309  * Elementary API.
310  */
311
312 @ELM_UNIX_DEF@ ELM_UNIX
313 @ELM_WIN32_DEF@ ELM_WIN32
314 @ELM_WINCE_DEF@ ELM_WINCE
315 @ELM_EDBUS_DEF@ ELM_EDBUS
316 @ELM_EFREET_DEF@ ELM_EFREET
317 @ELM_ETHUMB_DEF@ ELM_ETHUMB
318 @ELM_WEB_DEF@ ELM_WEB
319 @ELM_EMAP_DEF@ ELM_EMAP
320 @ELM_DEBUG_DEF@ ELM_DEBUG
321 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
322 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
323
324 /* Standard headers for standard system calls etc. */
325 #include <stdio.h>
326 #include <stdlib.h>
327 #include <unistd.h>
328 #include <string.h>
329 #include <sys/types.h>
330 #include <sys/stat.h>
331 #include <sys/time.h>
332 #include <sys/param.h>
333 #include <dlfcn.h>
334 #include <math.h>
335 #include <fnmatch.h>
336 #include <limits.h>
337 #include <ctype.h>
338 #include <time.h>
339 #include <dirent.h>
340 #include <pwd.h>
341 #include <errno.h>
342
343 #ifdef ELM_UNIX
344 # include <locale.h>
345 # ifdef ELM_LIBINTL_H
346 #  include <libintl.h>
347 # endif
348 # include <signal.h>
349 # include <grp.h>
350 # include <glob.h>
351 #endif
352
353 #ifdef ELM_ALLOCA_H
354 # include <alloca.h>
355 #endif
356
357 #if defined (ELM_WIN32) || defined (ELM_WINCE)
358 # include <malloc.h>
359 # ifndef alloca
360 #  define alloca _alloca
361 # endif
362 #endif
363
364
365 /* EFL headers */
366 #include <Eina.h>
367 #include <Eet.h>
368 #include <Evas.h>
369 #include <Evas_GL.h>
370 #include <Ecore.h>
371 #include <Ecore_Evas.h>
372 #include <Ecore_File.h>
373 #include <Ecore_IMF.h>
374 @ELEMENTARY_ECORE_CON_INC@
375 #include <Edje.h>
376
377 #ifdef ELM_EDBUS
378 # include <E_DBus.h>
379 #endif
380
381 #ifdef ELM_EFREET
382 # include <Efreet.h>
383 # include <Efreet_Mime.h>
384 # include <Efreet_Trash.h>
385 #endif
386
387 #ifdef ELM_ETHUMB
388 # include <Ethumb_Client.h>
389 #endif
390
391 #ifdef ELM_EMAP
392 # include <EMap.h>
393 #endif
394
395 #ifdef EAPI
396 # undef EAPI
397 #endif
398
399 #ifdef _WIN32
400 # ifdef ELEMENTARY_BUILD
401 #  ifdef DLL_EXPORT
402 #   define EAPI __declspec(dllexport)
403 #  else
404 #   define EAPI
405 #  endif /* ! DLL_EXPORT */
406 # else
407 #  define EAPI __declspec(dllimport)
408 # endif /* ! EFL_EVAS_BUILD */
409 #else
410 # ifdef __GNUC__
411 #  if __GNUC__ >= 4
412 #   define EAPI __attribute__ ((visibility("default")))
413 #  else
414 #   define EAPI
415 #  endif
416 # else
417 #  define EAPI
418 # endif
419 #endif /* ! _WIN32 */
420
421 #ifdef _WIN32
422 # define EAPI_MAIN
423 #else
424 # define EAPI_MAIN EAPI
425 #endif
426
427 #define WILL_DEPRECATE /* API is deprecated in upstream EFL, will be deprecated in SLP soon */
428
429 /* allow usage from c++ */
430 #ifdef __cplusplus
431 extern "C" {
432 #endif
433
434 #define ELM_VERSION_MAJOR @VMAJ@
435 #define ELM_VERSION_MINOR @VMIN@
436
437    typedef struct _Elm_Version
438      {
439         int major;
440         int minor;
441         int micro;
442         int revision;
443      } Elm_Version;
444
445    EAPI extern Elm_Version *elm_version;
446
447 /* handy macros */
448 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
449 #define ELM_PI 3.14159265358979323846
450
451    /**
452     * @defgroup General General
453     *
454     * @brief General Elementary API. Functions that don't relate to
455     * Elementary objects specifically.
456     *
457     * Here are documented functions which init/shutdown the library,
458     * that apply to generic Elementary objects, that deal with
459     * configuration, et cetera.
460     *
461     * @ref general_functions_example_page "This" example contemplates
462     * some of these functions.
463     */
464
465    /**
466     * @addtogroup General
467     * @{
468     */
469
470   /**
471    * Defines couple of standard Evas_Object layers to be used
472    * with evas_object_layer_set().
473    *
474    * @note whenever extending with new values, try to keep some padding
475    *       to siblings so there is room for further extensions.
476    */
477   typedef enum _Elm_Object_Layer
478     {
479        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
480        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
481        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
482        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
483        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
484        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
485     } Elm_Object_Layer;
486
487 /**************************************************************************/
488    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
489
490    /**
491     * Emitted when any Elementary's policy value is changed.
492     */
493    EAPI extern int ELM_EVENT_POLICY_CHANGED;
494
495    /**
496     * @typedef Elm_Event_Policy_Changed
497     *
498     * Data on the event when an Elementary policy has changed
499     */
500     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
501
502    /**
503     * @struct _Elm_Event_Policy_Changed
504     *
505     * Data on the event when an Elementary policy has changed
506     */
507     struct _Elm_Event_Policy_Changed
508      {
509         unsigned int policy; /**< the policy identifier */
510         int          new_value; /**< value the policy had before the change */
511         int          old_value; /**< new value the policy got */
512     };
513
514    /**
515     * Policy identifiers.
516     */
517     typedef enum _Elm_Policy
518     {
519         ELM_POLICY_QUIT, /**< under which circumstances the application
520                           * should quit automatically. @see
521                           * Elm_Policy_Quit.
522                           */
523         ELM_POLICY_LAST
524     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
525  */
526
527    typedef enum _Elm_Policy_Quit
528      {
529         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
530                                    * automatically */
531         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
532                                             * application's last
533                                             * window is closed */
534      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
535
536    typedef enum _Elm_Focus_Direction
537      {
538         ELM_FOCUS_PREVIOUS,
539         ELM_FOCUS_NEXT
540      } Elm_Focus_Direction;
541
542    typedef enum _Elm_Text_Format
543      {
544         ELM_TEXT_FORMAT_PLAIN_UTF8,
545         ELM_TEXT_FORMAT_MARKUP_UTF8
546      } Elm_Text_Format;
547
548    /**
549     * Line wrapping types.
550     */
551    typedef enum _Elm_Wrap_Type
552      {
553         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557         ELM_WRAP_LAST
558      } Elm_Wrap_Type;
559
560    typedef enum
561      {
562         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
563         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
564         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
565         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
566         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
567         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
568         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
569         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
570         ELM_INPUT_PANEL_LAYOUT_INVALID
571      } Elm_Input_Panel_Layout;
572
573    typedef enum
574      {
575         ELM_AUTOCAPITAL_TYPE_NONE,
576         ELM_AUTOCAPITAL_TYPE_WORD,
577         ELM_AUTOCAPITAL_TYPE_SENTENCE,
578         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
579      } Elm_Autocapital_Type;
580
581    /**
582     * @typedef Elm_Object_Item
583     * An Elementary Object item handle.
584     * @ingroup General
585     */
586    typedef struct _Elm_Object_Item Elm_Object_Item;
587
588
589    /**
590     * Called back when a widget's tooltip is activated and needs content.
591     * @param data user-data given to elm_object_tooltip_content_cb_set()
592     * @param obj owner widget.
593     * @param tooltip The tooltip object (affix content to this!)
594     */
595    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
596
597    /**
598     * Called back when a widget's item tooltip is activated and needs content.
599     * @param data user-data given to elm_object_tooltip_content_cb_set()
600     * @param obj owner widget.
601     * @param tooltip The tooltip object (affix content to this!)
602     * @param item context dependent item. As an example, if tooltip was
603     *        set on Elm_List_Item, then it is of this type.
604     */
605    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
606
607    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
608
609 #ifndef ELM_LIB_QUICKLAUNCH
610 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
611 #else
612 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
613 #endif
614
615 /**************************************************************************/
616    /* General calls */
617
618    /**
619     * Initialize Elementary
620     *
621     * @param[in] argc System's argument count value
622     * @param[in] argv System's pointer to array of argument strings
623     * @return The init counter value.
624     *
625     * This function initializes Elementary and increments a counter of
626     * the number of calls to it. It returns the new counter's value.
627     *
628     * @warning This call is exported only for use by the @c ELM_MAIN()
629     * macro. There is no need to use this if you use this macro (which
630     * is highly advisable). An elm_main() should contain the entry
631     * point code for your application, having the same prototype as
632     * elm_init(), and @b not being static (putting the @c EAPI symbol
633     * in front of its type declaration is advisable). The @c
634     * ELM_MAIN() call should be placed just after it.
635     *
636     * Example:
637     * @dontinclude bg_example_01.c
638     * @skip static void
639     * @until ELM_MAIN
640     *
641     * See the full @ref bg_example_01_c "example".
642     *
643     * @see elm_shutdown().
644     * @ingroup General
645     */
646    EAPI int          elm_init(int argc, char **argv);
647
648    /**
649     * Shut down Elementary
650     *
651     * @return The init counter value.
652     *
653     * This should be called at the end of your application, just
654     * before it ceases to do any more processing. This will clean up
655     * any permanent resources your application may have allocated via
656     * Elementary that would otherwise persist.
657     *
658     * @see elm_init() for an example
659     *
660     * @ingroup General
661     */
662    EAPI int          elm_shutdown(void);
663
664    /**
665     * Run Elementary's main loop
666     *
667     * This call should be issued just after all initialization is
668     * completed. This function will not return until elm_exit() is
669     * called. It will keep looping, running the main
670     * (event/processing) loop for Elementary.
671     *
672     * @see elm_init() for an example
673     *
674     * @ingroup General
675     */
676    EAPI void         elm_run(void);
677
678    /**
679     * Exit Elementary's main loop
680     *
681     * If this call is issued, it will flag the main loop to cease
682     * processing and return back to its parent function (usually your
683     * elm_main() function).
684     *
685     * @see elm_init() for an example. There, just after a request to
686     * close the window comes, the main loop will be left.
687     *
688     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
689     * applications, you'll be able to get this function called automatically for you.
690     *
691     * @ingroup General
692     */
693    EAPI void         elm_exit(void);
694
695    /**
696     * Provide information in order to make Elementary determine the @b
697     * run time location of the software in question, so other data files
698     * such as images, sound files, executable utilities, libraries,
699     * modules and locale files can be found.
700     *
701     * @param mainfunc This is your application's main function name,
702     *        whose binary's location is to be found. Providing @c NULL
703     *        will make Elementary not to use it
704     * @param dom This will be used as the application's "domain", in the
705     *        form of a prefix to any environment variables that may
706     *        override prefix detection and the directory name, inside the
707     *        standard share or data directories, where the software's
708     *        data files will be looked for.
709     * @param checkfile This is an (optional) magic file's path to check
710     *        for existence (and it must be located in the data directory,
711     *        under the share directory provided above). Its presence will
712     *        help determine the prefix found was correct. Pass @c NULL if
713     *        the check is not to be done.
714     *
715     * This function allows one to re-locate the application somewhere
716     * else after compilation, if the developer wishes for easier
717     * distribution of pre-compiled binaries.
718     *
719     * The prefix system is designed to locate where the given software is
720     * installed (under a common path prefix) at run time and then report
721     * specific locations of this prefix and common directories inside
722     * this prefix like the binary, library, data and locale directories,
723     * through the @c elm_app_*_get() family of functions.
724     *
725     * Call elm_app_info_set() early on before you change working
726     * directory or anything about @c argv[0], so it gets accurate
727     * information.
728     *
729     * It will then try and trace back which file @p mainfunc comes from,
730     * if provided, to determine the application's prefix directory.
731     *
732     * The @p dom parameter provides a string prefix to prepend before
733     * environment variables, allowing a fallback to @b specific
734     * environment variables to locate the software. You would most
735     * probably provide a lowercase string there, because it will also
736     * serve as directory domain, explained next. For environment
737     * variables purposes, this string is made uppercase. For example if
738     * @c "myapp" is provided as the prefix, then the program would expect
739     * @c "MYAPP_PREFIX" as a master environment variable to specify the
740     * exact install prefix for the software, or more specific environment
741     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
742     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
743     * the user or scripts before launching. If not provided (@c NULL),
744     * environment variables will not be used to override compiled-in
745     * defaults or auto detections.
746     *
747     * The @p dom string also provides a subdirectory inside the system
748     * shared data directory for data files. For example, if the system
749     * directory is @c /usr/local/share, then this directory name is
750     * appended, creating @c /usr/local/share/myapp, if it @p was @c
751     * "myapp". It is expected that the application installs data files in
752     * this directory.
753     *
754     * The @p checkfile is a file name or path of something inside the
755     * share or data directory to be used to test that the prefix
756     * detection worked. For example, your app will install a wallpaper
757     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
758     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
759     * checkfile string.
760     *
761     * @see elm_app_compile_bin_dir_set()
762     * @see elm_app_compile_lib_dir_set()
763     * @see elm_app_compile_data_dir_set()
764     * @see elm_app_compile_locale_set()
765     * @see elm_app_prefix_dir_get()
766     * @see elm_app_bin_dir_get()
767     * @see elm_app_lib_dir_get()
768     * @see elm_app_data_dir_get()
769     * @see elm_app_locale_dir_get()
770     */
771    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
772
773    /**
774     * Provide information on the @b fallback application's binaries
775     * directory, in scenarios where they get overriden by
776     * elm_app_info_set().
777     *
778     * @param dir The path to the default binaries directory (compile time
779     * one)
780     *
781     * @note Elementary will as well use this path to determine actual
782     * names of binaries' directory paths, maybe changing it to be @c
783     * something/local/bin instead of @c something/bin, only, for
784     * example.
785     *
786     * @warning You should call this function @b before
787     * elm_app_info_set().
788     */
789    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
790
791    /**
792     * Provide information on the @b fallback application's libraries
793     * directory, on scenarios where they get overriden by
794     * elm_app_info_set().
795     *
796     * @param dir The path to the default libraries directory (compile
797     * time one)
798     *
799     * @note Elementary will as well use this path to determine actual
800     * names of libraries' directory paths, maybe changing it to be @c
801     * something/lib32 or @c something/lib64 instead of @c something/lib,
802     * only, for example.
803     *
804     * @warning You should call this function @b before
805     * elm_app_info_set().
806     */
807    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
808
809    /**
810     * Provide information on the @b fallback application's data
811     * directory, on scenarios where they get overriden by
812     * elm_app_info_set().
813     *
814     * @param dir The path to the default data directory (compile time
815     * one)
816     *
817     * @note Elementary will as well use this path to determine actual
818     * names of data directory paths, maybe changing it to be @c
819     * something/local/share instead of @c something/share, only, for
820     * example.
821     *
822     * @warning You should call this function @b before
823     * elm_app_info_set().
824     */
825    EAPI void         elm_app_compile_data_dir_set(const char *dir);
826
827    /**
828     * Provide information on the @b fallback application's locale
829     * directory, on scenarios where they get overriden by
830     * elm_app_info_set().
831     *
832     * @param dir The path to the default locale directory (compile time
833     * one)
834     *
835     * @warning You should call this function @b before
836     * elm_app_info_set().
837     */
838    EAPI void         elm_app_compile_locale_set(const char *dir);
839
840    /**
841     * Retrieve the application's run time prefix directory, as set by
842     * elm_app_info_set() and the way (environment) the application was
843     * run from.
844     *
845     * @return The directory prefix the application is actually using.
846     */
847    EAPI const char  *elm_app_prefix_dir_get(void);
848
849    /**
850     * Retrieve the application's run time binaries prefix directory, as
851     * set by elm_app_info_set() and the way (environment) the application
852     * was run from.
853     *
854     * @return The binaries directory prefix the application is actually
855     * using.
856     */
857    EAPI const char  *elm_app_bin_dir_get(void);
858
859    /**
860     * Retrieve the application's run time libraries prefix directory, as
861     * set by elm_app_info_set() and the way (environment) the application
862     * was run from.
863     *
864     * @return The libraries directory prefix the application is actually
865     * using.
866     */
867    EAPI const char  *elm_app_lib_dir_get(void);
868
869    /**
870     * Retrieve the application's run time data prefix directory, as
871     * set by elm_app_info_set() and the way (environment) the application
872     * was run from.
873     *
874     * @return The data directory prefix the application is actually
875     * using.
876     */
877    EAPI const char  *elm_app_data_dir_get(void);
878
879    /**
880     * Retrieve the application's run time locale prefix directory, as
881     * set by elm_app_info_set() and the way (environment) the application
882     * was run from.
883     *
884     * @return The locale directory prefix the application is actually
885     * using.
886     */
887    EAPI const char  *elm_app_locale_dir_get(void);
888
889    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
890    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
891    EAPI int          elm_quicklaunch_init(int argc, char **argv);
892    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
893    EAPI int          elm_quicklaunch_sub_shutdown(void);
894    EAPI int          elm_quicklaunch_shutdown(void);
895    EAPI void         elm_quicklaunch_seed(void);
896    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
897    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
898    EAPI void         elm_quicklaunch_cleanup(void);
899    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
900    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
901
902    EAPI Eina_Bool    elm_need_efreet(void);
903    EAPI Eina_Bool    elm_need_e_dbus(void);
904
905    /**
906     * This must be called before any other function that deals with
907     * elm_thumb objects or ethumb_client instances.
908     *
909     * @ingroup Thumb
910     */
911    EAPI Eina_Bool    elm_need_ethumb(void);
912
913    /**
914     * This must be called before any other function that deals with
915     * elm_web objects or ewk_view instances.
916     *
917     * @ingroup Web
918     */
919    EAPI Eina_Bool    elm_need_web(void);
920
921    /**
922     * Set a new policy's value (for a given policy group/identifier).
923     *
924     * @param policy policy identifier, as in @ref Elm_Policy.
925     * @param value policy value, which depends on the identifier
926     *
927     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
928     *
929     * Elementary policies define applications' behavior,
930     * somehow. These behaviors are divided in policy groups (see
931     * #Elm_Policy enumeration). This call will emit the Ecore event
932     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
933     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
934     * then.
935     *
936     * @note Currently, we have only one policy identifier/group
937     * (#ELM_POLICY_QUIT), which has two possible values.
938     *
939     * @ingroup General
940     */
941    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
942
943    /**
944     * Gets the policy value for given policy identifier.
945     *
946     * @param policy policy identifier, as in #Elm_Policy.
947     * @return The currently set policy value, for that
948     * identifier. Will be @c 0 if @p policy passed is invalid.
949     *
950     * @ingroup General
951     */
952    EAPI int          elm_policy_get(unsigned int policy);
953
954    /**
955     * Change the language of the current application
956     *
957     * The @p lang passed must be the full name of the locale to use, for
958     * example "en_US.utf8" or "es_ES@euro".
959     *
960     * Changing language with this function will make Elementary run through
961     * all its widgets, translating strings set with
962     * elm_object_domain_translatable_text_part_set(). This way, an entire
963     * UI can have its language changed without having to restart the program.
964     *
965     * For more complex cases, like having formatted strings that need
966     * translation, widgets will also emit a "language,changed" signal that
967     * the user can listen to to manually translate the text.
968     *
969     * @param lang Language to set, must be the full name of the locale
970     *
971     * @ingroup General
972     */
973    EAPI void         elm_language_set(const char *lang);
974
975    /**
976     * Set a label of an object
977     *
978     * @param obj The Elementary object
979     * @param part The text part name to set (NULL for the default label)
980     * @param label The new text of the label
981     *
982     * @note Elementary objects may have many labels (e.g. Action Slider)
983     * @deprecated Use elm_object_part_text_set() instead.
984     * @ingroup General
985     */
986    EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
987
988    /**
989     * Set a label of an object
990     *
991     * @param obj The Elementary object
992     * @param part The text part name to set (NULL for the default label)
993     * @param label The new text of the label
994     *
995     * @note Elementary objects may have many labels (e.g. Action Slider)
996     *
997     * @ingroup General
998     */
999    EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1000
1001 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1002
1003    /**
1004     * Get a label of an object
1005     *
1006     * @param obj The Elementary object
1007     * @param part The text part name to get (NULL for the default label)
1008     * @return text of the label or NULL for any error
1009     *
1010     * @note Elementary objects may have many labels (e.g. Action Slider)
1011     * @deprecated Use elm_object_part_text_get() instead.
1012     * @ingroup General
1013     */
1014    EINA_DEPRECATED EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1015
1016    /**
1017     * Get a label of an object
1018     *
1019     * @param obj The Elementary object
1020     * @param part The text part name to get (NULL for the default label)
1021     * @return text of the label or NULL for any error
1022     *
1023     * @note Elementary objects may have many labels (e.g. Action Slider)
1024     *
1025     * @ingroup General
1026     */
1027    EAPI const char  *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1028
1029 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1030
1031    /**
1032     * Set the text for an objects' part, marking it as translatable.
1033     *
1034     * The string to set as @p text must be the original one. Do not pass the
1035     * return of @c gettext() here. Elementary will translate the string
1036     * internally and set it on the object using elm_object_part_text_set(),
1037     * also storing the original string so that it can be automatically
1038     * translated when the language is changed with elm_language_set().
1039     *
1040     * The @p domain will be stored along to find the translation in the
1041     * correct catalog. It can be NULL, in which case it will use whatever
1042     * domain was set by the application with @c textdomain(). This is useful
1043     * in case you are building a library on top of Elementary that will have
1044     * its own translatable strings, that should not be mixed with those of
1045     * programs using the library.
1046     *
1047     * @param obj The object containing the text part
1048     * @param part The name of the part to set
1049     * @param domain The translation domain to use
1050     * @param text The original, non-translated text to set
1051     *
1052     * @ingroup General
1053     */
1054    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1055
1056 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1057
1058 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1059
1060    /**
1061     * Gets the original string set as translatable for an object
1062     *
1063     * When setting translated strings, the function elm_object_part_text_get()
1064     * will return the translation returned by @c gettext(). To get the
1065     * original string use this function.
1066     *
1067     * @param obj The object
1068     * @param part The name of the part that was set
1069     *
1070     * @return The original, untranslated string
1071     *
1072     * @ingroup General
1073     */
1074    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1075
1076 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1077
1078    /**
1079     * Set a content of an object
1080     *
1081     * @param obj The Elementary object
1082     * @param part The content part name to set (NULL for the default content)
1083     * @param content The new content of the object
1084     *
1085     * @note Elementary objects may have many contents
1086     * @deprecated Use elm_object_part_content_set instead.
1087     * @ingroup General
1088     */
1089    EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1090
1091    /**
1092     * Set a content of an object
1093     *
1094     * @param obj The Elementary object
1095     * @param part The content part name to set (NULL for the default content)
1096     * @param content The new content of the object
1097     *
1098     * @note Elementary objects may have many contents
1099     *
1100     * @ingroup General
1101     */
1102    EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1103
1104 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1105
1106    /**
1107     * Get a content of an object
1108     *
1109     * @param obj The Elementary object
1110     * @param item The content part name to get (NULL for the default content)
1111     * @return content of the object or NULL for any error
1112     *
1113     * @note Elementary objects may have many contents
1114     * @deprecated Use elm_object_part_content_get instead.
1115     * @ingroup General
1116     */
1117    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1118
1119    /**
1120     * Get a content of an object
1121     *
1122     * @param obj The Elementary object
1123     * @param item The content part name to get (NULL for the default content)
1124     * @return content of the object or NULL for any error
1125     *
1126     * @note Elementary objects may have many contents
1127     *
1128     * @ingroup General
1129     */
1130    EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1131
1132 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1133
1134    /**
1135     * Unset a content of an object
1136     *
1137     * @param obj The Elementary object
1138     * @param item The content part name to unset (NULL for the default content)
1139     *
1140     * @note Elementary objects may have many contents
1141     * @deprecated Use elm_object_part_content_unset instead.
1142     * @ingroup General
1143     */
1144    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1145
1146    /**
1147     * Unset a content of an object
1148     *
1149     * @param obj The Elementary object
1150     * @param item The content part name to unset (NULL for the default content)
1151     *
1152     * @note Elementary objects may have many contents
1153     *
1154     * @ingroup General
1155     */
1156    EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1157
1158 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1159
1160    /**
1161     * Set the text to read out when in accessibility mode
1162     *
1163     * @param obj The object which is to be described
1164     * @param txt The text that describes the widget to people with poor or no vision
1165     *
1166     * @ingroup General
1167     */
1168    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1169
1170    /**
1171     * Get the widget object's handle which contains a given item
1172     *
1173     * @param item The Elementary object item
1174     * @return The widget object
1175     *
1176     * @note This returns the widget object itself that an item belongs to.
1177     *
1178     * @ingroup General
1179     */
1180    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1181
1182    /**
1183     * Set a content of an object item
1184     *
1185     * @param it The Elementary object item
1186     * @param part The content part name to set (NULL for the default content)
1187     * @param content The new content of the object item
1188     *
1189     * @note Elementary object items may have many contents
1190     * @deprecated Use elm_object_item_part_content_set instead.
1191     * @ingroup General
1192     */
1193    EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1194
1195    /**
1196     * Set a content of an object item
1197     *
1198     * @param it The Elementary object item
1199     * @param part The content part name to set (NULL for the default content)
1200     * @param content The new content of the object item
1201     *
1202     * @note Elementary object items may have many contents
1203     *
1204     * @ingroup General
1205     */
1206    EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1207
1208 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1209
1210    /**
1211     * Get a content of an object item
1212     *
1213     * @param it The Elementary object item
1214     * @param part The content part name to unset (NULL for the default content)
1215     * @return content of the object item or NULL for any error
1216     *
1217     * @note Elementary object items may have many contents
1218     * @deprecated Use elm_object_item_part_content_get instead.
1219     * @ingroup General
1220     */
1221    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1222
1223    /**
1224     * Get a content of an object item
1225     *
1226     * @param it The Elementary object item
1227     * @param part The content part name to unset (NULL for the default content)
1228     * @return content of the object item or NULL for any error
1229     *
1230     * @note Elementary object items may have many contents
1231     *
1232     * @ingroup General
1233     */
1234    EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1235
1236 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1237
1238    /**
1239     * Unset a content of an object item
1240     *
1241     * @param it The Elementary object item
1242     * @param part The content part name to unset (NULL for the default content)
1243     *
1244     * @note Elementary object items may have many contents
1245     * @deprecated Use elm_object_item_part_content_unset instead.
1246     * @ingroup General
1247     */
1248    EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1249
1250    /**
1251     * Unset a content of an object item
1252     *
1253     * @param it The Elementary object item
1254     * @param part The content part name to unset (NULL for the default content)
1255     *
1256     * @note Elementary object items may have many contents
1257     *
1258     * @ingroup General
1259     */
1260    EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1261
1262 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1263
1264    /**
1265     * Set a label of an object item
1266     *
1267     * @param it The Elementary object item
1268     * @param part The text part name to set (NULL for the default label)
1269     * @param label The new text of the label
1270     *
1271     * @note Elementary object items may have many labels
1272     * @deprecated Use elm_object_item_part_text_set instead.
1273     * @ingroup General
1274     */
1275    WILL_DEPRECATE  EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1276
1277    /**
1278     * Set a label of an object item
1279     *
1280     * @param it The Elementary object item
1281     * @param part The text part name to set (NULL for the default label)
1282     * @param label The new text of the label
1283     *
1284     * @note Elementary object items may have many labels
1285     *
1286     * @ingroup General
1287     */
1288    EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1289
1290 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1291
1292    /**
1293     * Get a label of an object item
1294     *
1295     * @param it The Elementary object item
1296     * @param part The text part name to get (NULL for the default label)
1297     * @return text of the label or NULL for any error
1298     *
1299     * @note Elementary object items may have many labels
1300     * @deprecated Use elm_object_item_part_text_get instead.
1301     * @ingroup General
1302     */
1303    WILL_DEPRECATE  EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1304    /**
1305     * Get a label of an object item
1306     *
1307     * @param it The Elementary object item
1308     * @param part The text part name to get (NULL for the default label)
1309     * @return text of the label or NULL for any error
1310     *
1311     * @note Elementary object items may have many labels
1312     *
1313     * @ingroup General
1314     */
1315    EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1316
1317    /**
1318     * Set the text to read out when in accessibility mode
1319     *
1320     * @param obj The object which is to be described
1321     * @param txt The text that describes the widget to people with poor or no vision
1322     *
1323     * @ingroup General
1324     */
1325    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1326
1327    /**
1328     * Set the text to read out when in accessibility mode
1329     *
1330     * @param it The object item which is to be described
1331     * @param txt The text that describes the widget to people with poor or no vision
1332     *
1333     * @ingroup General
1334     */
1335    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1336
1337 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1338
1339    /**
1340     * Set the text to read out when in accessibility mode
1341     *
1342     * @param it The object item which is to be described
1343     * @param txt The text that describes the widget to people with poor or no vision
1344     *
1345     * @ingroup General
1346     */
1347    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1348
1349    /**
1350     * Get the data associated with an object item
1351     * @param it The Elementary object item
1352     * @return The data associated with @p it
1353     *
1354     * @ingroup General
1355     */
1356    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1357
1358    /**
1359     * Set the data associated with an object item
1360     * @param it The Elementary object item
1361     * @param data The data to be associated with @p it
1362     *
1363     * @ingroup General
1364     */
1365    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1366
1367    /**
1368     * Send a signal to the edje object of the widget item.
1369     *
1370     * This function sends a signal to the edje object of the obj item. An
1371     * edje program can respond to a signal by specifying matching
1372     * 'signal' and 'source' fields.
1373     *
1374     * @param it The Elementary object item
1375     * @param emission The signal's name.
1376     * @param source The signal's source.
1377     * @ingroup General
1378     */
1379    EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1380
1381    /**
1382     * Set the disabled state of an widget item.
1383     *
1384     * @param obj The Elementary object item
1385     * @param disabled The state to put in in: @c EINA_TRUE for
1386     *        disabled, @c EINA_FALSE for enabled
1387     *
1388     * Elementary object item can be @b disabled, in which state they won't
1389     * receive input and, in general, will be themed differently from
1390     * their normal state, usually greyed out. Useful for contexts
1391     * where you don't want your users to interact with some of the
1392     * parts of you interface.
1393     *
1394     * This sets the state for the widget item, either disabling it or
1395     * enabling it back.
1396     *
1397     * @ingroup Styles
1398     */
1399    EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1400
1401    /**
1402     * Get the disabled state of an widget item.
1403     *
1404     * @param obj The Elementary object
1405     * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1406     *            if it's enabled (or on errors)
1407     *
1408     * This gets the state of the widget, which might be enabled or disabled.
1409     *
1410     * @ingroup Styles
1411     */
1412    EAPI Eina_Bool    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1413
1414    /**
1415     * @}
1416     */
1417
1418    /**
1419     * @defgroup Caches Caches
1420     *
1421     * These are functions which let one fine-tune some cache values for
1422     * Elementary applications, thus allowing for performance adjustments.
1423     *
1424     * @{
1425     */
1426
1427    /**
1428     * @brief Flush all caches.
1429     *
1430     * Frees all data that was in cache and is not currently being used to reduce
1431     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1432     * to calling all of the following functions:
1433     * @li edje_file_cache_flush()
1434     * @li edje_collection_cache_flush()
1435     * @li eet_clearcache()
1436     * @li evas_image_cache_flush()
1437     * @li evas_font_cache_flush()
1438     * @li evas_render_dump()
1439     * @note Evas caches are flushed for every canvas associated with a window.
1440     *
1441     * @ingroup Caches
1442     */
1443    EAPI void         elm_all_flush(void);
1444
1445    /**
1446     * Get the configured cache flush interval time
1447     *
1448     * This gets the globally configured cache flush interval time, in
1449     * ticks
1450     *
1451     * @return The cache flush interval time
1452     * @ingroup Caches
1453     *
1454     * @see elm_all_flush()
1455     */
1456    EAPI int          elm_cache_flush_interval_get(void);
1457
1458    /**
1459     * Set the configured cache flush interval time
1460     *
1461     * This sets the globally configured cache flush interval time, in ticks
1462     *
1463     * @param size The cache flush interval time
1464     * @ingroup Caches
1465     *
1466     * @see elm_all_flush()
1467     */
1468    EAPI void         elm_cache_flush_interval_set(int size);
1469
1470    /**
1471     * Set the configured cache flush interval time for all applications on the
1472     * display
1473     *
1474     * This sets the globally configured cache flush interval time -- in ticks
1475     * -- for all applications on the display.
1476     *
1477     * @param size The cache flush interval time
1478     * @ingroup Caches
1479     */
1480    EAPI void         elm_cache_flush_interval_all_set(int size);
1481
1482    /**
1483     * Get the configured cache flush enabled state
1484     *
1485     * This gets the globally configured cache flush state - if it is enabled
1486     * or not. When cache flushing is enabled, elementary will regularly
1487     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1488     * memory and allow usage to re-seed caches and data in memory where it
1489     * can do so. An idle application will thus minimise its memory usage as
1490     * data will be freed from memory and not be re-loaded as it is idle and
1491     * not rendering or doing anything graphically right now.
1492     *
1493     * @return The cache flush state
1494     * @ingroup Caches
1495     *
1496     * @see elm_all_flush()
1497     */
1498    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1499
1500    /**
1501     * Set the configured cache flush enabled state
1502     *
1503     * This sets the globally configured cache flush enabled state.
1504     *
1505     * @param size The cache flush enabled state
1506     * @ingroup Caches
1507     *
1508     * @see elm_all_flush()
1509     */
1510    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1511
1512    /**
1513     * Set the configured cache flush enabled state for all applications on the
1514     * display
1515     *
1516     * This sets the globally configured cache flush enabled state for all
1517     * applications on the display.
1518     *
1519     * @param size The cache flush enabled state
1520     * @ingroup Caches
1521     */
1522    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1523
1524    /**
1525     * Get the configured font cache size
1526     *
1527     * This gets the globally configured font cache size, in bytes.
1528     *
1529     * @return The font cache size
1530     * @ingroup Caches
1531     */
1532    EAPI int          elm_font_cache_get(void);
1533
1534    /**
1535     * Set the configured font cache size
1536     *
1537     * This sets the globally configured font cache size, in bytes
1538     *
1539     * @param size The font cache size
1540     * @ingroup Caches
1541     */
1542    EAPI void         elm_font_cache_set(int size);
1543
1544    /**
1545     * Set the configured font cache size for all applications on the
1546     * display
1547     *
1548     * This sets the globally configured font cache size -- in bytes
1549     * -- for all applications on the display.
1550     *
1551     * @param size The font cache size
1552     * @ingroup Caches
1553     */
1554    EAPI void         elm_font_cache_all_set(int size);
1555
1556    /**
1557     * Get the configured image cache size
1558     *
1559     * This gets the globally configured image cache size, in bytes
1560     *
1561     * @return The image cache size
1562     * @ingroup Caches
1563     */
1564    EAPI int          elm_image_cache_get(void);
1565
1566    /**
1567     * Set the configured image cache size
1568     *
1569     * This sets the globally configured image cache size, in bytes
1570     *
1571     * @param size The image cache size
1572     * @ingroup Caches
1573     */
1574    EAPI void         elm_image_cache_set(int size);
1575
1576    /**
1577     * Set the configured image cache size for all applications on the
1578     * display
1579     *
1580     * This sets the globally configured image cache size -- in bytes
1581     * -- for all applications on the display.
1582     *
1583     * @param size The image cache size
1584     * @ingroup Caches
1585     */
1586    EAPI void         elm_image_cache_all_set(int size);
1587
1588    /**
1589     * Get the configured edje file cache size.
1590     *
1591     * This gets the globally configured edje file cache size, in number
1592     * of files.
1593     *
1594     * @return The edje file cache size
1595     * @ingroup Caches
1596     */
1597    EAPI int          elm_edje_file_cache_get(void);
1598
1599    /**
1600     * Set the configured edje file cache size
1601     *
1602     * This sets the globally configured edje file cache size, in number
1603     * of files.
1604     *
1605     * @param size The edje file cache size
1606     * @ingroup Caches
1607     */
1608    EAPI void         elm_edje_file_cache_set(int size);
1609
1610    /**
1611     * Set the configured edje file cache size for all applications on the
1612     * display
1613     *
1614     * This sets the globally configured edje file cache size -- in number
1615     * of files -- for all applications on the display.
1616     *
1617     * @param size The edje file cache size
1618     * @ingroup Caches
1619     */
1620    EAPI void         elm_edje_file_cache_all_set(int size);
1621
1622    /**
1623     * Get the configured edje collections (groups) cache size.
1624     *
1625     * This gets the globally configured edje collections cache size, in
1626     * number of collections.
1627     *
1628     * @return The edje collections cache size
1629     * @ingroup Caches
1630     */
1631    EAPI int          elm_edje_collection_cache_get(void);
1632
1633    /**
1634     * Set the configured edje collections (groups) cache size
1635     *
1636     * This sets the globally configured edje collections cache size, in
1637     * number of collections.
1638     *
1639     * @param size The edje collections cache size
1640     * @ingroup Caches
1641     */
1642    EAPI void         elm_edje_collection_cache_set(int size);
1643
1644    /**
1645     * Set the configured edje collections (groups) cache size for all
1646     * applications on the display
1647     *
1648     * This sets the globally configured edje collections cache size -- in
1649     * number of collections -- for all applications on the display.
1650     *
1651     * @param size The edje collections cache size
1652     * @ingroup Caches
1653     */
1654    EAPI void         elm_edje_collection_cache_all_set(int size);
1655
1656    /**
1657     * @}
1658     */
1659
1660    /**
1661     * @defgroup Scaling Widget Scaling
1662     *
1663     * Different widgets can be scaled independently. These functions
1664     * allow you to manipulate this scaling on a per-widget basis. The
1665     * object and all its children get their scaling factors multiplied
1666     * by the scale factor set. This is multiplicative, in that if a
1667     * child also has a scale size set it is in turn multiplied by its
1668     * parent's scale size. @c 1.0 means ā€œdon't scaleā€, @c 2.0 is
1669     * double size, @c 0.5 is half, etc.
1670     *
1671     * @ref general_functions_example_page "This" example contemplates
1672     * some of these functions.
1673     */
1674
1675    /**
1676     * Get the global scaling factor
1677     *
1678     * This gets the globally configured scaling factor that is applied to all
1679     * objects.
1680     *
1681     * @return The scaling factor
1682     * @ingroup Scaling
1683     */
1684    EAPI double       elm_scale_get(void);
1685
1686    /**
1687     * Set the global scaling factor
1688     *
1689     * This sets the globally configured scaling factor that is applied to all
1690     * objects.
1691     *
1692     * @param scale The scaling factor to set
1693     * @ingroup Scaling
1694     */
1695    EAPI void         elm_scale_set(double scale);
1696
1697    /**
1698     * Set the global scaling factor for all applications on the display
1699     *
1700     * This sets the globally configured scaling factor that is applied to all
1701     * objects for all applications.
1702     * @param scale The scaling factor to set
1703     * @ingroup Scaling
1704     */
1705    EAPI void         elm_scale_all_set(double scale);
1706
1707    /**
1708     * Set the scaling factor for a given Elementary object
1709     *
1710     * @param obj The Elementary to operate on
1711     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1712     * no scaling)
1713     *
1714     * @ingroup Scaling
1715     */
1716    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1717
1718    /**
1719     * Get the scaling factor for a given Elementary object
1720     *
1721     * @param obj The object
1722     * @return The scaling factor set by elm_object_scale_set()
1723     *
1724     * @ingroup Scaling
1725     */
1726    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1727
1728    /**
1729     * @defgroup Password_last_show Password last input show
1730     *
1731     * Last show feature of password mode enables user to view
1732     * the last input entered for few seconds before masking it.
1733     * These functions allow to set this feature in password mode
1734     * of entry widget and also allow to manipulate the duration
1735     * for which the input has to be visible.
1736     *
1737     * @{
1738     */
1739
1740    /**
1741     * Get show last setting of password mode.
1742     *
1743     * This gets the show last input setting of password mode which might be
1744     * enabled or disabled.
1745     *
1746     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1747     *            if it's disabled.
1748     * @ingroup Password_last_show
1749     */
1750    EAPI Eina_Bool elm_password_show_last_get(void);
1751
1752    /**
1753     * Set show last setting in password mode.
1754     *
1755     * This enables or disables show last setting of password mode.
1756     *
1757     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1758     * @see elm_password_show_last_timeout_set()
1759     * @ingroup Password_last_show
1760     */
1761    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1762
1763    /**
1764     * Get's the timeout value in last show password mode.
1765     *
1766     * This gets the time out value for which the last input entered in password
1767     * mode will be visible.
1768     *
1769     * @return The timeout value of last show password mode.
1770     * @ingroup Password_last_show
1771     */
1772    EAPI double elm_password_show_last_timeout_get(void);
1773
1774    /**
1775     * Set's the timeout value in last show password mode.
1776     *
1777     * This sets the time out value for which the last input entered in password
1778     * mode will be visible.
1779     *
1780     * @param password_show_last_timeout The timeout value.
1781     * @see elm_password_show_last_set()
1782     * @ingroup Password_last_show
1783     */
1784    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1785
1786    /**
1787     * @}
1788     */
1789
1790    /**
1791     * @defgroup UI-Mirroring Selective Widget mirroring
1792     *
1793     * These functions allow you to set ui-mirroring on specific
1794     * widgets or the whole interface. Widgets can be in one of two
1795     * modes, automatic and manual.  Automatic means they'll be changed
1796     * according to the system mirroring mode and manual means only
1797     * explicit changes will matter. You are not supposed to change
1798     * mirroring state of a widget set to automatic, will mostly work,
1799     * but the behavior is not really defined.
1800     *
1801     * @{
1802     */
1803
1804    EAPI Eina_Bool    elm_mirrored_get(void);
1805    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1806
1807    /**
1808     * Get the system mirrored mode. This determines the default mirrored mode
1809     * of widgets.
1810     *
1811     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1812     */
1813    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1814
1815    /**
1816     * Set the system mirrored mode. This determines the default mirrored mode
1817     * of widgets.
1818     *
1819     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1820     */
1821    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1822
1823    /**
1824     * Returns the widget's mirrored mode setting.
1825     *
1826     * @param obj The widget.
1827     * @return mirrored mode setting of the object.
1828     *
1829     **/
1830    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1831
1832    /**
1833     * Sets the widget's mirrored mode setting.
1834     * When widget in automatic mode, it follows the system mirrored mode set by
1835     * elm_mirrored_set().
1836     * @param obj The widget.
1837     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1838     */
1839    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1840
1841    /**
1842     * @}
1843     */
1844
1845    /**
1846     * Set the style to use by a widget
1847     *
1848     * Sets the style name that will define the appearance of a widget. Styles
1849     * vary from widget to widget and may also be defined by other themes
1850     * by means of extensions and overlays.
1851     *
1852     * @param obj The Elementary widget to style
1853     * @param style The style name to use
1854     *
1855     * @see elm_theme_extension_add()
1856     * @see elm_theme_extension_del()
1857     * @see elm_theme_overlay_add()
1858     * @see elm_theme_overlay_del()
1859     *
1860     * @ingroup Styles
1861     */
1862    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1863    /**
1864     * Get the style used by the widget
1865     *
1866     * This gets the style being used for that widget. Note that the string
1867     * pointer is only valid as longas the object is valid and the style doesn't
1868     * change.
1869     *
1870     * @param obj The Elementary widget to query for its style
1871     * @return The style name used
1872     *
1873     * @see elm_object_style_set()
1874     *
1875     * @ingroup Styles
1876     */
1877    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1878
1879    /**
1880     * @defgroup Styles Styles
1881     *
1882     * Widgets can have different styles of look. These generic API's
1883     * set styles of widgets, if they support them (and if the theme(s)
1884     * do).
1885     *
1886     * @ref general_functions_example_page "This" example contemplates
1887     * some of these functions.
1888     */
1889
1890    /**
1891     * Set the disabled state of an Elementary object.
1892     *
1893     * @param obj The Elementary object to operate on
1894     * @param disabled The state to put in in: @c EINA_TRUE for
1895     *        disabled, @c EINA_FALSE for enabled
1896     *
1897     * Elementary objects can be @b disabled, in which state they won't
1898     * receive input and, in general, will be themed differently from
1899     * their normal state, usually greyed out. Useful for contexts
1900     * where you don't want your users to interact with some of the
1901     * parts of you interface.
1902     *
1903     * This sets the state for the widget, either disabling it or
1904     * enabling it back.
1905     *
1906     * @ingroup Styles
1907     */
1908    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1909
1910    /**
1911     * Get the disabled state of an Elementary object.
1912     *
1913     * @param obj The Elementary object to operate on
1914     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1915     *            if it's enabled (or on errors)
1916     *
1917     * This gets the state of the widget, which might be enabled or disabled.
1918     *
1919     * @ingroup Styles
1920     */
1921    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1922
1923    /**
1924     * @defgroup WidgetNavigation Widget Tree Navigation.
1925     *
1926     * How to check if an Evas Object is an Elementary widget? How to
1927     * get the first elementary widget that is parent of the given
1928     * object?  These are all covered in widget tree navigation.
1929     *
1930     * @ref general_functions_example_page "This" example contemplates
1931     * some of these functions.
1932     */
1933
1934    /**
1935     * Check if the given Evas Object is an Elementary widget.
1936     *
1937     * @param obj the object to query.
1938     * @return @c EINA_TRUE if it is an elementary widget variant,
1939     *         @c EINA_FALSE otherwise
1940     * @ingroup WidgetNavigation
1941     */
1942    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1943
1944    /**
1945     * Get the first parent of the given object that is an Elementary
1946     * widget.
1947     *
1948     * @param obj the Elementary object to query parent from.
1949     * @return the parent object that is an Elementary widget, or @c
1950     *         NULL, if it was not found.
1951     *
1952     * Use this to query for an object's parent widget.
1953     *
1954     * @note Most of Elementary users wouldn't be mixing non-Elementary
1955     * smart objects in the objects tree of an application, as this is
1956     * an advanced usage of Elementary with Evas. So, except for the
1957     * application's window, which is the root of that tree, all other
1958     * objects would have valid Elementary widget parents.
1959     *
1960     * @ingroup WidgetNavigation
1961     */
1962    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1963
1964    /**
1965     * Get the top level parent of an Elementary widget.
1966     *
1967     * @param obj The object to query.
1968     * @return The top level Elementary widget, or @c NULL if parent cannot be
1969     * found.
1970     * @ingroup WidgetNavigation
1971     */
1972    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1973
1974    /**
1975     * Get the string that represents this Elementary widget.
1976     *
1977     * @note Elementary is weird and exposes itself as a single
1978     *       Evas_Object_Smart_Class of type "elm_widget", so
1979     *       evas_object_type_get() always return that, making debug and
1980     *       language bindings hard. This function tries to mitigate this
1981     *       problem, but the solution is to change Elementary to use
1982     *       proper inheritance.
1983     *
1984     * @param obj the object to query.
1985     * @return Elementary widget name, or @c NULL if not a valid widget.
1986     * @ingroup WidgetNavigation
1987     */
1988    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1989
1990    /**
1991     * @defgroup Config Elementary Config
1992     *
1993     * Elementary configuration is formed by a set options bounded to a
1994     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1995     * "finger size", etc. These are functions with which one syncronizes
1996     * changes made to those values to the configuration storing files, de
1997     * facto. You most probably don't want to use the functions in this
1998     * group unlees you're writing an elementary configuration manager.
1999     *
2000     * @{
2001     */
2002
2003    /**
2004     * Save back Elementary's configuration, so that it will persist on
2005     * future sessions.
2006     *
2007     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2008     * @ingroup Config
2009     *
2010     * This function will take effect -- thus, do I/O -- immediately. Use
2011     * it when you want to apply all configuration changes at once. The
2012     * current configuration set will get saved onto the current profile
2013     * configuration file.
2014     *
2015     */
2016    EAPI Eina_Bool    elm_config_save(void);
2017
2018    /**
2019     * Reload Elementary's configuration, bounded to current selected
2020     * profile.
2021     *
2022     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2023     * @ingroup Config
2024     *
2025     * Useful when you want to force reloading of configuration values for
2026     * a profile. If one removes user custom configuration directories,
2027     * for example, it will force a reload with system values instead.
2028     *
2029     */
2030    EAPI void         elm_config_reload(void);
2031
2032    /**
2033     * @}
2034     */
2035
2036    /**
2037     * @defgroup Profile Elementary Profile
2038     *
2039     * Profiles are pre-set options that affect the whole look-and-feel of
2040     * Elementary-based applications. There are, for example, profiles
2041     * aimed at desktop computer applications and others aimed at mobile,
2042     * touchscreen-based ones. You most probably don't want to use the
2043     * functions in this group unlees you're writing an elementary
2044     * configuration manager.
2045     *
2046     * @{
2047     */
2048
2049    /**
2050     * Get Elementary's profile in use.
2051     *
2052     * This gets the global profile that is applied to all Elementary
2053     * applications.
2054     *
2055     * @return The profile's name
2056     * @ingroup Profile
2057     */
2058    EAPI const char  *elm_profile_current_get(void);
2059
2060    /**
2061     * Get an Elementary's profile directory path in the filesystem. One
2062     * may want to fetch a system profile's dir or an user one (fetched
2063     * inside $HOME).
2064     *
2065     * @param profile The profile's name
2066     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2067     *                or a system one (@c EINA_FALSE)
2068     * @return The profile's directory path.
2069     * @ingroup Profile
2070     *
2071     * @note You must free it with elm_profile_dir_free().
2072     */
2073    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2074
2075    /**
2076     * Free an Elementary's profile directory path, as returned by
2077     * elm_profile_dir_get().
2078     *
2079     * @param p_dir The profile's path
2080     * @ingroup Profile
2081     *
2082     */
2083    EAPI void         elm_profile_dir_free(const char *p_dir);
2084
2085    /**
2086     * Get Elementary's list of available profiles.
2087     *
2088     * @return The profiles list. List node data are the profile name
2089     *         strings.
2090     * @ingroup Profile
2091     *
2092     * @note One must free this list, after usage, with the function
2093     *       elm_profile_list_free().
2094     */
2095    EAPI Eina_List   *elm_profile_list_get(void);
2096
2097    /**
2098     * Free Elementary's list of available profiles.
2099     *
2100     * @param l The profiles list, as returned by elm_profile_list_get().
2101     * @ingroup Profile
2102     *
2103     */
2104    EAPI void         elm_profile_list_free(Eina_List *l);
2105
2106    /**
2107     * Set Elementary's profile.
2108     *
2109     * This sets the global profile that is applied to Elementary
2110     * applications. Just the process the call comes from will be
2111     * affected.
2112     *
2113     * @param profile The profile's name
2114     * @ingroup Profile
2115     *
2116     */
2117    EAPI void         elm_profile_set(const char *profile);
2118
2119    /**
2120     * Set Elementary's profile.
2121     *
2122     * This sets the global profile that is applied to all Elementary
2123     * applications. All running Elementary windows will be affected.
2124     *
2125     * @param profile The profile's name
2126     * @ingroup Profile
2127     *
2128     */
2129    EAPI void         elm_profile_all_set(const char *profile);
2130
2131    /**
2132     * @}
2133     */
2134
2135    /**
2136     * @defgroup Engine Elementary Engine
2137     *
2138     * These are functions setting and querying which rendering engine
2139     * Elementary will use for drawing its windows' pixels.
2140     *
2141     * The following are the available engines:
2142     * @li "software_x11"
2143     * @li "fb"
2144     * @li "directfb"
2145     * @li "software_16_x11"
2146     * @li "software_8_x11"
2147     * @li "xrender_x11"
2148     * @li "opengl_x11"
2149     * @li "software_gdi"
2150     * @li "software_16_wince_gdi"
2151     * @li "sdl"
2152     * @li "software_16_sdl"
2153     * @li "opengl_sdl"
2154     * @li "buffer"
2155     * @li "ews"
2156     * @li "opengl_cocoa"
2157     * @li "psl1ght"
2158     *
2159     * @{
2160     */
2161
2162    /**
2163     * @brief Get Elementary's rendering engine in use.
2164     *
2165     * @return The rendering engine's name
2166     * @note there's no need to free the returned string, here.
2167     *
2168     * This gets the global rendering engine that is applied to all Elementary
2169     * applications.
2170     *
2171     * @see elm_engine_set()
2172     */
2173    EAPI const char  *elm_engine_current_get(void);
2174
2175    /**
2176     * @brief Set Elementary's rendering engine for use.
2177     *
2178     * @param engine The rendering engine's name
2179     *
2180     * This sets global rendering engine that is applied to all Elementary
2181     * applications. Note that it will take effect only to Elementary windows
2182     * created after this is called.
2183     *
2184     * @see elm_win_add()
2185     */
2186    EAPI void         elm_engine_set(const char *engine);
2187
2188    /**
2189     * @}
2190     */
2191
2192    /**
2193     * @defgroup Fonts Elementary Fonts
2194     *
2195     * These are functions dealing with font rendering, selection and the
2196     * like for Elementary applications. One might fetch which system
2197     * fonts are there to use and set custom fonts for individual classes
2198     * of UI items containing text (text classes).
2199     *
2200     * @{
2201     */
2202
2203   typedef struct _Elm_Text_Class
2204     {
2205        const char *name;
2206        const char *desc;
2207     } Elm_Text_Class;
2208
2209   typedef struct _Elm_Font_Overlay
2210     {
2211        const char     *text_class;
2212        const char     *font;
2213        Evas_Font_Size  size;
2214     } Elm_Font_Overlay;
2215
2216   typedef struct _Elm_Font_Properties
2217     {
2218        const char *name;
2219        Eina_List  *styles;
2220     } Elm_Font_Properties;
2221
2222    /**
2223     * Get Elementary's list of supported text classes.
2224     *
2225     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2226     * @ingroup Fonts
2227     *
2228     * Release the list with elm_text_classes_list_free().
2229     */
2230    EAPI const Eina_List     *elm_text_classes_list_get(void);
2231
2232    /**
2233     * Free Elementary's list of supported text classes.
2234     *
2235     * @ingroup Fonts
2236     *
2237     * @see elm_text_classes_list_get().
2238     */
2239    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2240
2241    /**
2242     * Get Elementary's list of font overlays, set with
2243     * elm_font_overlay_set().
2244     *
2245     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2246     * data.
2247     *
2248     * @ingroup Fonts
2249     *
2250     * For each text class, one can set a <b>font overlay</b> for it,
2251     * overriding the default font properties for that class coming from
2252     * the theme in use. There is no need to free this list.
2253     *
2254     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2255     */
2256    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2257
2258    /**
2259     * Set a font overlay for a given Elementary text class.
2260     *
2261     * @param text_class Text class name
2262     * @param font Font name and style string
2263     * @param size Font size
2264     *
2265     * @ingroup Fonts
2266     *
2267     * @p font has to be in the format returned by
2268     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2269     * and elm_font_overlay_unset().
2270     */
2271    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2272
2273    /**
2274     * Unset a font overlay for a given Elementary text class.
2275     *
2276     * @param text_class Text class name
2277     *
2278     * @ingroup Fonts
2279     *
2280     * This will bring back text elements belonging to text class
2281     * @p text_class back to their default font settings.
2282     */
2283    EAPI void                 elm_font_overlay_unset(const char *text_class);
2284
2285    /**
2286     * Apply the changes made with elm_font_overlay_set() and
2287     * elm_font_overlay_unset() on the current Elementary window.
2288     *
2289     * @ingroup Fonts
2290     *
2291     * This applies all font overlays set to all objects in the UI.
2292     */
2293    EAPI void                 elm_font_overlay_apply(void);
2294
2295    /**
2296     * Apply the changes made with elm_font_overlay_set() and
2297     * elm_font_overlay_unset() on all Elementary application windows.
2298     *
2299     * @ingroup Fonts
2300     *
2301     * This applies all font overlays set to all objects in the UI.
2302     */
2303    EAPI void                 elm_font_overlay_all_apply(void);
2304
2305    /**
2306     * Translate a font (family) name string in fontconfig's font names
2307     * syntax into an @c Elm_Font_Properties struct.
2308     *
2309     * @param font The font name and styles string
2310     * @return the font properties struct
2311     *
2312     * @ingroup Fonts
2313     *
2314     * @note The reverse translation can be achived with
2315     * elm_font_fontconfig_name_get(), for one style only (single font
2316     * instance, not family).
2317     */
2318    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2319
2320    /**
2321     * Free font properties return by elm_font_properties_get().
2322     *
2323     * @param efp the font properties struct
2324     *
2325     * @ingroup Fonts
2326     */
2327    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2328
2329    /**
2330     * Translate a font name, bound to a style, into fontconfig's font names
2331     * syntax.
2332     *
2333     * @param name The font (family) name
2334     * @param style The given style (may be @c NULL)
2335     *
2336     * @return the font name and style string
2337     *
2338     * @ingroup Fonts
2339     *
2340     * @note The reverse translation can be achived with
2341     * elm_font_properties_get(), for one style only (single font
2342     * instance, not family).
2343     */
2344    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2345
2346    /**
2347     * Free the font string return by elm_font_fontconfig_name_get().
2348     *
2349     * @param efp the font properties struct
2350     *
2351     * @ingroup Fonts
2352     */
2353    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2354
2355    /**
2356     * Create a font hash table of available system fonts.
2357     *
2358     * One must call it with @p list being the return value of
2359     * evas_font_available_list(). The hash will be indexed by font
2360     * (family) names, being its values @c Elm_Font_Properties blobs.
2361     *
2362     * @param list The list of available system fonts, as returned by
2363     * evas_font_available_list().
2364     * @return the font hash.
2365     *
2366     * @ingroup Fonts
2367     *
2368     * @note The user is supposed to get it populated at least with 3
2369     * default font families (Sans, Serif, Monospace), which should be
2370     * present on most systems.
2371     */
2372    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2373
2374    /**
2375     * Free the hash return by elm_font_available_hash_add().
2376     *
2377     * @param hash the hash to be freed.
2378     *
2379     * @ingroup Fonts
2380     */
2381    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2382
2383    /**
2384     * @}
2385     */
2386
2387    /**
2388     * @defgroup Fingers Fingers
2389     *
2390     * Elementary is designed to be finger-friendly for touchscreens,
2391     * and so in addition to scaling for display resolution, it can
2392     * also scale based on finger "resolution" (or size). You can then
2393     * customize the granularity of the areas meant to receive clicks
2394     * on touchscreens.
2395     *
2396     * Different profiles may have pre-set values for finger sizes.
2397     *
2398     * @ref general_functions_example_page "This" example contemplates
2399     * some of these functions.
2400     *
2401     * @{
2402     */
2403
2404    /**
2405     * Get the configured "finger size"
2406     *
2407     * @return The finger size
2408     *
2409     * This gets the globally configured finger size, <b>in pixels</b>
2410     *
2411     * @ingroup Fingers
2412     */
2413    EAPI Evas_Coord       elm_finger_size_get(void);
2414
2415    /**
2416     * Set the configured finger size
2417     *
2418     * This sets the globally configured finger size in pixels
2419     *
2420     * @param size The finger size
2421     * @ingroup Fingers
2422     */
2423    EAPI void             elm_finger_size_set(Evas_Coord size);
2424
2425    /**
2426     * Set the configured finger size for all applications on the display
2427     *
2428     * This sets the globally configured finger size in pixels for all
2429     * applications on the display
2430     *
2431     * @param size The finger size
2432     * @ingroup Fingers
2433     */
2434    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2435
2436    /**
2437     * @}
2438     */
2439
2440    /**
2441     * @defgroup Focus Focus
2442     *
2443     * An Elementary application has, at all times, one (and only one)
2444     * @b focused object. This is what determines where the input
2445     * events go to within the application's window. Also, focused
2446     * objects can be decorated differently, in order to signal to the
2447     * user where the input is, at a given moment.
2448     *
2449     * Elementary applications also have the concept of <b>focus
2450     * chain</b>: one can cycle through all the windows' focusable
2451     * objects by input (tab key) or programmatically. The default
2452     * focus chain for an application is the one define by the order in
2453     * which the widgets where added in code. One will cycle through
2454     * top level widgets, and, for each one containg sub-objects, cycle
2455     * through them all, before returning to the level
2456     * above. Elementary also allows one to set @b custom focus chains
2457     * for their applications.
2458     *
2459     * Besides the focused decoration a widget may exhibit, when it
2460     * gets focus, Elementary has a @b global focus highlight object
2461     * that can be enabled for a window. If one chooses to do so, this
2462     * extra highlight effect will surround the current focused object,
2463     * too.
2464     *
2465     * @note Some Elementary widgets are @b unfocusable, after
2466     * creation, by their very nature: they are not meant to be
2467     * interacted with input events, but are there just for visual
2468     * purposes.
2469     *
2470     * @ref general_functions_example_page "This" example contemplates
2471     * some of these functions.
2472     */
2473
2474    /**
2475     * Get the enable status of the focus highlight
2476     *
2477     * This gets whether the highlight on focused objects is enabled or not
2478     * @ingroup Focus
2479     */
2480    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2481
2482    /**
2483     * Set the enable status of the focus highlight
2484     *
2485     * Set whether to show or not the highlight on focused objects
2486     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2487     * @ingroup Focus
2488     */
2489    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2490
2491    /**
2492     * Get the enable status of the highlight animation
2493     *
2494     * Get whether the focus highlight, if enabled, will animate its switch from
2495     * one object to the next
2496     * @ingroup Focus
2497     */
2498    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2499
2500    /**
2501     * Set the enable status of the highlight animation
2502     *
2503     * Set whether the focus highlight, if enabled, will animate its switch from
2504     * one object to the next
2505     * @param animate Enable animation if EINA_TRUE, disable otherwise
2506     * @ingroup Focus
2507     */
2508    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2509
2510    /**
2511     * Get the whether an Elementary object has the focus or not.
2512     *
2513     * @param obj The Elementary object to get the information from
2514     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2515     *            not (and on errors).
2516     *
2517     * @see elm_object_focus_set()
2518     *
2519     * @ingroup Focus
2520     */
2521    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2522
2523    /**
2524     * Set/unset focus to a given Elementary object.
2525     *
2526     * @param obj The Elementary object to operate on.
2527     * @param enable @c EINA_TRUE Set focus to a given object,
2528     *               @c EINA_FALSE Unset focus to a given object.
2529     *
2530     * @note When you set focus to this object, if it can handle focus, will
2531     * take the focus away from the one who had it previously and will, for
2532     * now on, be the one receiving input events. Unsetting focus will remove
2533     * the focus from @p obj, passing it back to the previous element in the
2534     * focus chain list.
2535     *
2536     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2537     *
2538     * @ingroup Focus
2539     */
2540    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2541
2542    /**
2543     * Make a given Elementary object the focused one.
2544     *
2545     * @param obj The Elementary object to make focused.
2546     *
2547     * @note This object, if it can handle focus, will take the focus
2548     * away from the one who had it previously and will, for now on, be
2549     * the one receiving input events.
2550     *
2551     * @see elm_object_focus_get()
2552     * @deprecated use elm_object_focus_set() instead.
2553     *
2554     * @ingroup Focus
2555     */
2556    WILL_DEPRECATE  EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2557
2558    /**
2559     * Remove the focus from an Elementary object
2560     *
2561     * @param obj The Elementary to take focus from
2562     *
2563     * This removes the focus from @p obj, passing it back to the
2564     * previous element in the focus chain list.
2565     *
2566     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2567     * @deprecated use elm_object_focus_set() instead.
2568     *
2569     * @ingroup Focus
2570     */
2571    WILL_DEPRECATE  EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2572
2573    /**
2574     * Set the ability for an Element object to be focused
2575     *
2576     * @param obj The Elementary object to operate on
2577     * @param enable @c EINA_TRUE if the object can be focused, @c
2578     *        EINA_FALSE if not (and on errors)
2579     *
2580     * This sets whether the object @p obj is able to take focus or
2581     * not. Unfocusable objects do nothing when programmatically
2582     * focused, being the nearest focusable parent object the one
2583     * really getting focus. Also, when they receive mouse input, they
2584     * will get the event, but not take away the focus from where it
2585     * was previously.
2586     *
2587     * @ingroup Focus
2588     */
2589    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2590
2591    /**
2592     * Get whether an Elementary object is focusable or not
2593     *
2594     * @param obj The Elementary object to operate on
2595     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2596     *             EINA_FALSE if not (and on errors)
2597     *
2598     * @note Objects which are meant to be interacted with by input
2599     * events are created able to be focused, by default. All the
2600     * others are not.
2601     *
2602     * @ingroup Focus
2603     */
2604    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2605
2606    /**
2607     * Set custom focus chain.
2608     *
2609     * This function overwrites any previous custom focus chain within
2610     * the list of objects. The previous list will be deleted and this list
2611     * will be managed by elementary. After it is set, don't modify it.
2612     *
2613     * @note On focus cycle, only will be evaluated children of this container.
2614     *
2615     * @param obj The container object
2616     * @param objs Chain of objects to pass focus
2617     * @ingroup Focus
2618     */
2619    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2620
2621    /**
2622     * Unset a custom focus chain on a given Elementary widget
2623     *
2624     * @param obj The container object to remove focus chain from
2625     *
2626     * Any focus chain previously set on @p obj (for its child objects)
2627     * is removed entirely after this call.
2628     *
2629     * @ingroup Focus
2630     */
2631    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2632
2633    /**
2634     * Get custom focus chain
2635     *
2636     * @param obj The container object
2637     * @ingroup Focus
2638     */
2639    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2640
2641    /**
2642     * Append object to custom focus chain.
2643     *
2644     * @note If relative_child equal to NULL or not in custom chain, the object
2645     * will be added in end.
2646     *
2647     * @note On focus cycle, only will be evaluated children of this container.
2648     *
2649     * @param obj The container object
2650     * @param child The child to be added in custom chain
2651     * @param relative_child The relative object to position the child
2652     * @ingroup Focus
2653     */
2654    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2655
2656    /**
2657     * Prepend object to custom focus chain.
2658     *
2659     * @note If relative_child equal to NULL or not in custom chain, the object
2660     * will be added in begin.
2661     *
2662     * @note On focus cycle, only will be evaluated children of this container.
2663     *
2664     * @param obj The container object
2665     * @param child The child to be added in custom chain
2666     * @param relative_child The relative object to position the child
2667     * @ingroup Focus
2668     */
2669    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2670
2671    /**
2672     * Give focus to next object in object tree.
2673     *
2674     * Give focus to next object in focus chain of one object sub-tree.
2675     * If the last object of chain already have focus, the focus will go to the
2676     * first object of chain.
2677     *
2678     * @param obj The object root of sub-tree
2679     * @param dir Direction to cycle the focus
2680     *
2681     * @ingroup Focus
2682     */
2683    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2684
2685    /**
2686     * Give focus to near object in one direction.
2687     *
2688     * Give focus to near object in direction of one object.
2689     * If none focusable object in given direction, the focus will not change.
2690     *
2691     * @param obj The reference object
2692     * @param x Horizontal component of direction to focus
2693     * @param y Vertical component of direction to focus
2694     *
2695     * @ingroup Focus
2696     */
2697    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2698
2699    /**
2700     * Make the elementary object and its children to be unfocusable
2701     * (or focusable).
2702     *
2703     * @param obj The Elementary object to operate on
2704     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2705     *        @c EINA_FALSE for focusable.
2706     *
2707     * This sets whether the object @p obj and its children objects
2708     * are able to take focus or not. If the tree is set as unfocusable,
2709     * newest focused object which is not in this tree will get focus.
2710     * This API can be helpful for an object to be deleted.
2711     * When an object will be deleted soon, it and its children may not
2712     * want to get focus (by focus reverting or by other focus controls).
2713     * Then, just use this API before deleting.
2714     *
2715     * @see elm_object_tree_unfocusable_get()
2716     *
2717     * @ingroup Focus
2718     */
2719    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2720
2721    /**
2722     * Get whether an Elementary object and its children are unfocusable or not.
2723     *
2724     * @param obj The Elementary object to get the information from
2725     * @return @c EINA_TRUE, if the tree is unfocussable,
2726     *         @c EINA_FALSE if not (and on errors).
2727     *
2728     * @see elm_object_tree_unfocusable_set()
2729     *
2730     * @ingroup Focus
2731     */
2732    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2733
2734    /**
2735     * @defgroup Scrolling Scrolling
2736     *
2737     * These are functions setting how scrollable views in Elementary
2738     * widgets should behave on user interaction.
2739     *
2740     * @{
2741     */
2742
2743    /**
2744     * Get whether scrollers should bounce when they reach their
2745     * viewport's edge during a scroll.
2746     *
2747     * @return the thumb scroll bouncing state
2748     *
2749     * This is the default behavior for touch screens, in general.
2750     * @ingroup Scrolling
2751     */
2752    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2753
2754    /**
2755     * Set whether scrollers should bounce when they reach their
2756     * viewport's edge during a scroll.
2757     *
2758     * @param enabled the thumb scroll bouncing state
2759     *
2760     * @see elm_thumbscroll_bounce_enabled_get()
2761     * @ingroup Scrolling
2762     */
2763    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2764
2765    /**
2766     * Set whether scrollers should bounce when they reach their
2767     * viewport's edge during a scroll, for all Elementary application
2768     * windows.
2769     *
2770     * @param enabled the thumb scroll bouncing state
2771     *
2772     * @see elm_thumbscroll_bounce_enabled_get()
2773     * @ingroup Scrolling
2774     */
2775    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2776
2777    /**
2778     * Get the amount of inertia a scroller will impose at bounce
2779     * animations.
2780     *
2781     * @return the thumb scroll bounce friction
2782     *
2783     * @ingroup Scrolling
2784     */
2785    EAPI double           elm_scroll_bounce_friction_get(void);
2786
2787    /**
2788     * Set the amount of inertia a scroller will impose at bounce
2789     * animations.
2790     *
2791     * @param friction the thumb scroll bounce friction
2792     *
2793     * @see elm_thumbscroll_bounce_friction_get()
2794     * @ingroup Scrolling
2795     */
2796    EAPI void             elm_scroll_bounce_friction_set(double friction);
2797
2798    /**
2799     * Set the amount of inertia a scroller will impose at bounce
2800     * animations, for all Elementary application windows.
2801     *
2802     * @param friction the thumb scroll bounce friction
2803     *
2804     * @see elm_thumbscroll_bounce_friction_get()
2805     * @ingroup Scrolling
2806     */
2807    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2808
2809    /**
2810     * Get the amount of inertia a <b>paged</b> scroller will impose at
2811     * page fitting animations.
2812     *
2813     * @return the page scroll friction
2814     *
2815     * @ingroup Scrolling
2816     */
2817    EAPI double           elm_scroll_page_scroll_friction_get(void);
2818
2819    /**
2820     * Set the amount of inertia a <b>paged</b> scroller will impose at
2821     * page fitting animations.
2822     *
2823     * @param friction the page scroll friction
2824     *
2825     * @see elm_thumbscroll_page_scroll_friction_get()
2826     * @ingroup Scrolling
2827     */
2828    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2829
2830    /**
2831     * Set the amount of inertia a <b>paged</b> scroller will impose at
2832     * page fitting animations, for all Elementary application windows.
2833     *
2834     * @param friction the page scroll friction
2835     *
2836     * @see elm_thumbscroll_page_scroll_friction_get()
2837     * @ingroup Scrolling
2838     */
2839    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2840
2841    /**
2842     * Get the amount of inertia a scroller will impose at region bring
2843     * animations.
2844     *
2845     * @return the bring in scroll friction
2846     *
2847     * @ingroup Scrolling
2848     */
2849    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2850
2851    /**
2852     * Set the amount of inertia a scroller will impose at region bring
2853     * animations.
2854     *
2855     * @param friction the bring in scroll friction
2856     *
2857     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2858     * @ingroup Scrolling
2859     */
2860    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2861
2862    /**
2863     * Set the amount of inertia a scroller will impose at region bring
2864     * animations, for all Elementary application windows.
2865     *
2866     * @param friction the bring in scroll friction
2867     *
2868     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2869     * @ingroup Scrolling
2870     */
2871    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2872
2873    /**
2874     * Get the amount of inertia scrollers will impose at animations
2875     * triggered by Elementary widgets' zooming API.
2876     *
2877     * @return the zoom friction
2878     *
2879     * @ingroup Scrolling
2880     */
2881    EAPI double           elm_scroll_zoom_friction_get(void);
2882
2883    /**
2884     * Set the amount of inertia scrollers will impose at animations
2885     * triggered by Elementary widgets' zooming API.
2886     *
2887     * @param friction the zoom friction
2888     *
2889     * @see elm_thumbscroll_zoom_friction_get()
2890     * @ingroup Scrolling
2891     */
2892    EAPI void             elm_scroll_zoom_friction_set(double friction);
2893
2894    /**
2895     * Set the amount of inertia scrollers will impose at animations
2896     * triggered by Elementary widgets' zooming API, for all Elementary
2897     * application windows.
2898     *
2899     * @param friction the zoom friction
2900     *
2901     * @see elm_thumbscroll_zoom_friction_get()
2902     * @ingroup Scrolling
2903     */
2904    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2905
2906    /**
2907     * Get whether scrollers should be draggable from any point in their
2908     * views.
2909     *
2910     * @return the thumb scroll state
2911     *
2912     * @note This is the default behavior for touch screens, in general.
2913     * @note All other functions namespaced with "thumbscroll" will only
2914     *       have effect if this mode is enabled.
2915     *
2916     * @ingroup Scrolling
2917     */
2918    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2919
2920    /**
2921     * Set whether scrollers should be draggable from any point in their
2922     * views.
2923     *
2924     * @param enabled the thumb scroll state
2925     *
2926     * @see elm_thumbscroll_enabled_get()
2927     * @ingroup Scrolling
2928     */
2929    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2930
2931    /**
2932     * Set whether scrollers should be draggable from any point in their
2933     * views, for all Elementary application windows.
2934     *
2935     * @param enabled the thumb scroll state
2936     *
2937     * @see elm_thumbscroll_enabled_get()
2938     * @ingroup Scrolling
2939     */
2940    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2941
2942    /**
2943     * Get the number of pixels one should travel while dragging a
2944     * scroller's view to actually trigger scrolling.
2945     *
2946     * @return the thumb scroll threshould
2947     *
2948     * One would use higher values for touch screens, in general, because
2949     * of their inherent imprecision.
2950     * @ingroup Scrolling
2951     */
2952    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2953
2954    /**
2955     * Set the number of pixels one should travel while dragging a
2956     * scroller's view to actually trigger scrolling.
2957     *
2958     * @param threshold the thumb scroll threshould
2959     *
2960     * @see elm_thumbscroll_threshould_get()
2961     * @ingroup Scrolling
2962     */
2963    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2964
2965    /**
2966     * Set the number of pixels one should travel while dragging a
2967     * scroller's view to actually trigger scrolling, for all Elementary
2968     * application windows.
2969     *
2970     * @param threshold the thumb scroll threshould
2971     *
2972     * @see elm_thumbscroll_threshould_get()
2973     * @ingroup Scrolling
2974     */
2975    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2976
2977    /**
2978     * Get the minimum speed of mouse cursor movement which will trigger
2979     * list self scrolling animation after a mouse up event
2980     * (pixels/second).
2981     *
2982     * @return the thumb scroll momentum threshould
2983     *
2984     * @ingroup Scrolling
2985     */
2986    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2987
2988    /**
2989     * Set the minimum speed of mouse cursor movement which will trigger
2990     * list self scrolling animation after a mouse up event
2991     * (pixels/second).
2992     *
2993     * @param threshold the thumb scroll momentum threshould
2994     *
2995     * @see elm_thumbscroll_momentum_threshould_get()
2996     * @ingroup Scrolling
2997     */
2998    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2999
3000    /**
3001     * Set the minimum speed of mouse cursor movement which will trigger
3002     * list self scrolling animation after a mouse up event
3003     * (pixels/second), for all Elementary application windows.
3004     *
3005     * @param threshold the thumb scroll momentum threshould
3006     *
3007     * @see elm_thumbscroll_momentum_threshould_get()
3008     * @ingroup Scrolling
3009     */
3010    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3011
3012    /**
3013     * Get the amount of inertia a scroller will impose at self scrolling
3014     * animations.
3015     *
3016     * @return the thumb scroll friction
3017     *
3018     * @ingroup Scrolling
3019     */
3020    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3021
3022    /**
3023     * Set the amount of inertia a scroller will impose at self scrolling
3024     * animations.
3025     *
3026     * @param friction the thumb scroll friction
3027     *
3028     * @see elm_thumbscroll_friction_get()
3029     * @ingroup Scrolling
3030     */
3031    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3032
3033    /**
3034     * Set the amount of inertia a scroller will impose at self scrolling
3035     * animations, for all Elementary application windows.
3036     *
3037     * @param friction the thumb scroll friction
3038     *
3039     * @see elm_thumbscroll_friction_get()
3040     * @ingroup Scrolling
3041     */
3042    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3043
3044    /**
3045     * Get the amount of lag between your actual mouse cursor dragging
3046     * movement and a scroller's view movement itself, while pushing it
3047     * into bounce state manually.
3048     *
3049     * @return the thumb scroll border friction
3050     *
3051     * @ingroup Scrolling
3052     */
3053    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3054
3055    /**
3056     * Set the amount of lag between your actual mouse cursor dragging
3057     * movement and a scroller's view movement itself, while pushing it
3058     * into bounce state manually.
3059     *
3060     * @param friction the thumb scroll border friction. @c 0.0 for
3061     *        perfect synchrony between two movements, @c 1.0 for maximum
3062     *        lag.
3063     *
3064     * @see elm_thumbscroll_border_friction_get()
3065     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3066     *
3067     * @ingroup Scrolling
3068     */
3069    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3070
3071    /**
3072     * Set the amount of lag between your actual mouse cursor dragging
3073     * movement and a scroller's view movement itself, while pushing it
3074     * into bounce state manually, for all Elementary application windows.
3075     *
3076     * @param friction the thumb scroll border friction. @c 0.0 for
3077     *        perfect synchrony between two movements, @c 1.0 for maximum
3078     *        lag.
3079     *
3080     * @see elm_thumbscroll_border_friction_get()
3081     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3082     *
3083     * @ingroup Scrolling
3084     */
3085    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3086
3087    /**
3088     * Get the sensitivity amount which is be multiplied by the length of
3089     * mouse dragging.
3090     *
3091     * @return the thumb scroll sensitivity friction
3092     *
3093     * @ingroup Scrolling
3094     */
3095    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3096
3097    /**
3098     * Set the sensitivity amount which is be multiplied by the length of
3099     * mouse dragging.
3100     *
3101     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3102     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3103     *        is proper.
3104     *
3105     * @see elm_thumbscroll_sensitivity_friction_get()
3106     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3107     *
3108     * @ingroup Scrolling
3109     */
3110    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3111
3112    /**
3113     * Set the sensitivity amount which is be multiplied by the length of
3114     * mouse dragging, for all Elementary application windows.
3115     *
3116     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3117     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3118     *        is proper.
3119     *
3120     * @see elm_thumbscroll_sensitivity_friction_get()
3121     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3122     *
3123     * @ingroup Scrolling
3124     */
3125    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3126
3127    /**
3128     * @}
3129     */
3130
3131    /**
3132     * @defgroup Scrollhints Scrollhints
3133     *
3134     * Objects when inside a scroller can scroll, but this may not always be
3135     * desirable in certain situations. This allows an object to hint to itself
3136     * and parents to "not scroll" in one of 2 ways. If any child object of a
3137     * scroller has pushed a scroll freeze or hold then it affects all parent
3138     * scrollers until all children have released them.
3139     *
3140     * 1. To hold on scrolling. This means just flicking and dragging may no
3141     * longer scroll, but pressing/dragging near an edge of the scroller will
3142     * still scroll. This is automatically used by the entry object when
3143     * selecting text.
3144     *
3145     * 2. To totally freeze scrolling. This means it stops. until
3146     * popped/released.
3147     *
3148     * @{
3149     */
3150
3151    /**
3152     * Push the scroll hold by 1
3153     *
3154     * This increments the scroll hold count by one. If it is more than 0 it will
3155     * take effect on the parents of the indicated object.
3156     *
3157     * @param obj The object
3158     * @ingroup Scrollhints
3159     */
3160    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3161
3162    /**
3163     * Pop the scroll hold by 1
3164     *
3165     * This decrements the scroll hold count by one. If it is more than 0 it will
3166     * take effect on the parents of the indicated object.
3167     *
3168     * @param obj The object
3169     * @ingroup Scrollhints
3170     */
3171    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3172
3173    /**
3174     * Push the scroll freeze by 1
3175     *
3176     * This increments the scroll freeze count by one. If it is more
3177     * than 0 it will take effect on the parents of the indicated
3178     * object.
3179     *
3180     * @param obj The object
3181     * @ingroup Scrollhints
3182     */
3183    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3184
3185    /**
3186     * Pop the scroll freeze by 1
3187     *
3188     * This decrements the scroll freeze count by one. If it is more
3189     * than 0 it will take effect on the parents of the indicated
3190     * object.
3191     *
3192     * @param obj The object
3193     * @ingroup Scrollhints
3194     */
3195    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3196
3197    /**
3198     * Lock the scrolling of the given widget (and thus all parents)
3199     *
3200     * This locks the given object from scrolling in the X axis (and implicitly
3201     * also locks all parent scrollers too from doing the same).
3202     *
3203     * @param obj The object
3204     * @param lock The lock state (1 == locked, 0 == unlocked)
3205     * @ingroup Scrollhints
3206     */
3207    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3208
3209    /**
3210     * Lock the scrolling of the given widget (and thus all parents)
3211     *
3212     * This locks the given object from scrolling in the Y axis (and implicitly
3213     * also locks all parent scrollers too from doing the same).
3214     *
3215     * @param obj The object
3216     * @param lock The lock state (1 == locked, 0 == unlocked)
3217     * @ingroup Scrollhints
3218     */
3219    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3220
3221    /**
3222     * Get the scrolling lock of the given widget
3223     *
3224     * This gets the lock for X axis scrolling.
3225     *
3226     * @param obj The object
3227     * @ingroup Scrollhints
3228     */
3229    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3230
3231    /**
3232     * Get the scrolling lock of the given widget
3233     *
3234     * This gets the lock for X axis scrolling.
3235     *
3236     * @param obj The object
3237     * @ingroup Scrollhints
3238     */
3239    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3240
3241    /**
3242     * @}
3243     */
3244
3245    /**
3246     * Send a signal to the widget edje object.
3247     *
3248     * This function sends a signal to the edje object of the obj. An
3249     * edje program can respond to a signal by specifying matching
3250     * 'signal' and 'source' fields.
3251     *
3252     * @param obj The object
3253     * @param emission The signal's name.
3254     * @param source The signal's source.
3255     * @ingroup General
3256     */
3257    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3258
3259    /**
3260     * Add a callback for a signal emitted by widget edje object.
3261     *
3262     * This function connects a callback function to a signal emitted by the
3263     * edje object of the obj.
3264     * Globs can occur in either the emission or source name.
3265     *
3266     * @param obj The object
3267     * @param emission The signal's name.
3268     * @param source The signal's source.
3269     * @param func The callback function to be executed when the signal is
3270     * emitted.
3271     * @param data A pointer to data to pass in to the callback function.
3272     * @ingroup General
3273     */
3274    EAPI void             elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
3275
3276    /**
3277     * Remove a signal-triggered callback from a widget edje object.
3278     *
3279     * This function removes a callback, previoulsy attached to a
3280     * signal emitted by the edje object of the obj.  The parameters
3281     * emission, source and func must match exactly those passed to a
3282     * previous call to elm_object_signal_callback_add(). The data
3283     * pointer that was passed to this call will be returned.
3284     *
3285     * @param obj The object
3286     * @param emission The signal's name.
3287     * @param source The signal's source.
3288     * @param func The callback function to be executed when the signal is
3289     * emitted.
3290     * @return The data pointer
3291     * @ingroup General
3292     */
3293    EAPI void            *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
3294
3295    /**
3296     * Add a callback for input events (key up, key down, mouse wheel)
3297     * on a given Elementary widget
3298     *
3299     * @param obj The widget to add an event callback on
3300     * @param func The callback function to be executed when the event
3301     * happens
3302     * @param data Data to pass in to @p func
3303     *
3304     * Every widget in an Elementary interface set to receive focus,
3305     * with elm_object_focus_allow_set(), will propagate @b all of its
3306     * key up, key down and mouse wheel input events up to its parent
3307     * object, and so on. All of the focusable ones in this chain which
3308     * had an event callback set, with this call, will be able to treat
3309     * those events. There are two ways of making the propagation of
3310     * these event upwards in the tree of widgets to @b cease:
3311     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3312     *   the event was @b not processed, so the propagation will go on.
3313     * - The @c event_info pointer passed to @p func will contain the
3314     *   event's structure and, if you OR its @c event_flags inner
3315     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3316     *   one has already handled it, thus killing the event's
3317     *   propagation, too.
3318     *
3319     * @note Your event callback will be issued on those events taking
3320     * place only if no other child widget of @obj has consumed the
3321     * event already.
3322     *
3323     * @note Not to be confused with @c
3324     * evas_object_event_callback_add(), which will add event callbacks
3325     * per type on general Evas objects (no event propagation
3326     * infrastructure taken in account).
3327     *
3328     * @note Not to be confused with @c
3329     * elm_object_signal_callback_add(), which will add callbacks to @b
3330     * signals coming from a widget's theme, not input events.
3331     *
3332     * @note Not to be confused with @c
3333     * edje_object_signal_callback_add(), which does the same as
3334     * elm_object_signal_callback_add(), but directly on an Edje
3335     * object.
3336     *
3337     * @note Not to be confused with @c
3338     * evas_object_smart_callback_add(), which adds callbacks to smart
3339     * objects' <b>smart events</b>, and not input events.
3340     *
3341     * @see elm_object_event_callback_del()
3342     *
3343     * @ingroup General
3344     */
3345    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3346
3347    /**
3348     * Remove an event callback from a widget.
3349     *
3350     * This function removes a callback, previoulsy attached to event emission
3351     * by the @p obj.
3352     * The parameters func and data must match exactly those passed to
3353     * a previous call to elm_object_event_callback_add(). The data pointer that
3354     * was passed to this call will be returned.
3355     *
3356     * @param obj The object
3357     * @param func The callback function to be executed when the event is
3358     * emitted.
3359     * @param data Data to pass in to the callback function.
3360     * @return The data pointer
3361     * @ingroup General
3362     */
3363    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3364
3365    /**
3366     * Adjust size of an element for finger usage.
3367     *
3368     * @param times_w How many fingers should fit horizontally
3369     * @param w Pointer to the width size to adjust
3370     * @param times_h How many fingers should fit vertically
3371     * @param h Pointer to the height size to adjust
3372     *
3373     * This takes width and height sizes (in pixels) as input and a
3374     * size multiple (which is how many fingers you want to place
3375     * within the area, being "finger" the size set by
3376     * elm_finger_size_set()), and adjusts the size to be large enough
3377     * to accommodate the resulting size -- if it doesn't already
3378     * accommodate it. On return the @p w and @p h sizes pointed to by
3379     * these parameters will be modified, on those conditions.
3380     *
3381     * @note This is kind of a low level Elementary call, most useful
3382     * on size evaluation times for widgets. An external user wouldn't
3383     * be calling, most of the time.
3384     *
3385     * @ingroup Fingers
3386     */
3387    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3388
3389    /**
3390     * Get the duration for occuring long press event.
3391     *
3392     * @return Timeout for long press event
3393     * @ingroup Longpress
3394     */
3395    EAPI double           elm_longpress_timeout_get(void);
3396
3397    /**
3398     * Set the duration for occuring long press event.
3399     *
3400     * @param lonpress_timeout Timeout for long press event
3401     * @ingroup Longpress
3402     */
3403    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3404
3405    /**
3406     * @defgroup Debug Debug
3407     * don't use it unless you are sure
3408     *
3409     * @{
3410     */
3411
3412    /**
3413     * Print Tree object hierarchy in stdout
3414     *
3415     * @param obj The root object
3416     * @ingroup Debug
3417     */
3418    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3419    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3420
3421    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3422    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3423    /**
3424     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3425     *
3426     * @param obj The root object
3427     * @param file The path of output file
3428     * @ingroup Debug
3429     */
3430    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3431
3432    /**
3433     * @}
3434     */
3435
3436    /**
3437     * @defgroup Theme Theme
3438     *
3439     * Elementary uses Edje to theme its widgets, naturally. But for the most
3440     * part this is hidden behind a simpler interface that lets the user set
3441     * extensions and choose the style of widgets in a much easier way.
3442     *
3443     * Instead of thinking in terms of paths to Edje files and their groups
3444     * each time you want to change the appearance of a widget, Elementary
3445     * works so you can add any theme file with extensions or replace the
3446     * main theme at one point in the application, and then just set the style
3447     * of widgets with elm_object_style_set() and related functions. Elementary
3448     * will then look in its list of themes for a matching group and apply it,
3449     * and when the theme changes midway through the application, all widgets
3450     * will be updated accordingly.
3451     *
3452     * There are three concepts you need to know to understand how Elementary
3453     * theming works: default theme, extensions and overlays.
3454     *
3455     * Default theme, obviously enough, is the one that provides the default
3456     * look of all widgets. End users can change the theme used by Elementary
3457     * by setting the @c ELM_THEME environment variable before running an
3458     * application, or globally for all programs using the @c elementary_config
3459     * utility. Applications can change the default theme using elm_theme_set(),
3460     * but this can go against the user wishes, so it's not an adviced practice.
3461     *
3462     * Ideally, applications should find everything they need in the already
3463     * provided theme, but there may be occasions when that's not enough and
3464     * custom styles are required to correctly express the idea. For this
3465     * cases, Elementary has extensions.
3466     *
3467     * Extensions allow the application developer to write styles of its own
3468     * to apply to some widgets. This requires knowledge of how each widget
3469     * is themed, as extensions will always replace the entire group used by
3470     * the widget, so important signals and parts need to be there for the
3471     * object to behave properly (see documentation of Edje for details).
3472     * Once the theme for the extension is done, the application needs to add
3473     * it to the list of themes Elementary will look into, using
3474     * elm_theme_extension_add(), and set the style of the desired widgets as
3475     * he would normally with elm_object_style_set().
3476     *
3477     * Overlays, on the other hand, can replace the look of all widgets by
3478     * overriding the default style. Like extensions, it's up to the application
3479     * developer to write the theme for the widgets it wants, the difference
3480     * being that when looking for the theme, Elementary will check first the
3481     * list of overlays, then the set theme and lastly the list of extensions,
3482     * so with overlays it's possible to replace the default view and every
3483     * widget will be affected. This is very much alike to setting the whole
3484     * theme for the application and will probably clash with the end user
3485     * options, not to mention the risk of ending up with not matching styles
3486     * across the program. Unless there's a very special reason to use them,
3487     * overlays should be avoided for the resons exposed before.
3488     *
3489     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3490     * keeps one default internally and every function that receives one of
3491     * these can be called with NULL to refer to this default (except for
3492     * elm_theme_free()). It's possible to create a new instance of a
3493     * ::Elm_Theme to set other theme for a specific widget (and all of its
3494     * children), but this is as discouraged, if not even more so, than using
3495     * overlays. Don't use this unless you really know what you are doing.
3496     *
3497     * But to be less negative about things, you can look at the following
3498     * examples:
3499     * @li @ref theme_example_01 "Using extensions"
3500     * @li @ref theme_example_02 "Using overlays"
3501     *
3502     * @{
3503     */
3504    /**
3505     * @typedef Elm_Theme
3506     *
3507     * Opaque handler for the list of themes Elementary looks for when
3508     * rendering widgets.
3509     *
3510     * Stay out of this unless you really know what you are doing. For most
3511     * cases, sticking to the default is all a developer needs.
3512     */
3513    typedef struct _Elm_Theme Elm_Theme;
3514
3515    /**
3516     * Create a new specific theme
3517     *
3518     * This creates an empty specific theme that only uses the default theme. A
3519     * specific theme has its own private set of extensions and overlays too
3520     * (which are empty by default). Specific themes do not fall back to themes
3521     * of parent objects. They are not intended for this use. Use styles, overlays
3522     * and extensions when needed, but avoid specific themes unless there is no
3523     * other way (example: you want to have a preview of a new theme you are
3524     * selecting in a "theme selector" window. The preview is inside a scroller
3525     * and should display what the theme you selected will look like, but not
3526     * actually apply it yet. The child of the scroller will have a specific
3527     * theme set to show this preview before the user decides to apply it to all
3528     * applications).
3529     */
3530    EAPI Elm_Theme       *elm_theme_new(void);
3531    /**
3532     * Free a specific theme
3533     *
3534     * @param th The theme to free
3535     *
3536     * This frees a theme created with elm_theme_new().
3537     */
3538    EAPI void             elm_theme_free(Elm_Theme *th);
3539    /**
3540     * Copy the theme fom the source to the destination theme
3541     *
3542     * @param th The source theme to copy from
3543     * @param thdst The destination theme to copy data to
3544     *
3545     * This makes a one-time static copy of all the theme config, extensions
3546     * and overlays from @p th to @p thdst. If @p th references a theme, then
3547     * @p thdst is also set to reference it, with all the theme settings,
3548     * overlays and extensions that @p th had.
3549     */
3550    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3551    /**
3552     * Tell the source theme to reference the ref theme
3553     *
3554     * @param th The theme that will do the referencing
3555     * @param thref The theme that is the reference source
3556     *
3557     * This clears @p th to be empty and then sets it to refer to @p thref
3558     * so @p th acts as an override to @p thref, but where its overrides
3559     * don't apply, it will fall through to @p thref for configuration.
3560     */
3561    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3562    /**
3563     * Return the theme referred to
3564     *
3565     * @param th The theme to get the reference from
3566     * @return The referenced theme handle
3567     *
3568     * This gets the theme set as the reference theme by elm_theme_ref_set().
3569     * If no theme is set as a reference, NULL is returned.
3570     */
3571    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3572    /**
3573     * Return the default theme
3574     *
3575     * @return The default theme handle
3576     *
3577     * This returns the internal default theme setup handle that all widgets
3578     * use implicitly unless a specific theme is set. This is also often use
3579     * as a shorthand of NULL.
3580     */
3581    EAPI Elm_Theme       *elm_theme_default_get(void);
3582    /**
3583     * Prepends a theme overlay to the list of overlays
3584     *
3585     * @param th The theme to add to, or if NULL, the default theme
3586     * @param item The Edje file path to be used
3587     *
3588     * Use this if your application needs to provide some custom overlay theme
3589     * (An Edje file that replaces some default styles of widgets) where adding
3590     * new styles, or changing system theme configuration is not possible. Do
3591     * NOT use this instead of a proper system theme configuration. Use proper
3592     * configuration files, profiles, environment variables etc. to set a theme
3593     * so that the theme can be altered by simple confiugration by a user. Using
3594     * this call to achieve that effect is abusing the API and will create lots
3595     * of trouble.
3596     *
3597     * @see elm_theme_extension_add()
3598     */
3599    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3600    /**
3601     * Delete a theme overlay from the list of overlays
3602     *
3603     * @param th The theme to delete from, or if NULL, the default theme
3604     * @param item The name of the theme overlay
3605     *
3606     * @see elm_theme_overlay_add()
3607     */
3608    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3609    /**
3610     * Appends a theme extension to the list of extensions.
3611     *
3612     * @param th The theme to add to, or if NULL, the default theme
3613     * @param item The Edje file path to be used
3614     *
3615     * This is intended when an application needs more styles of widgets or new
3616     * widget themes that the default does not provide (or may not provide). The
3617     * application has "extended" usage by coming up with new custom style names
3618     * for widgets for specific uses, but as these are not "standard", they are
3619     * not guaranteed to be provided by a default theme. This means the
3620     * application is required to provide these extra elements itself in specific
3621     * Edje files. This call adds one of those Edje files to the theme search
3622     * path to be search after the default theme. The use of this call is
3623     * encouraged when default styles do not meet the needs of the application.
3624     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3625     *
3626     * @see elm_object_style_set()
3627     */
3628    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3629    /**
3630     * Deletes a theme extension from the list of extensions.
3631     *
3632     * @param th The theme to delete from, or if NULL, the default theme
3633     * @param item The name of the theme extension
3634     *
3635     * @see elm_theme_extension_add()
3636     */
3637    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3638    /**
3639     * Set the theme search order for the given theme
3640     *
3641     * @param th The theme to set the search order, or if NULL, the default theme
3642     * @param theme Theme search string
3643     *
3644     * This sets the search string for the theme in path-notation from first
3645     * theme to search, to last, delimited by the : character. Example:
3646     *
3647     * "shiny:/path/to/file.edj:default"
3648     *
3649     * See the ELM_THEME environment variable for more information.
3650     *
3651     * @see elm_theme_get()
3652     * @see elm_theme_list_get()
3653     */
3654    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3655    /**
3656     * Return the theme search order
3657     *
3658     * @param th The theme to get the search order, or if NULL, the default theme
3659     * @return The internal search order path
3660     *
3661     * This function returns a colon separated string of theme elements as
3662     * returned by elm_theme_list_get().
3663     *
3664     * @see elm_theme_set()
3665     * @see elm_theme_list_get()
3666     */
3667    EAPI const char      *elm_theme_get(Elm_Theme *th);
3668    /**
3669     * Return a list of theme elements to be used in a theme.
3670     *
3671     * @param th Theme to get the list of theme elements from.
3672     * @return The internal list of theme elements
3673     *
3674     * This returns the internal list of theme elements (will only be valid as
3675     * long as the theme is not modified by elm_theme_set() or theme is not
3676     * freed by elm_theme_free(). This is a list of strings which must not be
3677     * altered as they are also internal. If @p th is NULL, then the default
3678     * theme element list is returned.
3679     *
3680     * A theme element can consist of a full or relative path to a .edj file,
3681     * or a name, without extension, for a theme to be searched in the known
3682     * theme paths for Elemementary.
3683     *
3684     * @see elm_theme_set()
3685     * @see elm_theme_get()
3686     */
3687    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3688    /**
3689     * Return the full patrh for a theme element
3690     *
3691     * @param f The theme element name
3692     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3693     * @return The full path to the file found.
3694     *
3695     * This returns a string you should free with free() on success, NULL on
3696     * failure. This will search for the given theme element, and if it is a
3697     * full or relative path element or a simple searchable name. The returned
3698     * path is the full path to the file, if searched, and the file exists, or it
3699     * is simply the full path given in the element or a resolved path if
3700     * relative to home. The @p in_search_path boolean pointed to is set to
3701     * EINA_TRUE if the file was a searchable file andis in the search path,
3702     * and EINA_FALSE otherwise.
3703     */
3704    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3705    /**
3706     * Flush the current theme.
3707     *
3708     * @param th Theme to flush
3709     *
3710     * This flushes caches that let elementary know where to find theme elements
3711     * in the given theme. If @p th is NULL, then the default theme is flushed.
3712     * Call this function if source theme data has changed in such a way as to
3713     * make any caches Elementary kept invalid.
3714     */
3715    EAPI void             elm_theme_flush(Elm_Theme *th);
3716    /**
3717     * This flushes all themes (default and specific ones).
3718     *
3719     * This will flush all themes in the current application context, by calling
3720     * elm_theme_flush() on each of them.
3721     */
3722    EAPI void             elm_theme_full_flush(void);
3723    /**
3724     * Set the theme for all elementary using applications on the current display
3725     *
3726     * @param theme The name of the theme to use. Format same as the ELM_THEME
3727     * environment variable.
3728     */
3729    EAPI void             elm_theme_all_set(const char *theme);
3730    /**
3731     * Return a list of theme elements in the theme search path
3732     *
3733     * @return A list of strings that are the theme element names.
3734     *
3735     * This lists all available theme files in the standard Elementary search path
3736     * for theme elements, and returns them in alphabetical order as theme
3737     * element names in a list of strings. Free this with
3738     * elm_theme_name_available_list_free() when you are done with the list.
3739     */
3740    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3741    /**
3742     * Free the list returned by elm_theme_name_available_list_new()
3743     *
3744     * This frees the list of themes returned by
3745     * elm_theme_name_available_list_new(). Once freed the list should no longer
3746     * be used. a new list mys be created.
3747     */
3748    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3749    /**
3750     * Set a specific theme to be used for this object and its children
3751     *
3752     * @param obj The object to set the theme on
3753     * @param th The theme to set
3754     *
3755     * This sets a specific theme that will be used for the given object and any
3756     * child objects it has. If @p th is NULL then the theme to be used is
3757     * cleared and the object will inherit its theme from its parent (which
3758     * ultimately will use the default theme if no specific themes are set).
3759     *
3760     * Use special themes with great care as this will annoy users and make
3761     * configuration difficult. Avoid any custom themes at all if it can be
3762     * helped.
3763     */
3764    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3765    /**
3766     * Get the specific theme to be used
3767     *
3768     * @param obj The object to get the specific theme from
3769     * @return The specifc theme set.
3770     *
3771     * This will return a specific theme set, or NULL if no specific theme is
3772     * set on that object. It will not return inherited themes from parents, only
3773     * the specific theme set for that specific object. See elm_object_theme_set()
3774     * for more information.
3775     */
3776    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3777
3778    /**
3779     * Get a data item from a theme
3780     *
3781     * @param th The theme, or NULL for default theme
3782     * @param key The data key to search with
3783     * @return The data value, or NULL on failure
3784     *
3785     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3786     * It works the same way as edje_file_data_get() except that the return is stringshared.
3787     */
3788    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3789    /**
3790     * @}
3791     */
3792
3793    /* win */
3794    /** @defgroup Win Win
3795     *
3796     * @image html img/widget/win/preview-00.png
3797     * @image latex img/widget/win/preview-00.eps
3798     *
3799     * The window class of Elementary.  Contains functions to manipulate
3800     * windows. The Evas engine used to render the window contents is specified
3801     * in the system or user elementary config files (whichever is found last),
3802     * and can be overridden with the ELM_ENGINE environment variable for
3803     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3804     * compilation setup and modules actually installed at runtime) are (listed
3805     * in order of best supported and most likely to be complete and work to
3806     * lowest quality).
3807     *
3808     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3809     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3810     * rendering in X11)
3811     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3812     * exits)
3813     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3814     * rendering)
3815     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3816     * buffer)
3817     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3818     * rendering using SDL as the buffer)
3819     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3820     * GDI with software)
3821     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3822     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3823     * grayscale using dedicated 8bit software engine in X11)
3824     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3825     * X11 using 16bit software engine)
3826     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3827     * (Windows CE rendering via GDI with 16bit software renderer)
3828     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3829     * buffer with 16bit software renderer)
3830     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3831     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3832     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3833     *
3834     * All engines use a simple string to select the engine to render, EXCEPT
3835     * the "shot" engine. This actually encodes the output of the virtual
3836     * screenshot and how long to delay in the engine string. The engine string
3837     * is encoded in the following way:
3838     *
3839     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3840     *
3841     * Where options are separated by a ":" char if more than one option is
3842     * given, with delay, if provided being the first option and file the last
3843     * (order is important). The delay specifies how long to wait after the
3844     * window is shown before doing the virtual "in memory" rendering and then
3845     * save the output to the file specified by the file option (and then exit).
3846     * If no delay is given, the default is 0.5 seconds. If no file is given the
3847     * default output file is "out.png". Repeat option is for continous
3848     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3849     * fixed to "out001.png" Some examples of using the shot engine:
3850     *
3851     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3852     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3853     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3854     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3855     *   ELM_ENGINE="shot:" elementary_test
3856     *
3857     * Signals that you can add callbacks for are:
3858     *
3859     * @li "delete,request": the user requested to close the window. See
3860     * elm_win_autodel_set().
3861     * @li "focus,in": window got focus
3862     * @li "focus,out": window lost focus
3863     * @li "moved": window that holds the canvas was moved
3864     *
3865     * Examples:
3866     * @li @ref win_example_01
3867     *
3868     * @{
3869     */
3870    /**
3871     * Defines the types of window that can be created
3872     *
3873     * These are hints set on the window so that a running Window Manager knows
3874     * how the window should be handled and/or what kind of decorations it
3875     * should have.
3876     *
3877     * Currently, only the X11 backed engines use them.
3878     */
3879    typedef enum _Elm_Win_Type
3880      {
3881         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3882                          window. Almost every window will be created with this
3883                          type. */
3884         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3885         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3886                            window holding desktop icons. */
3887         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3888                         be kept on top of any other window by the Window
3889                         Manager. */
3890         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3891                            similar. */
3892         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3893         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3894                            pallete. */
3895         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3896         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3897                                  entry in a menubar is clicked. Typically used
3898                                  with elm_win_override_set(). This hint exists
3899                                  for completion only, as the EFL way of
3900                                  implementing a menu would not normally use a
3901                                  separate window for its contents. */
3902         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3903                               triggered by right-clicking an object. */
3904         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3905                            explanatory text that typically appear after the
3906                            mouse cursor hovers over an object for a while.
3907                            Typically used with elm_win_override_set() and also
3908                            not very commonly used in the EFL. */
3909         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3910                                 battery life or a new E-Mail received. */
3911         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3912                          usually used in the EFL. */
3913         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3914                        object being dragged across different windows, or even
3915                        applications. Typically used with
3916                        elm_win_override_set(). */
3917         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3918                                  buffer. No actual window is created for this
3919                                  type, instead the window and all of its
3920                                  contents will be rendered to an image buffer.
3921                                  This allows to have children window inside a
3922                                  parent one just like any other object would
3923                                  be, and do other things like applying @c
3924                                  Evas_Map effects to it. This is the only type
3925                                  of window that requires the @c parent
3926                                  parameter of elm_win_add() to be a valid @c
3927                                  Evas_Object. */
3928      } Elm_Win_Type;
3929
3930    /**
3931     * The differents layouts that can be requested for the virtual keyboard.
3932     *
3933     * When the application window is being managed by Illume, it may request
3934     * any of the following layouts for the virtual keyboard.
3935     */
3936    typedef enum _Elm_Win_Keyboard_Mode
3937      {
3938         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3939         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3940         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3941         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3942         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3943         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3944         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3945         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3946         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3947         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3948         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3949         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3950         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3951         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3952         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3953         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3954      } Elm_Win_Keyboard_Mode;
3955
3956    /**
3957     * Available commands that can be sent to the Illume manager.
3958     *
3959     * When running under an Illume session, a window may send commands to the
3960     * Illume manager to perform different actions.
3961     */
3962    typedef enum _Elm_Illume_Command
3963      {
3964         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3965                                          window */
3966         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3967                                             in the list */
3968         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3969                                          screen */
3970         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3971      } Elm_Illume_Command;
3972
3973    /**
3974     * Adds a window object. If this is the first window created, pass NULL as
3975     * @p parent.
3976     *
3977     * @param parent Parent object to add the window to, or NULL
3978     * @param name The name of the window
3979     * @param type The window type, one of #Elm_Win_Type.
3980     *
3981     * The @p parent paramter can be @c NULL for every window @p type except
3982     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3983     * which the image object will be created.
3984     *
3985     * @return The created object, or NULL on failure
3986     */
3987    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3988    /**
3989     * Adds a window object with standard setup
3990     *
3991     * @param name The name of the window
3992     * @param title The title for the window
3993     *
3994     * This creates a window like elm_win_add() but also puts in a standard
3995     * background with elm_bg_add(), as well as setting the window title to
3996     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3997     * as the parent widget.
3998     * 
3999     * @return The created object, or NULL on failure
4000     *
4001     * @see elm_win_add()
4002     */
4003    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4004    /**
4005     * Add @p subobj as a resize object of window @p obj.
4006     *
4007     *
4008     * Setting an object as a resize object of the window means that the
4009     * @p subobj child's size and position will be controlled by the window
4010     * directly. That is, the object will be resized to match the window size
4011     * and should never be moved or resized manually by the developer.
4012     *
4013     * In addition, resize objects of the window control what the minimum size
4014     * of it will be, as well as whether it can or not be resized by the user.
4015     *
4016     * For the end user to be able to resize a window by dragging the handles
4017     * or borders provided by the Window Manager, or using any other similar
4018     * mechanism, all of the resize objects in the window should have their
4019     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4020     *
4021     * @param obj The window object
4022     * @param subobj The resize object to add
4023     */
4024    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4025    /**
4026     * Delete @p subobj as a resize object of window @p obj.
4027     *
4028     * This function removes the object @p subobj from the resize objects of
4029     * the window @p obj. It will not delete the object itself, which will be
4030     * left unmanaged and should be deleted by the developer, manually handled
4031     * or set as child of some other container.
4032     *
4033     * @param obj The window object
4034     * @param subobj The resize object to add
4035     */
4036    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4037    /**
4038     * Set the title of the window
4039     *
4040     * @param obj The window object
4041     * @param title The title to set
4042     */
4043    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4044    /**
4045     * Get the title of the window
4046     *
4047     * The returned string is an internal one and should not be freed or
4048     * modified. It will also be rendered invalid if a new title is set or if
4049     * the window is destroyed.
4050     *
4051     * @param obj The window object
4052     * @return The title
4053     */
4054    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4055    /**
4056     * Set the window's autodel state.
4057     *
4058     * When closing the window in any way outside of the program control, like
4059     * pressing the X button in the titlebar or using a command from the
4060     * Window Manager, a "delete,request" signal is emitted to indicate that
4061     * this event occurred and the developer can take any action, which may
4062     * include, or not, destroying the window object.
4063     *
4064     * When the @p autodel parameter is set, the window will be automatically
4065     * destroyed when this event occurs, after the signal is emitted.
4066     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4067     * and is up to the program to do so when it's required.
4068     *
4069     * @param obj The window object
4070     * @param autodel If true, the window will automatically delete itself when
4071     * closed
4072     */
4073    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4074    /**
4075     * Get the window's autodel state.
4076     *
4077     * @param obj The window object
4078     * @return If the window will automatically delete itself when closed
4079     *
4080     * @see elm_win_autodel_set()
4081     */
4082    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4083    /**
4084     * Activate a window object.
4085     *
4086     * This function sends a request to the Window Manager to activate the
4087     * window pointed by @p obj. If honored by the WM, the window will receive
4088     * the keyboard focus.
4089     *
4090     * @note This is just a request that a Window Manager may ignore, so calling
4091     * this function does not ensure in any way that the window will be the
4092     * active one after it.
4093     *
4094     * @param obj The window object
4095     */
4096    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4097    /**
4098     * Lower a window object.
4099     *
4100     * Places the window pointed by @p obj at the bottom of the stack, so that
4101     * no other window is covered by it.
4102     *
4103     * If elm_win_override_set() is not set, the Window Manager may ignore this
4104     * request.
4105     *
4106     * @param obj The window object
4107     */
4108    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4109    /**
4110     * Raise a window object.
4111     *
4112     * Places the window pointed by @p obj at the top of the stack, so that it's
4113     * not covered by any other window.
4114     *
4115     * If elm_win_override_set() is not set, the Window Manager may ignore this
4116     * request.
4117     *
4118     * @param obj The window object
4119     */
4120    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4121    /**
4122     * Set the borderless state of a window.
4123     *
4124     * This function requests the Window Manager to not draw any decoration
4125     * around the window.
4126     *
4127     * @param obj The window object
4128     * @param borderless If true, the window is borderless
4129     */
4130    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4131    /**
4132     * Get the borderless state of a window.
4133     *
4134     * @param obj The window object
4135     * @return If true, the window is borderless
4136     */
4137    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4138    /**
4139     * Set the shaped state of a window.
4140     *
4141     * Shaped windows, when supported, will render the parts of the window that
4142     * has no content, transparent.
4143     *
4144     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4145     * background object or cover the entire window in any other way, or the
4146     * parts of the canvas that have no data will show framebuffer artifacts.
4147     *
4148     * @param obj The window object
4149     * @param shaped If true, the window is shaped
4150     *
4151     * @see elm_win_alpha_set()
4152     */
4153    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4154    /**
4155     * Get the shaped state of a window.
4156     *
4157     * @param obj The window object
4158     * @return If true, the window is shaped
4159     *
4160     * @see elm_win_shaped_set()
4161     */
4162    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4163    /**
4164     * Set the alpha channel state of a window.
4165     *
4166     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4167     * possibly making parts of the window completely or partially transparent.
4168     * This is also subject to the underlying system supporting it, like for
4169     * example, running under a compositing manager. If no compositing is
4170     * available, enabling this option will instead fallback to using shaped
4171     * windows, with elm_win_shaped_set().
4172     *
4173     * @param obj The window object
4174     * @param alpha If true, the window has an alpha channel
4175     *
4176     * @see elm_win_alpha_set()
4177     */
4178    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4179    /**
4180     * Get the transparency state of a window.
4181     *
4182     * @param obj The window object
4183     * @return If true, the window is transparent
4184     *
4185     * @see elm_win_transparent_set()
4186     */
4187    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4188    /**
4189     * Set the transparency state of a window.
4190     *
4191     * Use elm_win_alpha_set() instead.
4192     *
4193     * @param obj The window object
4194     * @param transparent If true, the window is transparent
4195     *
4196     * @see elm_win_alpha_set()
4197     */
4198    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4199    /**
4200     * Get the alpha channel state of a window.
4201     *
4202     * @param obj The window object
4203     * @return If true, the window has an alpha channel
4204     */
4205    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4206    /**
4207     * Set the override state of a window.
4208     *
4209     * A window with @p override set to EINA_TRUE will not be managed by the
4210     * Window Manager. This means that no decorations of any kind will be shown
4211     * for it, moving and resizing must be handled by the application, as well
4212     * as the window visibility.
4213     *
4214     * This should not be used for normal windows, and even for not so normal
4215     * ones, it should only be used when there's a good reason and with a lot
4216     * of care. Mishandling override windows may result situations that
4217     * disrupt the normal workflow of the end user.
4218     *
4219     * @param obj The window object
4220     * @param override If true, the window is overridden
4221     */
4222    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4223    /**
4224     * Get the override state of a window.
4225     *
4226     * @param obj The window object
4227     * @return If true, the window is overridden
4228     *
4229     * @see elm_win_override_set()
4230     */
4231    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4232    /**
4233     * Set the fullscreen state of a window.
4234     *
4235     * @param obj The window object
4236     * @param fullscreen If true, the window is fullscreen
4237     */
4238    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4239    /**
4240     * Get the fullscreen state of a window.
4241     *
4242     * @param obj The window object
4243     * @return If true, the window is fullscreen
4244     */
4245    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4246    /**
4247     * Set the maximized state of a window.
4248     *
4249     * @param obj The window object
4250     * @param maximized If true, the window is maximized
4251     */
4252    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4253    /**
4254     * Get the maximized state of a window.
4255     *
4256     * @param obj The window object
4257     * @return If true, the window is maximized
4258     */
4259    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4260    /**
4261     * Set the iconified state of a window.
4262     *
4263     * @param obj The window object
4264     * @param iconified If true, the window is iconified
4265     */
4266    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4267    /**
4268     * Get the iconified state of a window.
4269     *
4270     * @param obj The window object
4271     * @return If true, the window is iconified
4272     */
4273    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4274    /**
4275     * Set the layer of the window.
4276     *
4277     * What this means exactly will depend on the underlying engine used.
4278     *
4279     * In the case of X11 backed engines, the value in @p layer has the
4280     * following meanings:
4281     * @li < 3: The window will be placed below all others.
4282     * @li > 5: The window will be placed above all others.
4283     * @li other: The window will be placed in the default layer.
4284     *
4285     * @param obj The window object
4286     * @param layer The layer of the window
4287     */
4288    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4289    /**
4290     * Get the layer of the window.
4291     *
4292     * @param obj The window object
4293     * @return The layer of the window
4294     *
4295     * @see elm_win_layer_set()
4296     */
4297    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4298    /**
4299     * Set the rotation of the window.
4300     *
4301     * Most engines only work with multiples of 90.
4302     *
4303     * This function is used to set the orientation of the window @p obj to
4304     * match that of the screen. The window itself will be resized to adjust
4305     * to the new geometry of its contents. If you want to keep the window size,
4306     * see elm_win_rotation_with_resize_set().
4307     *
4308     * @param obj The window object
4309     * @param rotation The rotation of the window, in degrees (0-360),
4310     * counter-clockwise.
4311     */
4312    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4313    /**
4314     * Rotates the window and resizes it.
4315     *
4316     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4317     * that they fit inside the current window geometry.
4318     *
4319     * @param obj The window object
4320     * @param layer The rotation of the window in degrees (0-360),
4321     * counter-clockwise.
4322     */
4323    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4324    /**
4325     * Get the rotation of the window.
4326     *
4327     * @param obj The window object
4328     * @return The rotation of the window in degrees (0-360)
4329     *
4330     * @see elm_win_rotation_set()
4331     * @see elm_win_rotation_with_resize_set()
4332     */
4333    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4334    /**
4335     * Set the sticky state of the window.
4336     *
4337     * Hints the Window Manager that the window in @p obj should be left fixed
4338     * at its position even when the virtual desktop it's on moves or changes.
4339     *
4340     * @param obj The window object
4341     * @param sticky If true, the window's sticky state is enabled
4342     */
4343    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4344    /**
4345     * Get the sticky state of the window.
4346     *
4347     * @param obj The window object
4348     * @return If true, the window's sticky state is enabled
4349     *
4350     * @see elm_win_sticky_set()
4351     */
4352    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4353    /**
4354     * Set if this window is an illume conformant window
4355     *
4356     * @param obj The window object
4357     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4358     */
4359    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4360    /**
4361     * Get if this window is an illume conformant window
4362     *
4363     * @param obj The window object
4364     * @return A boolean if this window is illume conformant or not
4365     */
4366    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4367    /**
4368     * Set a window to be an illume quickpanel window
4369     *
4370     * By default window objects are not quickpanel windows.
4371     *
4372     * @param obj The window object
4373     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4374     */
4375    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4376    /**
4377     * Get if this window is a quickpanel or not
4378     *
4379     * @param obj The window object
4380     * @return A boolean if this window is a quickpanel or not
4381     */
4382    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4383    /**
4384     * Set the major priority of a quickpanel window
4385     *
4386     * @param obj The window object
4387     * @param priority The major priority for this quickpanel
4388     */
4389    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4390    /**
4391     * Get the major priority of a quickpanel window
4392     *
4393     * @param obj The window object
4394     * @return The major priority of this quickpanel
4395     */
4396    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4397    /**
4398     * Set the minor priority of a quickpanel window
4399     *
4400     * @param obj The window object
4401     * @param priority The minor priority for this quickpanel
4402     */
4403    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4404    /**
4405     * Get the minor priority of a quickpanel window
4406     *
4407     * @param obj The window object
4408     * @return The minor priority of this quickpanel
4409     */
4410    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4411    /**
4412     * Set which zone this quickpanel should appear in
4413     *
4414     * @param obj The window object
4415     * @param zone The requested zone for this quickpanel
4416     */
4417    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4418    /**
4419     * Get which zone this quickpanel should appear in
4420     *
4421     * @param obj The window object
4422     * @return The requested zone for this quickpanel
4423     */
4424    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4425    /**
4426     * Set the window to be skipped by keyboard focus
4427     *
4428     * This sets the window to be skipped by normal keyboard input. This means
4429     * a window manager will be asked to not focus this window as well as omit
4430     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4431     *
4432     * Call this and enable it on a window BEFORE you show it for the first time,
4433     * otherwise it may have no effect.
4434     *
4435     * Use this for windows that have only output information or might only be
4436     * interacted with by the mouse or fingers, and never for typing input.
4437     * Be careful that this may have side-effects like making the window
4438     * non-accessible in some cases unless the window is specially handled. Use
4439     * this with care.
4440     *
4441     * @param obj The window object
4442     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4443     */
4444    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4445    /**
4446     * Send a command to the windowing environment
4447     *
4448     * This is intended to work in touchscreen or small screen device
4449     * environments where there is a more simplistic window management policy in
4450     * place. This uses the window object indicated to select which part of the
4451     * environment to control (the part that this window lives in), and provides
4452     * a command and an optional parameter structure (use NULL for this if not
4453     * needed).
4454     *
4455     * @param obj The window object that lives in the environment to control
4456     * @param command The command to send
4457     * @param params Optional parameters for the command
4458     */
4459    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4460    /**
4461     * Get the inlined image object handle
4462     *
4463     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4464     * then the window is in fact an evas image object inlined in the parent
4465     * canvas. You can get this object (be careful to not manipulate it as it
4466     * is under control of elementary), and use it to do things like get pixel
4467     * data, save the image to a file, etc.
4468     *
4469     * @param obj The window object to get the inlined image from
4470     * @return The inlined image object, or NULL if none exists
4471     */
4472    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4473    /**
4474     * Determine whether a window has focus
4475     * @param obj The window to query
4476     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4477     */
4478    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4479    /**
4480     * Get screen geometry details for the screen that a window is on
4481     * @param obj The window to query
4482     * @param x where to return the horizontal offset value. May be NULL.
4483     * @param y  where to return the vertical offset value. May be NULL.
4484     * @param w  where to return the width value. May be NULL.
4485     * @param h  where to return the height value. May be NULL.
4486     */
4487    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4488    /**
4489     * Set the enabled status for the focus highlight in a window
4490     *
4491     * This function will enable or disable the focus highlight only for the
4492     * given window, regardless of the global setting for it
4493     *
4494     * @param obj The window where to enable the highlight
4495     * @param enabled The enabled value for the highlight
4496     */
4497    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4498    /**
4499     * Get the enabled value of the focus highlight for this window
4500     *
4501     * @param obj The window in which to check if the focus highlight is enabled
4502     *
4503     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4504     */
4505    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4506    /**
4507     * Set the style for the focus highlight on this window
4508     *
4509     * Sets the style to use for theming the highlight of focused objects on
4510     * the given window. If @p style is NULL, the default will be used.
4511     *
4512     * @param obj The window where to set the style
4513     * @param style The style to set
4514     */
4515    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4516    /**
4517     * Get the style set for the focus highlight object
4518     *
4519     * Gets the style set for this windows highilght object, or NULL if none
4520     * is set.
4521     *
4522     * @param obj The window to retrieve the highlights style from
4523     *
4524     * @return The style set or NULL if none was. Default is used in that case.
4525     */
4526    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4527    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4528    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4529    /*...
4530     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4531     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4532     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4533     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4534     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4535     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4536     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4537     *
4538     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4539     * (blank mouse, private mouse obj, defaultmouse)
4540     *
4541     */
4542    /**
4543     * Sets the keyboard mode of the window.
4544     *
4545     * @param obj The window object
4546     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4547     */
4548    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4549    /**
4550     * Gets the keyboard mode of the window.
4551     *
4552     * @param obj The window object
4553     * @return The mode, one of #Elm_Win_Keyboard_Mode
4554     */
4555    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4556    /**
4557     * Sets whether the window is a keyboard.
4558     *
4559     * @param obj The window object
4560     * @param is_keyboard If true, the window is a virtual keyboard
4561     */
4562    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4563    /**
4564     * Gets whether the window is a keyboard.
4565     *
4566     * @param obj The window object
4567     * @return If the window is a virtual keyboard
4568     */
4569    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4570
4571    /**
4572     * Get the screen position of a window.
4573     *
4574     * @param obj The window object
4575     * @param x The int to store the x coordinate to
4576     * @param y The int to store the y coordinate to
4577     */
4578    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4579    /**
4580     * @}
4581     */
4582
4583    /**
4584     * @defgroup Inwin Inwin
4585     *
4586     * @image html img/widget/inwin/preview-00.png
4587     * @image latex img/widget/inwin/preview-00.eps
4588     * @image html img/widget/inwin/preview-01.png
4589     * @image latex img/widget/inwin/preview-01.eps
4590     * @image html img/widget/inwin/preview-02.png
4591     * @image latex img/widget/inwin/preview-02.eps
4592     *
4593     * An inwin is a window inside a window that is useful for a quick popup.
4594     * It does not hover.
4595     *
4596     * It works by creating an object that will occupy the entire window, so it
4597     * must be created using an @ref Win "elm_win" as parent only. The inwin
4598     * object can be hidden or restacked below every other object if it's
4599     * needed to show what's behind it without destroying it. If this is done,
4600     * the elm_win_inwin_activate() function can be used to bring it back to
4601     * full visibility again.
4602     *
4603     * There are three styles available in the default theme. These are:
4604     * @li default: The inwin is sized to take over most of the window it's
4605     * placed in.
4606     * @li minimal: The size of the inwin will be the minimum necessary to show
4607     * its contents.
4608     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4609     * possible, but it's sized vertically the most it needs to fit its\
4610     * contents.
4611     *
4612     * Some examples of Inwin can be found in the following:
4613     * @li @ref inwin_example_01
4614     *
4615     * @{
4616     */
4617    /**
4618     * Adds an inwin to the current window
4619     *
4620     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4621     * Never call this function with anything other than the top-most window
4622     * as its parameter, unless you are fond of undefined behavior.
4623     *
4624     * After creating the object, the widget will set itself as resize object
4625     * for the window with elm_win_resize_object_add(), so when shown it will
4626     * appear to cover almost the entire window (how much of it depends on its
4627     * content and the style used). It must not be added into other container
4628     * objects and it needs not be moved or resized manually.
4629     *
4630     * @param parent The parent object
4631     * @return The new object or NULL if it cannot be created
4632     */
4633    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4634    /**
4635     * Activates an inwin object, ensuring its visibility
4636     *
4637     * This function will make sure that the inwin @p obj is completely visible
4638     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4639     * to the front. It also sets the keyboard focus to it, which will be passed
4640     * onto its content.
4641     *
4642     * The object's theme will also receive the signal "elm,action,show" with
4643     * source "elm".
4644     *
4645     * @param obj The inwin to activate
4646     */
4647    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4648    /**
4649     * Set the content of an inwin object.
4650     *
4651     * Once the content object is set, a previously set one will be deleted.
4652     * If you want to keep that old content object, use the
4653     * elm_win_inwin_content_unset() function.
4654     *
4655     * @param obj The inwin object
4656     * @param content The object to set as content
4657     */
4658    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4659    /**
4660     * Get the content of an inwin object.
4661     *
4662     * Return the content object which is set for this widget.
4663     *
4664     * The returned object is valid as long as the inwin is still alive and no
4665     * other content is set on it. Deleting the object will notify the inwin
4666     * about it and this one will be left empty.
4667     *
4668     * If you need to remove an inwin's content to be reused somewhere else,
4669     * see elm_win_inwin_content_unset().
4670     *
4671     * @param obj The inwin object
4672     * @return The content that is being used
4673     */
4674    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4675    /**
4676     * Unset the content of an inwin object.
4677     *
4678     * Unparent and return the content object which was set for this widget.
4679     *
4680     * @param obj The inwin object
4681     * @return The content that was being used
4682     */
4683    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4684    /**
4685     * @}
4686     */
4687    /* X specific calls - won't work on non-x engines (return 0) */
4688
4689    /**
4690     * Get the Ecore_X_Window of an Evas_Object
4691     *
4692     * @param obj The object
4693     *
4694     * @return The Ecore_X_Window of @p obj
4695     *
4696     * @ingroup Win
4697     */
4698    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4699
4700    /* smart callbacks called:
4701     * "delete,request" - the user requested to delete the window
4702     * "focus,in" - window got focus
4703     * "focus,out" - window lost focus
4704     * "moved" - window that holds the canvas was moved
4705     */
4706
4707    /**
4708     * @defgroup Bg Bg
4709     *
4710     * @image html img/widget/bg/preview-00.png
4711     * @image latex img/widget/bg/preview-00.eps
4712     *
4713     * @brief Background object, used for setting a solid color, image or Edje
4714     * group as background to a window or any container object.
4715     *
4716     * The bg object is used for setting a solid background to a window or
4717     * packing into any container object. It works just like an image, but has
4718     * some properties useful to a background, like setting it to tiled,
4719     * centered, scaled or stretched.
4720     * 
4721     * Default contents parts of the bg widget that you can use for are:
4722     * @li "overlay" - overlay of the bg
4723     *
4724     * Here is some sample code using it:
4725     * @li @ref bg_01_example_page
4726     * @li @ref bg_02_example_page
4727     * @li @ref bg_03_example_page
4728     */
4729
4730    /* bg */
4731    typedef enum _Elm_Bg_Option
4732      {
4733         ELM_BG_OPTION_CENTER,  /**< center the background */
4734         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4735         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4736         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4737      } Elm_Bg_Option;
4738
4739    /**
4740     * Add a new background to the parent
4741     *
4742     * @param parent The parent object
4743     * @return The new object or NULL if it cannot be created
4744     *
4745     * @ingroup Bg
4746     */
4747    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4748
4749    /**
4750     * Set the file (image or edje) used for the background
4751     *
4752     * @param obj The bg object
4753     * @param file The file path
4754     * @param group Optional key (group in Edje) within the file
4755     *
4756     * This sets the image file used in the background object. The image (or edje)
4757     * will be stretched (retaining aspect if its an image file) to completely fill
4758     * the bg object. This may mean some parts are not visible.
4759     *
4760     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4761     * even if @p file is NULL.
4762     *
4763     * @ingroup Bg
4764     */
4765    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4766
4767    /**
4768     * Get the file (image or edje) used for the background
4769     *
4770     * @param obj The bg object
4771     * @param file The file path
4772     * @param group Optional key (group in Edje) within the file
4773     *
4774     * @ingroup Bg
4775     */
4776    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4777
4778    /**
4779     * Set the option used for the background image
4780     *
4781     * @param obj The bg object
4782     * @param option The desired background option (TILE, SCALE)
4783     *
4784     * This sets the option used for manipulating the display of the background
4785     * image. The image can be tiled or scaled.
4786     *
4787     * @ingroup Bg
4788     */
4789    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4790
4791    /**
4792     * Get the option used for the background image
4793     *
4794     * @param obj The bg object
4795     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4796     *
4797     * @ingroup Bg
4798     */
4799    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4800    /**
4801     * Set the option used for the background color
4802     *
4803     * @param obj The bg object
4804     * @param r
4805     * @param g
4806     * @param b
4807     *
4808     * This sets the color used for the background rectangle. Its range goes
4809     * from 0 to 255.
4810     *
4811     * @ingroup Bg
4812     */
4813    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4814    /**
4815     * Get the option used for the background color
4816     *
4817     * @param obj The bg object
4818     * @param r
4819     * @param g
4820     * @param b
4821     *
4822     * @ingroup Bg
4823     */
4824    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4825
4826    /**
4827     * Set the overlay object used for the background object.
4828     *
4829     * @param obj The bg object
4830     * @param overlay The overlay object
4831     *
4832     * This provides a way for elm_bg to have an 'overlay' that will be on top
4833     * of the bg. Once the over object is set, a previously set one will be
4834     * deleted, even if you set the new one to NULL. If you want to keep that
4835     * old content object, use the elm_bg_overlay_unset() function.
4836     *
4837     * @deprecated use elm_object_part_content_set() instead
4838     *
4839     * @ingroup Bg
4840     */
4841
4842    WILL_DEPRECATE  EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4843
4844    /**
4845     * Get the overlay object used for the background object.
4846     *
4847     * @param obj The bg object
4848     * @return The content that is being used
4849     *
4850     * Return the content object which is set for this widget
4851     *
4852     * @deprecated use elm_object_part_content_get() instead
4853     *
4854     * @ingroup Bg
4855     */
4856    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4857
4858    /**
4859     * Get the overlay object used for the background object.
4860     *
4861     * @param obj The bg object
4862     * @return The content that was being used
4863     *
4864     * Unparent and return the overlay object which was set for this widget
4865     *
4866     * @deprecated use elm_object_part_content_unset() instead
4867     *
4868     * @ingroup Bg
4869     */
4870    WILL_DEPRECATE  EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4871
4872    /**
4873     * Set the size of the pixmap representation of the image.
4874     *
4875     * This option just makes sense if an image is going to be set in the bg.
4876     *
4877     * @param obj The bg object
4878     * @param w The new width of the image pixmap representation.
4879     * @param h The new height of the image pixmap representation.
4880     *
4881     * This function sets a new size for pixmap representation of the given bg
4882     * image. It allows the image to be loaded already in the specified size,
4883     * reducing the memory usage and load time when loading a big image with load
4884     * size set to a smaller size.
4885     *
4886     * NOTE: this is just a hint, the real size of the pixmap may differ
4887     * depending on the type of image being loaded, being bigger than requested.
4888     *
4889     * @ingroup Bg
4890     */
4891    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4892    /* smart callbacks called:
4893     */
4894
4895    /**
4896     * @defgroup Icon Icon
4897     *
4898     * @image html img/widget/icon/preview-00.png
4899     * @image latex img/widget/icon/preview-00.eps
4900     *
4901     * An object that provides standard icon images (delete, edit, arrows, etc.)
4902     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4903     *
4904     * The icon image requested can be in the elementary theme, or in the
4905     * freedesktop.org paths. It's possible to set the order of preference from
4906     * where the image will be used.
4907     *
4908     * This API is very similar to @ref Image, but with ready to use images.
4909     *
4910     * Default images provided by the theme are described below.
4911     *
4912     * The first list contains icons that were first intended to be used in
4913     * toolbars, but can be used in many other places too:
4914     * @li home
4915     * @li close
4916     * @li apps
4917     * @li arrow_up
4918     * @li arrow_down
4919     * @li arrow_left
4920     * @li arrow_right
4921     * @li chat
4922     * @li clock
4923     * @li delete
4924     * @li edit
4925     * @li refresh
4926     * @li folder
4927     * @li file
4928     *
4929     * Now some icons that were designed to be used in menus (but again, you can
4930     * use them anywhere else):
4931     * @li menu/home
4932     * @li menu/close
4933     * @li menu/apps
4934     * @li menu/arrow_up
4935     * @li menu/arrow_down
4936     * @li menu/arrow_left
4937     * @li menu/arrow_right
4938     * @li menu/chat
4939     * @li menu/clock
4940     * @li menu/delete
4941     * @li menu/edit
4942     * @li menu/refresh
4943     * @li menu/folder
4944     * @li menu/file
4945     *
4946     * And here we have some media player specific icons:
4947     * @li media_player/forward
4948     * @li media_player/info
4949     * @li media_player/next
4950     * @li media_player/pause
4951     * @li media_player/play
4952     * @li media_player/prev
4953     * @li media_player/rewind
4954     * @li media_player/stop
4955     *
4956     * Signals that you can add callbacks for are:
4957     *
4958     * "clicked" - This is called when a user has clicked the icon
4959     *
4960     * An example of usage for this API follows:
4961     * @li @ref tutorial_icon
4962     */
4963
4964    /**
4965     * @addtogroup Icon
4966     * @{
4967     */
4968
4969    typedef enum _Elm_Icon_Type
4970      {
4971         ELM_ICON_NONE,
4972         ELM_ICON_FILE,
4973         ELM_ICON_STANDARD
4974      } Elm_Icon_Type;
4975    /**
4976     * @enum _Elm_Icon_Lookup_Order
4977     * @typedef Elm_Icon_Lookup_Order
4978     *
4979     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4980     * theme, FDO paths, or both?
4981     *
4982     * @ingroup Icon
4983     */
4984    typedef enum _Elm_Icon_Lookup_Order
4985      {
4986         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4987         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4988         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4989         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4990      } Elm_Icon_Lookup_Order;
4991
4992    /**
4993     * Add a new icon object to the parent.
4994     *
4995     * @param parent The parent object
4996     * @return The new object or NULL if it cannot be created
4997     *
4998     * @see elm_icon_file_set()
4999     *
5000     * @ingroup Icon
5001     */
5002    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5003    /**
5004     * Set the file that will be used as icon.
5005     *
5006     * @param obj The icon object
5007     * @param file The path to file that will be used as icon image
5008     * @param group The group that the icon belongs to an edje file
5009     *
5010     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5011     *
5012     * @note The icon image set by this function can be changed by
5013     * elm_icon_standard_set().
5014     *
5015     * @see elm_icon_file_get()
5016     *
5017     * @ingroup Icon
5018     */
5019    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5020    /**
5021     * Set a location in memory to be used as an icon
5022     *
5023     * @param obj The icon object
5024     * @param img The binary data that will be used as an image
5025     * @param size The size of binary data @p img
5026     * @param format Optional format of @p img to pass to the image loader
5027     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5028     *
5029     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5030     *
5031     * @note The icon image set by this function can be changed by
5032     * elm_icon_standard_set().
5033     *
5034     * @ingroup Icon
5035     */
5036    EAPI Eina_Bool             elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1, 2);
5037    /**
5038     * Get the file that will be used as icon.
5039     *
5040     * @param obj The icon object
5041     * @param file The path to file that will be used as the icon image
5042     * @param group The group that the icon belongs to, in edje file
5043     *
5044     * @see elm_icon_file_set()
5045     *
5046     * @ingroup Icon
5047     */
5048    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5049    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5050    /**
5051     * Set the icon by icon standards names.
5052     *
5053     * @param obj The icon object
5054     * @param name The icon name
5055     *
5056     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5057     *
5058     * For example, freedesktop.org defines standard icon names such as "home",
5059     * "network", etc. There can be different icon sets to match those icon
5060     * keys. The @p name given as parameter is one of these "keys", and will be
5061     * used to look in the freedesktop.org paths and elementary theme. One can
5062     * change the lookup order with elm_icon_order_lookup_set().
5063     *
5064     * If name is not found in any of the expected locations and it is the
5065     * absolute path of an image file, this image will be used.
5066     *
5067     * @note The icon image set by this function can be changed by
5068     * elm_icon_file_set().
5069     *
5070     * @see elm_icon_standard_get()
5071     * @see elm_icon_file_set()
5072     *
5073     * @ingroup Icon
5074     */
5075    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5076    /**
5077     * Get the icon name set by icon standard names.
5078     *
5079     * @param obj The icon object
5080     * @return The icon name
5081     *
5082     * If the icon image was set using elm_icon_file_set() instead of
5083     * elm_icon_standard_set(), then this function will return @c NULL.
5084     *
5085     * @see elm_icon_standard_set()
5086     *
5087     * @ingroup Icon
5088     */
5089    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5090    /**
5091     * Set the smooth scaling for an icon object.
5092     *
5093     * @param obj The icon object
5094     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5095     * otherwise. Default is @c EINA_TRUE.
5096     *
5097     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5098     * scaling provides a better resulting image, but is slower.
5099     *
5100     * The smooth scaling should be disabled when making animations that change
5101     * the icon size, since they will be faster. Animations that don't require
5102     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5103     * is already scaled, since the scaled icon image will be cached).
5104     *
5105     * @see elm_icon_smooth_get()
5106     *
5107     * @ingroup Icon
5108     */
5109    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5110    /**
5111     * Get whether smooth scaling is enabled for an icon object.
5112     *
5113     * @param obj The icon object
5114     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5115     *
5116     * @see elm_icon_smooth_set()
5117     *
5118     * @ingroup Icon
5119     */
5120    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5121    /**
5122     * Disable scaling of this object.
5123     *
5124     * @param obj The icon object.
5125     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5126     * otherwise. Default is @c EINA_FALSE.
5127     *
5128     * This function disables scaling of the icon object through the function
5129     * elm_object_scale_set(). However, this does not affect the object
5130     * size/resize in any way. For that effect, take a look at
5131     * elm_icon_scale_set().
5132     *
5133     * @see elm_icon_no_scale_get()
5134     * @see elm_icon_scale_set()
5135     * @see elm_object_scale_set()
5136     *
5137     * @ingroup Icon
5138     */
5139    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5140    /**
5141     * Get whether scaling is disabled on the object.
5142     *
5143     * @param obj The icon object
5144     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5145     *
5146     * @see elm_icon_no_scale_set()
5147     *
5148     * @ingroup Icon
5149     */
5150    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5151    /**
5152     * Set if the object is (up/down) resizable.
5153     *
5154     * @param obj The icon object
5155     * @param scale_up A bool to set if the object is resizable up. Default is
5156     * @c EINA_TRUE.
5157     * @param scale_down A bool to set if the object is resizable down. Default
5158     * is @c EINA_TRUE.
5159     *
5160     * This function limits the icon object resize ability. If @p scale_up is set to
5161     * @c EINA_FALSE, the object can't have its height or width resized to a value
5162     * higher than the original icon size. Same is valid for @p scale_down.
5163     *
5164     * @see elm_icon_scale_get()
5165     *
5166     * @ingroup Icon
5167     */
5168    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5169    /**
5170     * Get if the object is (up/down) resizable.
5171     *
5172     * @param obj The icon object
5173     * @param scale_up A bool to set if the object is resizable up
5174     * @param scale_down A bool to set if the object is resizable down
5175     *
5176     * @see elm_icon_scale_set()
5177     *
5178     * @ingroup Icon
5179     */
5180    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5181    /**
5182     * Get the object's image size
5183     *
5184     * @param obj The icon object
5185     * @param w A pointer to store the width in
5186     * @param h A pointer to store the height in
5187     *
5188     * @ingroup Icon
5189     */
5190    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5191    /**
5192     * Set if the icon fill the entire object area.
5193     *
5194     * @param obj The icon object
5195     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5196     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5197     *
5198     * When the icon object is resized to a different aspect ratio from the
5199     * original icon image, the icon image will still keep its aspect. This flag
5200     * tells how the image should fill the object's area. They are: keep the
5201     * entire icon inside the limits of height and width of the object (@p
5202     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5203     * of the object, and the icon will fill the entire object (@p fill_outside
5204     * is @c EINA_TRUE).
5205     *
5206     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5207     * retain property to false. Thus, the icon image will always keep its
5208     * original aspect ratio.
5209     *
5210     * @see elm_icon_fill_outside_get()
5211     * @see elm_image_fill_outside_set()
5212     *
5213     * @ingroup Icon
5214     */
5215    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5216    /**
5217     * Get if the object is filled outside.
5218     *
5219     * @param obj The icon object
5220     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5221     *
5222     * @see elm_icon_fill_outside_set()
5223     *
5224     * @ingroup Icon
5225     */
5226    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5227    /**
5228     * Set the prescale size for the icon.
5229     *
5230     * @param obj The icon object
5231     * @param size The prescale size. This value is used for both width and
5232     * height.
5233     *
5234     * This function sets a new size for pixmap representation of the given
5235     * icon. It allows the icon to be loaded already in the specified size,
5236     * reducing the memory usage and load time when loading a big icon with load
5237     * size set to a smaller size.
5238     *
5239     * It's equivalent to the elm_bg_load_size_set() function for bg.
5240     *
5241     * @note this is just a hint, the real size of the pixmap may differ
5242     * depending on the type of icon being loaded, being bigger than requested.
5243     *
5244     * @see elm_icon_prescale_get()
5245     * @see elm_bg_load_size_set()
5246     *
5247     * @ingroup Icon
5248     */
5249    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5250    /**
5251     * Get the prescale size for the icon.
5252     *
5253     * @param obj The icon object
5254     * @return The prescale size
5255     *
5256     * @see elm_icon_prescale_set()
5257     *
5258     * @ingroup Icon
5259     */
5260    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5261    /**
5262     * Gets the image object of the icon. DO NOT MODIFY THIS.
5263     *
5264     * @param obj The icon object
5265     * @return The internal icon object
5266     *
5267     * @ingroup Icon
5268     */
5269    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5270    /**
5271     * Sets the icon lookup order used by elm_icon_standard_set().
5272     *
5273     * @param obj The icon object
5274     * @param order The icon lookup order (can be one of
5275     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5276     * or ELM_ICON_LOOKUP_THEME)
5277     *
5278     * @see elm_icon_order_lookup_get()
5279     * @see Elm_Icon_Lookup_Order
5280     *
5281     * @ingroup Icon
5282     */
5283    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5284    /**
5285     * Gets the icon lookup order.
5286     *
5287     * @param obj The icon object
5288     * @return The icon lookup order
5289     *
5290     * @see elm_icon_order_lookup_set()
5291     * @see Elm_Icon_Lookup_Order
5292     *
5293     * @ingroup Icon
5294     */
5295    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5296    /**
5297     * Enable or disable preloading of the icon
5298     *
5299     * @param obj The icon object
5300     * @param disable If EINA_TRUE, preloading will be disabled
5301     * @ingroup Icon
5302     */
5303    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5304    /**
5305     * Get if the icon supports animation or not.
5306     *
5307     * @param obj The icon object
5308     * @return @c EINA_TRUE if the icon supports animation,
5309     *         @c EINA_FALSE otherwise.
5310     *
5311     * Return if this elm icon's image can be animated. Currently Evas only
5312     * supports gif animation. If the return value is EINA_FALSE, other
5313     * elm_icon_animated_XXX APIs won't work.
5314     * @ingroup Icon
5315     */
5316    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317    /**
5318     * Set animation mode of the icon.
5319     *
5320     * @param obj The icon object
5321     * @param anim @c EINA_TRUE if the object do animation job,
5322     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5323     *
5324     * Since the default animation mode is set to EINA_FALSE, 
5325     * the icon is shown without animation.
5326     * This might be desirable when the application developer wants to show
5327     * a snapshot of the animated icon.
5328     * Set it to EINA_TRUE when the icon needs to be animated.
5329     * @ingroup Icon
5330     */
5331    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5332    /**
5333     * Get animation mode of the icon.
5334     *
5335     * @param obj The icon object
5336     * @return The animation mode of the icon object
5337     * @see elm_icon_animated_set
5338     * @ingroup Icon
5339     */
5340    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5341    /**
5342     * Set animation play mode of the icon.
5343     *
5344     * @param obj The icon object
5345     * @param play @c EINA_TRUE the object play animation images,
5346     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5347     *
5348     * To play elm icon's animation, set play to EINA_TURE.
5349     * For example, you make gif player using this set/get API and click event.
5350     *
5351     * 1. Click event occurs
5352     * 2. Check play flag using elm_icon_animaged_play_get
5353     * 3. If elm icon was playing, set play to EINA_FALSE.
5354     *    Then animation will be stopped and vice versa
5355     * @ingroup Icon
5356     */
5357    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5358    /**
5359     * Get animation play mode of the icon.
5360     *
5361     * @param obj The icon object
5362     * @return The play mode of the icon object
5363     *
5364     * @see elm_icon_animated_play_get
5365     * @ingroup Icon
5366     */
5367    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5368
5369    /* compatibility code to avoid API and ABI breaks */
5370    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5371      {
5372         elm_icon_animated_set(obj, animated);
5373      }
5374
5375    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5376      {
5377         return elm_icon_animated_get(obj);
5378      }
5379
5380    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5381      {
5382         elm_icon_animated_play_set(obj, play);
5383      }
5384
5385    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5386      {
5387         return elm_icon_animated_play_get(obj);
5388      }
5389
5390    /**
5391     * @}
5392     */
5393
5394    /**
5395     * @defgroup Image Image
5396     *
5397     * @image html img/widget/image/preview-00.png
5398     * @image latex img/widget/image/preview-00.eps
5399
5400     *
5401     * An object that allows one to load an image file to it. It can be used
5402     * anywhere like any other elementary widget.
5403     *
5404     * This widget provides most of the functionality provided from @ref Bg or @ref
5405     * Icon, but with a slightly different API (use the one that fits better your
5406     * needs).
5407     *
5408     * The features not provided by those two other image widgets are:
5409     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5410     * @li change the object orientation with elm_image_orient_set();
5411     * @li and turning the image editable with elm_image_editable_set().
5412     *
5413     * Signals that you can add callbacks for are:
5414     *
5415     * @li @c "clicked" - This is called when a user has clicked the image
5416     *
5417     * An example of usage for this API follows:
5418     * @li @ref tutorial_image
5419     */
5420
5421    /**
5422     * @addtogroup Image
5423     * @{
5424     */
5425
5426    /**
5427     * @enum _Elm_Image_Orient
5428     * @typedef Elm_Image_Orient
5429     *
5430     * Possible orientation options for elm_image_orient_set().
5431     *
5432     * @image html elm_image_orient_set.png
5433     * @image latex elm_image_orient_set.eps width=\textwidth
5434     *
5435     * @ingroup Image
5436     */
5437    typedef enum _Elm_Image_Orient
5438      {
5439         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5440         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5441         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5442         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5443         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5444         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5445         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5446         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5447      } Elm_Image_Orient;
5448
5449    /**
5450     * Add a new image to the parent.
5451     *
5452     * @param parent The parent object
5453     * @return The new object or NULL if it cannot be created
5454     *
5455     * @see elm_image_file_set()
5456     *
5457     * @ingroup Image
5458     */
5459    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5460    /**
5461     * Set the file that will be used as image.
5462     *
5463     * @param obj The image object
5464     * @param file The path to file that will be used as image
5465     * @param group The group that the image belongs in edje file (if it's an
5466     * edje image)
5467     *
5468     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5469     *
5470     * @see elm_image_file_get()
5471     *
5472     * @ingroup Image
5473     */
5474    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5475    /**
5476     * Get the file that will be used as image.
5477     *
5478     * @param obj The image object
5479     * @param file The path to file
5480     * @param group The group that the image belongs in edje file
5481     *
5482     * @see elm_image_file_set()
5483     *
5484     * @ingroup Image
5485     */
5486    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5487    /**
5488     * Set the smooth effect for an image.
5489     *
5490     * @param obj The image object
5491     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5492     * otherwise. Default is @c EINA_TRUE.
5493     *
5494     * Set the scaling algorithm to be used when scaling the image. Smooth
5495     * scaling provides a better resulting image, but is slower.
5496     *
5497     * The smooth scaling should be disabled when making animations that change
5498     * the image size, since it will be faster. Animations that don't require
5499     * resizing of the image can keep the smooth scaling enabled (even if the
5500     * image is already scaled, since the scaled image will be cached).
5501     *
5502     * @see elm_image_smooth_get()
5503     *
5504     * @ingroup Image
5505     */
5506    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5507    /**
5508     * Get the smooth effect for an image.
5509     *
5510     * @param obj The image object
5511     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5512     *
5513     * @see elm_image_smooth_get()
5514     *
5515     * @ingroup Image
5516     */
5517    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5518
5519    /**
5520     * Gets the current size of the image.
5521     *
5522     * @param obj The image object.
5523     * @param w Pointer to store width, or NULL.
5524     * @param h Pointer to store height, or NULL.
5525     *
5526     * This is the real size of the image, not the size of the object.
5527     *
5528     * On error, neither w or h will be written.
5529     *
5530     * @ingroup Image
5531     */
5532    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5533    /**
5534     * Disable scaling of this object.
5535     *
5536     * @param obj The image object.
5537     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5538     * otherwise. Default is @c EINA_FALSE.
5539     *
5540     * This function disables scaling of the elm_image widget through the
5541     * function elm_object_scale_set(). However, this does not affect the widget
5542     * size/resize in any way. For that effect, take a look at
5543     * elm_image_scale_set().
5544     *
5545     * @see elm_image_no_scale_get()
5546     * @see elm_image_scale_set()
5547     * @see elm_object_scale_set()
5548     *
5549     * @ingroup Image
5550     */
5551    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5552    /**
5553     * Get whether scaling is disabled on the object.
5554     *
5555     * @param obj The image object
5556     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5557     *
5558     * @see elm_image_no_scale_set()
5559     *
5560     * @ingroup Image
5561     */
5562    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5563    /**
5564     * Set if the object is (up/down) resizable.
5565     *
5566     * @param obj The image object
5567     * @param scale_up A bool to set if the object is resizable up. Default is
5568     * @c EINA_TRUE.
5569     * @param scale_down A bool to set if the object is resizable down. Default
5570     * is @c EINA_TRUE.
5571     *
5572     * This function limits the image resize ability. If @p scale_up is set to
5573     * @c EINA_FALSE, the object can't have its height or width resized to a value
5574     * higher than the original image size. Same is valid for @p scale_down.
5575     *
5576     * @see elm_image_scale_get()
5577     *
5578     * @ingroup Image
5579     */
5580    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5581    /**
5582     * Get if the object is (up/down) resizable.
5583     *
5584     * @param obj The image object
5585     * @param scale_up A bool to set if the object is resizable up
5586     * @param scale_down A bool to set if the object is resizable down
5587     *
5588     * @see elm_image_scale_set()
5589     *
5590     * @ingroup Image
5591     */
5592    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5593    /**
5594     * Set if the image fills the entire object area, when keeping the aspect ratio.
5595     *
5596     * @param obj The image object
5597     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5598     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5599     *
5600     * When the image should keep its aspect ratio even if resized to another
5601     * aspect ratio, there are two possibilities to resize it: keep the entire
5602     * image inside the limits of height and width of the object (@p fill_outside
5603     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5604     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5605     *
5606     * @note This option will have no effect if
5607     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5608     *
5609     * @see elm_image_fill_outside_get()
5610     * @see elm_image_aspect_ratio_retained_set()
5611     *
5612     * @ingroup Image
5613     */
5614    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5615    /**
5616     * Get if the object is filled outside
5617     *
5618     * @param obj The image object
5619     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5620     *
5621     * @see elm_image_fill_outside_set()
5622     *
5623     * @ingroup Image
5624     */
5625    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5626    /**
5627     * Set the prescale size for the image
5628     *
5629     * @param obj The image object
5630     * @param size The prescale size. This value is used for both width and
5631     * height.
5632     *
5633     * This function sets a new size for pixmap representation of the given
5634     * image. It allows the image to be loaded already in the specified size,
5635     * reducing the memory usage and load time when loading a big image with load
5636     * size set to a smaller size.
5637     *
5638     * It's equivalent to the elm_bg_load_size_set() function for bg.
5639     *
5640     * @note this is just a hint, the real size of the pixmap may differ
5641     * depending on the type of image being loaded, being bigger than requested.
5642     *
5643     * @see elm_image_prescale_get()
5644     * @see elm_bg_load_size_set()
5645     *
5646     * @ingroup Image
5647     */
5648    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5649    /**
5650     * Get the prescale size for the image
5651     *
5652     * @param obj The image object
5653     * @return The prescale size
5654     *
5655     * @see elm_image_prescale_set()
5656     *
5657     * @ingroup Image
5658     */
5659    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5660    /**
5661     * Set the image orientation.
5662     *
5663     * @param obj The image object
5664     * @param orient The image orientation @ref Elm_Image_Orient
5665     *  Default is #ELM_IMAGE_ORIENT_NONE.
5666     *
5667     * This function allows to rotate or flip the given image.
5668     *
5669     * @see elm_image_orient_get()
5670     * @see @ref Elm_Image_Orient
5671     *
5672     * @ingroup Image
5673     */
5674    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5675    /**
5676     * Get the image orientation.
5677     *
5678     * @param obj The image object
5679     * @return The image orientation @ref Elm_Image_Orient
5680     *
5681     * @see elm_image_orient_set()
5682     * @see @ref Elm_Image_Orient
5683     *
5684     * @ingroup Image
5685     */
5686    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5687    /**
5688     * Make the image 'editable'.
5689     *
5690     * @param obj Image object.
5691     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5692     *
5693     * This means the image is a valid drag target for drag and drop, and can be
5694     * cut or pasted too.
5695     *
5696     * @ingroup Image
5697     */
5698    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5699    /**
5700     * Check if the image 'editable'.
5701     *
5702     * @param obj Image object.
5703     * @return Editability.
5704     *
5705     * A return value of EINA_TRUE means the image is a valid drag target
5706     * for drag and drop, and can be cut or pasted too.
5707     *
5708     * @ingroup Image
5709     */
5710    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5711    /**
5712     * Get the basic Evas_Image object from this object (widget).
5713     *
5714     * @param obj The image object to get the inlined image from
5715     * @return The inlined image object, or NULL if none exists
5716     *
5717     * This function allows one to get the underlying @c Evas_Object of type
5718     * Image from this elementary widget. It can be useful to do things like get
5719     * the pixel data, save the image to a file, etc.
5720     *
5721     * @note Be careful to not manipulate it, as it is under control of
5722     * elementary.
5723     *
5724     * @ingroup Image
5725     */
5726    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5727    /**
5728     * Set whether the original aspect ratio of the image should be kept on resize.
5729     *
5730     * @param obj The image object.
5731     * @param retained @c EINA_TRUE if the image should retain the aspect,
5732     * @c EINA_FALSE otherwise.
5733     *
5734     * The original aspect ratio (width / height) of the image is usually
5735     * distorted to match the object's size. Enabling this option will retain
5736     * this original aspect, and the way that the image is fit into the object's
5737     * area depends on the option set by elm_image_fill_outside_set().
5738     *
5739     * @see elm_image_aspect_ratio_retained_get()
5740     * @see elm_image_fill_outside_set()
5741     *
5742     * @ingroup Image
5743     */
5744    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5745    /**
5746     * Get if the object retains the original aspect ratio.
5747     *
5748     * @param obj The image object.
5749     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5750     * otherwise.
5751     *
5752     * @ingroup Image
5753     */
5754    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5755
5756    /**
5757     * @}
5758     */
5759
5760    /* glview */
5761    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5762
5763    /* old API compatibility */
5764    typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5765
5766    typedef enum _Elm_GLView_Mode
5767      {
5768         ELM_GLVIEW_ALPHA   = 1,
5769         ELM_GLVIEW_DEPTH   = 2,
5770         ELM_GLVIEW_STENCIL = 4
5771      } Elm_GLView_Mode;
5772
5773    /**
5774     * Defines a policy for the glview resizing.
5775     *
5776     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5777     */
5778    typedef enum _Elm_GLView_Resize_Policy
5779      {
5780         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5781         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5782      } Elm_GLView_Resize_Policy;
5783
5784    typedef enum _Elm_GLView_Render_Policy
5785      {
5786         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5787         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5788      } Elm_GLView_Render_Policy;
5789
5790    /**
5791     * @defgroup GLView
5792     *
5793     * A simple GLView widget that allows GL rendering.
5794     *
5795     * Signals that you can add callbacks for are:
5796     *
5797     * @{
5798     */
5799
5800    /**
5801     * Add a new glview to the parent
5802     *
5803     * @param parent The parent object
5804     * @return The new object or NULL if it cannot be created
5805     *
5806     * @ingroup GLView
5807     */
5808    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5809
5810    /**
5811     * Sets the size of the glview
5812     *
5813     * @param obj The glview object
5814     * @param width width of the glview object
5815     * @param height height of the glview object
5816     *
5817     * @ingroup GLView
5818     */
5819    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5820
5821    /**
5822     * Gets the size of the glview.
5823     *
5824     * @param obj The glview object
5825     * @param width width of the glview object
5826     * @param height height of the glview object
5827     *
5828     * Note that this function returns the actual image size of the
5829     * glview.  This means that when the scale policy is set to
5830     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5831     * size.
5832     *
5833     * @ingroup GLView
5834     */
5835    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5836
5837    /**
5838     * Gets the gl api struct for gl rendering
5839     *
5840     * @param obj The glview object
5841     * @return The api object or NULL if it cannot be created
5842     *
5843     * @ingroup GLView
5844     */
5845    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5846
5847    /**
5848     * Set the mode of the GLView. Supports Three simple modes.
5849     *
5850     * @param obj The glview object
5851     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5852     * @return True if set properly.
5853     *
5854     * @ingroup GLView
5855     */
5856    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5857
5858    /**
5859     * Set the resize policy for the glview object.
5860     *
5861     * @param obj The glview object.
5862     * @param policy The scaling policy.
5863     *
5864     * By default, the resize policy is set to
5865     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5866     * destroys the previous surface and recreates the newly specified
5867     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5868     * however, glview only scales the image object and not the underlying
5869     * GL Surface.
5870     *
5871     * @ingroup GLView
5872     */
5873    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5874
5875    /**
5876     * Set the render policy for the glview object.
5877     *
5878     * @param obj The glview object.
5879     * @param policy The render policy.
5880     *
5881     * By default, the render policy is set to
5882     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5883     * that during the render loop, glview is only redrawn if it needs
5884     * to be redrawn. (i.e. When it is visible) If the policy is set to
5885     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5886     * whether it is visible/need redrawing or not.
5887     *
5888     * @ingroup GLView
5889     */
5890    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5891
5892    /**
5893     * Set the init function that runs once in the main loop.
5894     *
5895     * @param obj The glview object.
5896     * @param func The init function to be registered.
5897     *
5898     * The registered init function gets called once during the render loop.
5899     *
5900     * @ingroup GLView
5901     */
5902    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5903
5904    /**
5905     * Set the render function that runs in the main loop.
5906     *
5907     * @param obj The glview object.
5908     * @param func The delete function to be registered.
5909     *
5910     * The registered del function gets called when GLView object is deleted.
5911     *
5912     * @ingroup GLView
5913     */
5914    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5915
5916    /**
5917     * Set the resize function that gets called when resize happens.
5918     *
5919     * @param obj The glview object.
5920     * @param func The resize function to be registered.
5921     *
5922     * @ingroup GLView
5923     */
5924    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5925
5926    /**
5927     * Set the render function that runs in the main loop.
5928     *
5929     * @param obj The glview object.
5930     * @param func The render function to be registered.
5931     *
5932     * @ingroup GLView
5933     */
5934    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5935
5936    /**
5937     * Notifies that there has been changes in the GLView.
5938     *
5939     * @param obj The glview object.
5940     *
5941     * @ingroup GLView
5942     */
5943    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5944
5945    /**
5946     * @}
5947     */
5948
5949    /* box */
5950    /**
5951     * @defgroup Box Box
5952     *
5953     * @image html img/widget/box/preview-00.png
5954     * @image latex img/widget/box/preview-00.eps width=\textwidth
5955     *
5956     * @image html img/box.png
5957     * @image latex img/box.eps width=\textwidth
5958     *
5959     * A box arranges objects in a linear fashion, governed by a layout function
5960     * that defines the details of this arrangement.
5961     *
5962     * By default, the box will use an internal function to set the layout to
5963     * a single row, either vertical or horizontal. This layout is affected
5964     * by a number of parameters, such as the homogeneous flag set by
5965     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5966     * elm_box_align_set() and the hints set to each object in the box.
5967     *
5968     * For this default layout, it's possible to change the orientation with
5969     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5970     * placing its elements ordered from top to bottom. When horizontal is set,
5971     * the order will go from left to right. If the box is set to be
5972     * homogeneous, every object in it will be assigned the same space, that
5973     * of the largest object. Padding can be used to set some spacing between
5974     * the cell given to each object. The alignment of the box, set with
5975     * elm_box_align_set(), determines how the bounding box of all the elements
5976     * will be placed within the space given to the box widget itself.
5977     *
5978     * The size hints of each object also affect how they are placed and sized
5979     * within the box. evas_object_size_hint_min_set() will give the minimum
5980     * size the object can have, and the box will use it as the basis for all
5981     * latter calculations. Elementary widgets set their own minimum size as
5982     * needed, so there's rarely any need to use it manually.
5983     *
5984     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5985     * used to tell whether the object will be allocated the minimum size it
5986     * needs or if the space given to it should be expanded. It's important
5987     * to realize that expanding the size given to the object is not the same
5988     * thing as resizing the object. It could very well end being a small
5989     * widget floating in a much larger empty space. If not set, the weight
5990     * for objects will normally be 0.0 for both axis, meaning the widget will
5991     * not be expanded. To take as much space possible, set the weight to
5992     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5993     *
5994     * Besides how much space each object is allocated, it's possible to control
5995     * how the widget will be placed within that space using
5996     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5997     * for both axis, meaning the object will be centered, but any value from
5998     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5999     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6000     * is -1.0, means the object will be resized to fill the entire space it
6001     * was allocated.
6002     *
6003     * In addition, customized functions to define the layout can be set, which
6004     * allow the application developer to organize the objects within the box
6005     * in any number of ways.
6006     *
6007     * The special elm_box_layout_transition() function can be used
6008     * to switch from one layout to another, animating the motion of the
6009     * children of the box.
6010     *
6011     * @note Objects should not be added to box objects using _add() calls.
6012     *
6013     * Some examples on how to use boxes follow:
6014     * @li @ref box_example_01
6015     * @li @ref box_example_02
6016     *
6017     * @{
6018     */
6019    /**
6020     * @typedef Elm_Box_Transition
6021     *
6022     * Opaque handler containing the parameters to perform an animated
6023     * transition of the layout the box uses.
6024     *
6025     * @see elm_box_transition_new()
6026     * @see elm_box_layout_set()
6027     * @see elm_box_layout_transition()
6028     */
6029    typedef struct _Elm_Box_Transition Elm_Box_Transition;
6030
6031    /**
6032     * Add a new box to the parent
6033     *
6034     * By default, the box will be in vertical mode and non-homogeneous.
6035     *
6036     * @param parent The parent object
6037     * @return The new object or NULL if it cannot be created
6038     */
6039    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6040    /**
6041     * Set the horizontal orientation
6042     *
6043     * By default, box object arranges their contents vertically from top to
6044     * bottom.
6045     * By calling this function with @p horizontal as EINA_TRUE, the box will
6046     * become horizontal, arranging contents from left to right.
6047     *
6048     * @note This flag is ignored if a custom layout function is set.
6049     *
6050     * @param obj The box object
6051     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6052     * EINA_FALSE = vertical)
6053     */
6054    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6055    /**
6056     * Get the horizontal orientation
6057     *
6058     * @param obj The box object
6059     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6060     */
6061    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6062    /**
6063     * Set the box to arrange its children homogeneously
6064     *
6065     * If enabled, homogeneous layout makes all items the same size, according
6066     * to the size of the largest of its children.
6067     *
6068     * @note This flag is ignored if a custom layout function is set.
6069     *
6070     * @param obj The box object
6071     * @param homogeneous The homogeneous flag
6072     */
6073    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6074    /**
6075     * Get whether the box is using homogeneous mode or not
6076     *
6077     * @param obj The box object
6078     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6079     */
6080    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6081    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6082    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6083    /**
6084     * Add an object to the beginning of the pack list
6085     *
6086     * Pack @p subobj into the box @p obj, placing it first in the list of
6087     * children objects. The actual position the object will get on screen
6088     * depends on the layout used. If no custom layout is set, it will be at
6089     * the top or left, depending if the box is vertical or horizontal,
6090     * respectively.
6091     *
6092     * @param obj The box object
6093     * @param subobj The object to add to the box
6094     *
6095     * @see elm_box_pack_end()
6096     * @see elm_box_pack_before()
6097     * @see elm_box_pack_after()
6098     * @see elm_box_unpack()
6099     * @see elm_box_unpack_all()
6100     * @see elm_box_clear()
6101     */
6102    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6103    /**
6104     * Add an object at the end of the pack list
6105     *
6106     * Pack @p subobj into the box @p obj, placing it last in the list of
6107     * children objects. The actual position the object will get on screen
6108     * depends on the layout used. If no custom layout is set, it will be at
6109     * the bottom or right, depending if the box is vertical or horizontal,
6110     * respectively.
6111     *
6112     * @param obj The box object
6113     * @param subobj The object to add to the box
6114     *
6115     * @see elm_box_pack_start()
6116     * @see elm_box_pack_before()
6117     * @see elm_box_pack_after()
6118     * @see elm_box_unpack()
6119     * @see elm_box_unpack_all()
6120     * @see elm_box_clear()
6121     */
6122    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6123    /**
6124     * Adds an object to the box before the indicated object
6125     *
6126     * This will add the @p subobj to the box indicated before the object
6127     * indicated with @p before. If @p before is not already in the box, results
6128     * are undefined. Before means either to the left of the indicated object or
6129     * above it depending on orientation.
6130     *
6131     * @param obj The box object
6132     * @param subobj The object to add to the box
6133     * @param before The object before which to add it
6134     *
6135     * @see elm_box_pack_start()
6136     * @see elm_box_pack_end()
6137     * @see elm_box_pack_after()
6138     * @see elm_box_unpack()
6139     * @see elm_box_unpack_all()
6140     * @see elm_box_clear()
6141     */
6142    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6143    /**
6144     * Adds an object to the box after the indicated object
6145     *
6146     * This will add the @p subobj to the box indicated after the object
6147     * indicated with @p after. If @p after is not already in the box, results
6148     * are undefined. After means either to the right of the indicated object or
6149     * below it depending on orientation.
6150     *
6151     * @param obj The box object
6152     * @param subobj The object to add to the box
6153     * @param after The object after which to add it
6154     *
6155     * @see elm_box_pack_start()
6156     * @see elm_box_pack_end()
6157     * @see elm_box_pack_before()
6158     * @see elm_box_unpack()
6159     * @see elm_box_unpack_all()
6160     * @see elm_box_clear()
6161     */
6162    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6163    /**
6164     * Clear the box of all children
6165     *
6166     * Remove all the elements contained by the box, deleting the respective
6167     * objects.
6168     *
6169     * @param obj The box object
6170     *
6171     * @see elm_box_unpack()
6172     * @see elm_box_unpack_all()
6173     */
6174    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6175    /**
6176     * Unpack a box item
6177     *
6178     * Remove the object given by @p subobj from the box @p obj without
6179     * deleting it.
6180     *
6181     * @param obj The box object
6182     *
6183     * @see elm_box_unpack_all()
6184     * @see elm_box_clear()
6185     */
6186    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6187    /**
6188     * Remove all items from the box, without deleting them
6189     *
6190     * Clear the box from all children, but don't delete the respective objects.
6191     * If no other references of the box children exist, the objects will never
6192     * be deleted, and thus the application will leak the memory. Make sure
6193     * when using this function that you hold a reference to all the objects
6194     * in the box @p obj.
6195     *
6196     * @param obj The box object
6197     *
6198     * @see elm_box_clear()
6199     * @see elm_box_unpack()
6200     */
6201    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6202    /**
6203     * Retrieve a list of the objects packed into the box
6204     *
6205     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6206     * The order of the list corresponds to the packing order the box uses.
6207     *
6208     * You must free this list with eina_list_free() once you are done with it.
6209     *
6210     * @param obj The box object
6211     */
6212    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6213    /**
6214     * Set the space (padding) between the box's elements.
6215     *
6216     * Extra space in pixels that will be added between a box child and its
6217     * neighbors after its containing cell has been calculated. This padding
6218     * is set for all elements in the box, besides any possible padding that
6219     * individual elements may have through their size hints.
6220     *
6221     * @param obj The box object
6222     * @param horizontal The horizontal space between elements
6223     * @param vertical The vertical space between elements
6224     */
6225    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6226    /**
6227     * Get the space (padding) between the box's elements.
6228     *
6229     * @param obj The box object
6230     * @param horizontal The horizontal space between elements
6231     * @param vertical The vertical space between elements
6232     *
6233     * @see elm_box_padding_set()
6234     */
6235    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6236    /**
6237     * Set the alignment of the whole bouding box of contents.
6238     *
6239     * Sets how the bounding box containing all the elements of the box, after
6240     * their sizes and position has been calculated, will be aligned within
6241     * the space given for the whole box widget.
6242     *
6243     * @param obj The box object
6244     * @param horizontal The horizontal alignment of elements
6245     * @param vertical The vertical alignment of elements
6246     */
6247    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6248    /**
6249     * Get the alignment of the whole bouding box of contents.
6250     *
6251     * @param obj The box object
6252     * @param horizontal The horizontal alignment of elements
6253     * @param vertical The vertical alignment of elements
6254     *
6255     * @see elm_box_align_set()
6256     */
6257    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6258
6259    /**
6260     * Force the box to recalculate its children packing.
6261     *
6262     * If any children was added or removed, box will not calculate the
6263     * values immediately rather leaving it to the next main loop
6264     * iteration. While this is great as it would save lots of
6265     * recalculation, whenever you need to get the position of a just
6266     * added item you must force recalculate before doing so.
6267     *
6268     * @param obj The box object.
6269     */
6270    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6271
6272    /**
6273     * Set the layout defining function to be used by the box
6274     *
6275     * Whenever anything changes that requires the box in @p obj to recalculate
6276     * the size and position of its elements, the function @p cb will be called
6277     * to determine what the layout of the children will be.
6278     *
6279     * Once a custom function is set, everything about the children layout
6280     * is defined by it. The flags set by elm_box_horizontal_set() and
6281     * elm_box_homogeneous_set() no longer have any meaning, and the values
6282     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6283     * layout function to decide if they are used and how. These last two
6284     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6285     * passed to @p cb. The @c Evas_Object the function receives is not the
6286     * Elementary widget, but the internal Evas Box it uses, so none of the
6287     * functions described here can be used on it.
6288     *
6289     * Any of the layout functions in @c Evas can be used here, as well as the
6290     * special elm_box_layout_transition().
6291     *
6292     * The final @p data argument received by @p cb is the same @p data passed
6293     * here, and the @p free_data function will be called to free it
6294     * whenever the box is destroyed or another layout function is set.
6295     *
6296     * Setting @p cb to NULL will revert back to the default layout function.
6297     *
6298     * @param obj The box object
6299     * @param cb The callback function used for layout
6300     * @param data Data that will be passed to layout function
6301     * @param free_data Function called to free @p data
6302     *
6303     * @see elm_box_layout_transition()
6304     */
6305    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);
6306    /**
6307     * Special layout function that animates the transition from one layout to another
6308     *
6309     * Normally, when switching the layout function for a box, this will be
6310     * reflected immediately on screen on the next render, but it's also
6311     * possible to do this through an animated transition.
6312     *
6313     * This is done by creating an ::Elm_Box_Transition and setting the box
6314     * layout to this function.
6315     *
6316     * For example:
6317     * @code
6318     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6319     *                            evas_object_box_layout_vertical, // start
6320     *                            NULL, // data for initial layout
6321     *                            NULL, // free function for initial data
6322     *                            evas_object_box_layout_horizontal, // end
6323     *                            NULL, // data for final layout
6324     *                            NULL, // free function for final data
6325     *                            anim_end, // will be called when animation ends
6326     *                            NULL); // data for anim_end function\
6327     * elm_box_layout_set(box, elm_box_layout_transition, t,
6328     *                    elm_box_transition_free);
6329     * @endcode
6330     *
6331     * @note This function can only be used with elm_box_layout_set(). Calling
6332     * it directly will not have the expected results.
6333     *
6334     * @see elm_box_transition_new
6335     * @see elm_box_transition_free
6336     * @see elm_box_layout_set
6337     */
6338    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6339    /**
6340     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6341     *
6342     * If you want to animate the change from one layout to another, you need
6343     * to set the layout function of the box to elm_box_layout_transition(),
6344     * passing as user data to it an instance of ::Elm_Box_Transition with the
6345     * necessary information to perform this animation. The free function to
6346     * set for the layout is elm_box_transition_free().
6347     *
6348     * The parameters to create an ::Elm_Box_Transition sum up to how long
6349     * will it be, in seconds, a layout function to describe the initial point,
6350     * another for the final position of the children and one function to be
6351     * called when the whole animation ends. This last function is useful to
6352     * set the definitive layout for the box, usually the same as the end
6353     * layout for the animation, but could be used to start another transition.
6354     *
6355     * @param start_layout The layout function that will be used to start the animation
6356     * @param start_layout_data The data to be passed the @p start_layout function
6357     * @param start_layout_free_data Function to free @p start_layout_data
6358     * @param end_layout The layout function that will be used to end the animation
6359     * @param end_layout_free_data The data to be passed the @p end_layout function
6360     * @param end_layout_free_data Function to free @p end_layout_data
6361     * @param transition_end_cb Callback function called when animation ends
6362     * @param transition_end_data Data to be passed to @p transition_end_cb
6363     * @return An instance of ::Elm_Box_Transition
6364     *
6365     * @see elm_box_transition_new
6366     * @see elm_box_layout_transition
6367     */
6368    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);
6369    /**
6370     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6371     *
6372     * This function is mostly useful as the @c free_data parameter in
6373     * elm_box_layout_set() when elm_box_layout_transition().
6374     *
6375     * @param data The Elm_Box_Transition instance to be freed.
6376     *
6377     * @see elm_box_transition_new
6378     * @see elm_box_layout_transition
6379     */
6380    EAPI void                elm_box_transition_free(void *data);
6381    /**
6382     * @}
6383     */
6384
6385    /* button */
6386    /**
6387     * @defgroup Button Button
6388     *
6389     * @image html img/widget/button/preview-00.png
6390     * @image latex img/widget/button/preview-00.eps
6391     * @image html img/widget/button/preview-01.png
6392     * @image latex img/widget/button/preview-01.eps
6393     * @image html img/widget/button/preview-02.png
6394     * @image latex img/widget/button/preview-02.eps
6395     *
6396     * This is a push-button. Press it and run some function. It can contain
6397     * a simple label and icon object and it also has an autorepeat feature.
6398     *
6399     * This widgets emits the following signals:
6400     * @li "clicked": the user clicked the button (press/release).
6401     * @li "repeated": the user pressed the button without releasing it.
6402     * @li "pressed": button was pressed.
6403     * @li "unpressed": button was released after being pressed.
6404     * In all three cases, the @c event parameter of the callback will be
6405     * @c NULL.
6406     *
6407     * Also, defined in the default theme, the button has the following styles
6408     * available:
6409     * @li default: a normal button.
6410     * @li anchor: Like default, but the button fades away when the mouse is not
6411     * over it, leaving only the text or icon.
6412     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6413     * continuous look across its options.
6414     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6415     *
6416     * Default contents parts of the button widget that you can use for are:
6417     * @li "icon" - A icon of the button
6418     *
6419     * Default text parts of the button widget that you can use for are:
6420     * @li "default" - Label of the button
6421     *
6422     * Follow through a complete example @ref button_example_01 "here".
6423     * @{
6424     */
6425
6426    typedef enum
6427      {
6428         UIControlStateDefault,
6429         UIControlStateHighlighted,
6430         UIControlStateDisabled,
6431         UIControlStateFocused,
6432         UIControlStateReserved
6433      } UIControlState;
6434
6435    /**
6436     * Add a new button to the parent's canvas
6437     *
6438     * @param parent The parent object
6439     * @return The new object or NULL if it cannot be created
6440     */
6441    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6442    /**
6443     * Set the label used in the button
6444     *
6445     * The passed @p label can be NULL to clean any existing text in it and
6446     * leave the button as an icon only object.
6447     *
6448     * @param obj The button object
6449     * @param label The text will be written on the button
6450     * @deprecated use elm_object_text_set() instead.
6451     */
6452    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6453    /**
6454     * Get the label set for the button
6455     *
6456     * The string returned is an internal pointer and should not be freed or
6457     * altered. It will also become invalid when the button is destroyed.
6458     * The string returned, if not NULL, is a stringshare, so if you need to
6459     * keep it around even after the button is destroyed, you can use
6460     * eina_stringshare_ref().
6461     *
6462     * @param obj The button object
6463     * @return The text set to the label, or NULL if nothing is set
6464     * @deprecated use elm_object_text_set() instead.
6465     */
6466    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6467    /**
6468     * Set the label for each state of button
6469     *
6470     * The passed @p label can be NULL to clean any existing text in it and
6471     * leave the button as an icon only object for the state.
6472     *
6473     * @param obj The button object
6474     * @param label The text will be written on the button
6475     * @param state The state of button
6476     *
6477     * @ingroup Button
6478     */
6479    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6480    /**
6481     * Get the label of button for each state
6482     *
6483     * The string returned is an internal pointer and should not be freed or
6484     * altered. It will also become invalid when the button is destroyed.
6485     * The string returned, if not NULL, is a stringshare, so if you need to
6486     * keep it around even after the button is destroyed, you can use
6487     * eina_stringshare_ref().
6488     *
6489     * @param obj The button object
6490     * @param state The state of button
6491     * @return The title of button for state
6492     *
6493     * @ingroup Button
6494     */
6495    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6496    /**
6497     * Set the icon used for the button
6498     *
6499     * Setting a new icon will delete any other that was previously set, making
6500     * any reference to them invalid. If you need to maintain the previous
6501     * object alive, unset it first with elm_button_icon_unset().
6502     *
6503     * @param obj The button object
6504     * @param icon The icon object for the button
6505     * @deprecated use elm_object_part_content_set() instead.
6506     */
6507    WILL_DEPRECATE  EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6508    /**
6509     * Get the icon used for the button
6510     *
6511     * Return the icon object which is set for this widget. If the button is
6512     * destroyed or another icon is set, the returned object will be deleted
6513     * and any reference to it will be invalid.
6514     *
6515     * @param obj The button object
6516     * @return The icon object that is being used
6517     *
6518     * @deprecated use elm_object_part_content_get() instead
6519     */
6520    WILL_DEPRECATE  EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6521    /**
6522     * Remove the icon set without deleting it and return the object
6523     *
6524     * This function drops the reference the button holds of the icon object
6525     * and returns this last object. It is used in case you want to remove any
6526     * icon, or set another one, without deleting the actual object. The button
6527     * will be left without an icon set.
6528     *
6529     * @param obj The button object
6530     * @return The icon object that was being used
6531     * @deprecated use elm_object_part_content_unset() instead.
6532     */
6533    WILL_DEPRECATE  EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6534    /**
6535     * Turn on/off the autorepeat event generated when the button is kept pressed
6536     *
6537     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6538     * signal when they are clicked.
6539     *
6540     * When on, keeping a button pressed will continuously emit a @c repeated
6541     * signal until the button is released. The time it takes until it starts
6542     * emitting the signal is given by
6543     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6544     * new emission by elm_button_autorepeat_gap_timeout_set().
6545     *
6546     * @param obj The button object
6547     * @param on  A bool to turn on/off the event
6548     */
6549    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6550    /**
6551     * Get whether the autorepeat feature is enabled
6552     *
6553     * @param obj The button object
6554     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6555     *
6556     * @see elm_button_autorepeat_set()
6557     */
6558    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559    /**
6560     * Set the initial timeout before the autorepeat event is generated
6561     *
6562     * Sets the timeout, in seconds, since the button is pressed until the
6563     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6564     * won't be any delay and the even will be fired the moment the button is
6565     * pressed.
6566     *
6567     * @param obj The button object
6568     * @param t   Timeout in seconds
6569     *
6570     * @see elm_button_autorepeat_set()
6571     * @see elm_button_autorepeat_gap_timeout_set()
6572     */
6573    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6574    /**
6575     * Get the initial timeout before the autorepeat event is generated
6576     *
6577     * @param obj The button object
6578     * @return Timeout in seconds
6579     *
6580     * @see elm_button_autorepeat_initial_timeout_set()
6581     */
6582    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6583    /**
6584     * Set the interval between each generated autorepeat event
6585     *
6586     * After the first @c repeated event is fired, all subsequent ones will
6587     * follow after a delay of @p t seconds for each.
6588     *
6589     * @param obj The button object
6590     * @param t   Interval in seconds
6591     *
6592     * @see elm_button_autorepeat_initial_timeout_set()
6593     */
6594    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6595    /**
6596     * Get the interval between each generated autorepeat event
6597     *
6598     * @param obj The button object
6599     * @return Interval in seconds
6600     */
6601    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6602    /**
6603     * @}
6604     */
6605
6606    /**
6607     * @defgroup File_Selector_Button File Selector Button
6608     *
6609     * @image html img/widget/fileselector_button/preview-00.png
6610     * @image latex img/widget/fileselector_button/preview-00.eps
6611     * @image html img/widget/fileselector_button/preview-01.png
6612     * @image latex img/widget/fileselector_button/preview-01.eps
6613     * @image html img/widget/fileselector_button/preview-02.png
6614     * @image latex img/widget/fileselector_button/preview-02.eps
6615     *
6616     * This is a button that, when clicked, creates an Elementary
6617     * window (or inner window) <b> with a @ref Fileselector "file
6618     * selector widget" within</b>. When a file is chosen, the (inner)
6619     * window is closed and the button emits a signal having the
6620     * selected file as it's @c event_info.
6621     *
6622     * This widget encapsulates operations on its internal file
6623     * selector on its own API. There is less control over its file
6624     * selector than that one would have instatiating one directly.
6625     *
6626     * The following styles are available for this button:
6627     * @li @c "default"
6628     * @li @c "anchor"
6629     * @li @c "hoversel_vertical"
6630     * @li @c "hoversel_vertical_entry"
6631     *
6632     * Smart callbacks one can register to:
6633     * - @c "file,chosen" - the user has selected a path, whose string
6634     *   pointer comes as the @c event_info data (a stringshared
6635     *   string)
6636     *
6637     * Here is an example on its usage:
6638     * @li @ref fileselector_button_example
6639     *
6640     * @see @ref File_Selector_Entry for a similar widget.
6641     * @{
6642     */
6643
6644    /**
6645     * Add a new file selector button widget to the given parent
6646     * Elementary (container) object
6647     *
6648     * @param parent The parent object
6649     * @return a new file selector button widget handle or @c NULL, on
6650     * errors
6651     */
6652    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6653
6654    /**
6655     * Set the label for a given file selector button widget
6656     *
6657     * @param obj The file selector button widget
6658     * @param label The text label to be displayed on @p obj
6659     *
6660     * @deprecated use elm_object_text_set() instead.
6661     */
6662    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6663
6664    /**
6665     * Get the label set for a given file selector button widget
6666     *
6667     * @param obj The file selector button widget
6668     * @return The button label
6669     *
6670     * @deprecated use elm_object_text_set() instead.
6671     */
6672    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6673
6674    /**
6675     * Set the icon on a given file selector button widget
6676     *
6677     * @param obj The file selector button widget
6678     * @param icon The icon object for the button
6679     *
6680     * Once the icon object is set, a previously set one will be
6681     * deleted. If you want to keep the latter, use the
6682     * elm_fileselector_button_icon_unset() function.
6683     *
6684     * @see elm_fileselector_button_icon_get()
6685     */
6686    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6687
6688    /**
6689     * Get the icon set for a given file selector button widget
6690     *
6691     * @param obj The file selector button widget
6692     * @return The icon object currently set on @p obj or @c NULL, if
6693     * none is
6694     *
6695     * @see elm_fileselector_button_icon_set()
6696     */
6697    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6698
6699    /**
6700     * Unset the icon used in a given file selector button widget
6701     *
6702     * @param obj The file selector button widget
6703     * @return The icon object that was being used on @p obj or @c
6704     * NULL, on errors
6705     *
6706     * Unparent and return the icon object which was set for this
6707     * widget.
6708     *
6709     * @see elm_fileselector_button_icon_set()
6710     */
6711    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6712
6713    /**
6714     * Set the title for a given file selector button widget's window
6715     *
6716     * @param obj The file selector button widget
6717     * @param title The title string
6718     *
6719     * This will change the window's title, when the file selector pops
6720     * out after a click on the button. Those windows have the default
6721     * (unlocalized) value of @c "Select a file" as titles.
6722     *
6723     * @note It will only take any effect if the file selector
6724     * button widget is @b not under "inwin mode".
6725     *
6726     * @see elm_fileselector_button_window_title_get()
6727     */
6728    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6729
6730    /**
6731     * Get the title set for a given file selector button widget's
6732     * window
6733     *
6734     * @param obj The file selector button widget
6735     * @return Title of the file selector button's window
6736     *
6737     * @see elm_fileselector_button_window_title_get() for more details
6738     */
6739    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6740
6741    /**
6742     * Set the size of a given file selector button widget's window,
6743     * holding the file selector itself.
6744     *
6745     * @param obj The file selector button widget
6746     * @param width The window's width
6747     * @param height The window's height
6748     *
6749     * @note it will only take any effect if the file selector button
6750     * widget is @b not under "inwin mode". The default size for the
6751     * window (when applicable) is 400x400 pixels.
6752     *
6753     * @see elm_fileselector_button_window_size_get()
6754     */
6755    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6756
6757    /**
6758     * Get the size of a given file selector button widget's window,
6759     * holding the file selector itself.
6760     *
6761     * @param obj The file selector button widget
6762     * @param width Pointer into which to store the width value
6763     * @param height Pointer into which to store the height value
6764     *
6765     * @note Use @c NULL pointers on the size values you're not
6766     * interested in: they'll be ignored by the function.
6767     *
6768     * @see elm_fileselector_button_window_size_set(), for more details
6769     */
6770    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6771
6772    /**
6773     * Set the initial file system path for a given file selector
6774     * button widget
6775     *
6776     * @param obj The file selector button widget
6777     * @param path The path string
6778     *
6779     * It must be a <b>directory</b> path, which will have the contents
6780     * displayed initially in the file selector's view, when invoked
6781     * from @p obj. The default initial path is the @c "HOME"
6782     * environment variable's value.
6783     *
6784     * @see elm_fileselector_button_path_get()
6785     */
6786    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6787
6788    /**
6789     * Get the initial file system path set for a given file selector
6790     * button widget
6791     *
6792     * @param obj The file selector button widget
6793     * @return path The path string
6794     *
6795     * @see elm_fileselector_button_path_set() for more details
6796     */
6797    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6798
6799    /**
6800     * Enable/disable a tree view in the given file selector button
6801     * widget's internal file selector
6802     *
6803     * @param obj The file selector button widget
6804     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6805     * disable
6806     *
6807     * This has the same effect as elm_fileselector_expandable_set(),
6808     * but now applied to a file selector button's internal file
6809     * selector.
6810     *
6811     * @note There's no way to put a file selector button's internal
6812     * file selector in "grid mode", as one may do with "pure" file
6813     * selectors.
6814     *
6815     * @see elm_fileselector_expandable_get()
6816     */
6817    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6818
6819    /**
6820     * Get whether tree view is enabled for the given file selector
6821     * button widget's internal file selector
6822     *
6823     * @param obj The file selector button widget
6824     * @return @c EINA_TRUE if @p obj widget's internal file selector
6825     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6826     *
6827     * @see elm_fileselector_expandable_set() for more details
6828     */
6829    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6830
6831    /**
6832     * Set whether a given file selector button widget's internal file
6833     * selector is to display folders only or the directory contents,
6834     * as well.
6835     *
6836     * @param obj The file selector button widget
6837     * @param only @c EINA_TRUE to make @p obj widget's internal file
6838     * selector only display directories, @c EINA_FALSE to make files
6839     * to be displayed in it too
6840     *
6841     * This has the same effect as elm_fileselector_folder_only_set(),
6842     * but now applied to a file selector button's internal file
6843     * selector.
6844     *
6845     * @see elm_fileselector_folder_only_get()
6846     */
6847    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6848
6849    /**
6850     * Get whether a given file selector button widget's internal file
6851     * selector is displaying folders only or the directory contents,
6852     * as well.
6853     *
6854     * @param obj The file selector button widget
6855     * @return @c EINA_TRUE if @p obj widget's internal file
6856     * selector is only displaying directories, @c EINA_FALSE if files
6857     * are being displayed in it too (and on errors)
6858     *
6859     * @see elm_fileselector_button_folder_only_set() for more details
6860     */
6861    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6862
6863    /**
6864     * Enable/disable the file name entry box where the user can type
6865     * in a name for a file, in a given file selector button widget's
6866     * internal file selector.
6867     *
6868     * @param obj The file selector button widget
6869     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6870     * file selector a "saving dialog", @c EINA_FALSE otherwise
6871     *
6872     * This has the same effect as elm_fileselector_is_save_set(),
6873     * but now applied to a file selector button's internal file
6874     * selector.
6875     *
6876     * @see elm_fileselector_is_save_get()
6877     */
6878    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6879
6880    /**
6881     * Get whether the given file selector button widget's internal
6882     * file selector is in "saving dialog" mode
6883     *
6884     * @param obj The file selector button widget
6885     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6886     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6887     * errors)
6888     *
6889     * @see elm_fileselector_button_is_save_set() for more details
6890     */
6891    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6892
6893    /**
6894     * Set whether a given file selector button widget's internal file
6895     * selector will raise an Elementary "inner window", instead of a
6896     * dedicated Elementary window. By default, it won't.
6897     *
6898     * @param obj The file selector button widget
6899     * @param value @c EINA_TRUE to make it use an inner window, @c
6900     * EINA_TRUE to make it use a dedicated window
6901     *
6902     * @see elm_win_inwin_add() for more information on inner windows
6903     * @see elm_fileselector_button_inwin_mode_get()
6904     */
6905    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6906
6907    /**
6908     * Get whether a given file selector button widget's internal file
6909     * selector will raise an Elementary "inner window", instead of a
6910     * dedicated Elementary window.
6911     *
6912     * @param obj The file selector button widget
6913     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6914     * if it will use a dedicated window
6915     *
6916     * @see elm_fileselector_button_inwin_mode_set() for more details
6917     */
6918    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6919
6920    /**
6921     * @}
6922     */
6923
6924     /**
6925     * @defgroup File_Selector_Entry File Selector Entry
6926     *
6927     * @image html img/widget/fileselector_entry/preview-00.png
6928     * @image latex img/widget/fileselector_entry/preview-00.eps
6929     *
6930     * This is an entry made to be filled with or display a <b>file
6931     * system path string</b>. Besides the entry itself, the widget has
6932     * a @ref File_Selector_Button "file selector button" on its side,
6933     * which will raise an internal @ref Fileselector "file selector widget",
6934     * when clicked, for path selection aided by file system
6935     * navigation.
6936     *
6937     * This file selector may appear in an Elementary window or in an
6938     * inner window. When a file is chosen from it, the (inner) window
6939     * is closed and the selected file's path string is exposed both as
6940     * an smart event and as the new text on the entry.
6941     *
6942     * This widget encapsulates operations on its internal file
6943     * selector on its own API. There is less control over its file
6944     * selector than that one would have instatiating one directly.
6945     *
6946     * Smart callbacks one can register to:
6947     * - @c "changed" - The text within the entry was changed
6948     * - @c "activated" - The entry has had editing finished and
6949     *   changes are to be "committed"
6950     * - @c "press" - The entry has been clicked
6951     * - @c "longpressed" - The entry has been clicked (and held) for a
6952     *   couple seconds
6953     * - @c "clicked" - The entry has been clicked
6954     * - @c "clicked,double" - The entry has been double clicked
6955     * - @c "focused" - The entry has received focus
6956     * - @c "unfocused" - The entry has lost focus
6957     * - @c "selection,paste" - A paste action has occurred on the
6958     *   entry
6959     * - @c "selection,copy" - A copy action has occurred on the entry
6960     * - @c "selection,cut" - A cut action has occurred on the entry
6961     * - @c "unpressed" - The file selector entry's button was released
6962     *   after being pressed.
6963     * - @c "file,chosen" - The user has selected a path via the file
6964     *   selector entry's internal file selector, whose string pointer
6965     *   comes as the @c event_info data (a stringshared string)
6966     *
6967     * Here is an example on its usage:
6968     * @li @ref fileselector_entry_example
6969     *
6970     * @see @ref File_Selector_Button for a similar widget.
6971     * @{
6972     */
6973
6974    /**
6975     * Add a new file selector entry widget to the given parent
6976     * Elementary (container) object
6977     *
6978     * @param parent The parent object
6979     * @return a new file selector entry widget handle or @c NULL, on
6980     * errors
6981     */
6982    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6983
6984    /**
6985     * Set the label for a given file selector entry widget's button
6986     *
6987     * @param obj The file selector entry widget
6988     * @param label The text label to be displayed on @p obj widget's
6989     * button
6990     *
6991     * @deprecated use elm_object_text_set() instead.
6992     */
6993    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6994
6995    /**
6996     * Get the label set for a given file selector entry widget's button
6997     *
6998     * @param obj The file selector entry widget
6999     * @return The widget button's label
7000     *
7001     * @deprecated use elm_object_text_set() instead.
7002     */
7003    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7004
7005    /**
7006     * Set the icon on a given file selector entry widget's button
7007     *
7008     * @param obj The file selector entry widget
7009     * @param icon The icon object for the entry's button
7010     *
7011     * Once the icon object is set, a previously set one will be
7012     * deleted. If you want to keep the latter, use the
7013     * elm_fileselector_entry_button_icon_unset() function.
7014     *
7015     * @see elm_fileselector_entry_button_icon_get()
7016     */
7017    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7018
7019    /**
7020     * Get the icon set for a given file selector entry widget's button
7021     *
7022     * @param obj The file selector entry widget
7023     * @return The icon object currently set on @p obj widget's button
7024     * or @c NULL, if none is
7025     *
7026     * @see elm_fileselector_entry_button_icon_set()
7027     */
7028    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7029
7030    /**
7031     * Unset the icon used in a given file selector entry widget's
7032     * button
7033     *
7034     * @param obj The file selector entry widget
7035     * @return The icon object that was being used on @p obj widget's
7036     * button or @c NULL, on errors
7037     *
7038     * Unparent and return the icon object which was set for this
7039     * widget's button.
7040     *
7041     * @see elm_fileselector_entry_button_icon_set()
7042     */
7043    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7044
7045    /**
7046     * Set the title for a given file selector entry widget's window
7047     *
7048     * @param obj The file selector entry widget
7049     * @param title The title string
7050     *
7051     * This will change the window's title, when the file selector pops
7052     * out after a click on the entry's button. Those windows have the
7053     * default (unlocalized) value of @c "Select a file" as titles.
7054     *
7055     * @note It will only take any effect if the file selector
7056     * entry widget is @b not under "inwin mode".
7057     *
7058     * @see elm_fileselector_entry_window_title_get()
7059     */
7060    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7061
7062    /**
7063     * Get the title set for a given file selector entry widget's
7064     * window
7065     *
7066     * @param obj The file selector entry widget
7067     * @return Title of the file selector entry's window
7068     *
7069     * @see elm_fileselector_entry_window_title_get() for more details
7070     */
7071    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7072
7073    /**
7074     * Set the size of a given file selector entry widget's window,
7075     * holding the file selector itself.
7076     *
7077     * @param obj The file selector entry widget
7078     * @param width The window's width
7079     * @param height The window's height
7080     *
7081     * @note it will only take any effect if the file selector entry
7082     * widget is @b not under "inwin mode". The default size for the
7083     * window (when applicable) is 400x400 pixels.
7084     *
7085     * @see elm_fileselector_entry_window_size_get()
7086     */
7087    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7088
7089    /**
7090     * Get the size of a given file selector entry widget's window,
7091     * holding the file selector itself.
7092     *
7093     * @param obj The file selector entry widget
7094     * @param width Pointer into which to store the width value
7095     * @param height Pointer into which to store the height value
7096     *
7097     * @note Use @c NULL pointers on the size values you're not
7098     * interested in: they'll be ignored by the function.
7099     *
7100     * @see elm_fileselector_entry_window_size_set(), for more details
7101     */
7102    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7103
7104    /**
7105     * Set the initial file system path and the entry's path string for
7106     * a given file selector entry widget
7107     *
7108     * @param obj The file selector entry widget
7109     * @param path The path string
7110     *
7111     * It must be a <b>directory</b> path, which will have the contents
7112     * displayed initially in the file selector's view, when invoked
7113     * from @p obj. The default initial path is the @c "HOME"
7114     * environment variable's value.
7115     *
7116     * @see elm_fileselector_entry_path_get()
7117     */
7118    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7119
7120    /**
7121     * Get the entry's path string for a given file selector entry
7122     * widget
7123     *
7124     * @param obj The file selector entry widget
7125     * @return path The path string
7126     *
7127     * @see elm_fileselector_entry_path_set() for more details
7128     */
7129    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7130
7131    /**
7132     * Enable/disable a tree view in the given file selector entry
7133     * widget's internal file selector
7134     *
7135     * @param obj The file selector entry widget
7136     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7137     * disable
7138     *
7139     * This has the same effect as elm_fileselector_expandable_set(),
7140     * but now applied to a file selector entry's internal file
7141     * selector.
7142     *
7143     * @note There's no way to put a file selector entry's internal
7144     * file selector in "grid mode", as one may do with "pure" file
7145     * selectors.
7146     *
7147     * @see elm_fileselector_expandable_get()
7148     */
7149    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7150
7151    /**
7152     * Get whether tree view is enabled for the given file selector
7153     * entry widget's internal file selector
7154     *
7155     * @param obj The file selector entry widget
7156     * @return @c EINA_TRUE if @p obj widget's internal file selector
7157     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7158     *
7159     * @see elm_fileselector_expandable_set() for more details
7160     */
7161    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7162
7163    /**
7164     * Set whether a given file selector entry widget's internal file
7165     * selector is to display folders only or the directory contents,
7166     * as well.
7167     *
7168     * @param obj The file selector entry widget
7169     * @param only @c EINA_TRUE to make @p obj widget's internal file
7170     * selector only display directories, @c EINA_FALSE to make files
7171     * to be displayed in it too
7172     *
7173     * This has the same effect as elm_fileselector_folder_only_set(),
7174     * but now applied to a file selector entry's internal file
7175     * selector.
7176     *
7177     * @see elm_fileselector_folder_only_get()
7178     */
7179    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7180
7181    /**
7182     * Get whether a given file selector entry widget's internal file
7183     * selector is displaying folders only or the directory contents,
7184     * as well.
7185     *
7186     * @param obj The file selector entry widget
7187     * @return @c EINA_TRUE if @p obj widget's internal file
7188     * selector is only displaying directories, @c EINA_FALSE if files
7189     * are being displayed in it too (and on errors)
7190     *
7191     * @see elm_fileselector_entry_folder_only_set() for more details
7192     */
7193    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7194
7195    /**
7196     * Enable/disable the file name entry box where the user can type
7197     * in a name for a file, in a given file selector entry widget's
7198     * internal file selector.
7199     *
7200     * @param obj The file selector entry widget
7201     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7202     * file selector a "saving dialog", @c EINA_FALSE otherwise
7203     *
7204     * This has the same effect as elm_fileselector_is_save_set(),
7205     * but now applied to a file selector entry's internal file
7206     * selector.
7207     *
7208     * @see elm_fileselector_is_save_get()
7209     */
7210    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7211
7212    /**
7213     * Get whether the given file selector entry widget's internal
7214     * file selector is in "saving dialog" mode
7215     *
7216     * @param obj The file selector entry widget
7217     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7218     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7219     * errors)
7220     *
7221     * @see elm_fileselector_entry_is_save_set() for more details
7222     */
7223    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7224
7225    /**
7226     * Set whether a given file selector entry widget's internal file
7227     * selector will raise an Elementary "inner window", instead of a
7228     * dedicated Elementary window. By default, it won't.
7229     *
7230     * @param obj The file selector entry widget
7231     * @param value @c EINA_TRUE to make it use an inner window, @c
7232     * EINA_TRUE to make it use a dedicated window
7233     *
7234     * @see elm_win_inwin_add() for more information on inner windows
7235     * @see elm_fileselector_entry_inwin_mode_get()
7236     */
7237    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7238
7239    /**
7240     * Get whether a given file selector entry widget's internal file
7241     * selector will raise an Elementary "inner window", instead of a
7242     * dedicated Elementary window.
7243     *
7244     * @param obj The file selector entry widget
7245     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7246     * if it will use a dedicated window
7247     *
7248     * @see elm_fileselector_entry_inwin_mode_set() for more details
7249     */
7250    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7251
7252    /**
7253     * Set the initial file system path for a given file selector entry
7254     * widget
7255     *
7256     * @param obj The file selector entry widget
7257     * @param path The path string
7258     *
7259     * It must be a <b>directory</b> path, which will have the contents
7260     * displayed initially in the file selector's view, when invoked
7261     * from @p obj. The default initial path is the @c "HOME"
7262     * environment variable's value.
7263     *
7264     * @see elm_fileselector_entry_path_get()
7265     */
7266    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7267
7268    /**
7269     * Get the parent directory's path to the latest file selection on
7270     * a given filer selector entry widget
7271     *
7272     * @param obj The file selector object
7273     * @return The (full) path of the directory of the last selection
7274     * on @p obj widget, a @b stringshared string
7275     *
7276     * @see elm_fileselector_entry_path_set()
7277     */
7278    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7279
7280    /**
7281     * @}
7282     */
7283
7284    /**
7285     * @defgroup Scroller Scroller
7286     *
7287     * A scroller holds a single object and "scrolls it around". This means that
7288     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7289     * region around, allowing to move through a much larger object that is
7290     * contained in the scroller. The scroller will always have a small minimum
7291     * size by default as it won't be limited by the contents of the scroller.
7292     *
7293     * Signals that you can add callbacks for are:
7294     * @li "edge,left" - the left edge of the content has been reached
7295     * @li "edge,right" - the right edge of the content has been reached
7296     * @li "edge,top" - the top edge of the content has been reached
7297     * @li "edge,bottom" - the bottom edge of the content has been reached
7298     * @li "scroll" - the content has been scrolled (moved)
7299     * @li "scroll,anim,start" - scrolling animation has started
7300     * @li "scroll,anim,stop" - scrolling animation has stopped
7301     * @li "scroll,drag,start" - dragging the contents around has started
7302     * @li "scroll,drag,stop" - dragging the contents around has stopped
7303     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7304     * user intervetion.
7305     *
7306     * @note When Elemementary is in embedded mode the scrollbars will not be
7307     * dragable, they appear merely as indicators of how much has been scrolled.
7308     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7309     * fingerscroll) won't work.
7310     *
7311     * Default contents parts of the scroller widget that you can use for are:
7312     * @li "default" - A content of the scroller
7313     *
7314     * In @ref tutorial_scroller you'll find an example of how to use most of
7315     * this API.
7316     * @{
7317     */
7318    /**
7319     * @brief Type that controls when scrollbars should appear.
7320     *
7321     * @see elm_scroller_policy_set()
7322     */
7323    typedef enum _Elm_Scroller_Policy
7324      {
7325         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7326         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7327         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7328         ELM_SCROLLER_POLICY_LAST
7329      } Elm_Scroller_Policy;
7330    /**
7331     * @brief Add a new scroller to the parent
7332     *
7333     * @param parent The parent object
7334     * @return The new object or NULL if it cannot be created
7335     */
7336    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7337    /**
7338     * @brief Set the content of the scroller widget (the object to be scrolled around).
7339     *
7340     * @param obj The scroller object
7341     * @param content The new content object
7342     *
7343     * Once the content object is set, a previously set one will be deleted.
7344     * If you want to keep that old content object, use the
7345     * elm_scroller_content_unset() function.
7346     * @deprecated use elm_object_content_set() instead
7347     */
7348    WILL_DEPRECATE  EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7349    /**
7350     * @brief Get the content of the scroller widget
7351     *
7352     * @param obj The slider object
7353     * @return The content that is being used
7354     *
7355     * Return the content object which is set for this widget
7356     *
7357     * @see elm_scroller_content_set()
7358     * @deprecated use elm_object_content_get() instead.
7359     */
7360    WILL_DEPRECATE  EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7361    /**
7362     * @brief Unset the content of the scroller widget
7363     *
7364     * @param obj The slider object
7365     * @return The content that was being used
7366     *
7367     * Unparent and return the content object which was set for this widget
7368     *
7369     * @see elm_scroller_content_set()
7370     * @deprecated use elm_object_content_unset() instead.
7371     */
7372    WILL_DEPRECATE  EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7373    /**
7374     * @brief Set custom theme elements for the scroller
7375     *
7376     * @param obj The scroller object
7377     * @param widget The widget name to use (default is "scroller")
7378     * @param base The base name to use (default is "base")
7379     */
7380    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7381    /**
7382     * @brief Make the scroller minimum size limited to the minimum size of the content
7383     *
7384     * @param obj The scroller object
7385     * @param w Enable limiting minimum size horizontally
7386     * @param h Enable limiting minimum size vertically
7387     *
7388     * By default the scroller will be as small as its design allows,
7389     * irrespective of its content. This will make the scroller minimum size the
7390     * right size horizontally and/or vertically to perfectly fit its content in
7391     * that direction.
7392     */
7393    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7394    /**
7395     * @brief Show a specific virtual region within the scroller content object
7396     *
7397     * @param obj The scroller object
7398     * @param x X coordinate of the region
7399     * @param y Y coordinate of the region
7400     * @param w Width of the region
7401     * @param h Height of the region
7402     *
7403     * This will ensure all (or part if it does not fit) of the designated
7404     * region in the virtual content object (0, 0 starting at the top-left of the
7405     * virtual content object) is shown within the scroller.
7406     */
7407    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);
7408    /**
7409     * @brief Set the scrollbar visibility policy
7410     *
7411     * @param obj The scroller object
7412     * @param policy_h Horizontal scrollbar policy
7413     * @param policy_v Vertical scrollbar policy
7414     *
7415     * This sets the scrollbar visibility policy for the given scroller.
7416     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7417     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7418     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7419     * respectively for the horizontal and vertical scrollbars.
7420     */
7421    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7422    /**
7423     * @brief Gets scrollbar visibility policy
7424     *
7425     * @param obj The scroller object
7426     * @param policy_h Horizontal scrollbar policy
7427     * @param policy_v Vertical scrollbar policy
7428     *
7429     * @see elm_scroller_policy_set()
7430     */
7431    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7432    /**
7433     * @brief Get the currently visible content region
7434     *
7435     * @param obj The scroller object
7436     * @param x X coordinate of the region
7437     * @param y Y coordinate of the region
7438     * @param w Width of the region
7439     * @param h Height of the region
7440     *
7441     * This gets the current region in the content object that is visible through
7442     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7443     * w, @p h values pointed to.
7444     *
7445     * @note All coordinates are relative to the content.
7446     *
7447     * @see elm_scroller_region_show()
7448     */
7449    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);
7450    /**
7451     * @brief Get the size of the content object
7452     *
7453     * @param obj The scroller object
7454     * @param w Width of the content object.
7455     * @param h Height of the content object.
7456     *
7457     * This gets the size of the content object of the scroller.
7458     */
7459    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7460    /**
7461     * @brief Set bouncing behavior
7462     *
7463     * @param obj The scroller object
7464     * @param h_bounce Allow bounce horizontally
7465     * @param v_bounce Allow bounce vertically
7466     *
7467     * When scrolling, the scroller may "bounce" when reaching an edge of the
7468     * content object. This is a visual way to indicate the end has been reached.
7469     * This is enabled by default for both axis. This API will set if it is enabled
7470     * for the given axis with the boolean parameters for each axis.
7471     */
7472    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7473    /**
7474     * @brief Get the bounce behaviour
7475     *
7476     * @param obj The Scroller object
7477     * @param h_bounce Will the scroller bounce horizontally or not
7478     * @param v_bounce Will the scroller bounce vertically or not
7479     *
7480     * @see elm_scroller_bounce_set()
7481     */
7482    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7483    /**
7484     * @brief Set scroll page size relative to viewport size.
7485     *
7486     * @param obj The scroller object
7487     * @param h_pagerel The horizontal page relative size
7488     * @param v_pagerel The vertical page relative size
7489     *
7490     * The scroller is capable of limiting scrolling by the user to "pages". That
7491     * is to jump by and only show a "whole page" at a time as if the continuous
7492     * area of the scroller content is split into page sized pieces. This sets
7493     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7494     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7495     * axis. This is mutually exclusive with page size
7496     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7497     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7498     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7499     * the other axis.
7500     */
7501    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7502    /**
7503     * @brief Set scroll page size.
7504     *
7505     * @param obj The scroller object
7506     * @param h_pagesize The horizontal page size
7507     * @param v_pagesize The vertical page size
7508     *
7509     * This sets the page size to an absolute fixed value, with 0 turning it off
7510     * for that axis.
7511     *
7512     * @see elm_scroller_page_relative_set()
7513     */
7514    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7515    /**
7516     * @brief Get scroll current page number.
7517     *
7518     * @param obj The scroller object
7519     * @param h_pagenumber The horizontal page number
7520     * @param v_pagenumber The vertical page number
7521     *
7522     * The page number starts from 0. 0 is the first page.
7523     * Current page means the page which meets the top-left of the viewport.
7524     * If there are two or more pages in the viewport, it returns the number of the page
7525     * which meets the top-left of the viewport.
7526     *
7527     * @see elm_scroller_last_page_get()
7528     * @see elm_scroller_page_show()
7529     * @see elm_scroller_page_brint_in()
7530     */
7531    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7532    /**
7533     * @brief Get scroll last page number.
7534     *
7535     * @param obj The scroller object
7536     * @param h_pagenumber The horizontal page number
7537     * @param v_pagenumber The vertical page number
7538     *
7539     * The page number starts from 0. 0 is the first page.
7540     * This returns the last page number among the pages.
7541     *
7542     * @see elm_scroller_current_page_get()
7543     * @see elm_scroller_page_show()
7544     * @see elm_scroller_page_brint_in()
7545     */
7546    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7547    /**
7548     * Show a specific virtual region within the scroller content object by page number.
7549     *
7550     * @param obj The scroller object
7551     * @param h_pagenumber The horizontal page number
7552     * @param v_pagenumber The vertical page number
7553     *
7554     * 0, 0 of the indicated page is located at the top-left of the viewport.
7555     * This will jump to the page directly without animation.
7556     *
7557     * Example of usage:
7558     *
7559     * @code
7560     * sc = elm_scroller_add(win);
7561     * elm_scroller_content_set(sc, content);
7562     * elm_scroller_page_relative_set(sc, 1, 0);
7563     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7564     * elm_scroller_page_show(sc, h_page + 1, v_page);
7565     * @endcode
7566     *
7567     * @see elm_scroller_page_bring_in()
7568     */
7569    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7570    /**
7571     * Show a specific virtual region within the scroller content object by page number.
7572     *
7573     * @param obj The scroller object
7574     * @param h_pagenumber The horizontal page number
7575     * @param v_pagenumber The vertical page number
7576     *
7577     * 0, 0 of the indicated page is located at the top-left of the viewport.
7578     * This will slide to the page with animation.
7579     *
7580     * Example of usage:
7581     *
7582     * @code
7583     * sc = elm_scroller_add(win);
7584     * elm_scroller_content_set(sc, content);
7585     * elm_scroller_page_relative_set(sc, 1, 0);
7586     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7587     * elm_scroller_page_bring_in(sc, h_page, v_page);
7588     * @endcode
7589     *
7590     * @see elm_scroller_page_show()
7591     */
7592    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7593    /**
7594     * @brief Show a specific virtual region within the scroller content object.
7595     *
7596     * @param obj The scroller object
7597     * @param x X coordinate of the region
7598     * @param y Y coordinate of the region
7599     * @param w Width of the region
7600     * @param h Height of the region
7601     *
7602     * This will ensure all (or part if it does not fit) of the designated
7603     * region in the virtual content object (0, 0 starting at the top-left of the
7604     * virtual content object) is shown within the scroller. Unlike
7605     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7606     * to this location (if configuration in general calls for transitions). It
7607     * may not jump immediately to the new location and make take a while and
7608     * show other content along the way.
7609     *
7610     * @see elm_scroller_region_show()
7611     */
7612    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);
7613    /**
7614     * @brief Set event propagation on a scroller
7615     *
7616     * @param obj The scroller object
7617     * @param propagation If propagation is enabled or not
7618     *
7619     * This enables or disabled event propagation from the scroller content to
7620     * the scroller and its parent. By default event propagation is disabled.
7621     */
7622    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7623    /**
7624     * @brief Get event propagation for a scroller
7625     *
7626     * @param obj The scroller object
7627     * @return The propagation state
7628     *
7629     * This gets the event propagation for a scroller.
7630     *
7631     * @see elm_scroller_propagate_events_set()
7632     */
7633    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7634    /**
7635     * @brief Set scrolling gravity on a scroller
7636     *
7637     * @param obj The scroller object
7638     * @param x The scrolling horizontal gravity
7639     * @param y The scrolling vertical gravity
7640     *
7641     * The gravity, defines how the scroller will adjust its view
7642     * when the size of the scroller contents increase.
7643     *
7644     * The scroller will adjust the view to glue itself as follows.
7645     *
7646     *  x=0.0, for showing the left most region of the content.
7647     *  x=1.0, for showing the right most region of the content.
7648     *  y=0.0, for showing the bottom most region of the content.
7649     *  y=1.0, for showing the top most region of the content.
7650     *
7651     * Default values for x and y are 0.0
7652     */
7653    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7654    /**
7655     * @brief Get scrolling gravity values for a scroller
7656     *
7657     * @param obj The scroller object
7658     * @param x The scrolling horizontal gravity
7659     * @param y The scrolling vertical gravity
7660     *
7661     * This gets gravity values for a scroller.
7662     *
7663     * @see elm_scroller_gravity_set()
7664     *
7665     */
7666    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7667    /**
7668     * @}
7669     */
7670
7671    /**
7672     * @defgroup Label Label
7673     *
7674     * @image html img/widget/label/preview-00.png
7675     * @image latex img/widget/label/preview-00.eps
7676     *
7677     * @brief Widget to display text, with simple html-like markup.
7678     *
7679     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7680     * text doesn't fit the geometry of the label it will be ellipsized or be
7681     * cut. Elementary provides several styles for this widget:
7682     * @li default - No animation
7683     * @li marker - Centers the text in the label and make it bold by default
7684     * @li slide_long - The entire text appears from the right of the screen and
7685     * slides until it disappears in the left of the screen(reappering on the
7686     * right again).
7687     * @li slide_short - The text appears in the left of the label and slides to
7688     * the right to show the overflow. When all of the text has been shown the
7689     * position is reset.
7690     * @li slide_bounce - The text appears in the left of the label and slides to
7691     * the right to show the overflow. When all of the text has been shown the
7692     * animation reverses, moving the text to the left.
7693     *
7694     * Custom themes can of course invent new markup tags and style them any way
7695     * they like.
7696     *
7697     * The following signals may be emitted by the label widget:
7698     * @li "language,changed": The program's language changed.
7699     *
7700     * See @ref tutorial_label for a demonstration of how to use a label widget.
7701     * @{
7702     */
7703    /**
7704     * @brief Add a new label to the parent
7705     *
7706     * @param parent The parent object
7707     * @return The new object or NULL if it cannot be created
7708     */
7709    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7710    /**
7711     * @brief Set the label on the label object
7712     *
7713     * @param obj The label object
7714     * @param label The label will be used on the label object
7715     * @deprecated See elm_object_text_set()
7716     */
7717    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 */
7718    /**
7719     * @brief Get the label used on the label object
7720     *
7721     * @param obj The label object
7722     * @return The string inside the label
7723     * @deprecated See elm_object_text_get()
7724     */
7725    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7726    /**
7727     * @brief Set the wrapping behavior of the label
7728     *
7729     * @param obj The label object
7730     * @param wrap To wrap text or not
7731     *
7732     * By default no wrapping is done. Possible values for @p wrap are:
7733     * @li ELM_WRAP_NONE - No wrapping
7734     * @li ELM_WRAP_CHAR - wrap between characters
7735     * @li ELM_WRAP_WORD - wrap between words
7736     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7737     */
7738    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7739    /**
7740     * @brief Get the wrapping behavior of the label
7741     *
7742     * @param obj The label object
7743     * @return Wrap type
7744     *
7745     * @see elm_label_line_wrap_set()
7746     */
7747    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7748    /**
7749     * @brief Set wrap width of the label
7750     *
7751     * @param obj The label object
7752     * @param w The wrap width in pixels at a minimum where words need to wrap
7753     *
7754     * This function sets the maximum width size hint of the label.
7755     *
7756     * @warning This is only relevant if the label is inside a container.
7757     */
7758    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7759    /**
7760     * @brief Get wrap width of the label
7761     *
7762     * @param obj The label object
7763     * @return The wrap width in pixels at a minimum where words need to wrap
7764     *
7765     * @see elm_label_wrap_width_set()
7766     */
7767    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7768    /**
7769     * @brief Set wrap height of the label
7770     *
7771     * @param obj The label object
7772     * @param h The wrap height in pixels at a minimum where words need to wrap
7773     *
7774     * This function sets the maximum height size hint of the label.
7775     *
7776     * @warning This is only relevant if the label is inside a container.
7777     */
7778    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7779    /**
7780     * @brief get wrap width of the label
7781     *
7782     * @param obj The label object
7783     * @return The wrap height in pixels at a minimum where words need to wrap
7784     */
7785    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7786    /**
7787     * @brief Set the font size on the label object.
7788     *
7789     * @param obj The label object
7790     * @param size font size
7791     *
7792     * @warning NEVER use this. It is for hyper-special cases only. use styles
7793     * instead. e.g. "default", "marker", "slide_long" etc.
7794     */
7795    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7796    /**
7797     * @brief Set the text color on the label object
7798     *
7799     * @param obj The label object
7800     * @param r Red property background color of The label object
7801     * @param g Green property background color of The label object
7802     * @param b Blue property background color of The label object
7803     * @param a Alpha property background color of The label object
7804     *
7805     * @warning NEVER use this. It is for hyper-special cases only. use styles
7806     * instead. e.g. "default", "marker", "slide_long" etc.
7807     */
7808    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);
7809    /**
7810     * @brief Set the text align on the label object
7811     *
7812     * @param obj The label object
7813     * @param align align mode ("left", "center", "right")
7814     *
7815     * @warning NEVER use this. It is for hyper-special cases only. use styles
7816     * instead. e.g. "default", "marker", "slide_long" etc.
7817     */
7818    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7819    /**
7820     * @brief Set background color of the label
7821     *
7822     * @param obj The label object
7823     * @param r Red property background color of The label object
7824     * @param g Green property background color of The label object
7825     * @param b Blue property background color of The label object
7826     * @param a Alpha property background alpha of The label object
7827     *
7828     * @warning NEVER use this. It is for hyper-special cases only. use styles
7829     * instead. e.g. "default", "marker", "slide_long" etc.
7830     */
7831    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);
7832    /**
7833     * @brief Set the ellipsis behavior of the label
7834     *
7835     * @param obj The label object
7836     * @param ellipsis To ellipsis text or not
7837     *
7838     * If set to true and the text doesn't fit in the label an ellipsis("...")
7839     * will be shown at the end of the widget.
7840     *
7841     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7842     * choosen wrap method was ELM_WRAP_WORD.
7843     */
7844    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7845    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7846    /**
7847     * @brief Set the text slide of the label
7848     *
7849     * @param obj The label object
7850     * @param slide To start slide or stop
7851     *
7852     * If set to true, the text of the label will slide/scroll through the length of
7853     * label.
7854     *
7855     * @warning This only works with the themes "slide_short", "slide_long" and
7856     * "slide_bounce".
7857     */
7858    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7859    /**
7860     * @brief Get the text slide mode of the label
7861     *
7862     * @param obj The label object
7863     * @return slide slide mode value
7864     *
7865     * @see elm_label_slide_set()
7866     */
7867    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7868    /**
7869     * @brief Set the slide duration(speed) of the label
7870     *
7871     * @param obj The label object
7872     * @return The duration in seconds in moving text from slide begin position
7873     * to slide end position
7874     */
7875    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7876    /**
7877     * @brief Get the slide duration(speed) of the label
7878     *
7879     * @param obj The label object
7880     * @return The duration time in moving text from slide begin position to slide end position
7881     *
7882     * @see elm_label_slide_duration_set()
7883     */
7884    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7885    /**
7886     * @}
7887     */
7888
7889    /**
7890     * @defgroup Frame Frame
7891     *
7892     * @image html img/widget/frame/preview-00.png
7893     * @image latex img/widget/frame/preview-00.eps
7894     *
7895     * @brief Frame is a widget that holds some content and has a title.
7896     *
7897     * The default look is a frame with a title, but Frame supports multple
7898     * styles:
7899     * @li default
7900     * @li pad_small
7901     * @li pad_medium
7902     * @li pad_large
7903     * @li pad_huge
7904     * @li outdent_top
7905     * @li outdent_bottom
7906     *
7907     * Of all this styles only default shows the title. Frame emits no signals.
7908     *
7909     * Default contents parts of the frame widget that you can use for are:
7910     * @li "default" - A content of the frame
7911     *
7912     * Default text parts of the frame widget that you can use for are:
7913     * @li "elm.text" - Label of the frame
7914     *
7915     * For a detailed example see the @ref tutorial_frame.
7916     *
7917     * @{
7918     */
7919    /**
7920     * @brief Add a new frame to the parent
7921     *
7922     * @param parent The parent object
7923     * @return The new object or NULL if it cannot be created
7924     */
7925    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7926    /**
7927     * @brief Set the frame label
7928     *
7929     * @param obj The frame object
7930     * @param label The label of this frame object
7931     *
7932     * @deprecated use elm_object_text_set() instead.
7933     */
7934    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7935    /**
7936     * @brief Get the frame label
7937     *
7938     * @param obj The frame object
7939     *
7940     * @return The label of this frame objet or NULL if unable to get frame
7941     *
7942     * @deprecated use elm_object_text_get() instead.
7943     */
7944    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7945    /**
7946     * @brief Set the content of the frame widget
7947     *
7948     * Once the content object is set, a previously set one will be deleted.
7949     * If you want to keep that old content object, use the
7950     * elm_frame_content_unset() function.
7951     *
7952     * @param obj The frame object
7953     * @param content The content will be filled in this frame object
7954     *
7955     * @deprecated use elm_object_content_set() instead.
7956     */
7957    WILL_DEPRECATE  EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7958    /**
7959     * @brief Get the content of the frame widget
7960     *
7961     * Return the content object which is set for this widget
7962     *
7963     * @param obj The frame object
7964     * @return The content that is being used
7965     *
7966     * @deprecated use elm_object_content_get() instead.
7967     */
7968    WILL_DEPRECATE  EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7969    /**
7970     * @brief Unset the content of the frame widget
7971     *
7972     * Unparent and return the content object which was set for this widget
7973     *
7974     * @param obj The frame object
7975     * @return The content that was being used
7976     *
7977     * @deprecated use elm_object_content_unset() instead.
7978     */
7979    WILL_DEPRECATE  EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7980    /**
7981     * @}
7982     */
7983
7984    /**
7985     * @defgroup Table Table
7986     *
7987     * A container widget to arrange other widgets in a table where items can
7988     * also span multiple columns or rows - even overlap (and then be raised or
7989     * lowered accordingly to adjust stacking if they do overlap).
7990     *
7991     * For a Table widget the row/column count is not fixed.
7992     * The table widget adjusts itself when subobjects are added to it dynamically.
7993     *
7994     * The followin are examples of how to use a table:
7995     * @li @ref tutorial_table_01
7996     * @li @ref tutorial_table_02
7997     *
7998     * @{
7999     */
8000    /**
8001     * @brief Add a new table to the parent
8002     *
8003     * @param parent The parent object
8004     * @return The new object or NULL if it cannot be created
8005     */
8006    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8007    /**
8008     * @brief Set the homogeneous layout in the table
8009     *
8010     * @param obj The layout object
8011     * @param homogeneous A boolean to set if the layout is homogeneous in the
8012     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8013     */
8014    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8015    /**
8016     * @brief Get the current table homogeneous mode.
8017     *
8018     * @param obj The table object
8019     * @return A boolean to indicating if the layout is homogeneous in the table
8020     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8021     */
8022    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8023    /**
8024     * @warning <b>Use elm_table_homogeneous_set() instead</b>
8025     */
8026    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
8027    /**
8028     * @warning <b>Use elm_table_homogeneous_get() instead</b>
8029     */
8030    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8031    /**
8032     * @brief Set padding between cells.
8033     *
8034     * @param obj The layout object.
8035     * @param horizontal set the horizontal padding.
8036     * @param vertical set the vertical padding.
8037     *
8038     * Default value is 0.
8039     */
8040    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8041    /**
8042     * @brief Get padding between cells.
8043     *
8044     * @param obj The layout object.
8045     * @param horizontal set the horizontal padding.
8046     * @param vertical set the vertical padding.
8047     */
8048    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8049    /**
8050     * @brief Add a subobject on the table with the coordinates passed
8051     *
8052     * @param obj The table object
8053     * @param subobj The subobject to be added to the table
8054     * @param x Row number
8055     * @param y Column number
8056     * @param w rowspan
8057     * @param h colspan
8058     *
8059     * @note All positioning inside the table is relative to rows and columns, so
8060     * a value of 0 for x and y, means the top left cell of the table, and a
8061     * value of 1 for w and h means @p subobj only takes that 1 cell.
8062     */
8063    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8064    /**
8065     * @brief Remove child from table.
8066     *
8067     * @param obj The table object
8068     * @param subobj The subobject
8069     */
8070    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8071    /**
8072     * @brief Faster way to remove all child objects from a table object.
8073     *
8074     * @param obj The table object
8075     * @param clear If true, will delete children, else just remove from table.
8076     */
8077    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8078    /**
8079     * @brief Set the packing location of an existing child of the table
8080     *
8081     * @param subobj The subobject to be modified in the table
8082     * @param x Row number
8083     * @param y Column number
8084     * @param w rowspan
8085     * @param h colspan
8086     *
8087     * Modifies the position of an object already in the table.
8088     *
8089     * @note All positioning inside the table is relative to rows and columns, so
8090     * a value of 0 for x and y, means the top left cell of the table, and a
8091     * value of 1 for w and h means @p subobj only takes that 1 cell.
8092     */
8093    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8094    /**
8095     * @brief Get the packing location of an existing child of the table
8096     *
8097     * @param subobj The subobject to be modified in the table
8098     * @param x Row number
8099     * @param y Column number
8100     * @param w rowspan
8101     * @param h colspan
8102     *
8103     * @see elm_table_pack_set()
8104     */
8105    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8106    /**
8107     * @}
8108     */
8109
8110    /**
8111     * @defgroup Gengrid Gengrid (Generic grid)
8112     *
8113     * This widget aims to position objects in a grid layout while
8114     * actually creating and rendering only the visible ones, using the
8115     * same idea as the @ref Genlist "genlist": the user defines a @b
8116     * class for each item, specifying functions that will be called at
8117     * object creation, deletion, etc. When those items are selected by
8118     * the user, a callback function is issued. Users may interact with
8119     * a gengrid via the mouse (by clicking on items to select them and
8120     * clicking on the grid's viewport and swiping to pan the whole
8121     * view) or via the keyboard, navigating through item with the
8122     * arrow keys.
8123     *
8124     * @section Gengrid_Layouts Gengrid layouts
8125     *
8126     * Gengrid may layout its items in one of two possible layouts:
8127     * - horizontal or
8128     * - vertical.
8129     *
8130     * When in "horizontal mode", items will be placed in @b columns,
8131     * from top to bottom and, when the space for a column is filled,
8132     * another one is started on the right, thus expanding the grid
8133     * horizontally, making for horizontal scrolling. When in "vertical
8134     * mode" , though, items will be placed in @b rows, from left to
8135     * right and, when the space for a row is filled, another one is
8136     * started below, thus expanding the grid vertically (and making
8137     * for vertical scrolling).
8138     *
8139     * @section Gengrid_Items Gengrid items
8140     *
8141     * An item in a gengrid can have 0 or more text labels (they can be
8142     * regular text or textblock Evas objects - that's up to the style
8143     * to determine), 0 or more icons (which are simply objects
8144     * swallowed into the gengrid item's theming Edje object) and 0 or
8145     * more <b>boolean states</b>, which have the behavior left to the
8146     * user to define. The Edje part names for each of these properties
8147     * will be looked up, in the theme file for the gengrid, under the
8148     * Edje (string) data items named @c "labels", @c "icons" and @c
8149     * "states", respectively. For each of those properties, if more
8150     * than one part is provided, they must have names listed separated
8151     * by spaces in the data fields. For the default gengrid item
8152     * theme, we have @b one label part (@c "elm.text"), @b two icon
8153     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8154     * no state parts.
8155     *
8156     * A gengrid item may be at one of several styles. Elementary
8157     * provides one by default - "default", but this can be extended by
8158     * system or application custom themes/overlays/extensions (see
8159     * @ref Theme "themes" for more details).
8160     *
8161     * @section Gengrid_Item_Class Gengrid item classes
8162     *
8163     * In order to have the ability to add and delete items on the fly,
8164     * gengrid implements a class (callback) system where the
8165     * application provides a structure with information about that
8166     * type of item (gengrid may contain multiple different items with
8167     * different classes, states and styles). Gengrid will call the
8168     * functions in this struct (methods) when an item is "realized"
8169     * (i.e., created dynamically, while the user is scrolling the
8170     * grid). All objects will simply be deleted when no longer needed
8171     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8172     * contains the following members:
8173     * - @c item_style - This is a constant string and simply defines
8174     * the name of the item style. It @b must be specified and the
8175     * default should be @c "default".
8176     * - @c func.label_get - This function is called when an item
8177     * object is actually created. The @c data parameter will point to
8178     * the same data passed to elm_gengrid_item_append() and related
8179     * item creation functions. The @c obj parameter is the gengrid
8180     * object itself, while the @c part one is the name string of one
8181     * of the existing text parts in the Edje group implementing the
8182     * item's theme. This function @b must return a strdup'()ed string,
8183     * as the caller will free() it when done. See
8184     * #Elm_Gengrid_Item_Label_Get_Cb.
8185     * - @c func.content_get - This function is called when an item object
8186     * is actually created. The @c data parameter will point to the
8187     * same data passed to elm_gengrid_item_append() and related item
8188     * creation functions. The @c obj parameter is the gengrid object
8189     * itself, while the @c part one is the name string of one of the
8190     * existing (content) swallow parts in the Edje group implementing the
8191     * item's theme. It must return @c NULL, when no content is desired,
8192     * or a valid object handle, otherwise. The object will be deleted
8193     * by the gengrid on its deletion or when the item is "unrealized".
8194     * See #Elm_Gengrid_Item_Content_Get_Cb.
8195     * - @c func.state_get - This function is called when an item
8196     * object is actually created. The @c data parameter will point to
8197     * the same data passed to elm_gengrid_item_append() and related
8198     * item creation functions. The @c obj parameter is the gengrid
8199     * object itself, while the @c part one is the name string of one
8200     * of the state parts in the Edje group implementing the item's
8201     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8202     * true/on. Gengrids will emit a signal to its theming Edje object
8203     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8204     * "source" arguments, respectively, when the state is true (the
8205     * default is false), where @c XXX is the name of the (state) part.
8206     * See #Elm_Gengrid_Item_State_Get_Cb.
8207     * - @c func.del - This is called when elm_gengrid_item_del() is
8208     * called on an item or elm_gengrid_clear() is called on the
8209     * gengrid. This is intended for use when gengrid items are
8210     * deleted, so any data attached to the item (e.g. its data
8211     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8212     *
8213     * @section Gengrid_Usage_Hints Usage hints
8214     *
8215     * If the user wants to have multiple items selected at the same
8216     * time, elm_gengrid_multi_select_set() will permit it. If the
8217     * gengrid is single-selection only (the default), then
8218     * elm_gengrid_select_item_get() will return the selected item or
8219     * @c NULL, if none is selected. If the gengrid is under
8220     * multi-selection, then elm_gengrid_selected_items_get() will
8221     * return a list (that is only valid as long as no items are
8222     * modified (added, deleted, selected or unselected) of child items
8223     * on a gengrid.
8224     *
8225     * If an item changes (internal (boolean) state, label or content 
8226     * changes), then use elm_gengrid_item_update() to have gengrid
8227     * update the item with the new state. A gengrid will re-"realize"
8228     * the item, thus calling the functions in the
8229     * #Elm_Gengrid_Item_Class set for that item.
8230     *
8231     * To programmatically (un)select an item, use
8232     * elm_gengrid_item_selected_set(). To get its selected state use
8233     * elm_gengrid_item_selected_get(). To make an item disabled
8234     * (unable to be selected and appear differently) use
8235     * elm_gengrid_item_disabled_set() to set this and
8236     * elm_gengrid_item_disabled_get() to get the disabled state.
8237     *
8238     * Grid cells will only have their selection smart callbacks called
8239     * when firstly getting selected. Any further clicks will do
8240     * nothing, unless you enable the "always select mode", with
8241     * elm_gengrid_always_select_mode_set(), thus making every click to
8242     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8243     * turn off the ability to select items entirely in the widget and
8244     * they will neither appear selected nor call the selection smart
8245     * callbacks.
8246     *
8247     * Remember that you can create new styles and add your own theme
8248     * augmentation per application with elm_theme_extension_add(). If
8249     * you absolutely must have a specific style that overrides any
8250     * theme the user or system sets up you can use
8251     * elm_theme_overlay_add() to add such a file.
8252     *
8253     * @section Gengrid_Smart_Events Gengrid smart events
8254     *
8255     * Smart events that you can add callbacks for are:
8256     * - @c "activated" - The user has double-clicked or pressed
8257     *   (enter|return|spacebar) on an item. The @c event_info parameter
8258     *   is the gengrid item that was activated.
8259     * - @c "clicked,double" - The user has double-clicked an item.
8260     *   The @c event_info parameter is the gengrid item that was double-clicked.
8261     * - @c "longpressed" - This is called when the item is pressed for a certain
8262     *   amount of time. By default it's 1 second.
8263     * - @c "selected" - The user has made an item selected. The
8264     *   @c event_info parameter is the gengrid item that was selected.
8265     * - @c "unselected" - The user has made an item unselected. The
8266     *   @c event_info parameter is the gengrid item that was unselected.
8267     * - @c "realized" - This is called when the item in the gengrid
8268     *   has its implementing Evas object instantiated, de facto. @c
8269     *   event_info is the gengrid item that was created. The object
8270     *   may be deleted at any time, so it is highly advised to the
8271     *   caller @b not to use the object pointer returned from
8272     *   elm_gengrid_item_object_get(), because it may point to freed
8273     *   objects.
8274     * - @c "unrealized" - This is called when the implementing Evas
8275     *   object for this item is deleted. @c event_info is the gengrid
8276     *   item that was deleted.
8277     * - @c "changed" - Called when an item is added, removed, resized
8278     *   or moved and when the gengrid is resized or gets "horizontal"
8279     *   property changes.
8280     * - @c "scroll,anim,start" - This is called when scrolling animation has
8281     *   started.
8282     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8283     *   stopped.
8284     * - @c "drag,start,up" - Called when the item in the gengrid has
8285     *   been dragged (not scrolled) up.
8286     * - @c "drag,start,down" - Called when the item in the gengrid has
8287     *   been dragged (not scrolled) down.
8288     * - @c "drag,start,left" - Called when the item in the gengrid has
8289     *   been dragged (not scrolled) left.
8290     * - @c "drag,start,right" - Called when the item in the gengrid has
8291     *   been dragged (not scrolled) right.
8292     * - @c "drag,stop" - Called when the item in the gengrid has
8293     *   stopped being dragged.
8294     * - @c "drag" - Called when the item in the gengrid is being
8295     *   dragged.
8296     * - @c "scroll" - called when the content has been scrolled
8297     *   (moved).
8298     * - @c "scroll,drag,start" - called when dragging the content has
8299     *   started.
8300     * - @c "scroll,drag,stop" - called when dragging the content has
8301     *   stopped.
8302     * - @c "edge,top" - This is called when the gengrid is scrolled until
8303     *   the top edge.
8304     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8305     *   until the bottom edge.
8306     * - @c "edge,left" - This is called when the gengrid is scrolled
8307     *   until the left edge.
8308     * - @c "edge,right" - This is called when the gengrid is scrolled
8309     *   until the right edge.
8310     *
8311     * List of gengrid examples:
8312     * @li @ref gengrid_example
8313     */
8314
8315    /**
8316     * @addtogroup Gengrid
8317     * @{
8318     */
8319
8320    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8321    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8322    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8323    /**
8324     * Label fetching class function for Elm_Gen_Item_Class.
8325     * @param data The data passed in the item creation function
8326     * @param obj The base widget object
8327     * @param part The part name of the swallow
8328     * @return The allocated (NOT stringshared) string to set as the label
8329     */
8330    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8331    /**
8332     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8333     * @param data The data passed in the item creation function
8334     * @param obj The base widget object
8335     * @param part The part name of the swallow
8336     * @return The content object to swallow
8337     */
8338    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8339    /**
8340     * State fetching class function for Elm_Gen_Item_Class.
8341     * @param data The data passed in the item creation function
8342     * @param obj The base widget object
8343     * @param part The part name of the swallow
8344     * @return The hell if I know
8345     */
8346    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8347    /**
8348     * Deletion class function for Elm_Gen_Item_Class.
8349     * @param data The data passed in the item creation function
8350     * @param obj The base widget object
8351     */
8352    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8353
8354    /* temporary compatibility code */
8355    typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8356    typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8357    typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8358    typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8359
8360    /**
8361     * @struct _Elm_Gengrid_Item_Class
8362     *
8363     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8364     * field details.
8365     */
8366    struct _Elm_Gengrid_Item_Class
8367      {
8368         const char             *item_style;
8369         struct _Elm_Gengrid_Item_Class_Func
8370           {
8371              Elm_Gengrid_Item_Label_Get_Cb label_get;
8372              union { /* temporary compatibility code */
8373                Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8374                Elm_Gengrid_Item_Content_Get_Cb content_get;
8375              };
8376              Elm_Gengrid_Item_State_Get_Cb state_get;
8377              Elm_Gengrid_Item_Del_Cb       del;
8378           } func;
8379      }; /**< #Elm_Gengrid_Item_Class member definitions */
8380    /**
8381     * Add a new gengrid widget to the given parent Elementary
8382     * (container) object
8383     *
8384     * @param parent The parent object
8385     * @return a new gengrid widget handle or @c NULL, on errors
8386     *
8387     * This function inserts a new gengrid widget on the canvas.
8388     *
8389     * @see elm_gengrid_item_size_set()
8390     * @see elm_gengrid_group_item_size_set()
8391     * @see elm_gengrid_horizontal_set()
8392     * @see elm_gengrid_item_append()
8393     * @see elm_gengrid_item_del()
8394     * @see elm_gengrid_clear()
8395     *
8396     * @ingroup Gengrid
8397     */
8398    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8399
8400    /**
8401     * Set the size for the items of a given gengrid widget
8402     *
8403     * @param obj The gengrid object.
8404     * @param w The items' width.
8405     * @param h The items' height;
8406     *
8407     * A gengrid, after creation, has still no information on the size
8408     * to give to each of its cells. So, you most probably will end up
8409     * with squares one @ref Fingers "finger" wide, the default
8410     * size. Use this function to force a custom size for you items,
8411     * making them as big as you wish.
8412     *
8413     * @see elm_gengrid_item_size_get()
8414     *
8415     * @ingroup Gengrid
8416     */
8417    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8418
8419    /**
8420     * Get the size set for the items of a given gengrid widget
8421     *
8422     * @param obj The gengrid object.
8423     * @param w Pointer to a variable where to store the items' width.
8424     * @param h Pointer to a variable where to store the items' height.
8425     *
8426     * @note Use @c NULL pointers on the size values you're not
8427     * interested in: they'll be ignored by the function.
8428     *
8429     * @see elm_gengrid_item_size_get() for more details
8430     *
8431     * @ingroup Gengrid
8432     */
8433    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8434
8435    /**
8436     * Set the items grid's alignment within a given gengrid widget
8437     *
8438     * @param obj The gengrid object.
8439     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8440     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8441     *
8442     * This sets the alignment of the whole grid of items of a gengrid
8443     * within its given viewport. By default, those values are both
8444     * 0.5, meaning that the gengrid will have its items grid placed
8445     * exactly in the middle of its viewport.
8446     *
8447     * @note If given alignment values are out of the cited ranges,
8448     * they'll be changed to the nearest boundary values on the valid
8449     * ranges.
8450     *
8451     * @see elm_gengrid_align_get()
8452     *
8453     * @ingroup Gengrid
8454     */
8455    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8456
8457    /**
8458     * Get the items grid's alignment values within a given gengrid
8459     * widget
8460     *
8461     * @param obj The gengrid object.
8462     * @param align_x Pointer to a variable where to store the
8463     * horizontal alignment.
8464     * @param align_y Pointer to a variable where to store the vertical
8465     * alignment.
8466     *
8467     * @note Use @c NULL pointers on the alignment values you're not
8468     * interested in: they'll be ignored by the function.
8469     *
8470     * @see elm_gengrid_align_set() for more details
8471     *
8472     * @ingroup Gengrid
8473     */
8474    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8475
8476    /**
8477     * Set whether a given gengrid widget is or not able have items
8478     * @b reordered
8479     *
8480     * @param obj The gengrid object
8481     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8482     * @c EINA_FALSE to turn it off
8483     *
8484     * If a gengrid is set to allow reordering, a click held for more
8485     * than 0.5 over a given item will highlight it specially,
8486     * signalling the gengrid has entered the reordering state. From
8487     * that time on, the user will be able to, while still holding the
8488     * mouse button down, move the item freely in the gengrid's
8489     * viewport, replacing to said item to the locations it goes to.
8490     * The replacements will be animated and, whenever the user
8491     * releases the mouse button, the item being replaced gets a new
8492     * definitive place in the grid.
8493     *
8494     * @see elm_gengrid_reorder_mode_get()
8495     *
8496     * @ingroup Gengrid
8497     */
8498    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8499
8500    /**
8501     * Get whether a given gengrid widget is or not able have items
8502     * @b reordered
8503     *
8504     * @param obj The gengrid object
8505     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8506     * off
8507     *
8508     * @see elm_gengrid_reorder_mode_set() for more details
8509     *
8510     * @ingroup Gengrid
8511     */
8512    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8513
8514    /**
8515     * Append a new item in a given gengrid widget.
8516     *
8517     * @param obj The gengrid object.
8518     * @param gic The item class for the item.
8519     * @param data The item data.
8520     * @param func Convenience function called when the item is
8521     * selected.
8522     * @param func_data Data to be passed to @p func.
8523     * @return A handle to the item added or @c NULL, on errors.
8524     *
8525     * This adds an item to the beginning of the gengrid.
8526     *
8527     * @see elm_gengrid_item_prepend()
8528     * @see elm_gengrid_item_insert_before()
8529     * @see elm_gengrid_item_insert_after()
8530     * @see elm_gengrid_item_del()
8531     *
8532     * @ingroup Gengrid
8533     */
8534    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);
8535
8536    /**
8537     * Prepend a new item in a given gengrid widget.
8538     *
8539     * @param obj The gengrid object.
8540     * @param gic The item class for the item.
8541     * @param data The item data.
8542     * @param func Convenience function called when the item is
8543     * selected.
8544     * @param func_data Data to be passed to @p func.
8545     * @return A handle to the item added or @c NULL, on errors.
8546     *
8547     * This adds an item to the end of the gengrid.
8548     *
8549     * @see elm_gengrid_item_append()
8550     * @see elm_gengrid_item_insert_before()
8551     * @see elm_gengrid_item_insert_after()
8552     * @see elm_gengrid_item_del()
8553     *
8554     * @ingroup Gengrid
8555     */
8556    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);
8557
8558    /**
8559     * Insert an item before another in a gengrid widget
8560     *
8561     * @param obj The gengrid object.
8562     * @param gic The item class for the item.
8563     * @param data The item data.
8564     * @param relative The item to place this new one before.
8565     * @param func Convenience function called when the item is
8566     * selected.
8567     * @param func_data Data to be passed to @p func.
8568     * @return A handle to the item added or @c NULL, on errors.
8569     *
8570     * This inserts an item before another in the gengrid.
8571     *
8572     * @see elm_gengrid_item_append()
8573     * @see elm_gengrid_item_prepend()
8574     * @see elm_gengrid_item_insert_after()
8575     * @see elm_gengrid_item_del()
8576     *
8577     * @ingroup Gengrid
8578     */
8579    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);
8580
8581    /**
8582     * Insert an item after another in a gengrid widget
8583     *
8584     * @param obj The gengrid object.
8585     * @param gic The item class for the item.
8586     * @param data The item data.
8587     * @param relative The item to place this new one after.
8588     * @param func Convenience function called when the item is
8589     * selected.
8590     * @param func_data Data to be passed to @p func.
8591     * @return A handle to the item added or @c NULL, on errors.
8592     *
8593     * This inserts an item after another in the gengrid.
8594     *
8595     * @see elm_gengrid_item_append()
8596     * @see elm_gengrid_item_prepend()
8597     * @see elm_gengrid_item_insert_after()
8598     * @see elm_gengrid_item_del()
8599     *
8600     * @ingroup Gengrid
8601     */
8602    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);
8603
8604    /**
8605     * Insert an item in a gengrid widget using a user-defined sort function.
8606     *
8607     * @param obj The gengrid object.
8608     * @param gic The item class for the item.
8609     * @param data The item data.
8610     * @param comp User defined comparison function that defines the sort order based on
8611     * Elm_Gen_Item and its data param.
8612     * @param func Convenience function called when the item is selected.
8613     * @param func_data Data to be passed to @p func.
8614     * @return A handle to the item added or @c NULL, on errors.
8615     *
8616     * This inserts an item in the gengrid based on user defined comparison function.
8617     *
8618     * @see elm_gengrid_item_append()
8619     * @see elm_gengrid_item_prepend()
8620     * @see elm_gengrid_item_insert_after()
8621     * @see elm_gengrid_item_del()
8622     * @see elm_gengrid_item_direct_sorted_insert()
8623     *
8624     * @ingroup Gengrid
8625     */
8626    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);
8627
8628    /**
8629     * Insert an item in a gengrid widget using a user-defined sort function.
8630     *
8631     * @param obj The gengrid object.
8632     * @param gic The item class for the item.
8633     * @param data The item data.
8634     * @param comp User defined comparison function that defines the sort order based on
8635     * Elm_Gen_Item.
8636     * @param func Convenience function called when the item is selected.
8637     * @param func_data Data to be passed to @p func.
8638     * @return A handle to the item added or @c NULL, on errors.
8639     *
8640     * This inserts an item in the gengrid based on user defined comparison function.
8641     *
8642     * @see elm_gengrid_item_append()
8643     * @see elm_gengrid_item_prepend()
8644     * @see elm_gengrid_item_insert_after()
8645     * @see elm_gengrid_item_del()
8646     * @see elm_gengrid_item_sorted_insert()
8647     *
8648     * @ingroup Gengrid
8649     */
8650    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);
8651
8652    /**
8653     * Set whether items on a given gengrid widget are to get their
8654     * selection callbacks issued for @b every subsequent selection
8655     * click on them or just for the first click.
8656     *
8657     * @param obj The gengrid object
8658     * @param always_select @c EINA_TRUE to make items "always
8659     * selected", @c EINA_FALSE, otherwise
8660     *
8661     * By default, grid items will only call their selection callback
8662     * function when firstly getting selected, any subsequent further
8663     * clicks will do nothing. With this call, you make those
8664     * subsequent clicks also to issue the selection callbacks.
8665     *
8666     * @note <b>Double clicks</b> will @b always be reported on items.
8667     *
8668     * @see elm_gengrid_always_select_mode_get()
8669     *
8670     * @ingroup Gengrid
8671     */
8672    WILL_DEPRECATE  EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8673
8674    /**
8675     * Get whether items on a given gengrid widget have their selection
8676     * callbacks issued for @b every subsequent selection click on them
8677     * or just for the first click.
8678     *
8679     * @param obj The gengrid object.
8680     * @return @c EINA_TRUE if the gengrid items are "always selected",
8681     * @c EINA_FALSE, otherwise
8682     *
8683     * @see elm_gengrid_always_select_mode_set() for more details
8684     *
8685     * @ingroup Gengrid
8686     */
8687    WILL_DEPRECATE  EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8688
8689    /**
8690     * Set whether items on a given gengrid widget can be selected or not.
8691     *
8692     * @param obj The gengrid object
8693     * @param no_select @c EINA_TRUE to make items selectable,
8694     * @c EINA_FALSE otherwise
8695     *
8696     * This will make items in @p obj selectable or not. In the latter
8697     * case, any user interaction on the gengrid items will neither make
8698     * them appear selected nor them call their selection callback
8699     * functions.
8700     *
8701     * @see elm_gengrid_no_select_mode_get()
8702     *
8703     * @ingroup Gengrid
8704     */
8705    WILL_DEPRECATE  EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8706
8707    /**
8708     * Get whether items on a given gengrid widget can be selected or
8709     * not.
8710     *
8711     * @param obj The gengrid object
8712     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8713     * otherwise
8714     *
8715     * @see elm_gengrid_no_select_mode_set() for more details
8716     *
8717     * @ingroup Gengrid
8718     */
8719    WILL_DEPRECATE  EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8720
8721    /**
8722     * Enable or disable multi-selection in a given gengrid widget
8723     *
8724     * @param obj The gengrid object.
8725     * @param multi @c EINA_TRUE, to enable multi-selection,
8726     * @c EINA_FALSE to disable it.
8727     *
8728     * Multi-selection is the ability to have @b more than one
8729     * item selected, on a given gengrid, simultaneously. When it is
8730     * enabled, a sequence of clicks on different items will make them
8731     * all selected, progressively. A click on an already selected item
8732     * will unselect it. If interacting via the keyboard,
8733     * multi-selection is enabled while holding the "Shift" key.
8734     *
8735     * @note By default, multi-selection is @b disabled on gengrids
8736     *
8737     * @see elm_gengrid_multi_select_get()
8738     *
8739     * @ingroup Gengrid
8740     */
8741    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8742
8743    /**
8744     * Get whether multi-selection is enabled or disabled for a given
8745     * gengrid widget
8746     *
8747     * @param obj The gengrid object.
8748     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8749     * EINA_FALSE otherwise
8750     *
8751     * @see elm_gengrid_multi_select_set() for more details
8752     *
8753     * @ingroup Gengrid
8754     */
8755    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8756
8757    /**
8758     * Enable or disable bouncing effect for a given gengrid widget
8759     *
8760     * @param obj The gengrid object
8761     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8762     * @c EINA_FALSE to disable it
8763     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8764     * @c EINA_FALSE to disable it
8765     *
8766     * The bouncing effect occurs whenever one reaches the gengrid's
8767     * edge's while panning it -- it will scroll past its limits a
8768     * little bit and return to the edge again, in a animated for,
8769     * automatically.
8770     *
8771     * @note By default, gengrids have bouncing enabled on both axis
8772     *
8773     * @see elm_gengrid_bounce_get()
8774     *
8775     * @ingroup Gengrid
8776     */
8777    WILL_DEPRECATE  EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8778
8779    /**
8780     * Get whether bouncing effects are enabled or disabled, for a
8781     * given gengrid widget, on each axis
8782     *
8783     * @param obj The gengrid object
8784     * @param h_bounce Pointer to a variable where to store the
8785     * horizontal bouncing flag.
8786     * @param v_bounce Pointer to a variable where to store the
8787     * vertical bouncing flag.
8788     *
8789     * @see elm_gengrid_bounce_set() for more details
8790     *
8791     * @ingroup Gengrid
8792     */
8793    WILL_DEPRECATE  EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8794
8795    /**
8796     * Set a given gengrid widget's scrolling page size, relative to
8797     * its viewport size.
8798     *
8799     * @param obj The gengrid object
8800     * @param h_pagerel The horizontal page (relative) size
8801     * @param v_pagerel The vertical page (relative) size
8802     *
8803     * The gengrid's scroller is capable of binding scrolling by the
8804     * user to "pages". It means that, while scrolling and, specially
8805     * after releasing the mouse button, the grid will @b snap to the
8806     * nearest displaying page's area. When page sizes are set, the
8807     * grid's continuous content area is split into (equal) page sized
8808     * pieces.
8809     *
8810     * This function sets the size of a page <b>relatively to the
8811     * viewport dimensions</b> of the gengrid, for each axis. A value
8812     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8813     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8814     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8815     * 1.0. Values beyond those will make it behave behave
8816     * inconsistently. If you only want one axis to snap to pages, use
8817     * the value @c 0.0 for the other one.
8818     *
8819     * There is a function setting page size values in @b absolute
8820     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8821     * is mutually exclusive to this one.
8822     *
8823     * @see elm_gengrid_page_relative_get()
8824     *
8825     * @ingroup Gengrid
8826     */
8827    WILL_DEPRECATE  EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8828
8829    /**
8830     * Get a given gengrid widget's scrolling page size, relative to
8831     * its viewport size.
8832     *
8833     * @param obj The gengrid object
8834     * @param h_pagerel Pointer to a variable where to store the
8835     * horizontal page (relative) size
8836     * @param v_pagerel Pointer to a variable where to store the
8837     * vertical page (relative) size
8838     *
8839     * @see elm_gengrid_page_relative_set() for more details
8840     *
8841     * @ingroup Gengrid
8842     */
8843    WILL_DEPRECATE  EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8844
8845    /**
8846     * Set a given gengrid widget's scrolling page size
8847     *
8848     * @param obj The gengrid object
8849     * @param h_pagerel The horizontal page size, in pixels
8850     * @param v_pagerel The vertical page size, in pixels
8851     *
8852     * The gengrid's scroller is capable of binding scrolling by the
8853     * user to "pages". It means that, while scrolling and, specially
8854     * after releasing the mouse button, the grid will @b snap to the
8855     * nearest displaying page's area. When page sizes are set, the
8856     * grid's continuous content area is split into (equal) page sized
8857     * pieces.
8858     *
8859     * This function sets the size of a page of the gengrid, in pixels,
8860     * for each axis. Sane usable values are, between @c 0 and the
8861     * dimensions of @p obj, for each axis. Values beyond those will
8862     * make it behave behave inconsistently. If you only want one axis
8863     * to snap to pages, use the value @c 0 for the other one.
8864     *
8865     * There is a function setting page size values in @b relative
8866     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8867     * use is mutually exclusive to this one.
8868     *
8869     * @ingroup Gengrid
8870     */
8871    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8872
8873    /**
8874     * Set the direction in which a given gengrid widget will expand while
8875     * placing its items.
8876     *
8877     * @param obj The gengrid object.
8878     * @param setting @c EINA_TRUE to make the gengrid expand
8879     * horizontally, @c EINA_FALSE to expand vertically.
8880     *
8881     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8882     * in @b columns, from top to bottom and, when the space for a
8883     * column is filled, another one is started on the right, thus
8884     * expanding the grid horizontally. When in "vertical mode"
8885     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8886     * to right and, when the space for a row is filled, another one is
8887     * started below, thus expanding the grid vertically.
8888     *
8889     * @see elm_gengrid_horizontal_get()
8890     *
8891     * @ingroup Gengrid
8892     */
8893    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8894
8895    /**
8896     * Get for what direction a given gengrid widget will expand while
8897     * placing its items.
8898     *
8899     * @param obj The gengrid object.
8900     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8901     * @c EINA_FALSE if it's set to expand vertically.
8902     *
8903     * @see elm_gengrid_horizontal_set() for more detais
8904     *
8905     * @ingroup Gengrid
8906     */
8907    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8908
8909    /**
8910     * Get the first item in a given gengrid widget
8911     *
8912     * @param obj The gengrid object
8913     * @return The first item's handle or @c NULL, if there are no
8914     * items in @p obj (and on errors)
8915     *
8916     * This returns the first item in the @p obj's internal list of
8917     * items.
8918     *
8919     * @see elm_gengrid_last_item_get()
8920     *
8921     * @ingroup Gengrid
8922     */
8923    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8924
8925    /**
8926     * Get the last item in a given gengrid widget
8927     *
8928     * @param obj The gengrid object
8929     * @return The last item's handle or @c NULL, if there are no
8930     * items in @p obj (and on errors)
8931     *
8932     * This returns the last item in the @p obj's internal list of
8933     * items.
8934     *
8935     * @see elm_gengrid_first_item_get()
8936     *
8937     * @ingroup Gengrid
8938     */
8939    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8940
8941    /**
8942     * Get the @b next item in a gengrid widget's internal list of items,
8943     * given a handle to one of those items.
8944     *
8945     * @param item The gengrid item to fetch next from
8946     * @return The item after @p item, or @c NULL if there's none (and
8947     * on errors)
8948     *
8949     * This returns the item placed after the @p item, on the container
8950     * gengrid.
8951     *
8952     * @see elm_gengrid_item_prev_get()
8953     *
8954     * @ingroup Gengrid
8955     */
8956    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8957
8958    /**
8959     * Get the @b previous item in a gengrid widget's internal list of items,
8960     * given a handle to one of those items.
8961     *
8962     * @param item The gengrid item to fetch previous from
8963     * @return The item before @p item, or @c NULL if there's none (and
8964     * on errors)
8965     *
8966     * This returns the item placed before the @p item, on the container
8967     * gengrid.
8968     *
8969     * @see elm_gengrid_item_next_get()
8970     *
8971     * @ingroup Gengrid
8972     */
8973    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8974
8975    /**
8976     * Get the gengrid object's handle which contains a given gengrid
8977     * item
8978     *
8979     * @param item The item to fetch the container from
8980     * @return The gengrid (parent) object
8981     *
8982     * This returns the gengrid object itself that an item belongs to.
8983     *
8984     * @ingroup Gengrid
8985     */
8986    WILL_DEPRECATE EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8987
8988    /**
8989     * Remove a gengrid item from its parent, deleting it.
8990     *
8991     * @param item The item to be removed.
8992     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8993     *
8994     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8995     * once.
8996     *
8997     * @ingroup Gengrid
8998     */
8999    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9000
9001    /**
9002     * Update the contents of a given gengrid item
9003     *
9004     * @param item The gengrid item
9005     *
9006     * This updates an item by calling all the item class functions
9007     * again to get the contents, labels and states. Use this when the
9008     * original item data has changed and you want the changes to be
9009     * reflected.
9010     *
9011     * @ingroup Gengrid
9012     */
9013    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9014
9015    /**
9016     * Get the Gengrid Item class for the given Gengrid Item.
9017     *
9018     * @param item The gengrid item
9019     *
9020     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9021     * the function pointers and item_style.
9022     *
9023     * @ingroup Gengrid
9024     */
9025    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9026
9027    /**
9028     * Get the Gengrid Item class for the given Gengrid Item.
9029     *
9030     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9031     * the function pointers and item_style.
9032     *
9033     * @param item The gengrid item
9034     * @param gic The gengrid item class describing the function pointers and the item style.
9035     *
9036     * @ingroup Gengrid
9037     */
9038    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9039
9040    /**
9041     * Return the data associated to a given gengrid item
9042     *
9043     * @param item The gengrid item.
9044     * @return the data associated with this item.
9045     *
9046     * This returns the @c data value passed on the
9047     * elm_gengrid_item_append() and related item addition calls.
9048     *
9049     * @see elm_gengrid_item_append()
9050     * @see elm_gengrid_item_data_set()
9051     *
9052     * @ingroup Gengrid
9053     */
9054    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9055
9056    /**
9057     * Set the data associated with a given gengrid item
9058     *
9059     * @param item The gengrid item
9060     * @param data The data pointer to set on it
9061     *
9062     * This @b overrides the @c data value passed on the
9063     * elm_gengrid_item_append() and related item addition calls. This
9064     * function @b won't call elm_gengrid_item_update() automatically,
9065     * so you'd issue it afterwards if you want to have the item
9066     * updated to reflect the new data.
9067     *
9068     * @see elm_gengrid_item_data_get()
9069     * @see elm_gengrid_item_update()
9070     *
9071     * @ingroup Gengrid
9072     */
9073    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9074
9075    /**
9076     * Get a given gengrid item's position, relative to the whole
9077     * gengrid's grid area.
9078     *
9079     * @param item The Gengrid item.
9080     * @param x Pointer to variable to store the item's <b>row number</b>.
9081     * @param y Pointer to variable to store the item's <b>column number</b>.
9082     *
9083     * This returns the "logical" position of the item within the
9084     * gengrid. For example, @c (0, 1) would stand for first row,
9085     * second column.
9086     *
9087     * @ingroup Gengrid
9088     */
9089    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9090
9091    /**
9092     * Set whether a given gengrid item is selected or not
9093     *
9094     * @param item The gengrid item
9095     * @param selected Use @c EINA_TRUE, to make it selected, @c
9096     * EINA_FALSE to make it unselected
9097     *
9098     * This sets the selected state of an item. If multi-selection is
9099     * not enabled on the containing gengrid and @p selected is @c
9100     * EINA_TRUE, any other previously selected items will get
9101     * unselected in favor of this new one.
9102     *
9103     * @see elm_gengrid_item_selected_get()
9104     *
9105     * @ingroup Gengrid
9106     */
9107    WILL_DEPRECATE EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9108
9109    /**
9110     * Get whether a given gengrid item is selected or not
9111     *
9112     * @param item The gengrid item
9113     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9114     *
9115     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9116     *
9117     * @see elm_gengrid_item_selected_set() for more details
9118     *
9119     * @ingroup Gengrid
9120     */
9121    WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9122
9123    /**
9124     * Get the real Evas object created to implement the view of a
9125     * given gengrid item
9126     *
9127     * @param item The gengrid item.
9128     * @return the Evas object implementing this item's view.
9129     *
9130     * This returns the actual Evas object used to implement the
9131     * specified gengrid item's view. This may be @c NULL, as it may
9132     * not have been created or may have been deleted, at any time, by
9133     * the gengrid. <b>Do not modify this object</b> (move, resize,
9134     * show, hide, etc.), as the gengrid is controlling it. This
9135     * function is for querying, emitting custom signals or hooking
9136     * lower level callbacks for events on that object. Do not delete
9137     * this object under any circumstances.
9138     *
9139     * @see elm_gengrid_item_data_get()
9140     *
9141     * @ingroup Gengrid
9142     */
9143    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9144
9145    /**
9146     * Show the portion of a gengrid's internal grid containing a given
9147     * item, @b immediately.
9148     *
9149     * @param item The item to display
9150     *
9151     * This causes gengrid to @b redraw its viewport's contents to the
9152     * region contining the given @p item item, if it is not fully
9153     * visible.
9154     *
9155     * @see elm_gengrid_item_bring_in()
9156     *
9157     * @ingroup Gengrid
9158     */
9159    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9160
9161    /**
9162     * Animatedly bring in, to the visible area of a gengrid, a given
9163     * item on it.
9164     *
9165     * @param item The gengrid item to display
9166     *
9167     * This causes gengrid to jump to the given @p item and show
9168     * it (by scrolling), if it is not fully visible. This will use
9169     * animation to do so and take a period of time to complete.
9170     *
9171     * @see elm_gengrid_item_show()
9172     *
9173     * @ingroup Gengrid
9174     */
9175    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9176
9177    /**
9178     * Set whether a given gengrid item is disabled or not.
9179     *
9180     * @param item The gengrid item
9181     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9182     * to enable it back.
9183     *
9184     * A disabled item cannot be selected or unselected. It will also
9185     * change its appearance, to signal the user it's disabled.
9186     *
9187     * @see elm_gengrid_item_disabled_get()
9188     *
9189     * @ingroup Gengrid
9190     */
9191    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9192
9193    /**
9194     * Get whether a given gengrid item is disabled or not.
9195     *
9196     * @param item The gengrid item
9197     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9198     * (and on errors).
9199     *
9200     * @see elm_gengrid_item_disabled_set() for more details
9201     *
9202     * @ingroup Gengrid
9203     */
9204    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9205
9206    /**
9207     * Set the text to be shown in a given gengrid item's tooltips.
9208     *
9209     * @param item The gengrid item
9210     * @param text The text to set in the content
9211     *
9212     * This call will setup the text to be used as tooltip to that item
9213     * (analogous to elm_object_tooltip_text_set(), but being item
9214     * tooltips with higher precedence than object tooltips). It can
9215     * have only one tooltip at a time, so any previous tooltip data
9216     * will get removed.
9217     *
9218     * @ingroup Gengrid
9219     */
9220    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9221
9222    /**
9223     * Set the content to be shown in a given gengrid item's tooltip
9224     *
9225     * @param item The gengrid item.
9226     * @param func The function returning the tooltip contents.
9227     * @param data What to provide to @a func as callback data/context.
9228     * @param del_cb Called when data is not needed anymore, either when
9229     *        another callback replaces @p func, the tooltip is unset with
9230     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9231     *        dies. This callback receives as its first parameter the
9232     *        given @p data, being @c event_info the item handle.
9233     *
9234     * This call will setup the tooltip's contents to @p item
9235     * (analogous to elm_object_tooltip_content_cb_set(), but being
9236     * item tooltips with higher precedence than object tooltips). It
9237     * can have only one tooltip at a time, so any previous tooltip
9238     * content will get removed. @p func (with @p data) will be called
9239     * every time Elementary needs to show the tooltip and it should
9240     * return a valid Evas object, which will be fully managed by the
9241     * tooltip system, getting deleted when the tooltip is gone.
9242     *
9243     * @ingroup Gengrid
9244     */
9245    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);
9246
9247    /**
9248     * Unset a tooltip from a given gengrid item
9249     *
9250     * @param item gengrid item to remove a previously set tooltip from.
9251     *
9252     * This call removes any tooltip set on @p item. The callback
9253     * provided as @c del_cb to
9254     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9255     * notify it is not used anymore (and have resources cleaned, if
9256     * need be).
9257     *
9258     * @see elm_gengrid_item_tooltip_content_cb_set()
9259     *
9260     * @ingroup Gengrid
9261     */
9262    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9263
9264    /**
9265     * Set a different @b style for a given gengrid item's tooltip.
9266     *
9267     * @param item gengrid item with tooltip set
9268     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9269     * "default", @c "transparent", etc)
9270     *
9271     * Tooltips can have <b>alternate styles</b> to be displayed on,
9272     * which are defined by the theme set on Elementary. This function
9273     * works analogously as elm_object_tooltip_style_set(), but here
9274     * applied only to gengrid item objects. The default style for
9275     * tooltips is @c "default".
9276     *
9277     * @note before you set a style you should define a tooltip with
9278     *       elm_gengrid_item_tooltip_content_cb_set() or
9279     *       elm_gengrid_item_tooltip_text_set()
9280     *
9281     * @see elm_gengrid_item_tooltip_style_get()
9282     *
9283     * @ingroup Gengrid
9284     */
9285    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9286
9287    /**
9288     * Get the style set a given gengrid item's tooltip.
9289     *
9290     * @param item gengrid item with tooltip already set on.
9291     * @return style the theme style in use, which defaults to
9292     *         "default". If the object does not have a tooltip set,
9293     *         then @c NULL is returned.
9294     *
9295     * @see elm_gengrid_item_tooltip_style_set() for more details
9296     *
9297     * @ingroup Gengrid
9298     */
9299    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9300    /**
9301     * @brief Disable size restrictions on an object's tooltip
9302     * @param item The tooltip's anchor object
9303     * @param disable If EINA_TRUE, size restrictions are disabled
9304     * @return EINA_FALSE on failure, EINA_TRUE on success
9305     *
9306     * This function allows a tooltip to expand beyond its parant window's canvas.
9307     * It will instead be limited only by the size of the display.
9308     */
9309    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9310    /**
9311     * @brief Retrieve size restriction state of an object's tooltip
9312     * @param item The tooltip's anchor object
9313     * @return If EINA_TRUE, size restrictions are disabled
9314     *
9315     * This function returns whether a tooltip is allowed to expand beyond
9316     * its parant window's canvas.
9317     * It will instead be limited only by the size of the display.
9318     */
9319    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9320    /**
9321     * Set the type of mouse pointer/cursor decoration to be shown,
9322     * when the mouse pointer is over the given gengrid widget item
9323     *
9324     * @param item gengrid item to customize cursor on
9325     * @param cursor the cursor type's name
9326     *
9327     * This function works analogously as elm_object_cursor_set(), but
9328     * here the cursor's changing area is restricted to the item's
9329     * area, and not the whole widget's. Note that that item cursors
9330     * have precedence over widget cursors, so that a mouse over @p
9331     * item will always show cursor @p type.
9332     *
9333     * If this function is called twice for an object, a previously set
9334     * cursor will be unset on the second call.
9335     *
9336     * @see elm_object_cursor_set()
9337     * @see elm_gengrid_item_cursor_get()
9338     * @see elm_gengrid_item_cursor_unset()
9339     *
9340     * @ingroup Gengrid
9341     */
9342    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9343
9344    /**
9345     * Get the type of mouse pointer/cursor decoration set to be shown,
9346     * when the mouse pointer is over the given gengrid widget item
9347     *
9348     * @param item gengrid item with custom cursor set
9349     * @return the cursor type's name or @c NULL, if no custom cursors
9350     * were set to @p item (and on errors)
9351     *
9352     * @see elm_object_cursor_get()
9353     * @see elm_gengrid_item_cursor_set() for more details
9354     * @see elm_gengrid_item_cursor_unset()
9355     *
9356     * @ingroup Gengrid
9357     */
9358    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9359
9360    /**
9361     * Unset any custom mouse pointer/cursor decoration set to be
9362     * shown, when the mouse pointer is over the given gengrid widget
9363     * item, thus making it show the @b default cursor again.
9364     *
9365     * @param item a gengrid item
9366     *
9367     * Use this call to undo any custom settings on this item's cursor
9368     * decoration, bringing it back to defaults (no custom style set).
9369     *
9370     * @see elm_object_cursor_unset()
9371     * @see elm_gengrid_item_cursor_set() for more details
9372     *
9373     * @ingroup Gengrid
9374     */
9375    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9376
9377    /**
9378     * Set a different @b style for a given custom cursor set for a
9379     * gengrid item.
9380     *
9381     * @param item gengrid item with custom cursor set
9382     * @param style the <b>theme style</b> to use (e.g. @c "default",
9383     * @c "transparent", etc)
9384     *
9385     * This function only makes sense when one is using custom mouse
9386     * cursor decorations <b>defined in a theme file</b> , which can
9387     * have, given a cursor name/type, <b>alternate styles</b> on
9388     * it. It works analogously as elm_object_cursor_style_set(), but
9389     * here applied only to gengrid item objects.
9390     *
9391     * @warning Before you set a cursor style you should have defined a
9392     *       custom cursor previously on the item, with
9393     *       elm_gengrid_item_cursor_set()
9394     *
9395     * @see elm_gengrid_item_cursor_engine_only_set()
9396     * @see elm_gengrid_item_cursor_style_get()
9397     *
9398     * @ingroup Gengrid
9399     */
9400    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9401
9402    /**
9403     * Get the current @b style set for a given gengrid item's custom
9404     * cursor
9405     *
9406     * @param item gengrid item with custom cursor set.
9407     * @return style the cursor style in use. If the object does not
9408     *         have a cursor set, then @c NULL is returned.
9409     *
9410     * @see elm_gengrid_item_cursor_style_set() for more details
9411     *
9412     * @ingroup Gengrid
9413     */
9414    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9415
9416    /**
9417     * Set if the (custom) cursor for a given gengrid item should be
9418     * searched in its theme, also, or should only rely on the
9419     * rendering engine.
9420     *
9421     * @param item item with custom (custom) cursor already set on
9422     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9423     * only on those provided by the rendering engine, @c EINA_FALSE to
9424     * have them searched on the widget's theme, as well.
9425     *
9426     * @note This call is of use only if you've set a custom cursor
9427     * for gengrid items, with elm_gengrid_item_cursor_set().
9428     *
9429     * @note By default, cursors will only be looked for between those
9430     * provided by the rendering engine.
9431     *
9432     * @ingroup Gengrid
9433     */
9434    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9435
9436    /**
9437     * Get if the (custom) cursor for a given gengrid item is being
9438     * searched in its theme, also, or is only relying on the rendering
9439     * engine.
9440     *
9441     * @param item a gengrid item
9442     * @return @c EINA_TRUE, if cursors are being looked for only on
9443     * those provided by the rendering engine, @c EINA_FALSE if they
9444     * are being searched on the widget's theme, as well.
9445     *
9446     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9447     *
9448     * @ingroup Gengrid
9449     */
9450    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9451
9452    /**
9453     * Remove all items from a given gengrid widget
9454     *
9455     * @param obj The gengrid object.
9456     *
9457     * This removes (and deletes) all items in @p obj, leaving it
9458     * empty.
9459     *
9460     * @see elm_gengrid_item_del(), to remove just one item.
9461     *
9462     * @ingroup Gengrid
9463     */
9464    WILL_DEPRECATE EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9465
9466    /**
9467     * Get the selected item in a given gengrid widget
9468     *
9469     * @param obj The gengrid object.
9470     * @return The selected item's handleor @c NULL, if none is
9471     * selected at the moment (and on errors)
9472     *
9473     * This returns the selected item in @p obj. If multi selection is
9474     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9475     * the first item in the list is selected, which might not be very
9476     * useful. For that case, see elm_gengrid_selected_items_get().
9477     *
9478     * @ingroup Gengrid
9479     */
9480    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9481
9482    /**
9483     * Get <b>a list</b> of selected items in a given gengrid
9484     *
9485     * @param obj The gengrid object.
9486     * @return The list of selected items or @c NULL, if none is
9487     * selected at the moment (and on errors)
9488     *
9489     * This returns a list of the selected items, in the order that
9490     * they appear in the grid. This list is only valid as long as no
9491     * more items are selected or unselected (or unselected implictly
9492     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9493     * data, naturally.
9494     *
9495     * @see elm_gengrid_selected_item_get()
9496     *
9497     * @ingroup Gengrid
9498     */
9499    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9500
9501    /**
9502     * @}
9503     */
9504
9505    /**
9506     * @defgroup Clock Clock
9507     *
9508     * @image html img/widget/clock/preview-00.png
9509     * @image latex img/widget/clock/preview-00.eps
9510     *
9511     * This is a @b digital clock widget. In its default theme, it has a
9512     * vintage "flipping numbers clock" appearance, which will animate
9513     * sheets of individual algarisms individually as time goes by.
9514     *
9515     * A newly created clock will fetch system's time (already
9516     * considering local time adjustments) to start with, and will tick
9517     * accondingly. It may or may not show seconds.
9518     *
9519     * Clocks have an @b edition mode. When in it, the sheets will
9520     * display extra arrow indications on the top and bottom and the
9521     * user may click on them to raise or lower the time values. After
9522     * it's told to exit edition mode, it will keep ticking with that
9523     * new time set (it keeps the difference from local time).
9524     *
9525     * Also, when under edition mode, user clicks on the cited arrows
9526     * which are @b held for some time will make the clock to flip the
9527     * sheet, thus editing the time, continuosly and automatically for
9528     * the user. The interval between sheet flips will keep growing in
9529     * time, so that it helps the user to reach a time which is distant
9530     * from the one set.
9531     *
9532     * The time display is, by default, in military mode (24h), but an
9533     * am/pm indicator may be optionally shown, too, when it will
9534     * switch to 12h.
9535     *
9536     * Smart callbacks one can register to:
9537     * - "changed" - the clock's user changed the time
9538     *
9539     * Here is an example on its usage:
9540     * @li @ref clock_example
9541     */
9542
9543    /**
9544     * @addtogroup Clock
9545     * @{
9546     */
9547
9548    /**
9549     * Identifiers for which clock digits should be editable, when a
9550     * clock widget is in edition mode. Values may be ORed together to
9551     * make a mask, naturally.
9552     *
9553     * @see elm_clock_edit_set()
9554     * @see elm_clock_digit_edit_set()
9555     */
9556    typedef enum _Elm_Clock_Digedit
9557      {
9558         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9559         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9560         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9561         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9562         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9563         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9564         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9565         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9566      } Elm_Clock_Digedit;
9567
9568    /**
9569     * Add a new clock widget to the given parent Elementary
9570     * (container) object
9571     *
9572     * @param parent The parent object
9573     * @return a new clock widget handle or @c NULL, on errors
9574     *
9575     * This function inserts a new clock widget on the canvas.
9576     *
9577     * @ingroup Clock
9578     */
9579    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9580
9581    /**
9582     * Set a clock widget's time, programmatically
9583     *
9584     * @param obj The clock widget object
9585     * @param hrs The hours to set
9586     * @param min The minutes to set
9587     * @param sec The secondes to set
9588     *
9589     * This function updates the time that is showed by the clock
9590     * widget.
9591     *
9592     *  Values @b must be set within the following ranges:
9593     * - 0 - 23, for hours
9594     * - 0 - 59, for minutes
9595     * - 0 - 59, for seconds,
9596     *
9597     * even if the clock is not in "military" mode.
9598     *
9599     * @warning The behavior for values set out of those ranges is @b
9600     * undefined.
9601     *
9602     * @ingroup Clock
9603     */
9604    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9605
9606    /**
9607     * Get a clock widget's time values
9608     *
9609     * @param obj The clock object
9610     * @param[out] hrs Pointer to the variable to get the hours value
9611     * @param[out] min Pointer to the variable to get the minutes value
9612     * @param[out] sec Pointer to the variable to get the seconds value
9613     *
9614     * This function gets the time set for @p obj, returning
9615     * it on the variables passed as the arguments to function
9616     *
9617     * @note Use @c NULL pointers on the time values you're not
9618     * interested in: they'll be ignored by the function.
9619     *
9620     * @ingroup Clock
9621     */
9622    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9623
9624    /**
9625     * Set whether a given clock widget is under <b>edition mode</b> or
9626     * under (default) displaying-only mode.
9627     *
9628     * @param obj The clock object
9629     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9630     * put it back to "displaying only" mode
9631     *
9632     * This function makes a clock's time to be editable or not <b>by
9633     * user interaction</b>. When in edition mode, clocks @b stop
9634     * ticking, until one brings them back to canonical mode. The
9635     * elm_clock_digit_edit_set() function will influence which digits
9636     * of the clock will be editable. By default, all of them will be
9637     * (#ELM_CLOCK_NONE).
9638     *
9639     * @note am/pm sheets, if being shown, will @b always be editable
9640     * under edition mode.
9641     *
9642     * @see elm_clock_edit_get()
9643     *
9644     * @ingroup Clock
9645     */
9646    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9647
9648    /**
9649     * Retrieve whether a given clock widget is under <b>edition
9650     * mode</b> or under (default) displaying-only mode.
9651     *
9652     * @param obj The clock object
9653     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9654     * otherwise
9655     *
9656     * This function retrieves whether the clock's time can be edited
9657     * or not by user interaction.
9658     *
9659     * @see elm_clock_edit_set() for more details
9660     *
9661     * @ingroup Clock
9662     */
9663    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9664
9665    /**
9666     * Set what digits of the given clock widget should be editable
9667     * when in edition mode.
9668     *
9669     * @param obj The clock object
9670     * @param digedit Bit mask indicating the digits to be editable
9671     * (values in #Elm_Clock_Digedit).
9672     *
9673     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9674     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9675     * EINA_FALSE).
9676     *
9677     * @see elm_clock_digit_edit_get()
9678     *
9679     * @ingroup Clock
9680     */
9681    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9682
9683    /**
9684     * Retrieve what digits of the given clock widget should be
9685     * editable when in edition mode.
9686     *
9687     * @param obj The clock object
9688     * @return Bit mask indicating the digits to be editable
9689     * (values in #Elm_Clock_Digedit).
9690     *
9691     * @see elm_clock_digit_edit_set() for more details
9692     *
9693     * @ingroup Clock
9694     */
9695    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9696
9697    /**
9698     * Set if the given clock widget must show hours in military or
9699     * am/pm mode
9700     *
9701     * @param obj The clock object
9702     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9703     * to military mode
9704     *
9705     * This function sets if the clock must show hours in military or
9706     * am/pm mode. In some countries like Brazil the military mode
9707     * (00-24h-format) is used, in opposition to the USA, where the
9708     * am/pm mode is more commonly used.
9709     *
9710     * @see elm_clock_show_am_pm_get()
9711     *
9712     * @ingroup Clock
9713     */
9714    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9715
9716    /**
9717     * Get if the given clock widget shows hours in military or am/pm
9718     * mode
9719     *
9720     * @param obj The clock object
9721     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9722     * military
9723     *
9724     * This function gets if the clock shows hours in military or am/pm
9725     * mode.
9726     *
9727     * @see elm_clock_show_am_pm_set() for more details
9728     *
9729     * @ingroup Clock
9730     */
9731    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9732
9733    /**
9734     * Set if the given clock widget must show time with seconds or not
9735     *
9736     * @param obj The clock object
9737     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9738     *
9739     * This function sets if the given clock must show or not elapsed
9740     * seconds. By default, they are @b not shown.
9741     *
9742     * @see elm_clock_show_seconds_get()
9743     *
9744     * @ingroup Clock
9745     */
9746    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9747
9748    /**
9749     * Get whether the given clock widget is showing time with seconds
9750     * or not
9751     *
9752     * @param obj The clock object
9753     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9754     *
9755     * This function gets whether @p obj is showing or not the elapsed
9756     * seconds.
9757     *
9758     * @see elm_clock_show_seconds_set()
9759     *
9760     * @ingroup Clock
9761     */
9762    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9763
9764    /**
9765     * Set the interval on time updates for an user mouse button hold
9766     * on clock widgets' time edition.
9767     *
9768     * @param obj The clock object
9769     * @param interval The (first) interval value in seconds
9770     *
9771     * This interval value is @b decreased while the user holds the
9772     * mouse pointer either incrementing or decrementing a given the
9773     * clock digit's value.
9774     *
9775     * This helps the user to get to a given time distant from the
9776     * current one easier/faster, as it will start to flip quicker and
9777     * quicker on mouse button holds.
9778     *
9779     * The calculation for the next flip interval value, starting from
9780     * the one set with this call, is the previous interval divided by
9781     * 1.05, so it decreases a little bit.
9782     *
9783     * The default starting interval value for automatic flips is
9784     * @b 0.85 seconds.
9785     *
9786     * @see elm_clock_interval_get()
9787     *
9788     * @ingroup Clock
9789     */
9790    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9791
9792    /**
9793     * Get the interval on time updates for an user mouse button hold
9794     * on clock widgets' time edition.
9795     *
9796     * @param obj The clock object
9797     * @return The (first) interval value, in seconds, set on it
9798     *
9799     * @see elm_clock_interval_set() for more details
9800     *
9801     * @ingroup Clock
9802     */
9803    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9804
9805    /**
9806     * @}
9807     */
9808
9809    /**
9810     * @defgroup Layout Layout
9811     *
9812     * @image html img/widget/layout/preview-00.png
9813     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9814     *
9815     * @image html img/layout-predefined.png
9816     * @image latex img/layout-predefined.eps width=\textwidth
9817     *
9818     * This is a container widget that takes a standard Edje design file and
9819     * wraps it very thinly in a widget.
9820     *
9821     * An Edje design (theme) file has a very wide range of possibilities to
9822     * describe the behavior of elements added to the Layout. Check out the Edje
9823     * documentation and the EDC reference to get more information about what can
9824     * be done with Edje.
9825     *
9826     * Just like @ref List, @ref Box, and other container widgets, any
9827     * object added to the Layout will become its child, meaning that it will be
9828     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9829     *
9830     * The Layout widget can contain as many Contents, Boxes or Tables as
9831     * described in its theme file. For instance, objects can be added to
9832     * different Tables by specifying the respective Table part names. The same
9833     * is valid for Content and Box.
9834     *
9835     * The objects added as child of the Layout will behave as described in the
9836     * part description where they were added. There are 3 possible types of
9837     * parts where a child can be added:
9838     *
9839     * @section secContent Content (SWALLOW part)
9840     *
9841     * Only one object can be added to the @c SWALLOW part (but you still can
9842     * have many @c SWALLOW parts and one object on each of them). Use the @c
9843     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9844     * objects as content of the @c SWALLOW. After being set to this part, the 
9845     * object size, position, visibility, clipping and other description 
9846     * properties will be totally controlled by the description of the given part
9847     * (inside the Edje theme file).
9848     *
9849     * One can use @c evas_object_size_hint_* functions on the child to have some
9850     * kind of control over its behavior, but the resulting behavior will still
9851     * depend heavily on the @c SWALLOW part description.
9852     *
9853     * The Edje theme also can change the part description, based on signals or
9854     * scripts running inside the theme. This change can also be animated. All of
9855     * this will affect the child object set as content accordingly. The object
9856     * size will be changed if the part size is changed, it will animate move if
9857     * the part is moving, and so on.
9858     *
9859     * The following picture demonstrates a Layout widget with a child object
9860     * added to its @c SWALLOW:
9861     *
9862     * @image html layout_swallow.png
9863     * @image latex layout_swallow.eps width=\textwidth
9864     *
9865     * @section secBox Box (BOX part)
9866     *
9867     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9868     * allows one to add objects to the box and have them distributed along its
9869     * area, accordingly to the specified @a layout property (now by @a layout we
9870     * mean the chosen layouting design of the Box, not the Layout widget
9871     * itself).
9872     *
9873     * A similar effect for having a box with its position, size and other things
9874     * controlled by the Layout theme would be to create an Elementary @ref Box
9875     * widget and add it as a Content in the @c SWALLOW part.
9876     *
9877     * The main difference of using the Layout Box is that its behavior, the box
9878     * properties like layouting format, padding, align, etc. will be all
9879     * controlled by the theme. This means, for example, that a signal could be
9880     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9881     * handled the signal by changing the box padding, or align, or both. Using
9882     * the Elementary @ref Box widget is not necessarily harder or easier, it
9883     * just depends on the circunstances and requirements.
9884     *
9885     * The Layout Box can be used through the @c elm_layout_box_* set of
9886     * functions.
9887     *
9888     * The following picture demonstrates a Layout widget with many child objects
9889     * added to its @c BOX part:
9890     *
9891     * @image html layout_box.png
9892     * @image latex layout_box.eps width=\textwidth
9893     *
9894     * @section secTable Table (TABLE part)
9895     *
9896     * Just like the @ref secBox, the Layout Table is very similar to the
9897     * Elementary @ref Table widget. It allows one to add objects to the Table
9898     * specifying the row and column where the object should be added, and any
9899     * column or row span if necessary.
9900     *
9901     * Again, we could have this design by adding a @ref Table widget to the @c
9902     * SWALLOW part using elm_object_part_content_set(). The same difference happens
9903     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9904     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9905     *
9906     * The Layout Table can be used through the @c elm_layout_table_* set of
9907     * functions.
9908     *
9909     * The following picture demonstrates a Layout widget with many child objects
9910     * added to its @c TABLE part:
9911     *
9912     * @image html layout_table.png
9913     * @image latex layout_table.eps width=\textwidth
9914     *
9915     * @section secPredef Predefined Layouts
9916     *
9917     * Another interesting thing about the Layout widget is that it offers some
9918     * predefined themes that come with the default Elementary theme. These
9919     * themes can be set by the call elm_layout_theme_set(), and provide some
9920     * basic functionality depending on the theme used.
9921     *
9922     * Most of them already send some signals, some already provide a toolbar or
9923     * back and next buttons.
9924     *
9925     * These are available predefined theme layouts. All of them have class = @c
9926     * layout, group = @c application, and style = one of the following options:
9927     *
9928     * @li @c toolbar-content - application with toolbar and main content area
9929     * @li @c toolbar-content-back - application with toolbar and main content
9930     * area with a back button and title area
9931     * @li @c toolbar-content-back-next - application with toolbar and main
9932     * content area with a back and next buttons and title area
9933     * @li @c content-back - application with a main content area with a back
9934     * button and title area
9935     * @li @c content-back-next - application with a main content area with a
9936     * back and next buttons and title area
9937     * @li @c toolbar-vbox - application with toolbar and main content area as a
9938     * vertical box
9939     * @li @c toolbar-table - application with toolbar and main content area as a
9940     * table
9941     *
9942     * @section secExamples Examples
9943     *
9944     * Some examples of the Layout widget can be found here:
9945     * @li @ref layout_example_01
9946     * @li @ref layout_example_02
9947     * @li @ref layout_example_03
9948     * @li @ref layout_example_edc
9949     *
9950     */
9951
9952    /**
9953     * Add a new layout to the parent
9954     *
9955     * @param parent The parent object
9956     * @return The new object or NULL if it cannot be created
9957     *
9958     * @see elm_layout_file_set()
9959     * @see elm_layout_theme_set()
9960     *
9961     * @ingroup Layout
9962     */
9963    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9964    /**
9965     * Set the file that will be used as layout
9966     *
9967     * @param obj The layout object
9968     * @param file The path to file (edj) that will be used as layout
9969     * @param group The group that the layout belongs in edje file
9970     *
9971     * @return (1 = success, 0 = error)
9972     *
9973     * @ingroup Layout
9974     */
9975    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9976    /**
9977     * Set the edje group from the elementary theme that will be used as layout
9978     *
9979     * @param obj The layout object
9980     * @param clas the clas of the group
9981     * @param group the group
9982     * @param style the style to used
9983     *
9984     * @return (1 = success, 0 = error)
9985     *
9986     * @ingroup Layout
9987     */
9988    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9989    /**
9990     * Set the layout content.
9991     *
9992     * @param obj The layout object
9993     * @param swallow The swallow part name in the edje file
9994     * @param content The child that will be added in this layout object
9995     *
9996     * Once the content object is set, a previously set one will be deleted.
9997     * If you want to keep that old content object, use the
9998     * elm_object_part_content_unset() function.
9999     *
10000     * @note In an Edje theme, the part used as a content container is called @c
10001     * SWALLOW. This is why the parameter name is called @p swallow, but it is
10002     * expected to be a part name just like the second parameter of
10003     * elm_layout_box_append().
10004     *
10005     * @see elm_layout_box_append()
10006     * @see elm_object_part_content_get()
10007     * @see elm_object_part_content_unset()
10008     * @see @ref secBox
10009     * @deprecated use elm_object_part_content_set() instead
10010     *
10011     * @ingroup Layout
10012     */
10013    WILL_DEPRECATE EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10014    /**
10015     * Get the child object in the given content part.
10016     *
10017     * @param obj The layout object
10018     * @param swallow The SWALLOW part to get its content
10019     *
10020     * @return The swallowed object or NULL if none or an error occurred
10021     *
10022     * @deprecated use elm_object_part_content_get() instead
10023     *
10024     * @ingroup Layout
10025     */
10026    WILL_DEPRECATE EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10027    /**
10028     * Unset the layout content.
10029     *
10030     * @param obj The layout object
10031     * @param swallow The swallow part name in the edje file
10032     * @return The content that was being used
10033     *
10034     * Unparent and return the content object which was set for this part.
10035     *
10036     * @deprecated use elm_object_part_content_unset() instead
10037     *
10038     * @ingroup Layout
10039     */
10040    WILL_DEPRECATE EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10041    /**
10042     * Set the text of the given part
10043     *
10044     * @param obj The layout object
10045     * @param part The TEXT part where to set the text
10046     * @param text The text to set
10047     *
10048     * @ingroup Layout
10049     * @deprecated use elm_object_part_text_set() instead.
10050     */
10051    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10052    /**
10053     * Get the text set in the given part
10054     *
10055     * @param obj The layout object
10056     * @param part The TEXT part to retrieve the text off
10057     *
10058     * @return The text set in @p part
10059     *
10060     * @ingroup Layout
10061     * @deprecated use elm_object_part_text_get() instead.
10062     */
10063    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10064    /**
10065     * Append child to layout box part.
10066     *
10067     * @param obj the layout object
10068     * @param part the box part to which the object will be appended.
10069     * @param child the child object to append to box.
10070     *
10071     * Once the object is appended, it will become child of the layout. Its
10072     * lifetime will be bound to the layout, whenever the layout dies the child
10073     * will be deleted automatically. One should use elm_layout_box_remove() to
10074     * make this layout forget about the object.
10075     *
10076     * @see elm_layout_box_prepend()
10077     * @see elm_layout_box_insert_before()
10078     * @see elm_layout_box_insert_at()
10079     * @see elm_layout_box_remove()
10080     *
10081     * @ingroup Layout
10082     */
10083    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10084    /**
10085     * Prepend child to layout box part.
10086     *
10087     * @param obj the layout object
10088     * @param part the box part to prepend.
10089     * @param child the child object to prepend to box.
10090     *
10091     * Once the object is prepended, it will become child of the layout. Its
10092     * lifetime will be bound to the layout, whenever the layout dies the child
10093     * will be deleted automatically. One should use elm_layout_box_remove() to
10094     * make this layout forget about the object.
10095     *
10096     * @see elm_layout_box_append()
10097     * @see elm_layout_box_insert_before()
10098     * @see elm_layout_box_insert_at()
10099     * @see elm_layout_box_remove()
10100     *
10101     * @ingroup Layout
10102     */
10103    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10104    /**
10105     * Insert child to layout box part before a reference object.
10106     *
10107     * @param obj the layout object
10108     * @param part the box part to insert.
10109     * @param child the child object to insert into box.
10110     * @param reference another reference object to insert before in box.
10111     *
10112     * Once the object is inserted, it will become child of the layout. Its
10113     * lifetime will be bound to the layout, whenever the layout dies the child
10114     * will be deleted automatically. One should use elm_layout_box_remove() to
10115     * make this layout forget about the object.
10116     *
10117     * @see elm_layout_box_append()
10118     * @see elm_layout_box_prepend()
10119     * @see elm_layout_box_insert_before()
10120     * @see elm_layout_box_remove()
10121     *
10122     * @ingroup Layout
10123     */
10124    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10125    /**
10126     * Insert child to layout box part at a given position.
10127     *
10128     * @param obj the layout object
10129     * @param part the box part to insert.
10130     * @param child the child object to insert into box.
10131     * @param pos the numeric position >=0 to insert the child.
10132     *
10133     * Once the object is inserted, it will become child of the layout. Its
10134     * lifetime will be bound to the layout, whenever the layout dies the child
10135     * will be deleted automatically. One should use elm_layout_box_remove() to
10136     * make this layout forget about the object.
10137     *
10138     * @see elm_layout_box_append()
10139     * @see elm_layout_box_prepend()
10140     * @see elm_layout_box_insert_before()
10141     * @see elm_layout_box_remove()
10142     *
10143     * @ingroup Layout
10144     */
10145    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10146    /**
10147     * Remove a child of the given part box.
10148     *
10149     * @param obj The layout object
10150     * @param part The box part name to remove child.
10151     * @param child The object to remove from box.
10152     * @return The object that was being used, or NULL if not found.
10153     *
10154     * The object will be removed from the box part and its lifetime will
10155     * not be handled by the layout anymore. This is equivalent to
10156     * elm_object_part_content_unset() for box.
10157     *
10158     * @see elm_layout_box_append()
10159     * @see elm_layout_box_remove_all()
10160     *
10161     * @ingroup Layout
10162     */
10163    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10164    /**
10165     * Remove all children of the given part box.
10166     *
10167     * @param obj The layout object
10168     * @param part The box part name to remove child.
10169     * @param clear If EINA_TRUE, then all objects will be deleted as
10170     *        well, otherwise they will just be removed and will be
10171     *        dangling on the canvas.
10172     *
10173     * The objects will be removed from the box part and their lifetime will
10174     * not be handled by the layout anymore. This is equivalent to
10175     * elm_layout_box_remove() for all box children.
10176     *
10177     * @see elm_layout_box_append()
10178     * @see elm_layout_box_remove()
10179     *
10180     * @ingroup Layout
10181     */
10182    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10183    /**
10184     * Insert child to layout table part.
10185     *
10186     * @param obj the layout object
10187     * @param part the box part to pack child.
10188     * @param child_obj the child object to pack into table.
10189     * @param col the column to which the child should be added. (>= 0)
10190     * @param row the row to which the child should be added. (>= 0)
10191     * @param colspan how many columns should be used to store this object. (>=
10192     *        1)
10193     * @param rowspan how many rows should be used to store this object. (>= 1)
10194     *
10195     * Once the object is inserted, it will become child of the table. Its
10196     * lifetime will be bound to the layout, and whenever the layout dies the
10197     * child will be deleted automatically. One should use
10198     * elm_layout_table_remove() to make this layout forget about the object.
10199     *
10200     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10201     * more space than a single cell. For instance, the following code:
10202     * @code
10203     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10204     * @endcode
10205     *
10206     * Would result in an object being added like the following picture:
10207     *
10208     * @image html layout_colspan.png
10209     * @image latex layout_colspan.eps width=\textwidth
10210     *
10211     * @see elm_layout_table_unpack()
10212     * @see elm_layout_table_clear()
10213     *
10214     * @ingroup Layout
10215     */
10216    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);
10217    /**
10218     * Unpack (remove) a child of the given part table.
10219     *
10220     * @param obj The layout object
10221     * @param part The table part name to remove child.
10222     * @param child_obj The object to remove from table.
10223     * @return The object that was being used, or NULL if not found.
10224     *
10225     * The object will be unpacked from the table part and its lifetime
10226     * will not be handled by the layout anymore. This is equivalent to
10227     * elm_object_part_content_unset() for table.
10228     *
10229     * @see elm_layout_table_pack()
10230     * @see elm_layout_table_clear()
10231     *
10232     * @ingroup Layout
10233     */
10234    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10235    /**
10236     * Remove all the child objects of the given part table.
10237     *
10238     * @param obj The layout object
10239     * @param part The table part name to remove child.
10240     * @param clear If EINA_TRUE, then all objects will be deleted as
10241     *        well, otherwise they will just be removed and will be
10242     *        dangling on the canvas.
10243     *
10244     * The objects will be removed from the table part and their lifetime will
10245     * not be handled by the layout anymore. This is equivalent to
10246     * elm_layout_table_unpack() for all table children.
10247     *
10248     * @see elm_layout_table_pack()
10249     * @see elm_layout_table_unpack()
10250     *
10251     * @ingroup Layout
10252     */
10253    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10254    /**
10255     * Get the edje layout
10256     *
10257     * @param obj The layout object
10258     *
10259     * @return A Evas_Object with the edje layout settings loaded
10260     * with function elm_layout_file_set
10261     *
10262     * This returns the edje object. It is not expected to be used to then
10263     * swallow objects via edje_object_part_swallow() for example. Use
10264     * elm_object_part_content_set() instead so child object handling and sizing is
10265     * done properly.
10266     *
10267     * @note This function should only be used if you really need to call some
10268     * low level Edje function on this edje object. All the common stuff (setting
10269     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10270     * with proper elementary functions.
10271     *
10272     * @see elm_object_signal_callback_add()
10273     * @see elm_object_signal_emit()
10274     * @see elm_object_part_text_set()
10275     * @see elm_object_part_content_set()
10276     * @see elm_layout_box_append()
10277     * @see elm_layout_table_pack()
10278     * @see elm_layout_data_get()
10279     *
10280     * @ingroup Layout
10281     */
10282    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10283    /**
10284     * Get the edje data from the given layout
10285     *
10286     * @param obj The layout object
10287     * @param key The data key
10288     *
10289     * @return The edje data string
10290     *
10291     * This function fetches data specified inside the edje theme of this layout.
10292     * This function return NULL if data is not found.
10293     *
10294     * In EDC this comes from a data block within the group block that @p
10295     * obj was loaded from. E.g.
10296     *
10297     * @code
10298     * collections {
10299     *   group {
10300     *     name: "a_group";
10301     *     data {
10302     *       item: "key1" "value1";
10303     *       item: "key2" "value2";
10304     *     }
10305     *   }
10306     * }
10307     * @endcode
10308     *
10309     * @ingroup Layout
10310     */
10311    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10312    /**
10313     * Eval sizing
10314     *
10315     * @param obj The layout object
10316     *
10317     * Manually forces a sizing re-evaluation. This is useful when the minimum
10318     * size required by the edje theme of this layout has changed. The change on
10319     * the minimum size required by the edje theme is not immediately reported to
10320     * the elementary layout, so one needs to call this function in order to tell
10321     * the widget (layout) that it needs to reevaluate its own size.
10322     *
10323     * The minimum size of the theme is calculated based on minimum size of
10324     * parts, the size of elements inside containers like box and table, etc. All
10325     * of this can change due to state changes, and that's when this function
10326     * should be called.
10327     *
10328     * Also note that a standard signal of "size,eval" "elm" emitted from the
10329     * edje object will cause this to happen too.
10330     *
10331     * @ingroup Layout
10332     */
10333    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10334
10335    /**
10336     * Sets a specific cursor for an edje part.
10337     *
10338     * @param obj The layout object.
10339     * @param part_name a part from loaded edje group.
10340     * @param cursor cursor name to use, see Elementary_Cursor.h
10341     *
10342     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10343     *         part not exists or it has "mouse_events: 0".
10344     *
10345     * @ingroup Layout
10346     */
10347    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10348
10349    /**
10350     * Get the cursor to be shown when mouse is over an edje part
10351     *
10352     * @param obj The layout object.
10353     * @param part_name a part from loaded edje group.
10354     * @return the cursor name.
10355     *
10356     * @ingroup Layout
10357     */
10358    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10359
10360    /**
10361     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10362     *
10363     * @param obj The layout object.
10364     * @param part_name a part from loaded edje group, that had a cursor set
10365     *        with elm_layout_part_cursor_set().
10366     *
10367     * @ingroup Layout
10368     */
10369    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10370
10371    /**
10372     * Sets a specific cursor style for an edje part.
10373     *
10374     * @param obj The layout object.
10375     * @param part_name a part from loaded edje group.
10376     * @param style the theme style to use (default, transparent, ...)
10377     *
10378     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10379     *         part not exists or it did not had a cursor set.
10380     *
10381     * @ingroup Layout
10382     */
10383    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10384
10385    /**
10386     * Gets a specific cursor style for an edje part.
10387     *
10388     * @param obj The layout object.
10389     * @param part_name a part from loaded edje group.
10390     *
10391     * @return the theme style in use, defaults to "default". If the
10392     *         object does not have a cursor set, then NULL is returned.
10393     *
10394     * @ingroup Layout
10395     */
10396    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10397
10398    /**
10399     * Sets if the cursor set should be searched on the theme or should use
10400     * the provided by the engine, only.
10401     *
10402     * @note before you set if should look on theme you should define a
10403     * cursor with elm_layout_part_cursor_set(). By default it will only
10404     * look for cursors provided by the engine.
10405     *
10406     * @param obj The layout object.
10407     * @param part_name a part from loaded edje group.
10408     * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10409     *        or should also search on widget's theme as well (EINA_FALSE)
10410     *
10411     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10412     *         part not exists or it did not had a cursor set.
10413     *
10414     * @ingroup Layout
10415     */
10416    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);
10417
10418    /**
10419     * Gets a specific cursor engine_only for an edje part.
10420     *
10421     * @param obj The layout object.
10422     * @param part_name a part from loaded edje group.
10423     *
10424     * @return whenever the cursor is just provided by engine or also from theme.
10425     *
10426     * @ingroup Layout
10427     */
10428    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10429
10430 /**
10431  * @def elm_layout_icon_set
10432  * Convenience macro to set the icon object in a layout that follows the
10433  * Elementary naming convention for its parts.
10434  *
10435  * @ingroup Layout
10436  */
10437 #define elm_layout_icon_set(_ly, _obj) \
10438   do { \
10439     const char *sig; \
10440     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10441     if ((_obj)) sig = "elm,state,icon,visible"; \
10442     else sig = "elm,state,icon,hidden"; \
10443     elm_object_signal_emit((_ly), sig, "elm"); \
10444   } while (0)
10445
10446 /**
10447  * @def elm_layout_icon_get
10448  * Convienience macro to get the icon object from a layout that follows the
10449  * Elementary naming convention for its parts.
10450  *
10451  * @ingroup Layout
10452  */
10453 #define elm_layout_icon_get(_ly) \
10454   elm_object_part_content_get((_ly), "elm.swallow.icon")
10455
10456 /**
10457  * @def elm_layout_end_set
10458  * Convienience macro to set the end object in a layout that follows the
10459  * Elementary naming convention for its parts.
10460  *
10461  * @ingroup Layout
10462  */
10463 #define elm_layout_end_set(_ly, _obj) \
10464   do { \
10465     const char *sig; \
10466     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10467     if ((_obj)) sig = "elm,state,end,visible"; \
10468     else sig = "elm,state,end,hidden"; \
10469     elm_object_signal_emit((_ly), sig, "elm"); \
10470   } while (0)
10471
10472 /**
10473  * @def elm_layout_end_get
10474  * Convienience macro to get the end object in a layout that follows the
10475  * Elementary naming convention for its parts.
10476  *
10477  * @ingroup Layout
10478  */
10479 #define elm_layout_end_get(_ly) \
10480   elm_object_part_content_get((_ly), "elm.swallow.end")
10481
10482 /**
10483  * @def elm_layout_label_set
10484  * Convienience macro to set the label in a layout that follows the
10485  * Elementary naming convention for its parts.
10486  *
10487  * @ingroup Layout
10488  * @deprecated use elm_object_text_set() instead.
10489  */
10490 #define elm_layout_label_set(_ly, _txt) \
10491   elm_layout_text_set((_ly), "elm.text", (_txt))
10492
10493 /**
10494  * @def elm_layout_label_get
10495  * Convenience macro to get the label in a layout that follows the
10496  * Elementary naming convention for its parts.
10497  *
10498  * @ingroup Layout
10499  * @deprecated use elm_object_text_set() instead.
10500  */
10501 #define elm_layout_label_get(_ly) \
10502   elm_layout_text_get((_ly), "elm.text")
10503
10504    /* smart callbacks called:
10505     * "theme,changed" - when elm theme is changed.
10506     */
10507
10508    /**
10509     * @defgroup Notify Notify
10510     *
10511     * @image html img/widget/notify/preview-00.png
10512     * @image latex img/widget/notify/preview-00.eps
10513     *
10514     * Display a container in a particular region of the parent(top, bottom,
10515     * etc).  A timeout can be set to automatically hide the notify. This is so
10516     * that, after an evas_object_show() on a notify object, if a timeout was set
10517     * on it, it will @b automatically get hidden after that time.
10518     *
10519     * Signals that you can add callbacks for are:
10520     * @li "timeout" - when timeout happens on notify and it's hidden
10521     * @li "block,clicked" - when a click outside of the notify happens
10522     *
10523     * Default contents parts of the notify widget that you can use for are:
10524     * @li "default" - A content of the notify
10525     *
10526     * @ref tutorial_notify show usage of the API.
10527     *
10528     * @{
10529     */
10530    /**
10531     * @brief Possible orient values for notify.
10532     *
10533     * This values should be used in conjunction to elm_notify_orient_set() to
10534     * set the position in which the notify should appear(relative to its parent)
10535     * and in conjunction with elm_notify_orient_get() to know where the notify
10536     * is appearing.
10537     */
10538    typedef enum _Elm_Notify_Orient
10539      {
10540         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10541         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10542         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10543         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10544         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10545         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10546         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10547         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10548         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10549         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10550      } Elm_Notify_Orient;
10551    /**
10552     * @brief Add a new notify to the parent
10553     *
10554     * @param parent The parent object
10555     * @return The new object or NULL if it cannot be created
10556     */
10557    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10558    /**
10559     * @brief Set the content of the notify widget
10560     *
10561     * @param obj The notify object
10562     * @param content The content will be filled in this notify object
10563     *
10564     * Once the content object is set, a previously set one will be deleted. If
10565     * you want to keep that old content object, use the
10566     * elm_notify_content_unset() function.
10567     *
10568     * @deprecated use elm_object_content_set() instead
10569     *
10570     */
10571    WILL_DEPRECATE  EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10572    /**
10573     * @brief Unset the content of the notify widget
10574     *
10575     * @param obj The notify object
10576     * @return The content that was being used
10577     *
10578     * Unparent and return the content object which was set for this widget
10579     *
10580     * @see elm_notify_content_set()
10581     * @deprecated use elm_object_content_unset() instead
10582     *
10583     */
10584    WILL_DEPRECATE  EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10585    /**
10586     * @brief Return the content of the notify widget
10587     *
10588     * @param obj The notify object
10589     * @return The content that is being used
10590     *
10591     * @see elm_notify_content_set()
10592     * @deprecated use elm_object_content_get() instead
10593     *
10594     */
10595    WILL_DEPRECATE  EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10596    /**
10597     * @brief Set the notify parent
10598     *
10599     * @param obj The notify object
10600     * @param content The new parent
10601     *
10602     * Once the parent object is set, a previously set one will be disconnected
10603     * and replaced.
10604     */
10605    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10606    /**
10607     * @brief Get the notify parent
10608     *
10609     * @param obj The notify object
10610     * @return The parent
10611     *
10612     * @see elm_notify_parent_set()
10613     */
10614    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10615    /**
10616     * @brief Set the orientation
10617     *
10618     * @param obj The notify object
10619     * @param orient The new orientation
10620     *
10621     * Sets the position in which the notify will appear in its parent.
10622     *
10623     * @see @ref Elm_Notify_Orient for possible values.
10624     */
10625    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10626    /**
10627     * @brief Return the orientation
10628     * @param obj The notify object
10629     * @return The orientation of the notification
10630     *
10631     * @see elm_notify_orient_set()
10632     * @see Elm_Notify_Orient
10633     */
10634    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10635    /**
10636     * @brief Set the time interval after which the notify window is going to be
10637     * hidden.
10638     *
10639     * @param obj The notify object
10640     * @param time The timeout in seconds
10641     *
10642     * This function sets a timeout and starts the timer controlling when the
10643     * notify is hidden. Since calling evas_object_show() on a notify restarts
10644     * the timer controlling when the notify is hidden, setting this before the
10645     * notify is shown will in effect mean starting the timer when the notify is
10646     * shown.
10647     *
10648     * @note Set a value <= 0.0 to disable a running timer.
10649     *
10650     * @note If the value > 0.0 and the notify is previously visible, the
10651     * timer will be started with this value, canceling any running timer.
10652     */
10653    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10654    /**
10655     * @brief Return the timeout value (in seconds)
10656     * @param obj the notify object
10657     *
10658     * @see elm_notify_timeout_set()
10659     */
10660    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10661    /**
10662     * @brief Sets whether events should be passed to by a click outside
10663     * its area.
10664     *
10665     * @param obj The notify object
10666     * @param repeats EINA_TRUE Events are repeats, else no
10667     *
10668     * When true if the user clicks outside the window the events will be caught
10669     * by the others widgets, else the events are blocked.
10670     *
10671     * @note The default value is EINA_TRUE.
10672     */
10673    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10674    /**
10675     * @brief Return true if events are repeat below the notify object
10676     * @param obj the notify object
10677     *
10678     * @see elm_notify_repeat_events_set()
10679     */
10680    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10681    /**
10682     * @}
10683     */
10684
10685    /**
10686     * @defgroup Hover Hover
10687     *
10688     * @image html img/widget/hover/preview-00.png
10689     * @image latex img/widget/hover/preview-00.eps
10690     *
10691     * A Hover object will hover over its @p parent object at the @p target
10692     * location. Anything in the background will be given a darker coloring to
10693     * indicate that the hover object is on top (at the default theme). When the
10694     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10695     * clicked that @b doesn't cause the hover to be dismissed.
10696     *
10697     * A Hover object has two parents. One parent that owns it during creation
10698     * and the other parent being the one over which the hover object spans.
10699     *
10700     *
10701     * @note The hover object will take up the entire space of @p target
10702     * object.
10703     *
10704     * Elementary has the following styles for the hover widget:
10705     * @li default
10706     * @li popout
10707     * @li menu
10708     * @li hoversel_vertical
10709     *
10710     * The following are the available position for content:
10711     * @li left
10712     * @li top-left
10713     * @li top
10714     * @li top-right
10715     * @li right
10716     * @li bottom-right
10717     * @li bottom
10718     * @li bottom-left
10719     * @li middle
10720     * @li smart
10721     *
10722     * Signals that you can add callbacks for are:
10723     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10724     * @li "smart,changed" - a content object placed under the "smart"
10725     *                   policy was replaced to a new slot direction.
10726     *
10727     * See @ref tutorial_hover for more information.
10728     *
10729     * @{
10730     */
10731    typedef enum _Elm_Hover_Axis
10732      {
10733         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10734         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10735         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10736         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10737      } Elm_Hover_Axis;
10738    /**
10739     * @brief Adds a hover object to @p parent
10740     *
10741     * @param parent The parent object
10742     * @return The hover object or NULL if one could not be created
10743     */
10744    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10745    /**
10746     * @brief Sets the target object for the hover.
10747     *
10748     * @param obj The hover object
10749     * @param target The object to center the hover onto.
10750     *
10751     * This function will cause the hover to be centered on the target object.
10752     */
10753    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10754    /**
10755     * @brief Gets the target object for the hover.
10756     *
10757     * @param obj The hover object
10758     * @return The target object for the hover.
10759     *
10760     * @see elm_hover_target_set()
10761     */
10762    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10763    /**
10764     * @brief Sets the parent object for the hover.
10765     *
10766     * @param obj The hover object
10767     * @param parent The object to locate the hover over.
10768     *
10769     * This function will cause the hover to take up the entire space that the
10770     * parent object fills.
10771     */
10772    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10773    /**
10774     * @brief Gets the parent object for the hover.
10775     *
10776     * @param obj The hover object
10777     * @return The parent object to locate the hover over.
10778     *
10779     * @see elm_hover_parent_set()
10780     */
10781    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10782    /**
10783     * @brief Sets the content of the hover object and the direction in which it
10784     * will pop out.
10785     *
10786     * @param obj The hover object
10787     * @param swallow The direction that the object will be displayed
10788     * at. Accepted values are "left", "top-left", "top", "top-right",
10789     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10790     * "smart".
10791     * @param content The content to place at @p swallow
10792     *
10793     * Once the content object is set for a given direction, a previously
10794     * set one (on the same direction) will be deleted. If you want to
10795     * keep that old content object, use the elm_hover_content_unset()
10796     * function.
10797     *
10798     * All directions may have contents at the same time, except for
10799     * "smart". This is a special placement hint and its use case
10800     * independs of the calculations coming from
10801     * elm_hover_best_content_location_get(). Its use is for cases when
10802     * one desires only one hover content, but with a dynamic special
10803     * placement within the hover area. The content's geometry, whenever
10804     * it changes, will be used to decide on a best location, not
10805     * extrapolating the hover's parent object view to show it in (still
10806     * being the hover's target determinant of its medium part -- move and
10807     * resize it to simulate finger sizes, for example). If one of the
10808     * directions other than "smart" are used, a previously content set
10809     * using it will be deleted, and vice-versa.
10810     */
10811    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10812    /**
10813     * @brief Get the content of the hover object, in a given direction.
10814     *
10815     * Return the content object which was set for this widget in the
10816     * @p swallow direction.
10817     *
10818     * @param obj The hover object
10819     * @param swallow The direction that the object was display at.
10820     * @return The content that was being used
10821     *
10822     * @see elm_hover_content_set()
10823     */
10824    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10825    /**
10826     * @brief Unset the content of the hover object, in a given direction.
10827     *
10828     * Unparent and return the content object set at @p swallow direction.
10829     *
10830     * @param obj The hover object
10831     * @param swallow The direction that the object was display at.
10832     * @return The content that was being used.
10833     *
10834     * @see elm_hover_content_set()
10835     */
10836    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10837    /**
10838     * @brief Returns the best swallow location for content in the hover.
10839     *
10840     * @param obj The hover object
10841     * @param pref_axis The preferred orientation axis for the hover object to use
10842     * @return The edje location to place content into the hover or @c
10843     *         NULL, on errors.
10844     *
10845     * Best is defined here as the location at which there is the most available
10846     * space.
10847     *
10848     * @p pref_axis may be one of
10849     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10850     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10851     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10852     * - @c ELM_HOVER_AXIS_BOTH -- both
10853     *
10854     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10855     * nescessarily be along the horizontal axis("left" or "right"). If
10856     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10857     * be along the vertical axis("top" or "bottom"). Chossing
10858     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10859     * returned position may be in either axis.
10860     *
10861     * @see elm_hover_content_set()
10862     */
10863    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10864    /**
10865     * @}
10866     */
10867
10868    /* entry */
10869    /**
10870     * @defgroup Entry Entry
10871     *
10872     * @image html img/widget/entry/preview-00.png
10873     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10874     * @image html img/widget/entry/preview-01.png
10875     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10876     * @image html img/widget/entry/preview-02.png
10877     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10878     * @image html img/widget/entry/preview-03.png
10879     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10880     *
10881     * An entry is a convenience widget which shows a box that the user can
10882     * enter text into. Entries by default don't scroll, so they grow to
10883     * accomodate the entire text, resizing the parent window as needed. This
10884     * can be changed with the elm_entry_scrollable_set() function.
10885     *
10886     * They can also be single line or multi line (the default) and when set
10887     * to multi line mode they support text wrapping in any of the modes
10888     * indicated by #Elm_Wrap_Type.
10889     *
10890     * Other features include password mode, filtering of inserted text with
10891     * elm_entry_text_filter_append() and related functions, inline "items" and
10892     * formatted markup text.
10893     *
10894     * @section entry-markup Formatted text
10895     *
10896     * The markup tags supported by the Entry are defined by the theme, but
10897     * even when writing new themes or extensions it's a good idea to stick to
10898     * a sane default, to maintain coherency and avoid application breakages.
10899     * Currently defined by the default theme are the following tags:
10900     * @li \<br\>: Inserts a line break.
10901     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10902     * breaks.
10903     * @li \<tab\>: Inserts a tab.
10904     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10905     * enclosed text.
10906     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10907     * @li \<link\>...\</link\>: Underlines the enclosed text.
10908     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10909     *
10910     * @section entry-special Special markups
10911     *
10912     * Besides those used to format text, entries support two special markup
10913     * tags used to insert clickable portions of text or items inlined within
10914     * the text.
10915     *
10916     * @subsection entry-anchors Anchors
10917     *
10918     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10919     * \</a\> tags and an event will be generated when this text is clicked,
10920     * like this:
10921     *
10922     * @code
10923     * This text is outside <a href=anc-01>but this one is an anchor</a>
10924     * @endcode
10925     *
10926     * The @c href attribute in the opening tag gives the name that will be
10927     * used to identify the anchor and it can be any valid utf8 string.
10928     *
10929     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10930     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10931     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10932     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10933     * an anchor.
10934     *
10935     * @subsection entry-items Items
10936     *
10937     * Inlined in the text, any other @c Evas_Object can be inserted by using
10938     * \<item\> tags this way:
10939     *
10940     * @code
10941     * <item size=16x16 vsize=full href=emoticon/haha></item>
10942     * @endcode
10943     *
10944     * Just like with anchors, the @c href identifies each item, but these need,
10945     * in addition, to indicate their size, which is done using any one of
10946     * @c size, @c absize or @c relsize attributes. These attributes take their
10947     * value in the WxH format, where W is the width and H the height of the
10948     * item.
10949     *
10950     * @li absize: Absolute pixel size for the item. Whatever value is set will
10951     * be the item's size regardless of any scale value the object may have
10952     * been set to. The final line height will be adjusted to fit larger items.
10953     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10954     * for the object.
10955     * @li relsize: Size is adjusted for the item to fit within the current
10956     * line height.
10957     *
10958     * Besides their size, items are specificed a @c vsize value that affects
10959     * how their final size and position are calculated. The possible values
10960     * are:
10961     * @li ascent: Item will be placed within the line's baseline and its
10962     * ascent. That is, the height between the line where all characters are
10963     * positioned and the highest point in the line. For @c size and @c absize
10964     * items, the descent value will be added to the total line height to make
10965     * them fit. @c relsize items will be adjusted to fit within this space.
10966     * @li full: Items will be placed between the descent and ascent, or the
10967     * lowest point in the line and its highest.
10968     *
10969     * The next image shows different configurations of items and how
10970     * the previously mentioned options affect their sizes. In all cases,
10971     * the green line indicates the ascent, blue for the baseline and red for
10972     * the descent.
10973     *
10974     * @image html entry_item.png
10975     * @image latex entry_item.eps width=\textwidth
10976     *
10977     * And another one to show how size differs from absize. In the first one,
10978     * the scale value is set to 1.0, while the second one is using one of 2.0.
10979     *
10980     * @image html entry_item_scale.png
10981     * @image latex entry_item_scale.eps width=\textwidth
10982     *
10983     * After the size for an item is calculated, the entry will request an
10984     * object to place in its space. For this, the functions set with
10985     * elm_entry_item_provider_append() and related functions will be called
10986     * in order until one of them returns a @c non-NULL value. If no providers
10987     * are available, or all of them return @c NULL, then the entry falls back
10988     * to one of the internal defaults, provided the name matches with one of
10989     * them.
10990     *
10991     * All of the following are currently supported:
10992     *
10993     * - emoticon/angry
10994     * - emoticon/angry-shout
10995     * - emoticon/crazy-laugh
10996     * - emoticon/evil-laugh
10997     * - emoticon/evil
10998     * - emoticon/goggle-smile
10999     * - emoticon/grumpy
11000     * - emoticon/grumpy-smile
11001     * - emoticon/guilty
11002     * - emoticon/guilty-smile
11003     * - emoticon/haha
11004     * - emoticon/half-smile
11005     * - emoticon/happy-panting
11006     * - emoticon/happy
11007     * - emoticon/indifferent
11008     * - emoticon/kiss
11009     * - emoticon/knowing-grin
11010     * - emoticon/laugh
11011     * - emoticon/little-bit-sorry
11012     * - emoticon/love-lots
11013     * - emoticon/love
11014     * - emoticon/minimal-smile
11015     * - emoticon/not-happy
11016     * - emoticon/not-impressed
11017     * - emoticon/omg
11018     * - emoticon/opensmile
11019     * - emoticon/smile
11020     * - emoticon/sorry
11021     * - emoticon/squint-laugh
11022     * - emoticon/surprised
11023     * - emoticon/suspicious
11024     * - emoticon/tongue-dangling
11025     * - emoticon/tongue-poke
11026     * - emoticon/uh
11027     * - emoticon/unhappy
11028     * - emoticon/very-sorry
11029     * - emoticon/what
11030     * - emoticon/wink
11031     * - emoticon/worried
11032     * - emoticon/wtf
11033     *
11034     * Alternatively, an item may reference an image by its path, using
11035     * the URI form @c file:///path/to/an/image.png and the entry will then
11036     * use that image for the item.
11037     *
11038     * @section entry-files Loading and saving files
11039     *
11040     * Entries have convinience functions to load text from a file and save
11041     * changes back to it after a short delay. The automatic saving is enabled
11042     * by default, but can be disabled with elm_entry_autosave_set() and files
11043     * can be loaded directly as plain text or have any markup in them
11044     * recognized. See elm_entry_file_set() for more details.
11045     *
11046     * @section entry-signals Emitted signals
11047     *
11048     * This widget emits the following signals:
11049     *
11050     * @li "changed": The text within the entry was changed.
11051     * @li "changed,user": The text within the entry was changed because of user interaction.
11052     * @li "activated": The enter key was pressed on a single line entry.
11053     * @li "press": A mouse button has been pressed on the entry.
11054     * @li "longpressed": A mouse button has been pressed and held for a couple
11055     * seconds.
11056     * @li "clicked": The entry has been clicked (mouse press and release).
11057     * @li "clicked,double": The entry has been double clicked.
11058     * @li "clicked,triple": The entry has been triple clicked.
11059     * @li "focused": The entry has received focus.
11060     * @li "unfocused": The entry has lost focus.
11061     * @li "selection,paste": A paste of the clipboard contents was requested.
11062     * @li "selection,copy": A copy of the selected text into the clipboard was
11063     * requested.
11064     * @li "selection,cut": A cut of the selected text into the clipboard was
11065     * requested.
11066     * @li "selection,start": A selection has begun and no previous selection
11067     * existed.
11068     * @li "selection,changed": The current selection has changed.
11069     * @li "selection,cleared": The current selection has been cleared.
11070     * @li "cursor,changed": The cursor has changed position.
11071     * @li "anchor,clicked": An anchor has been clicked. The event_info
11072     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11073     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11074     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11075     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11076     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11077     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11078     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11079     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11080     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11081     * @li "preedit,changed": The preedit string has changed.
11082     * @li "language,changed": Program language changed.
11083     *
11084     * @section entry-examples
11085     *
11086     * An overview of the Entry API can be seen in @ref entry_example_01
11087     *
11088     * @{
11089     */
11090    /**
11091     * @typedef Elm_Entry_Anchor_Info
11092     *
11093     * The info sent in the callback for the "anchor,clicked" signals emitted
11094     * by entries.
11095     */
11096    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11097    /**
11098     * @struct _Elm_Entry_Anchor_Info
11099     *
11100     * The info sent in the callback for the "anchor,clicked" signals emitted
11101     * by entries.
11102     */
11103    struct _Elm_Entry_Anchor_Info
11104      {
11105         const char *name; /**< The name of the anchor, as stated in its href */
11106         int         button; /**< The mouse button used to click on it */
11107         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11108                     y, /**< Anchor geometry, relative to canvas */
11109                     w, /**< Anchor geometry, relative to canvas */
11110                     h; /**< Anchor geometry, relative to canvas */
11111      };
11112    /**
11113     * @typedef Elm_Entry_Filter_Cb
11114     * This callback type is used by entry filters to modify text.
11115     * @param data The data specified as the last param when adding the filter
11116     * @param entry The entry object
11117     * @param text A pointer to the location of the text being filtered. This data can be modified,
11118     * but any additional allocations must be managed by the user.
11119     * @see elm_entry_text_filter_append
11120     * @see elm_entry_text_filter_prepend
11121     */
11122    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11123
11124    /**
11125     * This adds an entry to @p parent object.
11126     *
11127     * By default, entries are:
11128     * @li not scrolled
11129     * @li multi-line
11130     * @li word wrapped
11131     * @li autosave is enabled
11132     *
11133     * @param parent The parent object
11134     * @return The new object or NULL if it cannot be created
11135     */
11136    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11137    /**
11138     * Sets the entry to single line mode.
11139     *
11140     * In single line mode, entries don't ever wrap when the text reaches the
11141     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11142     * key will generate an @c "activate" event instead of adding a new line.
11143     *
11144     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11145     * and pressing enter will break the text into a different line
11146     * without generating any events.
11147     *
11148     * @param obj The entry object
11149     * @param single_line If true, the text in the entry
11150     * will be on a single line.
11151     */
11152    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11153    /**
11154     * Gets whether the entry is set to be single line.
11155     *
11156     * @param obj The entry object
11157     * @return single_line If true, the text in the entry is set to display
11158     * on a single line.
11159     *
11160     * @see elm_entry_single_line_set()
11161     */
11162    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11163    /**
11164     * Sets the entry to password mode.
11165     *
11166     * In password mode, entries are implicitly single line and the display of
11167     * any text in them is replaced with asterisks (*).
11168     *
11169     * @param obj The entry object
11170     * @param password If true, password mode is enabled.
11171     */
11172    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11173    /**
11174     * Gets whether the entry is set to password mode.
11175     *
11176     * @param obj The entry object
11177     * @return If true, the entry is set to display all characters
11178     * as asterisks (*).
11179     *
11180     * @see elm_entry_password_set()
11181     */
11182    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11183    /**
11184     * This sets the text displayed within the entry to @p entry.
11185     *
11186     * @param obj The entry object
11187     * @param entry The text to be displayed
11188     *
11189     * @deprecated Use elm_object_text_set() instead.
11190     * @note Using this function bypasses text filters
11191     */
11192    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11193    /**
11194     * This returns the text currently shown in object @p entry.
11195     * See also elm_entry_entry_set().
11196     *
11197     * @param obj The entry object
11198     * @return The currently displayed text or NULL on failure
11199     *
11200     * @deprecated Use elm_object_text_get() instead.
11201     */
11202    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11203    /**
11204     * Appends @p entry to the text of the entry.
11205     *
11206     * Adds the text in @p entry to the end of any text already present in the
11207     * widget.
11208     *
11209     * The appended text is subject to any filters set for the widget.
11210     *
11211     * @param obj The entry object
11212     * @param entry The text to be displayed
11213     *
11214     * @see elm_entry_text_filter_append()
11215     */
11216    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11217    /**
11218     * Gets whether the entry is empty.
11219     *
11220     * Empty means no text at all. If there are any markup tags, like an item
11221     * tag for which no provider finds anything, and no text is displayed, this
11222     * function still returns EINA_FALSE.
11223     *
11224     * @param obj The entry object
11225     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11226     */
11227    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11228    /**
11229     * Gets any selected text within the entry.
11230     *
11231     * If there's any selected text in the entry, this function returns it as
11232     * a string in markup format. NULL is returned if no selection exists or
11233     * if an error occurred.
11234     *
11235     * The returned value points to an internal string and should not be freed
11236     * or modified in any way. If the @p entry object is deleted or its
11237     * contents are changed, the returned pointer should be considered invalid.
11238     *
11239     * @param obj The entry object
11240     * @return The selected text within the entry or NULL on failure
11241     */
11242    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11243    /**
11244     * Returns the actual textblock object of the entry.
11245     *
11246     * This function exposes the internal textblock object that actually
11247     * contains and draws the text. This should be used for low-level
11248     * manipulations that are otherwise not possible.
11249     *
11250     * Changing the textblock directly from here will not notify edje/elm to
11251     * recalculate the textblock size automatically, so any modifications
11252     * done to the textblock returned by this function should be followed by
11253     * a call to elm_entry_calc_force().
11254     *
11255     * The return value is marked as const as an additional warning.
11256     * One should not use the returned object with any of the generic evas
11257     * functions (geometry_get/resize/move and etc), but only with the textblock
11258     * functions; The former will either not work at all, or break the correct
11259     * functionality.
11260     *
11261     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11262     * the internal textblock object. Do NOT cache the returned object, and try
11263     * not to mix calls on this object with regular elm_entry calls (which may
11264     * change the internal textblock object). This applies to all cursors
11265     * returned from textblock calls, and all the other derivative values.
11266     *
11267     * @param obj The entry object
11268     * @return The textblock object.
11269     */
11270    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11271    /**
11272     * Forces calculation of the entry size and text layouting.
11273     *
11274     * This should be used after modifying the textblock object directly. See
11275     * elm_entry_textblock_get() for more information.
11276     *
11277     * @param obj The entry object
11278     *
11279     * @see elm_entry_textblock_get()
11280     */
11281    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11282    /**
11283     * Inserts the given text into the entry at the current cursor position.
11284     *
11285     * This inserts text at the cursor position as if it was typed
11286     * by the user (note that this also allows markup which a user
11287     * can't just "type" as it would be converted to escaped text, so this
11288     * call can be used to insert things like emoticon items or bold push/pop
11289     * tags, other font and color change tags etc.)
11290     *
11291     * If any selection exists, it will be replaced by the inserted text.
11292     *
11293     * The inserted text is subject to any filters set for the widget.
11294     *
11295     * @param obj The entry object
11296     * @param entry The text to insert
11297     *
11298     * @see elm_entry_text_filter_append()
11299     */
11300    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11301    /**
11302     * Set the line wrap type to use on multi-line entries.
11303     *
11304     * Sets the wrap type used by the entry to any of the specified in
11305     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11306     * line (without inserting a line break or paragraph separator) when it
11307     * reaches the far edge of the widget.
11308     *
11309     * Note that this only makes sense for multi-line entries. A widget set
11310     * to be single line will never wrap.
11311     *
11312     * @param obj The entry object
11313     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11314     */
11315    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11316    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11317    /**
11318     * Gets the wrap mode the entry was set to use.
11319     *
11320     * @param obj The entry object
11321     * @return Wrap type
11322     *
11323     * @see also elm_entry_line_wrap_set()
11324     */
11325    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11326    /**
11327     * Sets if the entry is to be editable or not.
11328     *
11329     * By default, entries are editable and when focused, any text input by the
11330     * user will be inserted at the current cursor position. But calling this
11331     * function with @p editable as EINA_FALSE will prevent the user from
11332     * inputting text into the entry.
11333     *
11334     * The only way to change the text of a non-editable entry is to use
11335     * elm_object_text_set(), elm_entry_entry_insert() and other related
11336     * functions.
11337     *
11338     * @param obj The entry object
11339     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11340     * if not, the entry is read-only and no user input is allowed.
11341     */
11342    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11343    /**
11344     * Gets whether the entry is editable or not.
11345     *
11346     * @param obj The entry object
11347     * @return If true, the entry is editable by the user.
11348     * If false, it is not editable by the user
11349     *
11350     * @see elm_entry_editable_set()
11351     */
11352    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11353    /**
11354     * This drops any existing text selection within the entry.
11355     *
11356     * @param obj The entry object
11357     */
11358    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11359    /**
11360     * This selects all text within the entry.
11361     *
11362     * @param obj The entry object
11363     */
11364    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11365    /**
11366     * This moves the cursor one place to the right within the entry.
11367     *
11368     * @param obj The entry object
11369     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11370     */
11371    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11372    /**
11373     * This moves the cursor one place to the left within the entry.
11374     *
11375     * @param obj The entry object
11376     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11377     */
11378    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11379    /**
11380     * This moves the cursor one line up within the entry.
11381     *
11382     * @param obj The entry object
11383     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11384     */
11385    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11386    /**
11387     * This moves the cursor one line down within the entry.
11388     *
11389     * @param obj The entry object
11390     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11391     */
11392    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11393    /**
11394     * This moves the cursor to the beginning of the entry.
11395     *
11396     * @param obj The entry object
11397     */
11398    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11399    /**
11400     * This moves the cursor to the end of the entry.
11401     *
11402     * @param obj The entry object
11403     */
11404    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11405    /**
11406     * This moves the cursor to the beginning of the current line.
11407     *
11408     * @param obj The entry object
11409     */
11410    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11411    /**
11412     * This moves the cursor to the end of the current line.
11413     *
11414     * @param obj The entry object
11415     */
11416    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11417    /**
11418     * This begins a selection within the entry as though
11419     * the user were holding down the mouse button to make a selection.
11420     *
11421     * @param obj The entry object
11422     */
11423    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11424    /**
11425     * This ends a selection within the entry as though
11426     * the user had just released the mouse button while making a selection.
11427     *
11428     * @param obj The entry object
11429     */
11430    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11431    /**
11432     * Gets whether a format node exists at the current cursor position.
11433     *
11434     * A format node is anything that defines how the text is rendered. It can
11435     * be a visible format node, such as a line break or a paragraph separator,
11436     * or an invisible one, such as bold begin or end tag.
11437     * This function returns whether any format node exists at the current
11438     * cursor position.
11439     *
11440     * @param obj The entry object
11441     * @return EINA_TRUE if the current cursor position contains a format node,
11442     * EINA_FALSE otherwise.
11443     *
11444     * @see elm_entry_cursor_is_visible_format_get()
11445     */
11446    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11447    /**
11448     * Gets if the current cursor position holds a visible format node.
11449     *
11450     * @param obj The entry object
11451     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11452     * if it's an invisible one or no format exists.
11453     *
11454     * @see elm_entry_cursor_is_format_get()
11455     */
11456    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11457    /**
11458     * Gets the character pointed by the cursor at its current position.
11459     *
11460     * This function returns a string with the utf8 character stored at the
11461     * current cursor position.
11462     * Only the text is returned, any format that may exist will not be part
11463     * of the return value.
11464     *
11465     * @param obj The entry object
11466     * @return The text pointed by the cursors.
11467     */
11468    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11469    /**
11470     * This function returns the geometry of the cursor.
11471     *
11472     * It's useful if you want to draw something on the cursor (or where it is),
11473     * or for example in the case of scrolled entry where you want to show the
11474     * cursor.
11475     *
11476     * @param obj The entry object
11477     * @param x returned geometry
11478     * @param y returned geometry
11479     * @param w returned geometry
11480     * @param h returned geometry
11481     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11482     */
11483    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);
11484    /**
11485     * Sets the cursor position in the entry to the given value
11486     *
11487     * The value in @p pos is the index of the character position within the
11488     * contents of the string as returned by elm_entry_cursor_pos_get().
11489     *
11490     * @param obj The entry object
11491     * @param pos The position of the cursor
11492     */
11493    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11494    /**
11495     * Retrieves the current position of the cursor in the entry
11496     *
11497     * @param obj The entry object
11498     * @return The cursor position
11499     */
11500    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11501    /**
11502     * This executes a "cut" action on the selected text in the entry.
11503     *
11504     * @param obj The entry object
11505     */
11506    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11507    /**
11508     * This executes a "copy" action on the selected text in the entry.
11509     *
11510     * @param obj The entry object
11511     */
11512    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11513    /**
11514     * This executes a "paste" action in the entry.
11515     *
11516     * @param obj The entry object
11517     */
11518    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11519    /**
11520     * This clears and frees the items in a entry's contextual (longpress)
11521     * menu.
11522     *
11523     * @param obj The entry object
11524     *
11525     * @see elm_entry_context_menu_item_add()
11526     */
11527    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11528    /**
11529     * This adds an item to the entry's contextual menu.
11530     *
11531     * A longpress on an entry will make the contextual menu show up, if this
11532     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11533     * By default, this menu provides a few options like enabling selection mode,
11534     * which is useful on embedded devices that need to be explicit about it,
11535     * and when a selection exists it also shows the copy and cut actions.
11536     *
11537     * With this function, developers can add other options to this menu to
11538     * perform any action they deem necessary.
11539     *
11540     * @param obj The entry object
11541     * @param label The item's text label
11542     * @param icon_file The item's icon file
11543     * @param icon_type The item's icon type
11544     * @param func The callback to execute when the item is clicked
11545     * @param data The data to associate with the item for related functions
11546     */
11547    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);
11548    /**
11549     * This disables the entry's contextual (longpress) menu.
11550     *
11551     * @param obj The entry object
11552     * @param disabled If true, the menu is disabled
11553     */
11554    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11555    /**
11556     * This returns whether the entry's contextual (longpress) menu is
11557     * disabled.
11558     *
11559     * @param obj The entry object
11560     * @return If true, the menu is disabled
11561     */
11562    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11563    /**
11564     * This appends a custom item provider to the list for that entry
11565     *
11566     * This appends the given callback. The list is walked from beginning to end
11567     * with each function called given the item href string in the text. If the
11568     * function returns an object handle other than NULL (it should create an
11569     * object to do this), then this object is used to replace that item. If
11570     * not the next provider is called until one provides an item object, or the
11571     * default provider in entry does.
11572     *
11573     * @param obj The entry object
11574     * @param func The function called to provide the item object
11575     * @param data The data passed to @p func
11576     *
11577     * @see @ref entry-items
11578     */
11579    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);
11580    /**
11581     * This prepends a custom item provider to the list for that entry
11582     *
11583     * This prepends the given callback. See elm_entry_item_provider_append() for
11584     * more information
11585     *
11586     * @param obj The entry object
11587     * @param func The function called to provide the item object
11588     * @param data The data passed to @p func
11589     */
11590    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);
11591    /**
11592     * This removes a custom item provider to the list for that entry
11593     *
11594     * This removes the given callback. See elm_entry_item_provider_append() for
11595     * more information
11596     *
11597     * @param obj The entry object
11598     * @param func The function called to provide the item object
11599     * @param data The data passed to @p func
11600     */
11601    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);
11602    /**
11603     * Append a filter function for text inserted in the entry
11604     *
11605     * Append the given callback to the list. This functions will be called
11606     * whenever any text is inserted into the entry, with the text to be inserted
11607     * as a parameter. The callback function is free to alter the text in any way
11608     * it wants, but it must remember to free the given pointer and update it.
11609     * If the new text is to be discarded, the function can free it and set its
11610     * text parameter to NULL. This will also prevent any following filters from
11611     * being called.
11612     *
11613     * @param obj The entry object
11614     * @param func The function to use as text filter
11615     * @param data User data to pass to @p func
11616     */
11617    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11618    /**
11619     * Prepend a filter function for text insdrted in the entry
11620     *
11621     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11622     * for more information
11623     *
11624     * @param obj The entry object
11625     * @param func The function to use as text filter
11626     * @param data User data to pass to @p func
11627     */
11628    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11629    /**
11630     * Remove a filter from the list
11631     *
11632     * Removes the given callback from the filter list. See
11633     * elm_entry_text_filter_append() for more information.
11634     *
11635     * @param obj The entry object
11636     * @param func The filter function to remove
11637     * @param data The user data passed when adding the function
11638     */
11639    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11640    /**
11641     * This converts a markup (HTML-like) string into UTF-8.
11642     *
11643     * The returned string is a malloc'ed buffer and it should be freed when
11644     * not needed anymore.
11645     *
11646     * @param s The string (in markup) to be converted
11647     * @return The converted string (in UTF-8). It should be freed.
11648     */
11649    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11650    /**
11651     * This converts a UTF-8 string into markup (HTML-like).
11652     *
11653     * The returned string is a malloc'ed buffer and it should be freed when
11654     * not needed anymore.
11655     *
11656     * @param s The string (in UTF-8) to be converted
11657     * @return The converted string (in markup). It should be freed.
11658     */
11659    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11660    /**
11661     * This sets the file (and implicitly loads it) for the text to display and
11662     * then edit. All changes are written back to the file after a short delay if
11663     * the entry object is set to autosave (which is the default).
11664     *
11665     * If the entry had any other file set previously, any changes made to it
11666     * will be saved if the autosave feature is enabled, otherwise, the file
11667     * will be silently discarded and any non-saved changes will be lost.
11668     *
11669     * @param obj The entry object
11670     * @param file The path to the file to load and save
11671     * @param format The file format
11672     */
11673    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11674    /**
11675     * Gets the file being edited by the entry.
11676     *
11677     * This function can be used to retrieve any file set on the entry for
11678     * edition, along with the format used to load and save it.
11679     *
11680     * @param obj The entry object
11681     * @param file The path to the file to load and save
11682     * @param format The file format
11683     */
11684    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11685    /**
11686     * This function writes any changes made to the file set with
11687     * elm_entry_file_set()
11688     *
11689     * @param obj The entry object
11690     */
11691    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11692    /**
11693     * This sets the entry object to 'autosave' the loaded text file or not.
11694     *
11695     * @param obj The entry object
11696     * @param autosave Autosave the loaded file or not
11697     *
11698     * @see elm_entry_file_set()
11699     */
11700    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11701    /**
11702     * This gets the entry object's 'autosave' status.
11703     *
11704     * @param obj The entry object
11705     * @return Autosave the loaded file or not
11706     *
11707     * @see elm_entry_file_set()
11708     */
11709    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11710
11711    /**
11712     * @enum _Elm_CNP_Mode
11713     * @typedef Elm_CNP_Mode
11714     * Enum of entry's copy & paste policy.
11715     *
11716     * @see elm_entry_cnp_mode_set()
11717     * @see elm_entry_cnp_mode_get()
11718     */
11719    typedef enum _Elm_CNP_Mode {
11720       ELM_CNP_MODE_MARKUP = 0,       /**< copy & paste text with markup tag */
11721       ELM_CNP_MODE_NO_IMAGE = 1,     /**< copy & paste text without item(image) tag */
11722       ELM_CNP_MODE_PLAINTEXT = 2     /**< copy & paste text without markup tag */
11723    } Elm_CNP_Mode;
11724
11725    /**
11726     * Control pasting of text and images for the widget.
11727     *
11728     * Normally the entry allows both text and images to be pasted.
11729     * By setting textonly to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
11730     * By setting textonly to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
11731     *
11732     * @note this only changes the behaviour of text.
11733     *
11734     * @param obj The entry object
11735     * @param mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
11736     * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
11737     */
11738    EAPI void         elm_entry_cnp_mode_set(Evas_Object *obj, Elm_CNP_Mode cnp_mode) EINA_ARG_NONNULL(1);
11739    /**
11740     * Getting elm_entry text paste/drop mode.
11741     *
11742     * Normally the entry allows both text and images to be pasted.
11743     * This gets the copy & paste mode of the entry.
11744     *
11745     * @param obj The entry object
11746     * @return mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
11747     * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
11748     */
11749    EAPI Elm_CNP_Mode elm_entry_cnp_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11750
11751    /**
11752     * Control pasting of text and images for the widget.
11753     *
11754     * Normally the entry allows both text and images to be pasted.  By setting
11755     * textonly to be true, this prevents images from being pasted.
11756     *
11757     * Note this only changes the behaviour of text.
11758     *
11759     * @param obj The entry object
11760     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11761     * text+image+other.
11762     */
11763    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11764    /**
11765     * Getting elm_entry text paste/drop mode.
11766     *
11767     * In textonly mode, only text may be pasted or dropped into the widget.
11768     *
11769     * @param obj The entry object
11770     * @return If the widget only accepts text from pastes.
11771     */
11772    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11773    /**
11774     * Enable or disable scrolling in entry
11775     *
11776     * Normally the entry is not scrollable unless you enable it with this call.
11777     *
11778     * @param obj The entry object
11779     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11780     */
11781    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11782    /**
11783     * Get the scrollable state of the entry
11784     *
11785     * Normally the entry is not scrollable. This gets the scrollable state
11786     * of the entry. See elm_entry_scrollable_set() for more information.
11787     *
11788     * @param obj The entry object
11789     * @return The scrollable state
11790     */
11791    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11792    /**
11793     * This sets a widget to be displayed to the left of a scrolled entry.
11794     *
11795     * @param obj The scrolled entry object
11796     * @param icon The widget to display on the left side of the scrolled
11797     * entry.
11798     *
11799     * @note A previously set widget will be destroyed.
11800     * @note If the object being set does not have minimum size hints set,
11801     * it won't get properly displayed.
11802     *
11803     * @see elm_entry_end_set()
11804     */
11805    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11806    /**
11807     * Gets the leftmost widget of the scrolled entry. This object is
11808     * owned by the scrolled entry and should not be modified.
11809     *
11810     * @param obj The scrolled entry object
11811     * @return the left widget inside the scroller
11812     */
11813    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11814    /**
11815     * Unset the leftmost widget of the scrolled entry, unparenting and
11816     * returning it.
11817     *
11818     * @param obj The scrolled entry object
11819     * @return the previously set icon sub-object of this entry, on
11820     * success.
11821     *
11822     * @see elm_entry_icon_set()
11823     */
11824    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11825    /**
11826     * Sets the visibility of the left-side widget of the scrolled entry,
11827     * set by elm_entry_icon_set().
11828     *
11829     * @param obj The scrolled entry object
11830     * @param setting EINA_TRUE if the object should be displayed,
11831     * EINA_FALSE if not.
11832     */
11833    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11834    /**
11835     * This sets a widget to be displayed to the end of a scrolled entry.
11836     *
11837     * @param obj The scrolled entry object
11838     * @param end The widget to display on the right side of the scrolled
11839     * entry.
11840     *
11841     * @note A previously set widget will be destroyed.
11842     * @note If the object being set does not have minimum size hints set,
11843     * it won't get properly displayed.
11844     *
11845     * @see elm_entry_icon_set
11846     */
11847    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11848    /**
11849     * Gets the endmost widget of the scrolled entry. This object is owned
11850     * by the scrolled entry and should not be modified.
11851     *
11852     * @param obj The scrolled entry object
11853     * @return the right widget inside the scroller
11854     */
11855    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11856    /**
11857     * Unset the endmost widget of the scrolled entry, unparenting and
11858     * returning it.
11859     *
11860     * @param obj The scrolled entry object
11861     * @return the previously set icon sub-object of this entry, on
11862     * success.
11863     *
11864     * @see elm_entry_icon_set()
11865     */
11866    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11867    /**
11868     * Sets the visibility of the end widget of the scrolled entry, set by
11869     * elm_entry_end_set().
11870     *
11871     * @param obj The scrolled entry object
11872     * @param setting EINA_TRUE if the object should be displayed,
11873     * EINA_FALSE if not.
11874     */
11875    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11876    /**
11877     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11878     * them).
11879     *
11880     * Setting an entry to single-line mode with elm_entry_single_line_set()
11881     * will automatically disable the display of scrollbars when the entry
11882     * moves inside its scroller.
11883     *
11884     * @param obj The scrolled entry object
11885     * @param h The horizontal scrollbar policy to apply
11886     * @param v The vertical scrollbar policy to apply
11887     */
11888    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11889    /**
11890     * This enables/disables bouncing within the entry.
11891     *
11892     * This function sets whether the entry will bounce when scrolling reaches
11893     * the end of the contained entry.
11894     *
11895     * @param obj The scrolled entry object
11896     * @param h The horizontal bounce state
11897     * @param v The vertical bounce state
11898     */
11899    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11900    /**
11901     * Get the bounce mode
11902     *
11903     * @param obj The Entry object
11904     * @param h_bounce Allow bounce horizontally
11905     * @param v_bounce Allow bounce vertically
11906     */
11907    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11908
11909    /* pre-made filters for entries */
11910    /**
11911     * @typedef Elm_Entry_Filter_Limit_Size
11912     *
11913     * Data for the elm_entry_filter_limit_size() entry filter.
11914     */
11915    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11916    /**
11917     * @struct _Elm_Entry_Filter_Limit_Size
11918     *
11919     * Data for the elm_entry_filter_limit_size() entry filter.
11920     */
11921    struct _Elm_Entry_Filter_Limit_Size
11922      {
11923         int max_char_count; /**< The maximum number of characters allowed. */
11924         int max_byte_count; /**< The maximum number of bytes allowed*/
11925      };
11926    /**
11927     * Filter inserted text based on user defined character and byte limits
11928     *
11929     * Add this filter to an entry to limit the characters that it will accept
11930     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11931     * The funtion works on the UTF-8 representation of the string, converting
11932     * it from the set markup, thus not accounting for any format in it.
11933     *
11934     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11935     * it as data when setting the filter. In it, it's possible to set limits
11936     * by character count or bytes (any of them is disabled if 0), and both can
11937     * be set at the same time. In that case, it first checks for characters,
11938     * then bytes.
11939     *
11940     * The function will cut the inserted text in order to allow only the first
11941     * number of characters that are still allowed. The cut is made in
11942     * characters, even when limiting by bytes, in order to always contain
11943     * valid ones and avoid half unicode characters making it in.
11944     *
11945     * This filter, like any others, does not apply when setting the entry text
11946     * directly with elm_object_text_set() (or the deprecated
11947     * elm_entry_entry_set()).
11948     */
11949    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11950    /**
11951     * @typedef Elm_Entry_Filter_Accept_Set
11952     *
11953     * Data for the elm_entry_filter_accept_set() entry filter.
11954     */
11955    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11956    /**
11957     * @struct _Elm_Entry_Filter_Accept_Set
11958     *
11959     * Data for the elm_entry_filter_accept_set() entry filter.
11960     */
11961    struct _Elm_Entry_Filter_Accept_Set
11962      {
11963         const char *accepted; /**< Set of characters accepted in the entry. */
11964         const char *rejected; /**< Set of characters rejected from the entry. */
11965      };
11966    /**
11967     * Filter inserted text based on accepted or rejected sets of characters
11968     *
11969     * Add this filter to an entry to restrict the set of accepted characters
11970     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11971     * This structure contains both accepted and rejected sets, but they are
11972     * mutually exclusive.
11973     *
11974     * The @c accepted set takes preference, so if it is set, the filter will
11975     * only work based on the accepted characters, ignoring anything in the
11976     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11977     *
11978     * In both cases, the function filters by matching utf8 characters to the
11979     * raw markup text, so it can be used to remove formatting tags.
11980     *
11981     * This filter, like any others, does not apply when setting the entry text
11982     * directly with elm_object_text_set() (or the deprecated
11983     * elm_entry_entry_set()).
11984     */
11985    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11986    /**
11987     * Set the input panel layout of the entry
11988     *
11989     * @param obj The entry object
11990     * @param layout layout type
11991     */
11992    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11993    /**
11994     * Get the input panel layout of the entry
11995     *
11996     * @param obj The entry object
11997     * @return layout type
11998     *
11999     * @see elm_entry_input_panel_layout_set
12000     */
12001    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12002    /**
12003     * Set the autocapitalization type on the immodule.
12004     *
12005     * @param obj The entry object
12006     * @param autocapital_type The type of autocapitalization
12007     */
12008    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12009    /**
12010     * Retrieve the autocapitalization type on the immodule.
12011     *
12012     * @param obj The entry object
12013     * @return autocapitalization type
12014     */
12015    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12016    /**
12017     * Sets the attribute to show the input panel automatically.
12018     *
12019     * @param obj The entry object
12020     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12021     */
12022    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12023    /**
12024     * Retrieve the attribute to show the input panel automatically.
12025     *
12026     * @param obj The entry object
12027     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12028     */
12029    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12030
12031    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
12032    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
12033    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
12034    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
12035    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
12036    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
12037    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
12038
12039    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
12040    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
12041    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
12042    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
12043    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
12044
12045    /**
12046     * @}
12047     */
12048
12049    /* composite widgets - these basically put together basic widgets above
12050     * in convenient packages that do more than basic stuff */
12051
12052    /* anchorview */
12053    /**
12054     * @defgroup Anchorview Anchorview
12055     *
12056     * @image html img/widget/anchorview/preview-00.png
12057     * @image latex img/widget/anchorview/preview-00.eps
12058     *
12059     * Anchorview is for displaying text that contains markup with anchors
12060     * like <c>\<a href=1234\>something\</\></c> in it.
12061     *
12062     * Besides being styled differently, the anchorview widget provides the
12063     * necessary functionality so that clicking on these anchors brings up a
12064     * popup with user defined content such as "call", "add to contacts" or
12065     * "open web page". This popup is provided using the @ref Hover widget.
12066     *
12067     * This widget is very similar to @ref Anchorblock, so refer to that
12068     * widget for an example. The only difference Anchorview has is that the
12069     * widget is already provided with scrolling functionality, so if the
12070     * text set to it is too large to fit in the given space, it will scroll,
12071     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12072     * text can be displayed.
12073     *
12074     * This widget emits the following signals:
12075     * @li "anchor,clicked": will be called when an anchor is clicked. The
12076     * @p event_info parameter on the callback will be a pointer of type
12077     * ::Elm_Entry_Anchorview_Info.
12078     *
12079     * See @ref Anchorblock for an example on how to use both of them.
12080     *
12081     * @see Anchorblock
12082     * @see Entry
12083     * @see Hover
12084     *
12085     * @{
12086     */
12087    /**
12088     * @typedef Elm_Entry_Anchorview_Info
12089     *
12090     * The info sent in the callback for "anchor,clicked" signals emitted by
12091     * the Anchorview widget.
12092     */
12093    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12094    /**
12095     * @struct _Elm_Entry_Anchorview_Info
12096     *
12097     * The info sent in the callback for "anchor,clicked" signals emitted by
12098     * the Anchorview widget.
12099     */
12100    struct _Elm_Entry_Anchorview_Info
12101      {
12102         const char     *name; /**< Name of the anchor, as indicated in its href
12103                                    attribute */
12104         int             button; /**< The mouse button used to click on it */
12105         Evas_Object    *hover; /**< The hover object to use for the popup */
12106         struct {
12107              Evas_Coord    x, y, w, h;
12108         } anchor, /**< Geometry selection of text used as anchor */
12109           hover_parent; /**< Geometry of the object used as parent by the
12110                              hover */
12111         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12112                                              for content on the left side of
12113                                              the hover. Before calling the
12114                                              callback, the widget will make the
12115                                              necessary calculations to check
12116                                              which sides are fit to be set with
12117                                              content, based on the position the
12118                                              hover is activated and its distance
12119                                              to the edges of its parent object
12120                                              */
12121         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12122                                               the right side of the hover.
12123                                               See @ref hover_left */
12124         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12125                                             of the hover. See @ref hover_left */
12126         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12127                                                below the hover. See @ref
12128                                                hover_left */
12129      };
12130    /**
12131     * Add a new Anchorview object
12132     *
12133     * @param parent The parent object
12134     * @return The new object or NULL if it cannot be created
12135     */
12136    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12137    /**
12138     * Set the text to show in the anchorview
12139     *
12140     * Sets the text of the anchorview to @p text. This text can include markup
12141     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12142     * text that will be specially styled and react to click events, ended with
12143     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12144     * "anchor,clicked" signal that you can attach a callback to with
12145     * evas_object_smart_callback_add(). The name of the anchor given in the
12146     * event info struct will be the one set in the href attribute, in this
12147     * case, anchorname.
12148     *
12149     * Other markup can be used to style the text in different ways, but it's
12150     * up to the style defined in the theme which tags do what.
12151     * @deprecated use elm_object_text_set() instead.
12152     */
12153    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12154    /**
12155     * Get the markup text set for the anchorview
12156     *
12157     * Retrieves the text set on the anchorview, with markup tags included.
12158     *
12159     * @param obj The anchorview object
12160     * @return The markup text set or @c NULL if nothing was set or an error
12161     * occurred
12162     * @deprecated use elm_object_text_set() instead.
12163     */
12164    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12165    /**
12166     * Set the parent of the hover popup
12167     *
12168     * Sets the parent object to use by the hover created by the anchorview
12169     * when an anchor is clicked. See @ref Hover for more details on this.
12170     * If no parent is set, the same anchorview object will be used.
12171     *
12172     * @param obj The anchorview object
12173     * @param parent The object to use as parent for the hover
12174     */
12175    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12176    /**
12177     * Get the parent of the hover popup
12178     *
12179     * Get the object used as parent for the hover created by the anchorview
12180     * widget. See @ref Hover for more details on this.
12181     *
12182     * @param obj The anchorview object
12183     * @return The object used as parent for the hover, NULL if none is set.
12184     */
12185    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12186    /**
12187     * Set the style that the hover should use
12188     *
12189     * When creating the popup hover, anchorview will request that it's
12190     * themed according to @p style.
12191     *
12192     * @param obj The anchorview object
12193     * @param style The style to use for the underlying hover
12194     *
12195     * @see elm_object_style_set()
12196     */
12197    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12198    /**
12199     * Get the style that the hover should use
12200     *
12201     * Get the style the hover created by anchorview will use.
12202     *
12203     * @param obj The anchorview object
12204     * @return The style to use by the hover. NULL means the default is used.
12205     *
12206     * @see elm_object_style_set()
12207     */
12208    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12209    /**
12210     * Ends the hover popup in the anchorview
12211     *
12212     * When an anchor is clicked, the anchorview widget will create a hover
12213     * object to use as a popup with user provided content. This function
12214     * terminates this popup, returning the anchorview to its normal state.
12215     *
12216     * @param obj The anchorview object
12217     */
12218    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12219    /**
12220     * Set bouncing behaviour when the scrolled content reaches an edge
12221     *
12222     * Tell the internal scroller object whether it should bounce or not
12223     * when it reaches the respective edges for each axis.
12224     *
12225     * @param obj The anchorview object
12226     * @param h_bounce Whether to bounce or not in the horizontal axis
12227     * @param v_bounce Whether to bounce or not in the vertical axis
12228     *
12229     * @see elm_scroller_bounce_set()
12230     */
12231    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12232    /**
12233     * Get the set bouncing behaviour of the internal scroller
12234     *
12235     * Get whether the internal scroller should bounce when the edge of each
12236     * axis is reached scrolling.
12237     *
12238     * @param obj The anchorview object
12239     * @param h_bounce Pointer where to store the bounce state of the horizontal
12240     *                 axis
12241     * @param v_bounce Pointer where to store the bounce state of the vertical
12242     *                 axis
12243     *
12244     * @see elm_scroller_bounce_get()
12245     */
12246    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12247    /**
12248     * Appends a custom item provider to the given anchorview
12249     *
12250     * Appends the given function to the list of items providers. This list is
12251     * called, one function at a time, with the given @p data pointer, the
12252     * anchorview object and, in the @p item parameter, the item name as
12253     * referenced in its href string. Following functions in the list will be
12254     * called in order until one of them returns something different to NULL,
12255     * which should be an Evas_Object which will be used in place of the item
12256     * element.
12257     *
12258     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12259     * href=item/name\>\</item\>
12260     *
12261     * @param obj The anchorview object
12262     * @param func The function to add to the list of providers
12263     * @param data User data that will be passed to the callback function
12264     *
12265     * @see elm_entry_item_provider_append()
12266     */
12267    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);
12268    /**
12269     * Prepend a custom item provider to the given anchorview
12270     *
12271     * Like elm_anchorview_item_provider_append(), but it adds the function
12272     * @p func to the beginning of the list, instead of the end.
12273     *
12274     * @param obj The anchorview object
12275     * @param func The function to add to the list of providers
12276     * @param data User data that will be passed to the callback function
12277     */
12278    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);
12279    /**
12280     * Remove a custom item provider from the list of the given anchorview
12281     *
12282     * Removes the function and data pairing that matches @p func and @p data.
12283     * That is, unless the same function and same user data are given, the
12284     * function will not be removed from the list. This allows us to add the
12285     * same callback several times, with different @p data pointers and be
12286     * able to remove them later without conflicts.
12287     *
12288     * @param obj The anchorview object
12289     * @param func The function to remove from the list
12290     * @param data The data matching the function to remove from the list
12291     */
12292    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);
12293    /**
12294     * @}
12295     */
12296
12297    /* anchorblock */
12298    /**
12299     * @defgroup Anchorblock Anchorblock
12300     *
12301     * @image html img/widget/anchorblock/preview-00.png
12302     * @image latex img/widget/anchorblock/preview-00.eps
12303     *
12304     * Anchorblock is for displaying text that contains markup with anchors
12305     * like <c>\<a href=1234\>something\</\></c> in it.
12306     *
12307     * Besides being styled differently, the anchorblock widget provides the
12308     * necessary functionality so that clicking on these anchors brings up a
12309     * popup with user defined content such as "call", "add to contacts" or
12310     * "open web page". This popup is provided using the @ref Hover widget.
12311     *
12312     * This widget emits the following signals:
12313     * @li "anchor,clicked": will be called when an anchor is clicked. The
12314     * @p event_info parameter on the callback will be a pointer of type
12315     * ::Elm_Entry_Anchorblock_Info.
12316     *
12317     * @see Anchorview
12318     * @see Entry
12319     * @see Hover
12320     *
12321     * Since examples are usually better than plain words, we might as well
12322     * try @ref tutorial_anchorblock_example "one".
12323     */
12324    /**
12325     * @addtogroup Anchorblock
12326     * @{
12327     */
12328    /**
12329     * @typedef Elm_Entry_Anchorblock_Info
12330     *
12331     * The info sent in the callback for "anchor,clicked" signals emitted by
12332     * the Anchorblock widget.
12333     */
12334    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12335    /**
12336     * @struct _Elm_Entry_Anchorblock_Info
12337     *
12338     * The info sent in the callback for "anchor,clicked" signals emitted by
12339     * the Anchorblock widget.
12340     */
12341    struct _Elm_Entry_Anchorblock_Info
12342      {
12343         const char     *name; /**< Name of the anchor, as indicated in its href
12344                                    attribute */
12345         int             button; /**< The mouse button used to click on it */
12346         Evas_Object    *hover; /**< The hover object to use for the popup */
12347         struct {
12348              Evas_Coord    x, y, w, h;
12349         } anchor, /**< Geometry selection of text used as anchor */
12350           hover_parent; /**< Geometry of the object used as parent by the
12351                              hover */
12352         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12353                                              for content on the left side of
12354                                              the hover. Before calling the
12355                                              callback, the widget will make the
12356                                              necessary calculations to check
12357                                              which sides are fit to be set with
12358                                              content, based on the position the
12359                                              hover is activated and its distance
12360                                              to the edges of its parent object
12361                                              */
12362         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12363                                               the right side of the hover.
12364                                               See @ref hover_left */
12365         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12366                                             of the hover. See @ref hover_left */
12367         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12368                                                below the hover. See @ref
12369                                                hover_left */
12370      };
12371    /**
12372     * Add a new Anchorblock object
12373     *
12374     * @param parent The parent object
12375     * @return The new object or NULL if it cannot be created
12376     */
12377    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12378    /**
12379     * Set the text to show in the anchorblock
12380     *
12381     * Sets the text of the anchorblock to @p text. This text can include markup
12382     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12383     * of text that will be specially styled and react to click events, ended
12384     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12385     * "anchor,clicked" signal that you can attach a callback to with
12386     * evas_object_smart_callback_add(). The name of the anchor given in the
12387     * event info struct will be the one set in the href attribute, in this
12388     * case, anchorname.
12389     *
12390     * Other markup can be used to style the text in different ways, but it's
12391     * up to the style defined in the theme which tags do what.
12392     * @deprecated use elm_object_text_set() instead.
12393     */
12394    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12395    /**
12396     * Get the markup text set for the anchorblock
12397     *
12398     * Retrieves the text set on the anchorblock, with markup tags included.
12399     *
12400     * @param obj The anchorblock object
12401     * @return The markup text set or @c NULL if nothing was set or an error
12402     * occurred
12403     * @deprecated use elm_object_text_set() instead.
12404     */
12405    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12406    /**
12407     * Set the parent of the hover popup
12408     *
12409     * Sets the parent object to use by the hover created by the anchorblock
12410     * when an anchor is clicked. See @ref Hover for more details on this.
12411     *
12412     * @param obj The anchorblock object
12413     * @param parent The object to use as parent for the hover
12414     */
12415    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12416    /**
12417     * Get the parent of the hover popup
12418     *
12419     * Get the object used as parent for the hover created by the anchorblock
12420     * widget. See @ref Hover for more details on this.
12421     * If no parent is set, the same anchorblock object will be used.
12422     *
12423     * @param obj The anchorblock object
12424     * @return The object used as parent for the hover, NULL if none is set.
12425     */
12426    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12427    /**
12428     * Set the style that the hover should use
12429     *
12430     * When creating the popup hover, anchorblock will request that it's
12431     * themed according to @p style.
12432     *
12433     * @param obj The anchorblock object
12434     * @param style The style to use for the underlying hover
12435     *
12436     * @see elm_object_style_set()
12437     */
12438    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12439    /**
12440     * Get the style that the hover should use
12441     *
12442     * Get the style, the hover created by anchorblock will use.
12443     *
12444     * @param obj The anchorblock object
12445     * @return The style to use by the hover. NULL means the default is used.
12446     *
12447     * @see elm_object_style_set()
12448     */
12449    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12450    /**
12451     * Ends the hover popup in the anchorblock
12452     *
12453     * When an anchor is clicked, the anchorblock widget will create a hover
12454     * object to use as a popup with user provided content. This function
12455     * terminates this popup, returning the anchorblock to its normal state.
12456     *
12457     * @param obj The anchorblock object
12458     */
12459    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12460    /**
12461     * Appends a custom item provider to the given anchorblock
12462     *
12463     * Appends the given function to the list of items providers. This list is
12464     * called, one function at a time, with the given @p data pointer, the
12465     * anchorblock object and, in the @p item parameter, the item name as
12466     * referenced in its href string. Following functions in the list will be
12467     * called in order until one of them returns something different to NULL,
12468     * which should be an Evas_Object which will be used in place of the item
12469     * element.
12470     *
12471     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12472     * href=item/name\>\</item\>
12473     *
12474     * @param obj The anchorblock object
12475     * @param func The function to add to the list of providers
12476     * @param data User data that will be passed to the callback function
12477     *
12478     * @see elm_entry_item_provider_append()
12479     */
12480    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);
12481    /**
12482     * Prepend a custom item provider to the given anchorblock
12483     *
12484     * Like elm_anchorblock_item_provider_append(), but it adds the function
12485     * @p func to the beginning of the list, instead of the end.
12486     *
12487     * @param obj The anchorblock object
12488     * @param func The function to add to the list of providers
12489     * @param data User data that will be passed to the callback function
12490     */
12491    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);
12492    /**
12493     * Remove a custom item provider from the list of the given anchorblock
12494     *
12495     * Removes the function and data pairing that matches @p func and @p data.
12496     * That is, unless the same function and same user data are given, the
12497     * function will not be removed from the list. This allows us to add the
12498     * same callback several times, with different @p data pointers and be
12499     * able to remove them later without conflicts.
12500     *
12501     * @param obj The anchorblock object
12502     * @param func The function to remove from the list
12503     * @param data The data matching the function to remove from the list
12504     */
12505    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);
12506    /**
12507     * @}
12508     */
12509
12510    /**
12511     * @defgroup Bubble Bubble
12512     *
12513     * @image html img/widget/bubble/preview-00.png
12514     * @image latex img/widget/bubble/preview-00.eps
12515     * @image html img/widget/bubble/preview-01.png
12516     * @image latex img/widget/bubble/preview-01.eps
12517     * @image html img/widget/bubble/preview-02.png
12518     * @image latex img/widget/bubble/preview-02.eps
12519     *
12520     * @brief The Bubble is a widget to show text similar to how speech is
12521     * represented in comics.
12522     *
12523     * The bubble widget contains 5 important visual elements:
12524     * @li The frame is a rectangle with rounded edjes and an "arrow".
12525     * @li The @p icon is an image to which the frame's arrow points to.
12526     * @li The @p label is a text which appears to the right of the icon if the
12527     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12528     * otherwise.
12529     * @li The @p info is a text which appears to the right of the label. Info's
12530     * font is of a ligther color than label.
12531     * @li The @p content is an evas object that is shown inside the frame.
12532     *
12533     * The position of the arrow, icon, label and info depends on which corner is
12534     * selected. The four available corners are:
12535     * @li "top_left" - Default
12536     * @li "top_right"
12537     * @li "bottom_left"
12538     * @li "bottom_right"
12539     *
12540     * Signals that you can add callbacks for are:
12541     * @li "clicked" - This is called when a user has clicked the bubble.
12542     *
12543     * Default contents parts of the bubble that you can use for are:
12544     * @li "default" - A content of the bubble
12545     * @li "icon" - An icon of the bubble
12546     *
12547     * Default text parts of the button widget that you can use for are:
12548     * @li NULL - Label of the bubble
12549     * 
12550          * For an example of using a buble see @ref bubble_01_example_page "this".
12551     *
12552     * @{
12553     */
12554
12555    /**
12556     * Add a new bubble to the parent
12557     *
12558     * @param parent The parent object
12559     * @return The new object or NULL if it cannot be created
12560     *
12561     * This function adds a text bubble to the given parent evas object.
12562     */
12563    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12564    /**
12565     * Set the label of the bubble
12566     *
12567     * @param obj The bubble object
12568     * @param label The string to set in the label
12569     *
12570     * This function sets the title of the bubble. Where this appears depends on
12571     * the selected corner.
12572     * @deprecated use elm_object_text_set() instead.
12573     */
12574    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12575    /**
12576     * Get the label of the bubble
12577     *
12578     * @param obj The bubble object
12579     * @return The string of set in the label
12580     *
12581     * This function gets the title of the bubble.
12582     * @deprecated use elm_object_text_get() instead.
12583     */
12584    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12585    /**
12586     * Set the info of the bubble
12587     *
12588     * @param obj The bubble object
12589     * @param info The given info about the bubble
12590     *
12591     * This function sets the info of the bubble. Where this appears depends on
12592     * the selected corner.
12593     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12594     */
12595    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12596    /**
12597     * Get the info of the bubble
12598     *
12599     * @param obj The bubble object
12600     *
12601     * @return The "info" string of the bubble
12602     *
12603     * This function gets the info text.
12604     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12605     */
12606    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12607    /**
12608     * Set the content to be shown in the bubble
12609     *
12610     * Once the content object is set, a previously set one will be deleted.
12611     * If you want to keep the old content object, use the
12612     * elm_bubble_content_unset() function.
12613     *
12614     * @param obj The bubble object
12615     * @param content The given content of the bubble
12616     *
12617     * This function sets the content shown on the middle of the bubble.
12618     * 
12619     * @deprecated use elm_object_content_set() instead
12620     *
12621     */
12622    WILL_DEPRECATE  EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12623    /**
12624     * Get the content shown in the bubble
12625     *
12626     * Return the content object which is set for this widget.
12627     *
12628     * @param obj The bubble object
12629     * @return The content that is being used
12630     *
12631     * @deprecated use elm_object_content_get() instead
12632     *
12633     */
12634    WILL_DEPRECATE  EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12635    /**
12636     * Unset the content shown in the bubble
12637     *
12638     * Unparent and return the content object which was set for this widget.
12639     *
12640     * @param obj The bubble object
12641     * @return The content that was being used
12642     *
12643     * @deprecated use elm_object_content_unset() instead
12644     *
12645     */
12646    WILL_DEPRECATE  EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12647    /**
12648     * Set the icon of the bubble
12649     *
12650     * Once the icon object is set, a previously set one will be deleted.
12651     * If you want to keep the old content object, use the
12652     * elm_icon_content_unset() function.
12653     *
12654     * @param obj The bubble object
12655     * @param icon The given icon for the bubble
12656     *
12657     * @deprecated use elm_object_part_content_set() instead
12658     *
12659     */
12660    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12661    /**
12662     * Get the icon of the bubble
12663     *
12664     * @param obj The bubble object
12665     * @return The icon for the bubble
12666     *
12667     * This function gets the icon shown on the top left of bubble.
12668     *
12669     * @deprecated use elm_object_part_content_get() instead
12670     *
12671     */
12672    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12673    /**
12674     * Unset the icon of the bubble
12675     *
12676     * Unparent and return the icon object which was set for this widget.
12677     *
12678     * @param obj The bubble object
12679     * @return The icon that was being used
12680     *
12681     * @deprecated use elm_object_part_content_unset() instead
12682     *
12683     */
12684    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12685    /**
12686     * Set the corner of the bubble
12687     *
12688     * @param obj The bubble object.
12689     * @param corner The given corner for the bubble.
12690     *
12691     * This function sets the corner of the bubble. The corner will be used to
12692     * determine where the arrow in the frame points to and where label, icon and
12693     * info are shown.
12694     *
12695     * Possible values for corner are:
12696     * @li "top_left" - Default
12697     * @li "top_right"
12698     * @li "bottom_left"
12699     * @li "bottom_right"
12700     */
12701    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12702    /**
12703     * Get the corner of the bubble
12704     *
12705     * @param obj The bubble object.
12706     * @return The given corner for the bubble.
12707     *
12708     * This function gets the selected corner of the bubble.
12709     */
12710    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12711
12712    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12713    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12714
12715    /**
12716     * @}
12717     */
12718
12719    /**
12720     * @defgroup Photo Photo
12721     *
12722     * For displaying the photo of a person (contact). Simple, yet
12723     * with a very specific purpose.
12724     *
12725     * Signals that you can add callbacks for are:
12726     *
12727     * "clicked" - This is called when a user has clicked the photo
12728     * "drag,start" - Someone started dragging the image out of the object
12729     * "drag,end" - Dragged item was dropped (somewhere)
12730     *
12731     * @{
12732     */
12733
12734    /**
12735     * Add a new photo to the parent
12736     *
12737     * @param parent The parent object
12738     * @return The new object or NULL if it cannot be created
12739     *
12740     * @ingroup Photo
12741     */
12742    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12743
12744    /**
12745     * Set the file that will be used as photo
12746     *
12747     * @param obj The photo object
12748     * @param file The path to file that will be used as photo
12749     *
12750     * @return (1 = success, 0 = error)
12751     *
12752     * @ingroup Photo
12753     */
12754    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12755
12756     /**
12757     * Set the file that will be used as thumbnail in the photo.
12758     *
12759     * @param obj The photo object.
12760     * @param file The path to file that will be used as thumb.
12761     * @param group The key used in case of an EET file.
12762     *
12763     * @ingroup Photo
12764     */
12765    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12766
12767    /**
12768     * Set the size that will be used on the photo
12769     *
12770     * @param obj The photo object
12771     * @param size The size that the photo will be
12772     *
12773     * @ingroup Photo
12774     */
12775    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12776
12777    /**
12778     * Set if the photo should be completely visible or not.
12779     *
12780     * @param obj The photo object
12781     * @param fill if true the photo will be completely visible
12782     *
12783     * @ingroup Photo
12784     */
12785    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12786
12787    /**
12788     * Set editability of the photo.
12789     *
12790     * An editable photo can be dragged to or from, and can be cut or
12791     * pasted too.  Note that pasting an image or dropping an item on
12792     * the image will delete the existing content.
12793     *
12794     * @param obj The photo object.
12795     * @param set To set of clear editablity.
12796     */
12797    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12798
12799    /**
12800     * @}
12801     */
12802
12803    /* gesture layer */
12804    /**
12805     * @defgroup Elm_Gesture_Layer Gesture Layer
12806     * Gesture Layer Usage:
12807     *
12808     * Use Gesture Layer to detect gestures.
12809     * The advantage is that you don't have to implement
12810     * gesture detection, just set callbacks of gesture state.
12811     * By using gesture layer we make standard interface.
12812     *
12813     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12814     * with a parent object parameter.
12815     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12816     * call. Usually with same object as target (2nd parameter).
12817     *
12818     * Now you need to tell gesture layer what gestures you follow.
12819     * This is done with @ref elm_gesture_layer_cb_set call.
12820     * By setting the callback you actually saying to gesture layer:
12821     * I would like to know when the gesture @ref Elm_Gesture_Types
12822     * switches to state @ref Elm_Gesture_State.
12823     *
12824     * Next, you need to implement the actual action that follows the input
12825     * in your callback.
12826     *
12827     * Note that if you like to stop being reported about a gesture, just set
12828     * all callbacks referring this gesture to NULL.
12829     * (again with @ref elm_gesture_layer_cb_set)
12830     *
12831     * The information reported by gesture layer to your callback is depending
12832     * on @ref Elm_Gesture_Types:
12833     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12834     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12835     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12836     *
12837     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12838     * @ref ELM_GESTURE_MOMENTUM.
12839     *
12840     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12841     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12842     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12843     * Note that we consider a flick as a line-gesture that should be completed
12844     * in flick-time-limit as defined in @ref Config.
12845     *
12846     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12847     *
12848     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12849     *
12850     *
12851     * Gesture Layer Tweaks:
12852     *
12853     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12854     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12855     *
12856     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12857     * so gesture starts when user touches (a *DOWN event) touch-surface
12858     * and ends when no fingers touches surface (a *UP event).
12859     */
12860
12861    /**
12862     * @enum _Elm_Gesture_Types
12863     * Enum of supported gesture types.
12864     * @ingroup Elm_Gesture_Layer
12865     */
12866    enum _Elm_Gesture_Types
12867      {
12868         ELM_GESTURE_FIRST = 0,
12869
12870         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12871         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12872         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12873         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12874
12875         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12876
12877         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12878         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12879
12880         ELM_GESTURE_ZOOM, /**< Zoom */
12881         ELM_GESTURE_ROTATE, /**< Rotate */
12882
12883         ELM_GESTURE_LAST
12884      };
12885
12886    /**
12887     * @typedef Elm_Gesture_Types
12888     * gesture types enum
12889     * @ingroup Elm_Gesture_Layer
12890     */
12891    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12892
12893    /**
12894     * @enum _Elm_Gesture_State
12895     * Enum of gesture states.
12896     * @ingroup Elm_Gesture_Layer
12897     */
12898    enum _Elm_Gesture_State
12899      {
12900         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12901         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12902         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12903         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12904         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12905      };
12906
12907    /**
12908     * @typedef Elm_Gesture_State
12909     * gesture states enum
12910     * @ingroup Elm_Gesture_Layer
12911     */
12912    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12913
12914    /**
12915     * @struct _Elm_Gesture_Taps_Info
12916     * Struct holds taps info for user
12917     * @ingroup Elm_Gesture_Layer
12918     */
12919    struct _Elm_Gesture_Taps_Info
12920      {
12921         Evas_Coord x, y;         /**< Holds center point between fingers */
12922         unsigned int n;          /**< Number of fingers tapped           */
12923         unsigned int timestamp;  /**< event timestamp       */
12924      };
12925
12926    /**
12927     * @typedef Elm_Gesture_Taps_Info
12928     * holds taps info for user
12929     * @ingroup Elm_Gesture_Layer
12930     */
12931    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12932
12933    /**
12934     * @struct _Elm_Gesture_Momentum_Info
12935     * Struct holds momentum info for user
12936     * x1 and y1 are not necessarily in sync
12937     * x1 holds x value of x direction starting point
12938     * and same holds for y1.
12939     * This is noticeable when doing V-shape movement
12940     * @ingroup Elm_Gesture_Layer
12941     */
12942    struct _Elm_Gesture_Momentum_Info
12943      {  /* Report line ends, timestamps, and momentum computed        */
12944         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12945         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12946         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12947         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12948
12949         unsigned int tx; /**< Timestamp of start of final x-swipe */
12950         unsigned int ty; /**< Timestamp of start of final y-swipe */
12951
12952         Evas_Coord mx; /**< Momentum on X */
12953         Evas_Coord my; /**< Momentum on Y */
12954
12955         unsigned int n;  /**< Number of fingers */
12956      };
12957
12958    /**
12959     * @typedef Elm_Gesture_Momentum_Info
12960     * holds momentum info for user
12961     * @ingroup Elm_Gesture_Layer
12962     */
12963     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12964
12965    /**
12966     * @struct _Elm_Gesture_Line_Info
12967     * Struct holds line info for user
12968     * @ingroup Elm_Gesture_Layer
12969     */
12970    struct _Elm_Gesture_Line_Info
12971      {  /* Report line ends, timestamps, and momentum computed      */
12972         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12973         double angle;              /**< Angle (direction) of lines  */
12974      };
12975
12976    /**
12977     * @typedef Elm_Gesture_Line_Info
12978     * Holds line info for user
12979     * @ingroup Elm_Gesture_Layer
12980     */
12981     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12982
12983    /**
12984     * @struct _Elm_Gesture_Zoom_Info
12985     * Struct holds zoom info for user
12986     * @ingroup Elm_Gesture_Layer
12987     */
12988    struct _Elm_Gesture_Zoom_Info
12989      {
12990         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12991         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12992         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12993         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12994      };
12995
12996    /**
12997     * @typedef Elm_Gesture_Zoom_Info
12998     * Holds zoom info for user
12999     * @ingroup Elm_Gesture_Layer
13000     */
13001    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13002
13003    /**
13004     * @struct _Elm_Gesture_Rotate_Info
13005     * Struct holds rotation info for user
13006     * @ingroup Elm_Gesture_Layer
13007     */
13008    struct _Elm_Gesture_Rotate_Info
13009      {
13010         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
13011         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13012         double base_angle; /**< Holds start-angle */
13013         double angle;      /**< Rotation value: 0.0 means no rotation         */
13014         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13015      };
13016
13017    /**
13018     * @typedef Elm_Gesture_Rotate_Info
13019     * Holds rotation info for user
13020     * @ingroup Elm_Gesture_Layer
13021     */
13022    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13023
13024    /**
13025     * @typedef Elm_Gesture_Event_Cb
13026     * User callback used to stream gesture info from gesture layer
13027     * @param data user data
13028     * @param event_info gesture report info
13029     * Returns a flag field to be applied on the causing event.
13030     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13031     * upon the event, in an irreversible way.
13032     *
13033     * @ingroup Elm_Gesture_Layer
13034     */
13035    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13036
13037    /**
13038     * Use function to set callbacks to be notified about
13039     * change of state of gesture.
13040     * When a user registers a callback with this function
13041     * this means this gesture has to be tested.
13042     *
13043     * When ALL callbacks for a gesture are set to NULL
13044     * it means user isn't interested in gesture-state
13045     * and it will not be tested.
13046     *
13047     * @param obj Pointer to gesture-layer.
13048     * @param idx The gesture you would like to track its state.
13049     * @param cb callback function pointer.
13050     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13051     * @param data user info to be sent to callback (usually, Smart Data)
13052     *
13053     * @ingroup Elm_Gesture_Layer
13054     */
13055    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);
13056
13057    /**
13058     * Call this function to get repeat-events settings.
13059     *
13060     * @param obj Pointer to gesture-layer.
13061     *
13062     * @return repeat events settings.
13063     * @see elm_gesture_layer_hold_events_set()
13064     * @ingroup Elm_Gesture_Layer
13065     */
13066    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13067
13068    /**
13069     * This function called in order to make gesture-layer repeat events.
13070     * Set this of you like to get the raw events only if gestures were not detected.
13071     * Clear this if you like gesture layer to fwd events as testing gestures.
13072     *
13073     * @param obj Pointer to gesture-layer.
13074     * @param r Repeat: TRUE/FALSE
13075     *
13076     * @ingroup Elm_Gesture_Layer
13077     */
13078    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13079
13080    /**
13081     * This function sets step-value for zoom action.
13082     * Set step to any positive value.
13083     * Cancel step setting by setting to 0.0
13084     *
13085     * @param obj Pointer to gesture-layer.
13086     * @param s new zoom step value.
13087     *
13088     * @ingroup Elm_Gesture_Layer
13089     */
13090    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13091
13092    /**
13093     * This function sets step-value for rotate action.
13094     * Set step to any positive value.
13095     * Cancel step setting by setting to 0.0
13096     *
13097     * @param obj Pointer to gesture-layer.
13098     * @param s new roatate step value.
13099     *
13100     * @ingroup Elm_Gesture_Layer
13101     */
13102    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13103
13104    /**
13105     * This function called to attach gesture-layer to an Evas_Object.
13106     * @param obj Pointer to gesture-layer.
13107     * @param t Pointer to underlying object (AKA Target)
13108     *
13109     * @return TRUE, FALSE on success, failure.
13110     *
13111     * @ingroup Elm_Gesture_Layer
13112     */
13113    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13114
13115    /**
13116     * Call this function to construct a new gesture-layer object.
13117     * This does not activate the gesture layer. You have to
13118     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13119     *
13120     * @param parent the parent object.
13121     *
13122     * @return Pointer to new gesture-layer object.
13123     *
13124     * @ingroup Elm_Gesture_Layer
13125     */
13126    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13127
13128    /**
13129     * @defgroup Thumb Thumb
13130     *
13131     * @image html img/widget/thumb/preview-00.png
13132     * @image latex img/widget/thumb/preview-00.eps
13133     *
13134     * A thumb object is used for displaying the thumbnail of an image or video.
13135     * You must have compiled Elementary with Ethumb_Client support and the DBus
13136     * service must be present and auto-activated in order to have thumbnails to
13137     * be generated.
13138     *
13139     * Once the thumbnail object becomes visible, it will check if there is a
13140     * previously generated thumbnail image for the file set on it. If not, it
13141     * will start generating this thumbnail.
13142     *
13143     * Different config settings will cause different thumbnails to be generated
13144     * even on the same file.
13145     *
13146     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13147     * Ethumb documentation to change this path, and to see other configuration
13148     * options.
13149     *
13150     * Signals that you can add callbacks for are:
13151     *
13152     * - "clicked" - This is called when a user has clicked the thumb without dragging
13153     *             around.
13154     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13155     * - "press" - This is called when a user has pressed down the thumb.
13156     * - "generate,start" - The thumbnail generation started.
13157     * - "generate,stop" - The generation process stopped.
13158     * - "generate,error" - The generation failed.
13159     * - "load,error" - The thumbnail image loading failed.
13160     *
13161     * available styles:
13162     * - default
13163     * - noframe
13164     *
13165     * An example of use of thumbnail:
13166     *
13167     * - @ref thumb_example_01
13168     */
13169
13170    /**
13171     * @addtogroup Thumb
13172     * @{
13173     */
13174
13175    /**
13176     * @enum _Elm_Thumb_Animation_Setting
13177     * @typedef Elm_Thumb_Animation_Setting
13178     *
13179     * Used to set if a video thumbnail is animating or not.
13180     *
13181     * @ingroup Thumb
13182     */
13183    typedef enum _Elm_Thumb_Animation_Setting
13184      {
13185         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13186         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13187         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13188         ELM_THUMB_ANIMATION_LAST
13189      } Elm_Thumb_Animation_Setting;
13190
13191    /**
13192     * Add a new thumb object to the parent.
13193     *
13194     * @param parent The parent object.
13195     * @return The new object or NULL if it cannot be created.
13196     *
13197     * @see elm_thumb_file_set()
13198     * @see elm_thumb_ethumb_client_get()
13199     *
13200     * @ingroup Thumb
13201     */
13202    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13203    /**
13204     * Reload thumbnail if it was generated before.
13205     *
13206     * @param obj The thumb object to reload
13207     *
13208     * This is useful if the ethumb client configuration changed, like its
13209     * size, aspect or any other property one set in the handle returned
13210     * by elm_thumb_ethumb_client_get().
13211     *
13212     * If the options didn't change, the thumbnail won't be generated again, but
13213     * the old one will still be used.
13214     *
13215     * @see elm_thumb_file_set()
13216     *
13217     * @ingroup Thumb
13218     */
13219    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13220    /**
13221     * Set the file that will be used as thumbnail.
13222     *
13223     * @param obj The thumb object.
13224     * @param file The path to file that will be used as thumb.
13225     * @param key The key used in case of an EET file.
13226     *
13227     * The file can be an image or a video (in that case, acceptable extensions are:
13228     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13229     * function elm_thumb_animate().
13230     *
13231     * @see elm_thumb_file_get()
13232     * @see elm_thumb_reload()
13233     * @see elm_thumb_animate()
13234     *
13235     * @ingroup Thumb
13236     */
13237    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13238    /**
13239     * Get the image or video path and key used to generate the thumbnail.
13240     *
13241     * @param obj The thumb object.
13242     * @param file Pointer to filename.
13243     * @param key Pointer to key.
13244     *
13245     * @see elm_thumb_file_set()
13246     * @see elm_thumb_path_get()
13247     *
13248     * @ingroup Thumb
13249     */
13250    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13251    /**
13252     * Get the path and key to the image or video generated by ethumb.
13253     *
13254     * One just need to make sure that the thumbnail was generated before getting
13255     * its path; otherwise, the path will be NULL. One way to do that is by asking
13256     * for the path when/after the "generate,stop" smart callback is called.
13257     *
13258     * @param obj The thumb object.
13259     * @param file Pointer to thumb path.
13260     * @param key Pointer to thumb key.
13261     *
13262     * @see elm_thumb_file_get()
13263     *
13264     * @ingroup Thumb
13265     */
13266    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13267    /**
13268     * Set the animation state for the thumb object. If its content is an animated
13269     * video, you may start/stop the animation or tell it to play continuously and
13270     * looping.
13271     *
13272     * @param obj The thumb object.
13273     * @param setting The animation setting.
13274     *
13275     * @see elm_thumb_file_set()
13276     *
13277     * @ingroup Thumb
13278     */
13279    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13280    /**
13281     * Get the animation state for the thumb object.
13282     *
13283     * @param obj The thumb object.
13284     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13285     * on errors.
13286     *
13287     * @see elm_thumb_animate_set()
13288     *
13289     * @ingroup Thumb
13290     */
13291    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13292    /**
13293     * Get the ethumb_client handle so custom configuration can be made.
13294     *
13295     * @return Ethumb_Client instance or NULL.
13296     *
13297     * This must be called before the objects are created to be sure no object is
13298     * visible and no generation started.
13299     *
13300     * Example of usage:
13301     *
13302     * @code
13303     * #include <Elementary.h>
13304     * #ifndef ELM_LIB_QUICKLAUNCH
13305     * EAPI_MAIN int
13306     * elm_main(int argc, char **argv)
13307     * {
13308     *    Ethumb_Client *client;
13309     *
13310     *    elm_need_ethumb();
13311     *
13312     *    // ... your code
13313     *
13314     *    client = elm_thumb_ethumb_client_get();
13315     *    if (!client)
13316     *      {
13317     *         ERR("could not get ethumb_client");
13318     *         return 1;
13319     *      }
13320     *    ethumb_client_size_set(client, 100, 100);
13321     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13322     *    // ... your code
13323     *
13324     *    // Create elm_thumb objects here
13325     *
13326     *    elm_run();
13327     *    elm_shutdown();
13328     *    return 0;
13329     * }
13330     * #endif
13331     * ELM_MAIN()
13332     * @endcode
13333     *
13334     * @note There's only one client handle for Ethumb, so once a configuration
13335     * change is done to it, any other request for thumbnails (for any thumbnail
13336     * object) will use that configuration. Thus, this configuration is global.
13337     *
13338     * @ingroup Thumb
13339     */
13340    EAPI void                        *elm_thumb_ethumb_client_get(void);
13341    /**
13342     * Get the ethumb_client connection state.
13343     *
13344     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13345     * otherwise.
13346     */
13347    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13348    /**
13349     * Make the thumbnail 'editable'.
13350     *
13351     * @param obj Thumb object.
13352     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13353     *
13354     * This means the thumbnail is a valid drag target for drag and drop, and can be
13355     * cut or pasted too.
13356     *
13357     * @see elm_thumb_editable_get()
13358     *
13359     * @ingroup Thumb
13360     */
13361    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13362    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13363    /**
13364     * Make the thumbnail 'editable'.
13365     *
13366     * @param obj Thumb object.
13367     * @return Editability.
13368     *
13369     * This means the thumbnail is a valid drag target for drag and drop, and can be
13370     * cut or pasted too.
13371     *
13372     * @see elm_thumb_editable_set()
13373     *
13374     * @ingroup Thumb
13375     */
13376    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13377
13378    /**
13379     * @}
13380     */
13381
13382    /**
13383     * @defgroup Web Web
13384     *
13385     * @image html img/widget/web/preview-00.png
13386     * @image latex img/widget/web/preview-00.eps
13387     *
13388     * A web object is used for displaying web pages (HTML/CSS/JS)
13389     * using WebKit-EFL. You must have compiled Elementary with
13390     * ewebkit support.
13391     *
13392     * Signals that you can add callbacks for are:
13393     * @li "download,request": A file download has been requested. Event info is
13394     * a pointer to a Elm_Web_Download
13395     * @li "editorclient,contents,changed": Editor client's contents changed
13396     * @li "editorclient,selection,changed": Editor client's selection changed
13397     * @li "frame,created": A new frame was created. Event info is an
13398     * Evas_Object which can be handled with WebKit's ewk_frame API
13399     * @li "icon,received": An icon was received by the main frame
13400     * @li "inputmethod,changed": Input method changed. Event info is an
13401     * Eina_Bool indicating whether it's enabled or not
13402     * @li "js,windowobject,clear": JS window object has been cleared
13403     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13404     * is a char *link[2], where the first string contains the URL the link
13405     * points to, and the second one the title of the link
13406     * @li "link,hover,out": Mouse cursor left the link
13407     * @li "load,document,finished": Loading of a document finished. Event info
13408     * is the frame that finished loading
13409     * @li "load,error": Load failed. Event info is a pointer to
13410     * Elm_Web_Frame_Load_Error
13411     * @li "load,finished": Load finished. Event info is NULL on success, on
13412     * error it's a pointer to Elm_Web_Frame_Load_Error
13413     * @li "load,newwindow,show": A new window was created and is ready to be
13414     * shown
13415     * @li "load,progress": Overall load progress. Event info is a pointer to
13416     * a double containing a value between 0.0 and 1.0
13417     * @li "load,provisional": Started provisional load
13418     * @li "load,started": Loading of a document started
13419     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13420     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13421     * the menubar is visible, or EINA_FALSE in case it's not
13422     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13423     * an Eina_Bool indicating the visibility
13424     * @li "popup,created": A dropdown widget was activated, requesting its
13425     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13426     * @li "popup,willdelete": The web object is ready to destroy the popup
13427     * object created. Event info is a pointer to Elm_Web_Menu
13428     * @li "ready": Page is fully loaded
13429     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13430     * info is a pointer to Eina_Bool where the visibility state should be set
13431     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13432     * is an Eina_Bool with the visibility state set
13433     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13434     * a string with the new text
13435     * @li "statusbar,visible,get": Queries visibility of the status bar.
13436     * Event info is a pointer to Eina_Bool where the visibility state should be
13437     * set.
13438     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13439     * an Eina_Bool with the visibility value
13440     * @li "title,changed": Title of the main frame changed. Event info is a
13441     * string with the new title
13442     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13443     * is a pointer to Eina_Bool where the visibility state should be set
13444     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13445     * info is an Eina_Bool with the visibility state
13446     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13447     * a string with the text to show
13448     * @li "uri,changed": URI of the main frame changed. Event info is a string
13449     * with the new URI
13450     * @li "view,resized": The web object internal's view changed sized
13451     * @li "windows,close,request": A JavaScript request to close the current
13452     * window was requested
13453     * @li "zoom,animated,end": Animated zoom finished
13454     *
13455     * available styles:
13456     * - default
13457     *
13458     * An example of use of web:
13459     *
13460     * - @ref web_example_01 TBD
13461     */
13462
13463    /**
13464     * @addtogroup Web
13465     * @{
13466     */
13467
13468    /**
13469     * Structure used to report load errors.
13470     *
13471     * Load errors are reported as signal by elm_web. All the strings are
13472     * temporary references and should @b not be used after the signal
13473     * callback returns. If it's required, make copies with strdup() or
13474     * eina_stringshare_add() (they are not even guaranteed to be
13475     * stringshared, so must use eina_stringshare_add() and not
13476     * eina_stringshare_ref()).
13477     */
13478    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13479    /**
13480     * Structure used to report load errors.
13481     *
13482     * Load errors are reported as signal by elm_web. All the strings are
13483     * temporary references and should @b not be used after the signal
13484     * callback returns. If it's required, make copies with strdup() or
13485     * eina_stringshare_add() (they are not even guaranteed to be
13486     * stringshared, so must use eina_stringshare_add() and not
13487     * eina_stringshare_ref()).
13488     */
13489    struct _Elm_Web_Frame_Load_Error
13490      {
13491         int code; /**< Numeric error code */
13492         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13493         const char *domain; /**< Error domain name */
13494         const char *description; /**< Error description (already localized) */
13495         const char *failing_url; /**< The URL that failed to load */
13496         Evas_Object *frame; /**< Frame object that produced the error */
13497      };
13498
13499    /**
13500     * The possibles types that the items in a menu can be
13501     */
13502    typedef enum _Elm_Web_Menu_Item_Type
13503      {
13504         ELM_WEB_MENU_SEPARATOR,
13505         ELM_WEB_MENU_GROUP,
13506         ELM_WEB_MENU_OPTION
13507      } Elm_Web_Menu_Item_Type;
13508
13509    /**
13510     * Structure describing the items in a menu
13511     */
13512    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13513    /**
13514     * Structure describing the items in a menu
13515     */
13516    struct _Elm_Web_Menu_Item
13517      {
13518         const char *text; /**< The text for the item */
13519         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13520      };
13521
13522    /**
13523     * Structure describing the menu of a popup
13524     *
13525     * This structure will be passed as the @c event_info for the "popup,create"
13526     * signal, which is emitted when a dropdown menu is opened. Users wanting
13527     * to handle these popups by themselves should listen to this signal and
13528     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13529     * property as @c EINA_FALSE means that the user will not handle the popup
13530     * and the default implementation will be used.
13531     *
13532     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13533     * will be emitted to notify the user that it can destroy any objects and
13534     * free all data related to it.
13535     *
13536     * @see elm_web_popup_selected_set()
13537     * @see elm_web_popup_destroy()
13538     */
13539    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13540    /**
13541     * Structure describing the menu of a popup
13542     *
13543     * This structure will be passed as the @c event_info for the "popup,create"
13544     * signal, which is emitted when a dropdown menu is opened. Users wanting
13545     * to handle these popups by themselves should listen to this signal and
13546     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13547     * property as @c EINA_FALSE means that the user will not handle the popup
13548     * and the default implementation will be used.
13549     *
13550     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13551     * will be emitted to notify the user that it can destroy any objects and
13552     * free all data related to it.
13553     *
13554     * @see elm_web_popup_selected_set()
13555     * @see elm_web_popup_destroy()
13556     */
13557    struct _Elm_Web_Menu
13558      {
13559         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13560         int x; /**< The X position of the popup, relative to the elm_web object */
13561         int y; /**< The Y position of the popup, relative to the elm_web object */
13562         int width; /**< Width of the popup menu */
13563         int height; /**< Height of the popup menu */
13564
13565         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. */
13566      };
13567
13568    typedef struct _Elm_Web_Download Elm_Web_Download;
13569    struct _Elm_Web_Download
13570      {
13571         const char *url;
13572      };
13573
13574    /**
13575     * Types of zoom available.
13576     */
13577    typedef enum _Elm_Web_Zoom_Mode
13578      {
13579         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13580         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13581         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13582         ELM_WEB_ZOOM_MODE_LAST
13583      } Elm_Web_Zoom_Mode;
13584    /**
13585     * Opaque handler containing the features (such as statusbar, menubar, etc)
13586     * that are to be set on a newly requested window.
13587     */
13588    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13589    /**
13590     * Callback type for the create_window hook.
13591     *
13592     * The function parameters are:
13593     * @li @p data User data pointer set when setting the hook function
13594     * @li @p obj The elm_web object requesting the new window
13595     * @li @p js Set to @c EINA_TRUE if the request was originated from
13596     * JavaScript. @c EINA_FALSE otherwise.
13597     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13598     * the features requested for the new window.
13599     *
13600     * The returned value of the function should be the @c elm_web widget where
13601     * the request will be loaded. That is, if a new window or tab is created,
13602     * the elm_web widget in it should be returned, and @b NOT the window
13603     * object.
13604     * Returning @c NULL should cancel the request.
13605     *
13606     * @see elm_web_window_create_hook_set()
13607     */
13608    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13609    /**
13610     * Callback type for the JS alert hook.
13611     *
13612     * The function parameters are:
13613     * @li @p data User data pointer set when setting the hook function
13614     * @li @p obj The elm_web object requesting the new window
13615     * @li @p message The message to show in the alert dialog
13616     *
13617     * The function should return the object representing the alert dialog.
13618     * Elm_Web will run a second main loop to handle the dialog and normal
13619     * flow of the application will be restored when the object is deleted, so
13620     * the user should handle the popup properly in order to delete the object
13621     * when the action is finished.
13622     * If the function returns @c NULL the popup will be ignored.
13623     *
13624     * @see elm_web_dialog_alert_hook_set()
13625     */
13626    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13627    /**
13628     * Callback type for the JS confirm hook.
13629     *
13630     * The function parameters are:
13631     * @li @p data User data pointer set when setting the hook function
13632     * @li @p obj The elm_web object requesting the new window
13633     * @li @p message The message to show in the confirm dialog
13634     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13635     * the user selected @c Ok, @c EINA_FALSE otherwise.
13636     *
13637     * The function should return the object representing the confirm dialog.
13638     * Elm_Web will run a second main loop to handle the dialog and normal
13639     * flow of the application will be restored when the object is deleted, so
13640     * the user should handle the popup properly in order to delete the object
13641     * when the action is finished.
13642     * If the function returns @c NULL the popup will be ignored.
13643     *
13644     * @see elm_web_dialog_confirm_hook_set()
13645     */
13646    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13647    /**
13648     * Callback type for the JS prompt hook.
13649     *
13650     * The function parameters are:
13651     * @li @p data User data pointer set when setting the hook function
13652     * @li @p obj The elm_web object requesting the new window
13653     * @li @p message The message to show in the prompt dialog
13654     * @li @p def_value The default value to present the user in the entry
13655     * @li @p value Pointer where to store the value given by the user. Must
13656     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13657     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13658     * the user selected @c Ok, @c EINA_FALSE otherwise.
13659     *
13660     * The function should return the object representing the prompt dialog.
13661     * Elm_Web will run a second main loop to handle the dialog and normal
13662     * flow of the application will be restored when the object is deleted, so
13663     * the user should handle the popup properly in order to delete the object
13664     * when the action is finished.
13665     * If the function returns @c NULL the popup will be ignored.
13666     *
13667     * @see elm_web_dialog_prompt_hook_set()
13668     */
13669    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13670    /**
13671     * Callback type for the JS file selector hook.
13672     *
13673     * The function parameters are:
13674     * @li @p data User data pointer set when setting the hook function
13675     * @li @p obj The elm_web object requesting the new window
13676     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13677     * @li @p accept_types Mime types accepted
13678     * @li @p selected Pointer where to store the list of malloc'ed strings
13679     * containing the path to each file selected. Must be @c NULL if the file
13680     * dialog is cancelled
13681     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13682     * the user selected @c Ok, @c EINA_FALSE otherwise.
13683     *
13684     * The function should return the object representing the file selector
13685     * dialog.
13686     * Elm_Web will run a second main loop to handle the dialog and normal
13687     * flow of the application will be restored when the object is deleted, so
13688     * the user should handle the popup properly in order to delete the object
13689     * when the action is finished.
13690     * If the function returns @c NULL the popup will be ignored.
13691     *
13692     * @see elm_web_dialog_file selector_hook_set()
13693     */
13694    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);
13695    /**
13696     * Callback type for the JS console message hook.
13697     *
13698     * When a console message is added from JavaScript, any set function to the
13699     * console message hook will be called for the user to handle. There is no
13700     * default implementation of this hook.
13701     *
13702     * The function parameters are:
13703     * @li @p data User data pointer set when setting the hook function
13704     * @li @p obj The elm_web object that originated the message
13705     * @li @p message The message sent
13706     * @li @p line_number The line number
13707     * @li @p source_id Source id
13708     *
13709     * @see elm_web_console_message_hook_set()
13710     */
13711    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13712    /**
13713     * Add a new web object to the parent.
13714     *
13715     * @param parent The parent object.
13716     * @return The new object or NULL if it cannot be created.
13717     *
13718     * @see elm_web_uri_set()
13719     * @see elm_web_webkit_view_get()
13720     */
13721    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13722
13723    /**
13724     * Get internal ewk_view object from web object.
13725     *
13726     * Elementary may not provide some low level features of EWebKit,
13727     * instead of cluttering the API with proxy methods we opted to
13728     * return the internal reference. Be careful using it as it may
13729     * interfere with elm_web behavior.
13730     *
13731     * @param obj The web object.
13732     * @return The internal ewk_view object or NULL if it does not
13733     *         exist. (Failure to create or Elementary compiled without
13734     *         ewebkit)
13735     *
13736     * @see elm_web_add()
13737     */
13738    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13739
13740    /**
13741     * Sets the function to call when a new window is requested
13742     *
13743     * This hook will be called when a request to create a new window is
13744     * issued from the web page loaded.
13745     * There is no default implementation for this feature, so leaving this
13746     * unset or passing @c NULL in @p func will prevent new windows from
13747     * opening.
13748     *
13749     * @param obj The web object where to set the hook function
13750     * @param func The hook function to be called when a window is requested
13751     * @param data User data
13752     */
13753    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13754    /**
13755     * Sets the function to call when an alert dialog
13756     *
13757     * This hook will be called when a JavaScript alert dialog is requested.
13758     * If no function is set or @c NULL is passed in @p func, the default
13759     * implementation will take place.
13760     *
13761     * @param obj The web object where to set the hook function
13762     * @param func The callback function to be used
13763     * @param data User data
13764     *
13765     * @see elm_web_inwin_mode_set()
13766     */
13767    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13768    /**
13769     * Sets the function to call when an confirm dialog
13770     *
13771     * This hook will be called when a JavaScript confirm dialog is requested.
13772     * If no function is set or @c NULL is passed in @p func, the default
13773     * implementation will take place.
13774     *
13775     * @param obj The web object where to set the hook function
13776     * @param func The callback function to be used
13777     * @param data User data
13778     *
13779     * @see elm_web_inwin_mode_set()
13780     */
13781    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13782    /**
13783     * Sets the function to call when an prompt dialog
13784     *
13785     * This hook will be called when a JavaScript prompt dialog is requested.
13786     * If no function is set or @c NULL is passed in @p func, the default
13787     * implementation will take place.
13788     *
13789     * @param obj The web object where to set the hook function
13790     * @param func The callback function to be used
13791     * @param data User data
13792     *
13793     * @see elm_web_inwin_mode_set()
13794     */
13795    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13796    /**
13797     * Sets the function to call when an file selector dialog
13798     *
13799     * This hook will be called when a JavaScript file selector dialog is
13800     * requested.
13801     * If no function is set or @c NULL is passed in @p func, the default
13802     * implementation will take place.
13803     *
13804     * @param obj The web object where to set the hook function
13805     * @param func The callback function to be used
13806     * @param data User data
13807     *
13808     * @see elm_web_inwin_mode_set()
13809     */
13810    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13811    /**
13812     * Sets the function to call when a console message is emitted from JS
13813     *
13814     * This hook will be called when a console message is emitted from
13815     * JavaScript. There is no default implementation for this feature.
13816     *
13817     * @param obj The web object where to set the hook function
13818     * @param func The callback function to be used
13819     * @param data User data
13820     */
13821    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13822    /**
13823     * Gets the status of the tab propagation
13824     *
13825     * @param obj The web object to query
13826     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13827     *
13828     * @see elm_web_tab_propagate_set()
13829     */
13830    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13831    /**
13832     * Sets whether to use tab propagation
13833     *
13834     * If tab propagation is enabled, whenever the user presses the Tab key,
13835     * Elementary will handle it and switch focus to the next widget.
13836     * The default value is disabled, where WebKit will handle the Tab key to
13837     * cycle focus though its internal objects, jumping to the next widget
13838     * only when that cycle ends.
13839     *
13840     * @param obj The web object
13841     * @param propagate Whether to propagate Tab keys to Elementary or not
13842     */
13843    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13844    /**
13845     * Sets the URI for the web object
13846     *
13847     * It must be a full URI, with resource included, in the form
13848     * http://www.enlightenment.org or file:///tmp/something.html
13849     *
13850     * @param obj The web object
13851     * @param uri The URI to set
13852     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13853     */
13854    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13855    /**
13856     * Gets the current URI for the object
13857     *
13858     * The returned string must not be freed and is guaranteed to be
13859     * stringshared.
13860     *
13861     * @param obj The web object
13862     * @return A stringshared internal string with the current URI, or NULL on
13863     * failure
13864     */
13865    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13866    /**
13867     * Gets the current title
13868     *
13869     * The returned string must not be freed and is guaranteed to be
13870     * stringshared.
13871     *
13872     * @param obj The web object
13873     * @return A stringshared internal string with the current title, or NULL on
13874     * failure
13875     */
13876    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13877    /**
13878     * Sets the background color to be used by the web object
13879     *
13880     * This is the color that will be used by default when the loaded page
13881     * does not set it's own. Color values are pre-multiplied.
13882     *
13883     * @param obj The web object
13884     * @param r Red component
13885     * @param g Green component
13886     * @param b Blue component
13887     * @param a Alpha component
13888     */
13889    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13890    /**
13891     * Gets the background color to be used by the web object
13892     *
13893     * This is the color that will be used by default when the loaded page
13894     * does not set it's own. Color values are pre-multiplied.
13895     *
13896     * @param obj The web object
13897     * @param r Red component
13898     * @param g Green component
13899     * @param b Blue component
13900     * @param a Alpha component
13901     */
13902    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13903    /**
13904     * Gets a copy of the currently selected text
13905     *
13906     * The string returned must be freed by the user when it's done with it.
13907     *
13908     * @param obj The web object
13909     * @return A newly allocated string, or NULL if nothing is selected or an
13910     * error occurred
13911     */
13912    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13913    /**
13914     * Tells the web object which index in the currently open popup was selected
13915     *
13916     * When the user handles the popup creation from the "popup,created" signal,
13917     * it needs to tell the web object which item was selected by calling this
13918     * function with the index corresponding to the item.
13919     *
13920     * @param obj The web object
13921     * @param index The index selected
13922     *
13923     * @see elm_web_popup_destroy()
13924     */
13925    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13926    /**
13927     * Dismisses an open dropdown popup
13928     *
13929     * When the popup from a dropdown widget is to be dismissed, either after
13930     * selecting an option or to cancel it, this function must be called, which
13931     * will later emit an "popup,willdelete" signal to notify the user that
13932     * any memory and objects related to this popup can be freed.
13933     *
13934     * @param obj The web object
13935     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13936     * if there was no menu to destroy
13937     */
13938    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13939    /**
13940     * Searches the given string in a document.
13941     *
13942     * @param obj The web object where to search the text
13943     * @param string String to search
13944     * @param case_sensitive If search should be case sensitive or not
13945     * @param forward If search is from cursor and on or backwards
13946     * @param wrap If search should wrap at the end
13947     *
13948     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13949     * or failure
13950     */
13951    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13952    /**
13953     * Marks matches of the given string in a document.
13954     *
13955     * @param obj The web object where to search text
13956     * @param string String to match
13957     * @param case_sensitive If match should be case sensitive or not
13958     * @param highlight If matches should be highlighted
13959     * @param limit Maximum amount of matches, or zero to unlimited
13960     *
13961     * @return number of matched @a string
13962     */
13963    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13964    /**
13965     * Clears all marked matches in the document
13966     *
13967     * @param obj The web object
13968     *
13969     * @return EINA_TRUE on success, EINA_FALSE otherwise
13970     */
13971    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13972    /**
13973     * Sets whether to highlight the matched marks
13974     *
13975     * If enabled, marks set with elm_web_text_matches_mark() will be
13976     * highlighted.
13977     *
13978     * @param obj The web object
13979     * @param highlight Whether to highlight the marks or not
13980     *
13981     * @return EINA_TRUE on success, EINA_FALSE otherwise
13982     */
13983    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13984    /**
13985     * Gets whether highlighting marks is enabled
13986     *
13987     * @param The web object
13988     *
13989     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13990     * otherwise
13991     */
13992    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13993    /**
13994     * Gets the overall loading progress of the page
13995     *
13996     * Returns the estimated loading progress of the page, with a value between
13997     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13998     * included in the page.
13999     *
14000     * @param The web object
14001     *
14002     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14003     * failure
14004     */
14005    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
14006    /**
14007     * Stops loading the current page
14008     *
14009     * Cancels the loading of the current page in the web object. This will
14010     * cause a "load,error" signal to be emitted, with the is_cancellation
14011     * flag set to EINA_TRUE.
14012     *
14013     * @param obj The web object
14014     *
14015     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14016     */
14017    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
14018    /**
14019     * Requests a reload of the current document in the object
14020     *
14021     * @param obj The web object
14022     *
14023     * @return EINA_TRUE on success, EINA_FALSE otherwise
14024     */
14025    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
14026    /**
14027     * Requests a reload of the current document, avoiding any existing caches
14028     *
14029     * @param obj The web object
14030     *
14031     * @return EINA_TRUE on success, EINA_FALSE otherwise
14032     */
14033    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
14034    /**
14035     * Goes back one step in the browsing history
14036     *
14037     * This is equivalent to calling elm_web_object_navigate(obj, -1);
14038     *
14039     * @param obj The web object
14040     *
14041     * @return EINA_TRUE on success, EINA_FALSE otherwise
14042     *
14043     * @see elm_web_history_enable_set()
14044     * @see elm_web_back_possible()
14045     * @see elm_web_forward()
14046     * @see elm_web_navigate()
14047     */
14048    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14049    /**
14050     * Goes forward one step in the browsing history
14051     *
14052     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14053     *
14054     * @param obj The web object
14055     *
14056     * @return EINA_TRUE on success, EINA_FALSE otherwise
14057     *
14058     * @see elm_web_history_enable_set()
14059     * @see elm_web_forward_possible()
14060     * @see elm_web_back()
14061     * @see elm_web_navigate()
14062     */
14063    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14064    /**
14065     * Jumps the given number of steps in the browsing history
14066     *
14067     * The @p steps value can be a negative integer to back in history, or a
14068     * positive to move forward.
14069     *
14070     * @param obj The web object
14071     * @param steps The number of steps to jump
14072     *
14073     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14074     * history exists to jump the given number of steps
14075     *
14076     * @see elm_web_history_enable_set()
14077     * @see elm_web_navigate_possible()
14078     * @see elm_web_back()
14079     * @see elm_web_forward()
14080     */
14081    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14082    /**
14083     * Queries whether it's possible to go back in history
14084     *
14085     * @param obj The web object
14086     *
14087     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14088     * otherwise
14089     */
14090    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14091    /**
14092     * Queries whether it's possible to go forward in history
14093     *
14094     * @param obj The web object
14095     *
14096     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14097     * otherwise
14098     */
14099    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14100    /**
14101     * Queries whether it's possible to jump the given number of steps
14102     *
14103     * The @p steps value can be a negative integer to back in history, or a
14104     * positive to move forward.
14105     *
14106     * @param obj The web object
14107     * @param steps The number of steps to check for
14108     *
14109     * @return EINA_TRUE if enough history exists to perform the given jump,
14110     * EINA_FALSE otherwise
14111     */
14112    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14113    /**
14114     * Gets whether browsing history is enabled for the given object
14115     *
14116     * @param obj The web object
14117     *
14118     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14119     */
14120    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14121    /**
14122     * Enables or disables the browsing history
14123     *
14124     * @param obj The web object
14125     * @param enable Whether to enable or disable the browsing history
14126     */
14127    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14128    /**
14129     * Sets the zoom level of the web object
14130     *
14131     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14132     * values meaning zoom in and lower meaning zoom out. This function will
14133     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14134     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14135     *
14136     * @param obj The web object
14137     * @param zoom The zoom level to set
14138     */
14139    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14140    /**
14141     * Gets the current zoom level set on the web object
14142     *
14143     * Note that this is the zoom level set on the web object and not that
14144     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14145     * the two zoom levels should match, but for the other two modes the
14146     * Webkit zoom is calculated internally to match the chosen mode without
14147     * changing the zoom level set for the web object.
14148     *
14149     * @param obj The web object
14150     *
14151     * @return The zoom level set on the object
14152     */
14153    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14154    /**
14155     * Sets the zoom mode to use
14156     *
14157     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14158     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14159     *
14160     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14161     * with the elm_web_zoom_set() function.
14162     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14163     * make sure the entirety of the web object's contents are shown.
14164     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14165     * fit the contents in the web object's size, without leaving any space
14166     * unused.
14167     *
14168     * @param obj The web object
14169     * @param mode The mode to set
14170     */
14171    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14172    /**
14173     * Gets the currently set zoom mode
14174     *
14175     * @param obj The web object
14176     *
14177     * @return The current zoom mode set for the object, or
14178     * ::ELM_WEB_ZOOM_MODE_LAST on error
14179     */
14180    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14181    /**
14182     * Shows the given region in the web object
14183     *
14184     * @param obj The web object
14185     * @param x The x coordinate of the region to show
14186     * @param y The y coordinate of the region to show
14187     * @param w The width of the region to show
14188     * @param h The height of the region to show
14189     */
14190    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14191    /**
14192     * Brings in the region to the visible area
14193     *
14194     * Like elm_web_region_show(), but it animates the scrolling of the object
14195     * to show the area
14196     *
14197     * @param obj The web object
14198     * @param x The x coordinate of the region to show
14199     * @param y The y coordinate of the region to show
14200     * @param w The width of the region to show
14201     * @param h The height of the region to show
14202     */
14203    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14204    /**
14205     * Sets the default dialogs to use an Inwin instead of a normal window
14206     *
14207     * If set, then the default implementation for the JavaScript dialogs and
14208     * file selector will be opened in an Inwin. Otherwise they will use a
14209     * normal separated window.
14210     *
14211     * @param obj The web object
14212     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14213     */
14214    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14215    /**
14216     * Gets whether Inwin mode is set for the current object
14217     *
14218     * @param obj The web object
14219     *
14220     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14221     */
14222    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14223
14224    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14225    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14226    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);
14227    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14228
14229    /**
14230     * @}
14231     */
14232
14233    /**
14234     * @defgroup Hoversel Hoversel
14235     *
14236     * @image html img/widget/hoversel/preview-00.png
14237     * @image latex img/widget/hoversel/preview-00.eps
14238     *
14239     * A hoversel is a button that pops up a list of items (automatically
14240     * choosing the direction to display) that have a label and, optionally, an
14241     * icon to select from. It is a convenience widget to avoid the need to do
14242     * all the piecing together yourself. It is intended for a small number of
14243     * items in the hoversel menu (no more than 8), though is capable of many
14244     * more.
14245     *
14246     * Signals that you can add callbacks for are:
14247     * "clicked" - the user clicked the hoversel button and popped up the sel
14248     * "selected" - an item in the hoversel list is selected. event_info is the item
14249     * "dismissed" - the hover is dismissed
14250     *
14251     * See @ref tutorial_hoversel for an example.
14252     * @{
14253     */
14254    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14255    /**
14256     * @brief Add a new Hoversel object
14257     *
14258     * @param parent The parent object
14259     * @return The new object or NULL if it cannot be created
14260     */
14261    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14262    /**
14263     * @brief This sets the hoversel to expand horizontally.
14264     *
14265     * @param obj The hoversel object
14266     * @param horizontal If true, the hover will expand horizontally to the
14267     * right.
14268     *
14269     * @note The initial button will display horizontally regardless of this
14270     * setting.
14271     */
14272    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14273    /**
14274     * @brief This returns whether the hoversel is set to expand horizontally.
14275     *
14276     * @param obj The hoversel object
14277     * @return If true, the hover will expand horizontally to the right.
14278     *
14279     * @see elm_hoversel_horizontal_set()
14280     */
14281    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14282    /**
14283     * @brief Set the Hover parent
14284     *
14285     * @param obj The hoversel object
14286     * @param parent The parent to use
14287     *
14288     * Sets the hover parent object, the area that will be darkened when the
14289     * hoversel is clicked. Should probably be the window that the hoversel is
14290     * in. See @ref Hover objects for more information.
14291     */
14292    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14293    /**
14294     * @brief Get the Hover parent
14295     *
14296     * @param obj The hoversel object
14297     * @return The used parent
14298     *
14299     * Gets the hover parent object.
14300     *
14301     * @see elm_hoversel_hover_parent_set()
14302     */
14303    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14304    /**
14305     * @brief Set the hoversel button label
14306     *
14307     * @param obj The hoversel object
14308     * @param label The label text.
14309     *
14310     * This sets the label of the button that is always visible (before it is
14311     * clicked and expanded).
14312     *
14313     * @deprecated elm_object_text_set()
14314     */
14315    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14316    /**
14317     * @brief Get the hoversel button label
14318     *
14319     * @param obj The hoversel object
14320     * @return The label text.
14321     *
14322     * @deprecated elm_object_text_get()
14323     */
14324    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14325    /**
14326     * @brief Set the icon of the hoversel button
14327     *
14328     * @param obj The hoversel object
14329     * @param icon The icon object
14330     *
14331     * Sets the icon of the button that is always visible (before it is clicked
14332     * and expanded).  Once the icon object is set, a previously set one will be
14333     * deleted, if you want to keep that old content object, use the
14334     * elm_hoversel_icon_unset() function.
14335     *
14336     * @see elm_object_content_set() for the button widget
14337     */
14338    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14339    /**
14340     * @brief Get the icon of the hoversel button
14341     *
14342     * @param obj The hoversel object
14343     * @return The icon object
14344     *
14345     * Get the icon of the button that is always visible (before it is clicked
14346     * and expanded). Also see elm_object_content_get() for the button widget.
14347     *
14348     * @see elm_hoversel_icon_set()
14349     */
14350    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14351    /**
14352     * @brief Get and unparent the icon of the hoversel button
14353     *
14354     * @param obj The hoversel object
14355     * @return The icon object that was being used
14356     *
14357     * Unparent and return the icon of the button that is always visible
14358     * (before it is clicked and expanded).
14359     *
14360     * @see elm_hoversel_icon_set()
14361     * @see elm_object_content_unset() for the button widget
14362     */
14363    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14364    /**
14365     * @brief This triggers the hoversel popup from code, the same as if the user
14366     * had clicked the button.
14367     *
14368     * @param obj The hoversel object
14369     */
14370    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14371    /**
14372     * @brief This dismisses the hoversel popup as if the user had clicked
14373     * outside the hover.
14374     *
14375     * @param obj The hoversel object
14376     */
14377    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14378    /**
14379     * @brief Returns whether the hoversel is expanded.
14380     *
14381     * @param obj The hoversel object
14382     * @return  This will return EINA_TRUE if the hoversel is expanded or
14383     * EINA_FALSE if it is not expanded.
14384     */
14385    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14386    /**
14387     * @brief This will remove all the children items from the hoversel.
14388     *
14389     * @param obj The hoversel object
14390     *
14391     * @warning Should @b not be called while the hoversel is active; use
14392     * elm_hoversel_expanded_get() to check first.
14393     *
14394     * @see elm_hoversel_item_del_cb_set()
14395     * @see elm_hoversel_item_del()
14396     */
14397    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14398    /**
14399     * @brief Get the list of items within the given hoversel.
14400     *
14401     * @param obj The hoversel object
14402     * @return Returns a list of Elm_Hoversel_Item*
14403     *
14404     * @see elm_hoversel_item_add()
14405     */
14406    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14407    /**
14408     * @brief Add an item to the hoversel button
14409     *
14410     * @param obj The hoversel object
14411     * @param label The text label to use for the item (NULL if not desired)
14412     * @param icon_file An image file path on disk to use for the icon or standard
14413     * icon name (NULL if not desired)
14414     * @param icon_type The icon type if relevant
14415     * @param func Convenience function to call when this item is selected
14416     * @param data Data to pass to item-related functions
14417     * @return A handle to the item added.
14418     *
14419     * This adds an item to the hoversel to show when it is clicked. Note: if you
14420     * need to use an icon from an edje file then use
14421     * elm_hoversel_item_icon_set() right after the this function, and set
14422     * icon_file to NULL here.
14423     *
14424     * For more information on what @p icon_file and @p icon_type are see the
14425     * @ref Icon "icon documentation".
14426     */
14427    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);
14428    /**
14429     * @brief Delete an item from the hoversel
14430     *
14431     * @param item The item to delete
14432     *
14433     * This deletes the item from the hoversel (should not be called while the
14434     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14435     *
14436     * @see elm_hoversel_item_add()
14437     * @see elm_hoversel_item_del_cb_set()
14438     */
14439    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14440    /**
14441     * @brief Set the function to be called when an item from the hoversel is
14442     * freed.
14443     *
14444     * @param item The item to set the callback on
14445     * @param func The function called
14446     *
14447     * That function will receive these parameters:
14448     * @li void *item_data
14449     * @li Evas_Object *the_item_object
14450     * @li Elm_Hoversel_Item *the_object_struct
14451     *
14452     * @see elm_hoversel_item_add()
14453     */
14454    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14455    /**
14456     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14457     * that will be passed to associated function callbacks.
14458     *
14459     * @param item The item to get the data from
14460     * @return The data pointer set with elm_hoversel_item_add()
14461     *
14462     * @see elm_hoversel_item_add()
14463     */
14464    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14465    /**
14466     * @brief This returns the label text of the given hoversel item.
14467     *
14468     * @param item The item to get the label
14469     * @return The label text of the hoversel item
14470     *
14471     * @see elm_hoversel_item_add()
14472     */
14473    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14474    /**
14475     * @brief This sets the icon for the given hoversel item.
14476     *
14477     * @param item The item to set the icon
14478     * @param icon_file An image file path on disk to use for the icon or standard
14479     * icon name
14480     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14481     * to NULL if the icon is not an edje file
14482     * @param icon_type The icon type
14483     *
14484     * The icon can be loaded from the standard set, from an image file, or from
14485     * an edje file.
14486     *
14487     * @see elm_hoversel_item_add()
14488     */
14489    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);
14490    /**
14491     * @brief Get the icon object of the hoversel item
14492     *
14493     * @param item The item to get the icon from
14494     * @param icon_file The image file path on disk used for the icon or standard
14495     * icon name
14496     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14497     * if the icon is not an edje file
14498     * @param icon_type The icon type
14499     *
14500     * @see elm_hoversel_item_icon_set()
14501     * @see elm_hoversel_item_add()
14502     */
14503    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);
14504    /**
14505     * @}
14506     */
14507
14508    /**
14509     * @defgroup Toolbar Toolbar
14510     * @ingroup Elementary
14511     *
14512     * @image html img/widget/toolbar/preview-00.png
14513     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14514     *
14515     * @image html img/toolbar.png
14516     * @image latex img/toolbar.eps width=\textwidth
14517     *
14518     * A toolbar is a widget that displays a list of items inside
14519     * a box. It can be scrollable, show a menu with items that don't fit
14520     * to toolbar size or even crop them.
14521     *
14522     * Only one item can be selected at a time.
14523     *
14524     * Items can have multiple states, or show menus when selected by the user.
14525     *
14526     * Smart callbacks one can listen to:
14527     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14528     * - "language,changed" - when the program language changes
14529     *
14530     * Available styles for it:
14531     * - @c "default"
14532     * - @c "transparent" - no background or shadow, just show the content
14533     *
14534     * List of examples:
14535     * @li @ref toolbar_example_01
14536     * @li @ref toolbar_example_02
14537     * @li @ref toolbar_example_03
14538     */
14539
14540    /**
14541     * @addtogroup Toolbar
14542     * @{
14543     */
14544
14545    /**
14546     * @enum _Elm_Toolbar_Shrink_Mode
14547     * @typedef Elm_Toolbar_Shrink_Mode
14548     *
14549     * Set toolbar's items display behavior, it can be scrollabel,
14550     * show a menu with exceeding items, or simply hide them.
14551     *
14552     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14553     * from elm config.
14554     *
14555     * Values <b> don't </b> work as bitmask, only one can be choosen.
14556     *
14557     * @see elm_toolbar_mode_shrink_set()
14558     * @see elm_toolbar_mode_shrink_get()
14559     *
14560     * @ingroup Toolbar
14561     */
14562    typedef enum _Elm_Toolbar_Shrink_Mode
14563      {
14564         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14565         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14566         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14567         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14568         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14569      } Elm_Toolbar_Shrink_Mode;
14570
14571    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(). */
14572
14573    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(). */
14574
14575    /**
14576     * Add a new toolbar widget to the given parent Elementary
14577     * (container) object.
14578     *
14579     * @param parent The parent object.
14580     * @return a new toolbar widget handle or @c NULL, on errors.
14581     *
14582     * This function inserts a new toolbar widget on the canvas.
14583     *
14584     * @ingroup Toolbar
14585     */
14586    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14587
14588    /**
14589     * Set the icon size, in pixels, to be used by toolbar items.
14590     *
14591     * @param obj The toolbar object
14592     * @param icon_size The icon size in pixels
14593     *
14594     * @note Default value is @c 32. It reads value from elm config.
14595     *
14596     * @see elm_toolbar_icon_size_get()
14597     *
14598     * @ingroup Toolbar
14599     */
14600    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14601
14602    /**
14603     * Get the icon size, in pixels, to be used by toolbar items.
14604     *
14605     * @param obj The toolbar object.
14606     * @return The icon size in pixels.
14607     *
14608     * @see elm_toolbar_icon_size_set() for details.
14609     *
14610     * @ingroup Toolbar
14611     */
14612    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14613
14614    /**
14615     * Sets icon lookup order, for toolbar items' icons.
14616     *
14617     * @param obj The toolbar object.
14618     * @param order The icon lookup order.
14619     *
14620     * Icons added before calling this function will not be affected.
14621     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14622     *
14623     * @see elm_toolbar_icon_order_lookup_get()
14624     *
14625     * @ingroup Toolbar
14626     */
14627    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14628
14629    /**
14630     * Gets the icon lookup order.
14631     *
14632     * @param obj The toolbar object.
14633     * @return The icon lookup order.
14634     *
14635     * @see elm_toolbar_icon_order_lookup_set() for details.
14636     *
14637     * @ingroup Toolbar
14638     */
14639    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14640
14641    /**
14642     * Set whether the toolbar should always have an item selected.
14643     *
14644     * @param obj The toolbar object.
14645     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14646     * disable it.
14647     *
14648     * This will cause the toolbar to always have an item selected, and clicking
14649     * the selected item will not cause a selected event to be emitted. Enabling this mode
14650     * will immediately select the first toolbar item.
14651     *
14652     * Always-selected is disabled by default.
14653     *
14654     * @see elm_toolbar_always_select_mode_get().
14655     *
14656     * @ingroup Toolbar
14657     */
14658    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14659
14660    /**
14661     * Get whether the toolbar should always have an item selected.
14662     *
14663     * @param obj The toolbar object.
14664     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14665     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14666     *
14667     * @see elm_toolbar_always_select_mode_set() for details.
14668     *
14669     * @ingroup Toolbar
14670     */
14671    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14672
14673    /**
14674     * Set whether the toolbar items' should be selected by the user or not.
14675     *
14676     * @param obj The toolbar object.
14677     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14678     * enable it.
14679     *
14680     * This will turn off the ability to select items entirely and they will
14681     * neither appear selected nor emit selected signals. The clicked
14682     * callback function will still be called.
14683     *
14684     * Selection is enabled by default.
14685     *
14686     * @see elm_toolbar_no_select_mode_get().
14687     *
14688     * @ingroup Toolbar
14689     */
14690    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14691
14692    /**
14693     * Set whether the toolbar items' should be selected by the user or not.
14694     *
14695     * @param obj The toolbar object.
14696     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14697     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14698     *
14699     * @see elm_toolbar_no_select_mode_set() for details.
14700     *
14701     * @ingroup Toolbar
14702     */
14703    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14704
14705    /**
14706     * Append item to the toolbar.
14707     *
14708     * @param obj The toolbar object.
14709     * @param icon A string with icon name or the absolute path of an image file.
14710     * @param label The label of the item.
14711     * @param func The function to call when the item is clicked.
14712     * @param data The data to associate with the item for related callbacks.
14713     * @return The created item or @c NULL upon failure.
14714     *
14715     * A new item will be created and appended to the toolbar, i.e., will
14716     * be set as @b last item.
14717     *
14718     * Items created with this method can be deleted with
14719     * elm_toolbar_item_del().
14720     *
14721     * Associated @p data can be properly freed when item is deleted if a
14722     * callback function is set with elm_toolbar_item_del_cb_set().
14723     *
14724     * If a function is passed as argument, it will be called everytime this item
14725     * is selected, i.e., the user clicks over an unselected item.
14726     * If such function isn't needed, just passing
14727     * @c NULL as @p func is enough. The same should be done for @p data.
14728     *
14729     * Toolbar will load icon image from fdo or current theme.
14730     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14731     * If an absolute path is provided it will load it direct from a file.
14732     *
14733     * @see elm_toolbar_item_icon_set()
14734     * @see elm_toolbar_item_del()
14735     * @see elm_toolbar_item_del_cb_set()
14736     *
14737     * @ingroup Toolbar
14738     */
14739    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);
14740
14741    /**
14742     * Prepend item to the toolbar.
14743     *
14744     * @param obj The toolbar object.
14745     * @param icon A string with icon name or the absolute path of an image file.
14746     * @param label The label of the item.
14747     * @param func The function to call when the item is clicked.
14748     * @param data The data to associate with the item for related callbacks.
14749     * @return The created item or @c NULL upon failure.
14750     *
14751     * A new item will be created and prepended to the toolbar, i.e., will
14752     * be set as @b first item.
14753     *
14754     * Items created with this method can be deleted with
14755     * elm_toolbar_item_del().
14756     *
14757     * Associated @p data can be properly freed when item is deleted if a
14758     * callback function is set with elm_toolbar_item_del_cb_set().
14759     *
14760     * If a function is passed as argument, it will be called everytime this item
14761     * is selected, i.e., the user clicks over an unselected item.
14762     * If such function isn't needed, just passing
14763     * @c NULL as @p func is enough. The same should be done for @p data.
14764     *
14765     * Toolbar will load icon image from fdo or current theme.
14766     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14767     * If an absolute path is provided it will load it direct from a file.
14768     *
14769     * @see elm_toolbar_item_icon_set()
14770     * @see elm_toolbar_item_del()
14771     * @see elm_toolbar_item_del_cb_set()
14772     *
14773     * @ingroup Toolbar
14774     */
14775    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);
14776
14777    /**
14778     * Insert a new item into the toolbar object before item @p before.
14779     *
14780     * @param obj The toolbar object.
14781     * @param before The toolbar item to insert before.
14782     * @param icon A string with icon name or the absolute path of an image file.
14783     * @param label The label of the item.
14784     * @param func The function to call when the item is clicked.
14785     * @param data The data to associate with the item for related callbacks.
14786     * @return The created item or @c NULL upon failure.
14787     *
14788     * A new item will be created and added to the toolbar. Its position in
14789     * this toolbar will be just before item @p before.
14790     *
14791     * Items created with this method can be deleted with
14792     * elm_toolbar_item_del().
14793     *
14794     * Associated @p data can be properly freed when item is deleted if a
14795     * callback function is set with elm_toolbar_item_del_cb_set().
14796     *
14797     * If a function is passed as argument, it will be called everytime this item
14798     * is selected, i.e., the user clicks over an unselected item.
14799     * If such function isn't needed, just passing
14800     * @c NULL as @p func is enough. The same should be done for @p data.
14801     *
14802     * Toolbar will load icon image from fdo or current theme.
14803     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14804     * If an absolute path is provided it will load it direct from a file.
14805     *
14806     * @see elm_toolbar_item_icon_set()
14807     * @see elm_toolbar_item_del()
14808     * @see elm_toolbar_item_del_cb_set()
14809     *
14810     * @ingroup Toolbar
14811     */
14812    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);
14813
14814    /**
14815     * Insert a new item into the toolbar object after item @p after.
14816     *
14817     * @param obj The toolbar object.
14818     * @param after The toolbar item to insert after.
14819     * @param icon A string with icon name or the absolute path of an image file.
14820     * @param label The label of the item.
14821     * @param func The function to call when the item is clicked.
14822     * @param data The data to associate with the item for related callbacks.
14823     * @return The created item or @c NULL upon failure.
14824     *
14825     * A new item will be created and added to the toolbar. Its position in
14826     * this toolbar will be just after item @p after.
14827     *
14828     * Items created with this method can be deleted with
14829     * elm_toolbar_item_del().
14830     *
14831     * Associated @p data can be properly freed when item is deleted if a
14832     * callback function is set with elm_toolbar_item_del_cb_set().
14833     *
14834     * If a function is passed as argument, it will be called everytime this item
14835     * is selected, i.e., the user clicks over an unselected item.
14836     * If such function isn't needed, just passing
14837     * @c NULL as @p func is enough. The same should be done for @p data.
14838     *
14839     * Toolbar will load icon image from fdo or current theme.
14840     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14841     * If an absolute path is provided it will load it direct from a file.
14842     *
14843     * @see elm_toolbar_item_icon_set()
14844     * @see elm_toolbar_item_del()
14845     * @see elm_toolbar_item_del_cb_set()
14846     *
14847     * @ingroup Toolbar
14848     */
14849    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);
14850
14851    /**
14852     * Get the first item in the given toolbar widget's list of
14853     * items.
14854     *
14855     * @param obj The toolbar object
14856     * @return The first item or @c NULL, if it has no items (and on
14857     * errors)
14858     *
14859     * @see elm_toolbar_item_append()
14860     * @see elm_toolbar_last_item_get()
14861     *
14862     * @ingroup Toolbar
14863     */
14864    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14865
14866    /**
14867     * Get the last item in the given toolbar widget's list of
14868     * items.
14869     *
14870     * @param obj The toolbar object
14871     * @return The last item or @c NULL, if it has no items (and on
14872     * errors)
14873     *
14874     * @see elm_toolbar_item_prepend()
14875     * @see elm_toolbar_first_item_get()
14876     *
14877     * @ingroup Toolbar
14878     */
14879    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14880
14881    /**
14882     * Get the item after @p item in toolbar.
14883     *
14884     * @param item The toolbar item.
14885     * @return The item after @p item, or @c NULL if none or on failure.
14886     *
14887     * @note If it is the last item, @c NULL will be returned.
14888     *
14889     * @see elm_toolbar_item_append()
14890     *
14891     * @ingroup Toolbar
14892     */
14893    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14894
14895    /**
14896     * Get the item before @p item in toolbar.
14897     *
14898     * @param item The toolbar item.
14899     * @return The item before @p item, or @c NULL if none or on failure.
14900     *
14901     * @note If it is the first item, @c NULL will be returned.
14902     *
14903     * @see elm_toolbar_item_prepend()
14904     *
14905     * @ingroup Toolbar
14906     */
14907    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14908
14909    /**
14910     * Get the toolbar object from an item.
14911     *
14912     * @param item The item.
14913     * @return The toolbar object.
14914     *
14915     * This returns the toolbar object itself that an item belongs to.
14916     *
14917     * @ingroup Toolbar
14918     */
14919    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14920
14921    /**
14922     * Set the priority of a toolbar item.
14923     *
14924     * @param item The toolbar item.
14925     * @param priority The item priority. The default is zero.
14926     *
14927     * This is used only when the toolbar shrink mode is set to
14928     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14929     * When space is less than required, items with low priority
14930     * will be removed from the toolbar and added to a dynamically-created menu,
14931     * while items with higher priority will remain on the toolbar,
14932     * with the same order they were added.
14933     *
14934     * @see elm_toolbar_item_priority_get()
14935     *
14936     * @ingroup Toolbar
14937     */
14938    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14939
14940    /**
14941     * Get the priority of a toolbar item.
14942     *
14943     * @param item The toolbar item.
14944     * @return The @p item priority, or @c 0 on failure.
14945     *
14946     * @see elm_toolbar_item_priority_set() for details.
14947     *
14948     * @ingroup Toolbar
14949     */
14950    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14951
14952    /**
14953     * Get the label of item.
14954     *
14955     * @param item The item of toolbar.
14956     * @return The label of item.
14957     *
14958     * The return value is a pointer to the label associated to @p item when
14959     * it was created, with function elm_toolbar_item_append() or similar,
14960     * or later,
14961     * with function elm_toolbar_item_label_set. If no label
14962     * was passed as argument, it will return @c NULL.
14963     *
14964     * @see elm_toolbar_item_label_set() for more details.
14965     * @see elm_toolbar_item_append()
14966     *
14967     * @ingroup Toolbar
14968     */
14969    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14970
14971    /**
14972     * Set the label of item.
14973     *
14974     * @param item The item of toolbar.
14975     * @param text The label of item.
14976     *
14977     * The label to be displayed by the item.
14978     * Label will be placed at icons bottom (if set).
14979     *
14980     * If a label was passed as argument on item creation, with function
14981     * elm_toolbar_item_append() or similar, it will be already
14982     * displayed by the item.
14983     *
14984     * @see elm_toolbar_item_label_get()
14985     * @see elm_toolbar_item_append()
14986     *
14987     * @ingroup Toolbar
14988     */
14989    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14990
14991    /**
14992     * Return the data associated with a given toolbar widget item.
14993     *
14994     * @param item The toolbar widget item handle.
14995     * @return The data associated with @p item.
14996     *
14997     * @see elm_toolbar_item_data_set()
14998     *
14999     * @ingroup Toolbar
15000     */
15001    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15002
15003    /**
15004     * Set the data associated with a given toolbar widget item.
15005     *
15006     * @param item The toolbar widget item handle.
15007     * @param data The new data pointer to set to @p item.
15008     *
15009     * This sets new item data on @p item.
15010     *
15011     * @warning The old data pointer won't be touched by this function, so
15012     * the user had better to free that old data himself/herself.
15013     *
15014     * @ingroup Toolbar
15015     */
15016    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
15017
15018    /**
15019     * Returns a pointer to a toolbar item by its label.
15020     *
15021     * @param obj The toolbar object.
15022     * @param label The label of the item to find.
15023     *
15024     * @return The pointer to the toolbar item matching @p label or @c NULL
15025     * on failure.
15026     *
15027     * @ingroup Toolbar
15028     */
15029    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15030
15031    /*
15032     * Get whether the @p item is selected or not.
15033     *
15034     * @param item The toolbar item.
15035     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15036     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15037     *
15038     * @see elm_toolbar_selected_item_set() for details.
15039     * @see elm_toolbar_item_selected_get()
15040     *
15041     * @ingroup Toolbar
15042     */
15043    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15044
15045    /**
15046     * Set the selected state of an item.
15047     *
15048     * @param item The toolbar item
15049     * @param selected The selected state
15050     *
15051     * This sets the selected state of the given item @p it.
15052     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15053     *
15054     * If a new item is selected the previosly selected will be unselected.
15055     * Previoulsy selected item can be get with function
15056     * elm_toolbar_selected_item_get().
15057     *
15058     * Selected items will be highlighted.
15059     *
15060     * @see elm_toolbar_item_selected_get()
15061     * @see elm_toolbar_selected_item_get()
15062     *
15063     * @ingroup Toolbar
15064     */
15065    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15066
15067    /**
15068     * Get the selected item.
15069     *
15070     * @param obj The toolbar object.
15071     * @return The selected toolbar item.
15072     *
15073     * The selected item can be unselected with function
15074     * elm_toolbar_item_selected_set().
15075     *
15076     * The selected item always will be highlighted on toolbar.
15077     *
15078     * @see elm_toolbar_selected_items_get()
15079     *
15080     * @ingroup Toolbar
15081     */
15082    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15083
15084    /**
15085     * Set the icon associated with @p item.
15086     *
15087     * @param obj The parent of this item.
15088     * @param item The toolbar item.
15089     * @param icon A string with icon name or the absolute path of an image file.
15090     *
15091     * Toolbar will load icon image from fdo or current theme.
15092     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15093     * If an absolute path is provided it will load it direct from a file.
15094     *
15095     * @see elm_toolbar_icon_order_lookup_set()
15096     * @see elm_toolbar_icon_order_lookup_get()
15097     *
15098     * @ingroup Toolbar
15099     */
15100    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15101
15102    /**
15103     * Get the string used to set the icon of @p item.
15104     *
15105     * @param item The toolbar item.
15106     * @return The string associated with the icon object.
15107     *
15108     * @see elm_toolbar_item_icon_set() for details.
15109     *
15110     * @ingroup Toolbar
15111     */
15112    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15113
15114    /**
15115     * Get the object of @p item.
15116     *
15117     * @param item The toolbar item.
15118     * @return The object
15119     *
15120     * @ingroup Toolbar
15121     */
15122    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15123
15124    /**
15125     * Get the icon object of @p item.
15126     *
15127     * @param item The toolbar item.
15128     * @return The icon object
15129     *
15130     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15131     *
15132     * @ingroup Toolbar
15133     */
15134    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15135
15136    /**
15137     * Set the icon associated with @p item to an image in a binary buffer.
15138     *
15139     * @param item The toolbar item.
15140     * @param img The binary data that will be used as an image
15141     * @param size The size of binary data @p img
15142     * @param format Optional format of @p img to pass to the image loader
15143     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15144     *
15145     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15146     *
15147     * @note The icon image set by this function can be changed by
15148     * elm_toolbar_item_icon_set().
15149     * 
15150     * @ingroup Toolbar
15151     */
15152    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);
15153
15154    /**
15155     * Delete them item from the toolbar.
15156     *
15157     * @param item The item of toolbar to be deleted.
15158     *
15159     * @see elm_toolbar_item_append()
15160     * @see elm_toolbar_item_del_cb_set()
15161     *
15162     * @ingroup Toolbar
15163     */
15164    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15165
15166    /**
15167     * Set the function called when a toolbar item is freed.
15168     *
15169     * @param item The item to set the callback on.
15170     * @param func The function called.
15171     *
15172     * If there is a @p func, then it will be called prior item's memory release.
15173     * That will be called with the following arguments:
15174     * @li item's data;
15175     * @li item's Evas object;
15176     * @li item itself;
15177     *
15178     * This way, a data associated to a toolbar item could be properly freed.
15179     *
15180     * @ingroup Toolbar
15181     */
15182    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15183
15184    /**
15185     * Get a value whether toolbar item is disabled or not.
15186     *
15187     * @param item The item.
15188     * @return The disabled state.
15189     *
15190     * @see elm_toolbar_item_disabled_set() for more details.
15191     *
15192     * @ingroup Toolbar
15193     */
15194    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15195
15196    /**
15197     * Sets the disabled/enabled state of a toolbar item.
15198     *
15199     * @param item The item.
15200     * @param disabled The disabled state.
15201     *
15202     * A disabled item cannot be selected or unselected. It will also
15203     * change its appearance (generally greyed out). This sets the
15204     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15205     * enabled).
15206     *
15207     * @ingroup Toolbar
15208     */
15209    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15210
15211    /**
15212     * Set or unset item as a separator.
15213     *
15214     * @param item The toolbar item.
15215     * @param setting @c EINA_TRUE to set item @p item as separator or
15216     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15217     *
15218     * Items aren't set as separator by default.
15219     *
15220     * If set as separator it will display separator theme, so won't display
15221     * icons or label.
15222     *
15223     * @see elm_toolbar_item_separator_get()
15224     *
15225     * @ingroup Toolbar
15226     */
15227    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15228
15229    /**
15230     * Get a value whether item is a separator or not.
15231     *
15232     * @param item The toolbar item.
15233     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15234     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15235     *
15236     * @see elm_toolbar_item_separator_set() for details.
15237     *
15238     * @ingroup Toolbar
15239     */
15240    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15241
15242    /**
15243     * Set the shrink state of toolbar @p obj.
15244     *
15245     * @param obj The toolbar object.
15246     * @param shrink_mode Toolbar's items display behavior.
15247     *
15248     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15249     * but will enforce a minimun size so all the items will fit, won't scroll
15250     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15251     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15252     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15253     *
15254     * @ingroup Toolbar
15255     */
15256    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15257
15258    /**
15259     * Get the shrink mode of toolbar @p obj.
15260     *
15261     * @param obj The toolbar object.
15262     * @return Toolbar's items display behavior.
15263     *
15264     * @see elm_toolbar_mode_shrink_set() for details.
15265     *
15266     * @ingroup Toolbar
15267     */
15268    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15269
15270    /**
15271     * Enable/disable homogenous mode.
15272     *
15273     * @param obj The toolbar object
15274     * @param homogeneous Assume the items within the toolbar are of the
15275     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15276     *
15277     * This will enable the homogeneous mode where items are of the same size.
15278     * @see elm_toolbar_homogeneous_get()
15279     *
15280     * @ingroup Toolbar
15281     */
15282    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15283
15284    /**
15285     * Get whether the homogenous mode is enabled.
15286     *
15287     * @param obj The toolbar object.
15288     * @return Assume the items within the toolbar are of the same height
15289     * and width (EINA_TRUE = on, EINA_FALSE = off).
15290     *
15291     * @see elm_toolbar_homogeneous_set()
15292     *
15293     * @ingroup Toolbar
15294     */
15295    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15296
15297    /**
15298     * Enable/disable homogenous mode.
15299     *
15300     * @param obj The toolbar object
15301     * @param homogeneous Assume the items within the toolbar are of the
15302     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15303     *
15304     * This will enable the homogeneous mode where items are of the same size.
15305     * @see elm_toolbar_homogeneous_get()
15306     *
15307     * @deprecated use elm_toolbar_homogeneous_set() instead.
15308     *
15309     * @ingroup Toolbar
15310     */
15311    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15312
15313    /**
15314     * Get whether the homogenous mode is enabled.
15315     *
15316     * @param obj The toolbar object.
15317     * @return Assume the items within the toolbar are of the same height
15318     * and width (EINA_TRUE = on, EINA_FALSE = off).
15319     *
15320     * @see elm_toolbar_homogeneous_set()
15321     * @deprecated use elm_toolbar_homogeneous_get() instead.
15322     *
15323     * @ingroup Toolbar
15324     */
15325    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15326
15327    /**
15328     * Set the parent object of the toolbar items' menus.
15329     *
15330     * @param obj The toolbar object.
15331     * @param parent The parent of the menu objects.
15332     *
15333     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15334     *
15335     * For more details about setting the parent for toolbar menus, see
15336     * elm_menu_parent_set().
15337     *
15338     * @see elm_menu_parent_set() for details.
15339     * @see elm_toolbar_item_menu_set() for details.
15340     *
15341     * @ingroup Toolbar
15342     */
15343    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15344
15345    /**
15346     * Get the parent object of the toolbar items' menus.
15347     *
15348     * @param obj The toolbar object.
15349     * @return The parent of the menu objects.
15350     *
15351     * @see elm_toolbar_menu_parent_set() for details.
15352     *
15353     * @ingroup Toolbar
15354     */
15355    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15356
15357    /**
15358     * Set the alignment of the items.
15359     *
15360     * @param obj The toolbar object.
15361     * @param align The new alignment, a float between <tt> 0.0 </tt>
15362     * and <tt> 1.0 </tt>.
15363     *
15364     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15365     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15366     * items.
15367     *
15368     * Centered items by default.
15369     *
15370     * @see elm_toolbar_align_get()
15371     *
15372     * @ingroup Toolbar
15373     */
15374    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15375
15376    /**
15377     * Get the alignment of the items.
15378     *
15379     * @param obj The toolbar object.
15380     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15381     * <tt> 1.0 </tt>.
15382     *
15383     * @see elm_toolbar_align_set() for details.
15384     *
15385     * @ingroup Toolbar
15386     */
15387    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15388
15389    /**
15390     * Set whether the toolbar item opens a menu.
15391     *
15392     * @param item The toolbar item.
15393     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15394     *
15395     * A toolbar item can be set to be a menu, using this function.
15396     *
15397     * Once it is set to be a menu, it can be manipulated through the
15398     * menu-like function elm_toolbar_menu_parent_set() and the other
15399     * elm_menu functions, using the Evas_Object @c menu returned by
15400     * elm_toolbar_item_menu_get().
15401     *
15402     * So, items to be displayed in this item's menu should be added with
15403     * elm_menu_item_add().
15404     *
15405     * The following code exemplifies the most basic usage:
15406     * @code
15407     * tb = elm_toolbar_add(win)
15408     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15409     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15410     * elm_toolbar_menu_parent_set(tb, win);
15411     * menu = elm_toolbar_item_menu_get(item);
15412     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15413     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15414     * NULL);
15415     * @endcode
15416     *
15417     * @see elm_toolbar_item_menu_get()
15418     *
15419     * @ingroup Toolbar
15420     */
15421    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15422
15423    /**
15424     * Get toolbar item's menu.
15425     *
15426     * @param item The toolbar item.
15427     * @return Item's menu object or @c NULL on failure.
15428     *
15429     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15430     * this function will set it.
15431     *
15432     * @see elm_toolbar_item_menu_set() for details.
15433     *
15434     * @ingroup Toolbar
15435     */
15436    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15437
15438    /**
15439     * Add a new state to @p item.
15440     *
15441     * @param item The item.
15442     * @param icon A string with icon name or the absolute path of an image file.
15443     * @param label The label of the new state.
15444     * @param func The function to call when the item is clicked when this
15445     * state is selected.
15446     * @param data The data to associate with the state.
15447     * @return The toolbar item state, or @c NULL upon failure.
15448     *
15449     * Toolbar will load icon image from fdo or current theme.
15450     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15451     * If an absolute path is provided it will load it direct from a file.
15452     *
15453     * States created with this function can be removed with
15454     * elm_toolbar_item_state_del().
15455     *
15456     * @see elm_toolbar_item_state_del()
15457     * @see elm_toolbar_item_state_sel()
15458     * @see elm_toolbar_item_state_get()
15459     *
15460     * @ingroup Toolbar
15461     */
15462    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);
15463
15464    /**
15465     * Delete a previoulsy added state to @p item.
15466     *
15467     * @param item The toolbar item.
15468     * @param state The state to be deleted.
15469     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15470     *
15471     * @see elm_toolbar_item_state_add()
15472     */
15473    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15474
15475    /**
15476     * Set @p state as the current state of @p it.
15477     *
15478     * @param it The item.
15479     * @param state The state to use.
15480     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15481     *
15482     * If @p state is @c NULL, it won't select any state and the default item's
15483     * icon and label will be used. It's the same behaviour than
15484     * elm_toolbar_item_state_unser().
15485     *
15486     * @see elm_toolbar_item_state_unset()
15487     *
15488     * @ingroup Toolbar
15489     */
15490    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15491
15492    /**
15493     * Unset the state of @p it.
15494     *
15495     * @param it The item.
15496     *
15497     * The default icon and label from this item will be displayed.
15498     *
15499     * @see elm_toolbar_item_state_set() for more details.
15500     *
15501     * @ingroup Toolbar
15502     */
15503    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15504
15505    /**
15506     * Get the current state of @p it.
15507     *
15508     * @param item The item.
15509     * @return The selected state or @c NULL if none is selected or on failure.
15510     *
15511     * @see elm_toolbar_item_state_set() for details.
15512     * @see elm_toolbar_item_state_unset()
15513     * @see elm_toolbar_item_state_add()
15514     *
15515     * @ingroup Toolbar
15516     */
15517    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15518
15519    /**
15520     * Get the state after selected state in toolbar's @p item.
15521     *
15522     * @param it The toolbar item to change state.
15523     * @return The state after current state, or @c NULL on failure.
15524     *
15525     * If last state is selected, this function will return first state.
15526     *
15527     * @see elm_toolbar_item_state_set()
15528     * @see elm_toolbar_item_state_add()
15529     *
15530     * @ingroup Toolbar
15531     */
15532    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15533
15534    /**
15535     * Get the state before selected state in toolbar's @p item.
15536     *
15537     * @param it The toolbar item to change state.
15538     * @return The state before current state, or @c NULL on failure.
15539     *
15540     * If first state is selected, this function will return last state.
15541     *
15542     * @see elm_toolbar_item_state_set()
15543     * @see elm_toolbar_item_state_add()
15544     *
15545     * @ingroup Toolbar
15546     */
15547    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15548
15549    /**
15550     * Set the text to be shown in a given toolbar item's tooltips.
15551     *
15552     * @param item Target item.
15553     * @param text The text to set in the content.
15554     *
15555     * Setup the text as tooltip to object. The item can have only one tooltip,
15556     * so any previous tooltip data - set with this function or
15557     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15558     *
15559     * @see elm_object_tooltip_text_set() for more details.
15560     *
15561     * @ingroup Toolbar
15562     */
15563    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15564
15565    /**
15566     * Set the content to be shown in the tooltip item.
15567     *
15568     * Setup the tooltip to item. The item can have only one tooltip,
15569     * so any previous tooltip data is removed. @p func(with @p data) will
15570     * be called every time that need show the tooltip and it should
15571     * return a valid Evas_Object. This object is then managed fully by
15572     * tooltip system and is deleted when the tooltip is gone.
15573     *
15574     * @param item the toolbar item being attached a tooltip.
15575     * @param func the function used to create the tooltip contents.
15576     * @param data what to provide to @a func as callback data/context.
15577     * @param del_cb called when data is not needed anymore, either when
15578     *        another callback replaces @a func, the tooltip is unset with
15579     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15580     *        dies. This callback receives as the first parameter the
15581     *        given @a data, and @c event_info is the item.
15582     *
15583     * @see elm_object_tooltip_content_cb_set() for more details.
15584     *
15585     * @ingroup Toolbar
15586     */
15587    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);
15588
15589    /**
15590     * Unset tooltip from item.
15591     *
15592     * @param item toolbar item to remove previously set tooltip.
15593     *
15594     * Remove tooltip from item. The callback provided as del_cb to
15595     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15596     * it is not used anymore.
15597     *
15598     * @see elm_object_tooltip_unset() for more details.
15599     * @see elm_toolbar_item_tooltip_content_cb_set()
15600     *
15601     * @ingroup Toolbar
15602     */
15603    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15604
15605    /**
15606     * Sets a different style for this item tooltip.
15607     *
15608     * @note before you set a style you should define a tooltip with
15609     *       elm_toolbar_item_tooltip_content_cb_set() or
15610     *       elm_toolbar_item_tooltip_text_set()
15611     *
15612     * @param item toolbar item with tooltip already set.
15613     * @param style the theme style to use (default, transparent, ...)
15614     *
15615     * @see elm_object_tooltip_style_set() for more details.
15616     *
15617     * @ingroup Toolbar
15618     */
15619    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15620
15621    /**
15622     * Get the style for this item tooltip.
15623     *
15624     * @param item toolbar item with tooltip already set.
15625     * @return style the theme style in use, defaults to "default". If the
15626     *         object does not have a tooltip set, then NULL is returned.
15627     *
15628     * @see elm_object_tooltip_style_get() for more details.
15629     * @see elm_toolbar_item_tooltip_style_set()
15630     *
15631     * @ingroup Toolbar
15632     */
15633    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15634
15635    /**
15636     * Set the type of mouse pointer/cursor decoration to be shown,
15637     * when the mouse pointer is over the given toolbar widget item
15638     *
15639     * @param item toolbar item to customize cursor on
15640     * @param cursor the cursor type's name
15641     *
15642     * This function works analogously as elm_object_cursor_set(), but
15643     * here the cursor's changing area is restricted to the item's
15644     * area, and not the whole widget's. Note that that item cursors
15645     * have precedence over widget cursors, so that a mouse over an
15646     * item with custom cursor set will always show @b that cursor.
15647     *
15648     * If this function is called twice for an object, a previously set
15649     * cursor will be unset on the second call.
15650     *
15651     * @see elm_object_cursor_set()
15652     * @see elm_toolbar_item_cursor_get()
15653     * @see elm_toolbar_item_cursor_unset()
15654     *
15655     * @ingroup Toolbar
15656     */
15657    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15658
15659    /*
15660     * Get the type of mouse pointer/cursor decoration set to be shown,
15661     * when the mouse pointer is over the given toolbar widget item
15662     *
15663     * @param item toolbar item with custom cursor set
15664     * @return the cursor type's name or @c NULL, if no custom cursors
15665     * were set to @p item (and on errors)
15666     *
15667     * @see elm_object_cursor_get()
15668     * @see elm_toolbar_item_cursor_set()
15669     * @see elm_toolbar_item_cursor_unset()
15670     *
15671     * @ingroup Toolbar
15672     */
15673    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15674
15675    /**
15676     * Unset any custom mouse pointer/cursor decoration set to be
15677     * shown, when the mouse pointer is over the given toolbar widget
15678     * item, thus making it show the @b default cursor again.
15679     *
15680     * @param item a toolbar item
15681     *
15682     * Use this call to undo any custom settings on this item's cursor
15683     * decoration, bringing it back to defaults (no custom style set).
15684     *
15685     * @see elm_object_cursor_unset()
15686     * @see elm_toolbar_item_cursor_set()
15687     *
15688     * @ingroup Toolbar
15689     */
15690    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15691
15692    /**
15693     * Set a different @b style for a given custom cursor set for a
15694     * toolbar item.
15695     *
15696     * @param item toolbar item with custom cursor set
15697     * @param style the <b>theme style</b> to use (e.g. @c "default",
15698     * @c "transparent", etc)
15699     *
15700     * This function only makes sense when one is using custom mouse
15701     * cursor decorations <b>defined in a theme file</b>, which can have,
15702     * given a cursor name/type, <b>alternate styles</b> on it. It
15703     * works analogously as elm_object_cursor_style_set(), but here
15704     * applyed only to toolbar item objects.
15705     *
15706     * @warning Before you set a cursor style you should have definen a
15707     *       custom cursor previously on the item, with
15708     *       elm_toolbar_item_cursor_set()
15709     *
15710     * @see elm_toolbar_item_cursor_engine_only_set()
15711     * @see elm_toolbar_item_cursor_style_get()
15712     *
15713     * @ingroup Toolbar
15714     */
15715    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15716
15717    /**
15718     * Get the current @b style set for a given toolbar item's custom
15719     * cursor
15720     *
15721     * @param item toolbar item with custom cursor set.
15722     * @return style the cursor style in use. If the object does not
15723     *         have a cursor set, then @c NULL is returned.
15724     *
15725     * @see elm_toolbar_item_cursor_style_set() for more details
15726     *
15727     * @ingroup Toolbar
15728     */
15729    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15730
15731    /**
15732     * Set if the (custom)cursor for a given toolbar item should be
15733     * searched in its theme, also, or should only rely on the
15734     * rendering engine.
15735     *
15736     * @param item item with custom (custom) cursor already set on
15737     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15738     * only on those provided by the rendering engine, @c EINA_FALSE to
15739     * have them searched on the widget's theme, as well.
15740     *
15741     * @note This call is of use only if you've set a custom cursor
15742     * for toolbar items, with elm_toolbar_item_cursor_set().
15743     *
15744     * @note By default, cursors will only be looked for between those
15745     * provided by the rendering engine.
15746     *
15747     * @ingroup Toolbar
15748     */
15749    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15750
15751    /**
15752     * Get if the (custom) cursor for a given toolbar item is being
15753     * searched in its theme, also, or is only relying on the rendering
15754     * engine.
15755     *
15756     * @param item a toolbar item
15757     * @return @c EINA_TRUE, if cursors are being looked for only on
15758     * those provided by the rendering engine, @c EINA_FALSE if they
15759     * are being searched on the widget's theme, as well.
15760     *
15761     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15762     *
15763     * @ingroup Toolbar
15764     */
15765    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15766
15767    /**
15768     * Change a toolbar's orientation
15769     * @param obj The toolbar object
15770     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15771     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15772     * @ingroup Toolbar
15773     * @deprecated use elm_toolbar_horizontal_set() instead.
15774     */
15775    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15776
15777    /**
15778     * Change a toolbar's orientation
15779     * @param obj The toolbar object
15780     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15781     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15782     * @ingroup Toolbar
15783     */
15784    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15785
15786    /**
15787     * Get a toolbar's orientation
15788     * @param obj The toolbar object
15789     * @return If @c EINA_TRUE, the toolbar is vertical
15790     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15791     * @ingroup Toolbar
15792     * @deprecated use elm_toolbar_horizontal_get() instead.
15793     */
15794    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15795
15796    /**
15797     * Get a toolbar's orientation
15798     * @param obj The toolbar object
15799     * @return If @c EINA_TRUE, the toolbar is horizontal
15800     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15801     * @ingroup Toolbar
15802     */
15803    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15804    /**
15805     * @}
15806     */
15807
15808    /**
15809     * @defgroup Tooltips Tooltips
15810     *
15811     * The Tooltip is an (internal, for now) smart object used to show a
15812     * content in a frame on mouse hover of objects(or widgets), with
15813     * tips/information about them.
15814     *
15815     * @{
15816     */
15817
15818    EAPI double       elm_tooltip_delay_get(void);
15819    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15820    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15821    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15822    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15823    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15824 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15825    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);
15826    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15827    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15828    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15829    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15830    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15831
15832    /**
15833     * @}
15834     */
15835
15836    /**
15837     * @defgroup Cursors Cursors
15838     *
15839     * The Elementary cursor is an internal smart object used to
15840     * customize the mouse cursor displayed over objects (or
15841     * widgets). In the most common scenario, the cursor decoration
15842     * comes from the graphical @b engine Elementary is running
15843     * on. Those engines may provide different decorations for cursors,
15844     * and Elementary provides functions to choose them (think of X11
15845     * cursors, as an example).
15846     *
15847     * There's also the possibility of, besides using engine provided
15848     * cursors, also use ones coming from Edje theming files. Both
15849     * globally and per widget, Elementary makes it possible for one to
15850     * make the cursors lookup to be held on engines only or on
15851     * Elementary's theme file, too. To set cursor's hot spot,
15852     * two data items should be added to cursor's theme: "hot_x" and
15853     * "hot_y", that are the offset from upper-left corner of the cursor
15854     * (coordinates 0,0).
15855     *
15856     * @{
15857     */
15858
15859    /**
15860     * Set the cursor to be shown when mouse is over the object
15861     *
15862     * Set the cursor that will be displayed when mouse is over the
15863     * object. The object can have only one cursor set to it, so if
15864     * this function is called twice for an object, the previous set
15865     * will be unset.
15866     * If using X cursors, a definition of all the valid cursor names
15867     * is listed on Elementary_Cursors.h. If an invalid name is set
15868     * the default cursor will be used.
15869     *
15870     * @param obj the object being set a cursor.
15871     * @param cursor the cursor name to be used.
15872     *
15873     * @ingroup Cursors
15874     */
15875    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15876
15877    /**
15878     * Get the cursor to be shown when mouse is over the object
15879     *
15880     * @param obj an object with cursor already set.
15881     * @return the cursor name.
15882     *
15883     * @ingroup Cursors
15884     */
15885    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15886
15887    /**
15888     * Unset cursor for object
15889     *
15890     * Unset cursor for object, and set the cursor to default if the mouse
15891     * was over this object.
15892     *
15893     * @param obj Target object
15894     * @see elm_object_cursor_set()
15895     *
15896     * @ingroup Cursors
15897     */
15898    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15899
15900    /**
15901     * Sets a different style for this object cursor.
15902     *
15903     * @note before you set a style you should define a cursor with
15904     *       elm_object_cursor_set()
15905     *
15906     * @param obj an object with cursor already set.
15907     * @param style the theme style to use (default, transparent, ...)
15908     *
15909     * @ingroup Cursors
15910     */
15911    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15912
15913    /**
15914     * Get the style for this object cursor.
15915     *
15916     * @param obj an object with cursor already set.
15917     * @return style the theme style in use, defaults to "default". If the
15918     *         object does not have a cursor set, then NULL is returned.
15919     *
15920     * @ingroup Cursors
15921     */
15922    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15923
15924    /**
15925     * Set if the cursor set should be searched on the theme or should use
15926     * the provided by the engine, only.
15927     *
15928     * @note before you set if should look on theme you should define a cursor
15929     * with elm_object_cursor_set(). By default it will only look for cursors
15930     * provided by the engine.
15931     *
15932     * @param obj an object with cursor already set.
15933     * @param engine_only boolean to define it cursors should be looked only
15934     * between the provided by the engine or searched on widget's theme as well.
15935     *
15936     * @ingroup Cursors
15937     */
15938    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15939
15940    /**
15941     * Get the cursor engine only usage for this object cursor.
15942     *
15943     * @param obj an object with cursor already set.
15944     * @return engine_only boolean to define it cursors should be
15945     * looked only between the provided by the engine or searched on
15946     * widget's theme as well. If the object does not have a cursor
15947     * set, then EINA_FALSE is returned.
15948     *
15949     * @ingroup Cursors
15950     */
15951    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15952
15953    /**
15954     * Get the configured cursor engine only usage
15955     *
15956     * This gets the globally configured exclusive usage of engine cursors.
15957     *
15958     * @return 1 if only engine cursors should be used
15959     * @ingroup Cursors
15960     */
15961    EAPI int          elm_cursor_engine_only_get(void);
15962
15963    /**
15964     * Set the configured cursor engine only usage
15965     *
15966     * This sets the globally configured exclusive usage of engine cursors.
15967     * It won't affect cursors set before changing this value.
15968     *
15969     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15970     * look for them on theme before.
15971     * @return EINA_TRUE if value is valid and setted (0 or 1)
15972     * @ingroup Cursors
15973     */
15974    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15975
15976    /**
15977     * @}
15978     */
15979
15980    /**
15981     * @defgroup Menu Menu
15982     *
15983     * @image html img/widget/menu/preview-00.png
15984     * @image latex img/widget/menu/preview-00.eps
15985     *
15986     * A menu is a list of items displayed above its parent. When the menu is
15987     * showing its parent is darkened. Each item can have a sub-menu. The menu
15988     * object can be used to display a menu on a right click event, in a toolbar,
15989     * anywhere.
15990     *
15991     * Signals that you can add callbacks for are:
15992     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15993     *             event_info is NULL.
15994     *
15995     * @see @ref tutorial_menu
15996     * @{
15997     */
15998    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15999    /**
16000     * @brief Add a new menu to the parent
16001     *
16002     * @param parent The parent object.
16003     * @return The new object or NULL if it cannot be created.
16004     */
16005    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16006    /**
16007     * @brief Set the parent for the given menu widget
16008     *
16009     * @param obj The menu object.
16010     * @param parent The new parent.
16011     */
16012    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16013    /**
16014     * @brief Get the parent for the given menu widget
16015     *
16016     * @param obj The menu object.
16017     * @return The parent.
16018     *
16019     * @see elm_menu_parent_set()
16020     */
16021    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16022    /**
16023     * @brief Move the menu to a new position
16024     *
16025     * @param obj The menu object.
16026     * @param x The new position.
16027     * @param y The new position.
16028     *
16029     * Sets the top-left position of the menu to (@p x,@p y).
16030     *
16031     * @note @p x and @p y coordinates are relative to parent.
16032     */
16033    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16034    /**
16035     * @brief Close a opened menu
16036     *
16037     * @param obj the menu object
16038     * @return void
16039     *
16040     * Hides the menu and all it's sub-menus.
16041     */
16042    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16043    /**
16044     * @brief Returns a list of @p item's items.
16045     *
16046     * @param obj The menu object
16047     * @return An Eina_List* of @p item's items
16048     */
16049    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16050    /**
16051     * @brief Get the Evas_Object of an Elm_Menu_Item
16052     *
16053     * @param item The menu item object.
16054     * @return The edje object containing the swallowed content
16055     *
16056     * @warning Don't manipulate this object!
16057     */
16058    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16059    /**
16060     * @brief Add an item at the end of the given menu widget
16061     *
16062     * @param obj The menu object.
16063     * @param parent The parent menu item (optional)
16064     * @param icon A icon display on the item. The icon will be destryed by the menu.
16065     * @param label The label of the item.
16066     * @param func Function called when the user select the item.
16067     * @param data Data sent by the callback.
16068     * @return Returns the new item.
16069     */
16070    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);
16071    /**
16072     * @brief Add an object swallowed in an item at the end of the given menu
16073     * widget
16074     *
16075     * @param obj The menu object.
16076     * @param parent The parent menu item (optional)
16077     * @param subobj The object to swallow
16078     * @param func Function called when the user select the item.
16079     * @param data Data sent by the callback.
16080     * @return Returns the new item.
16081     *
16082     * Add an evas object as an item to the menu.
16083     */
16084    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);
16085    /**
16086     * @brief Set the label of a menu item
16087     *
16088     * @param item The menu item object.
16089     * @param label The label to set for @p item
16090     *
16091     * @warning Don't use this funcion on items created with
16092     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16093     */
16094    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16095    /**
16096     * @brief Get the label of a menu item
16097     *
16098     * @param item The menu item object.
16099     * @return The label of @p item
16100     */
16101    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16102    /**
16103     * @brief Set the icon of a menu item to the standard icon with name @p icon
16104     *
16105     * @param item The menu item object.
16106     * @param icon The icon object to set for the content of @p item
16107     *
16108     * Once this icon is set, any previously set icon will be deleted.
16109     */
16110    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16111    /**
16112     * @brief Get the string representation from the icon of a menu item
16113     *
16114     * @param item The menu item object.
16115     * @return The string representation of @p item's icon or NULL
16116     *
16117     * @see elm_menu_item_object_icon_name_set()
16118     */
16119    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16120    /**
16121     * @brief Set the content object of a menu item
16122     *
16123     * @param item The menu item object
16124     * @param The content object or NULL
16125     * @return EINA_TRUE on success, else EINA_FALSE
16126     *
16127     * Use this function to change the object swallowed by a menu item, deleting
16128     * any previously swallowed object.
16129     */
16130    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16131    /**
16132     * @brief Get the content object of a menu item
16133     *
16134     * @param item The menu item object
16135     * @return The content object or NULL
16136     * @note If @p item was added with elm_menu_item_add_object, this
16137     * function will return the object passed, else it will return the
16138     * icon object.
16139     *
16140     * @see elm_menu_item_object_content_set()
16141     */
16142    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16143
16144    EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
16145      {
16146         elm_menu_item_object_icon_name_set(item, icon);
16147      }
16148
16149    EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16150      {
16151         return elm_menu_item_object_content_get(item);
16152      }
16153
16154    EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16155      {
16156         return elm_menu_item_object_icon_name_get(item);
16157      }
16158
16159    /**
16160     * @brief Set the selected state of @p item.
16161     *
16162     * @param item The menu item object.
16163     * @param selected The selected/unselected state of the item
16164     */
16165    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16166    /**
16167     * @brief Get the selected state of @p item.
16168     *
16169     * @param item The menu item object.
16170     * @return The selected/unselected state of the item
16171     *
16172     * @see elm_menu_item_selected_set()
16173     */
16174    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16175    /**
16176     * @brief Set the disabled state of @p item.
16177     *
16178     * @param item The menu item object.
16179     * @param disabled The enabled/disabled state of the item
16180     */
16181    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16182    /**
16183     * @brief Get the disabled state of @p item.
16184     *
16185     * @param item The menu item object.
16186     * @return The enabled/disabled state of the item
16187     *
16188     * @see elm_menu_item_disabled_set()
16189     */
16190    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16191    /**
16192     * @brief Add a separator item to menu @p obj under @p parent.
16193     *
16194     * @param obj The menu object
16195     * @param parent The item to add the separator under
16196     * @return The created item or NULL on failure
16197     *
16198     * This is item is a @ref Separator.
16199     */
16200    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16201    /**
16202     * @brief Returns whether @p item is a separator.
16203     *
16204     * @param item The item to check
16205     * @return If true, @p item is a separator
16206     *
16207     * @see elm_menu_item_separator_add()
16208     */
16209    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16210    /**
16211     * @brief Deletes an item from the menu.
16212     *
16213     * @param item The item to delete.
16214     *
16215     * @see elm_menu_item_add()
16216     */
16217    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16218    /**
16219     * @brief Set the function called when a menu item is deleted.
16220     *
16221     * @param item The item to set the callback on
16222     * @param func The function called
16223     *
16224     * @see elm_menu_item_add()
16225     * @see elm_menu_item_del()
16226     */
16227    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16228    /**
16229     * @brief Returns the data associated with menu item @p item.
16230     *
16231     * @param item The item
16232     * @return The data associated with @p item or NULL if none was set.
16233     *
16234     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16235     */
16236    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16237    /**
16238     * @brief Sets the data to be associated with menu item @p item.
16239     *
16240     * @param item The item
16241     * @param data The data to be associated with @p item
16242     */
16243    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16244    /**
16245     * @brief Returns a list of @p item's subitems.
16246     *
16247     * @param item The item
16248     * @return An Eina_List* of @p item's subitems
16249     *
16250     * @see elm_menu_add()
16251     */
16252    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16253    /**
16254     * @brief Get the position of a menu item
16255     *
16256     * @param item The menu item
16257     * @return The item's index
16258     *
16259     * This function returns the index position of a menu item in a menu.
16260     * For a sub-menu, this number is relative to the first item in the sub-menu.
16261     *
16262     * @note Index values begin with 0
16263     */
16264    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16265    /**
16266     * @brief @brief Return a menu item's owner menu
16267     *
16268     * @param item The menu item
16269     * @return The menu object owning @p item, or NULL on failure
16270     *
16271     * Use this function to get the menu object owning an item.
16272     */
16273    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16274    /**
16275     * @brief Get the selected item in the menu
16276     *
16277     * @param obj The menu object
16278     * @return The selected item, or NULL if none
16279     *
16280     * @see elm_menu_item_selected_get()
16281     * @see elm_menu_item_selected_set()
16282     */
16283    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16284    /**
16285     * @brief Get the last item in the menu
16286     *
16287     * @param obj The menu object
16288     * @return The last item, or NULL if none
16289     */
16290    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16291    /**
16292     * @brief Get the first item in the menu
16293     *
16294     * @param obj The menu object
16295     * @return The first item, or NULL if none
16296     */
16297    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16298    /**
16299     * @brief Get the next item in the menu.
16300     *
16301     * @param item The menu item object.
16302     * @return The item after it, or NULL if none
16303     */
16304    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16305    /**
16306     * @brief Get the previous item in the menu.
16307     *
16308     * @param item The menu item object.
16309     * @return The item before it, or NULL if none
16310     */
16311    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16312    /**
16313     * @}
16314     */
16315
16316    /**
16317     * @defgroup List List
16318     * @ingroup Elementary
16319     *
16320     * @image html img/widget/list/preview-00.png
16321     * @image latex img/widget/list/preview-00.eps width=\textwidth
16322     *
16323     * @image html img/list.png
16324     * @image latex img/list.eps width=\textwidth
16325     *
16326     * A list widget is a container whose children are displayed vertically or
16327     * horizontally, in order, and can be selected.
16328     * The list can accept only one or multiple items selection. Also has many
16329     * modes of items displaying.
16330     *
16331     * A list is a very simple type of list widget.  For more robust
16332     * lists, @ref Genlist should probably be used.
16333     *
16334     * Smart callbacks one can listen to:
16335     * - @c "activated" - The user has double-clicked or pressed
16336     *   (enter|return|spacebar) on an item. The @c event_info parameter
16337     *   is the item that was activated.
16338     * - @c "clicked,double" - The user has double-clicked an item.
16339     *   The @c event_info parameter is the item that was double-clicked.
16340     * - "selected" - when the user selected an item
16341     * - "unselected" - when the user unselected an item
16342     * - "longpressed" - an item in the list is long-pressed
16343     * - "edge,top" - the list is scrolled until the top edge
16344     * - "edge,bottom" - the list is scrolled until the bottom edge
16345     * - "edge,left" - the list is scrolled until the left edge
16346     * - "edge,right" - the list is scrolled until the right edge
16347     * - "language,changed" - the program's language changed
16348     *
16349     * Available styles for it:
16350     * - @c "default"
16351     *
16352     * List of examples:
16353     * @li @ref list_example_01
16354     * @li @ref list_example_02
16355     * @li @ref list_example_03
16356     */
16357
16358    /**
16359     * @addtogroup List
16360     * @{
16361     */
16362
16363    /**
16364     * @enum _Elm_List_Mode
16365     * @typedef Elm_List_Mode
16366     *
16367     * Set list's resize behavior, transverse axis scroll and
16368     * items cropping. See each mode's description for more details.
16369     *
16370     * @note Default value is #ELM_LIST_SCROLL.
16371     *
16372     * Values <b> don't </b> work as bitmask, only one can be choosen.
16373     *
16374     * @see elm_list_mode_set()
16375     * @see elm_list_mode_get()
16376     *
16377     * @ingroup List
16378     */
16379    typedef enum _Elm_List_Mode
16380      {
16381         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. */
16382         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). */
16383         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. */
16384         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. */
16385         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16386      } Elm_List_Mode;
16387
16388    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().  */
16389
16390    /**
16391     * Add a new list widget to the given parent Elementary
16392     * (container) object.
16393     *
16394     * @param parent The parent object.
16395     * @return a new list widget handle or @c NULL, on errors.
16396     *
16397     * This function inserts a new list widget on the canvas.
16398     *
16399     * @ingroup List
16400     */
16401    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16402
16403    /**
16404     * Starts the list.
16405     *
16406     * @param obj The list object
16407     *
16408     * @note Call before running show() on the list object.
16409     * @warning If not called, it won't display the list properly.
16410     *
16411     * @code
16412     * li = elm_list_add(win);
16413     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16414     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16415     * elm_list_go(li);
16416     * evas_object_show(li);
16417     * @endcode
16418     *
16419     * @ingroup List
16420     */
16421    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16422
16423    /**
16424     * Enable or disable multiple items selection on the list object.
16425     *
16426     * @param obj The list object
16427     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16428     * disable it.
16429     *
16430     * Disabled by default. If disabled, the user can select a single item of
16431     * the list each time. Selected items are highlighted on list.
16432     * If enabled, many items can be selected.
16433     *
16434     * If a selected item is selected again, it will be unselected.
16435     *
16436     * @see elm_list_multi_select_get()
16437     *
16438     * @ingroup List
16439     */
16440    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16441
16442    /**
16443     * Get a value whether multiple items selection is enabled or not.
16444     *
16445     * @see elm_list_multi_select_set() for details.
16446     *
16447     * @param obj The list object.
16448     * @return @c EINA_TRUE means multiple items selection is enabled.
16449     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16450     * @c EINA_FALSE is returned.
16451     *
16452     * @ingroup List
16453     */
16454    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16455
16456    /**
16457     * Set which mode to use for the list object.
16458     *
16459     * @param obj The list object
16460     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16461     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16462     *
16463     * Set list's resize behavior, transverse axis scroll and
16464     * items cropping. See each mode's description for more details.
16465     *
16466     * @note Default value is #ELM_LIST_SCROLL.
16467     *
16468     * Only one can be set, if a previous one was set, it will be changed
16469     * by the new mode set. Bitmask won't work as well.
16470     *
16471     * @see elm_list_mode_get()
16472     *
16473     * @ingroup List
16474     */
16475    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16476
16477    /**
16478     * Get the mode the list is at.
16479     *
16480     * @param obj The list object
16481     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16482     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16483     *
16484     * @note see elm_list_mode_set() for more information.
16485     *
16486     * @ingroup List
16487     */
16488    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16489
16490    /**
16491     * Enable or disable horizontal mode on the list object.
16492     *
16493     * @param obj The list object.
16494     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16495     * disable it, i.e., to enable vertical mode.
16496     *
16497     * @note Vertical mode is set by default.
16498     *
16499     * On horizontal mode items are displayed on list from left to right,
16500     * instead of from top to bottom. Also, the list will scroll horizontally.
16501     * Each item will presents left icon on top and right icon, or end, at
16502     * the bottom.
16503     *
16504     * @see elm_list_horizontal_get()
16505     *
16506     * @ingroup List
16507     */
16508    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16509
16510    /**
16511     * Get a value whether horizontal mode is enabled or not.
16512     *
16513     * @param obj The list object.
16514     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16515     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16516     * @c EINA_FALSE is returned.
16517     *
16518     * @see elm_list_horizontal_set() for details.
16519     *
16520     * @ingroup List
16521     */
16522    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16523
16524    /**
16525     * Enable or disable always select mode on the list object.
16526     *
16527     * @param obj The list object
16528     * @param always_select @c EINA_TRUE to enable always select mode or
16529     * @c EINA_FALSE to disable it.
16530     *
16531     * @note Always select mode is disabled by default.
16532     *
16533     * Default behavior of list items is to only call its callback function
16534     * the first time it's pressed, i.e., when it is selected. If a selected
16535     * item is pressed again, and multi-select is disabled, it won't call
16536     * this function (if multi-select is enabled it will unselect the item).
16537     *
16538     * If always select is enabled, it will call the callback function
16539     * everytime a item is pressed, so it will call when the item is selected,
16540     * and again when a selected item is pressed.
16541     *
16542     * @see elm_list_always_select_mode_get()
16543     * @see elm_list_multi_select_set()
16544     *
16545     * @ingroup List
16546     */
16547    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16548
16549    /**
16550     * Get a value whether always select mode is enabled or not, meaning that
16551     * an item will always call its callback function, even if already selected.
16552     *
16553     * @param obj The list object
16554     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16555     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16556     * @c EINA_FALSE is returned.
16557     *
16558     * @see elm_list_always_select_mode_set() for details.
16559     *
16560     * @ingroup List
16561     */
16562    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16563
16564    /**
16565     * Set bouncing behaviour when the scrolled content reaches an edge.
16566     *
16567     * Tell the internal scroller object whether it should bounce or not
16568     * when it reaches the respective edges for each axis.
16569     *
16570     * @param obj The list object
16571     * @param h_bounce Whether to bounce or not in the horizontal axis.
16572     * @param v_bounce Whether to bounce or not in the vertical axis.
16573     *
16574     * @see elm_scroller_bounce_set()
16575     *
16576     * @ingroup List
16577     */
16578    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16579
16580    /**
16581     * Get the bouncing behaviour of the internal scroller.
16582     *
16583     * Get whether the internal scroller should bounce when the edge of each
16584     * axis is reached scrolling.
16585     *
16586     * @param obj The list object.
16587     * @param h_bounce Pointer where to store the bounce state of the horizontal
16588     * axis.
16589     * @param v_bounce Pointer where to store the bounce state of the vertical
16590     * axis.
16591     *
16592     * @see elm_scroller_bounce_get()
16593     * @see elm_list_bounce_set()
16594     *
16595     * @ingroup List
16596     */
16597    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16598
16599    /**
16600     * Set the scrollbar policy.
16601     *
16602     * @param obj The list object
16603     * @param policy_h Horizontal scrollbar policy.
16604     * @param policy_v Vertical scrollbar policy.
16605     *
16606     * This sets the scrollbar visibility policy for the given scroller.
16607     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16608     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16609     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16610     * This applies respectively for the horizontal and vertical scrollbars.
16611     *
16612     * The both are disabled by default, i.e., are set to
16613     * #ELM_SCROLLER_POLICY_OFF.
16614     *
16615     * @ingroup List
16616     */
16617    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16618
16619    /**
16620     * Get the scrollbar policy.
16621     *
16622     * @see elm_list_scroller_policy_get() for details.
16623     *
16624     * @param obj The list object.
16625     * @param policy_h Pointer where to store horizontal scrollbar policy.
16626     * @param policy_v Pointer where to store vertical scrollbar policy.
16627     *
16628     * @ingroup List
16629     */
16630    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);
16631
16632    /**
16633     * Append a new item to the list object.
16634     *
16635     * @param obj The list object.
16636     * @param label The label of the list item.
16637     * @param icon The icon object to use for the left side of the item. An
16638     * icon can be any Evas object, but usually it is an icon created
16639     * with elm_icon_add().
16640     * @param end The icon object to use for the right side of the item. An
16641     * icon can be any Evas object.
16642     * @param func The function to call when the item is clicked.
16643     * @param data The data to associate with the item for related callbacks.
16644     *
16645     * @return The created item or @c NULL upon failure.
16646     *
16647     * A new item will be created and appended to the list, i.e., will
16648     * be set as @b last item.
16649     *
16650     * Items created with this method can be deleted with
16651     * elm_list_item_del().
16652     *
16653     * Associated @p data can be properly freed when item is deleted if a
16654     * callback function is set with elm_list_item_del_cb_set().
16655     *
16656     * If a function is passed as argument, it will be called everytime this item
16657     * is selected, i.e., the user clicks over an unselected item.
16658     * If always select is enabled it will call this function every time
16659     * user clicks over an item (already selected or not).
16660     * If such function isn't needed, just passing
16661     * @c NULL as @p func is enough. The same should be done for @p data.
16662     *
16663     * Simple example (with no function callback or data associated):
16664     * @code
16665     * li = elm_list_add(win);
16666     * ic = elm_icon_add(win);
16667     * elm_icon_file_set(ic, "path/to/image", NULL);
16668     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16669     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16670     * elm_list_go(li);
16671     * evas_object_show(li);
16672     * @endcode
16673     *
16674     * @see elm_list_always_select_mode_set()
16675     * @see elm_list_item_del()
16676     * @see elm_list_item_del_cb_set()
16677     * @see elm_list_clear()
16678     * @see elm_icon_add()
16679     *
16680     * @ingroup List
16681     */
16682    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);
16683
16684    /**
16685     * Prepend a new item to the list object.
16686     *
16687     * @param obj The list object.
16688     * @param label The label of the list item.
16689     * @param icon The icon object to use for the left side of the item. An
16690     * icon can be any Evas object, but usually it is an icon created
16691     * with elm_icon_add().
16692     * @param end The icon object to use for the right side of the item. An
16693     * icon can be any Evas object.
16694     * @param func The function to call when the item is clicked.
16695     * @param data The data to associate with the item for related callbacks.
16696     *
16697     * @return The created item or @c NULL upon failure.
16698     *
16699     * A new item will be created and prepended to the list, i.e., will
16700     * be set as @b first item.
16701     *
16702     * Items created with this method can be deleted with
16703     * elm_list_item_del().
16704     *
16705     * Associated @p data can be properly freed when item is deleted if a
16706     * callback function is set with elm_list_item_del_cb_set().
16707     *
16708     * If a function is passed as argument, it will be called everytime this item
16709     * is selected, i.e., the user clicks over an unselected item.
16710     * If always select is enabled it will call this function every time
16711     * user clicks over an item (already selected or not).
16712     * If such function isn't needed, just passing
16713     * @c NULL as @p func is enough. The same should be done for @p data.
16714     *
16715     * @see elm_list_item_append() for a simple code example.
16716     * @see elm_list_always_select_mode_set()
16717     * @see elm_list_item_del()
16718     * @see elm_list_item_del_cb_set()
16719     * @see elm_list_clear()
16720     * @see elm_icon_add()
16721     *
16722     * @ingroup List
16723     */
16724    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);
16725
16726    /**
16727     * Insert a new item into the list object before item @p before.
16728     *
16729     * @param obj The list object.
16730     * @param before The list item to insert before.
16731     * @param label The label of the list item.
16732     * @param icon The icon object to use for the left side of the item. An
16733     * icon can be any Evas object, but usually it is an icon created
16734     * with elm_icon_add().
16735     * @param end The icon object to use for the right side of the item. An
16736     * icon can be any Evas object.
16737     * @param func The function to call when the item is clicked.
16738     * @param data The data to associate with the item for related callbacks.
16739     *
16740     * @return The created item or @c NULL upon failure.
16741     *
16742     * A new item will be created and added to the list. Its position in
16743     * this list will be just before item @p before.
16744     *
16745     * Items created with this method can be deleted with
16746     * elm_list_item_del().
16747     *
16748     * Associated @p data can be properly freed when item is deleted if a
16749     * callback function is set with elm_list_item_del_cb_set().
16750     *
16751     * If a function is passed as argument, it will be called everytime this item
16752     * is selected, i.e., the user clicks over an unselected item.
16753     * If always select is enabled it will call this function every time
16754     * user clicks over an item (already selected or not).
16755     * If such function isn't needed, just passing
16756     * @c NULL as @p func is enough. The same should be done for @p data.
16757     *
16758     * @see elm_list_item_append() for a simple code example.
16759     * @see elm_list_always_select_mode_set()
16760     * @see elm_list_item_del()
16761     * @see elm_list_item_del_cb_set()
16762     * @see elm_list_clear()
16763     * @see elm_icon_add()
16764     *
16765     * @ingroup List
16766     */
16767    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);
16768
16769    /**
16770     * Insert a new item into the list object after item @p after.
16771     *
16772     * @param obj The list object.
16773     * @param after The list item to insert after.
16774     * @param label The label of the list item.
16775     * @param icon The icon object to use for the left side of the item. An
16776     * icon can be any Evas object, but usually it is an icon created
16777     * with elm_icon_add().
16778     * @param end The icon object to use for the right side of the item. An
16779     * icon can be any Evas object.
16780     * @param func The function to call when the item is clicked.
16781     * @param data The data to associate with the item for related callbacks.
16782     *
16783     * @return The created item or @c NULL upon failure.
16784     *
16785     * A new item will be created and added to the list. Its position in
16786     * this list will be just after item @p after.
16787     *
16788     * Items created with this method can be deleted with
16789     * elm_list_item_del().
16790     *
16791     * Associated @p data can be properly freed when item is deleted if a
16792     * callback function is set with elm_list_item_del_cb_set().
16793     *
16794     * If a function is passed as argument, it will be called everytime this item
16795     * is selected, i.e., the user clicks over an unselected item.
16796     * If always select is enabled it will call this function every time
16797     * user clicks over an item (already selected or not).
16798     * If such function isn't needed, just passing
16799     * @c NULL as @p func is enough. The same should be done for @p data.
16800     *
16801     * @see elm_list_item_append() for a simple code example.
16802     * @see elm_list_always_select_mode_set()
16803     * @see elm_list_item_del()
16804     * @see elm_list_item_del_cb_set()
16805     * @see elm_list_clear()
16806     * @see elm_icon_add()
16807     *
16808     * @ingroup List
16809     */
16810    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);
16811
16812    /**
16813     * Insert a new item into the sorted list object.
16814     *
16815     * @param obj The list object.
16816     * @param label The label of the list item.
16817     * @param icon The icon object to use for the left side of the item. An
16818     * icon can be any Evas object, but usually it is an icon created
16819     * with elm_icon_add().
16820     * @param end The icon object to use for the right side of the item. An
16821     * icon can be any Evas object.
16822     * @param func The function to call when the item is clicked.
16823     * @param data The data to associate with the item for related callbacks.
16824     * @param cmp_func The comparing function to be used to sort list
16825     * items <b>by #Elm_List_Item item handles</b>. This function will
16826     * receive two items and compare them, returning a non-negative integer
16827     * if the second item should be place after the first, or negative value
16828     * if should be placed before.
16829     *
16830     * @return The created item or @c NULL upon failure.
16831     *
16832     * @note This function inserts values into a list object assuming it was
16833     * sorted and the result will be sorted.
16834     *
16835     * A new item will be created and added to the list. Its position in
16836     * this list will be found comparing the new item with previously inserted
16837     * items using function @p cmp_func.
16838     *
16839     * Items created with this method can be deleted with
16840     * elm_list_item_del().
16841     *
16842     * Associated @p data can be properly freed when item is deleted if a
16843     * callback function is set with elm_list_item_del_cb_set().
16844     *
16845     * If a function is passed as argument, it will be called everytime this item
16846     * is selected, i.e., the user clicks over an unselected item.
16847     * If always select is enabled it will call this function every time
16848     * user clicks over an item (already selected or not).
16849     * If such function isn't needed, just passing
16850     * @c NULL as @p func is enough. The same should be done for @p data.
16851     *
16852     * @see elm_list_item_append() for a simple code example.
16853     * @see elm_list_always_select_mode_set()
16854     * @see elm_list_item_del()
16855     * @see elm_list_item_del_cb_set()
16856     * @see elm_list_clear()
16857     * @see elm_icon_add()
16858     *
16859     * @ingroup List
16860     */
16861    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);
16862
16863    /**
16864     * Remove all list's items.
16865     *
16866     * @param obj The list object
16867     *
16868     * @see elm_list_item_del()
16869     * @see elm_list_item_append()
16870     *
16871     * @ingroup List
16872     */
16873    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16874
16875    /**
16876     * Get a list of all the list items.
16877     *
16878     * @param obj The list object
16879     * @return An @c Eina_List of list items, #Elm_List_Item,
16880     * or @c NULL on failure.
16881     *
16882     * @see elm_list_item_append()
16883     * @see elm_list_item_del()
16884     * @see elm_list_clear()
16885     *
16886     * @ingroup List
16887     */
16888    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16889
16890    /**
16891     * Get the selected item.
16892     *
16893     * @param obj The list object.
16894     * @return The selected list item.
16895     *
16896     * The selected item can be unselected with function
16897     * elm_list_item_selected_set().
16898     *
16899     * The selected item always will be highlighted on list.
16900     *
16901     * @see elm_list_selected_items_get()
16902     *
16903     * @ingroup List
16904     */
16905    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16906
16907    /**
16908     * Return a list of the currently selected list items.
16909     *
16910     * @param obj The list object.
16911     * @return An @c Eina_List of list items, #Elm_List_Item,
16912     * or @c NULL on failure.
16913     *
16914     * Multiple items can be selected if multi select is enabled. It can be
16915     * done with elm_list_multi_select_set().
16916     *
16917     * @see elm_list_selected_item_get()
16918     * @see elm_list_multi_select_set()
16919     *
16920     * @ingroup List
16921     */
16922    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16923
16924    /**
16925     * Set the selected state of an item.
16926     *
16927     * @param item The list item
16928     * @param selected The selected state
16929     *
16930     * This sets the selected state of the given item @p it.
16931     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16932     *
16933     * If a new item is selected the previosly selected will be unselected,
16934     * unless multiple selection is enabled with elm_list_multi_select_set().
16935     * Previoulsy selected item can be get with function
16936     * elm_list_selected_item_get().
16937     *
16938     * Selected items will be highlighted.
16939     *
16940     * @see elm_list_item_selected_get()
16941     * @see elm_list_selected_item_get()
16942     * @see elm_list_multi_select_set()
16943     *
16944     * @ingroup List
16945     */
16946    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16947
16948    /*
16949     * Get whether the @p item is selected or not.
16950     *
16951     * @param item The list item.
16952     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16953     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16954     *
16955     * @see elm_list_selected_item_set() for details.
16956     * @see elm_list_item_selected_get()
16957     *
16958     * @ingroup List
16959     */
16960    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16961
16962    /**
16963     * Set or unset item as a separator.
16964     *
16965     * @param it The list item.
16966     * @param setting @c EINA_TRUE to set item @p it as separator or
16967     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16968     *
16969     * Items aren't set as separator by default.
16970     *
16971     * If set as separator it will display separator theme, so won't display
16972     * icons or label.
16973     *
16974     * @see elm_list_item_separator_get()
16975     *
16976     * @ingroup List
16977     */
16978    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16979
16980    /**
16981     * Get a value whether item is a separator or not.
16982     *
16983     * @see elm_list_item_separator_set() for details.
16984     *
16985     * @param it The list item.
16986     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16987     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16988     *
16989     * @ingroup List
16990     */
16991    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16992
16993    /**
16994     * Show @p item in the list view.
16995     *
16996     * @param item The list item to be shown.
16997     *
16998     * It won't animate list until item is visible. If such behavior is wanted,
16999     * use elm_list_bring_in() intead.
17000     *
17001     * @ingroup List
17002     */
17003    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17004
17005    /**
17006     * Bring in the given item to list view.
17007     *
17008     * @param item The item.
17009     *
17010     * This causes list to jump to the given item @p item and show it
17011     * (by scrolling), if it is not fully visible.
17012     *
17013     * This may use animation to do so and take a period of time.
17014     *
17015     * If animation isn't wanted, elm_list_item_show() can be used.
17016     *
17017     * @ingroup List
17018     */
17019    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17020
17021    /**
17022     * Delete them item from the list.
17023     *
17024     * @param item The item of list to be deleted.
17025     *
17026     * If deleting all list items is required, elm_list_clear()
17027     * should be used instead of getting items list and deleting each one.
17028     *
17029     * @see elm_list_clear()
17030     * @see elm_list_item_append()
17031     * @see elm_list_item_del_cb_set()
17032     *
17033     * @ingroup List
17034     */
17035    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17036
17037    /**
17038     * Set the function called when a list item is freed.
17039     *
17040     * @param item The item to set the callback on
17041     * @param func The function called
17042     *
17043     * If there is a @p func, then it will be called prior item's memory release.
17044     * That will be called with the following arguments:
17045     * @li item's data;
17046     * @li item's Evas object;
17047     * @li item itself;
17048     *
17049     * This way, a data associated to a list item could be properly freed.
17050     *
17051     * @ingroup List
17052     */
17053    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17054
17055    /**
17056     * Get the data associated to the item.
17057     *
17058     * @param item The list item
17059     * @return The data associated to @p item
17060     *
17061     * The return value is a pointer to data associated to @p item when it was
17062     * created, with function elm_list_item_append() or similar. If no data
17063     * was passed as argument, it will return @c NULL.
17064     *
17065     * @see elm_list_item_append()
17066     *
17067     * @ingroup List
17068     */
17069    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17070
17071    /**
17072     * Get the left side icon associated to the item.
17073     *
17074     * @param item The list item
17075     * @return The left side icon associated to @p item
17076     *
17077     * The return value is a pointer to the icon associated to @p item when
17078     * it was
17079     * created, with function elm_list_item_append() or similar, or later
17080     * with function elm_list_item_icon_set(). If no icon
17081     * was passed as argument, it will return @c NULL.
17082     *
17083     * @see elm_list_item_append()
17084     * @see elm_list_item_icon_set()
17085     *
17086     * @ingroup List
17087     */
17088    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17089
17090    /**
17091     * Set the left side icon associated to the item.
17092     *
17093     * @param item The list item
17094     * @param icon The left side icon object to associate with @p item
17095     *
17096     * The icon object to use at left side of the item. An
17097     * icon can be any Evas object, but usually it is an icon created
17098     * with elm_icon_add().
17099     *
17100     * Once the icon object is set, a previously set one will be deleted.
17101     * @warning Setting the same icon for two items will cause the icon to
17102     * dissapear from the first item.
17103     *
17104     * If an icon was passed as argument on item creation, with function
17105     * elm_list_item_append() or similar, it will be already
17106     * associated to the item.
17107     *
17108     * @see elm_list_item_append()
17109     * @see elm_list_item_icon_get()
17110     *
17111     * @ingroup List
17112     */
17113    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17114
17115    /**
17116     * Get the right side icon associated to the item.
17117     *
17118     * @param item The list item
17119     * @return The right side icon associated to @p item
17120     *
17121     * The return value is a pointer to the icon associated to @p item when
17122     * it was
17123     * created, with function elm_list_item_append() or similar, or later
17124     * with function elm_list_item_icon_set(). If no icon
17125     * was passed as argument, it will return @c NULL.
17126     *
17127     * @see elm_list_item_append()
17128     * @see elm_list_item_icon_set()
17129     *
17130     * @ingroup List
17131     */
17132    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17133
17134    /**
17135     * Set the right side icon associated to the item.
17136     *
17137     * @param item The list item
17138     * @param end The right side icon object to associate with @p item
17139     *
17140     * The icon object to use at right side of the item. An
17141     * icon can be any Evas object, but usually it is an icon created
17142     * with elm_icon_add().
17143     *
17144     * Once the icon object is set, a previously set one will be deleted.
17145     * @warning Setting the same icon for two items will cause the icon to
17146     * dissapear from the first item.
17147     *
17148     * If an icon was passed as argument on item creation, with function
17149     * elm_list_item_append() or similar, it will be already
17150     * associated to the item.
17151     *
17152     * @see elm_list_item_append()
17153     * @see elm_list_item_end_get()
17154     *
17155     * @ingroup List
17156     */
17157    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17158
17159    /**
17160     * Gets the base object of the item.
17161     *
17162     * @param item The list item
17163     * @return The base object associated with @p item
17164     *
17165     * Base object is the @c Evas_Object that represents that item.
17166     *
17167     * @ingroup List
17168     */
17169    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17170    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17171
17172    /**
17173     * Get the label of item.
17174     *
17175     * @param item The item of list.
17176     * @return The label of item.
17177     *
17178     * The return value is a pointer to the label associated to @p item when
17179     * it was created, with function elm_list_item_append(), or later
17180     * with function elm_list_item_label_set. If no label
17181     * was passed as argument, it will return @c NULL.
17182     *
17183     * @see elm_list_item_label_set() for more details.
17184     * @see elm_list_item_append()
17185     *
17186     * @ingroup List
17187     */
17188    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17189
17190    /**
17191     * Set the label of item.
17192     *
17193     * @param item The item of list.
17194     * @param text The label of item.
17195     *
17196     * The label to be displayed by the item.
17197     * Label will be placed between left and right side icons (if set).
17198     *
17199     * If a label was passed as argument on item creation, with function
17200     * elm_list_item_append() or similar, it will be already
17201     * displayed by the item.
17202     *
17203     * @see elm_list_item_label_get()
17204     * @see elm_list_item_append()
17205     *
17206     * @ingroup List
17207     */
17208    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17209
17210
17211    /**
17212     * Get the item before @p it in list.
17213     *
17214     * @param it The list item.
17215     * @return The item before @p it, or @c NULL if none or on failure.
17216     *
17217     * @note If it is the first item, @c NULL will be returned.
17218     *
17219     * @see elm_list_item_append()
17220     * @see elm_list_items_get()
17221     *
17222     * @ingroup List
17223     */
17224    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17225
17226    /**
17227     * Get the item after @p it in list.
17228     *
17229     * @param it The list item.
17230     * @return The item after @p it, or @c NULL if none or on failure.
17231     *
17232     * @note If it is the last item, @c NULL will be returned.
17233     *
17234     * @see elm_list_item_append()
17235     * @see elm_list_items_get()
17236     *
17237     * @ingroup List
17238     */
17239    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17240
17241    /**
17242     * Sets the disabled/enabled state of a list item.
17243     *
17244     * @param it The item.
17245     * @param disabled The disabled state.
17246     *
17247     * A disabled item cannot be selected or unselected. It will also
17248     * change its appearance (generally greyed out). This sets the
17249     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17250     * enabled).
17251     *
17252     * @ingroup List
17253     */
17254    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17255
17256    /**
17257     * Get a value whether list item is disabled or not.
17258     *
17259     * @param it The item.
17260     * @return The disabled state.
17261     *
17262     * @see elm_list_item_disabled_set() for more details.
17263     *
17264     * @ingroup List
17265     */
17266    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17267
17268    /**
17269     * Set the text to be shown in a given list item's tooltips.
17270     *
17271     * @param item Target item.
17272     * @param text The text to set in the content.
17273     *
17274     * Setup the text as tooltip to object. The item can have only one tooltip,
17275     * so any previous tooltip data - set with this function or
17276     * elm_list_item_tooltip_content_cb_set() - is removed.
17277     *
17278     * @see elm_object_tooltip_text_set() for more details.
17279     *
17280     * @ingroup List
17281     */
17282    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17283
17284
17285    /**
17286     * @brief Disable size restrictions on an object's tooltip
17287     * @param item The tooltip's anchor object
17288     * @param disable If EINA_TRUE, size restrictions are disabled
17289     * @return EINA_FALSE on failure, EINA_TRUE on success
17290     *
17291     * This function allows a tooltip to expand beyond its parant window's canvas.
17292     * It will instead be limited only by the size of the display.
17293     */
17294    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17295    /**
17296     * @brief Retrieve size restriction state of an object's tooltip
17297     * @param obj The tooltip's anchor object
17298     * @return If EINA_TRUE, size restrictions are disabled
17299     *
17300     * This function returns whether a tooltip is allowed to expand beyond
17301     * its parant window's canvas.
17302     * It will instead be limited only by the size of the display.
17303     */
17304    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17305
17306    /**
17307     * Set the content to be shown in the tooltip item.
17308     *
17309     * Setup the tooltip to item. The item can have only one tooltip,
17310     * so any previous tooltip data is removed. @p func(with @p data) will
17311     * be called every time that need show the tooltip and it should
17312     * return a valid Evas_Object. This object is then managed fully by
17313     * tooltip system and is deleted when the tooltip is gone.
17314     *
17315     * @param item the list item being attached a tooltip.
17316     * @param func the function used to create the tooltip contents.
17317     * @param data what to provide to @a func as callback data/context.
17318     * @param del_cb called when data is not needed anymore, either when
17319     *        another callback replaces @a func, the tooltip is unset with
17320     *        elm_list_item_tooltip_unset() or the owner @a item
17321     *        dies. This callback receives as the first parameter the
17322     *        given @a data, and @c event_info is the item.
17323     *
17324     * @see elm_object_tooltip_content_cb_set() for more details.
17325     *
17326     * @ingroup List
17327     */
17328    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);
17329
17330    /**
17331     * Unset tooltip from item.
17332     *
17333     * @param item list item to remove previously set tooltip.
17334     *
17335     * Remove tooltip from item. The callback provided as del_cb to
17336     * elm_list_item_tooltip_content_cb_set() will be called to notify
17337     * it is not used anymore.
17338     *
17339     * @see elm_object_tooltip_unset() for more details.
17340     * @see elm_list_item_tooltip_content_cb_set()
17341     *
17342     * @ingroup List
17343     */
17344    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17345
17346    /**
17347     * Sets a different style for this item tooltip.
17348     *
17349     * @note before you set a style you should define a tooltip with
17350     *       elm_list_item_tooltip_content_cb_set() or
17351     *       elm_list_item_tooltip_text_set()
17352     *
17353     * @param item list item with tooltip already set.
17354     * @param style the theme style to use (default, transparent, ...)
17355     *
17356     * @see elm_object_tooltip_style_set() for more details.
17357     *
17358     * @ingroup List
17359     */
17360    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17361
17362    /**
17363     * Get the style for this item tooltip.
17364     *
17365     * @param item list item with tooltip already set.
17366     * @return style the theme style in use, defaults to "default". If the
17367     *         object does not have a tooltip set, then NULL is returned.
17368     *
17369     * @see elm_object_tooltip_style_get() for more details.
17370     * @see elm_list_item_tooltip_style_set()
17371     *
17372     * @ingroup List
17373     */
17374    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17375
17376    /**
17377     * Set the type of mouse pointer/cursor decoration to be shown,
17378     * when the mouse pointer is over the given list widget item
17379     *
17380     * @param item list item to customize cursor on
17381     * @param cursor the cursor type's name
17382     *
17383     * This function works analogously as elm_object_cursor_set(), but
17384     * here the cursor's changing area is restricted to the item's
17385     * area, and not the whole widget's. Note that that item cursors
17386     * have precedence over widget cursors, so that a mouse over an
17387     * item with custom cursor set will always show @b that cursor.
17388     *
17389     * If this function is called twice for an object, a previously set
17390     * cursor will be unset on the second call.
17391     *
17392     * @see elm_object_cursor_set()
17393     * @see elm_list_item_cursor_get()
17394     * @see elm_list_item_cursor_unset()
17395     *
17396     * @ingroup List
17397     */
17398    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17399
17400    /*
17401     * Get the type of mouse pointer/cursor decoration set to be shown,
17402     * when the mouse pointer is over the given list widget item
17403     *
17404     * @param item list item with custom cursor set
17405     * @return the cursor type's name or @c NULL, if no custom cursors
17406     * were set to @p item (and on errors)
17407     *
17408     * @see elm_object_cursor_get()
17409     * @see elm_list_item_cursor_set()
17410     * @see elm_list_item_cursor_unset()
17411     *
17412     * @ingroup List
17413     */
17414    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17415
17416    /**
17417     * Unset any custom mouse pointer/cursor decoration set to be
17418     * shown, when the mouse pointer is over the given list widget
17419     * item, thus making it show the @b default cursor again.
17420     *
17421     * @param item a list item
17422     *
17423     * Use this call to undo any custom settings on this item's cursor
17424     * decoration, bringing it back to defaults (no custom style set).
17425     *
17426     * @see elm_object_cursor_unset()
17427     * @see elm_list_item_cursor_set()
17428     *
17429     * @ingroup List
17430     */
17431    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17432
17433    /**
17434     * Set a different @b style for a given custom cursor set for a
17435     * list item.
17436     *
17437     * @param item list item with custom cursor set
17438     * @param style the <b>theme style</b> to use (e.g. @c "default",
17439     * @c "transparent", etc)
17440     *
17441     * This function only makes sense when one is using custom mouse
17442     * cursor decorations <b>defined in a theme file</b>, which can have,
17443     * given a cursor name/type, <b>alternate styles</b> on it. It
17444     * works analogously as elm_object_cursor_style_set(), but here
17445     * applyed only to list item objects.
17446     *
17447     * @warning Before you set a cursor style you should have definen a
17448     *       custom cursor previously on the item, with
17449     *       elm_list_item_cursor_set()
17450     *
17451     * @see elm_list_item_cursor_engine_only_set()
17452     * @see elm_list_item_cursor_style_get()
17453     *
17454     * @ingroup List
17455     */
17456    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17457
17458    /**
17459     * Get the current @b style set for a given list item's custom
17460     * cursor
17461     *
17462     * @param item list item with custom cursor set.
17463     * @return style the cursor style in use. If the object does not
17464     *         have a cursor set, then @c NULL is returned.
17465     *
17466     * @see elm_list_item_cursor_style_set() for more details
17467     *
17468     * @ingroup List
17469     */
17470    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17471
17472    /**
17473     * Set if the (custom)cursor for a given list item should be
17474     * searched in its theme, also, or should only rely on the
17475     * rendering engine.
17476     *
17477     * @param item item with custom (custom) cursor already set on
17478     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17479     * only on those provided by the rendering engine, @c EINA_FALSE to
17480     * have them searched on the widget's theme, as well.
17481     *
17482     * @note This call is of use only if you've set a custom cursor
17483     * for list items, with elm_list_item_cursor_set().
17484     *
17485     * @note By default, cursors will only be looked for between those
17486     * provided by the rendering engine.
17487     *
17488     * @ingroup List
17489     */
17490    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17491
17492    /**
17493     * Get if the (custom) cursor for a given list item is being
17494     * searched in its theme, also, or is only relying on the rendering
17495     * engine.
17496     *
17497     * @param item a list item
17498     * @return @c EINA_TRUE, if cursors are being looked for only on
17499     * those provided by the rendering engine, @c EINA_FALSE if they
17500     * are being searched on the widget's theme, as well.
17501     *
17502     * @see elm_list_item_cursor_engine_only_set(), for more details
17503     *
17504     * @ingroup List
17505     */
17506    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17507
17508    /**
17509     * @}
17510     */
17511
17512    /**
17513     * @defgroup Slider Slider
17514     * @ingroup Elementary
17515     *
17516     * @image html img/widget/slider/preview-00.png
17517     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17518     *
17519     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
17520     * something within a range.
17521     *
17522     * A slider can be horizontal or vertical. It can contain an Icon and has a
17523     * primary label as well as a units label (that is formatted with floating
17524     * point values and thus accepts a printf-style format string, like
17525     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
17526     * else (like on the slider itself) that also accepts a format string like
17527     * units. Label, Icon Unit and Indicator strings/objects are optional.
17528     *
17529     * A slider may be inverted which means values invert, with high vales being
17530     * on the left or top and low values on the right or bottom (as opposed to
17531     * normally being low on the left or top and high on the bottom and right).
17532     *
17533     * The slider should have its minimum and maximum values set by the
17534     * application with  elm_slider_min_max_set() and value should also be set by
17535     * the application before use with  elm_slider_value_set(). The span of the
17536     * slider is its length (horizontally or vertically). This will be scaled by
17537     * the object or applications scaling factor. At any point code can query the
17538     * slider for its value with elm_slider_value_get().
17539     *
17540     * Smart callbacks one can listen to:
17541     * - "changed" - Whenever the slider value is changed by the user.
17542     * - "slider,drag,start" - dragging the slider indicator around has started.
17543     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17544     * - "delay,changed" - A short time after the value is changed by the user.
17545     * This will be called only when the user stops dragging for
17546     * a very short period or when they release their
17547     * finger/mouse, so it avoids possibly expensive reactions to
17548     * the value change.
17549     *
17550     * Available styles for it:
17551     * - @c "default"
17552     *
17553     * Default contents parts of the slider widget that you can use for are:
17554     * @li "icon" - A icon of the slider
17555     * @li "end" - A end part content of the slider
17556     * 
17557     * Default text parts of the silder widget that you can use for are:
17558     * @li "default" - Label of the silder
17559     * Here is an example on its usage:
17560     * @li @ref slider_example
17561     */
17562
17563    /**
17564     * @addtogroup Slider
17565     * @{
17566     */
17567
17568    /**
17569     * Add a new slider widget to the given parent Elementary
17570     * (container) object.
17571     *
17572     * @param parent The parent object.
17573     * @return a new slider widget handle or @c NULL, on errors.
17574     *
17575     * This function inserts a new slider widget on the canvas.
17576     *
17577     * @ingroup Slider
17578     */
17579    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17580
17581    /**
17582     * Set the label of a given slider widget
17583     *
17584     * @param obj The progress bar object
17585     * @param label The text label string, in UTF-8
17586     *
17587     * @ingroup Slider
17588     * @deprecated use elm_object_text_set() instead.
17589     */
17590    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17591
17592    /**
17593     * Get the label of a given slider widget
17594     *
17595     * @param obj The progressbar object
17596     * @return The text label string, in UTF-8
17597     *
17598     * @ingroup Slider
17599     * @deprecated use elm_object_text_get() instead.
17600     */
17601    WILL_DEPRECATE  EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17602
17603    /**
17604     * Set the icon object of the slider object.
17605     *
17606     * @param obj The slider object.
17607     * @param icon The icon object.
17608     *
17609     * On horizontal mode, icon is placed at left, and on vertical mode,
17610     * placed at top.
17611     *
17612     * @note Once the icon object is set, a previously set one will be deleted.
17613     * If you want to keep that old content object, use the
17614     * elm_slider_icon_unset() function.
17615     *
17616     * @warning If the object being set does not have minimum size hints set,
17617     * it won't get properly displayed.
17618     *
17619     * @ingroup Slider
17620     * @deprecated use elm_object_part_content_set() instead.
17621     */
17622    WILL_DEPRECATE  EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17623
17624    /**
17625     * Unset an icon set on a given slider widget.
17626     *
17627     * @param obj The slider object.
17628     * @return The icon object that was being used, if any was set, or
17629     * @c NULL, otherwise (and on errors).
17630     *
17631     * On horizontal mode, icon is placed at left, and on vertical mode,
17632     * placed at top.
17633     *
17634     * This call will unparent and return the icon object which was set
17635     * for this widget, previously, on success.
17636     *
17637     * @see elm_slider_icon_set() for more details
17638     * @see elm_slider_icon_get()
17639     * @deprecated use elm_object_part_content_unset() instead.
17640     *
17641     * @ingroup Slider
17642     */
17643    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17644
17645    /**
17646     * Retrieve the icon object set for a given slider widget.
17647     *
17648     * @param obj The slider object.
17649     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17650     * otherwise (and on errors).
17651     *
17652     * On horizontal mode, icon is placed at left, and on vertical mode,
17653     * placed at top.
17654     *
17655     * @see elm_slider_icon_set() for more details
17656     * @see elm_slider_icon_unset()
17657     *
17658     * @deprecated use elm_object_part_content_get() instead.
17659     *
17660     * @ingroup Slider
17661     */
17662    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17663
17664    /**
17665     * Set the end object of the slider object.
17666     *
17667     * @param obj The slider object.
17668     * @param end The end object.
17669     *
17670     * On horizontal mode, end is placed at left, and on vertical mode,
17671     * placed at bottom.
17672     *
17673     * @note Once the icon object is set, a previously set one will be deleted.
17674     * If you want to keep that old content object, use the
17675     * elm_slider_end_unset() function.
17676     *
17677     * @warning If the object being set does not have minimum size hints set,
17678     * it won't get properly displayed.
17679     *
17680     * @deprecated use elm_object_part_content_set() instead.
17681     *
17682     * @ingroup Slider
17683     */
17684    WILL_DEPRECATE  EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17685
17686    /**
17687     * Unset an end object set on a given slider widget.
17688     *
17689     * @param obj The slider object.
17690     * @return The end object that was being used, if any was set, or
17691     * @c NULL, otherwise (and on errors).
17692     *
17693     * On horizontal mode, end is placed at left, and on vertical mode,
17694     * placed at bottom.
17695     *
17696     * This call will unparent and return the icon object which was set
17697     * for this widget, previously, on success.
17698     *
17699     * @see elm_slider_end_set() for more details.
17700     * @see elm_slider_end_get()
17701     *
17702     * @deprecated use elm_object_part_content_unset() instead
17703     * instead.
17704     *
17705     * @ingroup Slider
17706     */
17707    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17708
17709    /**
17710     * Retrieve the end object set for a given slider widget.
17711     *
17712     * @param obj The slider object.
17713     * @return The end object's handle, if @p obj had one set, or @c NULL,
17714     * otherwise (and on errors).
17715     *
17716     * On horizontal mode, icon is placed at right, and on vertical mode,
17717     * placed at bottom.
17718     *
17719     * @see elm_slider_end_set() for more details.
17720     * @see elm_slider_end_unset()
17721     *
17722     *
17723     * @deprecated use elm_object_part_content_get() instead 
17724     * instead.
17725     *
17726     * @ingroup Slider
17727     */
17728    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17729
17730    /**
17731     * Set the (exact) length of the bar region of a given slider widget.
17732     *
17733     * @param obj The slider object.
17734     * @param size The length of the slider's bar region.
17735     *
17736     * This sets the minimum width (when in horizontal mode) or height
17737     * (when in vertical mode) of the actual bar area of the slider
17738     * @p obj. This in turn affects the object's minimum size. Use
17739     * this when you're not setting other size hints expanding on the
17740     * given direction (like weight and alignment hints) and you would
17741     * like it to have a specific size.
17742     *
17743     * @note Icon, end, label, indicator and unit text around @p obj
17744     * will require their
17745     * own space, which will make @p obj to require more the @p size,
17746     * actually.
17747     *
17748     * @see elm_slider_span_size_get()
17749     *
17750     * @ingroup Slider
17751     */
17752    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17753
17754    /**
17755     * Get the length set for the bar region of a given slider widget
17756     *
17757     * @param obj The slider object.
17758     * @return The length of the slider's bar region.
17759     *
17760     * If that size was not set previously, with
17761     * elm_slider_span_size_set(), this call will return @c 0.
17762     *
17763     * @ingroup Slider
17764     */
17765    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17766
17767    /**
17768     * Set the format string for the unit label.
17769     *
17770     * @param obj The slider object.
17771     * @param format The format string for the unit display.
17772     *
17773     * Unit label is displayed all the time, if set, after slider's bar.
17774     * In horizontal mode, at right and in vertical mode, at bottom.
17775     *
17776     * If @c NULL, unit label won't be visible. If not it sets the format
17777     * string for the label text. To the label text is provided a floating point
17778     * value, so the label text can display up to 1 floating point value.
17779     * Note that this is optional.
17780     *
17781     * Use a format string such as "%1.2f meters" for example, and it will
17782     * display values like: "3.14 meters" for a value equal to 3.14159.
17783     *
17784     * Default is unit label disabled.
17785     *
17786     * @see elm_slider_indicator_format_get()
17787     *
17788     * @ingroup Slider
17789     */
17790    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17791
17792    /**
17793     * Get the unit label format of the slider.
17794     *
17795     * @param obj The slider object.
17796     * @return The unit label format string in UTF-8.
17797     *
17798     * Unit label is displayed all the time, if set, after slider's bar.
17799     * In horizontal mode, at right and in vertical mode, at bottom.
17800     *
17801     * @see elm_slider_unit_format_set() for more
17802     * information on how this works.
17803     *
17804     * @ingroup Slider
17805     */
17806    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17807
17808    /**
17809     * Set the format string for the indicator label.
17810     *
17811     * @param obj The slider object.
17812     * @param indicator The format string for the indicator display.
17813     *
17814     * The slider may display its value somewhere else then unit label,
17815     * for example, above the slider knob that is dragged around. This function
17816     * sets the format string used for this.
17817     *
17818     * If @c NULL, indicator label won't be visible. If not it sets the format
17819     * string for the label text. To the label text is provided a floating point
17820     * value, so the label text can display up to 1 floating point value.
17821     * Note that this is optional.
17822     *
17823     * Use a format string such as "%1.2f meters" for example, and it will
17824     * display values like: "3.14 meters" for a value equal to 3.14159.
17825     *
17826     * Default is indicator label disabled.
17827     *
17828     * @see elm_slider_indicator_format_get()
17829     *
17830     * @ingroup Slider
17831     */
17832    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17833
17834    /**
17835     * Get the indicator label format of the slider.
17836     *
17837     * @param obj The slider object.
17838     * @return The indicator label format string in UTF-8.
17839     *
17840     * The slider may display its value somewhere else then unit label,
17841     * for example, above the slider knob that is dragged around. This function
17842     * gets the format string used for this.
17843     *
17844     * @see elm_slider_indicator_format_set() for more
17845     * information on how this works.
17846     *
17847     * @ingroup Slider
17848     */
17849    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17850
17851    /**
17852     * Set the format function pointer for the indicator label
17853     *
17854     * @param obj The slider object.
17855     * @param func The indicator format function.
17856     * @param free_func The freeing function for the format string.
17857     *
17858     * Set the callback function to format the indicator string.
17859     *
17860     * @see elm_slider_indicator_format_set() for more info on how this works.
17861     *
17862     * @ingroup Slider
17863     */
17864   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);
17865
17866   /**
17867    * Set the format function pointer for the units label
17868    *
17869    * @param obj The slider object.
17870    * @param func The units format function.
17871    * @param free_func The freeing function for the format string.
17872    *
17873    * Set the callback function to format the indicator string.
17874    *
17875    * @see elm_slider_units_format_set() for more info on how this works.
17876    *
17877    * @ingroup Slider
17878    */
17879   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);
17880
17881   /**
17882    * Set the orientation of a given slider widget.
17883    *
17884    * @param obj The slider object.
17885    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17886    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17887    *
17888    * Use this function to change how your slider is to be
17889    * disposed: vertically or horizontally.
17890    *
17891    * By default it's displayed horizontally.
17892    *
17893    * @see elm_slider_horizontal_get()
17894    *
17895    * @ingroup Slider
17896    */
17897    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17898
17899    /**
17900     * Retrieve the orientation of a given slider widget
17901     *
17902     * @param obj The slider object.
17903     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17904     * @c EINA_FALSE if it's @b vertical (and on errors).
17905     *
17906     * @see elm_slider_horizontal_set() for more details.
17907     *
17908     * @ingroup Slider
17909     */
17910    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17911
17912    /**
17913     * Set the minimum and maximum values for the slider.
17914     *
17915     * @param obj The slider object.
17916     * @param min The minimum value.
17917     * @param max The maximum value.
17918     *
17919     * Define the allowed range of values to be selected by the user.
17920     *
17921     * If actual value is less than @p min, it will be updated to @p min. If it
17922     * is bigger then @p max, will be updated to @p max. Actual value can be
17923     * get with elm_slider_value_get().
17924     *
17925     * By default, min is equal to 0.0, and max is equal to 1.0.
17926     *
17927     * @warning Maximum must be greater than minimum, otherwise behavior
17928     * is undefined.
17929     *
17930     * @see elm_slider_min_max_get()
17931     *
17932     * @ingroup Slider
17933     */
17934    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17935
17936    /**
17937     * Get the minimum and maximum values of the slider.
17938     *
17939     * @param obj The slider object.
17940     * @param min Pointer where to store the minimum value.
17941     * @param max Pointer where to store the maximum value.
17942     *
17943     * @note If only one value is needed, the other pointer can be passed
17944     * as @c NULL.
17945     *
17946     * @see elm_slider_min_max_set() for details.
17947     *
17948     * @ingroup Slider
17949     */
17950    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17951
17952    /**
17953     * Set the value the slider displays.
17954     *
17955     * @param obj The slider object.
17956     * @param val The value to be displayed.
17957     *
17958     * Value will be presented on the unit label following format specified with
17959     * elm_slider_unit_format_set() and on indicator with
17960     * elm_slider_indicator_format_set().
17961     *
17962     * @warning The value must to be between min and max values. This values
17963     * are set by elm_slider_min_max_set().
17964     *
17965     * @see elm_slider_value_get()
17966     * @see elm_slider_unit_format_set()
17967     * @see elm_slider_indicator_format_set()
17968     * @see elm_slider_min_max_set()
17969     *
17970     * @ingroup Slider
17971     */
17972    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17973
17974    /**
17975     * Get the value displayed by the spinner.
17976     *
17977     * @param obj The spinner object.
17978     * @return The value displayed.
17979     *
17980     * @see elm_spinner_value_set() for details.
17981     *
17982     * @ingroup Slider
17983     */
17984    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17985
17986    /**
17987     * Invert a given slider widget's displaying values order
17988     *
17989     * @param obj The slider object.
17990     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17991     * @c EINA_FALSE to bring it back to default, non-inverted values.
17992     *
17993     * A slider may be @b inverted, in which state it gets its
17994     * values inverted, with high vales being on the left or top and
17995     * low values on the right or bottom, as opposed to normally have
17996     * the low values on the former and high values on the latter,
17997     * respectively, for horizontal and vertical modes.
17998     *
17999     * @see elm_slider_inverted_get()
18000     *
18001     * @ingroup Slider
18002     */
18003    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18004
18005    /**
18006     * Get whether a given slider widget's displaying values are
18007     * inverted or not.
18008     *
18009     * @param obj The slider object.
18010     * @return @c EINA_TRUE, if @p obj has inverted values,
18011     * @c EINA_FALSE otherwise (and on errors).
18012     *
18013     * @see elm_slider_inverted_set() for more details.
18014     *
18015     * @ingroup Slider
18016     */
18017    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18018
18019    /**
18020     * Set whether to enlarge slider indicator (augmented knob) or not.
18021     *
18022     * @param obj The slider object.
18023     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18024     * let the knob always at default size.
18025     *
18026     * By default, indicator will be bigger while dragged by the user.
18027     *
18028     * @warning It won't display values set with
18029     * elm_slider_indicator_format_set() if you disable indicator.
18030     *
18031     * @ingroup Slider
18032     */
18033    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18034
18035    /**
18036     * Get whether a given slider widget's enlarging indicator or not.
18037     *
18038     * @param obj The slider object.
18039     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18040     * @c EINA_FALSE otherwise (and on errors).
18041     *
18042     * @see elm_slider_indicator_show_set() for details.
18043     *
18044     * @ingroup Slider
18045     */
18046    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18047
18048    /**
18049     * @}
18050     */
18051
18052    /**
18053     * @addtogroup Actionslider Actionslider
18054     *
18055     * @image html img/widget/actionslider/preview-00.png
18056     * @image latex img/widget/actionslider/preview-00.eps
18057     *
18058     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18059     * properties. The user drags and releases the indicator, to choose a label.
18060     *
18061     * Labels occupy the following positions.
18062     * a. Left
18063     * b. Right
18064     * c. Center
18065     *
18066     * Positions can be enabled or disabled.
18067     *
18068     * Magnets can be set on the above positions.
18069     *
18070     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18071     *
18072     * @note By default all positions are set as enabled.
18073     *
18074     * Signals that you can add callbacks for are:
18075     *
18076     * "selected" - when user selects an enabled position (the label is passed
18077     *              as event info)".
18078     * @n
18079     * "pos_changed" - when the indicator reaches any of the positions("left",
18080     *                 "right" or "center").
18081     *
18082     * See an example of actionslider usage @ref actionslider_example_page "here"
18083     * @{
18084     */
18085
18086    typedef enum _Elm_Actionslider_Indicator_Pos
18087      {
18088         ELM_ACTIONSLIDER_INDICATOR_NONE,
18089         ELM_ACTIONSLIDER_INDICATOR_LEFT,
18090         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
18091         ELM_ACTIONSLIDER_INDICATOR_CENTER
18092      } Elm_Actionslider_Indicator_Pos;
18093
18094    typedef enum _Elm_Actionslider_Magnet_Pos
18095      {
18096         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
18097         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
18098         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
18099         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
18100         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
18101         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
18102      } Elm_Actionslider_Magnet_Pos;
18103
18104    typedef enum _Elm_Actionslider_Label_Pos
18105      {
18106         ELM_ACTIONSLIDER_LABEL_LEFT,
18107         ELM_ACTIONSLIDER_LABEL_RIGHT,
18108         ELM_ACTIONSLIDER_LABEL_CENTER,
18109         ELM_ACTIONSLIDER_LABEL_BUTTON
18110      } Elm_Actionslider_Label_Pos;
18111
18112    /* smart callbacks called:
18113     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
18114     */
18115
18116    /**
18117     * Add a new actionslider to the parent.
18118     *
18119     * @param parent The parent object
18120     * @return The new actionslider object or NULL if it cannot be created
18121     */
18122    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18123
18124    /**
18125    * Set actionslider label.
18126    *
18127    * @param[in] obj The actionslider object
18128    * @param[in] pos The position of the label.
18129    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
18130    * @param label The label which is going to be set.
18131    */
18132    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
18133    /**
18134     * Get actionslider labels.
18135     *
18136     * @param obj The actionslider object
18137     * @param left_label A char** to place the left_label of @p obj into.
18138     * @param center_label A char** to place the center_label of @p obj into.
18139     * @param right_label A char** to place the right_label of @p obj into.
18140     */
18141    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);
18142    /**
18143     * Get actionslider selected label.
18144     *
18145     * @param obj The actionslider object
18146     * @return The selected label
18147     */
18148    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18149    /**
18150     * Set actionslider indicator position.
18151     *
18152     * @param obj The actionslider object.
18153     * @param pos The position of the indicator.
18154     */
18155    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
18156    /**
18157     * Get actionslider indicator position.
18158     *
18159     * @param obj The actionslider object.
18160     * @return The position of the indicator.
18161     */
18162    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18163    /**
18164     * Set actionslider magnet position. To make multiple positions magnets @c or
18165     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
18166     *
18167     * @param obj The actionslider object.
18168     * @param pos Bit mask indicating the magnet positions.
18169     */
18170    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18171    /**
18172     * Get actionslider magnet position.
18173     *
18174     * @param obj The actionslider object.
18175     * @return The positions with magnet property.
18176     */
18177    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18178    /**
18179     * Set actionslider enabled position. To set multiple positions as enabled @c or
18180     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
18181     *
18182     * @note All the positions are enabled by default.
18183     *
18184     * @param obj The actionslider object.
18185     * @param pos Bit mask indicating the enabled positions.
18186     */
18187    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18188    /**
18189     * Get actionslider enabled position.
18190     *
18191     * @param obj The actionslider object.
18192     * @return The enabled positions.
18193     */
18194    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18195    /**
18196     * Set the label used on the indicator.
18197     *
18198     * @param obj The actionslider object
18199     * @param label The label to be set on the indicator.
18200     * @deprecated use elm_object_text_set() instead.
18201     */
18202    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18203    /**
18204     * Get the label used on the indicator object.
18205     *
18206     * @param obj The actionslider object
18207     * @return The indicator label
18208     * @deprecated use elm_object_text_get() instead.
18209     */
18210    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18211
18212    /**
18213    * Hold actionslider object movement.
18214    *
18215    * @param[in] obj The actionslider object
18216    * @param[in] flag Actionslider hold/release
18217    * (EINA_TURE = hold/EIN_FALSE = release)
18218    *
18219    * @ingroup Actionslider
18220    */
18221    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18222
18223
18224    /**
18225     * @}
18226     */
18227
18228    /**
18229     * @defgroup Genlist Genlist
18230     *
18231     * @image html img/widget/genlist/preview-00.png
18232     * @image latex img/widget/genlist/preview-00.eps
18233     * @image html img/genlist.png
18234     * @image latex img/genlist.eps
18235     *
18236     * This widget aims to have more expansive list than the simple list in
18237     * Elementary that could have more flexible items and allow many more entries
18238     * while still being fast and low on memory usage. At the same time it was
18239     * also made to be able to do tree structures. But the price to pay is more
18240     * complexity when it comes to usage. If all you want is a simple list with
18241     * icons and a single label, use the normal @ref List object.
18242     *
18243     * Genlist has a fairly large API, mostly because it's relatively complex,
18244     * trying to be both expansive, powerful and efficient. First we will begin
18245     * an overview on the theory behind genlist.
18246     *
18247     * @section Genlist_Item_Class Genlist item classes - creating items
18248     *
18249     * In order to have the ability to add and delete items on the fly, genlist
18250     * implements a class (callback) system where the application provides a
18251     * structure with information about that type of item (genlist may contain
18252     * multiple different items with different classes, states and styles).
18253     * Genlist will call the functions in this struct (methods) when an item is
18254     * "realized" (i.e., created dynamically, while the user is scrolling the
18255     * grid). All objects will simply be deleted when no longer needed with
18256     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18257     * following members:
18258     * - @c item_style - This is a constant string and simply defines the name
18259     *   of the item style. It @b must be specified and the default should be @c
18260     *   "default".
18261     *
18262     * - @c func - A struct with pointers to functions that will be called when
18263     *   an item is going to be actually created. All of them receive a @c data
18264     *   parameter that will point to the same data passed to
18265     *   elm_genlist_item_append() and related item creation functions, and a @c
18266     *   obj parameter that points to the genlist object itself.
18267     *
18268     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18269     * state_get and @c del. The 3 first functions also receive a @c part
18270     * parameter described below. A brief description of these functions follows:
18271     *
18272     * - @c label_get - The @c part parameter is the name string of one of the
18273     *   existing text parts in the Edje group implementing the item's theme.
18274     *   This function @b must return a strdup'()ed string, as the caller will
18275     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18276     * - @c content_get - The @c part parameter is the name string of one of the
18277     *   existing (content) swallow parts in the Edje group implementing the item's
18278     *   theme. It must return @c NULL, when no content is desired, or a valid
18279     *   object handle, otherwise.  The object will be deleted by the genlist on
18280     *   its deletion or when the item is "unrealized".  See
18281     *   #Elm_Genlist_Item_Content_Get_Cb.
18282     * - @c func.state_get - The @c part parameter is the name string of one of
18283     *   the state parts in the Edje group implementing the item's theme. Return
18284     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18285     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18286     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18287     *   the state is true (the default is false), where @c XXX is the name of
18288     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18289     * - @c func.del - This is intended for use when genlist items are deleted,
18290     *   so any data attached to the item (e.g. its data parameter on creation)
18291     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18292     *
18293     * available item styles:
18294     * - default
18295     * - default_style - The text part is a textblock
18296     *
18297     * @image html img/widget/genlist/preview-04.png
18298     * @image latex img/widget/genlist/preview-04.eps
18299     *
18300     * - double_label
18301     *
18302     * @image html img/widget/genlist/preview-01.png
18303     * @image latex img/widget/genlist/preview-01.eps
18304     *
18305     * - icon_top_text_bottom
18306     *
18307     * @image html img/widget/genlist/preview-02.png
18308     * @image latex img/widget/genlist/preview-02.eps
18309     *
18310     * - group_index
18311     *
18312     * @image html img/widget/genlist/preview-03.png
18313     * @image latex img/widget/genlist/preview-03.eps
18314     *
18315     * @section Genlist_Items Structure of items
18316     *
18317     * An item in a genlist can have 0 or more text labels (they can be regular
18318     * text or textblock Evas objects - that's up to the style to determine), 0
18319     * or more contents (which are simply objects swallowed into the genlist item's
18320     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18321     * behavior left to the user to define. The Edje part names for each of
18322     * these properties will be looked up, in the theme file for the genlist,
18323     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18324     * "states", respectively. For each of those properties, if more than one
18325     * part is provided, they must have names listed separated by spaces in the
18326     * data fields. For the default genlist item theme, we have @b one label
18327     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18328     * "elm.swallow.end") and @b no state parts.
18329     *
18330     * A genlist item may be at one of several styles. Elementary provides one
18331     * by default - "default", but this can be extended by system or application
18332     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18333     * details).
18334     *
18335     * @section Genlist_Manipulation Editing and Navigating
18336     *
18337     * Items can be added by several calls. All of them return a @ref
18338     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18339     * They all take a data parameter that is meant to be used for a handle to
18340     * the applications internal data (eg the struct with the original item
18341     * data). The parent parameter is the parent genlist item this belongs to if
18342     * it is a tree or an indexed group, and NULL if there is no parent. The
18343     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18344     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18345     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18346     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18347     * is set then this item is group index item that is displayed at the top
18348     * until the next group comes. The func parameter is a convenience callback
18349     * that is called when the item is selected and the data parameter will be
18350     * the func_data parameter, obj be the genlist object and event_info will be
18351     * the genlist item.
18352     *
18353     * elm_genlist_item_append() adds an item to the end of the list, or if
18354     * there is a parent, to the end of all the child items of the parent.
18355     * elm_genlist_item_prepend() is the same but adds to the beginning of
18356     * the list or children list. elm_genlist_item_insert_before() inserts at
18357     * item before another item and elm_genlist_item_insert_after() inserts after
18358     * the indicated item.
18359     *
18360     * The application can clear the list with elm_gen_clear() which deletes
18361     * all the items in the list and elm_genlist_item_del() will delete a specific
18362     * item. elm_genlist_item_subitems_clear() will clear all items that are
18363     * children of the indicated parent item.
18364     *
18365     * To help inspect list items you can jump to the item at the top of the list
18366     * with elm_genlist_first_item_get() which will return the item pointer, and
18367     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18368     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18369     * and previous items respectively relative to the indicated item. Using
18370     * these calls you can walk the entire item list/tree. Note that as a tree
18371     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18372     * let you know which item is the parent (and thus know how to skip them if
18373     * wanted).
18374     *
18375     * @section Genlist_Muti_Selection Multi-selection
18376     *
18377     * If the application wants multiple items to be able to be selected,
18378     * elm_genlist_multi_select_set() can enable this. If the list is
18379     * single-selection only (the default), then elm_genlist_selected_item_get()
18380     * will return the selected item, if any, or NULL if none is selected. If the
18381     * list is multi-select then elm_genlist_selected_items_get() will return a
18382     * list (that is only valid as long as no items are modified (added, deleted,
18383     * selected or unselected)).
18384     *
18385     * @section Genlist_Usage_Hints Usage hints
18386     *
18387     * There are also convenience functions. elm_gen_item_genlist_get() will
18388     * return the genlist object the item belongs to. elm_genlist_item_show()
18389     * will make the scroller scroll to show that specific item so its visible.
18390     * elm_genlist_item_data_get() returns the data pointer set by the item
18391     * creation functions.
18392     *
18393     * If an item changes (state of boolean changes, label or contents change),
18394     * then use elm_genlist_item_update() to have genlist update the item with
18395     * the new state. Genlist will re-realize the item thus call the functions
18396     * in the _Elm_Genlist_Item_Class for that item.
18397     *
18398     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18399     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18400     * to expand/contract an item and get its expanded state, use
18401     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18402     * again to make an item disabled (unable to be selected and appear
18403     * differently) use elm_genlist_item_disabled_set() to set this and
18404     * elm_genlist_item_disabled_get() to get the disabled state.
18405     *
18406     * In general to indicate how the genlist should expand items horizontally to
18407     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18408     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18409     * mode means that if items are too wide to fit, the scroller will scroll
18410     * horizontally. Otherwise items are expanded to fill the width of the
18411     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18412     * to the viewport width and limited to that size. This can be combined with
18413     * a different style that uses edjes' ellipsis feature (cutting text off like
18414     * this: "tex...").
18415     *
18416     * Items will only call their selection func and callback when first becoming
18417     * selected. Any further clicks will do nothing, unless you enable always
18418     * select with elm_gen_always_select_mode_set(). This means even if
18419     * selected, every click will make the selected callbacks be called.
18420     * elm_genlist_no_select_mode_set() will turn off the ability to select
18421     * items entirely and they will neither appear selected nor call selected
18422     * callback functions.
18423     *
18424     * Remember that you can create new styles and add your own theme augmentation
18425     * per application with elm_theme_extension_add(). If you absolutely must
18426     * have a specific style that overrides any theme the user or system sets up
18427     * you can use elm_theme_overlay_add() to add such a file.
18428     *
18429     * @section Genlist_Implementation Implementation
18430     *
18431     * Evas tracks every object you create. Every time it processes an event
18432     * (mouse move, down, up etc.) it needs to walk through objects and find out
18433     * what event that affects. Even worse every time it renders display updates,
18434     * in order to just calculate what to re-draw, it needs to walk through many
18435     * many many objects. Thus, the more objects you keep active, the more
18436     * overhead Evas has in just doing its work. It is advisable to keep your
18437     * active objects to the minimum working set you need. Also remember that
18438     * object creation and deletion carries an overhead, so there is a
18439     * middle-ground, which is not easily determined. But don't keep massive lists
18440     * of objects you can't see or use. Genlist does this with list objects. It
18441     * creates and destroys them dynamically as you scroll around. It groups them
18442     * into blocks so it can determine the visibility etc. of a whole block at
18443     * once as opposed to having to walk the whole list. This 2-level list allows
18444     * for very large numbers of items to be in the list (tests have used up to
18445     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18446     * may be different sizes, every item added needs to be calculated as to its
18447     * size and thus this presents a lot of overhead on populating the list, this
18448     * genlist employs a queue. Any item added is queued and spooled off over
18449     * time, actually appearing some time later, so if your list has many members
18450     * you may find it takes a while for them to all appear, with your process
18451     * consuming a lot of CPU while it is busy spooling.
18452     *
18453     * Genlist also implements a tree structure, but it does so with callbacks to
18454     * the application, with the application filling in tree structures when
18455     * requested (allowing for efficient building of a very deep tree that could
18456     * even be used for file-management). See the above smart signal callbacks for
18457     * details.
18458     *
18459     * @section Genlist_Smart_Events Genlist smart events
18460     *
18461     * Signals that you can add callbacks for are:
18462     * - @c "activated" - The user has double-clicked or pressed
18463     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18464     *   item that was activated.
18465     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18466     *   event_info parameter is the item that was double-clicked.
18467     * - @c "selected" - This is called when a user has made an item selected.
18468     *   The event_info parameter is the genlist item that was selected.
18469     * - @c "unselected" - This is called when a user has made an item
18470     *   unselected. The event_info parameter is the genlist item that was
18471     *   unselected.
18472     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18473     *   called and the item is now meant to be expanded. The event_info
18474     *   parameter is the genlist item that was indicated to expand.  It is the
18475     *   job of this callback to then fill in the child items.
18476     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18477     *   called and the item is now meant to be contracted. The event_info
18478     *   parameter is the genlist item that was indicated to contract. It is the
18479     *   job of this callback to then delete the child items.
18480     * - @c "expand,request" - This is called when a user has indicated they want
18481     *   to expand a tree branch item. The callback should decide if the item can
18482     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18483     *   appropriately to set the state. The event_info parameter is the genlist
18484     *   item that was indicated to expand.
18485     * - @c "contract,request" - This is called when a user has indicated they
18486     *   want to contract a tree branch item. The callback should decide if the
18487     *   item can contract (has any children) and then call
18488     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18489     *   event_info parameter is the genlist item that was indicated to contract.
18490     * - @c "realized" - This is called when the item in the list is created as a
18491     *   real evas object. event_info parameter is the genlist item that was
18492     *   created. The object may be deleted at any time, so it is up to the
18493     *   caller to not use the object pointer from elm_genlist_item_object_get()
18494     *   in a way where it may point to freed objects.
18495     * - @c "unrealized" - This is called just before an item is unrealized.
18496     *   After this call content objects provided will be deleted and the item
18497     *   object itself delete or be put into a floating cache.
18498     * - @c "drag,start,up" - This is called when the item in the list has been
18499     *   dragged (not scrolled) up.
18500     * - @c "drag,start,down" - This is called when the item in the list has been
18501     *   dragged (not scrolled) down.
18502     * - @c "drag,start,left" - This is called when the item in the list has been
18503     *   dragged (not scrolled) left.
18504     * - @c "drag,start,right" - This is called when the item in the list has
18505     *   been dragged (not scrolled) right.
18506     * - @c "drag,stop" - This is called when the item in the list has stopped
18507     *   being dragged.
18508     * - @c "drag" - This is called when the item in the list is being dragged.
18509     * - @c "longpressed" - This is called when the item is pressed for a certain
18510     *   amount of time. By default it's 1 second.
18511     * - @c "scroll,anim,start" - This is called when scrolling animation has
18512     *   started.
18513     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18514     *   stopped.
18515     * - @c "scroll,drag,start" - This is called when dragging the content has
18516     *   started.
18517     * - @c "scroll,drag,stop" - This is called when dragging the content has
18518     *   stopped.
18519     * - @c "edge,top" - This is called when the genlist is scrolled until
18520     *   the top edge.
18521     * - @c "edge,bottom" - This is called when the genlist is scrolled
18522     *   until the bottom edge.
18523     * - @c "edge,left" - This is called when the genlist is scrolled
18524     *   until the left edge.
18525     * - @c "edge,right" - This is called when the genlist is scrolled
18526     *   until the right edge.
18527     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18528     *   swiped left.
18529     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18530     *   swiped right.
18531     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18532     *   swiped up.
18533     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18534     *   swiped down.
18535     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18536     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18537     *   multi-touch pinched in.
18538     * - @c "swipe" - This is called when the genlist is swiped.
18539     * - @c "moved" - This is called when a genlist item is moved.
18540     * - @c "language,changed" - This is called when the program's language is
18541     *   changed.
18542     *
18543     * @section Genlist_Examples Examples
18544     *
18545     * Here is a list of examples that use the genlist, trying to show some of
18546     * its capabilities:
18547     * - @ref genlist_example_01
18548     * - @ref genlist_example_02
18549     * - @ref genlist_example_03
18550     * - @ref genlist_example_04
18551     * - @ref genlist_example_05
18552     */
18553
18554    /**
18555     * @addtogroup Genlist
18556     * @{
18557     */
18558
18559    /**
18560     * @enum _Elm_Genlist_Item_Flags
18561     * @typedef Elm_Genlist_Item_Flags
18562     *
18563     * Defines if the item is of any special type (has subitems or it's the
18564     * index of a group), or is just a simple item.
18565     *
18566     * @ingroup Genlist
18567     */
18568    typedef enum _Elm_Genlist_Item_Flags
18569      {
18570         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18571         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18572         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18573      } Elm_Genlist_Item_Flags;
18574    typedef enum _Elm_Genlist_Item_Field_Flags
18575      {
18576         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18577         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18578         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18579         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18580      } Elm_Genlist_Item_Field_Flags;
18581    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18582    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18583    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18584    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18585    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
18586    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18587    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
18588    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18589
18590    /**
18591     * @struct _Elm_Genlist_Item_Class
18592     *
18593     * Genlist item class definition structs.
18594     *
18595     * This struct contains the style and fetching functions that will define the
18596     * contents of each item.
18597     *
18598     * @see @ref Genlist_Item_Class
18599     */
18600    struct _Elm_Genlist_Item_Class
18601      {
18602         const char                *item_style;
18603         struct {
18604           GenlistItemLabelGetFunc  label_get;
18605           GenlistItemIconGetFunc   icon_get;
18606           GenlistItemStateGetFunc  state_get;
18607           GenlistItemDelFunc       del;
18608           GenlistItemMovedFunc     moved;
18609         } func;
18610         const char *edit_item_style;
18611         const char                *mode_item_style;
18612      };
18613    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18614    /**
18615     * Add a new genlist widget to the given parent Elementary
18616     * (container) object
18617     *
18618     * @param parent The parent object
18619     * @return a new genlist widget handle or @c NULL, on errors
18620     *
18621     * This function inserts a new genlist widget on the canvas.
18622     *
18623     * @see elm_genlist_item_append()
18624     * @see elm_genlist_item_del()
18625     * @see elm_gen_clear()
18626     *
18627     * @ingroup Genlist
18628     */
18629    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18630    /**
18631     * Remove all items from a given genlist widget.
18632     *
18633     * @param obj The genlist object
18634     *
18635     * This removes (and deletes) all items in @p obj, leaving it empty.
18636     *
18637     * This is deprecated. Please use elm_gen_clear() instead.
18638     * 
18639     * @see elm_genlist_item_del(), to remove just one item.
18640     *
18641     * @ingroup Genlist
18642     */
18643    WILL_DEPRECATE  EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18644    /**
18645     * Enable or disable multi-selection in the genlist
18646     *
18647     * @param obj The genlist object
18648     * @param multi Multi-select enable/disable. Default is disabled.
18649     *
18650     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18651     * the list. This allows more than 1 item to be selected. To retrieve the list
18652     * of selected items, use elm_genlist_selected_items_get().
18653     *
18654     * @see elm_genlist_selected_items_get()
18655     * @see elm_genlist_multi_select_get()
18656     *
18657     * @ingroup Genlist
18658     */
18659    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18660    /**
18661     * Gets if multi-selection in genlist is enabled or disabled.
18662     *
18663     * @param obj The genlist object
18664     * @return Multi-select enabled/disabled
18665     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18666     *
18667     * @see elm_genlist_multi_select_set()
18668     *
18669     * @ingroup Genlist
18670     */
18671    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18672    /**
18673     * This sets the horizontal stretching mode.
18674     *
18675     * @param obj The genlist object
18676     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18677     *
18678     * This sets the mode used for sizing items horizontally. Valid modes
18679     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18680     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18681     * the scroller will scroll horizontally. Otherwise items are expanded
18682     * to fill the width of the viewport of the scroller. If it is
18683     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18684     * limited to that size.
18685     *
18686     * @see elm_genlist_horizontal_get()
18687     *
18688     * @ingroup Genlist
18689     */
18690    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18691    /**
18692     * Gets the horizontal stretching mode.
18693     *
18694     * @param obj The genlist object
18695     * @return The mode to use
18696     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18697     *
18698     * @see elm_genlist_horizontal_set()
18699     *
18700     * @ingroup Genlist
18701     */
18702    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18703    /**
18704     * Set the always select mode.
18705     *
18706     * @param obj The genlist object
18707     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18708     * EINA_FALSE = off). Default is @c EINA_FALSE.
18709     *
18710     * Items will only call their selection func and callback when first
18711     * becoming selected. Any further clicks will do nothing, unless you
18712     * enable always select with elm_gen_always_select_mode_set().
18713     * This means that, even if selected, every click will make the selected
18714     * callbacks be called.
18715     * 
18716     * This function is deprecated. please see elm_gen_always_select_mode_set()
18717     *
18718     * @see elm_genlist_always_select_mode_get()
18719     *
18720     * @ingroup Genlist
18721     */
18722    WILL_DEPRECATE  EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18723    /**
18724     * Get the always select mode.
18725     *
18726     * @param obj The genlist object
18727     * @return The always select mode
18728     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18729     *
18730     * @see elm_genlist_always_select_mode_set()
18731     *
18732     * @ingroup Genlist
18733     */
18734    WILL_DEPRECATE  EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18735    /**
18736     * Enable/disable the no select mode.
18737     *
18738     * @param obj The genlist object
18739     * @param no_select The no select mode
18740     * (EINA_TRUE = on, EINA_FALSE = off)
18741     *
18742     * This will turn off the ability to select items entirely and they
18743     * will neither appear selected nor call selected callback functions.
18744     *
18745     * @see elm_genlist_no_select_mode_get()
18746     *
18747     * @ingroup Genlist
18748     */
18749    WILL_DEPRECATE  EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18750    /**
18751     * Gets whether the no select mode is enabled.
18752     *
18753     * @param obj The genlist object
18754     * @return The no select mode
18755     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18756     *
18757     * @see elm_genlist_no_select_mode_set()
18758     *
18759     * @ingroup Genlist
18760     */
18761    WILL_DEPRECATE  EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18762    /**
18763     * Enable/disable compress mode.
18764     *
18765     * @param obj The genlist object
18766     * @param compress The compress mode
18767     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18768     *
18769     * This will enable the compress mode where items are "compressed"
18770     * horizontally to fit the genlist scrollable viewport width. This is
18771     * special for genlist.  Do not rely on
18772     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18773     * work as genlist needs to handle it specially.
18774     *
18775     * @see elm_genlist_compress_mode_get()
18776     *
18777     * @ingroup Genlist
18778     */
18779    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18780    /**
18781     * Get whether the compress mode is enabled.
18782     *
18783     * @param obj The genlist object
18784     * @return The compress mode
18785     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18786     *
18787     * @see elm_genlist_compress_mode_set()
18788     *
18789     * @ingroup Genlist
18790     */
18791    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18792    /**
18793     * Enable/disable height-for-width mode.
18794     *
18795     * @param obj The genlist object
18796     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18797     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18798     *
18799     * With height-for-width mode the item width will be fixed (restricted
18800     * to a minimum of) to the list width when calculating its size in
18801     * order to allow the height to be calculated based on it. This allows,
18802     * for instance, text block to wrap lines if the Edje part is
18803     * configured with "text.min: 0 1".
18804     *
18805     * @note This mode will make list resize slower as it will have to
18806     *       recalculate every item height again whenever the list width
18807     *       changes!
18808     *
18809     * @note When height-for-width mode is enabled, it also enables
18810     *       compress mode (see elm_genlist_compress_mode_set()) and
18811     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18812     *
18813     * @ingroup Genlist
18814     */
18815    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18816    /**
18817     * Get whether the height-for-width mode is enabled.
18818     *
18819     * @param obj The genlist object
18820     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18821     * off)
18822     *
18823     * @ingroup Genlist
18824     */
18825    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18826    /**
18827     * Enable/disable horizontal and vertical bouncing effect.
18828     *
18829     * @param obj The genlist object
18830     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18831     * EINA_FALSE = off). Default is @c EINA_FALSE.
18832     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18833     * EINA_FALSE = off). Default is @c EINA_TRUE.
18834     *
18835     * This will enable or disable the scroller bouncing effect for the
18836     * genlist. See elm_scroller_bounce_set() for details.
18837     *
18838     * @see elm_scroller_bounce_set()
18839     * @see elm_genlist_bounce_get()
18840     *
18841     * @ingroup Genlist
18842     */
18843    WILL_DEPRECATE  EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18844    /**
18845     * Get whether the horizontal and vertical bouncing effect is enabled.
18846     *
18847     * @param obj The genlist object
18848     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18849     * option is set.
18850     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18851     * option is set.
18852     *
18853     * @see elm_genlist_bounce_set()
18854     *
18855     * @ingroup Genlist
18856     */
18857    WILL_DEPRECATE  EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18858    /**
18859     * Enable/disable homogenous mode.
18860     *
18861     * @param obj The genlist object
18862     * @param homogeneous Assume the items within the genlist are of the
18863     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18864     * EINA_FALSE.
18865     *
18866     * This will enable the homogeneous mode where items are of the same
18867     * height and width so that genlist may do the lazy-loading at its
18868     * maximum (which increases the performance for scrolling the list). This
18869     * implies 'compressed' mode.
18870     *
18871     * @see elm_genlist_compress_mode_set()
18872     * @see elm_genlist_homogeneous_get()
18873     *
18874     * @ingroup Genlist
18875     */
18876    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18877    /**
18878     * Get whether the homogenous mode is enabled.
18879     *
18880     * @param obj The genlist object
18881     * @return Assume the items within the genlist are of the same height
18882     * and width (EINA_TRUE = on, EINA_FALSE = off)
18883     *
18884     * @see elm_genlist_homogeneous_set()
18885     *
18886     * @ingroup Genlist
18887     */
18888    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18889    /**
18890     * Set the maximum number of items within an item block
18891     *
18892     * @param obj The genlist object
18893     * @param n   Maximum number of items within an item block. Default is 32.
18894     *
18895     * This will configure the block count to tune to the target with
18896     * particular performance matrix.
18897     *
18898     * A block of objects will be used to reduce the number of operations due to
18899     * many objects in the screen. It can determine the visibility, or if the
18900     * object has changed, it theme needs to be updated, etc. doing this kind of
18901     * calculation to the entire block, instead of per object.
18902     *
18903     * The default value for the block count is enough for most lists, so unless
18904     * you know you will have a lot of objects visible in the screen at the same
18905     * time, don't try to change this.
18906     *
18907     * @see elm_genlist_block_count_get()
18908     * @see @ref Genlist_Implementation
18909     *
18910     * @ingroup Genlist
18911     */
18912    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18913    /**
18914     * Get the maximum number of items within an item block
18915     *
18916     * @param obj The genlist object
18917     * @return Maximum number of items within an item block
18918     *
18919     * @see elm_genlist_block_count_set()
18920     *
18921     * @ingroup Genlist
18922     */
18923    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18924    /**
18925     * Set the timeout in seconds for the longpress event.
18926     *
18927     * @param obj The genlist object
18928     * @param timeout timeout in seconds. Default is 1.
18929     *
18930     * This option will change how long it takes to send an event "longpressed"
18931     * after the mouse down signal is sent to the list. If this event occurs, no
18932     * "clicked" event will be sent.
18933     *
18934     * @see elm_genlist_longpress_timeout_set()
18935     *
18936     * @ingroup Genlist
18937     */
18938    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18939    /**
18940     * Get the timeout in seconds for the longpress event.
18941     *
18942     * @param obj The genlist object
18943     * @return timeout in seconds
18944     *
18945     * @see elm_genlist_longpress_timeout_get()
18946     *
18947     * @ingroup Genlist
18948     */
18949    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18950    /**
18951     * Append a new item in a given genlist widget.
18952     *
18953     * @param obj The genlist object
18954     * @param itc The item class for the item
18955     * @param data The item data
18956     * @param parent The parent item, or NULL if none
18957     * @param flags Item flags
18958     * @param func Convenience function called when the item is selected
18959     * @param func_data Data passed to @p func above.
18960     * @return A handle to the item added or @c NULL if not possible
18961     *
18962     * This adds the given item to the end of the list or the end of
18963     * the children list if the @p parent is given.
18964     *
18965     * @see elm_genlist_item_prepend()
18966     * @see elm_genlist_item_insert_before()
18967     * @see elm_genlist_item_insert_after()
18968     * @see elm_genlist_item_del()
18969     *
18970     * @ingroup Genlist
18971     */
18972    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);
18973    /**
18974     * Prepend a new item in a given genlist widget.
18975     *
18976     * @param obj The genlist object
18977     * @param itc The item class for the item
18978     * @param data The item data
18979     * @param parent The parent item, or NULL if none
18980     * @param flags Item flags
18981     * @param func Convenience function called when the item is selected
18982     * @param func_data Data passed to @p func above.
18983     * @return A handle to the item added or NULL if not possible
18984     *
18985     * This adds an item to the beginning of the list or beginning of the
18986     * children of the parent if given.
18987     *
18988     * @see elm_genlist_item_append()
18989     * @see elm_genlist_item_insert_before()
18990     * @see elm_genlist_item_insert_after()
18991     * @see elm_genlist_item_del()
18992     *
18993     * @ingroup Genlist
18994     */
18995    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);
18996    /**
18997     * Insert an item before another in a genlist widget
18998     *
18999     * @param obj The genlist object
19000     * @param itc The item class for the item
19001     * @param data The item data
19002     * @param before The item to place this new one before.
19003     * @param flags Item flags
19004     * @param func Convenience function called when the item is selected
19005     * @param func_data Data passed to @p func above.
19006     * @return A handle to the item added or @c NULL if not possible
19007     *
19008     * This inserts an item before another in the list. It will be in the
19009     * same tree level or group as the item it is inserted before.
19010     *
19011     * @see elm_genlist_item_append()
19012     * @see elm_genlist_item_prepend()
19013     * @see elm_genlist_item_insert_after()
19014     * @see elm_genlist_item_del()
19015     *
19016     * @ingroup Genlist
19017     */
19018    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);
19019    /**
19020     * Insert an item after another in a genlist widget
19021     *
19022     * @param obj The genlist object
19023     * @param itc The item class for the item
19024     * @param data The item data
19025     * @param after The item to place this new one after.
19026     * @param flags Item flags
19027     * @param func Convenience function called when the item is selected
19028     * @param func_data Data passed to @p func above.
19029     * @return A handle to the item added or @c NULL if not possible
19030     *
19031     * This inserts an item after another in the list. It will be in the
19032     * same tree level or group as the item it is inserted after.
19033     *
19034     * @see elm_genlist_item_append()
19035     * @see elm_genlist_item_prepend()
19036     * @see elm_genlist_item_insert_before()
19037     * @see elm_genlist_item_del()
19038     *
19039     * @ingroup Genlist
19040     */
19041    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);
19042    /**
19043     * Insert a new item into the sorted genlist object
19044     *
19045     * @param obj The genlist object
19046     * @param itc The item class for the item
19047     * @param data The item data
19048     * @param parent The parent item, or NULL if none
19049     * @param flags Item flags
19050     * @param comp The function called for the sort
19051     * @param func Convenience function called when item selected
19052     * @param func_data Data passed to @p func above.
19053     * @return A handle to the item added or NULL if not possible
19054     *
19055     * @ingroup Genlist
19056     */
19057    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);
19058    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);
19059    /* operations to retrieve existing items */
19060    /**
19061     * Get the selectd item in the genlist.
19062     *
19063     * @param obj The genlist object
19064     * @return The selected item, or NULL if none is selected.
19065     *
19066     * This gets the selected item in the list (if multi-selection is enabled, only
19067     * the item that was first selected in the list is returned - which is not very
19068     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19069     * used).
19070     *
19071     * If no item is selected, NULL is returned.
19072     *
19073     * @see elm_genlist_selected_items_get()
19074     *
19075     * @ingroup Genlist
19076     */
19077    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19078    /**
19079     * Get a list of selected items in the genlist.
19080     *
19081     * @param obj The genlist object
19082     * @return The list of selected items, or NULL if none are selected.
19083     *
19084     * It returns a list of the selected items. This list pointer is only valid so
19085     * long as the selection doesn't change (no items are selected or unselected, or
19086     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19087     * pointers. The order of the items in this list is the order which they were
19088     * selected, i.e. the first item in this list is the first item that was
19089     * selected, and so on.
19090     *
19091     * @note If not in multi-select mode, consider using function
19092     * elm_genlist_selected_item_get() instead.
19093     *
19094     * @see elm_genlist_multi_select_set()
19095     * @see elm_genlist_selected_item_get()
19096     *
19097     * @ingroup Genlist
19098     */
19099    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19100    /**
19101     * Get the mode item style of items in the genlist
19102     * @param obj The genlist object
19103     * @return The mode item style string, or NULL if none is specified
19104     * 
19105     * This is a constant string and simply defines the name of the
19106     * style that will be used for mode animations. It can be
19107     * @c NULL if you don't plan to use Genlist mode. See
19108     * elm_genlist_item_mode_set() for more info.
19109     * 
19110     * @ingroup Genlist
19111     */
19112    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19113    /**
19114     * Set the mode item style of items in the genlist
19115     * @param obj The genlist object
19116     * @param style The mode item style string, or NULL if none is desired
19117     * 
19118     * This is a constant string and simply defines the name of the
19119     * style that will be used for mode animations. It can be
19120     * @c NULL if you don't plan to use Genlist mode. See
19121     * elm_genlist_item_mode_set() for more info.
19122     * 
19123     * @ingroup Genlist
19124     */
19125    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19126    /**
19127     * Get a list of realized items in genlist
19128     *
19129     * @param obj The genlist object
19130     * @return The list of realized items, nor NULL if none are realized.
19131     *
19132     * This returns a list of the realized items in the genlist. The list
19133     * contains Elm_Genlist_Item pointers. The list must be freed by the
19134     * caller when done with eina_list_free(). The item pointers in the
19135     * list are only valid so long as those items are not deleted or the
19136     * genlist is not deleted.
19137     *
19138     * @see elm_genlist_realized_items_update()
19139     *
19140     * @ingroup Genlist
19141     */
19142    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19143    /**
19144     * Get the item that is at the x, y canvas coords.
19145     *
19146     * @param obj The gelinst object.
19147     * @param x The input x coordinate
19148     * @param y The input y coordinate
19149     * @param posret The position relative to the item returned here
19150     * @return The item at the coordinates or NULL if none
19151     *
19152     * This returns the item at the given coordinates (which are canvas
19153     * relative, not object-relative). If an item is at that coordinate,
19154     * that item handle is returned, and if @p posret is not NULL, the
19155     * integer pointed to is set to a value of -1, 0 or 1, depending if
19156     * the coordinate is on the upper portion of that item (-1), on the
19157     * middle section (0) or on the lower part (1). If NULL is returned as
19158     * an item (no item found there), then posret may indicate -1 or 1
19159     * based if the coordinate is above or below all items respectively in
19160     * the genlist.
19161     *
19162     * @ingroup Genlist
19163     */
19164    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);
19165    /**
19166     * Get the first item in the genlist
19167     *
19168     * This returns the first item in the list.
19169     *
19170     * @param obj The genlist object
19171     * @return The first item, or NULL if none
19172     *
19173     * @ingroup Genlist
19174     */
19175    WILL_DEPRECATE  EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19176    /**
19177     * Get the last item in the genlist
19178     *
19179     * This returns the last item in the list.
19180     *
19181     * @return The last item, or NULL if none
19182     *
19183     * @ingroup Genlist
19184     */
19185    WILL_DEPRECATE  EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19186    /**
19187     * Set the scrollbar policy
19188     *
19189     * @param obj The genlist object
19190     * @param policy_h Horizontal scrollbar policy.
19191     * @param policy_v Vertical scrollbar policy.
19192     *
19193     * This sets the scrollbar visibility policy for the given genlist
19194     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19195     * made visible if it is needed, and otherwise kept hidden.
19196     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19197     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19198     * respectively for the horizontal and vertical scrollbars. Default is
19199     * #ELM_SMART_SCROLLER_POLICY_AUTO
19200     *
19201     * @see elm_genlist_scroller_policy_get()
19202     *
19203     * @ingroup Genlist
19204     */
19205    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19206    /**
19207     * Get the scrollbar policy
19208     *
19209     * @param obj The genlist object
19210     * @param policy_h Pointer to store the horizontal scrollbar policy.
19211     * @param policy_v Pointer to store the vertical scrollbar policy.
19212     *
19213     * @see elm_genlist_scroller_policy_set()
19214     *
19215     * @ingroup Genlist
19216     */
19217    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);
19218    /**
19219     * Get the @b next item in a genlist widget's internal list of items,
19220     * given a handle to one of those items.
19221     *
19222     * @param item The genlist item to fetch next from
19223     * @return The item after @p item, or @c NULL if there's none (and
19224     * on errors)
19225     *
19226     * This returns the item placed after the @p item, on the container
19227     * genlist.
19228     *
19229     * @see elm_genlist_item_prev_get()
19230     *
19231     * @ingroup Genlist
19232     */
19233    WILL_DEPRECATE  EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19234    /**
19235     * Get the @b previous item in a genlist widget's internal list of items,
19236     * given a handle to one of those items.
19237     *
19238     * @param item The genlist item to fetch previous from
19239     * @return The item before @p item, or @c NULL if there's none (and
19240     * on errors)
19241     *
19242     * This returns the item placed before the @p item, on the container
19243     * genlist.
19244     *
19245     * @see elm_genlist_item_next_get()
19246     *
19247     * @ingroup Genlist
19248     */
19249    WILL_DEPRECATE  EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19250    /**
19251     * Get the genlist object's handle which contains a given genlist
19252     * item
19253     *
19254     * @param item The item to fetch the container from
19255     * @return The genlist (parent) object
19256     *
19257     * This returns the genlist object itself that an item belongs to.
19258     *
19259     * This function is deprecated. Please use elm_gen_item_widget_get()
19260     * 
19261     * @ingroup Genlist
19262     */
19263    WILL_DEPRECATE  EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19264    /**
19265     * Get the parent item of the given item
19266     *
19267     * @param it The item
19268     * @return The parent of the item or @c NULL if it has no parent.
19269     *
19270     * This returns the item that was specified as parent of the item @p it on
19271     * elm_genlist_item_append() and insertion related functions.
19272     *
19273     * @ingroup Genlist
19274     */
19275    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19276    /**
19277     * Remove all sub-items (children) of the given item
19278     *
19279     * @param it The item
19280     *
19281     * This removes all items that are children (and their descendants) of the
19282     * given item @p it.
19283     *
19284     * @see elm_genlist_clear()
19285     * @see elm_genlist_item_del()
19286     *
19287     * @ingroup Genlist
19288     */
19289    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19290    /**
19291     * Set whether a given genlist item is selected or not
19292     *
19293     * @param it The item
19294     * @param selected Use @c EINA_TRUE, to make it selected, @c
19295     * EINA_FALSE to make it unselected
19296     *
19297     * This sets the selected state of an item. If multi selection is
19298     * not enabled on the containing genlist and @p selected is @c
19299     * EINA_TRUE, any other previously selected items will get
19300     * unselected in favor of this new one.
19301     *
19302     * @see elm_genlist_item_selected_get()
19303     *
19304     * @ingroup Genlist
19305     */
19306    WILL_DEPRECATE  EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19307    /**
19308     * Get whether a given genlist item is selected or not
19309     *
19310     * @param it The item
19311     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19312     *
19313     * @see elm_genlist_item_selected_set() for more details
19314     *
19315     * @ingroup Genlist
19316     */
19317    WILL_DEPRECATE  EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19318    /**
19319     * Sets the expanded state of an item.
19320     *
19321     * @param it The item
19322     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19323     *
19324     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19325     * expanded or not.
19326     *
19327     * The theme will respond to this change visually, and a signal "expanded" or
19328     * "contracted" will be sent from the genlist with a pointer to the item that
19329     * has been expanded/contracted.
19330     *
19331     * Calling this function won't show or hide any child of this item (if it is
19332     * a parent). You must manually delete and create them on the callbacks fo
19333     * the "expanded" or "contracted" signals.
19334     *
19335     * @see elm_genlist_item_expanded_get()
19336     *
19337     * @ingroup Genlist
19338     */
19339    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19340    /**
19341     * Get the expanded state of an item
19342     *
19343     * @param it The item
19344     * @return The expanded state
19345     *
19346     * This gets the expanded state of an item.
19347     *
19348     * @see elm_genlist_item_expanded_set()
19349     *
19350     * @ingroup Genlist
19351     */
19352    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19353    /**
19354     * Get the depth of expanded item
19355     *
19356     * @param it The genlist item object
19357     * @return The depth of expanded item
19358     *
19359     * @ingroup Genlist
19360     */
19361    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19362    /**
19363     * Set whether a given genlist item is disabled or not.
19364     *
19365     * @param it The item
19366     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19367     * to enable it back.
19368     *
19369     * A disabled item cannot be selected or unselected. It will also
19370     * change its appearance, to signal the user it's disabled.
19371     *
19372     * @see elm_genlist_item_disabled_get()
19373     *
19374     * @ingroup Genlist
19375     */
19376    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19377    /**
19378     * Get whether a given genlist item is disabled or not.
19379     *
19380     * @param it The item
19381     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19382     * (and on errors).
19383     *
19384     * @see elm_genlist_item_disabled_set() for more details
19385     *
19386     * @ingroup Genlist
19387     */
19388    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19389    /**
19390     * Sets the display only state of an item.
19391     *
19392     * @param it The item
19393     * @param display_only @c EINA_TRUE if the item is display only, @c
19394     * EINA_FALSE otherwise.
19395     *
19396     * A display only item cannot be selected or unselected. It is for
19397     * display only and not selecting or otherwise clicking, dragging
19398     * etc. by the user, thus finger size rules will not be applied to
19399     * this item.
19400     *
19401     * It's good to set group index items to display only state.
19402     *
19403     * @see elm_genlist_item_display_only_get()
19404     *
19405     * @ingroup Genlist
19406     */
19407    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19408    /**
19409     * Get the display only state of an item
19410     *
19411     * @param it The item
19412     * @return @c EINA_TRUE if the item is display only, @c
19413     * EINA_FALSE otherwise.
19414     *
19415     * @see elm_genlist_item_display_only_set()
19416     *
19417     * @ingroup Genlist
19418     */
19419    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19420    /**
19421     * Show the portion of a genlist's internal list containing a given
19422     * item, immediately.
19423     *
19424     * @param it The item to display
19425     *
19426     * This causes genlist to jump to the given item @p it and show it (by
19427     * immediately scrolling to that position), if it is not fully visible.
19428     *
19429     * @see elm_genlist_item_bring_in()
19430     * @see elm_genlist_item_top_show()
19431     * @see elm_genlist_item_middle_show()
19432     *
19433     * @ingroup Genlist
19434     */
19435    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19436    /**
19437     * Animatedly bring in, to the visible are of a genlist, a given
19438     * item on it.
19439     *
19440     * @param it The item to display
19441     *
19442     * This causes genlist to jump to the given item @p it and show it (by
19443     * animatedly scrolling), if it is not fully visible. This may use animation
19444     * to do so and take a period of time
19445     *
19446     * @see elm_genlist_item_show()
19447     * @see elm_genlist_item_top_bring_in()
19448     * @see elm_genlist_item_middle_bring_in()
19449     *
19450     * @ingroup Genlist
19451     */
19452    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19453    /**
19454     * Show the portion of a genlist's internal list containing a given
19455     * item, immediately.
19456     *
19457     * @param it The item to display
19458     *
19459     * This causes genlist to jump to the given item @p it and show it (by
19460     * immediately scrolling to that position), if it is not fully visible.
19461     *
19462     * The item will be positioned at the top of the genlist viewport.
19463     *
19464     * @see elm_genlist_item_show()
19465     * @see elm_genlist_item_top_bring_in()
19466     *
19467     * @ingroup Genlist
19468     */
19469    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19470    /**
19471     * Animatedly bring in, to the visible are of a genlist, a given
19472     * item on it.
19473     *
19474     * @param it The item
19475     *
19476     * This causes genlist to jump to the given item @p it and show it (by
19477     * animatedly scrolling), if it is not fully visible. This may use animation
19478     * to do so and take a period of time
19479     *
19480     * The item will be positioned at the top of the genlist viewport.
19481     *
19482     * @see elm_genlist_item_bring_in()
19483     * @see elm_genlist_item_top_show()
19484     *
19485     * @ingroup Genlist
19486     */
19487    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19488    /**
19489     * Show the portion of a genlist's internal list containing a given
19490     * item, immediately.
19491     *
19492     * @param it The item to display
19493     *
19494     * This causes genlist to jump to the given item @p it and show it (by
19495     * immediately scrolling to that position), if it is not fully visible.
19496     *
19497     * The item will be positioned at the middle of the genlist viewport.
19498     *
19499     * @see elm_genlist_item_show()
19500     * @see elm_genlist_item_middle_bring_in()
19501     *
19502     * @ingroup Genlist
19503     */
19504    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19505    /**
19506     * Animatedly bring in, to the visible are of a genlist, a given
19507     * item on it.
19508     *
19509     * @param it The item
19510     *
19511     * This causes genlist to jump to the given item @p it and show it (by
19512     * animatedly scrolling), if it is not fully visible. This may use animation
19513     * to do so and take a period of time
19514     *
19515     * The item will be positioned at the middle of the genlist viewport.
19516     *
19517     * @see elm_genlist_item_bring_in()
19518     * @see elm_genlist_item_middle_show()
19519     *
19520     * @ingroup Genlist
19521     */
19522    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19523    /**
19524     * Remove a genlist item from the its parent, deleting it.
19525     *
19526     * @param item The item to be removed.
19527     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19528     *
19529     * @see elm_genlist_clear(), to remove all items in a genlist at
19530     * once.
19531     *
19532     * @ingroup Genlist
19533     */
19534    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19535    /**
19536     * Return the data associated to a given genlist item
19537     *
19538     * @param item The genlist item.
19539     * @return the data associated to this item.
19540     *
19541     * This returns the @c data value passed on the
19542     * elm_genlist_item_append() and related item addition calls.
19543     *
19544     * @see elm_genlist_item_append()
19545     * @see elm_genlist_item_data_set()
19546     *
19547     * @ingroup Genlist
19548     */
19549    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19550    /**
19551     * Set the data associated to a given genlist item
19552     *
19553     * @param item The genlist item
19554     * @param data The new data pointer to set on it
19555     *
19556     * This @b overrides the @c data value passed on the
19557     * elm_genlist_item_append() and related item addition calls. This
19558     * function @b won't call elm_genlist_item_update() automatically,
19559     * so you'd issue it afterwards if you want to hove the item
19560     * updated to reflect the that new data.
19561     *
19562     * @see elm_genlist_item_data_get()
19563     *
19564     * @ingroup Genlist
19565     */
19566    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19567    /**
19568     * Tells genlist to "orphan" icons fetchs by the item class
19569     *
19570     * @param it The item
19571     *
19572     * This instructs genlist to release references to icons in the item,
19573     * meaning that they will no longer be managed by genlist and are
19574     * floating "orphans" that can be re-used elsewhere if the user wants
19575     * to.
19576     *
19577     * @ingroup Genlist
19578     */
19579    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19580    WILL_DEPRECATE  EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19581    /**
19582     * Get the real Evas object created to implement the view of a
19583     * given genlist item
19584     *
19585     * @param item The genlist item.
19586     * @return the Evas object implementing this item's view.
19587     *
19588     * This returns the actual Evas object used to implement the
19589     * specified genlist item's view. This may be @c NULL, as it may
19590     * not have been created or may have been deleted, at any time, by
19591     * the genlist. <b>Do not modify this object</b> (move, resize,
19592     * show, hide, etc.), as the genlist is controlling it. This
19593     * function is for querying, emitting custom signals or hooking
19594     * lower level callbacks for events on that object. Do not delete
19595     * this object under any circumstances.
19596     *
19597     * @see elm_genlist_item_data_get()
19598     *
19599     * @ingroup Genlist
19600     */
19601    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19602    /**
19603     * Update the contents of an item
19604     *
19605     * @param it The item
19606     *
19607     * This updates an item by calling all the item class functions again
19608     * to get the icons, labels and states. Use this when the original
19609     * item data has changed and the changes are desired to be reflected.
19610     *
19611     * Use elm_genlist_realized_items_update() to update all already realized
19612     * items.
19613     *
19614     * @see elm_genlist_realized_items_update()
19615     *
19616     * @ingroup Genlist
19617     */
19618    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19619    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19620    /**
19621     * Update the item class of an item
19622     *
19623     * @param it The item
19624     * @param itc The item class for the item
19625     *
19626     * This sets another class fo the item, changing the way that it is
19627     * displayed. After changing the item class, elm_genlist_item_update() is
19628     * called on the item @p it.
19629     *
19630     * @ingroup Genlist
19631     */
19632    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19633    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19634    /**
19635     * Set the text to be shown in a given genlist item's tooltips.
19636     *
19637     * @param item The genlist item
19638     * @param text The text to set in the content
19639     *
19640     * This call will setup the text to be used as tooltip to that item
19641     * (analogous to elm_object_tooltip_text_set(), but being item
19642     * tooltips with higher precedence than object tooltips). It can
19643     * have only one tooltip at a time, so any previous tooltip data
19644     * will get removed.
19645     *
19646     * In order to set an icon or something else as a tooltip, look at
19647     * elm_genlist_item_tooltip_content_cb_set().
19648     *
19649     * @ingroup Genlist
19650     */
19651    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19652    /**
19653     * Set the content to be shown in a given genlist item's tooltips
19654     *
19655     * @param item The genlist item.
19656     * @param func The function returning the tooltip contents.
19657     * @param data What to provide to @a func as callback data/context.
19658     * @param del_cb Called when data is not needed anymore, either when
19659     *        another callback replaces @p func, the tooltip is unset with
19660     *        elm_genlist_item_tooltip_unset() or the owner @p item
19661     *        dies. This callback receives as its first parameter the
19662     *        given @p data, being @c event_info the item handle.
19663     *
19664     * This call will setup the tooltip's contents to @p item
19665     * (analogous to elm_object_tooltip_content_cb_set(), but being
19666     * item tooltips with higher precedence than object tooltips). It
19667     * can have only one tooltip at a time, so any previous tooltip
19668     * content will get removed. @p func (with @p data) will be called
19669     * every time Elementary needs to show the tooltip and it should
19670     * return a valid Evas object, which will be fully managed by the
19671     * tooltip system, getting deleted when the tooltip is gone.
19672     *
19673     * In order to set just a text as a tooltip, look at
19674     * elm_genlist_item_tooltip_text_set().
19675     *
19676     * @ingroup Genlist
19677     */
19678    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);
19679    /**
19680     * Unset a tooltip from a given genlist item
19681     *
19682     * @param item genlist item to remove a previously set tooltip from.
19683     *
19684     * This call removes any tooltip set on @p item. The callback
19685     * provided as @c del_cb to
19686     * elm_genlist_item_tooltip_content_cb_set() will be called to
19687     * notify it is not used anymore (and have resources cleaned, if
19688     * need be).
19689     *
19690     * @see elm_genlist_item_tooltip_content_cb_set()
19691     *
19692     * @ingroup Genlist
19693     */
19694    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19695    /**
19696     * Set a different @b style for a given genlist item's tooltip.
19697     *
19698     * @param item genlist item with tooltip set
19699     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19700     * "default", @c "transparent", etc)
19701     *
19702     * Tooltips can have <b>alternate styles</b> to be displayed on,
19703     * which are defined by the theme set on Elementary. This function
19704     * works analogously as elm_object_tooltip_style_set(), but here
19705     * applied only to genlist item objects. The default style for
19706     * tooltips is @c "default".
19707     *
19708     * @note before you set a style you should define a tooltip with
19709     *       elm_genlist_item_tooltip_content_cb_set() or
19710     *       elm_genlist_item_tooltip_text_set()
19711     *
19712     * @see elm_genlist_item_tooltip_style_get()
19713     *
19714     * @ingroup Genlist
19715     */
19716    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19717    /**
19718     * Get the style set a given genlist item's tooltip.
19719     *
19720     * @param item genlist item with tooltip already set on.
19721     * @return style the theme style in use, which defaults to
19722     *         "default". If the object does not have a tooltip set,
19723     *         then @c NULL is returned.
19724     *
19725     * @see elm_genlist_item_tooltip_style_set() for more details
19726     *
19727     * @ingroup Genlist
19728     */
19729    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19730    /**
19731     * @brief Disable size restrictions on an object's tooltip
19732     * @param item The tooltip's anchor object
19733     * @param disable If EINA_TRUE, size restrictions are disabled
19734     * @return EINA_FALSE on failure, EINA_TRUE on success
19735     *
19736     * This function allows a tooltip to expand beyond its parant window's canvas.
19737     * It will instead be limited only by the size of the display.
19738     */
19739    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19740    /**
19741     * @brief Retrieve size restriction state of an object's tooltip
19742     * @param item The tooltip's anchor object
19743     * @return If EINA_TRUE, size restrictions are disabled
19744     *
19745     * This function returns whether a tooltip is allowed to expand beyond
19746     * its parant window's canvas.
19747     * It will instead be limited only by the size of the display.
19748     */
19749    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19750    /**
19751     * Set the type of mouse pointer/cursor decoration to be shown,
19752     * when the mouse pointer is over the given genlist widget item
19753     *
19754     * @param item genlist item to customize cursor on
19755     * @param cursor the cursor type's name
19756     *
19757     * This function works analogously as elm_object_cursor_set(), but
19758     * here the cursor's changing area is restricted to the item's
19759     * area, and not the whole widget's. Note that that item cursors
19760     * have precedence over widget cursors, so that a mouse over @p
19761     * item will always show cursor @p type.
19762     *
19763     * If this function is called twice for an object, a previously set
19764     * cursor will be unset on the second call.
19765     *
19766     * @see elm_object_cursor_set()
19767     * @see elm_genlist_item_cursor_get()
19768     * @see elm_genlist_item_cursor_unset()
19769     *
19770     * @ingroup Genlist
19771     */
19772    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19773    /**
19774     * Get the type of mouse pointer/cursor decoration set to be shown,
19775     * when the mouse pointer is over the given genlist widget item
19776     *
19777     * @param item genlist item with custom cursor set
19778     * @return the cursor type's name or @c NULL, if no custom cursors
19779     * were set to @p item (and on errors)
19780     *
19781     * @see elm_object_cursor_get()
19782     * @see elm_genlist_item_cursor_set() for more details
19783     * @see elm_genlist_item_cursor_unset()
19784     *
19785     * @ingroup Genlist
19786     */
19787    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19788    /**
19789     * Unset any custom mouse pointer/cursor decoration set to be
19790     * shown, when the mouse pointer is over the given genlist widget
19791     * item, thus making it show the @b default cursor again.
19792     *
19793     * @param item a genlist item
19794     *
19795     * Use this call to undo any custom settings on this item's cursor
19796     * decoration, bringing it back to defaults (no custom style set).
19797     *
19798     * @see elm_object_cursor_unset()
19799     * @see elm_genlist_item_cursor_set() for more details
19800     *
19801     * @ingroup Genlist
19802     */
19803    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19804    /**
19805     * Set a different @b style for a given custom cursor set for a
19806     * genlist item.
19807     *
19808     * @param item genlist item with custom cursor set
19809     * @param style the <b>theme style</b> to use (e.g. @c "default",
19810     * @c "transparent", etc)
19811     *
19812     * This function only makes sense when one is using custom mouse
19813     * cursor decorations <b>defined in a theme file</b> , which can
19814     * have, given a cursor name/type, <b>alternate styles</b> on
19815     * it. It works analogously as elm_object_cursor_style_set(), but
19816     * here applied only to genlist item objects.
19817     *
19818     * @warning Before you set a cursor style you should have defined a
19819     *       custom cursor previously on the item, with
19820     *       elm_genlist_item_cursor_set()
19821     *
19822     * @see elm_genlist_item_cursor_engine_only_set()
19823     * @see elm_genlist_item_cursor_style_get()
19824     *
19825     * @ingroup Genlist
19826     */
19827    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19828    /**
19829     * Get the current @b style set for a given genlist item's custom
19830     * cursor
19831     *
19832     * @param item genlist item with custom cursor set.
19833     * @return style the cursor style in use. If the object does not
19834     *         have a cursor set, then @c NULL is returned.
19835     *
19836     * @see elm_genlist_item_cursor_style_set() for more details
19837     *
19838     * @ingroup Genlist
19839     */
19840    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19841    /**
19842     * Set if the (custom) cursor for a given genlist item should be
19843     * searched in its theme, also, or should only rely on the
19844     * rendering engine.
19845     *
19846     * @param item item with custom (custom) cursor already set on
19847     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19848     * only on those provided by the rendering engine, @c EINA_FALSE to
19849     * have them searched on the widget's theme, as well.
19850     *
19851     * @note This call is of use only if you've set a custom cursor
19852     * for genlist items, with elm_genlist_item_cursor_set().
19853     *
19854     * @note By default, cursors will only be looked for between those
19855     * provided by the rendering engine.
19856     *
19857     * @ingroup Genlist
19858     */
19859    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19860    /**
19861     * Get if the (custom) cursor for a given genlist item is being
19862     * searched in its theme, also, or is only relying on the rendering
19863     * engine.
19864     *
19865     * @param item a genlist item
19866     * @return @c EINA_TRUE, if cursors are being looked for only on
19867     * those provided by the rendering engine, @c EINA_FALSE if they
19868     * are being searched on the widget's theme, as well.
19869     *
19870     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19871     *
19872     * @ingroup Genlist
19873     */
19874    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19875    /**
19876     * Update the contents of all realized items.
19877     *
19878     * @param obj The genlist object.
19879     *
19880     * This updates all realized items by calling all the item class functions again
19881     * to get the icons, labels and states. Use this when the original
19882     * item data has changed and the changes are desired to be reflected.
19883     *
19884     * To update just one item, use elm_genlist_item_update().
19885     *
19886     * @see elm_genlist_realized_items_get()
19887     * @see elm_genlist_item_update()
19888     *
19889     * @ingroup Genlist
19890     */
19891    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19892    /**
19893     * Activate a genlist mode on an item
19894     *
19895     * @param item The genlist item
19896     * @param mode Mode name
19897     * @param mode_set Boolean to define set or unset mode.
19898     *
19899     * A genlist mode is a different way of selecting an item. Once a mode is
19900     * activated on an item, any other selected item is immediately unselected.
19901     * This feature provides an easy way of implementing a new kind of animation
19902     * for selecting an item, without having to entirely rewrite the item style
19903     * theme. However, the elm_genlist_selected_* API can't be used to get what
19904     * item is activate for a mode.
19905     *
19906     * The current item style will still be used, but applying a genlist mode to
19907     * an item will select it using a different kind of animation.
19908     *
19909     * The current active item for a mode can be found by
19910     * elm_genlist_mode_item_get().
19911     *
19912     * The characteristics of genlist mode are:
19913     * - Only one mode can be active at any time, and for only one item.
19914     * - Genlist handles deactivating other items when one item is activated.
19915     * - A mode is defined in the genlist theme (edc), and more modes can easily
19916     *   be added.
19917     * - A mode style and the genlist item style are different things. They
19918     *   can be combined to provide a default style to the item, with some kind
19919     *   of animation for that item when the mode is activated.
19920     *
19921     * When a mode is activated on an item, a new view for that item is created.
19922     * The theme of this mode defines the animation that will be used to transit
19923     * the item from the old view to the new view. This second (new) view will be
19924     * active for that item while the mode is active on the item, and will be
19925     * destroyed after the mode is totally deactivated from that item.
19926     *
19927     * @see elm_genlist_mode_get()
19928     * @see elm_genlist_mode_item_get()
19929     *
19930     * @ingroup Genlist
19931     */
19932    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19933    /**
19934     * Get the last (or current) genlist mode used.
19935     *
19936     * @param obj The genlist object
19937     *
19938     * This function just returns the name of the last used genlist mode. It will
19939     * be the current mode if it's still active.
19940     *
19941     * @see elm_genlist_item_mode_set()
19942     * @see elm_genlist_mode_item_get()
19943     *
19944     * @ingroup Genlist
19945     */
19946    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19947    /**
19948     * Get active genlist mode item
19949     *
19950     * @param obj The genlist object
19951     * @return The active item for that current mode. Or @c NULL if no item is
19952     * activated with any mode.
19953     *
19954     * This function returns the item that was activated with a mode, by the
19955     * function elm_genlist_item_mode_set().
19956     *
19957     * @see elm_genlist_item_mode_set()
19958     * @see elm_genlist_mode_get()
19959     *
19960     * @ingroup Genlist
19961     */
19962    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19963
19964    /**
19965     * Set reorder mode
19966     *
19967     * @param obj The genlist object
19968     * @param reorder_mode The reorder mode
19969     * (EINA_TRUE = on, EINA_FALSE = off)
19970     *
19971     * @ingroup Genlist
19972     */
19973    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19974
19975    /**
19976     * Get the reorder mode
19977     *
19978     * @param obj The genlist object
19979     * @return The reorder mode
19980     * (EINA_TRUE = on, EINA_FALSE = off)
19981     *
19982     * @ingroup Genlist
19983     */
19984    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19985
19986    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19987    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19988    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19989    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19990    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19991    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19992    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19993    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19994    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19995    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19996
19997    /**
19998     * @}
19999     */
20000
20001    /**
20002     * @defgroup Check Check
20003     *
20004     * @image html img/widget/check/preview-00.png
20005     * @image latex img/widget/check/preview-00.eps
20006     * @image html img/widget/check/preview-01.png
20007     * @image latex img/widget/check/preview-01.eps
20008     * @image html img/widget/check/preview-02.png
20009     * @image latex img/widget/check/preview-02.eps
20010     *
20011     * @brief The check widget allows for toggling a value between true and
20012     * false.
20013     *
20014     * Check objects are a lot like radio objects in layout and functionality
20015     * except they do not work as a group, but independently and only toggle the
20016     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
20017     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
20018     * returns the current state. For convenience, like the radio objects, you
20019     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
20020     * for it to modify.
20021     *
20022     * Signals that you can add callbacks for are:
20023     * "changed" - This is called whenever the user changes the state of one of
20024     *             the check object(event_info is NULL).
20025     *
20026     * Default contents parts of the check widget that you can use for are:
20027     * @li "icon" - A icon of the check
20028     *
20029     * Default text parts of the check widget that you can use for are:
20030     * @li "elm.text" - Label of the check
20031     *
20032     * @ref tutorial_check should give you a firm grasp of how to use this widget
20033     * .
20034     * @{
20035     */
20036    /**
20037     * @brief Add a new Check object
20038     *
20039     * @param parent The parent object
20040     * @return The new object or NULL if it cannot be created
20041     */
20042    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20043    /**
20044     * @brief Set the text label of the check object
20045     *
20046     * @param obj The check object
20047     * @param label The text label string in UTF-8
20048     *
20049     * @deprecated use elm_object_text_set() instead.
20050     */
20051    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20052    /**
20053     * @brief Get the text label of the check object
20054     *
20055     * @param obj The check object
20056     * @return The text label string in UTF-8
20057     *
20058     * @deprecated use elm_object_text_get() instead.
20059     */
20060    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20061    /**
20062     * @brief Set the icon object of the check object
20063     *
20064     * @param obj The check object
20065     * @param icon The icon object
20066     *
20067     * Once the icon object is set, a previously set one will be deleted.
20068     * If you want to keep that old content object, use the
20069     * elm_object_content_unset() function.
20070     *
20071     * @deprecated use elm_object_part_content_set() instead.
20072     *
20073     */
20074    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20075    /**
20076     * @brief Get the icon object of the check object
20077     *
20078     * @param obj The check object
20079     * @return The icon object
20080     *
20081     * @deprecated use elm_object_part_content_get() instead.
20082     *  
20083     */
20084    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20085    /**
20086     * @brief Unset the icon used for the check object
20087     *
20088     * @param obj The check object
20089     * @return The icon object that was being used
20090     *
20091     * Unparent and return the icon object which was set for this widget.
20092     *
20093     * @deprecated use elm_object_part_content_unset() instead.
20094     *
20095     */
20096    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20097    /**
20098     * @brief Set the on/off state of the check object
20099     *
20100     * @param obj The check object
20101     * @param state The state to use (1 == on, 0 == off)
20102     *
20103     * This sets the state of the check. If set
20104     * with elm_check_state_pointer_set() the state of that variable is also
20105     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20106     */
20107    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20108    /**
20109     * @brief Get the state of the check object
20110     *
20111     * @param obj The check object
20112     * @return The boolean state
20113     */
20114    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20115    /**
20116     * @brief Set a convenience pointer to a boolean to change
20117     *
20118     * @param obj The check object
20119     * @param statep Pointer to the boolean to modify
20120     *
20121     * This sets a pointer to a boolean, that, in addition to the check objects
20122     * state will also be modified directly. To stop setting the object pointed
20123     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20124     * then when this is called, the check objects state will also be modified to
20125     * reflect the value of the boolean @p statep points to, just like calling
20126     * elm_check_state_set().
20127     */
20128    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20129    /**
20130     * @}
20131     */
20132
20133    /* compatibility code for toggle controls */
20134
20135    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
20136      {
20137         Evas_Object *obj;
20138
20139         obj = elm_check_add(parent);
20140         elm_object_style_set(obj, "toggle");
20141         elm_object_part_text_set(obj, "on", "ON");
20142         elm_object_part_text_set(obj, "off", "OFF");
20143         return obj;
20144      }
20145
20146    EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
20147      {
20148         elm_object_text_set(obj, label);
20149      }
20150
20151    EINA_DEPRECATED EAPI extern inline const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20152      {
20153         return elm_object_text_get(obj);
20154      }
20155
20156    EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
20157      {
20158         elm_object_content_set(obj, icon);
20159      }
20160
20161    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20162      {
20163         return elm_object_content_get(obj);
20164      }
20165
20166    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
20167      {
20168         return elm_object_content_unset(obj);
20169      }
20170
20171    EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
20172      {
20173         elm_object_part_text_set(obj, "on", onlabel);
20174         elm_object_part_text_set(obj, "off", offlabel);
20175      }
20176
20177    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)
20178      {
20179         if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
20180         if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
20181      }
20182
20183    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
20184      {
20185         elm_check_state_set(obj, state);
20186      }
20187
20188    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20189      {
20190         return elm_check_state_get(obj);
20191      }
20192
20193    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
20194      {
20195         elm_check_state_pointer_set(obj, statep);
20196      }
20197
20198    /**
20199     * @defgroup Radio Radio
20200     *
20201     * @image html img/widget/radio/preview-00.png
20202     * @image latex img/widget/radio/preview-00.eps
20203     *
20204     * @brief Radio is a widget that allows for 1 or more options to be displayed
20205     * and have the user choose only 1 of them.
20206     *
20207     * A radio object contains an indicator, an optional Label and an optional
20208     * icon object. While it's possible to have a group of only one radio they,
20209     * are normally used in groups of 2 or more. To add a radio to a group use
20210     * elm_radio_group_add(). The radio object(s) will select from one of a set
20211     * of integer values, so any value they are configuring needs to be mapped to
20212     * a set of integers. To configure what value that radio object represents,
20213     * use  elm_radio_state_value_set() to set the integer it represents. To set
20214     * the value the whole group(which one is currently selected) is to indicate
20215     * use elm_radio_value_set() on any group member, and to get the groups value
20216     * use elm_radio_value_get(). For convenience the radio objects are also able
20217     * to directly set an integer(int) to the value that is selected. To specify
20218     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20219     * The radio objects will modify this directly. That implies the pointer must
20220     * point to valid memory for as long as the radio objects exist.
20221     *
20222     * Signals that you can add callbacks for are:
20223     * @li changed - This is called whenever the user changes the state of one of
20224     * the radio objects within the group of radio objects that work together.
20225     *
20226     * Default contents parts of the radio widget that you can use for are:
20227     * @li "icon" - A icon of the radio
20228     *
20229     * @ref tutorial_radio show most of this API in action.
20230     * @{
20231     */
20232    /**
20233     * @brief Add a new radio to the parent
20234     *
20235     * @param parent The parent object
20236     * @return The new object or NULL if it cannot be created
20237     */
20238    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20239    /**
20240     * @brief Set the text label of the radio object
20241     *
20242     * @param obj The radio object
20243     * @param label The text label string in UTF-8
20244     *
20245     * @deprecated use elm_object_text_set() instead.
20246     */
20247    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20248    /**
20249     * @brief Get the text label of the radio object
20250     *
20251     * @param obj The radio object
20252     * @return The text label string in UTF-8
20253     *
20254     * @deprecated use elm_object_text_set() instead.
20255     */
20256    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20257    /**
20258     * @brief Set the icon object of the radio object
20259     *
20260     * @param obj The radio object
20261     * @param icon The icon object
20262     *
20263     * Once the icon object is set, a previously set one will be deleted. If you
20264     * want to keep that old content object, use the elm_radio_icon_unset()
20265     * function.
20266     *
20267     * @deprecated use elm_object_part_content_set() instead.
20268     *
20269     */
20270    WILL_DEPRECATE  EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20271    /**
20272     * @brief Get the icon object of the radio object
20273     *
20274     * @param obj The radio object
20275     * @return The icon object
20276     *
20277     * @see elm_radio_icon_set()
20278     *
20279     * @deprecated use elm_object_part_content_get() instead.
20280     *
20281     */
20282    WILL_DEPRECATE  EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20283    /**
20284     * @brief Unset the icon used for the radio object
20285     *
20286     * @param obj The radio object
20287     * @return The icon object that was being used
20288     *
20289     * Unparent and return the icon object which was set for this widget.
20290     *
20291     * @see elm_radio_icon_set()
20292     * @deprecated use elm_object_part_content_unset() instead.
20293     *
20294     */
20295    WILL_DEPRECATE  EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20296    /**
20297     * @brief Add this radio to a group of other radio objects
20298     *
20299     * @param obj The radio object
20300     * @param group Any object whose group the @p obj is to join.
20301     *
20302     * Radio objects work in groups. Each member should have a different integer
20303     * value assigned. In order to have them work as a group, they need to know
20304     * about each other. This adds the given radio object to the group of which
20305     * the group object indicated is a member.
20306     */
20307    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20308    /**
20309     * @brief Set the integer value that this radio object represents
20310     *
20311     * @param obj The radio object
20312     * @param value The value to use if this radio object is selected
20313     *
20314     * This sets the value of the radio.
20315     */
20316    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20317    /**
20318     * @brief Get the integer value that this radio object represents
20319     *
20320     * @param obj The radio object
20321     * @return The value used if this radio object is selected
20322     *
20323     * This gets the value of the radio.
20324     *
20325     * @see elm_radio_value_set()
20326     */
20327    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20328    /**
20329     * @brief Set the value of the radio.
20330     *
20331     * @param obj The radio object
20332     * @param value The value to use for the group
20333     *
20334     * This sets the value of the radio group and will also set the value if
20335     * pointed to, to the value supplied, but will not call any callbacks.
20336     */
20337    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20338    /**
20339     * @brief Get the state of the radio object
20340     *
20341     * @param obj The radio object
20342     * @return The integer state
20343     */
20344    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20345    /**
20346     * @brief Set a convenience pointer to a integer to change
20347     *
20348     * @param obj The radio object
20349     * @param valuep Pointer to the integer to modify
20350     *
20351     * This sets a pointer to a integer, that, in addition to the radio objects
20352     * state will also be modified directly. To stop setting the object pointed
20353     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20354     * when this is called, the radio objects state will also be modified to
20355     * reflect the value of the integer valuep points to, just like calling
20356     * elm_radio_value_set().
20357     */
20358    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20359    /**
20360     * @}
20361     */
20362
20363    /**
20364     * @defgroup Pager Pager
20365     *
20366     * @image html img/widget/pager/preview-00.png
20367     * @image latex img/widget/pager/preview-00.eps
20368     *
20369     * @brief Widget that allows flipping between one or more ā€œpagesā€
20370     * of objects.
20371     *
20372     * The flipping between pages of objects is animated. All content
20373     * in the pager is kept in a stack, being the last content added
20374     * (visible one) on the top of that stack.
20375     *
20376     * Objects can be pushed or popped from the stack or deleted as
20377     * well. Pushes and pops will animate the widget accordingly to its
20378     * style (a pop will also delete the child object once the
20379     * animation is finished). Any object already in the pager can be
20380     * promoted to the top (from its current stacking position) through
20381     * the use of elm_pager_content_promote(). New objects are pushed
20382     * to the top with elm_pager_content_push(). When the top item is
20383     * no longer wanted, simply pop it with elm_pager_content_pop() and
20384     * it will also be deleted. If an object is no longer needed and is
20385     * not the top item, just delete it as normal. You can query which
20386     * objects are the top and bottom with
20387     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20388     *
20389     * Signals that you can add callbacks for are:
20390     * - @c "show,finished" - when a new page is actually shown on the top
20391     * - @c "hide,finished" - when a previous page is hidden
20392     *
20393     * Only after the first of that signals the child object is
20394     * guaranteed to be visible, as in @c evas_object_visible_get().
20395     *
20396     * This widget has the following styles available:
20397     * - @c "default"
20398     * - @c "fade"
20399     * - @c "fade_translucide"
20400     * - @c "fade_invisible"
20401     *
20402     * @note These styles affect only the flipping animations on the
20403     * default theme; the appearance when not animating is unaffected
20404     * by them.
20405     *
20406     * @ref tutorial_pager gives a good overview of the usage of the API.
20407     * @{
20408     */
20409
20410    /**
20411     * Add a new pager to the parent
20412     *
20413     * @param parent The parent object
20414     * @return The new object or NULL if it cannot be created
20415     *
20416     * @ingroup Pager
20417     */
20418    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20419
20420    /**
20421     * @brief Push an object to the top of the pager stack (and show it).
20422     *
20423     * @param obj The pager object
20424     * @param content The object to push
20425     *
20426     * The object pushed becomes a child of the pager, it will be controlled and
20427     * deleted when the pager is deleted.
20428     *
20429     * @note If the content is already in the stack use
20430     * elm_pager_content_promote().
20431     * @warning Using this function on @p content already in the stack results in
20432     * undefined behavior.
20433     */
20434    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20435
20436    /**
20437     * @brief Pop the object that is on top of the stack
20438     *
20439     * @param obj The pager object
20440     *
20441     * This pops the object that is on the top(visible) of the pager, makes it
20442     * disappear, then deletes the object. The object that was underneath it on
20443     * the stack will become visible.
20444     */
20445    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20446
20447    /**
20448     * @brief Moves an object already in the pager stack to the top of the stack.
20449     *
20450     * @param obj The pager object
20451     * @param content The object to promote
20452     *
20453     * This will take the @p content and move it to the top of the stack as
20454     * if it had been pushed there.
20455     *
20456     * @note If the content isn't already in the stack use
20457     * elm_pager_content_push().
20458     * @warning Using this function on @p content not already in the stack
20459     * results in undefined behavior.
20460     */
20461    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20462
20463    /**
20464     * @brief Return the object at the bottom of the pager stack
20465     *
20466     * @param obj The pager object
20467     * @return The bottom object or NULL if none
20468     */
20469    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20470
20471    /**
20472     * @brief  Return the object at the top of the pager stack
20473     *
20474     * @param obj The pager object
20475     * @return The top object or NULL if none
20476     */
20477    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20478
20479    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20480    EINA_DEPRECATED    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20481
20482    /**
20483     * @}
20484     */
20485
20486    /**
20487     * @defgroup Slideshow Slideshow
20488     *
20489     * @image html img/widget/slideshow/preview-00.png
20490     * @image latex img/widget/slideshow/preview-00.eps
20491     *
20492     * This widget, as the name indicates, is a pre-made image
20493     * slideshow panel, with API functions acting on (child) image
20494     * items presentation. Between those actions, are:
20495     * - advance to next/previous image
20496     * - select the style of image transition animation
20497     * - set the exhibition time for each image
20498     * - start/stop the slideshow
20499     *
20500     * The transition animations are defined in the widget's theme,
20501     * consequently new animations can be added without having to
20502     * update the widget's code.
20503     *
20504     * @section Slideshow_Items Slideshow items
20505     *
20506     * For slideshow items, just like for @ref Genlist "genlist" ones,
20507     * the user defines a @b classes, specifying functions that will be
20508     * called on the item's creation and deletion times.
20509     *
20510     * The #Elm_Slideshow_Item_Class structure contains the following
20511     * members:
20512     *
20513     * - @c func.get - When an item is displayed, this function is
20514     *   called, and it's where one should create the item object, de
20515     *   facto. For example, the object can be a pure Evas image object
20516     *   or an Elementary @ref Photocam "photocam" widget. See
20517     *   #SlideshowItemGetFunc.
20518     * - @c func.del - When an item is no more displayed, this function
20519     *   is called, where the user must delete any data associated to
20520     *   the item. See #SlideshowItemDelFunc.
20521     *
20522     * @section Slideshow_Caching Slideshow caching
20523     *
20524     * The slideshow provides facilities to have items adjacent to the
20525     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20526     * you, so that the system does not have to decode image data
20527     * anymore at the time it has to actually switch images on its
20528     * viewport. The user is able to set the numbers of items to be
20529     * cached @b before and @b after the current item, in the widget's
20530     * item list.
20531     *
20532     * Smart events one can add callbacks for are:
20533     *
20534     * - @c "changed" - when the slideshow switches its view to a new
20535     *   item
20536     *
20537     * List of examples for the slideshow widget:
20538     * @li @ref slideshow_example
20539     */
20540
20541    /**
20542     * @addtogroup Slideshow
20543     * @{
20544     */
20545
20546    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20547    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20548    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20549    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20550    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20551
20552    /**
20553     * @struct _Elm_Slideshow_Item_Class
20554     *
20555     * Slideshow item class definition. See @ref Slideshow_Items for
20556     * field details.
20557     */
20558    struct _Elm_Slideshow_Item_Class
20559      {
20560         struct _Elm_Slideshow_Item_Class_Func
20561           {
20562              SlideshowItemGetFunc get;
20563              SlideshowItemDelFunc del;
20564           } func;
20565      }; /**< #Elm_Slideshow_Item_Class member definitions */
20566
20567    /**
20568     * Add a new slideshow widget to the given parent Elementary
20569     * (container) object
20570     *
20571     * @param parent The parent object
20572     * @return A new slideshow widget handle or @c NULL, on errors
20573     *
20574     * This function inserts a new slideshow widget on the canvas.
20575     *
20576     * @ingroup Slideshow
20577     */
20578    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20579
20580    /**
20581     * Add (append) a new item in a given slideshow widget.
20582     *
20583     * @param obj The slideshow object
20584     * @param itc The item class for the item
20585     * @param data The item's data
20586     * @return A handle to the item added or @c NULL, on errors
20587     *
20588     * Add a new item to @p obj's internal list of items, appending it.
20589     * The item's class must contain the function really fetching the
20590     * image object to show for this item, which could be an Evas image
20591     * object or an Elementary photo, for example. The @p data
20592     * parameter is going to be passed to both class functions of the
20593     * item.
20594     *
20595     * @see #Elm_Slideshow_Item_Class
20596     * @see elm_slideshow_item_sorted_insert()
20597     *
20598     * @ingroup Slideshow
20599     */
20600    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20601
20602    /**
20603     * Insert a new item into the given slideshow widget, using the @p func
20604     * function to sort items (by item handles).
20605     *
20606     * @param obj The slideshow object
20607     * @param itc The item class for the item
20608     * @param data The item's data
20609     * @param func The comparing function to be used to sort slideshow
20610     * items <b>by #Elm_Slideshow_Item item handles</b>
20611     * @return Returns The slideshow item handle, on success, or
20612     * @c NULL, on errors
20613     *
20614     * Add a new item to @p obj's internal list of items, in a position
20615     * determined by the @p func comparing function. The item's class
20616     * must contain the function really fetching the image object to
20617     * show for this item, which could be an Evas image object or an
20618     * Elementary photo, for example. The @p data parameter is going to
20619     * be passed to both class functions of the item.
20620     *
20621     * @see #Elm_Slideshow_Item_Class
20622     * @see elm_slideshow_item_add()
20623     *
20624     * @ingroup Slideshow
20625     */
20626    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);
20627
20628    /**
20629     * Display a given slideshow widget's item, programmatically.
20630     *
20631     * @param obj The slideshow object
20632     * @param item The item to display on @p obj's viewport
20633     *
20634     * The change between the current item and @p item will use the
20635     * transition @p obj is set to use (@see
20636     * elm_slideshow_transition_set()).
20637     *
20638     * @ingroup Slideshow
20639     */
20640    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20641
20642    /**
20643     * Slide to the @b next item, in a given slideshow widget
20644     *
20645     * @param obj The slideshow object
20646     *
20647     * The sliding animation @p obj is set to use will be the
20648     * transition effect used, after this call is issued.
20649     *
20650     * @note If the end of the slideshow's internal list of items is
20651     * reached, it'll wrap around to the list's beginning, again.
20652     *
20653     * @ingroup Slideshow
20654     */
20655    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20656
20657    /**
20658     * Slide to the @b previous item, in a given slideshow widget
20659     *
20660     * @param obj The slideshow object
20661     *
20662     * The sliding animation @p obj is set to use will be the
20663     * transition effect used, after this call is issued.
20664     *
20665     * @note If the beginning of the slideshow's internal list of items
20666     * is reached, it'll wrap around to the list's end, again.
20667     *
20668     * @ingroup Slideshow
20669     */
20670    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20671
20672    /**
20673     * Returns the list of sliding transition/effect names available, for a
20674     * given slideshow widget.
20675     *
20676     * @param obj The slideshow object
20677     * @return The list of transitions (list of @b stringshared strings
20678     * as data)
20679     *
20680     * The transitions, which come from @p obj's theme, must be an EDC
20681     * data item named @c "transitions" on the theme file, with (prefix)
20682     * names of EDC programs actually implementing them.
20683     *
20684     * The available transitions for slideshows on the default theme are:
20685     * - @c "fade" - the current item fades out, while the new one
20686     *   fades in to the slideshow's viewport.
20687     * - @c "black_fade" - the current item fades to black, and just
20688     *   then, the new item will fade in.
20689     * - @c "horizontal" - the current item slides horizontally, until
20690     *   it gets out of the slideshow's viewport, while the new item
20691     *   comes from the left to take its place.
20692     * - @c "vertical" - the current item slides vertically, until it
20693     *   gets out of the slideshow's viewport, while the new item comes
20694     *   from the bottom to take its place.
20695     * - @c "square" - the new item starts to appear from the middle of
20696     *   the current one, but with a tiny size, growing until its
20697     *   target (full) size and covering the old one.
20698     *
20699     * @warning The stringshared strings get no new references
20700     * exclusive to the user grabbing the list, here, so if you'd like
20701     * to use them out of this call's context, you'd better @c
20702     * eina_stringshare_ref() them.
20703     *
20704     * @see elm_slideshow_transition_set()
20705     *
20706     * @ingroup Slideshow
20707     */
20708    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20709
20710    /**
20711     * Set the current slide transition/effect in use for a given
20712     * slideshow widget
20713     *
20714     * @param obj The slideshow object
20715     * @param transition The new transition's name string
20716     *
20717     * If @p transition is implemented in @p obj's theme (i.e., is
20718     * contained in the list returned by
20719     * elm_slideshow_transitions_get()), this new sliding effect will
20720     * be used on the widget.
20721     *
20722     * @see elm_slideshow_transitions_get() for more details
20723     *
20724     * @ingroup Slideshow
20725     */
20726    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20727
20728    /**
20729     * Get the current slide transition/effect in use for a given
20730     * slideshow widget
20731     *
20732     * @param obj The slideshow object
20733     * @return The current transition's name
20734     *
20735     * @see elm_slideshow_transition_set() for more details
20736     *
20737     * @ingroup Slideshow
20738     */
20739    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20740
20741    /**
20742     * Set the interval between each image transition on a given
20743     * slideshow widget, <b>and start the slideshow, itself</b>
20744     *
20745     * @param obj The slideshow object
20746     * @param timeout The new displaying timeout for images
20747     *
20748     * After this call, the slideshow widget will start cycling its
20749     * view, sequentially and automatically, with the images of the
20750     * items it has. The time between each new image displayed is going
20751     * to be @p timeout, in @b seconds. If a different timeout was set
20752     * previously and an slideshow was in progress, it will continue
20753     * with the new time between transitions, after this call.
20754     *
20755     * @note A value less than or equal to 0 on @p timeout will disable
20756     * the widget's internal timer, thus halting any slideshow which
20757     * could be happening on @p obj.
20758     *
20759     * @see elm_slideshow_timeout_get()
20760     *
20761     * @ingroup Slideshow
20762     */
20763    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20764
20765    /**
20766     * Get the interval set for image transitions on a given slideshow
20767     * widget.
20768     *
20769     * @param obj The slideshow object
20770     * @return Returns the timeout set on it
20771     *
20772     * @see elm_slideshow_timeout_set() for more details
20773     *
20774     * @ingroup Slideshow
20775     */
20776    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20777
20778    /**
20779     * Set if, after a slideshow is started, for a given slideshow
20780     * widget, its items should be displayed cyclically or not.
20781     *
20782     * @param obj The slideshow object
20783     * @param loop Use @c EINA_TRUE to make it cycle through items or
20784     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20785     * list of items
20786     *
20787     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20788     * ignore what is set by this functions, i.e., they'll @b always
20789     * cycle through items. This affects only the "automatic"
20790     * slideshow, as set by elm_slideshow_timeout_set().
20791     *
20792     * @see elm_slideshow_loop_get()
20793     *
20794     * @ingroup Slideshow
20795     */
20796    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20797
20798    /**
20799     * Get if, after a slideshow is started, for a given slideshow
20800     * widget, its items are to be displayed cyclically or not.
20801     *
20802     * @param obj The slideshow object
20803     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20804     * through or @c EINA_FALSE, otherwise
20805     *
20806     * @see elm_slideshow_loop_set() for more details
20807     *
20808     * @ingroup Slideshow
20809     */
20810    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20811
20812    /**
20813     * Remove all items from a given slideshow widget
20814     *
20815     * @param obj The slideshow object
20816     *
20817     * This removes (and deletes) all items in @p obj, leaving it
20818     * empty.
20819     *
20820     * @see elm_slideshow_item_del(), to remove just one item.
20821     *
20822     * @ingroup Slideshow
20823     */
20824    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20825
20826    /**
20827     * Get the internal list of items in a given slideshow widget.
20828     *
20829     * @param obj The slideshow object
20830     * @return The list of items (#Elm_Slideshow_Item as data) or
20831     * @c NULL on errors.
20832     *
20833     * This list is @b not to be modified in any way and must not be
20834     * freed. Use the list members with functions like
20835     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20836     *
20837     * @warning This list is only valid until @p obj object's internal
20838     * items list is changed. It should be fetched again with another
20839     * call to this function when changes happen.
20840     *
20841     * @ingroup Slideshow
20842     */
20843    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20844
20845    /**
20846     * Delete a given item from a slideshow widget.
20847     *
20848     * @param item The slideshow item
20849     *
20850     * @ingroup Slideshow
20851     */
20852    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20853
20854    /**
20855     * Return the data associated with a given slideshow item
20856     *
20857     * @param item The slideshow item
20858     * @return Returns the data associated to this item
20859     *
20860     * @ingroup Slideshow
20861     */
20862    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20863
20864    /**
20865     * Returns the currently displayed item, in a given slideshow widget
20866     *
20867     * @param obj The slideshow object
20868     * @return A handle to the item being displayed in @p obj or
20869     * @c NULL, if none is (and on errors)
20870     *
20871     * @ingroup Slideshow
20872     */
20873    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20874
20875    /**
20876     * Get the real Evas object created to implement the view of a
20877     * given slideshow item
20878     *
20879     * @param item The slideshow item.
20880     * @return the Evas object implementing this item's view.
20881     *
20882     * This returns the actual Evas object used to implement the
20883     * specified slideshow item's view. This may be @c NULL, as it may
20884     * not have been created or may have been deleted, at any time, by
20885     * the slideshow. <b>Do not modify this object</b> (move, resize,
20886     * show, hide, etc.), as the slideshow is controlling it. This
20887     * function is for querying, emitting custom signals or hooking
20888     * lower level callbacks for events on that object. Do not delete
20889     * this object under any circumstances.
20890     *
20891     * @see elm_slideshow_item_data_get()
20892     *
20893     * @ingroup Slideshow
20894     */
20895    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20896
20897    /**
20898     * Get the the item, in a given slideshow widget, placed at
20899     * position @p nth, in its internal items list
20900     *
20901     * @param obj The slideshow object
20902     * @param nth The number of the item to grab a handle to (0 being
20903     * the first)
20904     * @return The item stored in @p obj at position @p nth or @c NULL,
20905     * if there's no item with that index (and on errors)
20906     *
20907     * @ingroup Slideshow
20908     */
20909    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20910
20911    /**
20912     * Set the current slide layout in use for a given slideshow widget
20913     *
20914     * @param obj The slideshow object
20915     * @param layout The new layout's name string
20916     *
20917     * If @p layout is implemented in @p obj's theme (i.e., is contained
20918     * in the list returned by elm_slideshow_layouts_get()), this new
20919     * images layout will be used on the widget.
20920     *
20921     * @see elm_slideshow_layouts_get() for more details
20922     *
20923     * @ingroup Slideshow
20924     */
20925    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20926
20927    /**
20928     * Get the current slide layout in use for a given slideshow widget
20929     *
20930     * @param obj The slideshow object
20931     * @return The current layout's name
20932     *
20933     * @see elm_slideshow_layout_set() for more details
20934     *
20935     * @ingroup Slideshow
20936     */
20937    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20938
20939    /**
20940     * Returns the list of @b layout names available, for a given
20941     * slideshow widget.
20942     *
20943     * @param obj The slideshow object
20944     * @return The list of layouts (list of @b stringshared strings
20945     * as data)
20946     *
20947     * Slideshow layouts will change how the widget is to dispose each
20948     * image item in its viewport, with regard to cropping, scaling,
20949     * etc.
20950     *
20951     * The layouts, which come from @p obj's theme, must be an EDC
20952     * data item name @c "layouts" on the theme file, with (prefix)
20953     * names of EDC programs actually implementing them.
20954     *
20955     * The available layouts for slideshows on the default theme are:
20956     * - @c "fullscreen" - item images with original aspect, scaled to
20957     *   touch top and down slideshow borders or, if the image's heigh
20958     *   is not enough, left and right slideshow borders.
20959     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20960     *   one, but always leaving 10% of the slideshow's dimensions of
20961     *   distance between the item image's borders and the slideshow
20962     *   borders, for each axis.
20963     *
20964     * @warning The stringshared strings get no new references
20965     * exclusive to the user grabbing the list, here, so if you'd like
20966     * to use them out of this call's context, you'd better @c
20967     * eina_stringshare_ref() them.
20968     *
20969     * @see elm_slideshow_layout_set()
20970     *
20971     * @ingroup Slideshow
20972     */
20973    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20974
20975    /**
20976     * Set the number of items to cache, on a given slideshow widget,
20977     * <b>before the current item</b>
20978     *
20979     * @param obj The slideshow object
20980     * @param count Number of items to cache before the current one
20981     *
20982     * The default value for this property is @c 2. See
20983     * @ref Slideshow_Caching "slideshow caching" for more details.
20984     *
20985     * @see elm_slideshow_cache_before_get()
20986     *
20987     * @ingroup Slideshow
20988     */
20989    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20990
20991    /**
20992     * Retrieve the number of items to cache, on a given slideshow widget,
20993     * <b>before the current item</b>
20994     *
20995     * @param obj The slideshow object
20996     * @return The number of items set to be cached before the current one
20997     *
20998     * @see elm_slideshow_cache_before_set() for more details
20999     *
21000     * @ingroup Slideshow
21001     */
21002    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21003
21004    /**
21005     * Set the number of items to cache, on a given slideshow widget,
21006     * <b>after the current item</b>
21007     *
21008     * @param obj The slideshow object
21009     * @param count Number of items to cache after the current one
21010     *
21011     * The default value for this property is @c 2. See
21012     * @ref Slideshow_Caching "slideshow caching" for more details.
21013     *
21014     * @see elm_slideshow_cache_after_get()
21015     *
21016     * @ingroup Slideshow
21017     */
21018    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21019
21020    /**
21021     * Retrieve the number of items to cache, on a given slideshow widget,
21022     * <b>after the current item</b>
21023     *
21024     * @param obj The slideshow object
21025     * @return The number of items set to be cached after the current one
21026     *
21027     * @see elm_slideshow_cache_after_set() for more details
21028     *
21029     * @ingroup Slideshow
21030     */
21031    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21032
21033    /**
21034     * Get the number of items stored in a given slideshow widget
21035     *
21036     * @param obj The slideshow object
21037     * @return The number of items on @p obj, at the moment of this call
21038     *
21039     * @ingroup Slideshow
21040     */
21041    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21042
21043    /**
21044     * @}
21045     */
21046
21047    /**
21048     * @defgroup Fileselector File Selector
21049     *
21050     * @image html img/widget/fileselector/preview-00.png
21051     * @image latex img/widget/fileselector/preview-00.eps
21052     *
21053     * A file selector is a widget that allows a user to navigate
21054     * through a file system, reporting file selections back via its
21055     * API.
21056     *
21057     * It contains shortcut buttons for home directory (@c ~) and to
21058     * jump one directory upwards (..), as well as cancel/ok buttons to
21059     * confirm/cancel a given selection. After either one of those two
21060     * former actions, the file selector will issue its @c "done" smart
21061     * callback.
21062     *
21063     * There's a text entry on it, too, showing the name of the current
21064     * selection. There's the possibility of making it editable, so it
21065     * is useful on file saving dialogs on applications, where one
21066     * gives a file name to save contents to, in a given directory in
21067     * the system. This custom file name will be reported on the @c
21068     * "done" smart callback (explained in sequence).
21069     *
21070     * Finally, it has a view to display file system items into in two
21071     * possible forms:
21072     * - list
21073     * - grid
21074     *
21075     * If Elementary is built with support of the Ethumb thumbnailing
21076     * library, the second form of view will display preview thumbnails
21077     * of files which it supports.
21078     *
21079     * Smart callbacks one can register to:
21080     *
21081     * - @c "selected" - the user has clicked on a file (when not in
21082     *      folders-only mode) or directory (when in folders-only mode)
21083     * - @c "directory,open" - the list has been populated with new
21084     *      content (@c event_info is a pointer to the directory's
21085     *      path, a @b stringshared string)
21086     * - @c "done" - the user has clicked on the "ok" or "cancel"
21087     *      buttons (@c event_info is a pointer to the selection's
21088     *      path, a @b stringshared string)
21089     *
21090     * Here is an example on its usage:
21091     * @li @ref fileselector_example
21092     */
21093
21094    /**
21095     * @addtogroup Fileselector
21096     * @{
21097     */
21098
21099    /**
21100     * Defines how a file selector widget is to layout its contents
21101     * (file system entries).
21102     */
21103    typedef enum _Elm_Fileselector_Mode
21104      {
21105         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21106         ELM_FILESELECTOR_GRID, /**< layout as a grid */
21107         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21108      } Elm_Fileselector_Mode;
21109
21110    /**
21111     * Add a new file selector widget to the given parent Elementary
21112     * (container) object
21113     *
21114     * @param parent The parent object
21115     * @return a new file selector widget handle or @c NULL, on errors
21116     *
21117     * This function inserts a new file selector widget on the canvas.
21118     *
21119     * @ingroup Fileselector
21120     */
21121    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21122
21123    /**
21124     * Enable/disable the file name entry box where the user can type
21125     * in a name for a file, in a given file selector widget
21126     *
21127     * @param obj The file selector object
21128     * @param is_save @c EINA_TRUE to make the file selector a "saving
21129     * dialog", @c EINA_FALSE otherwise
21130     *
21131     * Having the entry editable is useful on file saving dialogs on
21132     * applications, where one gives a file name to save contents to,
21133     * in a given directory in the system. This custom file name will
21134     * be reported on the @c "done" smart callback.
21135     *
21136     * @see elm_fileselector_is_save_get()
21137     *
21138     * @ingroup Fileselector
21139     */
21140    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21141
21142    /**
21143     * Get whether the given file selector is in "saving dialog" mode
21144     *
21145     * @param obj The file selector object
21146     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21147     * mode, @c EINA_FALSE otherwise (and on errors)
21148     *
21149     * @see elm_fileselector_is_save_set() for more details
21150     *
21151     * @ingroup Fileselector
21152     */
21153    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21154
21155    /**
21156     * Enable/disable folder-only view for a given file selector widget
21157     *
21158     * @param obj The file selector object
21159     * @param only @c EINA_TRUE to make @p obj only display
21160     * directories, @c EINA_FALSE to make files to be displayed in it
21161     * too
21162     *
21163     * If enabled, the widget's view will only display folder items,
21164     * naturally.
21165     *
21166     * @see elm_fileselector_folder_only_get()
21167     *
21168     * @ingroup Fileselector
21169     */
21170    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21171
21172    /**
21173     * Get whether folder-only view is set for a given file selector
21174     * widget
21175     *
21176     * @param obj The file selector object
21177     * @return only @c EINA_TRUE if @p obj is only displaying
21178     * directories, @c EINA_FALSE if files are being displayed in it
21179     * too (and on errors)
21180     *
21181     * @see elm_fileselector_folder_only_get()
21182     *
21183     * @ingroup Fileselector
21184     */
21185    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21186
21187    /**
21188     * Enable/disable the "ok" and "cancel" buttons on a given file
21189     * selector widget
21190     *
21191     * @param obj The file selector object
21192     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21193     *
21194     * @note A file selector without those buttons will never emit the
21195     * @c "done" smart event, and is only usable if one is just hooking
21196     * to the other two events.
21197     *
21198     * @see elm_fileselector_buttons_ok_cancel_get()
21199     *
21200     * @ingroup Fileselector
21201     */
21202    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21203
21204    /**
21205     * Get whether the "ok" and "cancel" buttons on a given file
21206     * selector widget are being shown.
21207     *
21208     * @param obj The file selector object
21209     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21210     * otherwise (and on errors)
21211     *
21212     * @see elm_fileselector_buttons_ok_cancel_set() for more details
21213     *
21214     * @ingroup Fileselector
21215     */
21216    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21217
21218    /**
21219     * Enable/disable a tree view in the given file selector widget,
21220     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21221     *
21222     * @param obj The file selector object
21223     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21224     * disable
21225     *
21226     * In a tree view, arrows are created on the sides of directories,
21227     * allowing them to expand in place.
21228     *
21229     * @note If it's in other mode, the changes made by this function
21230     * will only be visible when one switches back to "list" mode.
21231     *
21232     * @see elm_fileselector_expandable_get()
21233     *
21234     * @ingroup Fileselector
21235     */
21236    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21237
21238    /**
21239     * Get whether tree view is enabled for the given file selector
21240     * widget
21241     *
21242     * @param obj The file selector object
21243     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21244     * otherwise (and or errors)
21245     *
21246     * @see elm_fileselector_expandable_set() for more details
21247     *
21248     * @ingroup Fileselector
21249     */
21250    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21251
21252    /**
21253     * Set, programmatically, the @b directory that a given file
21254     * selector widget will display contents from
21255     *
21256     * @param obj The file selector object
21257     * @param path The path to display in @p obj
21258     *
21259     * This will change the @b directory that @p obj is displaying. It
21260     * will also clear the text entry area on the @p obj object, which
21261     * displays select files' names.
21262     *
21263     * @see elm_fileselector_path_get()
21264     *
21265     * @ingroup Fileselector
21266     */
21267    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21268
21269    /**
21270     * Get the parent directory's path that a given file selector
21271     * widget is displaying
21272     *
21273     * @param obj The file selector object
21274     * @return The (full) path of the directory the file selector is
21275     * displaying, a @b stringshared string
21276     *
21277     * @see elm_fileselector_path_set()
21278     *
21279     * @ingroup Fileselector
21280     */
21281    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21282
21283    /**
21284     * Set, programmatically, the currently selected file/directory in
21285     * the given file selector widget
21286     *
21287     * @param obj The file selector object
21288     * @param path The (full) path to a file or directory
21289     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21290     * latter case occurs if the directory or file pointed to do not
21291     * exist.
21292     *
21293     * @see elm_fileselector_selected_get()
21294     *
21295     * @ingroup Fileselector
21296     */
21297    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21298
21299    /**
21300     * Get the currently selected item's (full) path, in the given file
21301     * selector widget
21302     *
21303     * @param obj The file selector object
21304     * @return The absolute path of the selected item, a @b
21305     * stringshared string
21306     *
21307     * @note Custom editions on @p obj object's text entry, if made,
21308     * will appear on the return string of this function, naturally.
21309     *
21310     * @see elm_fileselector_selected_set() for more details
21311     *
21312     * @ingroup Fileselector
21313     */
21314    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21315
21316    /**
21317     * Set the mode in which a given file selector widget will display
21318     * (layout) file system entries in its view
21319     *
21320     * @param obj The file selector object
21321     * @param mode The mode of the fileselector, being it one of
21322     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21323     * first one, naturally, will display the files in a list. The
21324     * latter will make the widget to display its entries in a grid
21325     * form.
21326     *
21327     * @note By using elm_fileselector_expandable_set(), the user may
21328     * trigger a tree view for that list.
21329     *
21330     * @note If Elementary is built with support of the Ethumb
21331     * thumbnailing library, the second form of view will display
21332     * preview thumbnails of files which it supports. You must have
21333     * elm_need_ethumb() called in your Elementary for thumbnailing to
21334     * work, though.
21335     *
21336     * @see elm_fileselector_expandable_set().
21337     * @see elm_fileselector_mode_get().
21338     *
21339     * @ingroup Fileselector
21340     */
21341    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21342
21343    /**
21344     * Get the mode in which a given file selector widget is displaying
21345     * (layouting) file system entries in its view
21346     *
21347     * @param obj The fileselector object
21348     * @return The mode in which the fileselector is at
21349     *
21350     * @see elm_fileselector_mode_set() for more details
21351     *
21352     * @ingroup Fileselector
21353     */
21354    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21355
21356    /**
21357     * @}
21358     */
21359
21360    /**
21361     * @defgroup Progressbar Progress bar
21362     *
21363     * The progress bar is a widget for visually representing the
21364     * progress status of a given job/task.
21365     *
21366     * A progress bar may be horizontal or vertical. It may display an
21367     * icon besides it, as well as primary and @b units labels. The
21368     * former is meant to label the widget as a whole, while the
21369     * latter, which is formatted with floating point values (and thus
21370     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21371     * units"</c>), is meant to label the widget's <b>progress
21372     * value</b>. Label, icon and unit strings/objects are @b optional
21373     * for progress bars.
21374     *
21375     * A progress bar may be @b inverted, in which state it gets its
21376     * values inverted, with high values being on the left or top and
21377     * low values on the right or bottom, as opposed to normally have
21378     * the low values on the former and high values on the latter,
21379     * respectively, for horizontal and vertical modes.
21380     *
21381     * The @b span of the progress, as set by
21382     * elm_progressbar_span_size_set(), is its length (horizontally or
21383     * vertically), unless one puts size hints on the widget to expand
21384     * on desired directions, by any container. That length will be
21385     * scaled by the object or applications scaling factor. At any
21386     * point code can query the progress bar for its value with
21387     * elm_progressbar_value_get().
21388     *
21389     * Available widget styles for progress bars:
21390     * - @c "default"
21391     * - @c "wheel" (simple style, no text, no progression, only
21392     *      "pulse" effect is available)
21393     *
21394     * Default contents parts of the progressbar widget that you can use for are:
21395     * @li "icon" - A icon of the progressbar
21396     * 
21397     * Here is an example on its usage:
21398     * @li @ref progressbar_example
21399     */
21400
21401    /**
21402     * Add a new progress bar widget to the given parent Elementary
21403     * (container) object
21404     *
21405     * @param parent The parent object
21406     * @return a new progress bar widget handle or @c NULL, on errors
21407     *
21408     * This function inserts a new progress bar widget on the canvas.
21409     *
21410     * @ingroup Progressbar
21411     */
21412    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21413
21414    /**
21415     * Set whether a given progress bar widget is at "pulsing mode" or
21416     * not.
21417     *
21418     * @param obj The progress bar object
21419     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21420     * @c EINA_FALSE to put it back to its default one
21421     *
21422     * By default, progress bars will display values from the low to
21423     * high value boundaries. There are, though, contexts in which the
21424     * state of progression of a given task is @b unknown.  For those,
21425     * one can set a progress bar widget to a "pulsing state", to give
21426     * the user an idea that some computation is being held, but
21427     * without exact progress values. In the default theme it will
21428     * animate its bar with the contents filling in constantly and back
21429     * to non-filled, in a loop. To start and stop this pulsing
21430     * animation, one has to explicitly call elm_progressbar_pulse().
21431     *
21432     * @see elm_progressbar_pulse_get()
21433     * @see elm_progressbar_pulse()
21434     *
21435     * @ingroup Progressbar
21436     */
21437    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21438
21439    /**
21440     * Get whether a given progress bar widget is at "pulsing mode" or
21441     * not.
21442     *
21443     * @param obj The progress bar object
21444     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21445     * if it's in the default one (and on errors)
21446     *
21447     * @ingroup Progressbar
21448     */
21449    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21450
21451    /**
21452     * Start/stop a given progress bar "pulsing" animation, if its
21453     * under that mode
21454     *
21455     * @param obj The progress bar object
21456     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21457     * @c EINA_FALSE to @b stop it
21458     *
21459     * @note This call won't do anything if @p obj is not under "pulsing mode".
21460     *
21461     * @see elm_progressbar_pulse_set() for more details.
21462     *
21463     * @ingroup Progressbar
21464     */
21465    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21466
21467    /**
21468     * Set the progress value (in percentage) on a given progress bar
21469     * widget
21470     *
21471     * @param obj The progress bar object
21472     * @param val The progress value (@b must be between @c 0.0 and @c
21473     * 1.0)
21474     *
21475     * Use this call to set progress bar levels.
21476     *
21477     * @note If you passes a value out of the specified range for @p
21478     * val, it will be interpreted as the @b closest of the @b boundary
21479     * values in the range.
21480     *
21481     * @ingroup Progressbar
21482     */
21483    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21484
21485    /**
21486     * Get the progress value (in percentage) on a given progress bar
21487     * widget
21488     *
21489     * @param obj The progress bar object
21490     * @return The value of the progressbar
21491     *
21492     * @see elm_progressbar_value_set() for more details
21493     *
21494     * @ingroup Progressbar
21495     */
21496    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21497
21498    /**
21499     * Set the label of a given progress bar widget
21500     *
21501     * @param obj The progress bar object
21502     * @param label The text label string, in UTF-8
21503     *
21504     * @ingroup Progressbar
21505     * @deprecated use elm_object_text_set() instead.
21506     */
21507    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21508
21509    /**
21510     * Get the label of a given progress bar widget
21511     *
21512     * @param obj The progressbar object
21513     * @return The text label string, in UTF-8
21514     *
21515     * @ingroup Progressbar
21516     * @deprecated use elm_object_text_set() instead.
21517     */
21518    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21519
21520    /**
21521     * Set the icon object of a given progress bar widget
21522     *
21523     * @param obj The progress bar object
21524     * @param icon The icon object
21525     *
21526     * Use this call to decorate @p obj with an icon next to it.
21527     *
21528     * @note Once the icon object is set, a previously set one will be
21529     * deleted. If you want to keep that old content object, use the
21530     * elm_progressbar_icon_unset() function.
21531     *
21532     * @see elm_progressbar_icon_get()
21533     * @deprecated use elm_object_part_content_set() instead.
21534     *
21535     * @ingroup Progressbar
21536     */
21537    WILL_DEPRECATE  EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21538
21539    /**
21540     * Retrieve the icon object set for a given progress bar widget
21541     *
21542     * @param obj The progress bar object
21543     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21544     * otherwise (and on errors)
21545     *
21546     * @see elm_progressbar_icon_set() for more details
21547     * @deprecated use elm_object_part_content_get() instead.
21548     *
21549     * @ingroup Progressbar
21550     */
21551    WILL_DEPRECATE  EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21552
21553    /**
21554     * Unset an icon set on a given progress bar widget
21555     *
21556     * @param obj The progress bar object
21557     * @return The icon object that was being used, if any was set, or
21558     * @c NULL, otherwise (and on errors)
21559     *
21560     * This call will unparent and return the icon object which was set
21561     * for this widget, previously, on success.
21562     *
21563     * @see elm_progressbar_icon_set() for more details
21564     * @deprecated use elm_object_part_content_unset() instead.
21565     *
21566     * @ingroup Progressbar
21567     */
21568    WILL_DEPRECATE  EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21569
21570    /**
21571     * Set the (exact) length of the bar region of a given progress bar
21572     * widget
21573     *
21574     * @param obj The progress bar object
21575     * @param size The length of the progress bar's bar region
21576     *
21577     * This sets the minimum width (when in horizontal mode) or height
21578     * (when in vertical mode) of the actual bar area of the progress
21579     * bar @p obj. This in turn affects the object's minimum size. Use
21580     * this when you're not setting other size hints expanding on the
21581     * given direction (like weight and alignment hints) and you would
21582     * like it to have a specific size.
21583     *
21584     * @note Icon, label and unit text around @p obj will require their
21585     * own space, which will make @p obj to require more the @p size,
21586     * actually.
21587     *
21588     * @see elm_progressbar_span_size_get()
21589     *
21590     * @ingroup Progressbar
21591     */
21592    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21593
21594    /**
21595     * Get the length set for the bar region of a given progress bar
21596     * widget
21597     *
21598     * @param obj The progress bar object
21599     * @return The length of the progress bar's bar region
21600     *
21601     * If that size was not set previously, with
21602     * elm_progressbar_span_size_set(), this call will return @c 0.
21603     *
21604     * @ingroup Progressbar
21605     */
21606    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21607
21608    /**
21609     * Set the format string for a given progress bar widget's units
21610     * label
21611     *
21612     * @param obj The progress bar object
21613     * @param format The format string for @p obj's units label
21614     *
21615     * If @c NULL is passed on @p format, it will make @p obj's units
21616     * area to be hidden completely. If not, it'll set the <b>format
21617     * string</b> for the units label's @b text. The units label is
21618     * provided a floating point value, so the units text is up display
21619     * at most one floating point falue. Note that the units label is
21620     * optional. Use a format string such as "%1.2f meters" for
21621     * example.
21622     *
21623     * @note The default format string for a progress bar is an integer
21624     * percentage, as in @c "%.0f %%".
21625     *
21626     * @see elm_progressbar_unit_format_get()
21627     *
21628     * @ingroup Progressbar
21629     */
21630    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21631
21632    /**
21633     * Retrieve the format string set for a given progress bar widget's
21634     * units label
21635     *
21636     * @param obj The progress bar object
21637     * @return The format set string for @p obj's units label or
21638     * @c NULL, if none was set (and on errors)
21639     *
21640     * @see elm_progressbar_unit_format_set() for more details
21641     *
21642     * @ingroup Progressbar
21643     */
21644    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21645
21646    /**
21647     * Set the orientation of a given progress bar widget
21648     *
21649     * @param obj The progress bar object
21650     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21651     * @b horizontal, @c EINA_FALSE to make it @b vertical
21652     *
21653     * Use this function to change how your progress bar is to be
21654     * disposed: vertically or horizontally.
21655     *
21656     * @see elm_progressbar_horizontal_get()
21657     *
21658     * @ingroup Progressbar
21659     */
21660    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21661
21662    /**
21663     * Retrieve the orientation of a given progress bar widget
21664     *
21665     * @param obj The progress bar object
21666     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21667     * @c EINA_FALSE if it's @b vertical (and on errors)
21668     *
21669     * @see elm_progressbar_horizontal_set() for more details
21670     *
21671     * @ingroup Progressbar
21672     */
21673    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21674
21675    /**
21676     * Invert a given progress bar widget's displaying values order
21677     *
21678     * @param obj The progress bar object
21679     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21680     * @c EINA_FALSE to bring it back to default, non-inverted values.
21681     *
21682     * A progress bar may be @b inverted, in which state it gets its
21683     * values inverted, with high values being on the left or top and
21684     * low values on the right or bottom, as opposed to normally have
21685     * the low values on the former and high values on the latter,
21686     * respectively, for horizontal and vertical modes.
21687     *
21688     * @see elm_progressbar_inverted_get()
21689     *
21690     * @ingroup Progressbar
21691     */
21692    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21693
21694    /**
21695     * Get whether a given progress bar widget's displaying values are
21696     * inverted or not
21697     *
21698     * @param obj The progress bar object
21699     * @return @c EINA_TRUE, if @p obj has inverted values,
21700     * @c EINA_FALSE otherwise (and on errors)
21701     *
21702     * @see elm_progressbar_inverted_set() for more details
21703     *
21704     * @ingroup Progressbar
21705     */
21706    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21707
21708    /**
21709     * @defgroup Separator Separator
21710     *
21711     * @brief Separator is a very thin object used to separate other objects.
21712     *
21713     * A separator can be vertical or horizontal.
21714     *
21715     * @ref tutorial_separator is a good example of how to use a separator.
21716     * @{
21717     */
21718    /**
21719     * @brief Add a separator object to @p parent
21720     *
21721     * @param parent The parent object
21722     *
21723     * @return The separator object, or NULL upon failure
21724     */
21725    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21726    /**
21727     * @brief Set the horizontal mode of a separator object
21728     *
21729     * @param obj The separator object
21730     * @param horizontal If true, the separator is horizontal
21731     */
21732    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21733    /**
21734     * @brief Get the horizontal mode of a separator object
21735     *
21736     * @param obj The separator object
21737     * @return If true, the separator is horizontal
21738     *
21739     * @see elm_separator_horizontal_set()
21740     */
21741    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21742    /**
21743     * @}
21744     */
21745
21746    /**
21747     * @defgroup Spinner Spinner
21748     * @ingroup Elementary
21749     *
21750     * @image html img/widget/spinner/preview-00.png
21751     * @image latex img/widget/spinner/preview-00.eps
21752     *
21753     * A spinner is a widget which allows the user to increase or decrease
21754     * numeric values using arrow buttons, or edit values directly, clicking
21755     * over it and typing the new value.
21756     *
21757     * By default the spinner will not wrap and has a label
21758     * of "%.0f" (just showing the integer value of the double).
21759     *
21760     * A spinner has a label that is formatted with floating
21761     * point values and thus accepts a printf-style format string, like
21762     * ā€œ%1.2f unitsā€.
21763     *
21764     * It also allows specific values to be replaced by pre-defined labels.
21765     *
21766     * Smart callbacks one can register to:
21767     *
21768     * - "changed" - Whenever the spinner value is changed.
21769     * - "delay,changed" - A short time after the value is changed by the user.
21770     *    This will be called only when the user stops dragging for a very short
21771     *    period or when they release their finger/mouse, so it avoids possibly
21772     *    expensive reactions to the value change.
21773     *
21774     * Available styles for it:
21775     * - @c "default";
21776     * - @c "vertical": up/down buttons at the right side and text left aligned.
21777     *
21778     * Here is an example on its usage:
21779     * @ref spinner_example
21780     */
21781
21782    /**
21783     * @addtogroup Spinner
21784     * @{
21785     */
21786
21787    /**
21788     * Add a new spinner widget to the given parent Elementary
21789     * (container) object.
21790     *
21791     * @param parent The parent object.
21792     * @return a new spinner widget handle or @c NULL, on errors.
21793     *
21794     * This function inserts a new spinner widget on the canvas.
21795     *
21796     * @ingroup Spinner
21797     *
21798     */
21799    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21800
21801    /**
21802     * Set the format string of the displayed label.
21803     *
21804     * @param obj The spinner object.
21805     * @param fmt The format string for the label display.
21806     *
21807     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21808     * string for the label text. The label text is provided a floating point
21809     * value, so the label text can display up to 1 floating point value.
21810     * Note that this is optional.
21811     *
21812     * Use a format string such as "%1.2f meters" for example, and it will
21813     * display values like: "3.14 meters" for a value equal to 3.14159.
21814     *
21815     * Default is "%0.f".
21816     *
21817     * @see elm_spinner_label_format_get()
21818     *
21819     * @ingroup Spinner
21820     */
21821    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21822
21823    /**
21824     * Get the label format of the spinner.
21825     *
21826     * @param obj The spinner object.
21827     * @return The text label format string in UTF-8.
21828     *
21829     * @see elm_spinner_label_format_set() for details.
21830     *
21831     * @ingroup Spinner
21832     */
21833    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21834
21835    /**
21836     * Set the minimum and maximum values for the spinner.
21837     *
21838     * @param obj The spinner object.
21839     * @param min The minimum value.
21840     * @param max The maximum value.
21841     *
21842     * Define the allowed range of values to be selected by the user.
21843     *
21844     * If actual value is less than @p min, it will be updated to @p min. If it
21845     * is bigger then @p max, will be updated to @p max. Actual value can be
21846     * get with elm_spinner_value_get().
21847     *
21848     * By default, min is equal to 0, and max is equal to 100.
21849     *
21850     * @warning Maximum must be greater than minimum.
21851     *
21852     * @see elm_spinner_min_max_get()
21853     *
21854     * @ingroup Spinner
21855     */
21856    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21857
21858    /**
21859     * Get the minimum and maximum values of the spinner.
21860     *
21861     * @param obj The spinner object.
21862     * @param min Pointer where to store the minimum value.
21863     * @param max Pointer where to store the maximum value.
21864     *
21865     * @note If only one value is needed, the other pointer can be passed
21866     * as @c NULL.
21867     *
21868     * @see elm_spinner_min_max_set() for details.
21869     *
21870     * @ingroup Spinner
21871     */
21872    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21873
21874    /**
21875     * Set the step used to increment or decrement the spinner value.
21876     *
21877     * @param obj The spinner object.
21878     * @param step The step value.
21879     *
21880     * This value will be incremented or decremented to the displayed value.
21881     * It will be incremented while the user keep right or top arrow pressed,
21882     * and will be decremented while the user keep left or bottom arrow pressed.
21883     *
21884     * The interval to increment / decrement can be set with
21885     * elm_spinner_interval_set().
21886     *
21887     * By default step value is equal to 1.
21888     *
21889     * @see elm_spinner_step_get()
21890     *
21891     * @ingroup Spinner
21892     */
21893    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21894
21895    /**
21896     * Get the step used to increment or decrement the spinner value.
21897     *
21898     * @param obj The spinner object.
21899     * @return The step value.
21900     *
21901     * @see elm_spinner_step_get() for more details.
21902     *
21903     * @ingroup Spinner
21904     */
21905    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21906
21907    /**
21908     * Set the value the spinner displays.
21909     *
21910     * @param obj The spinner object.
21911     * @param val The value to be displayed.
21912     *
21913     * Value will be presented on the label following format specified with
21914     * elm_spinner_format_set().
21915     *
21916     * @warning The value must to be between min and max values. This values
21917     * are set by elm_spinner_min_max_set().
21918     *
21919     * @see elm_spinner_value_get().
21920     * @see elm_spinner_format_set().
21921     * @see elm_spinner_min_max_set().
21922     *
21923     * @ingroup Spinner
21924     */
21925    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21926
21927    /**
21928     * Get the value displayed by the spinner.
21929     *
21930     * @param obj The spinner object.
21931     * @return The value displayed.
21932     *
21933     * @see elm_spinner_value_set() for details.
21934     *
21935     * @ingroup Spinner
21936     */
21937    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21938
21939    /**
21940     * Set whether the spinner should wrap when it reaches its
21941     * minimum or maximum value.
21942     *
21943     * @param obj The spinner object.
21944     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21945     * disable it.
21946     *
21947     * Disabled by default. If disabled, when the user tries to increment the
21948     * value,
21949     * but displayed value plus step value is bigger than maximum value,
21950     * the spinner
21951     * won't allow it. The same happens when the user tries to decrement it,
21952     * but the value less step is less than minimum value.
21953     *
21954     * When wrap is enabled, in such situations it will allow these changes,
21955     * but will get the value that would be less than minimum and subtracts
21956     * from maximum. Or add the value that would be more than maximum to
21957     * the minimum.
21958     *
21959     * E.g.:
21960     * @li min value = 10
21961     * @li max value = 50
21962     * @li step value = 20
21963     * @li displayed value = 20
21964     *
21965     * When the user decrement value (using left or bottom arrow), it will
21966     * displays @c 40, because max - (min - (displayed - step)) is
21967     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21968     *
21969     * @see elm_spinner_wrap_get().
21970     *
21971     * @ingroup Spinner
21972     */
21973    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21974
21975    /**
21976     * Get whether the spinner should wrap when it reaches its
21977     * minimum or maximum value.
21978     *
21979     * @param obj The spinner object
21980     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21981     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21982     *
21983     * @see elm_spinner_wrap_set() for details.
21984     *
21985     * @ingroup Spinner
21986     */
21987    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21988
21989    /**
21990     * Set whether the spinner can be directly edited by the user or not.
21991     *
21992     * @param obj The spinner object.
21993     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21994     * don't allow users to edit it directly.
21995     *
21996     * Spinner objects can have edition @b disabled, in which state they will
21997     * be changed only by arrows.
21998     * Useful for contexts
21999     * where you don't want your users to interact with it writting the value.
22000     * Specially
22001     * when using special values, the user can see real value instead
22002     * of special label on edition.
22003     *
22004     * It's enabled by default.
22005     *
22006     * @see elm_spinner_editable_get()
22007     *
22008     * @ingroup Spinner
22009     */
22010    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22011
22012    /**
22013     * Get whether the spinner can be directly edited by the user or not.
22014     *
22015     * @param obj The spinner object.
22016     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22017     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22018     *
22019     * @see elm_spinner_editable_set() for details.
22020     *
22021     * @ingroup Spinner
22022     */
22023    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22024
22025    /**
22026     * Set a special string to display in the place of the numerical value.
22027     *
22028     * @param obj The spinner object.
22029     * @param value The value to be replaced.
22030     * @param label The label to be used.
22031     *
22032     * It's useful for cases when a user should select an item that is
22033     * better indicated by a label than a value. For example, weekdays or months.
22034     *
22035     * E.g.:
22036     * @code
22037     * sp = elm_spinner_add(win);
22038     * elm_spinner_min_max_set(sp, 1, 3);
22039     * elm_spinner_special_value_add(sp, 1, "January");
22040     * elm_spinner_special_value_add(sp, 2, "February");
22041     * elm_spinner_special_value_add(sp, 3, "March");
22042     * evas_object_show(sp);
22043     * @endcode
22044     *
22045     * @ingroup Spinner
22046     */
22047    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22048
22049    /**
22050     * Set the interval on time updates for an user mouse button hold
22051     * on spinner widgets' arrows.
22052     *
22053     * @param obj The spinner object.
22054     * @param interval The (first) interval value in seconds.
22055     *
22056     * This interval value is @b decreased while the user holds the
22057     * mouse pointer either incrementing or decrementing spinner's value.
22058     *
22059     * This helps the user to get to a given value distant from the
22060     * current one easier/faster, as it will start to change quicker and
22061     * quicker on mouse button holds.
22062     *
22063     * The calculation for the next change interval value, starting from
22064     * the one set with this call, is the previous interval divided by
22065     * @c 1.05, so it decreases a little bit.
22066     *
22067     * The default starting interval value for automatic changes is
22068     * @c 0.85 seconds.
22069     *
22070     * @see elm_spinner_interval_get()
22071     *
22072     * @ingroup Spinner
22073     */
22074    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22075
22076    /**
22077     * Get the interval on time updates for an user mouse button hold
22078     * on spinner widgets' arrows.
22079     *
22080     * @param obj The spinner object.
22081     * @return The (first) interval value, in seconds, set on it.
22082     *
22083     * @see elm_spinner_interval_set() for more details.
22084     *
22085     * @ingroup Spinner
22086     */
22087    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22088
22089    /**
22090     * @}
22091     */
22092
22093    /**
22094     * @defgroup Index Index
22095     *
22096     * @image html img/widget/index/preview-00.png
22097     * @image latex img/widget/index/preview-00.eps
22098     *
22099     * An index widget gives you an index for fast access to whichever
22100     * group of other UI items one might have. It's a list of text
22101     * items (usually letters, for alphabetically ordered access).
22102     *
22103     * Index widgets are by default hidden and just appear when the
22104     * user clicks over it's reserved area in the canvas. In its
22105     * default theme, it's an area one @ref Fingers "finger" wide on
22106     * the right side of the index widget's container.
22107     *
22108     * When items on the index are selected, smart callbacks get
22109     * called, so that its user can make other container objects to
22110     * show a given area or child object depending on the index item
22111     * selected. You'd probably be using an index together with @ref
22112     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22113     * "general grids".
22114     *
22115     * Smart events one  can add callbacks for are:
22116     * - @c "changed" - When the selected index item changes. @c
22117     *      event_info is the selected item's data pointer.
22118     * - @c "delay,changed" - When the selected index item changes, but
22119     *      after a small idling period. @c event_info is the selected
22120     *      item's data pointer.
22121     * - @c "selected" - When the user releases a mouse button and
22122     *      selects an item. @c event_info is the selected item's data
22123     *      pointer.
22124     * - @c "level,up" - when the user moves a finger from the first
22125     *      level to the second level
22126     * - @c "level,down" - when the user moves a finger from the second
22127     *      level to the first level
22128     *
22129     * The @c "delay,changed" event is so that it'll wait a small time
22130     * before actually reporting those events and, moreover, just the
22131     * last event happening on those time frames will actually be
22132     * reported.
22133     *
22134     * Here are some examples on its usage:
22135     * @li @ref index_example_01
22136     * @li @ref index_example_02
22137     */
22138
22139    /**
22140     * @addtogroup Index
22141     * @{
22142     */
22143
22144    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22145
22146    /**
22147     * Add a new index widget to the given parent Elementary
22148     * (container) object
22149     *
22150     * @param parent The parent object
22151     * @return a new index widget handle or @c NULL, on errors
22152     *
22153     * This function inserts a new index widget on the canvas.
22154     *
22155     * @ingroup Index
22156     */
22157    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22158
22159    /**
22160     * Set whether a given index widget is or not visible,
22161     * programatically.
22162     *
22163     * @param obj The index object
22164     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22165     *
22166     * Not to be confused with visible as in @c evas_object_show() --
22167     * visible with regard to the widget's auto hiding feature.
22168     *
22169     * @see elm_index_active_get()
22170     *
22171     * @ingroup Index
22172     */
22173    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22174
22175    /**
22176     * Get whether a given index widget is currently visible or not.
22177     *
22178     * @param obj The index object
22179     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22180     *
22181     * @see elm_index_active_set() for more details
22182     *
22183     * @ingroup Index
22184     */
22185    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22186
22187    /**
22188     * Set the items level for a given index widget.
22189     *
22190     * @param obj The index object.
22191     * @param level @c 0 or @c 1, the currently implemented levels.
22192     *
22193     * @see elm_index_item_level_get()
22194     *
22195     * @ingroup Index
22196     */
22197    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22198
22199    /**
22200     * Get the items level set for a given index widget.
22201     *
22202     * @param obj The index object.
22203     * @return @c 0 or @c 1, which are the levels @p obj might be at.
22204     *
22205     * @see elm_index_item_level_set() for more information
22206     *
22207     * @ingroup Index
22208     */
22209    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22210
22211    /**
22212     * Returns the last selected item's data, for a given index widget.
22213     *
22214     * @param obj The index object.
22215     * @return The item @b data associated to the last selected item on
22216     * @p obj (or @c NULL, on errors).
22217     *
22218     * @warning The returned value is @b not an #Elm_Index_Item item
22219     * handle, but the data associated to it (see the @c item parameter
22220     * in elm_index_item_append(), as an example).
22221     *
22222     * @ingroup Index
22223     */
22224    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22225
22226    /**
22227     * Append a new item on a given index widget.
22228     *
22229     * @param obj The index object.
22230     * @param letter Letter under which the item should be indexed
22231     * @param item The item data to set for the index's item
22232     *
22233     * Despite the most common usage of the @p letter argument is for
22234     * single char strings, one could use arbitrary strings as index
22235     * entries.
22236     *
22237     * @c item will be the pointer returned back on @c "changed", @c
22238     * "delay,changed" and @c "selected" smart events.
22239     *
22240     * @ingroup Index
22241     */
22242    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22243
22244    /**
22245     * Prepend a new item on a given index widget.
22246     *
22247     * @param obj The index object.
22248     * @param letter Letter under which the item should be indexed
22249     * @param item The item data to set for the index's item
22250     *
22251     * Despite the most common usage of the @p letter argument is for
22252     * single char strings, one could use arbitrary strings as index
22253     * entries.
22254     *
22255     * @c item will be the pointer returned back on @c "changed", @c
22256     * "delay,changed" and @c "selected" smart events.
22257     *
22258     * @ingroup Index
22259     */
22260    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22261
22262    /**
22263     * Append a new item, on a given index widget, <b>after the item
22264     * having @p relative as data</b>.
22265     *
22266     * @param obj The index object.
22267     * @param letter Letter under which the item should be indexed
22268     * @param item The item data to set for the index's item
22269     * @param relative The item data of the index item to be the
22270     * predecessor of this new one
22271     *
22272     * Despite the most common usage of the @p letter argument is for
22273     * single char strings, one could use arbitrary strings as index
22274     * entries.
22275     *
22276     * @c item will be the pointer returned back on @c "changed", @c
22277     * "delay,changed" and @c "selected" smart events.
22278     *
22279     * @note If @p relative is @c NULL or if it's not found to be data
22280     * set on any previous item on @p obj, this function will behave as
22281     * elm_index_item_append().
22282     *
22283     * @ingroup Index
22284     */
22285    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22286
22287    /**
22288     * Prepend a new item, on a given index widget, <b>after the item
22289     * having @p relative as data</b>.
22290     *
22291     * @param obj The index object.
22292     * @param letter Letter under which the item should be indexed
22293     * @param item The item data to set for the index's item
22294     * @param relative The item data of the index item to be the
22295     * successor of this new one
22296     *
22297     * Despite the most common usage of the @p letter argument is for
22298     * single char strings, one could use arbitrary strings as index
22299     * entries.
22300     *
22301     * @c item will be the pointer returned back on @c "changed", @c
22302     * "delay,changed" and @c "selected" smart events.
22303     *
22304     * @note If @p relative is @c NULL or if it's not found to be data
22305     * set on any previous item on @p obj, this function will behave as
22306     * elm_index_item_prepend().
22307     *
22308     * @ingroup Index
22309     */
22310    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22311
22312    /**
22313     * Insert a new item into the given index widget, using @p cmp_func
22314     * function to sort items (by item handles).
22315     *
22316     * @param obj The index object.
22317     * @param letter Letter under which the item should be indexed
22318     * @param item The item data to set for the index's item
22319     * @param cmp_func The comparing function to be used to sort index
22320     * items <b>by #Elm_Index_Item item handles</b>
22321     * @param cmp_data_func A @b fallback function to be called for the
22322     * sorting of index items <b>by item data</b>). It will be used
22323     * when @p cmp_func returns @c 0 (equality), which means an index
22324     * item with provided item data already exists. To decide which
22325     * data item should be pointed to by the index item in question, @p
22326     * cmp_data_func will be used. If @p cmp_data_func returns a
22327     * non-negative value, the previous index item data will be
22328     * replaced by the given @p item pointer. If the previous data need
22329     * to be freed, it should be done by the @p cmp_data_func function,
22330     * because all references to it will be lost. If this function is
22331     * not provided (@c NULL is given), index items will be @b
22332     * duplicated, if @p cmp_func returns @c 0.
22333     *
22334     * Despite the most common usage of the @p letter argument is for
22335     * single char strings, one could use arbitrary strings as index
22336     * entries.
22337     *
22338     * @c item will be the pointer returned back on @c "changed", @c
22339     * "delay,changed" and @c "selected" smart events.
22340     *
22341     * @ingroup Index
22342     */
22343    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);
22344
22345    /**
22346     * Remove an item from a given index widget, <b>to be referenced by
22347     * it's data value</b>.
22348     *
22349     * @param obj The index object
22350     * @param item The item's data pointer for the item to be removed
22351     * from @p obj
22352     *
22353     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22354     * that callback function will be called by this one.
22355     *
22356     * @warning The item to be removed from @p obj will be found via
22357     * its item data pointer, and not by an #Elm_Index_Item handle.
22358     *
22359     * @ingroup Index
22360     */
22361    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22362
22363    /**
22364     * Find a given index widget's item, <b>using item data</b>.
22365     *
22366     * @param obj The index object
22367     * @param item The item data pointed to by the desired index item
22368     * @return The index item handle, if found, or @c NULL otherwise
22369     *
22370     * @ingroup Index
22371     */
22372    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22373
22374    /**
22375     * Removes @b all items from a given index widget.
22376     *
22377     * @param obj The index object.
22378     *
22379     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22380     * that callback function will be called for each item in @p obj.
22381     *
22382     * @ingroup Index
22383     */
22384    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22385
22386    /**
22387     * Go to a given items level on a index widget
22388     *
22389     * @param obj The index object
22390     * @param level The index level (one of @c 0 or @c 1)
22391     *
22392     * @ingroup Index
22393     */
22394    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22395
22396    /**
22397     * Return the data associated with a given index widget item
22398     *
22399     * @param it The index widget item handle
22400     * @return The data associated with @p it
22401     *
22402     * @see elm_index_item_data_set()
22403     *
22404     * @ingroup Index
22405     */
22406    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22407
22408    /**
22409     * Set the data associated with a given index widget item
22410     *
22411     * @param it The index widget item handle
22412     * @param data The new data pointer to set to @p it
22413     *
22414     * This sets new item data on @p it.
22415     *
22416     * @warning The old data pointer won't be touched by this function, so
22417     * the user had better to free that old data himself/herself.
22418     *
22419     * @ingroup Index
22420     */
22421    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22422
22423    /**
22424     * Set the function to be called when a given index widget item is freed.
22425     *
22426     * @param it The item to set the callback on
22427     * @param func The function to call on the item's deletion
22428     *
22429     * When called, @p func will have both @c data and @c event_info
22430     * arguments with the @p it item's data value and, naturally, the
22431     * @c obj argument with a handle to the parent index widget.
22432     *
22433     * @ingroup Index
22434     */
22435    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22436
22437    /**
22438     * Get the letter (string) set on a given index widget item.
22439     *
22440     * @param it The index item handle
22441     * @return The letter string set on @p it
22442     *
22443     * @ingroup Index
22444     */
22445    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22446
22447    /**
22448     */
22449    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22450
22451    /**
22452     * @}
22453     */
22454
22455    /**
22456     * @defgroup Photocam Photocam
22457     *
22458     * @image html img/widget/photocam/preview-00.png
22459     * @image latex img/widget/photocam/preview-00.eps
22460     *
22461     * This is a widget specifically for displaying high-resolution digital
22462     * camera photos giving speedy feedback (fast load), low memory footprint
22463     * and zooming and panning as well as fitting logic. It is entirely focused
22464     * on jpeg images, and takes advantage of properties of the jpeg format (via
22465     * evas loader features in the jpeg loader).
22466     *
22467     * Signals that you can add callbacks for are:
22468     * @li "clicked" - This is called when a user has clicked the photo without
22469     *                 dragging around.
22470     * @li "press" - This is called when a user has pressed down on the photo.
22471     * @li "longpressed" - This is called when a user has pressed down on the
22472     *                     photo for a long time without dragging around.
22473     * @li "clicked,double" - This is called when a user has double-clicked the
22474     *                        photo.
22475     * @li "load" - Photo load begins.
22476     * @li "loaded" - This is called when the image file load is complete for the
22477     *                first view (low resolution blurry version).
22478     * @li "load,detail" - Photo detailed data load begins.
22479     * @li "loaded,detail" - This is called when the image file load is complete
22480     *                      for the detailed image data (full resolution needed).
22481     * @li "zoom,start" - Zoom animation started.
22482     * @li "zoom,stop" - Zoom animation stopped.
22483     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22484     * @li "scroll" - the content has been scrolled (moved)
22485     * @li "scroll,anim,start" - scrolling animation has started
22486     * @li "scroll,anim,stop" - scrolling animation has stopped
22487     * @li "scroll,drag,start" - dragging the contents around has started
22488     * @li "scroll,drag,stop" - dragging the contents around has stopped
22489     *
22490     * @ref tutorial_photocam shows the API in action.
22491     * @{
22492     */
22493    /**
22494     * @brief Types of zoom available.
22495     */
22496    typedef enum _Elm_Photocam_Zoom_Mode
22497      {
22498         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22499         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22500         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22501         ELM_PHOTOCAM_ZOOM_MODE_LAST
22502      } Elm_Photocam_Zoom_Mode;
22503    /**
22504     * @brief Add a new Photocam object
22505     *
22506     * @param parent The parent object
22507     * @return The new object or NULL if it cannot be created
22508     */
22509    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22510    /**
22511     * @brief Set the photo file to be shown
22512     *
22513     * @param obj The photocam object
22514     * @param file The photo file
22515     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22516     *
22517     * This sets (and shows) the specified file (with a relative or absolute
22518     * path) and will return a load error (same error that
22519     * evas_object_image_load_error_get() will return). The image will change and
22520     * adjust its size at this point and begin a background load process for this
22521     * photo that at some time in the future will be displayed at the full
22522     * quality needed.
22523     */
22524    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22525    /**
22526     * @brief Returns the path of the current image file
22527     *
22528     * @param obj The photocam object
22529     * @return Returns the path
22530     *
22531     * @see elm_photocam_file_set()
22532     */
22533    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22534    /**
22535     * @brief Set the zoom level of the photo
22536     *
22537     * @param obj The photocam object
22538     * @param zoom The zoom level to set
22539     *
22540     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22541     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22542     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22543     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22544     * 16, 32, etc.).
22545     */
22546    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22547    /**
22548     * @brief Get the zoom level of the photo
22549     *
22550     * @param obj The photocam object
22551     * @return The current zoom level
22552     *
22553     * This returns the current zoom level of the photocam object. Note that if
22554     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22555     * (which is the default), the zoom level may be changed at any time by the
22556     * photocam object itself to account for photo size and photocam viewpoer
22557     * size.
22558     *
22559     * @see elm_photocam_zoom_set()
22560     * @see elm_photocam_zoom_mode_set()
22561     */
22562    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22563    /**
22564     * @brief Set the zoom mode
22565     *
22566     * @param obj The photocam object
22567     * @param mode The desired mode
22568     *
22569     * This sets the zoom mode to manual or one of several automatic levels.
22570     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22571     * elm_photocam_zoom_set() and will stay at that level until changed by code
22572     * or until zoom mode is changed. This is the default mode. The Automatic
22573     * modes will allow the photocam object to automatically adjust zoom mode
22574     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22575     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22576     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22577     * pixels within the frame are left unfilled.
22578     */
22579    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22580    /**
22581     * @brief Get the zoom mode
22582     *
22583     * @param obj The photocam object
22584     * @return The current zoom mode
22585     *
22586     * This gets the current zoom mode of the photocam object.
22587     *
22588     * @see elm_photocam_zoom_mode_set()
22589     */
22590    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22591    /**
22592     * @brief Get the current image pixel width and height
22593     *
22594     * @param obj The photocam object
22595     * @param w A pointer to the width return
22596     * @param h A pointer to the height return
22597     *
22598     * This gets the current photo pixel width and height (for the original).
22599     * The size will be returned in the integers @p w and @p h that are pointed
22600     * to.
22601     */
22602    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22603    /**
22604     * @brief Get the area of the image that is currently shown
22605     *
22606     * @param obj
22607     * @param x A pointer to the X-coordinate of region
22608     * @param y A pointer to the Y-coordinate of region
22609     * @param w A pointer to the width
22610     * @param h A pointer to the height
22611     *
22612     * @see elm_photocam_image_region_show()
22613     * @see elm_photocam_image_region_bring_in()
22614     */
22615    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22616    /**
22617     * @brief Set the viewed portion of the image
22618     *
22619     * @param obj The photocam object
22620     * @param x X-coordinate of region in image original pixels
22621     * @param y Y-coordinate of region in image original pixels
22622     * @param w Width of region in image original pixels
22623     * @param h Height of region in image original pixels
22624     *
22625     * This shows the region of the image without using animation.
22626     */
22627    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22628    /**
22629     * @brief Bring in the viewed portion of the image
22630     *
22631     * @param obj The photocam object
22632     * @param x X-coordinate of region in image original pixels
22633     * @param y Y-coordinate of region in image original pixels
22634     * @param w Width of region in image original pixels
22635     * @param h Height of region in image original pixels
22636     *
22637     * This shows the region of the image using animation.
22638     */
22639    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22640    /**
22641     * @brief Set the paused state for photocam
22642     *
22643     * @param obj The photocam object
22644     * @param paused The pause state to set
22645     *
22646     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22647     * photocam. The default is off. This will stop zooming using animation on
22648     * zoom levels changes and change instantly. This will stop any existing
22649     * animations that are running.
22650     */
22651    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22652    /**
22653     * @brief Get the paused state for photocam
22654     *
22655     * @param obj The photocam object
22656     * @return The current paused state
22657     *
22658     * This gets the current paused state for the photocam object.
22659     *
22660     * @see elm_photocam_paused_set()
22661     */
22662    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22663    /**
22664     * @brief Get the internal low-res image used for photocam
22665     *
22666     * @param obj The photocam object
22667     * @return The internal image object handle, or NULL if none exists
22668     *
22669     * This gets the internal image object inside photocam. Do not modify it. It
22670     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22671     * deleted at any time as well.
22672     */
22673    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22674    /**
22675     * @brief Set the photocam scrolling bouncing.
22676     *
22677     * @param obj The photocam object
22678     * @param h_bounce bouncing for horizontal
22679     * @param v_bounce bouncing for vertical
22680     */
22681    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22682    /**
22683     * @brief Get the photocam scrolling bouncing.
22684     *
22685     * @param obj The photocam object
22686     * @param h_bounce bouncing for horizontal
22687     * @param v_bounce bouncing for vertical
22688     *
22689     * @see elm_photocam_bounce_set()
22690     */
22691    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22692    /**
22693     * @}
22694     */
22695
22696    /**
22697     * @defgroup Map Map
22698     * @ingroup Elementary
22699     *
22700     * @image html img/widget/map/preview-00.png
22701     * @image latex img/widget/map/preview-00.eps
22702     *
22703     * This is a widget specifically for displaying a map. It uses basically
22704     * OpenStreetMap provider http://www.openstreetmap.org/,
22705     * but custom providers can be added.
22706     *
22707     * It supports some basic but yet nice features:
22708     * @li zoom and scroll
22709     * @li markers with content to be displayed when user clicks over it
22710     * @li group of markers
22711     * @li routes
22712     *
22713     * Smart callbacks one can listen to:
22714     *
22715     * - "clicked" - This is called when a user has clicked the map without
22716     *   dragging around.
22717     * - "press" - This is called when a user has pressed down on the map.
22718     * - "longpressed" - This is called when a user has pressed down on the map
22719     *   for a long time without dragging around.
22720     * - "clicked,double" - This is called when a user has double-clicked
22721     *   the map.
22722     * - "load,detail" - Map detailed data load begins.
22723     * - "loaded,detail" - This is called when all currently visible parts of
22724     *   the map are loaded.
22725     * - "zoom,start" - Zoom animation started.
22726     * - "zoom,stop" - Zoom animation stopped.
22727     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22728     * - "scroll" - the content has been scrolled (moved).
22729     * - "scroll,anim,start" - scrolling animation has started.
22730     * - "scroll,anim,stop" - scrolling animation has stopped.
22731     * - "scroll,drag,start" - dragging the contents around has started.
22732     * - "scroll,drag,stop" - dragging the contents around has stopped.
22733     * - "downloaded" - This is called when all currently required map images
22734     *   are downloaded.
22735     * - "route,load" - This is called when route request begins.
22736     * - "route,loaded" - This is called when route request ends.
22737     * - "name,load" - This is called when name request begins.
22738     * - "name,loaded- This is called when name request ends.
22739     *
22740     * Available style for map widget:
22741     * - @c "default"
22742     *
22743     * Available style for markers:
22744     * - @c "radio"
22745     * - @c "radio2"
22746     * - @c "empty"
22747     *
22748     * Available style for marker bubble:
22749     * - @c "default"
22750     *
22751     * List of examples:
22752     * @li @ref map_example_01
22753     * @li @ref map_example_02
22754     * @li @ref map_example_03
22755     */
22756
22757    /**
22758     * @addtogroup Map
22759     * @{
22760     */
22761
22762    /**
22763     * @enum _Elm_Map_Zoom_Mode
22764     * @typedef Elm_Map_Zoom_Mode
22765     *
22766     * Set map's zoom behavior. It can be set to manual or automatic.
22767     *
22768     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22769     *
22770     * Values <b> don't </b> work as bitmask, only one can be choosen.
22771     *
22772     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22773     * than the scroller view.
22774     *
22775     * @see elm_map_zoom_mode_set()
22776     * @see elm_map_zoom_mode_get()
22777     *
22778     * @ingroup Map
22779     */
22780    typedef enum _Elm_Map_Zoom_Mode
22781      {
22782         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22783         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22784         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22785         ELM_MAP_ZOOM_MODE_LAST
22786      } Elm_Map_Zoom_Mode;
22787
22788    /**
22789     * @enum _Elm_Map_Route_Sources
22790     * @typedef Elm_Map_Route_Sources
22791     *
22792     * Set route service to be used. By default used source is
22793     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22794     *
22795     * @see elm_map_route_source_set()
22796     * @see elm_map_route_source_get()
22797     *
22798     * @ingroup Map
22799     */
22800    typedef enum _Elm_Map_Route_Sources
22801      {
22802         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22803         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. */
22804         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22805         ELM_MAP_ROUTE_SOURCE_LAST
22806      } Elm_Map_Route_Sources;
22807
22808    typedef enum _Elm_Map_Name_Sources
22809      {
22810         ELM_MAP_NAME_SOURCE_NOMINATIM,
22811         ELM_MAP_NAME_SOURCE_LAST
22812      } Elm_Map_Name_Sources;
22813
22814    /**
22815     * @enum _Elm_Map_Route_Type
22816     * @typedef Elm_Map_Route_Type
22817     *
22818     * Set type of transport used on route.
22819     *
22820     * @see elm_map_route_add()
22821     *
22822     * @ingroup Map
22823     */
22824    typedef enum _Elm_Map_Route_Type
22825      {
22826         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22827         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22828         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22829         ELM_MAP_ROUTE_TYPE_LAST
22830      } Elm_Map_Route_Type;
22831
22832    /**
22833     * @enum _Elm_Map_Route_Method
22834     * @typedef Elm_Map_Route_Method
22835     *
22836     * Set the routing method, what should be priorized, time or distance.
22837     *
22838     * @see elm_map_route_add()
22839     *
22840     * @ingroup Map
22841     */
22842    typedef enum _Elm_Map_Route_Method
22843      {
22844         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22845         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22846         ELM_MAP_ROUTE_METHOD_LAST
22847      } Elm_Map_Route_Method;
22848
22849    typedef enum _Elm_Map_Name_Method
22850      {
22851         ELM_MAP_NAME_METHOD_SEARCH,
22852         ELM_MAP_NAME_METHOD_REVERSE,
22853         ELM_MAP_NAME_METHOD_LAST
22854      } Elm_Map_Name_Method;
22855
22856    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(). */
22857    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(). */
22858    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(). */
22859    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(). */
22860    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22861    typedef struct _Elm_Map_Track           Elm_Map_Track;
22862
22863    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. */
22864    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22865    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22866    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22867
22868    typedef char        *(*ElmMapModuleSourceFunc) (void);
22869    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22870    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22871    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22872    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22873    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22874    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22875    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22876    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22877
22878    /**
22879     * Add a new map widget to the given parent Elementary (container) object.
22880     *
22881     * @param parent The parent object.
22882     * @return a new map widget handle or @c NULL, on errors.
22883     *
22884     * This function inserts a new map widget on the canvas.
22885     *
22886     * @ingroup Map
22887     */
22888    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22889
22890    /**
22891     * Set the zoom level of the map.
22892     *
22893     * @param obj The map object.
22894     * @param zoom The zoom level to set.
22895     *
22896     * This sets the zoom level.
22897     *
22898     * It will respect limits defined by elm_map_source_zoom_min_set() and
22899     * elm_map_source_zoom_max_set().
22900     *
22901     * By default these values are 0 (world map) and 18 (maximum zoom).
22902     *
22903     * This function should be used when zoom mode is set to
22904     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22905     * with elm_map_zoom_mode_set().
22906     *
22907     * @see elm_map_zoom_mode_set().
22908     * @see elm_map_zoom_get().
22909     *
22910     * @ingroup Map
22911     */
22912    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22913
22914    /**
22915     * Get the zoom level of the map.
22916     *
22917     * @param obj The map object.
22918     * @return The current zoom level.
22919     *
22920     * This returns the current zoom level of the map object.
22921     *
22922     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22923     * (which is the default), the zoom level may be changed at any time by the
22924     * map object itself to account for map size and map viewport size.
22925     *
22926     * @see elm_map_zoom_set() for details.
22927     *
22928     * @ingroup Map
22929     */
22930    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22931
22932    /**
22933     * Set the zoom mode used by the map object.
22934     *
22935     * @param obj The map object.
22936     * @param mode The zoom mode of the map, being it one of
22937     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22938     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22939     *
22940     * This sets the zoom mode to manual or one of the automatic levels.
22941     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22942     * elm_map_zoom_set() and will stay at that level until changed by code
22943     * or until zoom mode is changed. This is the default mode.
22944     *
22945     * The Automatic modes will allow the map object to automatically
22946     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22947     * adjust zoom so the map fits inside the scroll frame with no pixels
22948     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22949     * ensure no pixels within the frame are left unfilled. Do not forget that
22950     * the valid sizes are 2^zoom, consequently the map may be smaller than
22951     * the scroller view.
22952     *
22953     * @see elm_map_zoom_set()
22954     *
22955     * @ingroup Map
22956     */
22957    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22958
22959    /**
22960     * Get the zoom mode used by the map object.
22961     *
22962     * @param obj The map object.
22963     * @return The zoom mode of the map, being it one of
22964     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22965     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22966     *
22967     * This function returns the current zoom mode used by the map object.
22968     *
22969     * @see elm_map_zoom_mode_set() for more details.
22970     *
22971     * @ingroup Map
22972     */
22973    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22974
22975    /**
22976     * Get the current coordinates of the map.
22977     *
22978     * @param obj The map object.
22979     * @param lon Pointer where to store longitude.
22980     * @param lat Pointer where to store latitude.
22981     *
22982     * This gets the current center coordinates of the map object. It can be
22983     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22984     *
22985     * @see elm_map_geo_region_bring_in()
22986     * @see elm_map_geo_region_show()
22987     *
22988     * @ingroup Map
22989     */
22990    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22991
22992    /**
22993     * Animatedly bring in given coordinates to the center of the map.
22994     *
22995     * @param obj The map object.
22996     * @param lon Longitude to center at.
22997     * @param lat Latitude to center at.
22998     *
22999     * This causes map to jump to the given @p lat and @p lon coordinates
23000     * and show it (by scrolling) in the center of the viewport, if it is not
23001     * already centered. This will use animation to do so and take a period
23002     * of time to complete.
23003     *
23004     * @see elm_map_geo_region_show() for a function to avoid animation.
23005     * @see elm_map_geo_region_get()
23006     *
23007     * @ingroup Map
23008     */
23009    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23010
23011    /**
23012     * Show the given coordinates at the center of the map, @b immediately.
23013     *
23014     * @param obj The map object.
23015     * @param lon Longitude to center at.
23016     * @param lat Latitude to center at.
23017     *
23018     * This causes map to @b redraw its viewport's contents to the
23019     * region contining the given @p lat and @p lon, that will be moved to the
23020     * center of the map.
23021     *
23022     * @see elm_map_geo_region_bring_in() for a function to move with animation.
23023     * @see elm_map_geo_region_get()
23024     *
23025     * @ingroup Map
23026     */
23027    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23028
23029    /**
23030     * Pause or unpause the map.
23031     *
23032     * @param obj The map object.
23033     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
23034     * to unpause it.
23035     *
23036     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23037     * for map.
23038     *
23039     * The default is off.
23040     *
23041     * This will stop zooming using animation, changing zoom levels will
23042     * change instantly. This will stop any existing animations that are running.
23043     *
23044     * @see elm_map_paused_get()
23045     *
23046     * @ingroup Map
23047     */
23048    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23049
23050    /**
23051     * Get a value whether map is paused or not.
23052     *
23053     * @param obj The map object.
23054     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23055     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23056     *
23057     * This gets the current paused state for the map object.
23058     *
23059     * @see elm_map_paused_set() for details.
23060     *
23061     * @ingroup Map
23062     */
23063    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23064
23065    /**
23066     * Set to show markers during zoom level changes or not.
23067     *
23068     * @param obj The map object.
23069     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23070     * to show them.
23071     *
23072     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23073     * for map.
23074     *
23075     * The default is off.
23076     *
23077     * This will stop zooming using animation, changing zoom levels will
23078     * change instantly. This will stop any existing animations that are running.
23079     *
23080     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23081     * for the markers.
23082     *
23083     * The default  is off.
23084     *
23085     * Enabling it will force the map to stop displaying the markers during
23086     * zoom level changes. Set to on if you have a large number of markers.
23087     *
23088     * @see elm_map_paused_markers_get()
23089     *
23090     * @ingroup Map
23091     */
23092    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23093
23094    /**
23095     * Get a value whether markers will be displayed on zoom level changes or not
23096     *
23097     * @param obj The map object.
23098     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23099     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23100     *
23101     * This gets the current markers paused state for the map object.
23102     *
23103     * @see elm_map_paused_markers_set() for details.
23104     *
23105     * @ingroup Map
23106     */
23107    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23108
23109    /**
23110     * Get the information of downloading status.
23111     *
23112     * @param obj The map object.
23113     * @param try_num Pointer where to store number of tiles being downloaded.
23114     * @param finish_num Pointer where to store number of tiles successfully
23115     * downloaded.
23116     *
23117     * This gets the current downloading status for the map object, the number
23118     * of tiles being downloaded and the number of tiles already downloaded.
23119     *
23120     * @ingroup Map
23121     */
23122    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23123
23124    /**
23125     * Convert a pixel coordinate (x,y) into a geographic coordinate
23126     * (longitude, latitude).
23127     *
23128     * @param obj The map object.
23129     * @param x the coordinate.
23130     * @param y the coordinate.
23131     * @param size the size in pixels of the map.
23132     * The map is a square and generally his size is : pow(2.0, zoom)*256.
23133     * @param lon Pointer where to store the longitude that correspond to x.
23134     * @param lat Pointer where to store the latitude that correspond to y.
23135     *
23136     * @note Origin pixel point is the top left corner of the viewport.
23137     * Map zoom and size are taken on account.
23138     *
23139     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23140     *
23141     * @ingroup Map
23142     */
23143    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);
23144
23145    /**
23146     * Convert a geographic coordinate (longitude, latitude) into a pixel
23147     * coordinate (x, y).
23148     *
23149     * @param obj The map object.
23150     * @param lon the longitude.
23151     * @param lat the latitude.
23152     * @param size the size in pixels of the map. The map is a square
23153     * and generally his size is : pow(2.0, zoom)*256.
23154     * @param x Pointer where to store the horizontal pixel coordinate that
23155     * correspond to the longitude.
23156     * @param y Pointer where to store the vertical pixel coordinate that
23157     * correspond to the latitude.
23158     *
23159     * @note Origin pixel point is the top left corner of the viewport.
23160     * Map zoom and size are taken on account.
23161     *
23162     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23163     *
23164     * @ingroup Map
23165     */
23166    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);
23167
23168    /**
23169     * Convert a geographic coordinate (longitude, latitude) into a name
23170     * (address).
23171     *
23172     * @param obj The map object.
23173     * @param lon the longitude.
23174     * @param lat the latitude.
23175     * @return name A #Elm_Map_Name handle for this coordinate.
23176     *
23177     * To get the string for this address, elm_map_name_address_get()
23178     * should be used.
23179     *
23180     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23181     *
23182     * @ingroup Map
23183     */
23184    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23185
23186    /**
23187     * Convert a name (address) into a geographic coordinate
23188     * (longitude, latitude).
23189     *
23190     * @param obj The map object.
23191     * @param name The address.
23192     * @return name A #Elm_Map_Name handle for this address.
23193     *
23194     * To get the longitude and latitude, elm_map_name_region_get()
23195     * should be used.
23196     *
23197     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23198     *
23199     * @ingroup Map
23200     */
23201    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23202
23203    /**
23204     * Convert a pixel coordinate into a rotated pixel coordinate.
23205     *
23206     * @param obj The map object.
23207     * @param x horizontal coordinate of the point to rotate.
23208     * @param y vertical coordinate of the point to rotate.
23209     * @param cx rotation's center horizontal position.
23210     * @param cy rotation's center vertical position.
23211     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23212     * @param xx Pointer where to store rotated x.
23213     * @param yy Pointer where to store rotated y.
23214     *
23215     * @ingroup Map
23216     */
23217    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);
23218
23219    /**
23220     * Add a new marker to the map object.
23221     *
23222     * @param obj The map object.
23223     * @param lon The longitude of the marker.
23224     * @param lat The latitude of the marker.
23225     * @param clas The class, to use when marker @b isn't grouped to others.
23226     * @param clas_group The class group, to use when marker is grouped to others
23227     * @param data The data passed to the callbacks.
23228     *
23229     * @return The created marker or @c NULL upon failure.
23230     *
23231     * A marker will be created and shown in a specific point of the map, defined
23232     * by @p lon and @p lat.
23233     *
23234     * It will be displayed using style defined by @p class when this marker
23235     * is displayed alone (not grouped). A new class can be created with
23236     * elm_map_marker_class_new().
23237     *
23238     * If the marker is grouped to other markers, it will be displayed with
23239     * style defined by @p class_group. Markers with the same group are grouped
23240     * if they are close. A new group class can be created with
23241     * elm_map_marker_group_class_new().
23242     *
23243     * Markers created with this method can be deleted with
23244     * elm_map_marker_remove().
23245     *
23246     * A marker can have associated content to be displayed by a bubble,
23247     * when a user click over it, as well as an icon. These objects will
23248     * be fetch using class' callback functions.
23249     *
23250     * @see elm_map_marker_class_new()
23251     * @see elm_map_marker_group_class_new()
23252     * @see elm_map_marker_remove()
23253     *
23254     * @ingroup Map
23255     */
23256    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);
23257
23258    /**
23259     * Set the maximum numbers of markers' content to be displayed in a group.
23260     *
23261     * @param obj The map object.
23262     * @param max The maximum numbers of items displayed in a bubble.
23263     *
23264     * A bubble will be displayed when the user clicks over the group,
23265     * and will place the content of markers that belong to this group
23266     * inside it.
23267     *
23268     * A group can have a long list of markers, consequently the creation
23269     * of the content of the bubble can be very slow.
23270     *
23271     * In order to avoid this, a maximum number of items is displayed
23272     * in a bubble.
23273     *
23274     * By default this number is 30.
23275     *
23276     * Marker with the same group class are grouped if they are close.
23277     *
23278     * @see elm_map_marker_add()
23279     *
23280     * @ingroup Map
23281     */
23282    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23283
23284    /**
23285     * Remove a marker from the map.
23286     *
23287     * @param marker The marker to remove.
23288     *
23289     * @see elm_map_marker_add()
23290     *
23291     * @ingroup Map
23292     */
23293    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23294
23295    /**
23296     * Get the current coordinates of the marker.
23297     *
23298     * @param marker marker.
23299     * @param lat Pointer where to store the marker's latitude.
23300     * @param lon Pointer where to store the marker's longitude.
23301     *
23302     * These values are set when adding markers, with function
23303     * elm_map_marker_add().
23304     *
23305     * @see elm_map_marker_add()
23306     *
23307     * @ingroup Map
23308     */
23309    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23310
23311    /**
23312     * Animatedly bring in given marker to the center of the map.
23313     *
23314     * @param marker The marker to center at.
23315     *
23316     * This causes map to jump to the given @p marker's coordinates
23317     * and show it (by scrolling) in the center of the viewport, if it is not
23318     * already centered. This will use animation to do so and take a period
23319     * of time to complete.
23320     *
23321     * @see elm_map_marker_show() for a function to avoid animation.
23322     * @see elm_map_marker_region_get()
23323     *
23324     * @ingroup Map
23325     */
23326    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23327
23328    /**
23329     * Show the given marker at the center of the map, @b immediately.
23330     *
23331     * @param marker The marker to center at.
23332     *
23333     * This causes map to @b redraw its viewport's contents to the
23334     * region contining the given @p marker's coordinates, that will be
23335     * moved to the center of the map.
23336     *
23337     * @see elm_map_marker_bring_in() for a function to move with animation.
23338     * @see elm_map_markers_list_show() if more than one marker need to be
23339     * displayed.
23340     * @see elm_map_marker_region_get()
23341     *
23342     * @ingroup Map
23343     */
23344    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23345
23346    /**
23347     * Move and zoom the map to display a list of markers.
23348     *
23349     * @param markers A list of #Elm_Map_Marker handles.
23350     *
23351     * The map will be centered on the center point of the markers in the list.
23352     * Then the map will be zoomed in order to fit the markers using the maximum
23353     * zoom which allows display of all the markers.
23354     *
23355     * @warning All the markers should belong to the same map object.
23356     *
23357     * @see elm_map_marker_show() to show a single marker.
23358     * @see elm_map_marker_bring_in()
23359     *
23360     * @ingroup Map
23361     */
23362    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23363
23364    /**
23365     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23366     *
23367     * @param marker The marker wich content should be returned.
23368     * @return Return the evas object if it exists, else @c NULL.
23369     *
23370     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23371     * elm_map_marker_class_get_cb_set() should be used.
23372     *
23373     * This content is what will be inside the bubble that will be displayed
23374     * when an user clicks over the marker.
23375     *
23376     * This returns the actual Evas object used to be placed inside
23377     * the bubble. This may be @c NULL, as it may
23378     * not have been created or may have been deleted, at any time, by
23379     * the map. <b>Do not modify this object</b> (move, resize,
23380     * show, hide, etc.), as the map is controlling it. This
23381     * function is for querying, emitting custom signals or hooking
23382     * lower level callbacks for events on that object. Do not delete
23383     * this object under any circumstances.
23384     *
23385     * @ingroup Map
23386     */
23387    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23388
23389    /**
23390     * Update the marker
23391     *
23392     * @param marker The marker to be updated.
23393     *
23394     * If a content is set to this marker, it will call function to delete it,
23395     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23396     * #ElmMapMarkerGetFunc.
23397     *
23398     * These functions are set for the marker class with
23399     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23400     *
23401     * @ingroup Map
23402     */
23403    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23404
23405    /**
23406     * Close all the bubbles opened by the user.
23407     *
23408     * @param obj The map object.
23409     *
23410     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23411     * when the user clicks on a marker.
23412     *
23413     * This functions is set for the marker class with
23414     * elm_map_marker_class_get_cb_set().
23415     *
23416     * @ingroup Map
23417     */
23418    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23419
23420    /**
23421     * Create a new group class.
23422     *
23423     * @param obj The map object.
23424     * @return Returns the new group class.
23425     *
23426     * Each marker must be associated to a group class. Markers in the same
23427     * group are grouped if they are close.
23428     *
23429     * The group class defines the style of the marker when a marker is grouped
23430     * to others markers. When it is alone, another class will be used.
23431     *
23432     * A group class will need to be provided when creating a marker with
23433     * elm_map_marker_add().
23434     *
23435     * Some properties and functions can be set by class, as:
23436     * - style, with elm_map_group_class_style_set()
23437     * - data - to be associated to the group class. It can be set using
23438     *   elm_map_group_class_data_set().
23439     * - min zoom to display markers, set with
23440     *   elm_map_group_class_zoom_displayed_set().
23441     * - max zoom to group markers, set using
23442     *   elm_map_group_class_zoom_grouped_set().
23443     * - visibility - set if markers will be visible or not, set with
23444     *   elm_map_group_class_hide_set().
23445     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23446     *   It can be set using elm_map_group_class_icon_cb_set().
23447     *
23448     * @see elm_map_marker_add()
23449     * @see elm_map_group_class_style_set()
23450     * @see elm_map_group_class_data_set()
23451     * @see elm_map_group_class_zoom_displayed_set()
23452     * @see elm_map_group_class_zoom_grouped_set()
23453     * @see elm_map_group_class_hide_set()
23454     * @see elm_map_group_class_icon_cb_set()
23455     *
23456     * @ingroup Map
23457     */
23458    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23459
23460    /**
23461     * Set the marker's style of a group class.
23462     *
23463     * @param clas The group class.
23464     * @param style The style to be used by markers.
23465     *
23466     * Each marker must be associated to a group class, and will use the style
23467     * defined by such class when grouped to other markers.
23468     *
23469     * The following styles are provided by default theme:
23470     * @li @c radio - blue circle
23471     * @li @c radio2 - green circle
23472     * @li @c empty
23473     *
23474     * @see elm_map_group_class_new() for more details.
23475     * @see elm_map_marker_add()
23476     *
23477     * @ingroup Map
23478     */
23479    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23480
23481    /**
23482     * Set the icon callback function of a group class.
23483     *
23484     * @param clas The group class.
23485     * @param icon_get The callback function that will return the icon.
23486     *
23487     * Each marker must be associated to a group class, and it can display a
23488     * custom icon. The function @p icon_get must return this icon.
23489     *
23490     * @see elm_map_group_class_new() for more details.
23491     * @see elm_map_marker_add()
23492     *
23493     * @ingroup Map
23494     */
23495    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23496
23497    /**
23498     * Set the data associated to the group class.
23499     *
23500     * @param clas The group class.
23501     * @param data The new user data.
23502     *
23503     * This data will be passed for callback functions, like icon get callback,
23504     * that can be set with elm_map_group_class_icon_cb_set().
23505     *
23506     * If a data was previously set, the object will lose the pointer for it,
23507     * so if needs to be freed, you must do it yourself.
23508     *
23509     * @see elm_map_group_class_new() for more details.
23510     * @see elm_map_group_class_icon_cb_set()
23511     * @see elm_map_marker_add()
23512     *
23513     * @ingroup Map
23514     */
23515    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23516
23517    /**
23518     * Set the minimum zoom from where the markers are displayed.
23519     *
23520     * @param clas The group class.
23521     * @param zoom The minimum zoom.
23522     *
23523     * Markers only will be displayed when the map is displayed at @p zoom
23524     * or bigger.
23525     *
23526     * @see elm_map_group_class_new() for more details.
23527     * @see elm_map_marker_add()
23528     *
23529     * @ingroup Map
23530     */
23531    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23532
23533    /**
23534     * Set the zoom from where the markers are no more grouped.
23535     *
23536     * @param clas The group class.
23537     * @param zoom The maximum zoom.
23538     *
23539     * Markers only will be grouped when the map is displayed at
23540     * less than @p zoom.
23541     *
23542     * @see elm_map_group_class_new() for more details.
23543     * @see elm_map_marker_add()
23544     *
23545     * @ingroup Map
23546     */
23547    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23548
23549    /**
23550     * Set if the markers associated to the group class @clas are hidden or not.
23551     *
23552     * @param clas The group class.
23553     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23554     * to show them.
23555     *
23556     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23557     * is to show them.
23558     *
23559     * @ingroup Map
23560     */
23561    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23562
23563    /**
23564     * Create a new marker class.
23565     *
23566     * @param obj The map object.
23567     * @return Returns the new group class.
23568     *
23569     * Each marker must be associated to a class.
23570     *
23571     * The marker class defines the style of the marker when a marker is
23572     * displayed alone, i.e., not grouped to to others markers. When grouped
23573     * it will use group class style.
23574     *
23575     * A marker class will need to be provided when creating a marker with
23576     * elm_map_marker_add().
23577     *
23578     * Some properties and functions can be set by class, as:
23579     * - style, with elm_map_marker_class_style_set()
23580     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23581     *   It can be set using elm_map_marker_class_icon_cb_set().
23582     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23583     *   Set using elm_map_marker_class_get_cb_set().
23584     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23585     *   Set using elm_map_marker_class_del_cb_set().
23586     *
23587     * @see elm_map_marker_add()
23588     * @see elm_map_marker_class_style_set()
23589     * @see elm_map_marker_class_icon_cb_set()
23590     * @see elm_map_marker_class_get_cb_set()
23591     * @see elm_map_marker_class_del_cb_set()
23592     *
23593     * @ingroup Map
23594     */
23595    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23596
23597    /**
23598     * Set the marker's style of a marker class.
23599     *
23600     * @param clas The marker class.
23601     * @param style The style to be used by markers.
23602     *
23603     * Each marker must be associated to a marker class, and will use the style
23604     * defined by such class when alone, i.e., @b not grouped to other markers.
23605     *
23606     * The following styles are provided by default theme:
23607     * @li @c radio
23608     * @li @c radio2
23609     * @li @c empty
23610     *
23611     * @see elm_map_marker_class_new() for more details.
23612     * @see elm_map_marker_add()
23613     *
23614     * @ingroup Map
23615     */
23616    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23617
23618    /**
23619     * Set the icon callback function of a marker class.
23620     *
23621     * @param clas The marker class.
23622     * @param icon_get The callback function that will return the icon.
23623     *
23624     * Each marker must be associated to a marker class, and it can display a
23625     * custom icon. The function @p icon_get must return this icon.
23626     *
23627     * @see elm_map_marker_class_new() for more details.
23628     * @see elm_map_marker_add()
23629     *
23630     * @ingroup Map
23631     */
23632    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23633
23634    /**
23635     * Set the bubble content callback function of a marker class.
23636     *
23637     * @param clas The marker class.
23638     * @param get The callback function that will return the content.
23639     *
23640     * Each marker must be associated to a marker class, and it can display a
23641     * a content on a bubble that opens when the user click over the marker.
23642     * The function @p get must return this content object.
23643     *
23644     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23645     * can be used.
23646     *
23647     * @see elm_map_marker_class_new() for more details.
23648     * @see elm_map_marker_class_del_cb_set()
23649     * @see elm_map_marker_add()
23650     *
23651     * @ingroup Map
23652     */
23653    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23654
23655    /**
23656     * Set the callback function used to delete bubble content of a marker class.
23657     *
23658     * @param clas The marker class.
23659     * @param del The callback function that will delete the content.
23660     *
23661     * Each marker must be associated to a marker class, and it can display a
23662     * a content on a bubble that opens when the user click over the marker.
23663     * The function to return such content can be set with
23664     * elm_map_marker_class_get_cb_set().
23665     *
23666     * If this content must be freed, a callback function need to be
23667     * set for that task with this function.
23668     *
23669     * If this callback is defined it will have to delete (or not) the
23670     * object inside, but if the callback is not defined the object will be
23671     * destroyed with evas_object_del().
23672     *
23673     * @see elm_map_marker_class_new() for more details.
23674     * @see elm_map_marker_class_get_cb_set()
23675     * @see elm_map_marker_add()
23676     *
23677     * @ingroup Map
23678     */
23679    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23680
23681    /**
23682     * Get the list of available sources.
23683     *
23684     * @param obj The map object.
23685     * @return The source names list.
23686     *
23687     * It will provide a list with all available sources, that can be set as
23688     * current source with elm_map_source_name_set(), or get with
23689     * elm_map_source_name_get().
23690     *
23691     * Available sources:
23692     * @li "Mapnik"
23693     * @li "Osmarender"
23694     * @li "CycleMap"
23695     * @li "Maplint"
23696     *
23697     * @see elm_map_source_name_set() for more details.
23698     * @see elm_map_source_name_get()
23699     *
23700     * @ingroup Map
23701     */
23702    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23703
23704    /**
23705     * Set the source of the map.
23706     *
23707     * @param obj The map object.
23708     * @param source The source to be used.
23709     *
23710     * Map widget retrieves images that composes the map from a web service.
23711     * This web service can be set with this method.
23712     *
23713     * A different service can return a different maps with different
23714     * information and it can use different zoom values.
23715     *
23716     * The @p source_name need to match one of the names provided by
23717     * elm_map_source_names_get().
23718     *
23719     * The current source can be get using elm_map_source_name_get().
23720     *
23721     * @see elm_map_source_names_get()
23722     * @see elm_map_source_name_get()
23723     *
23724     *
23725     * @ingroup Map
23726     */
23727    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23728
23729    /**
23730     * Get the name of currently used source.
23731     *
23732     * @param obj The map object.
23733     * @return Returns the name of the source in use.
23734     *
23735     * @see elm_map_source_name_set() for more details.
23736     *
23737     * @ingroup Map
23738     */
23739    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23740
23741    /**
23742     * Set the source of the route service to be used by the map.
23743     *
23744     * @param obj The map object.
23745     * @param source The route service to be used, being it one of
23746     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23747     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23748     *
23749     * Each one has its own algorithm, so the route retrieved may
23750     * differ depending on the source route. Now, only the default is working.
23751     *
23752     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23753     * http://www.yournavigation.org/.
23754     *
23755     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23756     * assumptions. Its routing core is based on Contraction Hierarchies.
23757     *
23758     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23759     *
23760     * @see elm_map_route_source_get().
23761     *
23762     * @ingroup Map
23763     */
23764    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23765
23766    /**
23767     * Get the current route source.
23768     *
23769     * @param obj The map object.
23770     * @return The source of the route service used by the map.
23771     *
23772     * @see elm_map_route_source_set() for details.
23773     *
23774     * @ingroup Map
23775     */
23776    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23777
23778    /**
23779     * Set the minimum zoom of the source.
23780     *
23781     * @param obj The map object.
23782     * @param zoom New minimum zoom value to be used.
23783     *
23784     * By default, it's 0.
23785     *
23786     * @ingroup Map
23787     */
23788    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23789
23790    /**
23791     * Get the minimum zoom of the source.
23792     *
23793     * @param obj The map object.
23794     * @return Returns the minimum zoom of the source.
23795     *
23796     * @see elm_map_source_zoom_min_set() for details.
23797     *
23798     * @ingroup Map
23799     */
23800    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23801
23802    /**
23803     * Set the maximum zoom of the source.
23804     *
23805     * @param obj The map object.
23806     * @param zoom New maximum zoom value to be used.
23807     *
23808     * By default, it's 18.
23809     *
23810     * @ingroup Map
23811     */
23812    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23813
23814    /**
23815     * Get the maximum zoom of the source.
23816     *
23817     * @param obj The map object.
23818     * @return Returns the maximum zoom of the source.
23819     *
23820     * @see elm_map_source_zoom_min_set() for details.
23821     *
23822     * @ingroup Map
23823     */
23824    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23825
23826    /**
23827     * Set the user agent used by the map object to access routing services.
23828     *
23829     * @param obj The map object.
23830     * @param user_agent The user agent to be used by the map.
23831     *
23832     * User agent is a client application implementing a network protocol used
23833     * in communications within a clientā€“server distributed computing system
23834     *
23835     * The @p user_agent identification string will transmitted in a header
23836     * field @c User-Agent.
23837     *
23838     * @see elm_map_user_agent_get()
23839     *
23840     * @ingroup Map
23841     */
23842    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23843
23844    /**
23845     * Get the user agent used by the map object.
23846     *
23847     * @param obj The map object.
23848     * @return The user agent identification string used by the map.
23849     *
23850     * @see elm_map_user_agent_set() for details.
23851     *
23852     * @ingroup Map
23853     */
23854    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23855
23856    /**
23857     * Add a new route to the map object.
23858     *
23859     * @param obj The map object.
23860     * @param type The type of transport to be considered when tracing a route.
23861     * @param method The routing method, what should be priorized.
23862     * @param flon The start longitude.
23863     * @param flat The start latitude.
23864     * @param tlon The destination longitude.
23865     * @param tlat The destination latitude.
23866     *
23867     * @return The created route or @c NULL upon failure.
23868     *
23869     * A route will be traced by point on coordinates (@p flat, @p flon)
23870     * to point on coordinates (@p tlat, @p tlon), using the route service
23871     * set with elm_map_route_source_set().
23872     *
23873     * It will take @p type on consideration to define the route,
23874     * depending if the user will be walking or driving, the route may vary.
23875     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23876     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23877     *
23878     * Another parameter is what the route should priorize, the minor distance
23879     * or the less time to be spend on the route. So @p method should be one
23880     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23881     *
23882     * Routes created with this method can be deleted with
23883     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23884     * and distance can be get with elm_map_route_distance_get().
23885     *
23886     * @see elm_map_route_remove()
23887     * @see elm_map_route_color_set()
23888     * @see elm_map_route_distance_get()
23889     * @see elm_map_route_source_set()
23890     *
23891     * @ingroup Map
23892     */
23893    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);
23894
23895    /**
23896     * Remove a route from the map.
23897     *
23898     * @param route The route to remove.
23899     *
23900     * @see elm_map_route_add()
23901     *
23902     * @ingroup Map
23903     */
23904    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23905
23906    /**
23907     * Set the route color.
23908     *
23909     * @param route The route object.
23910     * @param r Red channel value, from 0 to 255.
23911     * @param g Green channel value, from 0 to 255.
23912     * @param b Blue channel value, from 0 to 255.
23913     * @param a Alpha channel value, from 0 to 255.
23914     *
23915     * It uses an additive color model, so each color channel represents
23916     * how much of each primary colors must to be used. 0 represents
23917     * ausence of this color, so if all of the three are set to 0,
23918     * the color will be black.
23919     *
23920     * These component values should be integers in the range 0 to 255,
23921     * (single 8-bit byte).
23922     *
23923     * This sets the color used for the route. By default, it is set to
23924     * solid red (r = 255, g = 0, b = 0, a = 255).
23925     *
23926     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23927     *
23928     * @see elm_map_route_color_get()
23929     *
23930     * @ingroup Map
23931     */
23932    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23933
23934    /**
23935     * Get the route color.
23936     *
23937     * @param route The route object.
23938     * @param r Pointer where to store the red channel value.
23939     * @param g Pointer where to store the green channel value.
23940     * @param b Pointer where to store the blue channel value.
23941     * @param a Pointer where to store the alpha channel value.
23942     *
23943     * @see elm_map_route_color_set() for details.
23944     *
23945     * @ingroup Map
23946     */
23947    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23948
23949    /**
23950     * Get the route distance in kilometers.
23951     *
23952     * @param route The route object.
23953     * @return The distance of route (unit : km).
23954     *
23955     * @ingroup Map
23956     */
23957    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23958
23959    /**
23960     * Get the information of route nodes.
23961     *
23962     * @param route The route object.
23963     * @return Returns a string with the nodes of route.
23964     *
23965     * @ingroup Map
23966     */
23967    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23968
23969    /**
23970     * Get the information of route waypoint.
23971     *
23972     * @param route the route object.
23973     * @return Returns a string with information about waypoint of route.
23974     *
23975     * @ingroup Map
23976     */
23977    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23978
23979    /**
23980     * Get the address of the name.
23981     *
23982     * @param name The name handle.
23983     * @return Returns the address string of @p name.
23984     *
23985     * This gets the coordinates of the @p name, created with one of the
23986     * conversion functions.
23987     *
23988     * @see elm_map_utils_convert_name_into_coord()
23989     * @see elm_map_utils_convert_coord_into_name()
23990     *
23991     * @ingroup Map
23992     */
23993    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23994
23995    /**
23996     * Get the current coordinates of the name.
23997     *
23998     * @param name The name handle.
23999     * @param lat Pointer where to store the latitude.
24000     * @param lon Pointer where to store The longitude.
24001     *
24002     * This gets the coordinates of the @p name, created with one of the
24003     * conversion functions.
24004     *
24005     * @see elm_map_utils_convert_name_into_coord()
24006     * @see elm_map_utils_convert_coord_into_name()
24007     *
24008     * @ingroup Map
24009     */
24010    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24011
24012    /**
24013     * Remove a name from the map.
24014     *
24015     * @param name The name to remove.
24016     *
24017     * Basically the struct handled by @p name will be freed, so convertions
24018     * between address and coordinates will be lost.
24019     *
24020     * @see elm_map_utils_convert_name_into_coord()
24021     * @see elm_map_utils_convert_coord_into_name()
24022     *
24023     * @ingroup Map
24024     */
24025    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24026
24027    /**
24028     * Rotate the map.
24029     *
24030     * @param obj The map object.
24031     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
24032     * @param cx Rotation's center horizontal position.
24033     * @param cy Rotation's center vertical position.
24034     *
24035     * @see elm_map_rotate_get()
24036     *
24037     * @ingroup Map
24038     */
24039    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
24040
24041    /**
24042     * Get the rotate degree of the map
24043     *
24044     * @param obj The map object
24045     * @param degree Pointer where to store degrees from 0.0 to 360.0
24046     * to rotate arount Z axis.
24047     * @param cx Pointer where to store rotation's center horizontal position.
24048     * @param cy Pointer where to store rotation's center vertical position.
24049     *
24050     * @see elm_map_rotate_set() to set map rotation.
24051     *
24052     * @ingroup Map
24053     */
24054    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);
24055
24056    /**
24057     * Enable or disable mouse wheel to be used to zoom in / out the map.
24058     *
24059     * @param obj The map object.
24060     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24061     * to enable it.
24062     *
24063     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24064     *
24065     * It's disabled by default.
24066     *
24067     * @see elm_map_wheel_disabled_get()
24068     *
24069     * @ingroup Map
24070     */
24071    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24072
24073    /**
24074     * Get a value whether mouse wheel is enabled or not.
24075     *
24076     * @param obj The map object.
24077     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24078     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24079     *
24080     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24081     *
24082     * @see elm_map_wheel_disabled_set() for details.
24083     *
24084     * @ingroup Map
24085     */
24086    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24087
24088 #ifdef ELM_EMAP
24089    /**
24090     * Add a track on the map
24091     *
24092     * @param obj The map object.
24093     * @param emap The emap route object.
24094     * @return The route object. This is an elm object of type Route.
24095     *
24096     * @see elm_route_add() for details.
24097     *
24098     * @ingroup Map
24099     */
24100    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24101 #endif
24102
24103    /**
24104     * Remove a track from the map
24105     *
24106     * @param obj The map object.
24107     * @param route The track to remove.
24108     *
24109     * @ingroup Map
24110     */
24111    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24112
24113    /**
24114     * @}
24115     */
24116
24117    /* Route */
24118    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24119 #ifdef ELM_EMAP
24120    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24121 #endif
24122    EAPI double elm_route_lon_min_get(Evas_Object *obj);
24123    EAPI double elm_route_lat_min_get(Evas_Object *obj);
24124    EAPI double elm_route_lon_max_get(Evas_Object *obj);
24125    EAPI double elm_route_lat_max_get(Evas_Object *obj);
24126
24127
24128    /**
24129     * @defgroup Panel Panel
24130     *
24131     * @image html img/widget/panel/preview-00.png
24132     * @image latex img/widget/panel/preview-00.eps
24133     *
24134     * @brief A panel is a type of animated container that contains subobjects.
24135     * It can be expanded or contracted by clicking the button on it's edge.
24136     *
24137     * Orientations are as follows:
24138     * @li ELM_PANEL_ORIENT_TOP
24139     * @li ELM_PANEL_ORIENT_LEFT
24140     * @li ELM_PANEL_ORIENT_RIGHT
24141     *
24142     * Default contents parts of the panel widget that you can use for are:
24143     * @li "default" - A content of the panel
24144     *
24145     * @ref tutorial_panel shows one way to use this widget.
24146     * @{
24147     */
24148    typedef enum _Elm_Panel_Orient
24149      {
24150         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24151         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24152         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24153         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24154      } Elm_Panel_Orient;
24155    /**
24156     * @brief Adds a panel object
24157     *
24158     * @param parent The parent object
24159     *
24160     * @return The panel object, or NULL on failure
24161     */
24162    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24163    /**
24164     * @brief Sets the orientation of the panel
24165     *
24166     * @param parent The parent object
24167     * @param orient The panel orientation. Can be one of the following:
24168     * @li ELM_PANEL_ORIENT_TOP
24169     * @li ELM_PANEL_ORIENT_LEFT
24170     * @li ELM_PANEL_ORIENT_RIGHT
24171     *
24172     * Sets from where the panel will (dis)appear.
24173     */
24174    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24175    /**
24176     * @brief Get the orientation of the panel.
24177     *
24178     * @param obj The panel object
24179     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24180     */
24181    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24182    /**
24183     * @brief Set the content of the panel.
24184     *
24185     * @param obj The panel object
24186     * @param content The panel content
24187     *
24188     * Once the content object is set, a previously set one will be deleted.
24189     * If you want to keep that old content object, use the
24190     * elm_panel_content_unset() function.
24191     *
24192     * @deprecated use elm_object_content_set() instead
24193     *
24194     */
24195    WILL_DEPRECATE  EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24196    /**
24197     * @brief Get the content of the panel.
24198     *
24199     * @param obj The panel object
24200     * @return The content that is being used
24201     *
24202     * Return the content object which is set for this widget.
24203     *
24204     * @see elm_panel_content_set()
24205     * 
24206     * @deprecated use elm_object_content_get() instead
24207     *
24208     */
24209    WILL_DEPRECATE  EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24210    /**
24211     * @brief Unset the content of the panel.
24212     *
24213     * @param obj The panel object
24214     * @return The content that was being used
24215     *
24216     * Unparent and return the content object which was set for this widget.
24217     *
24218     * @see elm_panel_content_set()
24219     *
24220     * @deprecated use elm_object_content_unset() instead
24221     *
24222     */
24223    WILL_DEPRECATE  EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24224    /**
24225     * @brief Set the state of the panel.
24226     *
24227     * @param obj The panel object
24228     * @param hidden If true, the panel will run the animation to contract
24229     */
24230    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24231    /**
24232     * @brief Get the state of the panel.
24233     *
24234     * @param obj The panel object
24235     * @param hidden If true, the panel is in the "hide" state
24236     */
24237    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24238    /**
24239     * @brief Toggle the hidden state of the panel from code
24240     *
24241     * @param obj The panel object
24242     */
24243    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24244    /**
24245     * @}
24246     */
24247
24248    /**
24249     * @defgroup Panes Panes
24250     * @ingroup Elementary
24251     *
24252     * @image html img/widget/panes/preview-00.png
24253     * @image latex img/widget/panes/preview-00.eps width=\textwidth
24254     *
24255     * @image html img/panes.png
24256     * @image latex img/panes.eps width=\textwidth
24257     *
24258     * The panes adds a dragable bar between two contents. When dragged
24259     * this bar will resize contents size.
24260     *
24261     * Panes can be displayed vertically or horizontally, and contents
24262     * size proportion can be customized (homogeneous by default).
24263     *
24264     * Smart callbacks one can listen to:
24265     * - "press" - The panes has been pressed (button wasn't released yet).
24266     * - "unpressed" - The panes was released after being pressed.
24267     * - "clicked" - The panes has been clicked>
24268     * - "clicked,double" - The panes has been double clicked
24269     *
24270     * Available styles for it:
24271     * - @c "default"
24272     *
24273     * Default contents parts of the panes widget that you can use for are:
24274     * @li "left" - A leftside content of the panes
24275     * @li "right" - A rightside content of the panes
24276     *
24277     * If panes is displayed vertically, left content will be displayed at
24278     * top.
24279     * 
24280     * Here is an example on its usage:
24281     * @li @ref panes_example
24282     */
24283
24284    /**
24285     * @addtogroup Panes
24286     * @{
24287     */
24288
24289    /**
24290     * Add a new panes widget to the given parent Elementary
24291     * (container) object.
24292     *
24293     * @param parent The parent object.
24294     * @return a new panes widget handle or @c NULL, on errors.
24295     *
24296     * This function inserts a new panes widget on the canvas.
24297     *
24298     * @ingroup Panes
24299     */
24300    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24301
24302    /**
24303     * Set the left content of the panes widget.
24304     *
24305     * @param obj The panes object.
24306     * @param content The new left content object.
24307     *
24308     * Once the content object is set, a previously set one will be deleted.
24309     * If you want to keep that old content object, use the
24310     * elm_panes_content_left_unset() function.
24311     *
24312     * If panes is displayed vertically, left content will be displayed at
24313     * top.
24314     *
24315     * @see elm_panes_content_left_get()
24316     * @see elm_panes_content_right_set() to set content on the other side.
24317     *
24318     * @deprecated use elm_object_part_content_set() instead
24319     *
24320     * @ingroup Panes
24321     */
24322    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24323
24324    /**
24325     * Set the right content of the panes widget.
24326     *
24327     * @param obj The panes object.
24328     * @param content The new right content object.
24329     *
24330     * Once the content object is set, a previously set one will be deleted.
24331     * If you want to keep that old content object, use the
24332     * elm_panes_content_right_unset() function.
24333     *
24334     * If panes is displayed vertically, left content will be displayed at
24335     * bottom.
24336     *
24337     * @see elm_panes_content_right_get()
24338     * @see elm_panes_content_left_set() to set content on the other side.
24339     *
24340     * @deprecated use elm_object_part_content_set() instead
24341     *
24342     * @ingroup Panes
24343     */
24344    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24345
24346    /**
24347     * Get the left content of the panes.
24348     *
24349     * @param obj The panes object.
24350     * @return The left content object that is being used.
24351     *
24352     * Return the left content object which is set for this widget.
24353     *
24354     * @see elm_panes_content_left_set() for details.
24355     *
24356     * @deprecated use elm_object_part_content_get() instead
24357     *
24358     * @ingroup Panes
24359     */
24360    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24361
24362    /**
24363     * Get the right content of the panes.
24364     *
24365     * @param obj The panes object
24366     * @return The right content object that is being used
24367     *
24368     * Return the right content object which is set for this widget.
24369     *
24370     * @see elm_panes_content_right_set() for details.
24371     *
24372     * @deprecated use elm_object_part_content_get() instead
24373     *
24374     * @ingroup Panes
24375     */
24376    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24377
24378    /**
24379     * Unset the left content used for the panes.
24380     *
24381     * @param obj The panes object.
24382     * @return The left content object that was being used.
24383     *
24384     * Unparent and return the left content object which was set for this widget.
24385     *
24386     * @see elm_panes_content_left_set() for details.
24387     * @see elm_panes_content_left_get().
24388     *
24389     * @deprecated use elm_object_part_content_unset() instead
24390     *
24391     * @ingroup Panes
24392     */
24393    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24394
24395    /**
24396     * Unset the right content used for the panes.
24397     *
24398     * @param obj The panes object.
24399     * @return The right content object that was being used.
24400     *
24401     * Unparent and return the right content object which was set for this
24402     * widget.
24403     *
24404     * @see elm_panes_content_right_set() for details.
24405     * @see elm_panes_content_right_get().
24406     *
24407     * @deprecated use elm_object_part_content_unset() instead
24408     *
24409     * @ingroup Panes
24410     */
24411    WILL_DEPRECATE  EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24412
24413    /**
24414     * Get the size proportion of panes widget's left side.
24415     *
24416     * @param obj The panes object.
24417     * @return float value between 0.0 and 1.0 representing size proportion
24418     * of left side.
24419     *
24420     * @see elm_panes_content_left_size_set() for more details.
24421     *
24422     * @ingroup Panes
24423     */
24424    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24425
24426    /**
24427     * Set the size proportion of panes widget's left side.
24428     *
24429     * @param obj The panes object.
24430     * @param size Value between 0.0 and 1.0 representing size proportion
24431     * of left side.
24432     *
24433     * By default it's homogeneous, i.e., both sides have the same size.
24434     *
24435     * If something different is required, it can be set with this function.
24436     * For example, if the left content should be displayed over
24437     * 75% of the panes size, @p size should be passed as @c 0.75.
24438     * This way, right content will be resized to 25% of panes size.
24439     *
24440     * If displayed vertically, left content is displayed at top, and
24441     * right content at bottom.
24442     *
24443     * @note This proportion will change when user drags the panes bar.
24444     *
24445     * @see elm_panes_content_left_size_get()
24446     *
24447     * @ingroup Panes
24448     */
24449    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24450
24451   /**
24452    * Set the orientation of a given panes widget.
24453    *
24454    * @param obj The panes object.
24455    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24456    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24457    *
24458    * Use this function to change how your panes is to be
24459    * disposed: vertically or horizontally.
24460    *
24461    * By default it's displayed horizontally.
24462    *
24463    * @see elm_panes_horizontal_get()
24464    *
24465    * @ingroup Panes
24466    */
24467    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24468
24469    /**
24470     * Retrieve the orientation of a given panes widget.
24471     *
24472     * @param obj The panes object.
24473     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24474     * @c EINA_FALSE if it's @b vertical (and on errors).
24475     *
24476     * @see elm_panes_horizontal_set() for more details.
24477     *
24478     * @ingroup Panes
24479     */
24480    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24481    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24482    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24483
24484    /**
24485     * @}
24486     */
24487
24488    /**
24489     * @defgroup Flip Flip
24490     *
24491     * @image html img/widget/flip/preview-00.png
24492     * @image latex img/widget/flip/preview-00.eps
24493     *
24494     * This widget holds 2 content objects(Evas_Object): one on the front and one
24495     * on the back. It allows you to flip from front to back and vice-versa using
24496     * various animations.
24497     *
24498     * If either the front or back contents are not set the flip will treat that
24499     * as transparent. So if you wore to set the front content but not the back,
24500     * and then call elm_flip_go() you would see whatever is below the flip.
24501     *
24502     * For a list of supported animations see elm_flip_go().
24503     *
24504     * Signals that you can add callbacks for are:
24505     * "animate,begin" - when a flip animation was started
24506     * "animate,done" - when a flip animation is finished
24507     *
24508     * @ref tutorial_flip show how to use most of the API.
24509     *
24510     * @{
24511     */
24512    typedef enum _Elm_Flip_Mode
24513      {
24514         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24515         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24516         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24517         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24518         ELM_FLIP_CUBE_LEFT,
24519         ELM_FLIP_CUBE_RIGHT,
24520         ELM_FLIP_CUBE_UP,
24521         ELM_FLIP_CUBE_DOWN,
24522         ELM_FLIP_PAGE_LEFT,
24523         ELM_FLIP_PAGE_RIGHT,
24524         ELM_FLIP_PAGE_UP,
24525         ELM_FLIP_PAGE_DOWN
24526      } Elm_Flip_Mode;
24527    typedef enum _Elm_Flip_Interaction
24528      {
24529         ELM_FLIP_INTERACTION_NONE,
24530         ELM_FLIP_INTERACTION_ROTATE,
24531         ELM_FLIP_INTERACTION_CUBE,
24532         ELM_FLIP_INTERACTION_PAGE
24533      } Elm_Flip_Interaction;
24534    typedef enum _Elm_Flip_Direction
24535      {
24536         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24537         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24538         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24539         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24540      } Elm_Flip_Direction;
24541    /**
24542     * @brief Add a new flip to the parent
24543     *
24544     * @param parent The parent object
24545     * @return The new object or NULL if it cannot be created
24546     */
24547    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24548    /**
24549     * @brief Set the front content of the flip widget.
24550     *
24551     * @param obj The flip object
24552     * @param content The new front content object
24553     *
24554     * Once the content object is set, a previously set one will be deleted.
24555     * If you want to keep that old content object, use the
24556     * elm_flip_content_front_unset() function.
24557     */
24558    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24559    /**
24560     * @brief Set the back content of the flip widget.
24561     *
24562     * @param obj The flip object
24563     * @param content The new back content object
24564     *
24565     * Once the content object is set, a previously set one will be deleted.
24566     * If you want to keep that old content object, use the
24567     * elm_flip_content_back_unset() function.
24568     */
24569    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24570    /**
24571     * @brief Get the front content used for the flip
24572     *
24573     * @param obj The flip object
24574     * @return The front content object that is being used
24575     *
24576     * Return the front content object which is set for this widget.
24577     */
24578    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24579    /**
24580     * @brief Get the back content used for the flip
24581     *
24582     * @param obj The flip object
24583     * @return The back content object that is being used
24584     *
24585     * Return the back content object which is set for this widget.
24586     */
24587    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24588    /**
24589     * @brief Unset the front content used for the flip
24590     *
24591     * @param obj The flip object
24592     * @return The front content object that was being used
24593     *
24594     * Unparent and return the front content object which was set for this widget.
24595     */
24596    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24597    /**
24598     * @brief Unset the back content used for the flip
24599     *
24600     * @param obj The flip object
24601     * @return The back content object that was being used
24602     *
24603     * Unparent and return the back content object which was set for this widget.
24604     */
24605    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24606    /**
24607     * @brief Get flip front visibility state
24608     *
24609     * @param obj The flip objct
24610     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24611     * showing.
24612     */
24613    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24614    /**
24615     * @brief Set flip perspective
24616     *
24617     * @param obj The flip object
24618     * @param foc The coordinate to set the focus on
24619     * @param x The X coordinate
24620     * @param y The Y coordinate
24621     *
24622     * @warning This function currently does nothing.
24623     */
24624    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24625    /**
24626     * @brief Runs the flip animation
24627     *
24628     * @param obj The flip object
24629     * @param mode The mode type
24630     *
24631     * Flips the front and back contents using the @p mode animation. This
24632     * efectively hides the currently visible content and shows the hidden one.
24633     *
24634     * There a number of possible animations to use for the flipping:
24635     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24636     * around a horizontal axis in the middle of its height, the other content
24637     * is shown as the other side of the flip.
24638     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24639     * around a vertical axis in the middle of its width, the other content is
24640     * shown as the other side of the flip.
24641     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24642     * around a diagonal axis in the middle of its width, the other content is
24643     * shown as the other side of the flip.
24644     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24645     * around a diagonal axis in the middle of its height, the other content is
24646     * shown as the other side of the flip.
24647     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24648     * as if the flip was a cube, the other content is show as the right face of
24649     * the cube.
24650     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24651     * right as if the flip was a cube, the other content is show as the left
24652     * face of the cube.
24653     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24654     * flip was a cube, the other content is show as the bottom face of the cube.
24655     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24656     * the flip was a cube, the other content is show as the upper face of the
24657     * cube.
24658     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24659     * if the flip was a book, the other content is shown as the page below that.
24660     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24661     * as if the flip was a book, the other content is shown as the page below
24662     * that.
24663     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24664     * flip was a book, the other content is shown as the page below that.
24665     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24666     * flip was a book, the other content is shown as the page below that.
24667     *
24668     * @image html elm_flip.png
24669     * @image latex elm_flip.eps width=\textwidth
24670     */
24671    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24672    /**
24673     * @brief Set the interactive flip mode
24674     *
24675     * @param obj The flip object
24676     * @param mode The interactive flip mode to use
24677     *
24678     * This sets if the flip should be interactive (allow user to click and
24679     * drag a side of the flip to reveal the back page and cause it to flip).
24680     * By default a flip is not interactive. You may also need to set which
24681     * sides of the flip are "active" for flipping and how much space they use
24682     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24683     * and elm_flip_interacton_direction_hitsize_set()
24684     *
24685     * The four avilable mode of interaction are:
24686     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24687     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24688     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24689     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24690     *
24691     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24692     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24693     * happen, those can only be acheived with elm_flip_go();
24694     */
24695    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24696    /**
24697     * @brief Get the interactive flip mode
24698     *
24699     * @param obj The flip object
24700     * @return The interactive flip mode
24701     *
24702     * Returns the interactive flip mode set by elm_flip_interaction_set()
24703     */
24704    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24705    /**
24706     * @brief Set which directions of the flip respond to interactive flip
24707     *
24708     * @param obj The flip object
24709     * @param dir The direction to change
24710     * @param enabled If that direction is enabled or not
24711     *
24712     * By default all directions are disabled, so you may want to enable the
24713     * desired directions for flipping if you need interactive flipping. You must
24714     * call this function once for each direction that should be enabled.
24715     *
24716     * @see elm_flip_interaction_set()
24717     */
24718    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24719    /**
24720     * @brief Get the enabled state of that flip direction
24721     *
24722     * @param obj The flip object
24723     * @param dir The direction to check
24724     * @return If that direction is enabled or not
24725     *
24726     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24727     *
24728     * @see elm_flip_interaction_set()
24729     */
24730    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24731    /**
24732     * @brief Set the amount of the flip that is sensitive to interactive flip
24733     *
24734     * @param obj The flip object
24735     * @param dir The direction to modify
24736     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24737     *
24738     * Set the amount of the flip that is sensitive to interactive flip, with 0
24739     * representing no area in the flip and 1 representing the entire flip. There
24740     * is however a consideration to be made in that the area will never be
24741     * smaller than the finger size set(as set in your Elementary configuration).
24742     *
24743     * @see elm_flip_interaction_set()
24744     */
24745    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24746    /**
24747     * @brief Get the amount of the flip that is sensitive to interactive flip
24748     *
24749     * @param obj The flip object
24750     * @param dir The direction to check
24751     * @return The size set for that direction
24752     *
24753     * Returns the amount os sensitive area set by
24754     * elm_flip_interacton_direction_hitsize_set().
24755     */
24756    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24757    /**
24758     * @}
24759     */
24760
24761    /* scrolledentry */
24762    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24763    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24764    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24765    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24766    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24767    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24768    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24769    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24770    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24771    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24772    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24773    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24774    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24775    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24776    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24777    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24778    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24779    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24780    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24781    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24782    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24783    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24784    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24785    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24786    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24787    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24788    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24789    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24790    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24791    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24792    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24793    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24794    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24795    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24796    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24797    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);
24798    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24799    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24800    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);
24801    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24802    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);
24803    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24804    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24805    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24806    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24807    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24808    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24809    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24810    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24811    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);
24812    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);
24813    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);
24814    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);
24815    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);
24816    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);
24817    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24818    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24819    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24820    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24821    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24822    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24823    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24824    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24825    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24826    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24827    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24828    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24829    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24830
24831    /**
24832     * @defgroup Conformant Conformant
24833     * @ingroup Elementary
24834     *
24835     * @image html img/widget/conformant/preview-00.png
24836     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24837     *
24838     * @image html img/conformant.png
24839     * @image latex img/conformant.eps width=\textwidth
24840     *
24841     * The aim is to provide a widget that can be used in elementary apps to
24842     * account for space taken up by the indicator, virtual keypad & softkey
24843     * windows when running the illume2 module of E17.
24844     *
24845     * So conformant content will be sized and positioned considering the
24846     * space required for such stuff, and when they popup, as a keyboard
24847     * shows when an entry is selected, conformant content won't change.
24848     *
24849     * Available styles for it:
24850     * - @c "default"
24851     *
24852     * Default contents parts of the conformant widget that you can use for are:
24853     * @li "default" - A content of the conformant
24854     *
24855     * See how to use this widget in this example:
24856     * @ref conformant_example
24857     */
24858
24859    /**
24860     * @addtogroup Conformant
24861     * @{
24862     */
24863
24864    /**
24865     * Add a new conformant widget to the given parent Elementary
24866     * (container) object.
24867     *
24868     * @param parent The parent object.
24869     * @return A new conformant widget handle or @c NULL, on errors.
24870     *
24871     * This function inserts a new conformant widget on the canvas.
24872     *
24873     * @ingroup Conformant
24874     */
24875    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24876
24877    /**
24878     * Set the content of the conformant widget.
24879     *
24880     * @param obj The conformant object.
24881     * @param content The content to be displayed by the conformant.
24882     *
24883     * Content will be sized and positioned considering the space required
24884     * to display a virtual keyboard. So it won't fill all the conformant
24885     * size. This way is possible to be sure that content won't resize
24886     * or be re-positioned after the keyboard is displayed.
24887     *
24888     * Once the content object is set, a previously set one will be deleted.
24889     * If you want to keep that old content object, use the
24890     * elm_object_content_unset() function.
24891     *
24892     * @see elm_object_content_unset()
24893     * @see elm_object_content_get()
24894     *
24895     * @deprecated use elm_object_content_set() instead
24896     *
24897     * @ingroup Conformant
24898     */
24899    WILL_DEPRECATE  EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24900
24901    /**
24902     * Get the content of the conformant widget.
24903     *
24904     * @param obj The conformant object.
24905     * @return The content that is being used.
24906     *
24907     * Return the content object which is set for this widget.
24908     * It won't be unparent from conformant. For that, use
24909     * elm_object_content_unset().
24910     *
24911     * @see elm_object_content_set().
24912     * @see elm_object_content_unset()
24913     *
24914     * @deprecated use elm_object_content_get() instead
24915     *
24916     * @ingroup Conformant
24917     */
24918    WILL_DEPRECATE  EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24919
24920    /**
24921     * Unset the content of the conformant widget.
24922     *
24923     * @param obj The conformant object.
24924     * @return The content that was being used.
24925     *
24926     * Unparent and return the content object which was set for this widget.
24927     *
24928     * @see elm_object_content_set().
24929     *
24930     * @deprecated use elm_object_content_unset() instead
24931     *
24932     * @ingroup Conformant
24933     */
24934    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24935
24936    /**
24937     * Returns the Evas_Object that represents the content area.
24938     *
24939     * @param obj The conformant object.
24940     * @return The content area of the widget.
24941     *
24942     * @ingroup Conformant
24943     */
24944    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24945
24946    /**
24947     * @}
24948     */
24949
24950    /**
24951     * @defgroup Mapbuf Mapbuf
24952     * @ingroup Elementary
24953     *
24954     * @image html img/widget/mapbuf/preview-00.png
24955     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24956     *
24957     * This holds one content object and uses an Evas Map of transformation
24958     * points to be later used with this content. So the content will be
24959     * moved, resized, etc as a single image. So it will improve performance
24960     * when you have a complex interafce, with a lot of elements, and will
24961     * need to resize or move it frequently (the content object and its
24962     * children).
24963     *
24964     * Default contents parts of the mapbuf widget that you can use for are:
24965     * @li "default" - A content of the mapbuf
24966     *
24967     * To enable map, elm_mapbuf_enabled_set() should be used.
24968     * 
24969     * See how to use this widget in this example:
24970     * @ref mapbuf_example
24971     */
24972
24973    /**
24974     * @addtogroup Mapbuf
24975     * @{
24976     */
24977
24978    /**
24979     * Add a new mapbuf widget to the given parent Elementary
24980     * (container) object.
24981     *
24982     * @param parent The parent object.
24983     * @return A new mapbuf widget handle or @c NULL, on errors.
24984     *
24985     * This function inserts a new mapbuf widget on the canvas.
24986     *
24987     * @ingroup Mapbuf
24988     */
24989    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24990
24991    /**
24992     * Set the content of the mapbuf.
24993     *
24994     * @param obj The mapbuf object.
24995     * @param content The content that will be filled in this mapbuf object.
24996     *
24997     * Once the content object is set, a previously set one will be deleted.
24998     * If you want to keep that old content object, use the
24999     * elm_mapbuf_content_unset() function.
25000     *
25001     * To enable map, elm_mapbuf_enabled_set() should be used.
25002     *
25003     * @deprecated use elm_object_content_set() instead
25004     *
25005     * @ingroup Mapbuf
25006     */
25007    WILL_DEPRECATE  EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25008
25009    /**
25010     * Get the content of the mapbuf.
25011     *
25012     * @param obj The mapbuf object.
25013     * @return The content that is being used.
25014     *
25015     * Return the content object which is set for this widget.
25016     *
25017     * @see elm_mapbuf_content_set() for details.
25018     *
25019     * @deprecated use elm_object_content_get() instead
25020     *
25021     * @ingroup Mapbuf
25022     */
25023    WILL_DEPRECATE  EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25024
25025    /**
25026     * Unset the content of the mapbuf.
25027     *
25028     * @param obj The mapbuf object.
25029     * @return The content that was being used.
25030     *
25031     * Unparent and return the content object which was set for this widget.
25032     *
25033     * @see elm_mapbuf_content_set() for details.
25034     *
25035     * @deprecated use elm_object_content_unset() instead
25036     *
25037     * @ingroup Mapbuf
25038     */
25039    WILL_DEPRECATE  EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25040
25041    /**
25042     * Enable or disable the map.
25043     *
25044     * @param obj The mapbuf object.
25045     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25046     *
25047     * This enables the map that is set or disables it. On enable, the object
25048     * geometry will be saved, and the new geometry will change (position and
25049     * size) to reflect the map geometry set.
25050     *
25051     * Also, when enabled, alpha and smooth states will be used, so if the
25052     * content isn't solid, alpha should be enabled, for example, otherwise
25053     * a black retangle will fill the content.
25054     *
25055     * When disabled, the stored map will be freed and geometry prior to
25056     * enabling the map will be restored.
25057     *
25058     * It's disabled by default.
25059     *
25060     * @see elm_mapbuf_alpha_set()
25061     * @see elm_mapbuf_smooth_set()
25062     *
25063     * @ingroup Mapbuf
25064     */
25065    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25066
25067    /**
25068     * Get a value whether map is enabled or not.
25069     *
25070     * @param obj The mapbuf object.
25071     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25072     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25073     *
25074     * @see elm_mapbuf_enabled_set() for details.
25075     *
25076     * @ingroup Mapbuf
25077     */
25078    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25079
25080    /**
25081     * Enable or disable smooth map rendering.
25082     *
25083     * @param obj The mapbuf object.
25084     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25085     * to disable it.
25086     *
25087     * This sets smoothing for map rendering. If the object is a type that has
25088     * its own smoothing settings, then both the smooth settings for this object
25089     * and the map must be turned off.
25090     *
25091     * By default smooth maps are enabled.
25092     *
25093     * @ingroup Mapbuf
25094     */
25095    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25096
25097    /**
25098     * Get a value whether smooth map rendering is enabled or not.
25099     *
25100     * @param obj The mapbuf object.
25101     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25102     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25103     *
25104     * @see elm_mapbuf_smooth_set() for details.
25105     *
25106     * @ingroup Mapbuf
25107     */
25108    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25109
25110    /**
25111     * Set or unset alpha flag for map rendering.
25112     *
25113     * @param obj The mapbuf object.
25114     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25115     * to disable it.
25116     *
25117     * This sets alpha flag for map rendering. If the object is a type that has
25118     * its own alpha settings, then this will take precedence. Only image objects
25119     * have this currently. It stops alpha blending of the map area, and is
25120     * useful if you know the object and/or all sub-objects is 100% solid.
25121     *
25122     * Alpha is enabled by default.
25123     *
25124     * @ingroup Mapbuf
25125     */
25126    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25127
25128    /**
25129     * Get a value whether alpha blending is enabled or not.
25130     *
25131     * @param obj The mapbuf object.
25132     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25133     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25134     *
25135     * @see elm_mapbuf_alpha_set() for details.
25136     *
25137     * @ingroup Mapbuf
25138     */
25139    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25140
25141    /**
25142     * @}
25143     */
25144
25145    /**
25146     * @defgroup Flipselector Flip Selector
25147     *
25148     * @image html img/widget/flipselector/preview-00.png
25149     * @image latex img/widget/flipselector/preview-00.eps
25150     *
25151     * A flip selector is a widget to show a set of @b text items, one
25152     * at a time, with the same sheet switching style as the @ref Clock
25153     * "clock" widget, when one changes the current displaying sheet
25154     * (thus, the "flip" in the name).
25155     *
25156     * User clicks to flip sheets which are @b held for some time will
25157     * make the flip selector to flip continuosly and automatically for
25158     * the user. The interval between flips will keep growing in time,
25159     * so that it helps the user to reach an item which is distant from
25160     * the current selection.
25161     *
25162     * Smart callbacks one can register to:
25163     * - @c "selected" - when the widget's selected text item is changed
25164     * - @c "overflowed" - when the widget's current selection is changed
25165     *   from the first item in its list to the last
25166     * - @c "underflowed" - when the widget's current selection is changed
25167     *   from the last item in its list to the first
25168     *
25169     * Available styles for it:
25170     * - @c "default"
25171     *
25172          * To set/get the label of the flipselector item, you can use
25173          * elm_object_item_text_set/get APIs.
25174          * Once the text is set, a previously set one will be deleted.
25175          * 
25176     * Here is an example on its usage:
25177     * @li @ref flipselector_example
25178     */
25179
25180    /**
25181     * @addtogroup Flipselector
25182     * @{
25183     */
25184
25185    /**
25186     * Add a new flip selector widget to the given parent Elementary
25187     * (container) widget
25188     *
25189     * @param parent The parent object
25190     * @return a new flip selector widget handle or @c NULL, on errors
25191     *
25192     * This function inserts a new flip selector widget on the canvas.
25193     *
25194     * @ingroup Flipselector
25195     */
25196    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25197
25198    /**
25199     * Programmatically select the next item of a flip selector widget
25200     *
25201     * @param obj The flipselector object
25202     *
25203     * @note The selection will be animated. Also, if it reaches the
25204     * end of its list of member items, it will continue with the first
25205     * one onwards.
25206     *
25207     * @ingroup Flipselector
25208     */
25209    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25210
25211    /**
25212     * Programmatically select the previous item of a flip selector
25213     * widget
25214     *
25215     * @param obj The flipselector object
25216     *
25217     * @note The selection will be animated.  Also, if it reaches the
25218     * beginning of its list of member items, it will continue with the
25219     * last one backwards.
25220     *
25221     * @ingroup Flipselector
25222     */
25223    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25224
25225    /**
25226     * Append a (text) item to a flip selector widget
25227     *
25228     * @param obj The flipselector object
25229     * @param label The (text) label of the new item
25230     * @param func Convenience callback function to take place when
25231     * item is selected
25232     * @param data Data passed to @p func, above
25233     * @return A handle to the item added or @c NULL, on errors
25234     *
25235     * The widget's list of labels to show will be appended with the
25236     * given value. If the user wishes so, a callback function pointer
25237     * can be passed, which will get called when this same item is
25238     * selected.
25239     *
25240     * @note The current selection @b won't be modified by appending an
25241     * element to the list.
25242     *
25243     * @note The maximum length of the text label is going to be
25244     * determined <b>by the widget's theme</b>. Strings larger than
25245     * that value are going to be @b truncated.
25246     *
25247     * @ingroup Flipselector
25248     */
25249    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25250
25251    /**
25252     * Prepend a (text) item to a flip selector widget
25253     *
25254     * @param obj The flipselector object
25255     * @param label The (text) label of the new item
25256     * @param func Convenience callback function to take place when
25257     * item is selected
25258     * @param data Data passed to @p func, above
25259     * @return A handle to the item added or @c NULL, on errors
25260     *
25261     * The widget's list of labels to show will be prepended with the
25262     * given value. If the user wishes so, a callback function pointer
25263     * can be passed, which will get called when this same item is
25264     * selected.
25265     *
25266     * @note The current selection @b won't be modified by prepending
25267     * an element to the list.
25268     *
25269     * @note The maximum length of the text label is going to be
25270     * determined <b>by the widget's theme</b>. Strings larger than
25271     * that value are going to be @b truncated.
25272     *
25273     * @ingroup Flipselector
25274     */
25275    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25276
25277    /**
25278     * Get the internal list of items in a given flip selector widget.
25279     *
25280     * @param obj The flipselector object
25281     * @return The list of items (#Elm_Object_Item as data) or
25282     * @c NULL on errors.
25283     *
25284     * This list is @b not to be modified in any way and must not be
25285     * freed. Use the list members with functions like
25286     * elm_object_item_text_set(),
25287     * elm_object_item_text_get(),
25288     * elm_flipselector_item_del(),
25289     * elm_flipselector_item_selected_get(),
25290     * elm_flipselector_item_selected_set().
25291     *
25292     * @warning This list is only valid until @p obj object's internal
25293     * items list is changed. It should be fetched again with another
25294     * call to this function when changes happen.
25295     *
25296     * @ingroup Flipselector
25297     */
25298    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25299
25300    /**
25301     * Get the first item in the given flip selector widget's list of
25302     * items.
25303     *
25304     * @param obj The flipselector object
25305     * @return The first item or @c NULL, if it has no items (and on
25306     * errors)
25307     *
25308     * @see elm_flipselector_item_append()
25309     * @see elm_flipselector_last_item_get()
25310     *
25311     * @ingroup Flipselector
25312     */
25313    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25314
25315    /**
25316     * Get the last item in the given flip selector widget's list of
25317     * items.
25318     *
25319     * @param obj The flipselector object
25320     * @return The last item or @c NULL, if it has no items (and on
25321     * errors)
25322     *
25323     * @see elm_flipselector_item_prepend()
25324     * @see elm_flipselector_first_item_get()
25325     *
25326     * @ingroup Flipselector
25327     */
25328    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25329
25330    /**
25331     * Get the currently selected item in a flip selector widget.
25332     *
25333     * @param obj The flipselector object
25334     * @return The selected item or @c NULL, if the widget has no items
25335     * (and on erros)
25336     *
25337     * @ingroup Flipselector
25338     */
25339    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25340
25341    /**
25342     * Set whether a given flip selector widget's item should be the
25343     * currently selected one.
25344     *
25345     * @param it The flip selector item
25346     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25347     *
25348     * This sets whether @p item is or not the selected (thus, under
25349     * display) one. If @p item is different than one under display,
25350     * the latter will be unselected. If the @p item is set to be
25351     * unselected, on the other hand, the @b first item in the widget's
25352     * internal members list will be the new selected one.
25353     *
25354     * @see elm_flipselector_item_selected_get()
25355     *
25356     * @ingroup Flipselector
25357     */
25358    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25359
25360    /**
25361     * Get whether a given flip selector widget's item is the currently
25362     * selected one.
25363     *
25364     * @param it The flip selector item
25365     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25366     * (or on errors).
25367     *
25368     * @see elm_flipselector_item_selected_set()
25369     *
25370     * @ingroup Flipselector
25371     */
25372    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25373
25374    /**
25375     * Delete a given item from a flip selector widget.
25376     *
25377     * @param it The item to delete
25378     *
25379     * @ingroup Flipselector
25380     */
25381    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25382
25383    /**
25384     * Get the label of a given flip selector widget's item.
25385     *
25386     * @param it The item to get label from
25387     * @return The text label of @p item or @c NULL, on errors
25388     *
25389     * @see elm_object_item_text_set()
25390     *
25391     * @deprecated see elm_object_item_text_get() instead
25392     * @ingroup Flipselector
25393     */
25394    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25395
25396    /**
25397     * Set the label of a given flip selector widget's item.
25398     *
25399     * @param it The item to set label on
25400     * @param label The text label string, in UTF-8 encoding
25401     *
25402     * @see elm_object_item_text_get()
25403     *
25404          * @deprecated see elm_object_item_text_set() instead
25405     * @ingroup Flipselector
25406     */
25407    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25408
25409    /**
25410     * Gets the item before @p item in a flip selector widget's
25411     * internal list of items.
25412     *
25413     * @param it The item to fetch previous from
25414     * @return The item before the @p item, in its parent's list. If
25415     *         there is no previous item for @p item or there's an
25416     *         error, @c NULL is returned.
25417     *
25418     * @see elm_flipselector_item_next_get()
25419     *
25420     * @ingroup Flipselector
25421     */
25422    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25423
25424    /**
25425     * Gets the item after @p item in a flip selector widget's
25426     * internal list of items.
25427     *
25428     * @param it The item to fetch next from
25429     * @return The item after the @p item, in its parent's list. If
25430     *         there is no next item for @p item or there's an
25431     *         error, @c NULL is returned.
25432     *
25433     * @see elm_flipselector_item_next_get()
25434     *
25435     * @ingroup Flipselector
25436     */
25437    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25438
25439    /**
25440     * Set the interval on time updates for an user mouse button hold
25441     * on a flip selector widget.
25442     *
25443     * @param obj The flip selector object
25444     * @param interval The (first) interval value in seconds
25445     *
25446     * This interval value is @b decreased while the user holds the
25447     * mouse pointer either flipping up or flipping doww a given flip
25448     * selector.
25449     *
25450     * This helps the user to get to a given item distant from the
25451     * current one easier/faster, as it will start to flip quicker and
25452     * quicker on mouse button holds.
25453     *
25454     * The calculation for the next flip interval value, starting from
25455     * the one set with this call, is the previous interval divided by
25456     * 1.05, so it decreases a little bit.
25457     *
25458     * The default starting interval value for automatic flips is
25459     * @b 0.85 seconds.
25460     *
25461     * @see elm_flipselector_interval_get()
25462     *
25463     * @ingroup Flipselector
25464     */
25465    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25466
25467    /**
25468     * Get the interval on time updates for an user mouse button hold
25469     * on a flip selector widget.
25470     *
25471     * @param obj The flip selector object
25472     * @return The (first) interval value, in seconds, set on it
25473     *
25474     * @see elm_flipselector_interval_set() for more details
25475     *
25476     * @ingroup Flipselector
25477     */
25478    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25479    /**
25480     * @}
25481     */
25482
25483    /**
25484     * @addtogroup Calendar
25485     * @{
25486     */
25487
25488    /**
25489     * @enum _Elm_Calendar_Mark_Repeat
25490     * @typedef Elm_Calendar_Mark_Repeat
25491     *
25492     * Event periodicity, used to define if a mark should be repeated
25493     * @b beyond event's day. It's set when a mark is added.
25494     *
25495     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25496     * there will be marks every week after this date. Marks will be displayed
25497     * at 13th, 20th, 27th, 3rd June ...
25498     *
25499     * Values don't work as bitmask, only one can be choosen.
25500     *
25501     * @see elm_calendar_mark_add()
25502     *
25503     * @ingroup Calendar
25504     */
25505    typedef enum _Elm_Calendar_Mark_Repeat
25506      {
25507         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25508         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25509         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25510         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*/
25511         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. */
25512      } Elm_Calendar_Mark_Repeat;
25513
25514    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(). */
25515
25516    /**
25517     * Add a new calendar widget to the given parent Elementary
25518     * (container) object.
25519     *
25520     * @param parent The parent object.
25521     * @return a new calendar widget handle or @c NULL, on errors.
25522     *
25523     * This function inserts a new calendar widget on the canvas.
25524     *
25525     * @ref calendar_example_01
25526     *
25527     * @ingroup Calendar
25528     */
25529    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25530
25531    /**
25532     * Get weekdays names displayed by the calendar.
25533     *
25534     * @param obj The calendar object.
25535     * @return Array of seven strings to be used as weekday names.
25536     *
25537     * By default, weekdays abbreviations get from system are displayed:
25538     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25539     * The first string is related to Sunday, the second to Monday...
25540     *
25541     * @see elm_calendar_weekdays_name_set()
25542     *
25543     * @ref calendar_example_05
25544     *
25545     * @ingroup Calendar
25546     */
25547    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25548
25549    /**
25550     * Set weekdays names to be displayed by the calendar.
25551     *
25552     * @param obj The calendar object.
25553     * @param weekdays Array of seven strings to be used as weekday names.
25554     * @warning It must have 7 elements, or it will access invalid memory.
25555     * @warning The strings must be NULL terminated ('@\0').
25556     *
25557     * By default, weekdays abbreviations get from system are displayed:
25558     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25559     *
25560     * The first string should be related to Sunday, the second to Monday...
25561     *
25562     * The usage should be like this:
25563     * @code
25564     *   const char *weekdays[] =
25565     *   {
25566     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25567     *      "Thursday", "Friday", "Saturday"
25568     *   };
25569     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25570     * @endcode
25571     *
25572     * @see elm_calendar_weekdays_name_get()
25573     *
25574     * @ref calendar_example_02
25575     *
25576     * @ingroup Calendar
25577     */
25578    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25579
25580    /**
25581     * Set the minimum and maximum values for the year
25582     *
25583     * @param obj The calendar object
25584     * @param min The minimum year, greater than 1901;
25585     * @param max The maximum year;
25586     *
25587     * Maximum must be greater than minimum, except if you don't wan't to set
25588     * maximum year.
25589     * Default values are 1902 and -1.
25590     *
25591     * If the maximum year is a negative value, it will be limited depending
25592     * on the platform architecture (year 2037 for 32 bits);
25593     *
25594     * @see elm_calendar_min_max_year_get()
25595     *
25596     * @ref calendar_example_03
25597     *
25598     * @ingroup Calendar
25599     */
25600    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25601
25602    /**
25603     * Get the minimum and maximum values for the year
25604     *
25605     * @param obj The calendar object.
25606     * @param min The minimum year.
25607     * @param max The maximum year.
25608     *
25609     * Default values are 1902 and -1.
25610     *
25611     * @see elm_calendar_min_max_year_get() for more details.
25612     *
25613     * @ref calendar_example_05
25614     *
25615     * @ingroup Calendar
25616     */
25617    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25618
25619    /**
25620     * Enable or disable day selection
25621     *
25622     * @param obj The calendar object.
25623     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25624     * disable it.
25625     *
25626     * Enabled by default. If disabled, the user still can select months,
25627     * but not days. Selected days are highlighted on calendar.
25628     * It should be used if you won't need such selection for the widget usage.
25629     *
25630     * When a day is selected, or month is changed, smart callbacks for
25631     * signal "changed" will be called.
25632     *
25633     * @see elm_calendar_day_selection_enable_get()
25634     *
25635     * @ref calendar_example_04
25636     *
25637     * @ingroup Calendar
25638     */
25639    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25640
25641    /**
25642     * Get a value whether day selection is enabled or not.
25643     *
25644     * @see elm_calendar_day_selection_enable_set() for details.
25645     *
25646     * @param obj The calendar object.
25647     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25648     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25649     *
25650     * @ref calendar_example_05
25651     *
25652     * @ingroup Calendar
25653     */
25654    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25655
25656
25657    /**
25658     * Set selected date to be highlighted on calendar.
25659     *
25660     * @param obj The calendar object.
25661     * @param selected_time A @b tm struct to represent the selected date.
25662     *
25663     * Set the selected date, changing the displayed month if needed.
25664     * Selected date changes when the user goes to next/previous month or
25665     * select a day pressing over it on calendar.
25666     *
25667     * @see elm_calendar_selected_time_get()
25668     *
25669     * @ref calendar_example_04
25670     *
25671     * @ingroup Calendar
25672     */
25673    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25674
25675    /**
25676     * Get selected date.
25677     *
25678     * @param obj The calendar object
25679     * @param selected_time A @b tm struct to point to selected date
25680     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25681     * be considered.
25682     *
25683     * Get date selected by the user or set by function
25684     * elm_calendar_selected_time_set().
25685     * Selected date changes when the user goes to next/previous month or
25686     * select a day pressing over it on calendar.
25687     *
25688     * @see elm_calendar_selected_time_get()
25689     *
25690     * @ref calendar_example_05
25691     *
25692     * @ingroup Calendar
25693     */
25694    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25695
25696    /**
25697     * Set a function to format the string that will be used to display
25698     * month and year;
25699     *
25700     * @param obj The calendar object
25701     * @param format_function Function to set the month-year string given
25702     * the selected date
25703     *
25704     * By default it uses strftime with "%B %Y" format string.
25705     * It should allocate the memory that will be used by the string,
25706     * that will be freed by the widget after usage.
25707     * A pointer to the string and a pointer to the time struct will be provided.
25708     *
25709     * Example:
25710     * @code
25711     * static char *
25712     * _format_month_year(struct tm *selected_time)
25713     * {
25714     *    char buf[32];
25715     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25716     *    return strdup(buf);
25717     * }
25718     *
25719     * elm_calendar_format_function_set(calendar, _format_month_year);
25720     * @endcode
25721     *
25722     * @ref calendar_example_02
25723     *
25724     * @ingroup Calendar
25725     */
25726    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25727
25728    /**
25729     * Add a new mark to the calendar
25730     *
25731     * @param obj The calendar object
25732     * @param mark_type A string used to define the type of mark. It will be
25733     * emitted to the theme, that should display a related modification on these
25734     * days representation.
25735     * @param mark_time A time struct to represent the date of inclusion of the
25736     * mark. For marks that repeats it will just be displayed after the inclusion
25737     * date in the calendar.
25738     * @param repeat Repeat the event following this periodicity. Can be a unique
25739     * mark (that don't repeat), daily, weekly, monthly or annually.
25740     * @return The created mark or @p NULL upon failure.
25741     *
25742     * Add a mark that will be drawn in the calendar respecting the insertion
25743     * time and periodicity. It will emit the type as signal to the widget theme.
25744     * Default theme supports "holiday" and "checked", but it can be extended.
25745     *
25746     * It won't immediately update the calendar, drawing the marks.
25747     * For this, call elm_calendar_marks_draw(). However, when user selects
25748     * next or previous month calendar forces marks drawn.
25749     *
25750     * Marks created with this method can be deleted with
25751     * elm_calendar_mark_del().
25752     *
25753     * Example
25754     * @code
25755     * struct tm selected_time;
25756     * time_t current_time;
25757     *
25758     * current_time = time(NULL) + 5 * 84600;
25759     * localtime_r(&current_time, &selected_time);
25760     * elm_calendar_mark_add(cal, "holiday", selected_time,
25761     *     ELM_CALENDAR_ANNUALLY);
25762     *
25763     * current_time = time(NULL) + 1 * 84600;
25764     * localtime_r(&current_time, &selected_time);
25765     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25766     *
25767     * elm_calendar_marks_draw(cal);
25768     * @endcode
25769     *
25770     * @see elm_calendar_marks_draw()
25771     * @see elm_calendar_mark_del()
25772     *
25773     * @ref calendar_example_06
25774     *
25775     * @ingroup Calendar
25776     */
25777    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);
25778
25779    /**
25780     * Delete mark from the calendar.
25781     *
25782     * @param mark The mark to be deleted.
25783     *
25784     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25785     * should be used instead of getting marks list and deleting each one.
25786     *
25787     * @see elm_calendar_mark_add()
25788     *
25789     * @ref calendar_example_06
25790     *
25791     * @ingroup Calendar
25792     */
25793    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25794
25795    /**
25796     * Remove all calendar's marks
25797     *
25798     * @param obj The calendar object.
25799     *
25800     * @see elm_calendar_mark_add()
25801     * @see elm_calendar_mark_del()
25802     *
25803     * @ingroup Calendar
25804     */
25805    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25806
25807
25808    /**
25809     * Get a list of all the calendar marks.
25810     *
25811     * @param obj The calendar object.
25812     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25813     *
25814     * @see elm_calendar_mark_add()
25815     * @see elm_calendar_mark_del()
25816     * @see elm_calendar_marks_clear()
25817     *
25818     * @ingroup Calendar
25819     */
25820    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25821
25822    /**
25823     * Draw calendar marks.
25824     *
25825     * @param obj The calendar object.
25826     *
25827     * Should be used after adding, removing or clearing marks.
25828     * It will go through the entire marks list updating the calendar.
25829     * If lots of marks will be added, add all the marks and then call
25830     * this function.
25831     *
25832     * When the month is changed, i.e. user selects next or previous month,
25833     * marks will be drawed.
25834     *
25835     * @see elm_calendar_mark_add()
25836     * @see elm_calendar_mark_del()
25837     * @see elm_calendar_marks_clear()
25838     *
25839     * @ref calendar_example_06
25840     *
25841     * @ingroup Calendar
25842     */
25843    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25844
25845    /**
25846     * Set a day text color to the same that represents Saturdays.
25847     *
25848     * @param obj The calendar object.
25849     * @param pos The text position. Position is the cell counter, from left
25850     * to right, up to down. It starts on 0 and ends on 41.
25851     *
25852     * @deprecated use elm_calendar_mark_add() instead like:
25853     *
25854     * @code
25855     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25856     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25857     * @endcode
25858     *
25859     * @see elm_calendar_mark_add()
25860     *
25861     * @ingroup Calendar
25862     */
25863    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25864
25865    /**
25866     * Set a day text color to the same that represents Sundays.
25867     *
25868     * @param obj The calendar object.
25869     * @param pos The text position. Position is the cell counter, from left
25870     * to right, up to down. It starts on 0 and ends on 41.
25871
25872     * @deprecated use elm_calendar_mark_add() instead like:
25873     *
25874     * @code
25875     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25876     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25877     * @endcode
25878     *
25879     * @see elm_calendar_mark_add()
25880     *
25881     * @ingroup Calendar
25882     */
25883    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25884
25885    /**
25886     * Set a day text color to the same that represents Weekdays.
25887     *
25888     * @param obj The calendar object
25889     * @param pos The text position. Position is the cell counter, from left
25890     * to right, up to down. It starts on 0 and ends on 41.
25891     *
25892     * @deprecated use elm_calendar_mark_add() instead like:
25893     *
25894     * @code
25895     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25896     *
25897     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25898     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25899     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25900     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25901     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25902     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25903     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25904     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25905     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25906     * @endcode
25907     *
25908     * @see elm_calendar_mark_add()
25909     *
25910     * @ingroup Calendar
25911     */
25912    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25913
25914    /**
25915     * Set the interval on time updates for an user mouse button hold
25916     * on calendar widgets' month selection.
25917     *
25918     * @param obj The calendar object
25919     * @param interval The (first) interval value in seconds
25920     *
25921     * This interval value is @b decreased while the user holds the
25922     * mouse pointer either selecting next or previous month.
25923     *
25924     * This helps the user to get to a given month distant from the
25925     * current one easier/faster, as it will start to change quicker and
25926     * quicker on mouse button holds.
25927     *
25928     * The calculation for the next change interval value, starting from
25929     * the one set with this call, is the previous interval divided by
25930     * 1.05, so it decreases a little bit.
25931     *
25932     * The default starting interval value for automatic changes is
25933     * @b 0.85 seconds.
25934     *
25935     * @see elm_calendar_interval_get()
25936     *
25937     * @ingroup Calendar
25938     */
25939    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25940
25941    /**
25942     * Get the interval on time updates for an user mouse button hold
25943     * on calendar widgets' month selection.
25944     *
25945     * @param obj The calendar object
25946     * @return The (first) interval value, in seconds, set on it
25947     *
25948     * @see elm_calendar_interval_set() for more details
25949     *
25950     * @ingroup Calendar
25951     */
25952    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25953
25954    /**
25955     * @}
25956     */
25957
25958    /**
25959     * @defgroup Diskselector Diskselector
25960     * @ingroup Elementary
25961     *
25962     * @image html img/widget/diskselector/preview-00.png
25963     * @image latex img/widget/diskselector/preview-00.eps
25964     *
25965     * A diskselector is a kind of list widget. It scrolls horizontally,
25966     * and can contain label and icon objects. Three items are displayed
25967     * with the selected one in the middle.
25968     *
25969     * It can act like a circular list with round mode and labels can be
25970     * reduced for a defined length for side items.
25971     *
25972     * Smart callbacks one can listen to:
25973     * - "selected" - when item is selected, i.e. scroller stops.
25974     *
25975     * Available styles for it:
25976     * - @c "default"
25977     *
25978     * List of examples:
25979     * @li @ref diskselector_example_01
25980     * @li @ref diskselector_example_02
25981     */
25982
25983    /**
25984     * @addtogroup Diskselector
25985     * @{
25986     */
25987
25988    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(). */
25989
25990    /**
25991     * Add a new diskselector widget to the given parent Elementary
25992     * (container) object.
25993     *
25994     * @param parent The parent object.
25995     * @return a new diskselector widget handle or @c NULL, on errors.
25996     *
25997     * This function inserts a new diskselector widget on the canvas.
25998     *
25999     * @ingroup Diskselector
26000     */
26001    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26002
26003    /**
26004     * Enable or disable round mode.
26005     *
26006     * @param obj The diskselector object.
26007     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
26008     * disable it.
26009     *
26010     * Disabled by default. If round mode is enabled the items list will
26011     * work like a circle list, so when the user reaches the last item,
26012     * the first one will popup.
26013     *
26014     * @see elm_diskselector_round_get()
26015     *
26016     * @ingroup Diskselector
26017     */
26018    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
26019
26020    /**
26021     * Get a value whether round mode is enabled or not.
26022     *
26023     * @see elm_diskselector_round_set() for details.
26024     *
26025     * @param obj The diskselector object.
26026     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
26027     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26028     *
26029     * @ingroup Diskselector
26030     */
26031    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26032
26033    /**
26034     * Get the side labels max length.
26035     *
26036     * @deprecated use elm_diskselector_side_label_length_get() instead:
26037     *
26038     * @param obj The diskselector object.
26039     * @return The max length defined for side labels, or 0 if not a valid
26040     * diskselector.
26041     *
26042     * @ingroup Diskselector
26043     */
26044    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26045
26046    /**
26047     * Set the side labels max length.
26048     *
26049     * @deprecated use elm_diskselector_side_label_length_set() instead:
26050     *
26051     * @param obj The diskselector object.
26052     * @param len The max length defined for side labels.
26053     *
26054     * @ingroup Diskselector
26055     */
26056    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26057
26058    /**
26059     * Get the side labels max length.
26060     *
26061     * @see elm_diskselector_side_label_length_set() for details.
26062     *
26063     * @param obj The diskselector object.
26064     * @return The max length defined for side labels, or 0 if not a valid
26065     * diskselector.
26066     *
26067     * @ingroup Diskselector
26068     */
26069    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26070
26071    /**
26072     * Set the side labels max length.
26073     *
26074     * @param obj The diskselector object.
26075     * @param len The max length defined for side labels.
26076     *
26077     * Length is the number of characters of items' label that will be
26078     * visible when it's set on side positions. It will just crop
26079     * the string after defined size. E.g.:
26080     *
26081     * An item with label "January" would be displayed on side position as
26082     * "Jan" if max length is set to 3, or "Janu", if this property
26083     * is set to 4.
26084     *
26085     * When it's selected, the entire label will be displayed, except for
26086     * width restrictions. In this case label will be cropped and "..."
26087     * will be concatenated.
26088     *
26089     * Default side label max length is 3.
26090     *
26091     * This property will be applyed over all items, included before or
26092     * later this function call.
26093     *
26094     * @ingroup Diskselector
26095     */
26096    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26097
26098    /**
26099     * Set the number of items to be displayed.
26100     *
26101     * @param obj The diskselector object.
26102     * @param num The number of items the diskselector will display.
26103     *
26104     * Default value is 3, and also it's the minimun. If @p num is less
26105     * than 3, it will be set to 3.
26106     *
26107     * Also, it can be set on theme, using data item @c display_item_num
26108     * on group "elm/diskselector/item/X", where X is style set.
26109     * E.g.:
26110     *
26111     * group { name: "elm/diskselector/item/X";
26112     * data {
26113     *     item: "display_item_num" "5";
26114     *     }
26115     *
26116     * @ingroup Diskselector
26117     */
26118    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26119
26120    /**
26121     * Get the number of items in the diskselector object.
26122     *
26123     * @param obj The diskselector object.
26124     *
26125     * @ingroup Diskselector
26126     */
26127    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26128
26129    /**
26130     * Set bouncing behaviour when the scrolled content reaches an edge.
26131     *
26132     * Tell the internal scroller object whether it should bounce or not
26133     * when it reaches the respective edges for each axis.
26134     *
26135     * @param obj The diskselector object.
26136     * @param h_bounce Whether to bounce or not in the horizontal axis.
26137     * @param v_bounce Whether to bounce or not in the vertical axis.
26138     *
26139     * @see elm_scroller_bounce_set()
26140     *
26141     * @ingroup Diskselector
26142     */
26143    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26144
26145    /**
26146     * Get the bouncing behaviour of the internal scroller.
26147     *
26148     * Get whether the internal scroller should bounce when the edge of each
26149     * axis is reached scrolling.
26150     *
26151     * @param obj The diskselector object.
26152     * @param h_bounce Pointer where to store the bounce state of the horizontal
26153     * axis.
26154     * @param v_bounce Pointer where to store the bounce state of the vertical
26155     * axis.
26156     *
26157     * @see elm_scroller_bounce_get()
26158     * @see elm_diskselector_bounce_set()
26159     *
26160     * @ingroup Diskselector
26161     */
26162    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26163
26164    /**
26165     * Get the scrollbar policy.
26166     *
26167     * @see elm_diskselector_scroller_policy_get() for details.
26168     *
26169     * @param obj The diskselector object.
26170     * @param policy_h Pointer where to store horizontal scrollbar policy.
26171     * @param policy_v Pointer where to store vertical scrollbar policy.
26172     *
26173     * @ingroup Diskselector
26174     */
26175    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);
26176
26177    /**
26178     * Set the scrollbar policy.
26179     *
26180     * @param obj The diskselector object.
26181     * @param policy_h Horizontal scrollbar policy.
26182     * @param policy_v Vertical scrollbar policy.
26183     *
26184     * This sets the scrollbar visibility policy for the given scroller.
26185     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26186     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26187     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26188     * This applies respectively for the horizontal and vertical scrollbars.
26189     *
26190     * The both are disabled by default, i.e., are set to
26191     * #ELM_SCROLLER_POLICY_OFF.
26192     *
26193     * @ingroup Diskselector
26194     */
26195    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26196
26197    /**
26198     * Remove all diskselector's items.
26199     *
26200     * @param obj The diskselector object.
26201     *
26202     * @see elm_diskselector_item_del()
26203     * @see elm_diskselector_item_append()
26204     *
26205     * @ingroup Diskselector
26206     */
26207    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26208
26209    /**
26210     * Get a list of all the diskselector items.
26211     *
26212     * @param obj The diskselector object.
26213     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26214     * or @c NULL on failure.
26215     *
26216     * @see elm_diskselector_item_append()
26217     * @see elm_diskselector_item_del()
26218     * @see elm_diskselector_clear()
26219     *
26220     * @ingroup Diskselector
26221     */
26222    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26223
26224    /**
26225     * Appends a new item to the diskselector object.
26226     *
26227     * @param obj The diskselector object.
26228     * @param label The label of the diskselector item.
26229     * @param icon The icon object to use at left side of the item. An
26230     * icon can be any Evas object, but usually it is an icon created
26231     * with elm_icon_add().
26232     * @param func The function to call when the item is selected.
26233     * @param data The data to associate with the item for related callbacks.
26234     *
26235     * @return The created item or @c NULL upon failure.
26236     *
26237     * A new item will be created and appended to the diskselector, i.e., will
26238     * be set as last item. Also, if there is no selected item, it will
26239     * be selected. This will always happens for the first appended item.
26240     *
26241     * If no icon is set, label will be centered on item position, otherwise
26242     * the icon will be placed at left of the label, that will be shifted
26243     * to the right.
26244     *
26245     * Items created with this method can be deleted with
26246     * elm_diskselector_item_del().
26247     *
26248     * Associated @p data can be properly freed when item is deleted if a
26249     * callback function is set with elm_diskselector_item_del_cb_set().
26250     *
26251     * If a function is passed as argument, it will be called everytime this item
26252     * is selected, i.e., the user stops the diskselector with this
26253     * item on center position. If such function isn't needed, just passing
26254     * @c NULL as @p func is enough. The same should be done for @p data.
26255     *
26256     * Simple example (with no function callback or data associated):
26257     * @code
26258     * disk = elm_diskselector_add(win);
26259     * ic = elm_icon_add(win);
26260     * elm_icon_file_set(ic, "path/to/image", NULL);
26261     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26262     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26263     * @endcode
26264     *
26265     * @see elm_diskselector_item_del()
26266     * @see elm_diskselector_item_del_cb_set()
26267     * @see elm_diskselector_clear()
26268     * @see elm_icon_add()
26269     *
26270     * @ingroup Diskselector
26271     */
26272    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);
26273
26274
26275    /**
26276     * Delete them item from the diskselector.
26277     *
26278     * @param it The item of diskselector to be deleted.
26279     *
26280     * If deleting all diskselector items is required, elm_diskselector_clear()
26281     * should be used instead of getting items list and deleting each one.
26282     *
26283     * @see elm_diskselector_clear()
26284     * @see elm_diskselector_item_append()
26285     * @see elm_diskselector_item_del_cb_set()
26286     *
26287     * @ingroup Diskselector
26288     */
26289    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26290
26291    /**
26292     * Set the function called when a diskselector item is freed.
26293     *
26294     * @param it The item to set the callback on
26295     * @param func The function called
26296     *
26297     * If there is a @p func, then it will be called prior item's memory release.
26298     * That will be called with the following arguments:
26299     * @li item's data;
26300     * @li item's Evas object;
26301     * @li item itself;
26302     *
26303     * This way, a data associated to a diskselector item could be properly
26304     * freed.
26305     *
26306     * @ingroup Diskselector
26307     */
26308    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26309
26310    /**
26311     * Get the data associated to the item.
26312     *
26313     * @param it The diskselector item
26314     * @return The data associated to @p it
26315     *
26316     * The return value is a pointer to data associated to @p item when it was
26317     * created, with function elm_diskselector_item_append(). If no data
26318     * was passed as argument, it will return @c NULL.
26319     *
26320     * @see elm_diskselector_item_append()
26321     *
26322     * @ingroup Diskselector
26323     */
26324    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26325
26326    /**
26327     * Set the icon associated to the item.
26328     *
26329     * @param it The diskselector item
26330     * @param icon The icon object to associate with @p it
26331     *
26332     * The icon object to use at left side of the item. An
26333     * icon can be any Evas object, but usually it is an icon created
26334     * with elm_icon_add().
26335     *
26336     * Once the icon object is set, a previously set one will be deleted.
26337     * @warning Setting the same icon for two items will cause the icon to
26338     * dissapear from the first item.
26339     *
26340     * If an icon was passed as argument on item creation, with function
26341     * elm_diskselector_item_append(), it will be already
26342     * associated to the item.
26343     *
26344     * @see elm_diskselector_item_append()
26345     * @see elm_diskselector_item_icon_get()
26346     *
26347     * @ingroup Diskselector
26348     */
26349    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26350
26351    /**
26352     * Get the icon associated to the item.
26353     *
26354     * @param it The diskselector item
26355     * @return The icon associated to @p it
26356     *
26357     * The return value is a pointer to the icon associated to @p item when it was
26358     * created, with function elm_diskselector_item_append(), or later
26359     * with function elm_diskselector_item_icon_set. If no icon
26360     * was passed as argument, it will return @c NULL.
26361     *
26362     * @see elm_diskselector_item_append()
26363     * @see elm_diskselector_item_icon_set()
26364     *
26365     * @ingroup Diskselector
26366     */
26367    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26368
26369    /**
26370     * Set the label of item.
26371     *
26372     * @param it The item of diskselector.
26373     * @param label The label of item.
26374     *
26375     * The label to be displayed by the item.
26376     *
26377     * If no icon is set, label will be centered on item position, otherwise
26378     * the icon will be placed at left of the label, that will be shifted
26379     * to the right.
26380     *
26381     * An item with label "January" would be displayed on side position as
26382     * "Jan" if max length is set to 3 with function
26383     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26384     * is set to 4.
26385     *
26386     * When this @p item is selected, the entire label will be displayed,
26387     * except for width restrictions.
26388     * In this case label will be cropped and "..." will be concatenated,
26389     * but only for display purposes. It will keep the entire string, so
26390     * if diskselector is resized the remaining characters will be displayed.
26391     *
26392     * If a label was passed as argument on item creation, with function
26393     * elm_diskselector_item_append(), it will be already
26394     * displayed by the item.
26395     *
26396     * @see elm_diskselector_side_label_lenght_set()
26397     * @see elm_diskselector_item_label_get()
26398     * @see elm_diskselector_item_append()
26399     *
26400     * @ingroup Diskselector
26401     */
26402    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26403
26404    /**
26405     * Get the label of item.
26406     *
26407     * @param it The item of diskselector.
26408     * @return The label of item.
26409     *
26410     * The return value is a pointer to the label associated to @p item when it was
26411     * created, with function elm_diskselector_item_append(), or later
26412     * with function elm_diskselector_item_label_set. If no label
26413     * was passed as argument, it will return @c NULL.
26414     *
26415     * @see elm_diskselector_item_label_set() for more details.
26416     * @see elm_diskselector_item_append()
26417     *
26418     * @ingroup Diskselector
26419     */
26420    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26421
26422    /**
26423     * Get the selected item.
26424     *
26425     * @param obj The diskselector object.
26426     * @return The selected diskselector item.
26427     *
26428     * The selected item can be unselected with function
26429     * elm_diskselector_item_selected_set(), and the first item of
26430     * diskselector will be selected.
26431     *
26432     * The selected item always will be centered on diskselector, with
26433     * full label displayed, i.e., max lenght set to side labels won't
26434     * apply on the selected item. More details on
26435     * elm_diskselector_side_label_length_set().
26436     *
26437     * @ingroup Diskselector
26438     */
26439    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26440
26441    /**
26442     * Set the selected state of an item.
26443     *
26444     * @param it The diskselector item
26445     * @param selected The selected state
26446     *
26447     * This sets the selected state of the given item @p it.
26448     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26449     *
26450     * If a new item is selected the previosly selected will be unselected.
26451     * Previoulsy selected item can be get with function
26452     * elm_diskselector_selected_item_get().
26453     *
26454     * If the item @p it is unselected, the first item of diskselector will
26455     * be selected.
26456     *
26457     * Selected items will be visible on center position of diskselector.
26458     * So if it was on another position before selected, or was invisible,
26459     * diskselector will animate items until the selected item reaches center
26460     * position.
26461     *
26462     * @see elm_diskselector_item_selected_get()
26463     * @see elm_diskselector_selected_item_get()
26464     *
26465     * @ingroup Diskselector
26466     */
26467    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26468
26469    /*
26470     * Get whether the @p item is selected or not.
26471     *
26472     * @param it The diskselector item.
26473     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26474     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26475     *
26476     * @see elm_diskselector_selected_item_set() for details.
26477     * @see elm_diskselector_item_selected_get()
26478     *
26479     * @ingroup Diskselector
26480     */
26481    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26482
26483    /**
26484     * Get the first item of the diskselector.
26485     *
26486     * @param obj The diskselector object.
26487     * @return The first item, or @c NULL if none.
26488     *
26489     * The list of items follows append order. So it will return the first
26490     * item appended to the widget that wasn't deleted.
26491     *
26492     * @see elm_diskselector_item_append()
26493     * @see elm_diskselector_items_get()
26494     *
26495     * @ingroup Diskselector
26496     */
26497    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26498
26499    /**
26500     * Get the last item of the diskselector.
26501     *
26502     * @param obj The diskselector object.
26503     * @return The last item, or @c NULL if none.
26504     *
26505     * The list of items follows append order. So it will return last first
26506     * item appended to the widget that wasn't deleted.
26507     *
26508     * @see elm_diskselector_item_append()
26509     * @see elm_diskselector_items_get()
26510     *
26511     * @ingroup Diskselector
26512     */
26513    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26514
26515    /**
26516     * Get the item before @p item in diskselector.
26517     *
26518     * @param it The diskselector item.
26519     * @return The item before @p item, or @c NULL if none or on failure.
26520     *
26521     * The list of items follows append order. So it will return item appended
26522     * just before @p item and that wasn't deleted.
26523     *
26524     * If it is the first item, @c NULL will be returned.
26525     * First item can be get by elm_diskselector_first_item_get().
26526     *
26527     * @see elm_diskselector_item_append()
26528     * @see elm_diskselector_items_get()
26529     *
26530     * @ingroup Diskselector
26531     */
26532    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26533
26534    /**
26535     * Get the item after @p item in diskselector.
26536     *
26537     * @param it The diskselector item.
26538     * @return The item after @p item, or @c NULL if none or on failure.
26539     *
26540     * The list of items follows append order. So it will return item appended
26541     * just after @p item and that wasn't deleted.
26542     *
26543     * If it is the last item, @c NULL will be returned.
26544     * Last item can be get by elm_diskselector_last_item_get().
26545     *
26546     * @see elm_diskselector_item_append()
26547     * @see elm_diskselector_items_get()
26548     *
26549     * @ingroup Diskselector
26550     */
26551    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26552
26553    /**
26554     * Set the text to be shown in the diskselector item.
26555     *
26556     * @param item Target item
26557     * @param text The text to set in the content
26558     *
26559     * Setup the text as tooltip to object. The item can have only one tooltip,
26560     * so any previous tooltip data is removed.
26561     *
26562     * @see elm_object_tooltip_text_set() for more details.
26563     *
26564     * @ingroup Diskselector
26565     */
26566    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26567
26568    /**
26569     * Set the content to be shown in the tooltip item.
26570     *
26571     * Setup the tooltip to item. The item can have only one tooltip,
26572     * so any previous tooltip data is removed. @p func(with @p data) will
26573     * be called every time that need show the tooltip and it should
26574     * return a valid Evas_Object. This object is then managed fully by
26575     * tooltip system and is deleted when the tooltip is gone.
26576     *
26577     * @param item the diskselector item being attached a tooltip.
26578     * @param func the function used to create the tooltip contents.
26579     * @param data what to provide to @a func as callback data/context.
26580     * @param del_cb called when data is not needed anymore, either when
26581     *        another callback replaces @p func, the tooltip is unset with
26582     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26583     *        dies. This callback receives as the first parameter the
26584     *        given @a data, and @c event_info is the item.
26585     *
26586     * @see elm_object_tooltip_content_cb_set() for more details.
26587     *
26588     * @ingroup Diskselector
26589     */
26590    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);
26591
26592    /**
26593     * Unset tooltip from item.
26594     *
26595     * @param item diskselector item to remove previously set tooltip.
26596     *
26597     * Remove tooltip from item. The callback provided as del_cb to
26598     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26599     * it is not used anymore.
26600     *
26601     * @see elm_object_tooltip_unset() for more details.
26602     * @see elm_diskselector_item_tooltip_content_cb_set()
26603     *
26604     * @ingroup Diskselector
26605     */
26606    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26607
26608
26609    /**
26610     * Sets a different style for this item tooltip.
26611     *
26612     * @note before you set a style you should define a tooltip with
26613     *       elm_diskselector_item_tooltip_content_cb_set() or
26614     *       elm_diskselector_item_tooltip_text_set()
26615     *
26616     * @param item diskselector item with tooltip already set.
26617     * @param style the theme style to use (default, transparent, ...)
26618     *
26619     * @see elm_object_tooltip_style_set() for more details.
26620     *
26621     * @ingroup Diskselector
26622     */
26623    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26624
26625    /**
26626     * Get the style for this item tooltip.
26627     *
26628     * @param item diskselector item with tooltip already set.
26629     * @return style the theme style in use, defaults to "default". If the
26630     *         object does not have a tooltip set, then NULL is returned.
26631     *
26632     * @see elm_object_tooltip_style_get() for more details.
26633     * @see elm_diskselector_item_tooltip_style_set()
26634     *
26635     * @ingroup Diskselector
26636     */
26637    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26638
26639    /**
26640     * Set the cursor to be shown when mouse is over the diskselector item
26641     *
26642     * @param item Target item
26643     * @param cursor the cursor name to be used.
26644     *
26645     * @see elm_object_cursor_set() for more details.
26646     *
26647     * @ingroup Diskselector
26648     */
26649    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26650
26651    /**
26652     * Get the cursor to be shown when mouse is over the diskselector item
26653     *
26654     * @param item diskselector item with cursor already set.
26655     * @return the cursor name.
26656     *
26657     * @see elm_object_cursor_get() for more details.
26658     * @see elm_diskselector_cursor_set()
26659     *
26660     * @ingroup Diskselector
26661     */
26662    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26663
26664
26665    /**
26666     * Unset the cursor to be shown when mouse is over the diskselector item
26667     *
26668     * @param item Target item
26669     *
26670     * @see elm_object_cursor_unset() for more details.
26671     * @see elm_diskselector_cursor_set()
26672     *
26673     * @ingroup Diskselector
26674     */
26675    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26676
26677    /**
26678     * Sets a different style for this item cursor.
26679     *
26680     * @note before you set a style you should define a cursor with
26681     *       elm_diskselector_item_cursor_set()
26682     *
26683     * @param item diskselector item with cursor already set.
26684     * @param style the theme style to use (default, transparent, ...)
26685     *
26686     * @see elm_object_cursor_style_set() for more details.
26687     *
26688     * @ingroup Diskselector
26689     */
26690    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26691
26692
26693    /**
26694     * Get the style for this item cursor.
26695     *
26696     * @param item diskselector item with cursor already set.
26697     * @return style the theme style in use, defaults to "default". If the
26698     *         object does not have a cursor set, then @c NULL is returned.
26699     *
26700     * @see elm_object_cursor_style_get() for more details.
26701     * @see elm_diskselector_item_cursor_style_set()
26702     *
26703     * @ingroup Diskselector
26704     */
26705    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26706
26707
26708    /**
26709     * Set if the cursor set should be searched on the theme or should use
26710     * the provided by the engine, only.
26711     *
26712     * @note before you set if should look on theme you should define a cursor
26713     * with elm_diskselector_item_cursor_set().
26714     * By default it will only look for cursors provided by the engine.
26715     *
26716     * @param item widget item with cursor already set.
26717     * @param engine_only boolean to define if cursors set with
26718     * elm_diskselector_item_cursor_set() should be searched only
26719     * between cursors provided by the engine or searched on widget's
26720     * theme as well.
26721     *
26722     * @see elm_object_cursor_engine_only_set() for more details.
26723     *
26724     * @ingroup Diskselector
26725     */
26726    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26727
26728    /**
26729     * Get the cursor engine only usage for this item cursor.
26730     *
26731     * @param item widget item with cursor already set.
26732     * @return engine_only boolean to define it cursors should be looked only
26733     * between the provided by the engine or searched on widget's theme as well.
26734     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26735     *
26736     * @see elm_object_cursor_engine_only_get() for more details.
26737     * @see elm_diskselector_item_cursor_engine_only_set()
26738     *
26739     * @ingroup Diskselector
26740     */
26741    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26742
26743    /**
26744     * @}
26745     */
26746
26747    /**
26748     * @defgroup Colorselector Colorselector
26749     *
26750     * @{
26751     *
26752     * @image html img/widget/colorselector/preview-00.png
26753     * @image latex img/widget/colorselector/preview-00.eps
26754     *
26755     * @brief Widget for user to select a color.
26756     *
26757     * Signals that you can add callbacks for are:
26758     * "changed" - When the color value changes(event_info is NULL).
26759     *
26760     * See @ref tutorial_colorselector.
26761     */
26762    /**
26763     * @brief Add a new colorselector to the parent
26764     *
26765     * @param parent The parent object
26766     * @return The new object or NULL if it cannot be created
26767     *
26768     * @ingroup Colorselector
26769     */
26770    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26771    /**
26772     * Set a color for the colorselector
26773     *
26774     * @param obj   Colorselector object
26775     * @param r     r-value of color
26776     * @param g     g-value of color
26777     * @param b     b-value of color
26778     * @param a     a-value of color
26779     *
26780     * @ingroup Colorselector
26781     */
26782    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26783    /**
26784     * Get a color from the colorselector
26785     *
26786     * @param obj   Colorselector object
26787     * @param r     integer pointer for r-value of color
26788     * @param g     integer pointer for g-value of color
26789     * @param b     integer pointer for b-value of color
26790     * @param a     integer pointer for a-value of color
26791     *
26792     * @ingroup Colorselector
26793     */
26794    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26795    /**
26796     * @}
26797     */
26798
26799    /**
26800     * @defgroup Ctxpopup Ctxpopup
26801     *
26802     * @image html img/widget/ctxpopup/preview-00.png
26803     * @image latex img/widget/ctxpopup/preview-00.eps
26804     *
26805     * @brief Context popup widet.
26806     *
26807     * A ctxpopup is a widget that, when shown, pops up a list of items.
26808     * It automatically chooses an area inside its parent object's view
26809     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26810     * optimally fit into it. In the default theme, it will also point an
26811     * arrow to it's top left position at the time one shows it. Ctxpopup
26812     * items have a label and/or an icon. It is intended for a small
26813     * number of items (hence the use of list, not genlist).
26814     *
26815     * @note Ctxpopup is a especialization of @ref Hover.
26816     *
26817     * Signals that you can add callbacks for are:
26818     * "dismissed" - the ctxpopup was dismissed
26819     *
26820     * Default contents parts of the ctxpopup widget that you can use for are:
26821     * @li "default" - A content of the ctxpopup
26822     *
26823     * Default contents parts of the naviframe items that you can use for are:
26824     * @li "icon" - A icon in the title area
26825     * 
26826     * Default text parts of the naviframe items that you can use for are:
26827     * @li "default" - Title label in the title area
26828     *
26829     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26830     * @{
26831     */
26832    typedef enum _Elm_Ctxpopup_Direction
26833      {
26834         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26835                                           area */
26836         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26837                                            the clicked area */
26838         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26839                                           the clicked area */
26840         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26841                                         area */
26842         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26843      } Elm_Ctxpopup_Direction;
26844 #define Elm_Ctxpopup_Item Elm_Object_Item
26845
26846    /**
26847     * @brief Add a new Ctxpopup object to the parent.
26848     *
26849     * @param parent Parent object
26850     * @return New object or @c NULL, if it cannot be created
26851     */
26852    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26853    /**
26854     * @brief Set the Ctxpopup's parent
26855     *
26856     * @param obj The ctxpopup object
26857     * @param area The parent to use
26858     *
26859     * Set the parent object.
26860     *
26861     * @note elm_ctxpopup_add() will automatically call this function
26862     * with its @c parent argument.
26863     *
26864     * @see elm_ctxpopup_add()
26865     * @see elm_hover_parent_set()
26866     */
26867    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26868    /**
26869     * @brief Get the Ctxpopup's parent
26870     *
26871     * @param obj The ctxpopup object
26872     *
26873     * @see elm_ctxpopup_hover_parent_set() for more information
26874     */
26875    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26876    /**
26877     * @brief Clear all items in the given ctxpopup object.
26878     *
26879     * @param obj Ctxpopup object
26880     */
26881    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26882    /**
26883     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26884     *
26885     * @param obj Ctxpopup object
26886     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26887     */
26888    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26889    /**
26890     * @brief Get the value of current ctxpopup object's orientation.
26891     *
26892     * @param obj Ctxpopup object
26893     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26894     *
26895     * @see elm_ctxpopup_horizontal_set()
26896     */
26897    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26898    /**
26899     * @brief Add a new item to a ctxpopup object.
26900     *
26901     * @param obj Ctxpopup object
26902     * @param icon Icon to be set on new item
26903     * @param label The Label of the new item
26904     * @param func Convenience function called when item selected
26905     * @param data Data passed to @p func
26906     * @return A handle to the item added or @c NULL, on errors
26907     *
26908     * @warning Ctxpopup can't hold both an item list and a content at the same
26909     * time. When an item is added, any previous content will be removed.
26910     *
26911     * @see elm_ctxpopup_content_set()
26912     */
26913    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);
26914    /**
26915     * @brief Delete the given item in a ctxpopup object.
26916     *
26917     * @param it Ctxpopup item to be deleted
26918     *
26919     * @see elm_ctxpopup_item_append()
26920     */
26921    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26922    /**
26923     * @brief Set the ctxpopup item's state as disabled or enabled.
26924     *
26925     * @param it Ctxpopup item to be enabled/disabled
26926     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26927     *
26928     * When disabled the item is greyed out to indicate it's state.
26929     * @deprecated use elm_object_item_disabled_set() instead
26930     */
26931    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26932    /**
26933     * @brief Get the ctxpopup item's disabled/enabled state.
26934     *
26935     * @param it Ctxpopup item to be enabled/disabled
26936     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26937     *
26938     * @see elm_ctxpopup_item_disabled_set()
26939     * @deprecated use elm_object_item_disabled_get() instead
26940     */
26941    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26942    /**
26943     * @brief Get the icon object for the given ctxpopup item.
26944     *
26945     * @param it Ctxpopup item
26946     * @return icon object or @c NULL, if the item does not have icon or an error
26947     * occurred
26948     *
26949     * @see elm_ctxpopup_item_append()
26950     * @see elm_ctxpopup_item_icon_set()
26951     *
26952     * @deprecated use elm_object_item_part_content_get() instead
26953     */
26954    WILL_DEPRECATE  EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26955    /**
26956     * @brief Sets the side icon associated with the ctxpopup item
26957     *
26958     * @param it Ctxpopup item
26959     * @param icon Icon object to be set
26960     *
26961     * Once the icon object is set, a previously set one will be deleted.
26962     * @warning Setting the same icon for two items will cause the icon to
26963     * dissapear from the first item.
26964     *
26965     * @see elm_ctxpopup_item_append()
26966     *  
26967     * @deprecated use elm_object_item_part_content_set() instead
26968     *
26969     */
26970    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26971    /**
26972     * @brief Get the label for the given ctxpopup item.
26973     *
26974     * @param it Ctxpopup item
26975     * @return label string or @c NULL, if the item does not have label or an
26976     * error occured
26977     *
26978     * @see elm_ctxpopup_item_append()
26979     * @see elm_ctxpopup_item_label_set()
26980     *
26981     * @deprecated use elm_object_item_text_get() instead
26982     */
26983    WILL_DEPRECATE  EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26984    /**
26985     * @brief (Re)set the label on the given ctxpopup item.
26986     *
26987     * @param it Ctxpopup item
26988     * @param label String to set as label
26989     *
26990     * @deprecated use elm_object_item_text_set() instead
26991     */
26992    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26993    /**
26994     * @brief Set an elm widget as the content of the ctxpopup.
26995     *
26996     * @param obj Ctxpopup object
26997     * @param content Content to be swallowed
26998     *
26999     * If the content object is already set, a previous one will bedeleted. If
27000     * you want to keep that old content object, use the
27001     * elm_ctxpopup_content_unset() function.
27002     *
27003     * @warning Ctxpopup can't hold both a item list and a content at the same
27004     * time. When a content is set, any previous items will be removed.
27005     * 
27006     * @deprecated use elm_object_content_set() instead
27007     *
27008     */
27009    WILL_DEPRECATE  EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
27010    /**
27011     * @brief Unset the ctxpopup content
27012     *
27013     * @param obj Ctxpopup object
27014     * @return The content that was being used
27015     *
27016     * Unparent and return the content object which was set for this widget.
27017     *
27018     * @deprecated use elm_object_content_unset()
27019     *
27020     * @see elm_ctxpopup_content_set()
27021     *
27022     * @deprecated use elm_object_content_unset() instead
27023     *
27024     */
27025    WILL_DEPRECATE  EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
27026    /**
27027     * @brief Set the direction priority of a ctxpopup.
27028     *
27029     * @param obj Ctxpopup object
27030     * @param first 1st priority of direction
27031     * @param second 2nd priority of direction
27032     * @param third 3th priority of direction
27033     * @param fourth 4th priority of direction
27034     *
27035     * This functions gives a chance to user to set the priority of ctxpopup
27036     * showing direction. This doesn't guarantee the ctxpopup will appear in the
27037     * requested direction.
27038     *
27039     * @see Elm_Ctxpopup_Direction
27040     */
27041    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);
27042    /**
27043     * @brief Get the direction priority of a ctxpopup.
27044     *
27045     * @param obj Ctxpopup object
27046     * @param first 1st priority of direction to be returned
27047     * @param second 2nd priority of direction to be returned
27048     * @param third 3th priority of direction to be returned
27049     * @param fourth 4th priority of direction to be returned
27050     *
27051     * @see elm_ctxpopup_direction_priority_set() for more information.
27052     */
27053    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);
27054
27055    /**
27056     * @brief Get the current direction of a ctxpopup.
27057     *
27058     * @param obj Ctxpopup object
27059     * @return current direction of a ctxpopup
27060     *
27061     * @warning Once the ctxpopup showed up, the direction would be determined
27062     */
27063    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27064
27065    /**
27066     * @}
27067     */
27068
27069    /* transit */
27070    /**
27071     *
27072     * @defgroup Transit Transit
27073     * @ingroup Elementary
27074     *
27075     * Transit is designed to apply various animated transition effects to @c
27076     * Evas_Object, such like translation, rotation, etc. For using these
27077     * effects, create an @ref Elm_Transit and add the desired transition effects.
27078     *
27079     * Once the effects are added into transit, they will be automatically
27080     * managed (their callback will be called until the duration is ended, and
27081     * they will be deleted on completion).
27082     *
27083     * Example:
27084     * @code
27085     * Elm_Transit *trans = elm_transit_add();
27086     * elm_transit_object_add(trans, obj);
27087     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27088     * elm_transit_duration_set(transit, 1);
27089     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27090     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27091     * elm_transit_repeat_times_set(transit, 3);
27092     * @endcode
27093     *
27094     * Some transition effects are used to change the properties of objects. They
27095     * are:
27096     * @li @ref elm_transit_effect_translation_add
27097     * @li @ref elm_transit_effect_color_add
27098     * @li @ref elm_transit_effect_rotation_add
27099     * @li @ref elm_transit_effect_wipe_add
27100     * @li @ref elm_transit_effect_zoom_add
27101     * @li @ref elm_transit_effect_resizing_add
27102     *
27103     * Other transition effects are used to make one object disappear and another
27104     * object appear on its old place. These effects are:
27105     *
27106     * @li @ref elm_transit_effect_flip_add
27107     * @li @ref elm_transit_effect_resizable_flip_add
27108     * @li @ref elm_transit_effect_fade_add
27109     * @li @ref elm_transit_effect_blend_add
27110     *
27111     * It's also possible to make a transition chain with @ref
27112     * elm_transit_chain_transit_add.
27113     *
27114     * @warning We strongly recommend to use elm_transit just when edje can not do
27115     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27116     * animations can be manipulated inside the theme.
27117     *
27118     * List of examples:
27119     * @li @ref transit_example_01_explained
27120     * @li @ref transit_example_02_explained
27121     * @li @ref transit_example_03_c
27122     * @li @ref transit_example_04_c
27123     *
27124     * @{
27125     */
27126
27127    /**
27128     * @enum Elm_Transit_Tween_Mode
27129     *
27130     * The type of acceleration used in the transition.
27131     */
27132    typedef enum
27133      {
27134         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27135         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27136                                              over time, then decrease again
27137                                              and stop slowly */
27138         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27139                                              speed over time */
27140         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27141                                             over time */
27142      } Elm_Transit_Tween_Mode;
27143
27144    /**
27145     * @enum Elm_Transit_Effect_Flip_Axis
27146     *
27147     * The axis where flip effect should be applied.
27148     */
27149    typedef enum
27150      {
27151         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27152         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27153      } Elm_Transit_Effect_Flip_Axis;
27154    /**
27155     * @enum Elm_Transit_Effect_Wipe_Dir
27156     *
27157     * The direction where the wipe effect should occur.
27158     */
27159    typedef enum
27160      {
27161         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27162         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27163         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27164         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27165      } Elm_Transit_Effect_Wipe_Dir;
27166    /** @enum Elm_Transit_Effect_Wipe_Type
27167     *
27168     * Whether the wipe effect should show or hide the object.
27169     */
27170    typedef enum
27171      {
27172         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27173                                              animation */
27174         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27175                                             animation */
27176      } Elm_Transit_Effect_Wipe_Type;
27177
27178    /**
27179     * @typedef Elm_Transit
27180     *
27181     * The Transit created with elm_transit_add(). This type has the information
27182     * about the objects which the transition will be applied, and the
27183     * transition effects that will be used. It also contains info about
27184     * duration, number of repetitions, auto-reverse, etc.
27185     */
27186    typedef struct _Elm_Transit Elm_Transit;
27187    typedef void Elm_Transit_Effect;
27188    /**
27189     * @typedef Elm_Transit_Effect_Transition_Cb
27190     *
27191     * Transition callback called for this effect on each transition iteration.
27192     */
27193    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27194    /**
27195     * Elm_Transit_Effect_End_Cb
27196     *
27197     * Transition callback called for this effect when the transition is over.
27198     */
27199    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27200
27201    /**
27202     * Elm_Transit_Del_Cb
27203     *
27204     * A callback called when the transit is deleted.
27205     */
27206    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27207
27208    /**
27209     * Add new transit.
27210     *
27211     * @note Is not necessary to delete the transit object, it will be deleted at
27212     * the end of its operation.
27213     * @note The transit will start playing when the program enter in the main loop, is not
27214     * necessary to give a start to the transit.
27215     *
27216     * @return The transit object.
27217     *
27218     * @ingroup Transit
27219     */
27220    EAPI Elm_Transit                *elm_transit_add(void);
27221
27222    /**
27223     * Stops the animation and delete the @p transit object.
27224     *
27225     * Call this function if you wants to stop the animation before the duration
27226     * time. Make sure the @p transit object is still alive with
27227     * elm_transit_del_cb_set() function.
27228     * All added effects will be deleted, calling its repective data_free_cb
27229     * functions. The function setted by elm_transit_del_cb_set() will be called.
27230     *
27231     * @see elm_transit_del_cb_set()
27232     *
27233     * @param transit The transit object to be deleted.
27234     *
27235     * @ingroup Transit
27236     * @warning Just call this function if you are sure the transit is alive.
27237     */
27238    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27239
27240    /**
27241     * Add a new effect to the transit.
27242     *
27243     * @note The cb function and the data are the key to the effect. If you try to
27244     * add an already added effect, nothing is done.
27245     * @note After the first addition of an effect in @p transit, if its
27246     * effect list become empty again, the @p transit will be killed by
27247     * elm_transit_del(transit) function.
27248     *
27249     * Exemple:
27250     * @code
27251     * Elm_Transit *transit = elm_transit_add();
27252     * elm_transit_effect_add(transit,
27253     *                        elm_transit_effect_blend_op,
27254     *                        elm_transit_effect_blend_context_new(),
27255     *                        elm_transit_effect_blend_context_free);
27256     * @endcode
27257     *
27258     * @param transit The transit object.
27259     * @param transition_cb The operation function. It is called when the
27260     * animation begins, it is the function that actually performs the animation.
27261     * It is called with the @p data, @p transit and the time progression of the
27262     * animation (a double value between 0.0 and 1.0).
27263     * @param effect The context data of the effect.
27264     * @param end_cb The function to free the context data, it will be called
27265     * at the end of the effect, it must finalize the animation and free the
27266     * @p data.
27267     *
27268     * @ingroup Transit
27269     * @warning The transit free the context data at the and of the transition with
27270     * the data_free_cb function, do not use the context data in another transit.
27271     */
27272    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);
27273
27274    /**
27275     * Delete an added effect.
27276     *
27277     * This function will remove the effect from the @p transit, calling the
27278     * data_free_cb to free the @p data.
27279     *
27280     * @see elm_transit_effect_add()
27281     *
27282     * @note If the effect is not found, nothing is done.
27283     * @note If the effect list become empty, this function will call
27284     * elm_transit_del(transit), that is, it will kill the @p transit.
27285     *
27286     * @param transit The transit object.
27287     * @param transition_cb The operation function.
27288     * @param effect The context data of the effect.
27289     *
27290     * @ingroup Transit
27291     */
27292    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);
27293
27294    /**
27295     * Add new object to apply the effects.
27296     *
27297     * @note After the first addition of an object in @p transit, if its
27298     * object list become empty again, the @p transit will be killed by
27299     * elm_transit_del(transit) function.
27300     * @note If the @p obj belongs to another transit, the @p obj will be
27301     * removed from it and it will only belong to the @p transit. If the old
27302     * transit stays without objects, it will die.
27303     * @note When you add an object into the @p transit, its state from
27304     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27305     * transit ends, if you change this state whith evas_object_pass_events_set()
27306     * after add the object, this state will change again when @p transit stops to
27307     * run.
27308     *
27309     * @param transit The transit object.
27310     * @param obj Object to be animated.
27311     *
27312     * @ingroup Transit
27313     * @warning It is not allowed to add a new object after transit begins to go.
27314     */
27315    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27316
27317    /**
27318     * Removes an added object from the transit.
27319     *
27320     * @note If the @p obj is not in the @p transit, nothing is done.
27321     * @note If the list become empty, this function will call
27322     * elm_transit_del(transit), that is, it will kill the @p transit.
27323     *
27324     * @param transit The transit object.
27325     * @param obj Object to be removed from @p transit.
27326     *
27327     * @ingroup Transit
27328     * @warning It is not allowed to remove objects after transit begins to go.
27329     */
27330    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27331
27332    /**
27333     * Get the objects of the transit.
27334     *
27335     * @param transit The transit object.
27336     * @return a Eina_List with the objects from the transit.
27337     *
27338     * @ingroup Transit
27339     */
27340    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27341
27342    /**
27343     * Enable/disable keeping up the objects states.
27344     * If it is not kept, the objects states will be reset when transition ends.
27345     *
27346     * @note @p transit can not be NULL.
27347     * @note One state includes geometry, color, map data.
27348     *
27349     * @param transit The transit object.
27350     * @param state_keep Keeping or Non Keeping.
27351     *
27352     * @ingroup Transit
27353     */
27354    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27355
27356    /**
27357     * Get a value whether the objects states will be reset or not.
27358     *
27359     * @note @p transit can not be NULL
27360     *
27361     * @see elm_transit_objects_final_state_keep_set()
27362     *
27363     * @param transit The transit object.
27364     * @return EINA_TRUE means the states of the objects will be reset.
27365     * If @p transit is NULL, EINA_FALSE is returned
27366     *
27367     * @ingroup Transit
27368     */
27369    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27370
27371    /**
27372     * Set the event enabled when transit is operating.
27373     *
27374     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27375     * events from mouse and keyboard during the animation.
27376     * @note When you add an object with elm_transit_object_add(), its state from
27377     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27378     * transit ends, if you change this state with evas_object_pass_events_set()
27379     * after adding the object, this state will change again when @p transit stops
27380     * to run.
27381     *
27382     * @param transit The transit object.
27383     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27384     * ignored otherwise.
27385     *
27386     * @ingroup Transit
27387     */
27388    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27389
27390    /**
27391     * Get the value of event enabled status.
27392     *
27393     * @see elm_transit_event_enabled_set()
27394     *
27395     * @param transit The Transit object
27396     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27397     * EINA_FALSE is returned
27398     *
27399     * @ingroup Transit
27400     */
27401    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27402
27403    /**
27404     * Set the user-callback function when the transit is deleted.
27405     *
27406     * @note Using this function twice will overwrite the first function setted.
27407     * @note the @p transit object will be deleted after call @p cb function.
27408     *
27409     * @param transit The transit object.
27410     * @param cb Callback function pointer. This function will be called before
27411     * the deletion of the transit.
27412     * @param data Callback funtion user data. It is the @p op parameter.
27413     *
27414     * @ingroup Transit
27415     */
27416    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27417
27418    /**
27419     * Set reverse effect automatically.
27420     *
27421     * If auto reverse is setted, after running the effects with the progress
27422     * parameter from 0 to 1, it will call the effecs again with the progress
27423     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27424     * where the duration was setted with the function elm_transit_add and
27425     * the repeat with the function elm_transit_repeat_times_set().
27426     *
27427     * @param transit The transit object.
27428     * @param reverse EINA_TRUE means the auto_reverse is on.
27429     *
27430     * @ingroup Transit
27431     */
27432    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27433
27434    /**
27435     * Get if the auto reverse is on.
27436     *
27437     * @see elm_transit_auto_reverse_set()
27438     *
27439     * @param transit The transit object.
27440     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27441     * EINA_FALSE is returned
27442     *
27443     * @ingroup Transit
27444     */
27445    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27446
27447    /**
27448     * Set the transit repeat count. Effect will be repeated by repeat count.
27449     *
27450     * This function sets the number of repetition the transit will run after
27451     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27452     * If the @p repeat is a negative number, it will repeat infinite times.
27453     *
27454     * @note If this function is called during the transit execution, the transit
27455     * will run @p repeat times, ignoring the times it already performed.
27456     *
27457     * @param transit The transit object
27458     * @param repeat Repeat count
27459     *
27460     * @ingroup Transit
27461     */
27462    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27463
27464    /**
27465     * Get the transit repeat count.
27466     *
27467     * @see elm_transit_repeat_times_set()
27468     *
27469     * @param transit The Transit object.
27470     * @return The repeat count. If @p transit is NULL
27471     * 0 is returned
27472     *
27473     * @ingroup Transit
27474     */
27475    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27476
27477    /**
27478     * Set the transit animation acceleration type.
27479     *
27480     * This function sets the tween mode of the transit that can be:
27481     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27482     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27483     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27484     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27485     *
27486     * @param transit The transit object.
27487     * @param tween_mode The tween type.
27488     *
27489     * @ingroup Transit
27490     */
27491    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27492
27493    /**
27494     * Get the transit animation acceleration type.
27495     *
27496     * @note @p transit can not be NULL
27497     *
27498     * @param transit The transit object.
27499     * @return The tween type. If @p transit is NULL
27500     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27501     *
27502     * @ingroup Transit
27503     */
27504    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27505
27506    /**
27507     * Set the transit animation time
27508     *
27509     * @note @p transit can not be NULL
27510     *
27511     * @param transit The transit object.
27512     * @param duration The animation time.
27513     *
27514     * @ingroup Transit
27515     */
27516    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27517
27518    /**
27519     * Get the transit animation time
27520     *
27521     * @note @p transit can not be NULL
27522     *
27523     * @param transit The transit object.
27524     *
27525     * @return The transit animation time.
27526     *
27527     * @ingroup Transit
27528     */
27529    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27530
27531    /**
27532     * Starts the transition.
27533     * Once this API is called, the transit begins to measure the time.
27534     *
27535     * @note @p transit can not be NULL
27536     *
27537     * @param transit The transit object.
27538     *
27539     * @ingroup Transit
27540     */
27541    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27542
27543    /**
27544     * Pause/Resume the transition.
27545     *
27546     * If you call elm_transit_go again, the transit will be started from the
27547     * beginning, and will be unpaused.
27548     *
27549     * @note @p transit can not be NULL
27550     *
27551     * @param transit The transit object.
27552     * @param paused Whether the transition should be paused or not.
27553     *
27554     * @ingroup Transit
27555     */
27556    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27557
27558    /**
27559     * Get the value of paused status.
27560     *
27561     * @see elm_transit_paused_set()
27562     *
27563     * @note @p transit can not be NULL
27564     *
27565     * @param transit The transit object.
27566     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27567     * EINA_FALSE is returned
27568     *
27569     * @ingroup Transit
27570     */
27571    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27572
27573    /**
27574     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27575     *
27576     * The value returned is a fraction (current time / total time). It
27577     * represents the progression position relative to the total.
27578     *
27579     * @note @p transit can not be NULL
27580     *
27581     * @param transit The transit object.
27582     *
27583     * @return The time progression value. If @p transit is NULL
27584     * 0 is returned
27585     *
27586     * @ingroup Transit
27587     */
27588    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27589
27590    /**
27591     * Makes the chain relationship between two transits.
27592     *
27593     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27594     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27595     *
27596     * @param transit The transit object.
27597     * @param chain_transit The chain transit object. This transit will be operated
27598     *        after transit is done.
27599     *
27600     * This function adds @p chain_transit transition to a chain after the @p
27601     * transit, and will be started as soon as @p transit ends. See @ref
27602     * transit_example_02_explained for a full example.
27603     *
27604     * @ingroup Transit
27605     */
27606    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27607
27608    /**
27609     * Cut off the chain relationship between two transits.
27610     *
27611     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27612     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27613     *
27614     * @param transit The transit object.
27615     * @param chain_transit The chain transit object.
27616     *
27617     * This function remove the @p chain_transit transition from the @p transit.
27618     *
27619     * @ingroup Transit
27620     */
27621    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27622
27623    /**
27624     * Get the current chain transit list.
27625     *
27626     * @note @p transit can not be NULL.
27627     *
27628     * @param transit The transit object.
27629     * @return chain transit list.
27630     *
27631     * @ingroup Transit
27632     */
27633    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27634
27635    /**
27636     * Add the Resizing Effect to Elm_Transit.
27637     *
27638     * @note This API is one of the facades. It creates resizing effect context
27639     * and add it's required APIs to elm_transit_effect_add.
27640     *
27641     * @see elm_transit_effect_add()
27642     *
27643     * @param transit Transit object.
27644     * @param from_w Object width size when effect begins.
27645     * @param from_h Object height size when effect begins.
27646     * @param to_w Object width size when effect ends.
27647     * @param to_h Object height size when effect ends.
27648     * @return Resizing effect context data.
27649     *
27650     * @ingroup Transit
27651     */
27652    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);
27653
27654    /**
27655     * Add the Translation Effect to Elm_Transit.
27656     *
27657     * @note This API is one of the facades. It creates translation effect context
27658     * and add it's required APIs to elm_transit_effect_add.
27659     *
27660     * @see elm_transit_effect_add()
27661     *
27662     * @param transit Transit object.
27663     * @param from_dx X Position variation when effect begins.
27664     * @param from_dy Y Position variation when effect begins.
27665     * @param to_dx X Position variation when effect ends.
27666     * @param to_dy Y Position variation when effect ends.
27667     * @return Translation effect context data.
27668     *
27669     * @ingroup Transit
27670     * @warning It is highly recommended just create a transit with this effect when
27671     * the window that the objects of the transit belongs has already been created.
27672     * This is because this effect needs the geometry information about the objects,
27673     * and if the window was not created yet, it can get a wrong information.
27674     */
27675    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);
27676
27677    /**
27678     * Add the Zoom Effect to Elm_Transit.
27679     *
27680     * @note This API is one of the facades. It creates zoom effect context
27681     * and add it's required APIs to elm_transit_effect_add.
27682     *
27683     * @see elm_transit_effect_add()
27684     *
27685     * @param transit Transit object.
27686     * @param from_rate Scale rate when effect begins (1 is current rate).
27687     * @param to_rate Scale rate when effect ends.
27688     * @return Zoom effect context data.
27689     *
27690     * @ingroup Transit
27691     * @warning It is highly recommended just create a transit with this effect when
27692     * the window that the objects of the transit belongs has already been created.
27693     * This is because this effect needs the geometry information about the objects,
27694     * and if the window was not created yet, it can get a wrong information.
27695     */
27696    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27697
27698    /**
27699     * Add the Flip Effect to Elm_Transit.
27700     *
27701     * @note This API is one of the facades. It creates flip effect context
27702     * and add it's required APIs to elm_transit_effect_add.
27703     * @note This effect is applied to each pair of objects in the order they are listed
27704     * in the transit list of objects. The first object in the pair will be the
27705     * "front" object and the second will be the "back" object.
27706     *
27707     * @see elm_transit_effect_add()
27708     *
27709     * @param transit Transit object.
27710     * @param axis Flipping Axis(X or Y).
27711     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27712     * @return Flip effect context data.
27713     *
27714     * @ingroup Transit
27715     * @warning It is highly recommended just create a transit with this effect when
27716     * the window that the objects of the transit belongs has already been created.
27717     * This is because this effect needs the geometry information about the objects,
27718     * and if the window was not created yet, it can get a wrong information.
27719     */
27720    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27721
27722    /**
27723     * Add the Resizable Flip Effect to Elm_Transit.
27724     *
27725     * @note This API is one of the facades. It creates resizable flip effect context
27726     * and add it's required APIs to elm_transit_effect_add.
27727     * @note This effect is applied to each pair of objects in the order they are listed
27728     * in the transit list of objects. The first object in the pair will be the
27729     * "front" object and the second will be the "back" object.
27730     *
27731     * @see elm_transit_effect_add()
27732     *
27733     * @param transit Transit object.
27734     * @param axis Flipping Axis(X or Y).
27735     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27736     * @return Resizable flip effect context data.
27737     *
27738     * @ingroup Transit
27739     * @warning It is highly recommended just create a transit with this effect when
27740     * the window that the objects of the transit belongs has already been created.
27741     * This is because this effect needs the geometry information about the objects,
27742     * and if the window was not created yet, it can get a wrong information.
27743     */
27744    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27745
27746    /**
27747     * Add the Wipe Effect to Elm_Transit.
27748     *
27749     * @note This API is one of the facades. It creates wipe effect context
27750     * and add it's required APIs to elm_transit_effect_add.
27751     *
27752     * @see elm_transit_effect_add()
27753     *
27754     * @param transit Transit object.
27755     * @param type Wipe type. Hide or show.
27756     * @param dir Wipe Direction.
27757     * @return Wipe effect context data.
27758     *
27759     * @ingroup Transit
27760     * @warning It is highly recommended just create a transit with this effect when
27761     * the window that the objects of the transit belongs has already been created.
27762     * This is because this effect needs the geometry information about the objects,
27763     * and if the window was not created yet, it can get a wrong information.
27764     */
27765    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27766
27767    /**
27768     * Add the Color Effect to Elm_Transit.
27769     *
27770     * @note This API is one of the facades. It creates color effect context
27771     * and add it's required APIs to elm_transit_effect_add.
27772     *
27773     * @see elm_transit_effect_add()
27774     *
27775     * @param transit        Transit object.
27776     * @param  from_r        RGB R when effect begins.
27777     * @param  from_g        RGB G when effect begins.
27778     * @param  from_b        RGB B when effect begins.
27779     * @param  from_a        RGB A when effect begins.
27780     * @param  to_r          RGB R when effect ends.
27781     * @param  to_g          RGB G when effect ends.
27782     * @param  to_b          RGB B when effect ends.
27783     * @param  to_a          RGB A when effect ends.
27784     * @return               Color effect context data.
27785     *
27786     * @ingroup Transit
27787     */
27788    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);
27789
27790    /**
27791     * Add the Fade Effect to Elm_Transit.
27792     *
27793     * @note This API is one of the facades. It creates fade effect context
27794     * and add it's required APIs to elm_transit_effect_add.
27795     * @note This effect is applied to each pair of objects in the order they are listed
27796     * in the transit list of objects. The first object in the pair will be the
27797     * "before" object and the second will be the "after" object.
27798     *
27799     * @see elm_transit_effect_add()
27800     *
27801     * @param transit Transit object.
27802     * @return Fade effect context data.
27803     *
27804     * @ingroup Transit
27805     * @warning It is highly recommended just create a transit with this effect when
27806     * the window that the objects of the transit belongs has already been created.
27807     * This is because this effect needs the color information about the objects,
27808     * and if the window was not created yet, it can get a wrong information.
27809     */
27810    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27811
27812    /**
27813     * Add the Blend Effect to Elm_Transit.
27814     *
27815     * @note This API is one of the facades. It creates blend effect context
27816     * and add it's required APIs to elm_transit_effect_add.
27817     * @note This effect is applied to each pair of objects in the order they are listed
27818     * in the transit list of objects. The first object in the pair will be the
27819     * "before" object and the second will be the "after" object.
27820     *
27821     * @see elm_transit_effect_add()
27822     *
27823     * @param transit Transit object.
27824     * @return Blend effect context data.
27825     *
27826     * @ingroup Transit
27827     * @warning It is highly recommended just create a transit with this effect when
27828     * the window that the objects of the transit belongs has already been created.
27829     * This is because this effect needs the color information about the objects,
27830     * and if the window was not created yet, it can get a wrong information.
27831     */
27832    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27833
27834    /**
27835     * Add the Rotation Effect to Elm_Transit.
27836     *
27837     * @note This API is one of the facades. It creates rotation effect context
27838     * and add it's required APIs to elm_transit_effect_add.
27839     *
27840     * @see elm_transit_effect_add()
27841     *
27842     * @param transit Transit object.
27843     * @param from_degree Degree when effect begins.
27844     * @param to_degree Degree when effect is ends.
27845     * @return Rotation effect context data.
27846     *
27847     * @ingroup Transit
27848     * @warning It is highly recommended just create a transit with this effect when
27849     * the window that the objects of the transit belongs has already been created.
27850     * This is because this effect needs the geometry information about the objects,
27851     * and if the window was not created yet, it can get a wrong information.
27852     */
27853    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27854
27855    /**
27856     * Add the ImageAnimation Effect to Elm_Transit.
27857     *
27858     * @note This API is one of the facades. It creates image animation effect context
27859     * and add it's required APIs to elm_transit_effect_add.
27860     * The @p images parameter is a list images paths. This list and
27861     * its contents will be deleted at the end of the effect by
27862     * elm_transit_effect_image_animation_context_free() function.
27863     *
27864     * Example:
27865     * @code
27866     * char buf[PATH_MAX];
27867     * Eina_List *images = NULL;
27868     * Elm_Transit *transi = elm_transit_add();
27869     *
27870     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27871     * images = eina_list_append(images, eina_stringshare_add(buf));
27872     *
27873     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27874     * images = eina_list_append(images, eina_stringshare_add(buf));
27875     * elm_transit_effect_image_animation_add(transi, images);
27876     *
27877     * @endcode
27878     *
27879     * @see elm_transit_effect_add()
27880     *
27881     * @param transit Transit object.
27882     * @param images Eina_List of images file paths. This list and
27883     * its contents will be deleted at the end of the effect by
27884     * elm_transit_effect_image_animation_context_free() function.
27885     * @return Image Animation effect context data.
27886     *
27887     * @ingroup Transit
27888     */
27889    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27890    /**
27891     * @}
27892     */
27893
27894    /* Store */
27895    typedef struct _Elm_Store                      Elm_Store;
27896    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
27897    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27898    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27899    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
27900    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27901    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27902    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27903    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27904    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27905    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27906    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27907    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27908
27909    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27910    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27911    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27912    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27913    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27914    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27915    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27916
27917    typedef enum
27918      {
27919         ELM_STORE_ITEM_MAPPING_NONE = 0,
27920         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27921         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27922         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27923         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27924         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27925         // can add more here as needed by common apps
27926         ELM_STORE_ITEM_MAPPING_LAST
27927      } Elm_Store_Item_Mapping_Type;
27928
27929    struct _Elm_Store_Item_Mapping_Icon
27930      {
27931         // FIXME: allow edje file icons
27932         int                   w, h;
27933         Elm_Icon_Lookup_Order lookup_order;
27934         Eina_Bool             standard_name : 1;
27935         Eina_Bool             no_scale : 1;
27936         Eina_Bool             smooth : 1;
27937         Eina_Bool             scale_up : 1;
27938         Eina_Bool             scale_down : 1;
27939      };
27940
27941    struct _Elm_Store_Item_Mapping_Empty
27942      {
27943         Eina_Bool             dummy;
27944      };
27945
27946    struct _Elm_Store_Item_Mapping_Photo
27947      {
27948         int                   size;
27949      };
27950
27951    struct _Elm_Store_Item_Mapping_Custom
27952      {
27953         Elm_Store_Item_Mapping_Cb func;
27954      };
27955
27956    struct _Elm_Store_Item_Mapping
27957      {
27958         Elm_Store_Item_Mapping_Type     type;
27959         const char                     *part;
27960         int                             offset;
27961         union
27962           {
27963              Elm_Store_Item_Mapping_Empty  empty;
27964              Elm_Store_Item_Mapping_Icon   icon;
27965              Elm_Store_Item_Mapping_Photo  photo;
27966              Elm_Store_Item_Mapping_Custom custom;
27967              // add more types here
27968           } details;
27969      };
27970
27971    struct _Elm_Store_Item_Info
27972      {
27973         int                           index;
27974         int                           item_type;
27975         int                           group_index;
27976         Eina_Bool                     rec_item;
27977         int                           pre_group_index;
27978
27979         Elm_Genlist_Item_Class       *item_class;
27980         const Elm_Store_Item_Mapping *mapping;
27981         void                         *data;
27982         char                         *sort_id;
27983      };
27984
27985    struct _Elm_Store_Item_Info_Filesystem
27986      {
27987         Elm_Store_Item_Info  base;
27988         char                *path;
27989      };
27990
27991 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27992 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27993
27994    /**
27995     * dbsystem Store object
27996     *
27997     * @addtogroup DBStore
27998     * @{
27999     *
28000     * @return The new object or NULL if it cannot be created
28001     */
28002    EAPI Elm_Store              *elm_store_dbsystem_new(void);
28003    /**
28004     * Sets the item count of a store
28005     *
28006     * @param st The store object
28007     * @param count The item count of an store
28008     */
28009    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
28010    /**
28011     * Set the select func that select the state of a list item whether true or false
28012     *
28013     * @param st The store object
28014     * @param func The select cb function of an store
28015     * @param data The new data pointer to set
28016     */
28017    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
28018    /**
28019     * Sets the sort func that sort the item with a next in the list
28020     *
28021     * @param st The store object
28022     * @param func The sort cb function of an store
28023     * @param data The new data pointer to set
28024     */
28025    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
28026    /**
28027     * Set the store item free func
28028     *
28029     * @param st The store object
28030     * @param func The free cb function of an store
28031     * @param data The new data pointer to set
28032     */
28033    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
28034    /**
28035     * Get the item index that included header items
28036     *
28037     * @param sti The store item object
28038     * @return The item index in genlist
28039     */
28040    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28041    /**
28042     * Get the DB pointer of an item
28043     *
28044     * @param sti The store item object
28045     * @return The DB pointer of item
28046     */
28047    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28048    /**
28049     * Set the DB pointer of an item
28050     *
28051     * @param sti The store item object
28052     * @parm p_db The DB pointer of item
28053     */
28054    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
28055    /**
28056     */
28057    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28058    /**
28059     * Append the item to the genlist
28060     *
28061     * @param st The store object
28062     * @param info The store item info dbsystem object
28063     * @return The item of store
28064     */
28065    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
28066    /**
28067     * Realize the visible items to the screen
28068     *
28069     * @param st The store object
28070     */
28071    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28072    /**
28073     * Realize the item to the screen
28074     *
28075     * @param sti The store item object
28076     */
28077    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
28078    /**
28079     * Delete the item of genlist
28080     *
28081     * @param sti The store item object
28082     */
28083    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28084    EAPI void                    elm_store_free(Elm_Store *st);
28085    EAPI Elm_Store              *elm_store_filesystem_new(void);
28086    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
28087    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28088    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28089
28090    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
28091
28092    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
28093    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28094    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28095    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28096    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
28097    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28098
28099    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28100    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
28101    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28102    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
28103    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28104    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28105    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28106    /**
28107     * @}
28108     */
28109
28110    /**
28111     * @defgroup SegmentControl SegmentControl
28112     * @ingroup Elementary
28113     *
28114     * @image html img/widget/segment_control/preview-00.png
28115     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
28116     *
28117     * @image html img/segment_control.png
28118     * @image latex img/segment_control.eps width=\textwidth
28119     *
28120     * Segment control widget is a horizontal control made of multiple segment
28121     * items, each segment item functioning similar to discrete two state button.
28122     * A segment control groups the items together and provides compact
28123     * single button with multiple equal size segments.
28124     *
28125     * Segment item size is determined by base widget
28126     * size and the number of items added.
28127     * Only one segment item can be at selected state. A segment item can display
28128     * combination of Text and any Evas_Object like Images or other widget.
28129     *
28130     * Smart callbacks one can listen to:
28131     * - "changed" - When the user clicks on a segment item which is not
28132     *   previously selected and get selected. The event_info parameter is the
28133     *   segment item pointer.
28134     *
28135     * Available styles for it:
28136     * - @c "default"
28137     *
28138     * Here is an example on its usage:
28139     * @li @ref segment_control_example
28140     */
28141
28142    /**
28143     * @addtogroup SegmentControl
28144     * @{
28145     */
28146
28147    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28148
28149    /**
28150     * Add a new segment control widget to the given parent Elementary
28151     * (container) object.
28152     *
28153     * @param parent The parent object.
28154     * @return a new segment control widget handle or @c NULL, on errors.
28155     *
28156     * This function inserts a new segment control widget on the canvas.
28157     *
28158     * @ingroup SegmentControl
28159     */
28160    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28161
28162    /**
28163     * Append a new item to the segment control object.
28164     *
28165     * @param obj The segment control object.
28166     * @param icon The icon object to use for the left side of the item. An
28167     * icon can be any Evas object, but usually it is an icon created
28168     * with elm_icon_add().
28169     * @param label The label of the item.
28170     *        Note that, NULL is different from empty string "".
28171     * @return The created item or @c NULL upon failure.
28172     *
28173     * A new item will be created and appended to the segment control, i.e., will
28174     * be set as @b last item.
28175     *
28176     * If it should be inserted at another position,
28177     * elm_segment_control_item_insert_at() should be used instead.
28178     *
28179     * Items created with this function can be deleted with function
28180     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28181     *
28182     * @note @p label set to @c NULL is different from empty string "".
28183     * If an item
28184     * only has icon, it will be displayed bigger and centered. If it has
28185     * icon and label, even that an empty string, icon will be smaller and
28186     * positioned at left.
28187     *
28188     * Simple example:
28189     * @code
28190     * sc = elm_segment_control_add(win);
28191     * ic = elm_icon_add(win);
28192     * elm_icon_file_set(ic, "path/to/image", NULL);
28193     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28194     * elm_segment_control_item_add(sc, ic, "label");
28195     * evas_object_show(sc);
28196     * @endcode
28197     *
28198     * @see elm_segment_control_item_insert_at()
28199     * @see elm_segment_control_item_del()
28200     *
28201     * @ingroup SegmentControl
28202     */
28203    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28204
28205    /**
28206     * Insert a new item to the segment control object at specified position.
28207     *
28208     * @param obj The segment control object.
28209     * @param icon The icon object to use for the left side of the item. An
28210     * icon can be any Evas object, but usually it is an icon created
28211     * with elm_icon_add().
28212     * @param label The label of the item.
28213     * @param index Item position. Value should be between 0 and items count.
28214     * @return The created item or @c NULL upon failure.
28215
28216     * Index values must be between @c 0, when item will be prepended to
28217     * segment control, and items count, that can be get with
28218     * elm_segment_control_item_count_get(), case when item will be appended
28219     * to segment control, just like elm_segment_control_item_add().
28220     *
28221     * Items created with this function can be deleted with function
28222     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28223     *
28224     * @note @p label set to @c NULL is different from empty string "".
28225     * If an item
28226     * only has icon, it will be displayed bigger and centered. If it has
28227     * icon and label, even that an empty string, icon will be smaller and
28228     * positioned at left.
28229     *
28230     * @see elm_segment_control_item_add()
28231     * @see elm_segment_control_item_count_get()
28232     * @see elm_segment_control_item_del()
28233     *
28234     * @ingroup SegmentControl
28235     */
28236    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);
28237
28238    /**
28239     * Remove a segment control item from its parent, deleting it.
28240     *
28241     * @param it The item to be removed.
28242     *
28243     * Items can be added with elm_segment_control_item_add() or
28244     * elm_segment_control_item_insert_at().
28245     *
28246     * @ingroup SegmentControl
28247     */
28248    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28249
28250    /**
28251     * Remove a segment control item at given index from its parent,
28252     * deleting it.
28253     *
28254     * @param obj The segment control object.
28255     * @param index The position of the segment control item to be deleted.
28256     *
28257     * Items can be added with elm_segment_control_item_add() or
28258     * elm_segment_control_item_insert_at().
28259     *
28260     * @ingroup SegmentControl
28261     */
28262    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28263
28264    /**
28265     * Get the Segment items count from segment control.
28266     *
28267     * @param obj The segment control object.
28268     * @return Segment items count.
28269     *
28270     * It will just return the number of items added to segment control @p obj.
28271     *
28272     * @ingroup SegmentControl
28273     */
28274    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28275
28276    /**
28277     * Get the item placed at specified index.
28278     *
28279     * @param obj The segment control object.
28280     * @param index The index of the segment item.
28281     * @return The segment control item or @c NULL on failure.
28282     *
28283     * Index is the position of an item in segment control widget. Its
28284     * range is from @c 0 to <tt> count - 1 </tt>.
28285     * Count is the number of items, that can be get with
28286     * elm_segment_control_item_count_get().
28287     *
28288     * @ingroup SegmentControl
28289     */
28290    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28291
28292    /**
28293     * Get the label of item.
28294     *
28295     * @param obj The segment control object.
28296     * @param index The index of the segment item.
28297     * @return The label of the item at @p index.
28298     *
28299     * The return value is a pointer to the label associated to the item when
28300     * it was created, with function elm_segment_control_item_add(), or later
28301     * with function elm_segment_control_item_label_set. If no label
28302     * was passed as argument, it will return @c NULL.
28303     *
28304     * @see elm_segment_control_item_label_set() for more details.
28305     * @see elm_segment_control_item_add()
28306     *
28307     * @ingroup SegmentControl
28308     */
28309    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28310
28311    /**
28312     * Set the label of item.
28313     *
28314     * @param it The item of segment control.
28315     * @param text The label of item.
28316     *
28317     * The label to be displayed by the item.
28318     * Label will be at right of the icon (if set).
28319     *
28320     * If a label was passed as argument on item creation, with function
28321     * elm_control_segment_item_add(), it will be already
28322     * displayed by the item.
28323     *
28324     * @see elm_segment_control_item_label_get()
28325     * @see elm_segment_control_item_add()
28326     *
28327     * @ingroup SegmentControl
28328     */
28329    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28330
28331    /**
28332     * Get the icon associated to the item.
28333     *
28334     * @param obj The segment control object.
28335     * @param index The index of the segment item.
28336     * @return The left side icon associated to the item at @p index.
28337     *
28338     * The return value is a pointer to the icon associated to the item when
28339     * it was created, with function elm_segment_control_item_add(), or later
28340     * with function elm_segment_control_item_icon_set(). If no icon
28341     * was passed as argument, it will return @c NULL.
28342     *
28343     * @see elm_segment_control_item_add()
28344     * @see elm_segment_control_item_icon_set()
28345     *
28346     * @ingroup SegmentControl
28347     */
28348    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28349
28350    /**
28351     * Set the icon associated to the item.
28352     *
28353     * @param it The segment control item.
28354     * @param icon The icon object to associate with @p it.
28355     *
28356     * The icon object to use at left side of the item. An
28357     * icon can be any Evas object, but usually it is an icon created
28358     * with elm_icon_add().
28359     *
28360     * Once the icon object is set, a previously set one will be deleted.
28361     * @warning Setting the same icon for two items will cause the icon to
28362     * dissapear from the first item.
28363     *
28364     * If an icon was passed as argument on item creation, with function
28365     * elm_segment_control_item_add(), it will be already
28366     * associated to the item.
28367     *
28368     * @see elm_segment_control_item_add()
28369     * @see elm_segment_control_item_icon_get()
28370     *
28371     * @ingroup SegmentControl
28372     */
28373    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28374
28375    /**
28376     * Get the index of an item.
28377     *
28378     * @param it The segment control item.
28379     * @return The position of item in segment control widget.
28380     *
28381     * Index is the position of an item in segment control widget. Its
28382     * range is from @c 0 to <tt> count - 1 </tt>.
28383     * Count is the number of items, that can be get with
28384     * elm_segment_control_item_count_get().
28385     *
28386     * @ingroup SegmentControl
28387     */
28388    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28389
28390    /**
28391     * Get the base object of the item.
28392     *
28393     * @param it The segment control item.
28394     * @return The base object associated with @p it.
28395     *
28396     * Base object is the @c Evas_Object that represents that item.
28397     *
28398     * @ingroup SegmentControl
28399     */
28400    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28401
28402    /**
28403     * Get the selected item.
28404     *
28405     * @param obj The segment control object.
28406     * @return The selected item or @c NULL if none of segment items is
28407     * selected.
28408     *
28409     * The selected item can be unselected with function
28410     * elm_segment_control_item_selected_set().
28411     *
28412     * The selected item always will be highlighted on segment control.
28413     *
28414     * @ingroup SegmentControl
28415     */
28416    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28417
28418    /**
28419     * Set the selected state of an item.
28420     *
28421     * @param it The segment control item
28422     * @param select The selected state
28423     *
28424     * This sets the selected state of the given item @p it.
28425     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28426     *
28427     * If a new item is selected the previosly selected will be unselected.
28428     * Previoulsy selected item can be get with function
28429     * elm_segment_control_item_selected_get().
28430     *
28431     * The selected item always will be highlighted on segment control.
28432     *
28433     * @see elm_segment_control_item_selected_get()
28434     *
28435     * @ingroup SegmentControl
28436     */
28437    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28438
28439    /**
28440     * @}
28441     */
28442
28443    /**
28444     * @defgroup Grid Grid
28445     *
28446     * The grid is a grid layout widget that lays out a series of children as a
28447     * fixed "grid" of widgets using a given percentage of the grid width and
28448     * height each using the child object.
28449     *
28450     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28451     * widgets size itself. The default is 100 x 100, so that means the
28452     * position and sizes of children will effectively be percentages (0 to 100)
28453     * of the width or height of the grid widget
28454     *
28455     * @{
28456     */
28457
28458    /**
28459     * Add a new grid to the parent
28460     *
28461     * @param parent The parent object
28462     * @return The new object or NULL if it cannot be created
28463     *
28464     * @ingroup Grid
28465     */
28466    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28467
28468    /**
28469     * Set the virtual size of the grid
28470     *
28471     * @param obj The grid object
28472     * @param w The virtual width of the grid
28473     * @param h The virtual height of the grid
28474     *
28475     * @ingroup Grid
28476     */
28477    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28478
28479    /**
28480     * Get the virtual size of the grid
28481     *
28482     * @param obj The grid object
28483     * @param w Pointer to integer to store the virtual width of the grid
28484     * @param h Pointer to integer to store the virtual height of the grid
28485     *
28486     * @ingroup Grid
28487     */
28488    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28489
28490    /**
28491     * Pack child at given position and size
28492     *
28493     * @param obj The grid object
28494     * @param subobj The child to pack
28495     * @param x The virtual x coord at which to pack it
28496     * @param y The virtual y coord at which to pack it
28497     * @param w The virtual width at which to pack it
28498     * @param h The virtual height at which to pack it
28499     *
28500     * @ingroup Grid
28501     */
28502    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28503
28504    /**
28505     * Unpack a child from a grid object
28506     *
28507     * @param obj The grid object
28508     * @param subobj The child to unpack
28509     *
28510     * @ingroup Grid
28511     */
28512    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28513
28514    /**
28515     * Faster way to remove all child objects from a grid object.
28516     *
28517     * @param obj The grid object
28518     * @param clear If true, it will delete just removed children
28519     *
28520     * @ingroup Grid
28521     */
28522    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28523
28524    /**
28525     * Set packing of an existing child at to position and size
28526     *
28527     * @param subobj The child to set packing of
28528     * @param x The virtual x coord at which to pack it
28529     * @param y The virtual y coord at which to pack it
28530     * @param w The virtual width at which to pack it
28531     * @param h The virtual height at which to pack it
28532     *
28533     * @ingroup Grid
28534     */
28535    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28536
28537    /**
28538     * get packing of a child
28539     *
28540     * @param subobj The child to query
28541     * @param x Pointer to integer to store the virtual x coord
28542     * @param y Pointer to integer to store the virtual y coord
28543     * @param w Pointer to integer to store the virtual width
28544     * @param h Pointer to integer to store the virtual height
28545     *
28546     * @ingroup Grid
28547     */
28548    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28549
28550    /**
28551     * @}
28552     */
28553
28554    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28555    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28556    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28557    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28558    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28559    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28560
28561    /**
28562     * @defgroup Video Video
28563     *
28564     * @addtogroup Video
28565     * @{
28566     *
28567     * Elementary comes with two object that help design application that need
28568     * to display video. The main one, Elm_Video, display a video by using Emotion.
28569     * It does embedded the video inside an Edje object, so you can do some
28570     * animation depending on the video state change. It does also implement a
28571     * ressource management policy to remove this burden from the application writer.
28572     *
28573     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28574     * It take care of updating its content according to Emotion event and provide a
28575     * way to theme itself. It also does automatically raise the priority of the
28576     * linked Elm_Video so it will use the video decoder if available. It also does
28577     * activate the remember function on the linked Elm_Video object.
28578     *
28579     * Signals that you can add callback for are :
28580     *
28581     * "forward,clicked" - the user clicked the forward button.
28582     * "info,clicked" - the user clicked the info button.
28583     * "next,clicked" - the user clicked the next button.
28584     * "pause,clicked" - the user clicked the pause button.
28585     * "play,clicked" - the user clicked the play button.
28586     * "prev,clicked" - the user clicked the prev button.
28587     * "rewind,clicked" - the user clicked the rewind button.
28588     * "stop,clicked" - the user clicked the stop button.
28589     * 
28590     * Default contents parts of the player widget that you can use for are:
28591     * @li "video" - A video of the player
28592     * 
28593     */
28594
28595    /**
28596     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28597     *
28598     * @param parent The parent object
28599     * @return a new player widget handle or @c NULL, on errors.
28600     *
28601     * This function inserts a new player widget on the canvas.
28602     *
28603     * @see elm_object_part_content_set()
28604     *
28605     * @ingroup Video
28606     */
28607    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28608
28609    /**
28610     * @brief Link a Elm_Payer with an Elm_Video object.
28611     *
28612     * @param player the Elm_Player object.
28613     * @param video The Elm_Video object.
28614     *
28615     * This mean that action on the player widget will affect the
28616     * video object and the state of the video will be reflected in
28617     * the player itself.
28618     *
28619     * @see elm_player_add()
28620     * @see elm_video_add()
28621     * @deprecated use elm_object_part_content_set() instead
28622     *
28623     * @ingroup Video
28624     */
28625    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28626
28627    /**
28628     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28629     *
28630     * @param parent The parent object
28631     * @return a new video widget handle or @c NULL, on errors.
28632     *
28633     * This function inserts a new video widget on the canvas.
28634     *
28635     * @seeelm_video_file_set()
28636     * @see elm_video_uri_set()
28637     *
28638     * @ingroup Video
28639     */
28640    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28641
28642    /**
28643     * @brief Define the file that will be the video source.
28644     *
28645     * @param video The video object to define the file for.
28646     * @param filename The file to target.
28647     *
28648     * This function will explicitly define a filename as a source
28649     * for the video of the Elm_Video object.
28650     *
28651     * @see elm_video_uri_set()
28652     * @see elm_video_add()
28653     * @see elm_player_add()
28654     *
28655     * @ingroup Video
28656     */
28657    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28658
28659    /**
28660     * @brief Define the uri that will be the video source.
28661     *
28662     * @param video The video object to define the file for.
28663     * @param uri The uri to target.
28664     *
28665     * This function will define an uri as a source for the video of the
28666     * Elm_Video object. URI could be remote source of video, like http:// or local source
28667     * like for example WebCam who are most of the time v4l2:// (but that depend and
28668     * you should use Emotion API to request and list the available Webcam on your system).
28669     *
28670     * @see elm_video_file_set()
28671     * @see elm_video_add()
28672     * @see elm_player_add()
28673     *
28674     * @ingroup Video
28675     */
28676    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28677
28678    /**
28679     * @brief Get the underlying Emotion object.
28680     *
28681     * @param video The video object to proceed the request on.
28682     * @return the underlying Emotion object.
28683     *
28684     * @ingroup Video
28685     */
28686    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28687
28688    /**
28689     * @brief Start to play the video
28690     *
28691     * @param video The video object to proceed the request on.
28692     *
28693     * Start to play the video and cancel all suspend state.
28694     *
28695     * @ingroup Video
28696     */
28697    EAPI void elm_video_play(Evas_Object *video);
28698
28699    /**
28700     * @brief Pause the video
28701     *
28702     * @param video The video object to proceed the request on.
28703     *
28704     * Pause the video and start a timer to trigger suspend mode.
28705     *
28706     * @ingroup Video
28707     */
28708    EAPI void elm_video_pause(Evas_Object *video);
28709
28710    /**
28711     * @brief Stop the video
28712     *
28713     * @param video The video object to proceed the request on.
28714     *
28715     * Stop the video and put the emotion in deep sleep mode.
28716     *
28717     * @ingroup Video
28718     */
28719    EAPI void elm_video_stop(Evas_Object *video);
28720
28721    /**
28722     * @brief Is the video actually playing.
28723     *
28724     * @param video The video object to proceed the request on.
28725     * @return EINA_TRUE if the video is actually playing.
28726     *
28727     * You should consider watching event on the object instead of polling
28728     * the object state.
28729     *
28730     * @ingroup Video
28731     */
28732    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28733
28734    /**
28735     * @brief Is it possible to seek inside the video.
28736     *
28737     * @param video The video object to proceed the request on.
28738     * @return EINA_TRUE if is possible to seek inside the video.
28739     *
28740     * @ingroup Video
28741     */
28742    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28743
28744    /**
28745     * @brief Is the audio muted.
28746     *
28747     * @param video The video object to proceed the request on.
28748     * @return EINA_TRUE if the audio is muted.
28749     *
28750     * @ingroup Video
28751     */
28752    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28753
28754    /**
28755     * @brief Change the mute state of the Elm_Video object.
28756     *
28757     * @param video The video object to proceed the request on.
28758     * @param mute The new mute state.
28759     *
28760     * @ingroup Video
28761     */
28762    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28763
28764    /**
28765     * @brief Get the audio level of the current video.
28766     *
28767     * @param video The video object to proceed the request on.
28768     * @return the current audio level.
28769     *
28770     * @ingroup Video
28771     */
28772    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28773
28774    /**
28775     * @brief Set the audio level of anElm_Video object.
28776     *
28777     * @param video The video object to proceed the request on.
28778     * @param volume The new audio volume.
28779     *
28780     * @ingroup Video
28781     */
28782    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28783
28784    EAPI double elm_video_play_position_get(const Evas_Object *video);
28785    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28786    EAPI double elm_video_play_length_get(const Evas_Object *video);
28787    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28788    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28789    EAPI const char *elm_video_title_get(const Evas_Object *video);
28790    /**
28791     * @}
28792     */
28793
28794    // FIXME: incomplete - carousel. don't use this until this comment is removed
28795    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28796    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
28797    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28798    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
28799    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
28800    /* smart callbacks called:
28801     * "clicked" - when the user clicks on a carousel item and becomes selected
28802     */
28803
28804    /* datefield */
28805
28806    typedef enum _Elm_Datefield_ItemType
28807      {
28808         ELM_DATEFIELD_YEAR = 0,
28809         ELM_DATEFIELD_MONTH,
28810         ELM_DATEFIELD_DATE,
28811         ELM_DATEFIELD_HOUR,
28812         ELM_DATEFIELD_MINUTE,
28813         ELM_DATEFIELD_AMPM
28814      } Elm_Datefield_ItemType;
28815
28816    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28817    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28818    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
28819    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28820    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28821    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28822    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28823    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28824    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28825    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28826    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28827    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28828    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28829  
28830    /* smart callbacks called:
28831    * "changed" - when datefield value is changed, this signal is sent.
28832    */
28833
28834 ////////////////////// DEPRECATED ///////////////////////////////////
28835
28836    typedef enum _Elm_Datefield_Layout
28837      {
28838         ELM_DATEFIELD_LAYOUT_TIME,
28839         ELM_DATEFIELD_LAYOUT_DATE,
28840         ELM_DATEFIELD_LAYOUT_DATEANDTIME
28841      } Elm_Datefield_Layout;
28842
28843    EINA_DEPRECATED EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28844    EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28845    EINA_DEPRECATED EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28846    EINA_DEPRECATED EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
28847    EINA_DEPRECATED EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28848    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
28849    EINA_DEPRECATED EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28850    EINA_DEPRECATED EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28851    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28852    EINA_DEPRECATED EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28853    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28854    EINA_DEPRECATED EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28855    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);
28856    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28857 /////////////////////////////////////////////////////////////////////
28858
28859    /* popup */
28860    typedef enum _Elm_Popup_Response
28861      {
28862         ELM_POPUP_RESPONSE_NONE = -1,
28863         ELM_POPUP_RESPONSE_TIMEOUT = -2,
28864         ELM_POPUP_RESPONSE_OK = -3,
28865         ELM_POPUP_RESPONSE_CANCEL = -4,
28866         ELM_POPUP_RESPONSE_CLOSE = -5
28867      } Elm_Popup_Response;
28868
28869    typedef enum _Elm_Popup_Mode
28870      {
28871         ELM_POPUP_TYPE_NONE = 0,
28872         ELM_POPUP_TYPE_ALERT = (1 << 0)
28873      } Elm_Popup_Mode;
28874
28875    typedef enum _Elm_Popup_Orient
28876      {
28877         ELM_POPUP_ORIENT_TOP,
28878         ELM_POPUP_ORIENT_CENTER,
28879         ELM_POPUP_ORIENT_BOTTOM,
28880         ELM_POPUP_ORIENT_LEFT,
28881         ELM_POPUP_ORIENT_RIGHT,
28882         ELM_POPUP_ORIENT_TOP_LEFT,
28883         ELM_POPUP_ORIENT_TOP_RIGHT,
28884         ELM_POPUP_ORIENT_BOTTOM_LEFT,
28885         ELM_POPUP_ORIENT_BOTTOM_RIGHT
28886      } Elm_Popup_Orient;
28887
28888    /* smart callbacks called:
28889     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28890     */
28891
28892    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28893    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
28894    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
28895    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
28896    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
28897    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28898    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28899    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28900    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28901    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
28902    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, ... );
28903    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
28904    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28905    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
28906    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28907    EAPI int          elm_popup_run(Evas_Object *obj);
28908
28909    /* NavigationBar */
28910    #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28911    #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28912
28913    typedef enum
28914      {
28915         ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28916         ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28917         ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28918         ELM_NAVIGATIONBAR_BACK_BUTTON
28919      } Elm_Navi_Button_Type;
28920
28921    EINA_DEPRECATED EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28922    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);
28923    EINA_DEPRECATED    EAPI void         elm_navigationbar_pop(Evas_Object *obj);
28924    EINA_DEPRECATED    EAPI void         elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28925    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28926    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28927    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28928    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28929    EINA_DEPRECATED    EAPI Eina_List   *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28930    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28931    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28932    EINA_DEPRECATED    EAPI void         elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28933    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28934    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28935    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28936    EINA_DEPRECATED    EAPI void         elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28937    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28938    EINA_DEPRECATED    EAPI void         elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28939    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28940    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28941    EINA_DEPRECATED    EAPI void         elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28942    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28943
28944    /* NavigationBar */
28945    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28946    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28947
28948    typedef enum
28949      {
28950         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28951         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28952         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28953         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28954         ELM_NAVIGATIONBAR_EX_MAX
28955      } Elm_Navi_ex_Button_Type;
28956    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28957
28958    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28959    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28960    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
28961    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28962    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28963    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28964    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28965    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28966    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28967    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);
28968    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28969    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28970    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28971    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28972    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28973    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28974    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28975    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28976    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28977    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28978    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28979    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28980    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28981    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28982    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28983    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28984    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28985    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28986
28987    /**
28988     * @defgroup Naviframe Naviframe
28989     * @ingroup Elementary
28990     *
28991     * @brief Naviframe is a kind of view manager for the applications.
28992     *
28993     * Naviframe provides functions to switch different pages with stack
28994     * mechanism. It means if one page(item) needs to be changed to the new one,
28995     * then naviframe would push the new page to it's internal stack. Of course,
28996     * it can be back to the previous page by popping the top page. Naviframe
28997     * provides some transition effect while the pages are switching (same as
28998     * pager).
28999     *
29000     * Since each item could keep the different styles, users could keep the
29001     * same look & feel for the pages or different styles for the items in it's
29002     * application.
29003     *
29004     * Signals that you can add callback for are:
29005     * @li "transition,finished" - When the transition is finished in changing
29006     *     the item
29007     * @li "title,clicked" - User clicked title area
29008     *
29009     * Default contents parts of the naviframe items that you can use for are:
29010     * @li "default" - A main content of the page
29011     * @li "icon" - A icon in the title area
29012     * @li "prev_btn" - A button to go to the previous page
29013     * @li "next_btn" - A button to go to the next page
29014     *
29015     * Default text parts of the naviframe items that you can use for are:
29016     * @li "default" - Title label in the title area
29017     * @li "subtitle" - Sub-title label in the title area
29018     *
29019     * @ref tutorial_naviframe gives a good overview of the usage of the API.
29020     */
29021
29022   //Available commonly
29023   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
29024   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
29025   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
29026   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
29027   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
29028   #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
29029   #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
29030   #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
29031   #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
29032   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
29033   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
29034   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
29035   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
29036   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
29037   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
29038   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
29039   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
29040
29041    //Available only in a style - "2line"
29042   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
29043
29044   //Available only in a style - "segment"
29045   #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
29046   #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
29047
29048    /**
29049     * @addtogroup Naviframe
29050     * @{
29051     */
29052
29053    /**
29054     * @brief Add a new Naviframe object to the parent.
29055     *
29056     * @param parent Parent object
29057     * @return New object or @c NULL, if it cannot be created
29058     *
29059     * @ingroup Naviframe
29060     */
29061    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29062    /**
29063     * @brief Push a new item to the top of the naviframe stack (and show it).
29064     *
29065     * @param obj The naviframe object
29066     * @param title_label The label in the title area. The name of the title
29067     *        label part is "elm.text.title"
29068     * @param prev_btn The button to go to the previous item. If it is NULL,
29069     *        then naviframe will create a back button automatically. The name of
29070     *        the prev_btn part is "elm.swallow.prev_btn"
29071     * @param next_btn The button to go to the next item. Or It could be just an
29072     *        extra function button. The name of the next_btn part is
29073     *        "elm.swallow.next_btn"
29074     * @param content The main content object. The name of content part is
29075     *        "elm.swallow.content"
29076     * @param item_style The current item style name. @c NULL would be default.
29077     * @return The created item or @c NULL upon failure.
29078     *
29079     * The item pushed becomes one page of the naviframe, this item will be
29080     * deleted when it is popped.
29081     *
29082     * @see also elm_naviframe_item_style_set()
29083     * @see also elm_naviframe_item_insert_before()
29084     * @see also elm_naviframe_item_insert_after()
29085     *
29086     * The following styles are available for this item:
29087     * @li @c "default"
29088     *
29089     * @ingroup Naviframe
29090     */
29091    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);
29092     /**
29093     * @brief Insert a new item into the naviframe before item @p before.
29094     *
29095     * @param before The naviframe item to insert before.
29096     * @param title_label The label in the title area. The name of the title
29097     *        label part is "elm.text.title"
29098     * @param prev_btn The button to go to the previous item. If it is NULL,
29099     *        then naviframe will create a back button automatically. The name of
29100     *        the prev_btn part is "elm.swallow.prev_btn"
29101     * @param next_btn The button to go to the next item. Or It could be just an
29102     *        extra function button. The name of the next_btn part is
29103     *        "elm.swallow.next_btn"
29104     * @param content The main content object. The name of content part is
29105     *        "elm.swallow.content"
29106     * @param item_style The current item style name. @c NULL would be default.
29107     * @return The created item or @c NULL upon failure.
29108     *
29109     * The item is inserted into the naviframe straight away without any
29110     * transition operations. This item will be deleted when it is popped.
29111     *
29112     * @see also elm_naviframe_item_style_set()
29113     * @see also elm_naviframe_item_push()
29114     * @see also elm_naviframe_item_insert_after()
29115     *
29116     * The following styles are available for this item:
29117     * @li @c "default"
29118     *
29119     * @ingroup Naviframe
29120     */
29121    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);
29122    /**
29123     * @brief Insert a new item into the naviframe after item @p after.
29124     *
29125     * @param after The naviframe item to insert after.
29126     * @param title_label The label in the title area. The name of the title
29127     *        label part is "elm.text.title"
29128     * @param prev_btn The button to go to the previous item. If it is NULL,
29129     *        then naviframe will create a back button automatically. The name of
29130     *        the prev_btn part is "elm.swallow.prev_btn"
29131     * @param next_btn The button to go to the next item. Or It could be just an
29132     *        extra function button. The name of the next_btn part is
29133     *        "elm.swallow.next_btn"
29134     * @param content The main content object. The name of content part is
29135     *        "elm.swallow.content"
29136     * @param item_style The current item style name. @c NULL would be default.
29137     * @return The created item or @c NULL upon failure.
29138     *
29139     * The item is inserted into the naviframe straight away without any
29140     * transition operations. This item will be deleted when it is popped.
29141     *
29142     * @see also elm_naviframe_item_style_set()
29143     * @see also elm_naviframe_item_push()
29144     * @see also elm_naviframe_item_insert_before()
29145     *
29146     * The following styles are available for this item:
29147     * @li @c "default"
29148     *
29149     * @ingroup Naviframe
29150     */
29151    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);
29152    /**
29153     * @brief Pop an item that is on top of the stack
29154     *
29155     * @param obj The naviframe object
29156     * @return @c NULL or the content object(if the
29157     *         elm_naviframe_content_preserve_on_pop_get is true).
29158     *
29159     * This pops an item that is on the top(visible) of the naviframe, makes it
29160     * disappear, then deletes the item. The item that was underneath it on the
29161     * stack will become visible.
29162     *
29163     * @see also elm_naviframe_content_preserve_on_pop_get()
29164     *
29165     * @ingroup Naviframe
29166     */
29167    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29168    /**
29169     * @brief Pop the items between the top and the above one on the given item.
29170     *
29171     * @param it The naviframe item
29172     *
29173     * @ingroup Naviframe
29174     */
29175    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29176    /**
29177    * Promote an item already in the naviframe stack to the top of the stack
29178    *
29179    * @param it The naviframe item
29180    *
29181    * This will take the indicated item and promote it to the top of the stack
29182    * as if it had been pushed there. The item must already be inside the
29183    * naviframe stack to work.
29184    *
29185    */
29186    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29187    /**
29188     * @brief Delete the given item instantly.
29189     *
29190     * @param it The naviframe item
29191     *
29192     * This just deletes the given item from the naviframe item list instantly.
29193     * So this would not emit any signals for view transitions but just change
29194     * the current view if the given item is a top one.
29195     *
29196     * @ingroup Naviframe
29197     */
29198    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29199    /**
29200     * @brief preserve the content objects when items are popped.
29201     *
29202     * @param obj The naviframe object
29203     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29204     *
29205     * @see also elm_naviframe_content_preserve_on_pop_get()
29206     *
29207     * @ingroup Naviframe
29208     */
29209    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29210    /**
29211     * @brief Get a value whether preserve mode is enabled or not.
29212     *
29213     * @param obj The naviframe object
29214     * @return If @c EINA_TRUE, preserve mode is enabled
29215     *
29216     * @see also elm_naviframe_content_preserve_on_pop_set()
29217     *
29218     * @ingroup Naviframe
29219     */
29220    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29221    /**
29222     * @brief Get a top item on the naviframe stack
29223     *
29224     * @param obj The naviframe object
29225     * @return The top item on the naviframe stack or @c NULL, if the stack is
29226     *         empty
29227     *
29228     * @ingroup Naviframe
29229     */
29230    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29231    /**
29232     * @brief Get a bottom item on the naviframe stack
29233     *
29234     * @param obj The naviframe object
29235     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29236     *         empty
29237     *
29238     * @ingroup Naviframe
29239     */
29240    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29241    /**
29242     * @brief Set an item style
29243     *
29244     * @param obj The naviframe item
29245     * @param item_style The current item style name. @c NULL would be default
29246     *
29247     * The following styles are available for this item:
29248     * @li @c "default"
29249     *
29250     * @see also elm_naviframe_item_style_get()
29251     *
29252     * @ingroup Naviframe
29253     */
29254    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29255    /**
29256     * @brief Get an item style
29257     *
29258     * @param obj The naviframe item
29259     * @return The current item style name
29260     *
29261     * @see also elm_naviframe_item_style_set()
29262     *
29263     * @ingroup Naviframe
29264     */
29265    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29266    /**
29267     * @brief Show/Hide the title area
29268     *
29269     * @param it The naviframe item
29270     * @param visible If @c EINA_TRUE, title area will be visible, hidden
29271     *        otherwise
29272     *
29273     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
29274     *
29275     * @see also elm_naviframe_item_title_visible_get()
29276     *
29277     * @ingroup Naviframe
29278     */
29279    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29280    /**
29281     * @brief Get a value whether title area is visible or not.
29282     *
29283     * @param it The naviframe item
29284     * @return If @c EINA_TRUE, title area is visible
29285     *
29286     * @see also elm_naviframe_item_title_visible_set()
29287     *
29288     * @ingroup Naviframe
29289     */
29290    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29291
29292    /**
29293     * @brief Set creating prev button automatically or not
29294     *
29295     * @param obj The naviframe object
29296     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29297     *        be created internally when you pass the @c NULL to the prev_btn
29298     *        parameter in elm_naviframe_item_push
29299     *
29300     * @see also elm_naviframe_item_push()
29301     */
29302    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29303    /**
29304     * @brief Get a value whether prev button(back button) will be auto pushed or
29305     *        not.
29306     *
29307     * @param obj The naviframe object
29308     * @return If @c EINA_TRUE, prev button will be auto pushed.
29309     *
29310     * @see also elm_naviframe_item_push()
29311     *           elm_naviframe_prev_btn_auto_pushed_set()
29312     */
29313    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29314    /**
29315     * @brief Get a list of all the naviframe items.
29316     *
29317     * @param obj The naviframe object
29318     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29319     * or @c NULL on failure.
29320     */
29321    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29322
29323    /**
29324     * @}
29325     */
29326
29327    /**
29328     * @defgroup Controlbar Controlbar
29329     * @ingroup Elementary
29330     * @addtogroup Controlbar
29331     * @{
29332     *
29333     * This is a Controlbar. It can contain label and icon objects.
29334     * In edit mode, you can change the location of items.
29335     */
29336
29337    /* Control Bar */
29338    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29339    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29340    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29341    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29342    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29343    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29344    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29345    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29346    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29347
29348    typedef enum _Elm_Controlbar_Mode_Type
29349      {
29350         ELM_CONTROLBAR_MODE_DEFAULT = 0,
29351         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29352         ELM_CONTROLBAR_MODE_TRANSPARENCY,
29353         ELM_CONTROLBAR_MODE_LARGE,
29354         ELM_CONTROLBAR_MODE_SMALL,
29355         ELM_CONTROLBAR_MODE_LEFT,
29356         ELM_CONTROLBAR_MODE_RIGHT
29357      } Elm_Controlbar_Mode_Type;
29358
29359    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29360    /**
29361     * Add a new controlbar object
29362     *
29363     * @param parent The parent object
29364     * @return The new object or NULL if it cannot be created
29365     */
29366    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29367    /**
29368     * Append new tab item
29369     *
29370     * @param    obj The controlbar object
29371     * @param    icon_path The icon path of item
29372     * @param    label The label of item
29373     * @param    view The view of item
29374     * @return   The item of controlbar
29375     */
29376    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29377    /**
29378     * Prepend new tab item
29379     *
29380     * @param    obj The controlbar object
29381     * @param    icon_path The icon path of item
29382     * @param    label The label of item
29383     * @param    view The view of item
29384     * @return   The item of controlbar
29385     */
29386    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29387    /**
29388     * Insert new tab item before given item
29389     *
29390     * @param    obj The controlbar object
29391     * @param    before The given item
29392     * @param    icon_path The icon path of item
29393     * @param    label The label of item
29394     * @param    view The view of item
29395     * @return   The item of controlbar
29396     */
29397    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);
29398    /**
29399     * Insert new tab item after given item
29400     *
29401     * @param    obj The controlbar object
29402     * @param    after The given item
29403     * @param    icon_path The icon path of item
29404     * @param    label The label of item
29405     * @param    view The view of item
29406     * @return   The item of controlbar
29407     */
29408    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);
29409    /**
29410     * Append new tool item
29411     *
29412     * @param    obj The controlbar object
29413     * @param    icon_path The icon path of item
29414     * @param    label The label of item
29415     * @param    func Callback function of item
29416     * @param    data The data of callback function
29417     * @return   The item of controlbar
29418     */
29419    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);
29420    /**
29421     * Prepend new tool item
29422     *
29423     * @param    obj The controlbar object
29424     * @param    icon_path The icon path of item
29425     * @param    label The label of item
29426     * @param    func Callback function of item
29427     * @param    data The data of callback function
29428     * @return   The item of controlbar
29429     */
29430    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);
29431    /**
29432     * Insert new tool item before given item
29433     *
29434     * @param    obj The controlbar object
29435     * @param    before The given item
29436     * @param    icon_path The icon path of item
29437     * @param    label The label of item
29438     * @param    func Callback function of item
29439     * @param    data The data of callback function
29440     * @return   The item of controlbar
29441     */
29442    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);
29443    /**
29444     * Insert new tool item after given item
29445     *
29446     * @param    obj The controlbar object
29447     * @param    after The given item
29448     * @param    icon_path The icon path of item
29449     * @param    label The label of item
29450     * @param    func Callback function of item
29451     * @param    data The data of callback function
29452     * @return   The item of controlbar
29453     */
29454    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);
29455    /**
29456     * Append new object item
29457     *
29458     * @param    obj The controlbar object
29459     * @param    obj_item The object of item
29460     * @param    sel The number of sel occupied
29461     * @return  The item of controlbar
29462     */
29463    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29464    /**
29465     * Prepend new object item
29466     *
29467     * @param    obj The controlbar object
29468     * @param    obj_item The object of item
29469     * @param    sel The number of sel occupied
29470     * @return  The item of controlbar
29471     */
29472    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29473    /**
29474     * Insert new object item before given item
29475     *
29476     * @param    obj The controlbar object
29477     * @param    before The given item
29478     * @param    obj_item The object of item
29479     * @param    sel The number of sel occupied
29480     * @return  The item of controlbar
29481     */
29482    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29483    /**
29484     * Insert new object item after given item
29485     *
29486     * @param    obj The controlbar object
29487     * @param    after The given item
29488     * @param    obj_item The object of item
29489     * @param    sel The number of sel occupied
29490     * @return  The item of controlbar
29491     */
29492    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29493    /**
29494     * Get the object of the object item
29495     *
29496     * @param       it The item of controlbar
29497     * @return      The object of the object item
29498     */
29499    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29500    /**
29501     * Delete item from controlbar
29502     *
29503     * @param    it The item of controlbar
29504     */
29505    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
29506    /**
29507     * Select item in controlbar
29508     *
29509     * @param    it The item of controlbar
29510     */
29511    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
29512    /**
29513     * Set the visible status of item in bar
29514     *
29515     * @param    it The item of controlbar
29516     * @param    bar EINA_TRUE or EINA_FALSE
29517     */
29518    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29519    /**
29520     * Get the result which or not item is visible in bar
29521     *
29522     * @param    it The item of controlbar
29523     * @return   EINA_TRUE or EINA_FALSE
29524     */
29525    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29526    /**
29527     * Set item disable
29528     *
29529     * @param    it The item of controlbar
29530     * @param    bar EINA_TRUE or EINA_FALSE
29531     */
29532    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29533    /**
29534     * Get item disable
29535     *
29536     * @param    it The item of controlbar
29537     * @return   EINA_TRUE or EINA_FALSE
29538     */
29539    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29540    /**
29541     * Set the icon of item
29542     *
29543     * @param    it The item of controlbar
29544     * @param    icon_path The icon path of the item
29545     * @return   The icon object
29546     */
29547    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29548    /**
29549     * Get the icon of item
29550     *
29551     * @param    it The item of controlbar
29552     * @return   The icon object
29553     */
29554    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29555    /**
29556     * Set the label of item
29557     *
29558     * @param    it The item of controlbar
29559     * @param    label The label of item
29560     */
29561    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29562    /**
29563     * Get the label of item
29564     *
29565     * @param    it The item of controlbar
29566     * @return The label of item
29567     */
29568    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29569    /**
29570     * Get the selected item
29571     *
29572     * @param    obj The controlbar object
29573     * @return           The item of controlbar
29574     */
29575    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29576    /**
29577     * Get the first item
29578     *
29579     * @param    obj The controlbar object
29580     * @return           The item of controlbar
29581     */
29582    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29583    /**
29584     * Get the last item
29585     *
29586     * @param    obj The controlbar object
29587     * @return           The item of controlbar
29588     */
29589    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29590    /**
29591     * Get the items
29592     *
29593     * @param    obj The controlbar object
29594     * @return   The list of the items
29595     */
29596    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
29597    /**
29598     * Get the previous item
29599     *
29600     * @param    it The item of controlbar
29601     * @return   The previous item of the parameter item
29602     */
29603    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29604    /**
29605     * Get the next item
29606     *
29607     * @param    obj The controlbar object
29608     * @return   The next item of the parameter item
29609     */
29610    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29611    /**
29612     * Set the view of the item
29613     *
29614     * @param    it The item of controlbar
29615     * @param    view The view for the item
29616     */
29617    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29618    /**
29619     * Get the view of the item
29620     *
29621     * @param    it The item of controlbar
29622     * @return   The view for the item
29623     */
29624    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29625    /**
29626     * Unset the view of the item
29627     *
29628     * @param    it The item of controlbar
29629     * @return   The view for the item
29630     */
29631    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29632    /**
29633     * Set the vertical mode of the controlbar
29634     *
29635     * @param    obj The object of the controlbar
29636     * @param    vertical The vertical mode of the controlbar (TRUE = vertical, FALSE = horizontal)
29637     */
29638    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29639    /**
29640     * Set the mode of the controlbar
29641     *
29642     * @param    obj The object of the controlbar
29643     * @param    mode The mode of the controlbar
29644     */
29645    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
29646    /**
29647     * Set the alpha of the controlbar
29648     *
29649     * @param    obj The object of the controlbar
29650     * @param    alpha The alpha value of the controlbar (0-100)
29651     */
29652    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29653    /**
29654     * Set auto-align mode of the controlbar(It's not prepared yet)
29655     * If you set the auto-align and add items more than 5,
29656     * the "more" item will be made and the items more than 5 will be unvisible.
29657     *
29658     * @param    obj The object of the controlbar
29659     * @param    auto_align The dicision that the controlbar use the auto-align
29660     */
29661    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29662    /**
29663     * Get the button object of the item
29664     *
29665     * @param    it The item of controlbar
29666     * @return  button object of the item
29667     */
29668    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29669    /**
29670     * @}
29671     */
29672
29673
29674    /**
29675     * @defgroup Searchbar Searchbar
29676     * @addtogroup TickerNoti
29677     * @{
29678     * @ingroup Elementary
29679     *
29680     * This is Searchbar.
29681     * It can contain a simple entry and button object.
29682     */
29683
29684    /**
29685     * Add a new searchbar to the parent
29686     * @param parent The parent object
29687     * @return The new object or NULL if it cannot be created
29688     */
29689    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29690    /**
29691     * set the text of entry
29692     *
29693     * @param obj The searchbar object
29694     * @return void
29695     */
29696    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29697    /**
29698     * get the text of entry
29699     *
29700     * @param obj The searchbar object
29701     * @return string pointer of entry
29702     */
29703    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
29704    /**
29705     * get the pointer of entry
29706     *
29707     * @param obj The searchbar object
29708     * @return the entry object
29709     */
29710    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29711    /**
29712     * get the pointer of editfield
29713     *
29714     * @param obj The searchbar object
29715     * @return the editfield object
29716     */
29717    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29718    /**
29719     * set the cancel button animation flag
29720     *
29721     * @param obj The searchbar object
29722     * @param cancel_btn_ani_flag The flag of animating cancen button or not
29723     * @return void
29724     */
29725    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29726    /**
29727     * set the cancel button show mode
29728     *
29729     * @param obj The searchbar object
29730     * @param visible The flag of cancen button show or not
29731     * @return void
29732     */
29733    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29734    /**
29735     * clear searchbar status
29736     *
29737     * @param obj The searchbar object
29738     * @return void
29739     */
29740    EAPI void         elm_searchbar_clear(Evas_Object *obj);
29741    /**
29742     * set the searchbar boundary rect mode(with bg rect) set
29743     *
29744     * @param obj The searchbar object
29745     * @param boundary The present flag of boundary rect or not
29746     * @return void
29747     */
29748    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29749    /**
29750     * @}
29751     */
29752
29753    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29754    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29755    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29756    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29757
29758    /* NoContents */
29759    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29760    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
29761    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
29762    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29763    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29764
29765    /**
29766     * @defgroup TickerNoti TickerNoti
29767     * @addtogroup TickerNoti
29768     * @{
29769     *
29770     * This is a notification widget which can be used to display some short information.
29771     *
29772     * Parts which can be used with elm_object_text_part_set() and
29773     * elm_object_text_part_get():
29774     *
29775     * @li NULL/"default" - Operates on tickernoti content-text
29776     *
29777     * Parts which can be used with elm_object_content_part_set(),
29778     * elm_object_content_part_get() and elm_object_content_part_unset():
29779     *
29780     * @li "icon" - Operates on tickernoti's icon
29781     * @li "button" - Operates on tickernoti's button
29782     *
29783     * smart callbacks called:
29784     * @li "clicked" - emitted when tickernoti is clicked, except at the
29785     * swallow/button region, if any.
29786     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29787     * any hide animation, this signal is emitted after the animation.
29788     */
29789    typedef enum
29790      {
29791         ELM_TICKERNOTI_ORIENT_TOP = 0,
29792         ELM_TICKERNOTI_ORIENT_BOTTOM,
29793         ELM_TICKERNOTI_ORIENT_LAST
29794      }  Elm_Tickernoti_Orient;
29795
29796    /**
29797     * Add a tickernoti object to @p parent
29798     *
29799     * @param parent The parent object
29800     *
29801     * @return The tickernoti object, or NULL upon failure
29802     */
29803    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
29804    /**
29805     * Set the orientation of the tickernoti object
29806     *
29807     * @param obj The tickernoti object
29808     * @param orient The orientation of tickernoti object
29809     */
29810    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29811    /**
29812     * Get the orientation of the tickernoti object
29813     *
29814     * @param obj The tickernotil object
29815     * @return The orientation of tickernotil object
29816     */
29817    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29818    /**
29819     * Get the rotation of tickernoti object
29820     *
29821     * @param obj The tickernotil object
29822     * @return The rotation angle
29823     */
29824    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29825    /**
29826     * Set the rotation angle for the tickernoti object
29827     *
29828     * @param obj The tickernoti object
29829     * @param angle The rotation angle(in degree) will be used on the tickernoti object
29830     */
29831    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29832    /**
29833     * Get the view window(elm_win) on the tickernoti object
29834     *
29835     * @param obj The tickernotil object
29836     * @return internal view window(elm_win) object
29837     */
29838    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29839    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29840    /**
29841     * @deprecated
29842     */
29843    typedef enum
29844     {
29845        ELM_TICKERNOTI_DEFAULT,
29846        ELM_TICKERNOTI_DETAILVIEW
29847     } Elm_Tickernoti_Mode;
29848    /**
29849     * Set the detail label on the tickernoti object
29850     *
29851     * @param obj The tickernoti object
29852     * @param label The label will be used on the tickernoti object
29853     * @deprecated use elm_object_text_set() instead
29854     */
29855    WILL_DEPRECATE  EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29856    /**
29857     * Get the detail label used on the tickernoti object
29858     *
29859     * @param obj The tickernotil object
29860     * @return The string inside the label
29861     * @deprecated use elm_object_text_get() instead
29862     */
29863    WILL_DEPRECATE  EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29864    /**
29865     * Set the button object used on the tickernoti object
29866     *
29867     * @param obj The tickernotil object
29868     * @param button The button object will be used on the tickernoti object
29869     * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29870     */
29871    WILL_DEPRECATE  EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29872    /**
29873     * Get the button object used on the tickernoti object
29874     *
29875     * @param obj The tickernotil object
29876     * @return The button object inside the tickernoti
29877     * @deprecated use elm_object_content_part_get() instead with "button" as part name
29878     */
29879    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29880    /**
29881     * Set the detail icon object used on the tickernoti object
29882     *
29883     * @param obj The tickernotil object
29884     * @param icon The icon object will be used on the tickernoti object
29885     * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29886     */
29887    WILL_DEPRECATE  EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29888    /**
29889     * Get the detail icon object used on the tickernoti object
29890     *
29891     * @param obj The tickernotil object
29892     * @return The icon object inside the tickernoti
29893     * @deprecated use elm_object_content_part_get() instead with "icon" as part name
29894     */
29895    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29896    /**
29897     * Get the view mode on the tickernoti object
29898     *
29899     * @param obj The tickernotil object
29900     * @return The view mode
29901     * @deprecated removed as now styles are used instead
29902     */
29903    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29904    /**
29905     * Set the view mode used on the tickernoti object
29906     *
29907     * @param obj The tickernotil object
29908     * @param mode The view mode will be used on the tickernoti object
29909     * @deprecated removed as now styles are used instead
29910     */
29911    WILL_DEPRECATE  EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29912    /**
29913     * Get the detail view window(elm_win) on the tickernoti object
29914     *
29915     * @param obj The tickernotil object
29916     * @return detail view window(elm_win) object
29917     */
29918    WILL_DEPRECATE  EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29919    /**
29920     * Set the orientation of the tickernoti object
29921     *
29922     * @param obj The tickernoti object
29923     * @param orient The orientation of tickernoti object
29924     * @deprecated use elm_tickernoti_orient_set() instead
29925     */
29926    WILL_DEPRECATE  EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29927    /**
29928     * Get the orientation of the tickernoti object
29929     *
29930     * @param obj The tickernotil object
29931     * @return The orientation of tickernotil object
29932     * @deprecated use elm_tickernoti_orient_get() instead
29933     */
29934    WILL_DEPRECATE  EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29935    /**
29936     * Set the label on the tickernoti object
29937     *
29938     * @param obj The tickernoti object
29939     * @param label The label will be used on the tickernoti object
29940     * @deprecated use elm_object_text_get()
29941     */
29942    WILL_DEPRECATE  EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29943    /**
29944     * Get the label used on the tickernoti object
29945     *
29946     * @param obj The tickernotil object
29947     * @return The string inside the label
29948     * @deprecated use elm_object_text_get() instead
29949     */
29950    WILL_DEPRECATE  EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29951    /**
29952     * Set the icon object of the tickernoti object
29953     *
29954     * @param obj The tickernotil object
29955     * @param icon The icon object will be used on the tickernoti object
29956     * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29957     */
29958    WILL_DEPRECATE  EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29959    /**
29960     * Get the icon object of the tickernoti object
29961     *
29962     * @param obj The tickernotil object
29963     * @return The icon object inside the tickernoti
29964     * @deprecated use elm_object_content_part_get() instead with "icon" as part name
29965     */
29966    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29967    /**
29968     * Set the action button object used on the tickernoti object
29969     *
29970     * @param obj The tickernotil object
29971     * @param button The button object will be used on the tickernoti object
29972     * @deprecated use elm_object_content_part_set() instead with "button" as part name
29973     */
29974    WILL_DEPRECATE  EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29975    /**
29976     * Get the action button object used on the tickernoti object
29977     *
29978     * @param obj The tickernotil object
29979     * @return The button object inside the tickernoti
29980     * @deprecated use elm_object_content_part_get() instead with "button" as part name
29981     */
29982    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29983    /**
29984     * @}
29985     */
29986
29987    /**
29988     * @defgroup Colorpalette Colorpalette
29989     * @ingroup Elementary
29990     * @addtogroup Colorpalette
29991     * @{
29992     *
29993     * Using colorpalette, you can select a color by clicking
29994     * a color rectangle on the colorpalette.
29995     *
29996     * Smart callbacks that you can add are:
29997     *
29998     * clicked - This signal is sent when a color rectangle is clicked.
29999     */
30000    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
30001    struct _Colorpalette_Color
30002      {
30003         unsigned int r, g, b;
30004      };
30005
30006    /**
30007     * Add a new colorpalette to the parent.
30008     *
30009     * @param parent The parent object
30010     * @return The new object or NULL if it cannot be created
30011     *
30012     * @ingroup Colorpalette
30013     */
30014    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
30015    /**
30016     * Set colors to the colorpalette.
30017     *
30018     * @param obj   Colorpalette object
30019     * @param color_num     number of the colors on the colorpalette
30020     * @param color     Color lists
30021     */
30022    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
30023    /**
30024     * Set row/column value for the colorpalette.
30025     *
30026     * @param obj   Colorpalette object
30027     * @param row   row value for the colorpalette
30028     * @param col   column value for the colorpalette
30029     */
30030    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
30031
30032    /**
30033     * @}
30034     */
30035
30036    /* editfield */
30037    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
30038    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
30039    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
30040    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
30041    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
30042    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
30043 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
30044    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
30045    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
30046    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
30047    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
30048    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
30049    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
30050    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
30051    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
30052    /* smart callbacks called:
30053     * "clicked" - when an editfield is clicked
30054     * "unfocused" - when an editfield is unfocused
30055     */
30056
30057
30058    /**
30059     * @defgroup Multibuttonenetry Multibuttonenetry
30060     *
30061     * @image html img/widget/flipselector/preview-00.png
30062     * @image latex img/widget/flipselector/preview-00.eps
30063     *
30064     * A Multibuttonentry is a widget to allow a user to insert a text button.
30065     * the text button is inserted by pressing the "return" key. If there is no space in the current row,
30066     * the new button is entered in the next row. If the button is pressed, it will become focused. 
30067     * The focus can be removed by pressing the "backspace" key.
30068     * when items are added over 1 lines, if Multibuttonentry lost focus, it becase shrink mode ( made it 1 line)
30069     *
30070     * Smart callbacks one can register to:
30071     * - @c "item,selected" - when item is selected . it can be called by backspace key.                       
30072     * - @c "item,added" - when a new multibuttonentry item is added. 
30073     * - @c "item,deleted" -when a multibuttonentry item is deleted. 
30074     * - @c "item,clicked" - selected item of multibuttonentry is clicked.                  
30075     * - @c "clicked" - when multibuttonentry is clicked. 
30076     * - @c "focused" - when multibuttonentry is focused. 
30077     * - @c "unfocused" - when multibuttonentry is unfocused. 
30078     * - @c "expanded" - when multibuttonentry is expanded . 
30079     * - @c "shrank" - when multibuttonentry is shrank. 
30080     * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed. 
30081     *
30082     * Here is an example on its usage:
30083     * @li @ref multibuttonentry_example
30084     */
30085     /**
30086     * @addtogroup Multibuttonentry
30087     * @{
30088     */
30089
30090    /* Sliding Drawer */
30091    typedef enum _Elm_SlidingDrawer_Pos
30092      {
30093         ELM_SLIDINGDRAWER_BOTTOM,
30094         ELM_SLIDINGDRAWER_LEFT,
30095         ELM_SLIDINGDRAWER_RIGHT,
30096         ELM_SLIDINGDRAWER_TOP
30097      } Elm_SlidingDrawer_Pos;
30098
30099    typedef struct _Elm_SlidingDrawer_Drag_Value
30100      {
30101         double x, y;
30102      } Elm_SlidingDrawer_Drag_Value;
30103
30104    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
30105    EINA_DEPRECATED EAPI void         elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
30106    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
30107    EINA_DEPRECATED EAPI void         elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
30108    EINA_DEPRECATED EAPI void         elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw,  double dh);
30109    EINA_DEPRECATED EAPI void         elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
30110
30111    /* multibuttonentry */
30112    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
30113    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
30114
30115    /**
30116     * @brief Add a new multibuttonentry to the parent
30117     *
30118     * @param parent The parent object
30119     * @return The new object or NULL if it cannot be created
30120     */
30121    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
30122    /**
30123     * Get the label
30124     *
30125     * @param obj The multibuttonentry object
30126     * @return The label, or NULL if none
30127     */
30128    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj);
30129    /**
30130     * Set the label
30131     *
30132     * @param obj The multibuttonentry object
30133     * @param label The text label string
30134     */
30135    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
30136    /**
30137     * Get the entry of the multibuttonentry object
30138     *
30139     * @param obj The multibuttonentry object
30140     * @return The entry object, or NULL if none
30141     */
30142    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj);
30143    /**
30144     * Get the guide text
30145     *
30146     * @param obj The multibuttonentry object
30147     * @return The guide text, or NULL if none
30148     */
30149    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
30150    /**
30151     * Set the guide text
30152     *
30153     * @param obj The multibuttonentry object
30154     * @param label The guide text string
30155     */
30156    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
30157    /**
30158     * Get the value of shrink_mode state.
30159     *
30160     * @param obj The multibuttonentry object
30161     * @param the value of shrink mode state.
30162     */
30163    EAPI int                        elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
30164    /**
30165     * Set/Unset the multibuttonentry to shrink mode state of single line
30166     *
30167     * @param obj The multibuttonentry object
30168     * @param the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state.
30169     */
30170    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
30171    /**
30172     * Prepend a new item to the multibuttonentry
30173     *
30174     * @param obj The multibuttonentry object
30175     * @param label The label of new item
30176     * @param data The ponter to the data to be attached
30177     * @return A handle to the item added or NULL if not possible
30178     */
30179    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
30180    /**
30181     * Append a new item to the multibuttonentry
30182     *
30183     * @param obj The multibuttonentry object
30184     * @param label The label of new item
30185     * @param data The ponter to the data to be attached
30186     * @return A handle to the item added or NULL if not possible
30187     */
30188    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
30189    /**
30190     * Add a new item to the multibuttonentry before the indicated object
30191     *
30192     * reference.
30193     * @param obj The multibuttonentry object
30194     * @param before The item before which to add it
30195     * @param label The label of new item
30196     * @param data The ponter to the data to be attached
30197     * @return A handle to the item added or NULL if not possible
30198     */
30199    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
30200    /**
30201     * Add a new item to the multibuttonentry after the indicated object
30202     *
30203     * @param obj The multibuttonentry object
30204     * @param after The item after which to add it
30205     * @param label The label of new item
30206     * @param data The ponter to the data to be attached
30207     * @return A handle to the item added or NULL if not possible
30208     */
30209    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
30210    /**
30211     * Get a list of items in the multibuttonentry
30212     *
30213     * @param obj The multibuttonentry object
30214     * @return The list of items, or NULL if none
30215     */
30216    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj);
30217    /**
30218     * Get the first item in the multibuttonentry
30219     *
30220     * @param obj The multibuttonentry object
30221     * @return The first item, or NULL if none
30222     */
30223    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
30224    /**
30225     * Get the last item in the multibuttonentry
30226     *
30227     * @param obj The multibuttonentry object
30228     * @return The last item, or NULL if none
30229     */
30230    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
30231    /**
30232     * Get the selected item in the multibuttonentry
30233     *
30234     * @param obj The multibuttonentry object
30235     * @return The selected item, or NULL if none
30236     */
30237    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
30238    /**
30239     * Set the selected state of an item
30240     *
30241     * @param item The item
30242     * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30243     */
30244    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
30245    /**
30246    * unselect all of items.
30247    *
30248    * @param obj The multibuttonentry object
30249    */
30250    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
30251   /**
30252    * Delete a given item
30253    *
30254    * @param item The item
30255    */
30256    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
30257   /**
30258    * Remove all items in the multibuttonentry.
30259    *
30260    * @param obj The multibuttonentry object
30261    */
30262    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
30263   /**
30264    * Get the label of a given item
30265    *
30266    * @param item The item
30267    * @return The label of a given item, or NULL if none
30268    */
30269    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
30270   /**
30271    * Set the label of a given item
30272    *
30273    * @param item The item
30274    * @param label The text label string
30275    */
30276    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
30277   /**
30278    * Get the previous item in the multibuttonentry
30279    *
30280    * @param item The item
30281    * @return The item before the item @p item
30282    */
30283    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
30284   /**
30285    * Get the next item in the multibuttonentry
30286    *
30287    * @param item The item
30288    * @return The item after the item @p item
30289    */
30290    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
30291
30292    EAPI void                      *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
30293    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
30294    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
30295
30296    /**
30297     * @}
30298     */
30299
30300    /**
30301     * @defgroup Stackedicon Stackedicon
30302     * @ingroup Elementary
30303     * @addtogroup Stackedicon
30304     * @{
30305     *
30306     * This is a Stackedicon.
30307     * smart callback called:
30308     * "expanded" - This signal is emitted when a stackedicon is expanded.
30309     * "clicked" - This signal is emitted when a stackedicon is clicked.
30310     *
30311     * available styles:
30312     * default
30313     */
30314    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
30315    /**
30316     * Add a new stackedicon to the parent
30317     *
30318     * @param parent The parent object
30319     * @return The new object or NULL if it cannot be created
30320     */
30321    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
30322    /**
30323     * This appends a path to the stackedicon
30324     *
30325     * @param    obj   The stackedicon object
30326     * @param    path   The image full path
30327     * @return   The new item or NULL if it cannot be created
30328     */
30329    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
30330    /**
30331     * This prepends a path to the stackedicon
30332     *
30333     * @param    obj   The stackedicon object
30334     * @param    path   The image full path
30335     * @return   The new item or NULL if it cannot be created
30336     */
30337    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
30338    /**
30339     * This delete a path at the stackedicon
30340     *
30341     * @param    Elm_Stackedicon_Item   The delete item
30342     */
30343    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
30344    /**
30345     * Get item list from the stackedicon
30346     *
30347     * @param    obj   The stackedicon object
30348     * @return   The item list or NULL if it cannot be created
30349     */
30350    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
30351    /**
30352     * @}
30353     */
30354
30355
30356    /* dialoguegroup */
30357    typedef struct _Dialogue_Item Dialogue_Item;
30358
30359    typedef enum _Elm_Dialoguegourp_Item_Style
30360      {
30361         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
30362         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
30363         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
30364         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
30365         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
30366         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
30367         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
30368         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
30369         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
30370         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
30371         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
30372      } Elm_Dialoguegroup_Item_Style;
30373
30374    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
30375    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
30376    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
30377    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
30378    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
30379    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
30380    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
30381    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
30382    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
30383    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
30384    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
30385    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
30386    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
30387    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
30388    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
30389    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
30390
30391    /* Dayselector */
30392    typedef enum
30393      {
30394         ELM_DAYSELECTOR_SUN,
30395         ELM_DAYSELECTOR_MON,
30396         ELM_DAYSELECTOR_TUE,
30397         ELM_DAYSELECTOR_WED,
30398         ELM_DAYSELECTOR_THU,
30399         ELM_DAYSELECTOR_FRI,
30400         ELM_DAYSELECTOR_SAT
30401      } Elm_DaySelector_Day;
30402
30403    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
30404    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
30405    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
30406
30407    /**
30408     * @defgroup Imageslider Imageslider
30409     * @ingroup Elementary
30410     * @addtogroup Imageslider
30411     * @{
30412     *
30413     * By flicking images on the screen,
30414     * you can see the images in specific path.
30415     */
30416    typedef struct _Imageslider_Item Elm_Imageslider_Item;
30417    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
30418
30419    /**
30420     * Add an Image Slider widget
30421     *
30422     * @param        parent  The parent object
30423     * @return       The new Image slider object or NULL if it cannot be created
30424     */
30425    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30426    /**
30427     * Append an Image Slider item
30428     *
30429     * @param        obj          The Image Slider object
30430     * @param        photo_file   photo file path
30431     * @param        func         callback function
30432     * @param        data         callback data
30433     * @return       The Image Slider item handle or NULL
30434     */
30435    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);
30436    /**
30437     * Insert an Image Slider item into the Image Slider Widget by using the given index.
30438     *
30439     * @param        obj                     The Image Slider object
30440     * @param        photo_file      photo file path
30441     * @param        func            callback function
30442     * @param        index           required position
30443     * @param        data            callback data
30444     * @return       The Image Slider item handle or NULL
30445     */
30446    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);
30447    /**
30448     * Prepend Image Slider item
30449     *
30450     * @param        obj          The Image Slider object
30451     * @param        photo_file   photo file path
30452     * @param        func         callback function
30453     * @param        data         callback data
30454     * @return       The imageslider item handle or NULL
30455     */
30456    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);
30457    /**
30458     * Delete the selected Image Slider item
30459     *
30460     * @param it             The selected Image Slider item handle
30461     */
30462    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30463    /**
30464     * Get the selected Image Slider item
30465     *
30466     * @param obj            The Image Slider object
30467     * @return The selected Image Slider item or NULL
30468     */
30469    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
30470    /**
30471     * Get whether an Image Slider item is selected or not
30472     *
30473     * @param it              the selected Image Slider item
30474     * @return EINA_TRUE or EINA_FALSE
30475     */
30476    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30477    /**
30478     * Set the selected Image Slider item
30479     *
30480     * @param it             The Imaga Slider item
30481     */
30482    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30483    /**
30484     * Get the photo file path of given Image Slider item
30485     *
30486     * @param it             The Image Slider item
30487     * @return The photo file path or NULL;
30488     */
30489    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30490    /**
30491     * Sets the photo file path of given Image Slider item
30492     *
30493     * @param it         The Image Slider item
30494     * @param photo_file The photo file path or NULL;
30495     */
30496    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30497    /**
30498     * Get the previous Image Slider item
30499     *
30500     * @param it             The Image Slider item
30501     * @return The previous Image Slider item or NULL
30502     */
30503    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30504    /**
30505     * Get the next Image Slider item
30506     *
30507     * @param it             The Image Slider item
30508     * @return The next Image Slider item or NULL
30509     */
30510    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
30511    /**
30512     * Move to the previous Image Slider item
30513     *
30514     * @param obj    The Image Slider object
30515     */
30516    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
30517    /**
30518     * Move to the next Image Slider item
30519     *
30520     * @param obj The Image Slider object
30521     */
30522    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
30523    /**
30524     * Updates an Image Slider item
30525     *
30526     * @param it The Image Slider item
30527     */
30528    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30529    /**
30530     * @}
30531     */
30532 #ifdef __cplusplus
30533 }
30534 #endif
30535
30536 #endif