add recursie object find function - it will only look at elm children
[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    elm_shutdown();
237    return 0;
238 }
239 ELM_MAIN()
240 @endcode
241    *
242    */
243
244 /**
245 @page authors Authors
246 @author Carsten Haitzler <raster@@rasterman.com>
247 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
248 @author Cedric Bail <cedric.bail@@free.fr>
249 @author Vincent Torri <vtorri@@univ-evry.fr>
250 @author Daniel Kolesa <quaker66@@gmail.com>
251 @author Jaime Thomas <avi.thomas@@gmail.com>
252 @author Swisscom - http://www.swisscom.ch/
253 @author Christopher Michael <devilhorns@@comcast.net>
254 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
255 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
256 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
257 @author Brian Wang <brian.wang.0721@@gmail.com>
258 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
259 @author Samsung Electronics <tbd>
260 @author Samsung SAIT <tbd>
261 @author Brett Nash <nash@@nash.id.au>
262 @author Bruno Dilly <bdilly@@profusion.mobi>
263 @author Rafael Fonseca <rfonseca@@profusion.mobi>
264 @author Chuneon Park <hermet@@hermet.pe.kr>
265 @author Woohyun Jung <wh0705.jung@@samsung.com>
266 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
267 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
268 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
269 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
270 @author Gustavo Lima Chaves <glima@@profusion.mobi>
271 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
272 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
273 @author Otavio Pontes <otavio@@profusion.mobi>
274 @author Viktor Kojouharov <vkojouharov@@gmail.com>
275 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
276 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
277 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
278 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
279 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
280 @author Jihoon Kim <jihoon48.kim@@samsung.com>
281 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
282 @author Tom Hacohen <tom@@stosb.com>
283 @author Aharon Hillel <a.hillel@@partner.samsung.com>
284 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
285 @author Shinwoo Kim <kimcinoo@@gmail.com>
286 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
287 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
288 @author Sung W. Park <sungwoo@@gmail.com>
289 @author Thierry el Borgi <thierry@@substantiel.fr>
290 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
291 @author Chanwook Jung <joey.jung@@samsung.com>
292 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
293 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
294 @author Kim Yunhan <spbear@@gmail.com>
295 @author Bluezery <ohpowel@@gmail.com>
296 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
297 @author Sanjeev BA <iamsanjeev@@gmail.com>
298
299 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
300 contact with the developers and maintainers.
301  */
302
303 #ifndef ELEMENTARY_H
304 #define ELEMENTARY_H
305
306 /**
307  * @file Elementary.h
308  * @brief Elementary's API
309  *
310  * Elementary API.
311  */
312
313 @ELM_UNIX_DEF@ ELM_UNIX
314 @ELM_WIN32_DEF@ ELM_WIN32
315 @ELM_WINCE_DEF@ ELM_WINCE
316 @ELM_EDBUS_DEF@ ELM_EDBUS
317 @ELM_EFREET_DEF@ ELM_EFREET
318 @ELM_ETHUMB_DEF@ ELM_ETHUMB
319 @ELM_WEB_DEF@ ELM_WEB
320 @ELM_EMAP_DEF@ ELM_EMAP
321 @ELM_DEBUG_DEF@ ELM_DEBUG
322 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
323 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
324 @ELM_DIRENT_H_DEF@ ELM_DIRENT_H
325
326 /* Standard headers for standard system calls etc. */
327 #include <stdio.h>
328 #include <stdlib.h>
329 #include <unistd.h>
330 #include <string.h>
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
335 #include <math.h>
336 #include <fnmatch.h>
337 #include <limits.h>
338 #include <ctype.h>
339 #include <time.h>
340 #ifdef ELM_DIRENT_H
341 # include <dirent.h>
342 #endif
343 #include <pwd.h>
344 #include <errno.h>
345
346 #ifdef ELM_UNIX
347 # include <locale.h>
348 # ifdef ELM_LIBINTL_H
349 #  include <libintl.h>
350 # endif
351 # include <signal.h>
352 # include <grp.h>
353 # include <glob.h>
354 #endif
355
356 #ifdef ELM_ALLOCA_H
357 # include <alloca.h>
358 #endif
359
360 #if defined (ELM_WIN32) || defined (ELM_WINCE)
361 # include <malloc.h>
362 # ifndef alloca
363 #  define alloca _alloca
364 # endif
365 #endif
366
367
368 /* EFL headers */
369 #include <Eina.h>
370 #include <Eet.h>
371 #include <Evas.h>
372 #include <Evas_GL.h>
373 #include <Ecore.h>
374 #include <Ecore_Evas.h>
375 #include <Ecore_File.h>
376 @ELEMENTARY_ECORE_IMF_INC@
377 @ELEMENTARY_ECORE_CON_INC@
378 #include <Edje.h>
379
380 #ifdef ELM_EDBUS
381 # include <E_DBus.h>
382 #endif
383
384 #ifdef ELM_EFREET
385 # include <Efreet.h>
386 # include <Efreet_Mime.h>
387 # include <Efreet_Trash.h>
388 #endif
389
390 #ifdef ELM_ETHUMB
391 # include <Ethumb_Client.h>
392 #endif
393
394 #ifdef ELM_EMAP
395 # include <EMap.h>
396 #endif
397
398 #ifdef EAPI
399 # undef EAPI
400 #endif
401
402 #ifdef _WIN32
403 # ifdef ELEMENTARY_BUILD
404 #  ifdef DLL_EXPORT
405 #   define EAPI __declspec(dllexport)
406 #  else
407 #   define EAPI
408 #  endif /* ! DLL_EXPORT */
409 # else
410 #  define EAPI __declspec(dllimport)
411 # endif /* ! EFL_EVAS_BUILD */
412 #else
413 # ifdef __GNUC__
414 #  if __GNUC__ >= 4
415 #   define EAPI __attribute__ ((visibility("default")))
416 #  else
417 #   define EAPI
418 #  endif
419 # else
420 #  define EAPI
421 # endif
422 #endif /* ! _WIN32 */
423
424 #ifdef _WIN32
425 # define EAPI_MAIN
426 #else
427 # define EAPI_MAIN EAPI
428 #endif
429
430 /* allow usage from c++ */
431 #ifdef __cplusplus
432 extern "C" {
433 #endif
434
435 #define ELM_VERSION_MAJOR @VMAJ@
436 #define ELM_VERSION_MINOR @VMIN@
437
438    typedef struct _Elm_Version
439      {
440         int major;
441         int minor;
442         int micro;
443         int revision;
444      } Elm_Version;
445
446    EAPI extern Elm_Version *elm_version;
447
448 /* handy macros */
449 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
450 #define ELM_PI 3.14159265358979323846
451
452    /**
453     * @defgroup General General
454     *
455     * @brief General Elementary API. Functions that don't relate to
456     * Elementary objects specifically.
457     *
458     * Here are documented functions which init/shutdown the library,
459     * that apply to generic Elementary objects, that deal with
460     * configuration, et cetera.
461     *
462     * @ref general_functions_example_page "This" example contemplates
463     * some of these functions.
464     */
465
466    /**
467     * @addtogroup General
468     * @{
469     */
470
471   /**
472    * Defines couple of standard Evas_Object layers to be used
473    * with evas_object_layer_set().
474    *
475    * @note whenever extending with new values, try to keep some padding
476    *       to siblings so there is room for further extensions.
477    */
478   typedef enum _Elm_Object_Layer
479     {
480        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
481        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
482        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
483        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
484        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
485        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
486     } Elm_Object_Layer;
487
488 /**************************************************************************/
489    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
490
491    /**
492     * Emitted when the application has reconfigured elementary settings due
493     * to an external configuration tool asking it to.
494     */
495    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
496
497    /**
498     * Emitted when any Elementary's policy value is changed.
499     */
500    EAPI extern int ELM_EVENT_POLICY_CHANGED;
501
502    /**
503     * @typedef Elm_Event_Policy_Changed
504     *
505     * Data on the event when an Elementary policy has changed
506     */
507     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
508
509    /**
510     * @struct _Elm_Event_Policy_Changed
511     *
512     * Data on the event when an Elementary policy has changed
513     */
514     struct _Elm_Event_Policy_Changed
515      {
516         unsigned int policy; /**< the policy identifier */
517         int          new_value; /**< value the policy had before the change */
518         int          old_value; /**< new value the policy got */
519     };
520
521    /**
522     * Policy identifiers.
523     */
524     typedef enum _Elm_Policy
525     {
526         ELM_POLICY_QUIT, /**< under which circumstances the application
527                           * should quit automatically. @see
528                           * Elm_Policy_Quit.
529                           */
530         ELM_POLICY_LAST
531     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
532  */
533
534    typedef enum _Elm_Policy_Quit
535      {
536         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
537                                    * automatically */
538         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
539                                             * application's last
540                                             * window is closed */
541      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
542
543    typedef enum _Elm_Focus_Direction
544      {
545         ELM_FOCUS_PREVIOUS,
546         ELM_FOCUS_NEXT
547      } Elm_Focus_Direction;
548
549    typedef enum _Elm_Text_Format
550      {
551         ELM_TEXT_FORMAT_PLAIN_UTF8,
552         ELM_TEXT_FORMAT_MARKUP_UTF8
553      } Elm_Text_Format;
554
555    /**
556     * Line wrapping types.
557     */
558    typedef enum _Elm_Wrap_Type
559      {
560         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
561         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
562         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
563         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
564         ELM_WRAP_LAST
565      } Elm_Wrap_Type;
566
567    typedef enum
568      {
569         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
570         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
571         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
572         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
573         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
574         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
575         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
576         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
577         ELM_INPUT_PANEL_LAYOUT_INVALID
578      } Elm_Input_Panel_Layout;
579
580    typedef enum
581      {
582         ELM_AUTOCAPITAL_TYPE_NONE,
583         ELM_AUTOCAPITAL_TYPE_WORD,
584         ELM_AUTOCAPITAL_TYPE_SENTENCE,
585         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
586      } Elm_Autocapital_Type;
587
588    /**
589     * @typedef Elm_Object_Item
590     * An Elementary Object item handle.
591     * @ingroup General
592     */
593    typedef struct _Elm_Object_Item Elm_Object_Item;
594
595
596    /**
597     * Called back when a widget's tooltip is activated and needs content.
598     * @param data user-data given to elm_object_tooltip_content_cb_set()
599     * @param obj owner widget.
600     * @param tooltip The tooltip object (affix content to this!)
601     */
602    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
603
604    /**
605     * Called back when a widget's item tooltip is activated and needs content.
606     * @param data user-data given to elm_object_tooltip_content_cb_set()
607     * @param obj owner widget.
608     * @param tooltip The tooltip object (affix content to this!)
609     * @param item context dependent item. As an example, if tooltip was
610     *        set on Elm_List_Item, then it is of this type.
611     */
612    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
613
614    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. */
615
616 #ifndef ELM_LIB_QUICKLAUNCH
617 #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 */
618 #else
619 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
620 #endif
621
622 /**************************************************************************/
623    /* General calls */
624
625    /**
626     * Initialize Elementary
627     *
628     * @param[in] argc System's argument count value
629     * @param[in] argv System's pointer to array of argument strings
630     * @return The init counter value.
631     *
632     * This function initializes Elementary and increments a counter of
633     * the number of calls to it. It returns the new counter's value.
634     *
635     * @warning This call is exported only for use by the @c ELM_MAIN()
636     * macro. There is no need to use this if you use this macro (which
637     * is highly advisable). An elm_main() should contain the entry
638     * point code for your application, having the same prototype as
639     * elm_init(), and @b not being static (putting the @c EAPI symbol
640     * in front of its type declaration is advisable). The @c
641     * ELM_MAIN() call should be placed just after it.
642     *
643     * Example:
644     * @dontinclude bg_example_01.c
645     * @skip static void
646     * @until ELM_MAIN
647     *
648     * See the full @ref bg_example_01_c "example".
649     *
650     * @see elm_shutdown().
651     * @ingroup General
652     */
653    EAPI int          elm_init(int argc, char **argv);
654
655    /**
656     * Shut down Elementary
657     *
658     * @return The init counter value.
659     *
660     * This should be called at the end of your application, just
661     * before it ceases to do any more processing. This will clean up
662     * any permanent resources your application may have allocated via
663     * Elementary that would otherwise persist.
664     *
665     * @see elm_init() for an example
666     *
667     * @ingroup General
668     */
669    EAPI int          elm_shutdown(void);
670
671    /**
672     * Run Elementary's main loop
673     *
674     * This call should be issued just after all initialization is
675     * completed. This function will not return until elm_exit() is
676     * called. It will keep looping, running the main
677     * (event/processing) loop for Elementary.
678     *
679     * @see elm_init() for an example
680     *
681     * @ingroup General
682     */
683    EAPI void         elm_run(void);
684
685    /**
686     * Exit Elementary's main loop
687     *
688     * If this call is issued, it will flag the main loop to cease
689     * processing and return back to its parent function (usually your
690     * elm_main() function).
691     *
692     * @see elm_init() for an example. There, just after a request to
693     * close the window comes, the main loop will be left.
694     *
695     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
696     * applications, you'll be able to get this function called automatically for you.
697     *
698     * @ingroup General
699     */
700    EAPI void         elm_exit(void);
701
702    /**
703     * Provide information in order to make Elementary determine the @b
704     * run time location of the software in question, so other data files
705     * such as images, sound files, executable utilities, libraries,
706     * modules and locale files can be found.
707     *
708     * @param mainfunc This is your application's main function name,
709     *        whose binary's location is to be found. Providing @c NULL
710     *        will make Elementary not to use it
711     * @param dom This will be used as the application's "domain", in the
712     *        form of a prefix to any environment variables that may
713     *        override prefix detection and the directory name, inside the
714     *        standard share or data directories, where the software's
715     *        data files will be looked for.
716     * @param checkfile This is an (optional) magic file's path to check
717     *        for existence (and it must be located in the data directory,
718     *        under the share directory provided above). Its presence will
719     *        help determine the prefix found was correct. Pass @c NULL if
720     *        the check is not to be done.
721     *
722     * This function allows one to re-locate the application somewhere
723     * else after compilation, if the developer wishes for easier
724     * distribution of pre-compiled binaries.
725     *
726     * The prefix system is designed to locate where the given software is
727     * installed (under a common path prefix) at run time and then report
728     * specific locations of this prefix and common directories inside
729     * this prefix like the binary, library, data and locale directories,
730     * through the @c elm_app_*_get() family of functions.
731     *
732     * Call elm_app_info_set() early on before you change working
733     * directory or anything about @c argv[0], so it gets accurate
734     * information.
735     *
736     * It will then try and trace back which file @p mainfunc comes from,
737     * if provided, to determine the application's prefix directory.
738     *
739     * The @p dom parameter provides a string prefix to prepend before
740     * environment variables, allowing a fallback to @b specific
741     * environment variables to locate the software. You would most
742     * probably provide a lowercase string there, because it will also
743     * serve as directory domain, explained next. For environment
744     * variables purposes, this string is made uppercase. For example if
745     * @c "myapp" is provided as the prefix, then the program would expect
746     * @c "MYAPP_PREFIX" as a master environment variable to specify the
747     * exact install prefix for the software, or more specific environment
748     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
749     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
750     * the user or scripts before launching. If not provided (@c NULL),
751     * environment variables will not be used to override compiled-in
752     * defaults or auto detections.
753     *
754     * The @p dom string also provides a subdirectory inside the system
755     * shared data directory for data files. For example, if the system
756     * directory is @c /usr/local/share, then this directory name is
757     * appended, creating @c /usr/local/share/myapp, if it @p was @c
758     * "myapp". It is expected that the application installs data files in
759     * this directory.
760     *
761     * The @p checkfile is a file name or path of something inside the
762     * share or data directory to be used to test that the prefix
763     * detection worked. For example, your app will install a wallpaper
764     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
765     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
766     * checkfile string.
767     *
768     * @see elm_app_compile_bin_dir_set()
769     * @see elm_app_compile_lib_dir_set()
770     * @see elm_app_compile_data_dir_set()
771     * @see elm_app_compile_locale_set()
772     * @see elm_app_prefix_dir_get()
773     * @see elm_app_bin_dir_get()
774     * @see elm_app_lib_dir_get()
775     * @see elm_app_data_dir_get()
776     * @see elm_app_locale_dir_get()
777     */
778    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
779
780    /**
781     * Provide information on the @b fallback application's binaries
782     * directory, in scenarios where they get overriden by
783     * elm_app_info_set().
784     *
785     * @param dir The path to the default binaries directory (compile time
786     * one)
787     *
788     * @note Elementary will as well use this path to determine actual
789     * names of binaries' directory paths, maybe changing it to be @c
790     * something/local/bin instead of @c something/bin, only, for
791     * example.
792     *
793     * @warning You should call this function @b before
794     * elm_app_info_set().
795     */
796    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
797
798    /**
799     * Provide information on the @b fallback application's libraries
800     * directory, on scenarios where they get overriden by
801     * elm_app_info_set().
802     *
803     * @param dir The path to the default libraries directory (compile
804     * time one)
805     *
806     * @note Elementary will as well use this path to determine actual
807     * names of libraries' directory paths, maybe changing it to be @c
808     * something/lib32 or @c something/lib64 instead of @c something/lib,
809     * only, for example.
810     *
811     * @warning You should call this function @b before
812     * elm_app_info_set().
813     */
814    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
815
816    /**
817     * Provide information on the @b fallback application's data
818     * directory, on scenarios where they get overriden by
819     * elm_app_info_set().
820     *
821     * @param dir The path to the default data directory (compile time
822     * one)
823     *
824     * @note Elementary will as well use this path to determine actual
825     * names of data directory paths, maybe changing it to be @c
826     * something/local/share instead of @c something/share, only, for
827     * example.
828     *
829     * @warning You should call this function @b before
830     * elm_app_info_set().
831     */
832    EAPI void         elm_app_compile_data_dir_set(const char *dir);
833
834    /**
835     * Provide information on the @b fallback application's locale
836     * directory, on scenarios where they get overriden by
837     * elm_app_info_set().
838     *
839     * @param dir The path to the default locale directory (compile time
840     * one)
841     *
842     * @warning You should call this function @b before
843     * elm_app_info_set().
844     */
845    EAPI void         elm_app_compile_locale_set(const char *dir);
846
847    /**
848     * Retrieve the application's run time prefix directory, as set by
849     * elm_app_info_set() and the way (environment) the application was
850     * run from.
851     *
852     * @return The directory prefix the application is actually using.
853     */
854    EAPI const char  *elm_app_prefix_dir_get(void);
855
856    /**
857     * Retrieve the application's run time binaries prefix directory, as
858     * set by elm_app_info_set() and the way (environment) the application
859     * was run from.
860     *
861     * @return The binaries directory prefix the application is actually
862     * using.
863     */
864    EAPI const char  *elm_app_bin_dir_get(void);
865
866    /**
867     * Retrieve the application's run time libraries prefix directory, as
868     * set by elm_app_info_set() and the way (environment) the application
869     * was run from.
870     *
871     * @return The libraries directory prefix the application is actually
872     * using.
873     */
874    EAPI const char  *elm_app_lib_dir_get(void);
875
876    /**
877     * Retrieve the application's run time data prefix directory, as
878     * set by elm_app_info_set() and the way (environment) the application
879     * was run from.
880     *
881     * @return The data directory prefix the application is actually
882     * using.
883     */
884    EAPI const char  *elm_app_data_dir_get(void);
885
886    /**
887     * Retrieve the application's run time locale prefix directory, as
888     * set by elm_app_info_set() and the way (environment) the application
889     * was run from.
890     *
891     * @return The locale directory prefix the application is actually
892     * using.
893     */
894    EAPI const char  *elm_app_locale_dir_get(void);
895
896    /**
897     * Exposed symbol used only by macros and should not be used by apps
898     */
899    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
900
901    /**
902     * Exposed symbol used only by macros and should not be used by apps
903     */
904    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
905
906    /**
907     * Exposed symbol used only by macros and should not be used by apps
908     */
909    EAPI int          elm_quicklaunch_init(int argc, char **argv);
910
911    /**
912     * Exposed symbol used only by macros and should not be used by apps
913     */
914    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
915
916    /**
917     * Exposed symbol used only by macros and should not be used by apps
918     */
919    EAPI int          elm_quicklaunch_sub_shutdown(void);
920
921    /**
922     * Exposed symbol used only by macros and should not be used by apps
923     */
924    EAPI int          elm_quicklaunch_shutdown(void);
925
926    /**
927     * Exposed symbol used only by macros and should not be used by apps
928     */
929    EAPI void         elm_quicklaunch_seed(void);
930
931    /**
932     * Exposed symbol used only by macros and should not be used by apps
933     */
934    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
935
936    /**
937     * Exposed symbol used only by macros and should not be used by apps
938     */
939    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
940
941    /**
942     * Exposed symbol used only by macros and should not be used by apps
943     */
944    EAPI void         elm_quicklaunch_cleanup(void);
945
946    /**
947     * Exposed symbol used only by macros and should not be used by apps
948     */
949    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
950
951    /**
952     * Exposed symbol used only by macros and should not be used by apps
953     */
954    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
955
956    /**
957     * Request that your elementary application needs efreet
958     * 
959     * This initializes the Efreet library when called and if support exists
960     * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
961     * before any efreet calls.
962     * 
963     * @return EINA_TRUE if support exists and initialization succeeded.
964     * 
965     * @ingroup Efreet
966     */
967    EAPI Eina_Bool    elm_need_efreet(void);
968
969    /**
970     * Request that your elementary application needs e_dbus
971     * 
972     * This initializes the E_dbus library when called and if support exists
973     * it returns EINA_TRUE, otherwise returns EINA_FALSE. This must be called
974     * before any e_dbus calls.
975     * 
976     * @return EINA_TRUE if support exists and initialization succeeded.
977     * 
978     * @ingroup E_dbus
979     */
980    EAPI Eina_Bool    elm_need_e_dbus(void);
981
982    /**
983     * Request that your elementary application needs ethumb
984     * 
985     * This initializes the Ethumb library when called and if support exists
986     * it returns EINA_TRUE, otherwise returns EINA_FALSE.
987     * This must be called before any other function that deals with
988     * elm_thumb objects or ethumb_client instances.
989     *
990     * @ingroup Thumb
991     */
992    EAPI Eina_Bool    elm_need_ethumb(void);
993
994    /**
995     * Request that your elementary application needs web support
996     * 
997     * This initializes the Ewebkit library when called and if support exists
998     * it returns EINA_TRUE, otherwise returns EINA_FALSE.
999     * This must be called before any other function that deals with
1000     * elm_web objects or ewk_view instances.
1001     *
1002     * @ingroup Web
1003     */
1004    EAPI Eina_Bool    elm_need_web(void);
1005
1006    /**
1007     * Set a new policy's value (for a given policy group/identifier).
1008     *
1009     * @param policy policy identifier, as in @ref Elm_Policy.
1010     * @param value policy value, which depends on the identifier
1011     *
1012     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
1013     *
1014     * Elementary policies define applications' behavior,
1015     * somehow. These behaviors are divided in policy groups (see
1016     * #Elm_Policy enumeration). This call will emit the Ecore event
1017     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
1018     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
1019     * then.
1020     *
1021     * @note Currently, we have only one policy identifier/group
1022     * (#ELM_POLICY_QUIT), which has two possible values.
1023     *
1024     * @ingroup General
1025     */
1026    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
1027
1028    /**
1029     * Gets the policy value for given policy identifier.
1030     *
1031     * @param policy policy identifier, as in #Elm_Policy.
1032     * @return The currently set policy value, for that
1033     * identifier. Will be @c 0 if @p policy passed is invalid.
1034     *
1035     * @ingroup General
1036     */
1037    EAPI int          elm_policy_get(unsigned int policy);
1038
1039    /**
1040     * Change the language of the current application
1041     *
1042     * The @p lang passed must be the full name of the locale to use, for
1043     * example "en_US.utf8" or "es_ES@euro".
1044     *
1045     * Changing language with this function will make Elementary run through
1046     * all its widgets, translating strings set with
1047     * elm_object_domain_translatable_text_part_set(). This way, an entire
1048     * UI can have its language changed without having to restart the program.
1049     *
1050     * For more complex cases, like having formatted strings that need
1051     * translation, widgets will also emit a "language,changed" signal that
1052     * the user can listen to to manually translate the text.
1053     *
1054     * @param lang Language to set, must be the full name of the locale
1055     *
1056     * @ingroup General
1057     */
1058    EAPI void         elm_language_set(const char *lang);
1059
1060    /**
1061     * Set a label of an object
1062     *
1063     * @param obj The Elementary object
1064     * @param part The text part name to set (NULL for the default label)
1065     * @param label The new text of the label
1066     *
1067     * @note Elementary objects may have many labels (e.g. Action Slider)
1068     * @deprecated Use elm_object_part_text_set() instead.
1069     * @ingroup General
1070     */
1071    EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
1072
1073    /**
1074     * Set a label of an object
1075     *
1076     * @param obj The Elementary object
1077     * @param part The text part name to set (NULL for the default label)
1078     * @param label The new text of the label
1079     *
1080     * @note Elementary objects may have many labels (e.g. Action Slider)
1081     *
1082     * @ingroup General
1083     */
1084    EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1085
1086 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1087
1088    /**
1089     * Get a label of an object
1090     *
1091     * @param obj The Elementary object
1092     * @param part The text part name to get (NULL for the default label)
1093     * @return text of the label or NULL for any error
1094     *
1095     * @note Elementary objects may have many labels (e.g. Action Slider)
1096     * @deprecated Use elm_object_part_text_get() instead.
1097     * @ingroup General
1098     */
1099    EINA_DEPRECATED EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1100
1101    /**
1102     * Get a label of an object
1103     *
1104     * @param obj The Elementary object
1105     * @param part The text part name to get (NULL for the default label)
1106     * @return text of the label or NULL for any error
1107     *
1108     * @note Elementary objects may have many labels (e.g. Action Slider)
1109     *
1110     * @ingroup General
1111     */
1112    EAPI const char  *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1113
1114 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1115
1116    /**
1117     * Set the text for an objects' part, marking it as translatable.
1118     *
1119     * The string to set as @p text must be the original one. Do not pass the
1120     * return of @c gettext() here. Elementary will translate the string
1121     * internally and set it on the object using elm_object_part_text_set(),
1122     * also storing the original string so that it can be automatically
1123     * translated when the language is changed with elm_language_set().
1124     *
1125     * The @p domain will be stored along to find the translation in the
1126     * correct catalog. It can be NULL, in which case it will use whatever
1127     * domain was set by the application with @c textdomain(). This is useful
1128     * in case you are building a library on top of Elementary that will have
1129     * its own translatable strings, that should not be mixed with those of
1130     * programs using the library.
1131     *
1132     * @param obj The object containing the text part
1133     * @param part The name of the part to set
1134     * @param domain The translation domain to use
1135     * @param text The original, non-translated text to set
1136     *
1137     * @ingroup General
1138     */
1139    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1140
1141 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1142
1143 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1144
1145    /**
1146     * Gets the original string set as translatable for an object
1147     *
1148     * When setting translated strings, the function elm_object_part_text_get()
1149     * will return the translation returned by @c gettext(). To get the
1150     * original string use this function.
1151     *
1152     * @param obj The object
1153     * @param part The name of the part that was set
1154     *
1155     * @return The original, untranslated string
1156     *
1157     * @ingroup General
1158     */
1159    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1160
1161 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1162
1163    /**
1164     * Set a content of an object
1165     *
1166     * @param obj The Elementary object
1167     * @param part The content part name to set (NULL for the default content)
1168     * @param content The new content of the object
1169     *
1170     * @note Elementary objects may have many contents
1171     * @deprecated Use elm_object_part_content_set instead.
1172     * @ingroup General
1173     */
1174    EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1175
1176    /**
1177     * Set a content of an object
1178     *
1179     * @param obj The Elementary object
1180     * @param part The content part name to set (NULL for the default content)
1181     * @param content The new content of the object
1182     *
1183     * @note Elementary objects may have many contents
1184     *
1185     * @ingroup General
1186     */
1187    EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1188
1189 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1190
1191    /**
1192     * Get a content of an object
1193     *
1194     * @param obj The Elementary object
1195     * @param item The content part name to get (NULL for the default content)
1196     * @return content of the object or NULL for any error
1197     *
1198     * @note Elementary objects may have many contents
1199     * @deprecated Use elm_object_part_content_get instead.
1200     * @ingroup General
1201     */
1202    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1203
1204    /**
1205     * Get a content of an object
1206     *
1207     * @param obj The Elementary object
1208     * @param item The content part name to get (NULL for the default content)
1209     * @return content of the object or NULL for any error
1210     *
1211     * @note Elementary objects may have many contents
1212     *
1213     * @ingroup General
1214     */
1215    EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1216
1217 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1218
1219    /**
1220     * Unset a content of an object
1221     *
1222     * @param obj The Elementary object
1223     * @param item The content part name to unset (NULL for the default content)
1224     *
1225     * @note Elementary objects may have many contents
1226     * @deprecated Use elm_object_part_content_unset instead.
1227     * @ingroup General
1228     */
1229    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1230
1231    /**
1232     * Unset a content of an object
1233     *
1234     * @param obj The Elementary object
1235     * @param item The content part name to unset (NULL for the default content)
1236     *
1237     * @note Elementary objects may have many contents
1238     *
1239     * @ingroup General
1240     */
1241    EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1242
1243 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1244
1245    /**
1246     * Set the text to read out when in accessibility mode
1247     *
1248     * @param obj The object which is to be described
1249     * @param txt The text that describes the widget to people with poor or no vision
1250     *
1251     * @ingroup General
1252     */
1253    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1254
1255    /**
1256     * Get a named object from the children
1257     * 
1258     * @param obj The parent object whose children to look at
1259     * @param name The name of the child to find
1260     * @param recurse Set to thge maximum number of levels to recurse (0 == none, 1 is only look at 1 level of children etc.)
1261     * @return The found object of that name, or NULL if none is found
1262     * 
1263     * This function searches the children (or recursively children of
1264     * children and so on) of the given @p obj object looking for a child with
1265     * the name of @p name. If the child is found the object is returned, or
1266     * NULL is returned. You can set the name of an object with 
1267     * evas_object_name_set(). If the name is not unique within the child
1268     * objects (or the tree is @p recurse is greater than 0) then it is
1269     * undefined as to which child of that name is returned, so ensure the name
1270     * is unique amongst children. If recurse is set to -1 it will recurse
1271     * without limit.
1272     * 
1273     * @ingroup General
1274     */
1275    EAPI Evas_Object *elm_object_name_find(const Evas_Object *obj, const char *name, int recurse);
1276        
1277    /**
1278     * Get the widget object's handle which contains a given item
1279     *
1280     * @param item The Elementary object item
1281     * @return The widget object
1282     *
1283     * @note This returns the widget object itself that an item belongs to.
1284     *
1285     * @ingroup General
1286     */
1287    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1288
1289    /**
1290     * Set a content of an object item
1291     *
1292     * @param it The Elementary object item
1293     * @param part The content part name to set (NULL for the default content)
1294     * @param content The new content of the object item
1295     *
1296     * @note Elementary object items may have many contents
1297     * @deprecated Use elm_object_item_part_content_set instead.
1298     * @ingroup General
1299     */
1300    EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1301
1302    /**
1303     * Set a content of an object item
1304     *
1305     * @param it The Elementary object item
1306     * @param part The content part name to set (NULL for the default content)
1307     * @param content The new content of the object item
1308     *
1309     * @note Elementary object items may have many contents
1310     *
1311     * @ingroup General
1312     */
1313    EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1314
1315 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1316
1317    /**
1318     * Get a content of an object item
1319     *
1320     * @param it The Elementary object item
1321     * @param part The content part name to unset (NULL for the default content)
1322     * @return content of the object item or NULL for any error
1323     *
1324     * @note Elementary object items may have many contents
1325     * @deprecated Use elm_object_item_part_content_get instead.
1326     * @ingroup General
1327     */
1328    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1329
1330    /**
1331     * Get a content of an object item
1332     *
1333     * @param it The Elementary object item
1334     * @param part The content part name to unset (NULL for the default content)
1335     * @return content of the object item or NULL for any error
1336     *
1337     * @note Elementary object items may have many contents
1338     *
1339     * @ingroup General
1340     */
1341    EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1342
1343 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1344
1345    /**
1346     * Unset a content of an object item
1347     *
1348     * @param it The Elementary object item
1349     * @param part The content part name to unset (NULL for the default content)
1350     *
1351     * @note Elementary object items may have many contents
1352     * @deprecated Use elm_object_item_part_content_unset instead.
1353     * @ingroup General
1354     */
1355    EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1356
1357    /**
1358     * Unset a content of an object item
1359     *
1360     * @param it The Elementary object item
1361     * @param part The content part name to unset (NULL for the default content)
1362     *
1363     * @note Elementary object items may have many contents
1364     *
1365     * @ingroup General
1366     */
1367    EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1368
1369 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1370
1371    /**
1372     * Set a label of an object item
1373     *
1374     * @param it The Elementary object item
1375     * @param part The text part name to set (NULL for the default label)
1376     * @param label The new text of the label
1377     *
1378     * @note Elementary object items may have many labels
1379     * @deprecated Use elm_object_item_part_text_set instead.
1380     * @ingroup General
1381     */
1382    EINA_DEPRECATED EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1383
1384    /**
1385     * Set a label of an object item
1386     *
1387     * @param it The Elementary object item
1388     * @param part The text part name to set (NULL for the default label)
1389     * @param label The new text of the label
1390     *
1391     * @note Elementary object items may have many labels
1392     *
1393     * @ingroup General
1394     */
1395    EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1396
1397 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1398
1399    /**
1400     * Get a label of an object item
1401     *
1402     * @param it The Elementary object item
1403     * @param part The text part name to get (NULL for the default label)
1404     * @return text of the label or NULL for any error
1405     *
1406     * @note Elementary object items may have many labels
1407     * @deprecated Use elm_object_item_part_text_get instead.
1408     * @ingroup General
1409     */
1410    EINA_DEPRECATED EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1411    /**
1412     * Get a label of an object item
1413     *
1414     * @param it The Elementary object item
1415     * @param part The text part name to get (NULL for the default label)
1416     * @return text of the label or NULL for any error
1417     *
1418     * @note Elementary object items may have many labels
1419     *
1420     * @ingroup General
1421     */
1422    EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1423
1424 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1425
1426    /**
1427     * Set the text to read out when in accessibility mode
1428     *
1429     * @param it The object item which is to be described
1430     * @param txt The text that describes the widget to people with poor or no vision
1431     *
1432     * @ingroup General
1433     */
1434    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1435
1436    /**
1437     * Get the data associated with an object item
1438     * @param it The Elementary object item
1439     * @return The data associated with @p it
1440     *
1441     * @ingroup General
1442     */
1443    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1444
1445    /**
1446     * Set the data associated with an object item
1447     * @param it The Elementary object item
1448     * @param data The data to be associated with @p it
1449     *
1450     * @ingroup General
1451     */
1452    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1453
1454    /**
1455     * Send a signal to the edje object of the widget item.
1456     *
1457     * This function sends a signal to the edje object of the obj item. An
1458     * edje program can respond to a signal by specifying matching
1459     * 'signal' and 'source' fields.
1460     *
1461     * @param it The Elementary object item
1462     * @param emission The signal's name.
1463     * @param source The signal's source.
1464     * @ingroup General
1465     */
1466    EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1467
1468    /**
1469     * Set the disabled state of an widget item.
1470     *
1471     * @param obj The Elementary object item
1472     * @param disabled The state to put in in: @c EINA_TRUE for
1473     *        disabled, @c EINA_FALSE for enabled
1474     *
1475     * Elementary object item can be @b disabled, in which state they won't
1476     * receive input and, in general, will be themed differently from
1477     * their normal state, usually greyed out. Useful for contexts
1478     * where you don't want your users to interact with some of the
1479     * parts of you interface.
1480     *
1481     * This sets the state for the widget item, either disabling it or
1482     * enabling it back.
1483     *
1484     * @ingroup Styles
1485     */
1486    EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1487
1488    /**
1489     * Get the disabled state of an widget item.
1490     *
1491     * @param obj The Elementary object
1492     * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1493     *            if it's enabled (or on errors)
1494     *
1495     * This gets the state of the widget, which might be enabled or disabled.
1496     *
1497     * @ingroup Styles
1498     */
1499    EAPI Eina_Bool    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1500
1501    /**
1502     * @}
1503     */
1504
1505    /**
1506     * @defgroup Caches Caches
1507     *
1508     * These are functions which let one fine-tune some cache values for
1509     * Elementary applications, thus allowing for performance adjustments.
1510     *
1511     * @{
1512     */
1513
1514    /**
1515     * @brief Flush all caches.
1516     *
1517     * Frees all data that was in cache and is not currently being used to reduce
1518     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1519     * to calling all of the following functions:
1520     * @li edje_file_cache_flush()
1521     * @li edje_collection_cache_flush()
1522     * @li eet_clearcache()
1523     * @li evas_image_cache_flush()
1524     * @li evas_font_cache_flush()
1525     * @li evas_render_dump()
1526     * @note Evas caches are flushed for every canvas associated with a window.
1527     *
1528     * @ingroup Caches
1529     */
1530    EAPI void         elm_all_flush(void);
1531
1532    /**
1533     * Get the configured cache flush interval time
1534     *
1535     * This gets the globally configured cache flush interval time, in
1536     * ticks
1537     *
1538     * @return The cache flush interval time
1539     * @ingroup Caches
1540     *
1541     * @see elm_all_flush()
1542     */
1543    EAPI int          elm_cache_flush_interval_get(void);
1544
1545    /**
1546     * Set the configured cache flush interval time
1547     *
1548     * This sets the globally configured cache flush interval time, in ticks
1549     *
1550     * @param size The cache flush interval time
1551     * @ingroup Caches
1552     *
1553     * @see elm_all_flush()
1554     */
1555    EAPI void         elm_cache_flush_interval_set(int size);
1556
1557    /**
1558     * Set the configured cache flush interval time for all applications on the
1559     * display
1560     *
1561     * This sets the globally configured cache flush interval time -- in ticks
1562     * -- for all applications on the display.
1563     *
1564     * @param size The cache flush interval time
1565     * @ingroup Caches
1566     */
1567    EAPI void         elm_cache_flush_interval_all_set(int size);
1568
1569    /**
1570     * Get the configured cache flush enabled state
1571     *
1572     * This gets the globally configured cache flush state - if it is enabled
1573     * or not. When cache flushing is enabled, elementary will regularly
1574     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1575     * memory and allow usage to re-seed caches and data in memory where it
1576     * can do so. An idle application will thus minimise its memory usage as
1577     * data will be freed from memory and not be re-loaded as it is idle and
1578     * not rendering or doing anything graphically right now.
1579     *
1580     * @return The cache flush state
1581     * @ingroup Caches
1582     *
1583     * @see elm_all_flush()
1584     */
1585    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1586
1587    /**
1588     * Set the configured cache flush enabled state
1589     *
1590     * This sets the globally configured cache flush enabled state.
1591     *
1592     * @param size The cache flush enabled state
1593     * @ingroup Caches
1594     *
1595     * @see elm_all_flush()
1596     */
1597    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1598
1599    /**
1600     * Set the configured cache flush enabled state for all applications on the
1601     * display
1602     *
1603     * This sets the globally configured cache flush enabled state for all
1604     * applications on the display.
1605     *
1606     * @param size The cache flush enabled state
1607     * @ingroup Caches
1608     */
1609    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1610
1611    /**
1612     * Get the configured font cache size
1613     *
1614     * This gets the globally configured font cache size, in bytes.
1615     *
1616     * @return The font cache size
1617     * @ingroup Caches
1618     */
1619    EAPI int          elm_font_cache_get(void);
1620
1621    /**
1622     * Set the configured font cache size
1623     *
1624     * This sets the globally configured font cache size, in bytes
1625     *
1626     * @param size The font cache size
1627     * @ingroup Caches
1628     */
1629    EAPI void         elm_font_cache_set(int size);
1630
1631    /**
1632     * Set the configured font cache size for all applications on the
1633     * display
1634     *
1635     * This sets the globally configured font cache size -- in bytes
1636     * -- for all applications on the display.
1637     *
1638     * @param size The font cache size
1639     * @ingroup Caches
1640     */
1641    EAPI void         elm_font_cache_all_set(int size);
1642
1643    /**
1644     * Get the configured image cache size
1645     *
1646     * This gets the globally configured image cache size, in bytes
1647     *
1648     * @return The image cache size
1649     * @ingroup Caches
1650     */
1651    EAPI int          elm_image_cache_get(void);
1652
1653    /**
1654     * Set the configured image cache size
1655     *
1656     * This sets the globally configured image cache size, in bytes
1657     *
1658     * @param size The image cache size
1659     * @ingroup Caches
1660     */
1661    EAPI void         elm_image_cache_set(int size);
1662
1663    /**
1664     * Set the configured image cache size for all applications on the
1665     * display
1666     *
1667     * This sets the globally configured image cache size -- in bytes
1668     * -- for all applications on the display.
1669     *
1670     * @param size The image cache size
1671     * @ingroup Caches
1672     */
1673    EAPI void         elm_image_cache_all_set(int size);
1674
1675    /**
1676     * Get the configured edje file cache size.
1677     *
1678     * This gets the globally configured edje file cache size, in number
1679     * of files.
1680     *
1681     * @return The edje file cache size
1682     * @ingroup Caches
1683     */
1684    EAPI int          elm_edje_file_cache_get(void);
1685
1686    /**
1687     * Set the configured edje file cache size
1688     *
1689     * This sets the globally configured edje file cache size, in number
1690     * of files.
1691     *
1692     * @param size The edje file cache size
1693     * @ingroup Caches
1694     */
1695    EAPI void         elm_edje_file_cache_set(int size);
1696
1697    /**
1698     * Set the configured edje file cache size for all applications on the
1699     * display
1700     *
1701     * This sets the globally configured edje file cache size -- in number
1702     * of files -- for all applications on the display.
1703     *
1704     * @param size The edje file cache size
1705     * @ingroup Caches
1706     */
1707    EAPI void         elm_edje_file_cache_all_set(int size);
1708
1709    /**
1710     * Get the configured edje collections (groups) cache size.
1711     *
1712     * This gets the globally configured edje collections cache size, in
1713     * number of collections.
1714     *
1715     * @return The edje collections cache size
1716     * @ingroup Caches
1717     */
1718    EAPI int          elm_edje_collection_cache_get(void);
1719
1720    /**
1721     * Set the configured edje collections (groups) cache size
1722     *
1723     * This sets the globally configured edje collections cache size, in
1724     * number of collections.
1725     *
1726     * @param size The edje collections cache size
1727     * @ingroup Caches
1728     */
1729    EAPI void         elm_edje_collection_cache_set(int size);
1730
1731    /**
1732     * Set the configured edje collections (groups) cache size for all
1733     * applications on the display
1734     *
1735     * This sets the globally configured edje collections cache size -- in
1736     * number of collections -- for all applications on the display.
1737     *
1738     * @param size The edje collections cache size
1739     * @ingroup Caches
1740     */
1741    EAPI void         elm_edje_collection_cache_all_set(int size);
1742
1743    /**
1744     * @}
1745     */
1746
1747    /**
1748     * @defgroup Scaling Widget Scaling
1749     *
1750     * Different widgets can be scaled independently. These functions
1751     * allow you to manipulate this scaling on a per-widget basis. The
1752     * object and all its children get their scaling factors multiplied
1753     * by the scale factor set. This is multiplicative, in that if a
1754     * child also has a scale size set it is in turn multiplied by its
1755     * parent's scale size. @c 1.0 means ā€œdon't scaleā€, @c 2.0 is
1756     * double size, @c 0.5 is half, etc.
1757     *
1758     * @ref general_functions_example_page "This" example contemplates
1759     * some of these functions.
1760     */
1761
1762    /**
1763     * Get the global scaling factor
1764     *
1765     * This gets the globally configured scaling factor that is applied to all
1766     * objects.
1767     *
1768     * @return The scaling factor
1769     * @ingroup Scaling
1770     */
1771    EAPI double       elm_scale_get(void);
1772
1773    /**
1774     * Set the global scaling factor
1775     *
1776     * This sets the globally configured scaling factor that is applied to all
1777     * objects.
1778     *
1779     * @param scale The scaling factor to set
1780     * @ingroup Scaling
1781     */
1782    EAPI void         elm_scale_set(double scale);
1783
1784    /**
1785     * Set the global scaling factor for all applications on the display
1786     *
1787     * This sets the globally configured scaling factor that is applied to all
1788     * objects for all applications.
1789     * @param scale The scaling factor to set
1790     * @ingroup Scaling
1791     */
1792    EAPI void         elm_scale_all_set(double scale);
1793
1794    /**
1795     * Set the scaling factor for a given Elementary object
1796     *
1797     * @param obj The Elementary to operate on
1798     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1799     * no scaling)
1800     *
1801     * @ingroup Scaling
1802     */
1803    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1804
1805    /**
1806     * Get the scaling factor for a given Elementary object
1807     *
1808     * @param obj The object
1809     * @return The scaling factor set by elm_object_scale_set()
1810     *
1811     * @ingroup Scaling
1812     */
1813    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1814
1815    /**
1816     * @defgroup Password_last_show Password last input show
1817     *
1818     * Last show feature of password mode enables user to view
1819     * the last input entered for few seconds before masking it.
1820     * These functions allow to set this feature in password mode
1821     * of entry widget and also allow to manipulate the duration
1822     * for which the input has to be visible.
1823     *
1824     * @{
1825     */
1826
1827    /**
1828     * Get show last setting of password mode.
1829     *
1830     * This gets the show last input setting of password mode which might be
1831     * enabled or disabled.
1832     *
1833     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1834     *            if it's disabled.
1835     * @ingroup Password_last_show
1836     */
1837    EAPI Eina_Bool elm_password_show_last_get(void);
1838
1839    /**
1840     * Set show last setting in password mode.
1841     *
1842     * This enables or disables show last setting of password mode.
1843     *
1844     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1845     * @see elm_password_show_last_timeout_set()
1846     * @ingroup Password_last_show
1847     */
1848    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1849
1850    /**
1851     * Get's the timeout value in last show password mode.
1852     *
1853     * This gets the time out value for which the last input entered in password
1854     * mode will be visible.
1855     *
1856     * @return The timeout value of last show password mode.
1857     * @ingroup Password_last_show
1858     */
1859    EAPI double elm_password_show_last_timeout_get(void);
1860
1861    /**
1862     * Set's the timeout value in last show password mode.
1863     *
1864     * This sets the time out value for which the last input entered in password
1865     * mode will be visible.
1866     *
1867     * @param password_show_last_timeout The timeout value.
1868     * @see elm_password_show_last_set()
1869     * @ingroup Password_last_show
1870     */
1871    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1872
1873    /**
1874     * @}
1875     */
1876
1877    /**
1878     * @defgroup UI-Mirroring Selective Widget mirroring
1879     *
1880     * These functions allow you to set ui-mirroring on specific
1881     * widgets or the whole interface. Widgets can be in one of two
1882     * modes, automatic and manual.  Automatic means they'll be changed
1883     * according to the system mirroring mode and manual means only
1884     * explicit changes will matter. You are not supposed to change
1885     * mirroring state of a widget set to automatic, will mostly work,
1886     * but the behavior is not really defined.
1887     *
1888     * @{
1889     */
1890
1891    EAPI Eina_Bool    elm_mirrored_get(void);
1892    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1893
1894    /**
1895     * Get the system mirrored mode. This determines the default mirrored mode
1896     * of widgets.
1897     *
1898     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1899     */
1900    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1901
1902    /**
1903     * Set the system mirrored mode. This determines the default mirrored mode
1904     * of widgets.
1905     *
1906     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1907     */
1908    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1909
1910    /**
1911     * Returns the widget's mirrored mode setting.
1912     *
1913     * @param obj The widget.
1914     * @return mirrored mode setting of the object.
1915     *
1916     **/
1917    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1918
1919    /**
1920     * Sets the widget's mirrored mode setting.
1921     * When widget in automatic mode, it follows the system mirrored mode set by
1922     * elm_mirrored_set().
1923     * @param obj The widget.
1924     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1925     */
1926    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1927
1928    /**
1929     * @}
1930     */
1931
1932    /**
1933     * Set the style to use by a widget
1934     *
1935     * Sets the style name that will define the appearance of a widget. Styles
1936     * vary from widget to widget and may also be defined by other themes
1937     * by means of extensions and overlays.
1938     *
1939     * @param obj The Elementary widget to style
1940     * @param style The style name to use
1941     *
1942     * @see elm_theme_extension_add()
1943     * @see elm_theme_extension_del()
1944     * @see elm_theme_overlay_add()
1945     * @see elm_theme_overlay_del()
1946     *
1947     * @ingroup Styles
1948     */
1949    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1950    /**
1951     * Get the style used by the widget
1952     *
1953     * This gets the style being used for that widget. Note that the string
1954     * pointer is only valid as longas the object is valid and the style doesn't
1955     * change.
1956     *
1957     * @param obj The Elementary widget to query for its style
1958     * @return The style name used
1959     *
1960     * @see elm_object_style_set()
1961     *
1962     * @ingroup Styles
1963     */
1964    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1965
1966    /**
1967     * @defgroup Styles Styles
1968     *
1969     * Widgets can have different styles of look. These generic API's
1970     * set styles of widgets, if they support them (and if the theme(s)
1971     * do).
1972     *
1973     * @ref general_functions_example_page "This" example contemplates
1974     * some of these functions.
1975     */
1976
1977    /**
1978     * Set the disabled state of an Elementary object.
1979     *
1980     * @param obj The Elementary object to operate on
1981     * @param disabled The state to put in in: @c EINA_TRUE for
1982     *        disabled, @c EINA_FALSE for enabled
1983     *
1984     * Elementary objects can be @b disabled, in which state they won't
1985     * receive input and, in general, will be themed differently from
1986     * their normal state, usually greyed out. Useful for contexts
1987     * where you don't want your users to interact with some of the
1988     * parts of you interface.
1989     *
1990     * This sets the state for the widget, either disabling it or
1991     * enabling it back.
1992     *
1993     * @ingroup Styles
1994     */
1995    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1996
1997    /**
1998     * Get the disabled state of an Elementary object.
1999     *
2000     * @param obj The Elementary object to operate on
2001     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
2002     *            if it's enabled (or on errors)
2003     *
2004     * This gets the state of the widget, which might be enabled or disabled.
2005     *
2006     * @ingroup Styles
2007     */
2008    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2009
2010    /**
2011     * @defgroup WidgetNavigation Widget Tree Navigation.
2012     *
2013     * How to check if an Evas Object is an Elementary widget? How to
2014     * get the first elementary widget that is parent of the given
2015     * object?  These are all covered in widget tree navigation.
2016     *
2017     * @ref general_functions_example_page "This" example contemplates
2018     * some of these functions.
2019     */
2020
2021    /**
2022     * Check if the given Evas Object is an Elementary widget.
2023     *
2024     * @param obj the object to query.
2025     * @return @c EINA_TRUE if it is an elementary widget variant,
2026     *         @c EINA_FALSE otherwise
2027     * @ingroup WidgetNavigation
2028     */
2029    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2030
2031    /**
2032     * Get the first parent of the given object that is an Elementary
2033     * widget.
2034     *
2035     * @param obj the Elementary object to query parent from.
2036     * @return the parent object that is an Elementary widget, or @c
2037     *         NULL, if it was not found.
2038     *
2039     * Use this to query for an object's parent widget.
2040     *
2041     * @note Most of Elementary users wouldn't be mixing non-Elementary
2042     * smart objects in the objects tree of an application, as this is
2043     * an advanced usage of Elementary with Evas. So, except for the
2044     * application's window, which is the root of that tree, all other
2045     * objects would have valid Elementary widget parents.
2046     *
2047     * @ingroup WidgetNavigation
2048     */
2049    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2050
2051    /**
2052     * Get the top level parent of an Elementary widget.
2053     *
2054     * @param obj The object to query.
2055     * @return The top level Elementary widget, or @c NULL if parent cannot be
2056     * found.
2057     * @ingroup WidgetNavigation
2058     */
2059    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2060
2061    /**
2062     * Get the string that represents this Elementary widget.
2063     *
2064     * @note Elementary is weird and exposes itself as a single
2065     *       Evas_Object_Smart_Class of type "elm_widget", so
2066     *       evas_object_type_get() always return that, making debug and
2067     *       language bindings hard. This function tries to mitigate this
2068     *       problem, but the solution is to change Elementary to use
2069     *       proper inheritance.
2070     *
2071     * @param obj the object to query.
2072     * @return Elementary widget name, or @c NULL if not a valid widget.
2073     * @ingroup WidgetNavigation
2074     */
2075    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2076
2077    /**
2078     * @defgroup Config Elementary Config
2079     *
2080     * Elementary configuration is formed by a set options bounded to a
2081     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
2082     * "finger size", etc. These are functions with which one syncronizes
2083     * changes made to those values to the configuration storing files, de
2084     * facto. You most probably don't want to use the functions in this
2085     * group unlees you're writing an elementary configuration manager.
2086     *
2087     * @{
2088     */
2089
2090    /**
2091     * Save back Elementary's configuration, so that it will persist on
2092     * future sessions.
2093     *
2094     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2095     * @ingroup Config
2096     *
2097     * This function will take effect -- thus, do I/O -- immediately. Use
2098     * it when you want to apply all configuration changes at once. The
2099     * current configuration set will get saved onto the current profile
2100     * configuration file.
2101     *
2102     */
2103    EAPI Eina_Bool    elm_config_save(void);
2104
2105    /**
2106     * Reload Elementary's configuration, bounded to current selected
2107     * profile.
2108     *
2109     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2110     * @ingroup Config
2111     *
2112     * Useful when you want to force reloading of configuration values for
2113     * a profile. If one removes user custom configuration directories,
2114     * for example, it will force a reload with system values instead.
2115     *
2116     */
2117    EAPI void         elm_config_reload(void);
2118
2119    /**
2120     * @}
2121     */
2122
2123    /**
2124     * @defgroup Profile Elementary Profile
2125     *
2126     * Profiles are pre-set options that affect the whole look-and-feel of
2127     * Elementary-based applications. There are, for example, profiles
2128     * aimed at desktop computer applications and others aimed at mobile,
2129     * touchscreen-based ones. You most probably don't want to use the
2130     * functions in this group unlees you're writing an elementary
2131     * configuration manager.
2132     *
2133     * @{
2134     */
2135
2136    /**
2137     * Get Elementary's profile in use.
2138     *
2139     * This gets the global profile that is applied to all Elementary
2140     * applications.
2141     *
2142     * @return The profile's name
2143     * @ingroup Profile
2144     */
2145    EAPI const char  *elm_profile_current_get(void);
2146
2147    /**
2148     * Get an Elementary's profile directory path in the filesystem. One
2149     * may want to fetch a system profile's dir or an user one (fetched
2150     * inside $HOME).
2151     *
2152     * @param profile The profile's name
2153     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2154     *                or a system one (@c EINA_FALSE)
2155     * @return The profile's directory path.
2156     * @ingroup Profile
2157     *
2158     * @note You must free it with elm_profile_dir_free().
2159     */
2160    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2161
2162    /**
2163     * Free an Elementary's profile directory path, as returned by
2164     * elm_profile_dir_get().
2165     *
2166     * @param p_dir The profile's path
2167     * @ingroup Profile
2168     *
2169     */
2170    EAPI void         elm_profile_dir_free(const char *p_dir);
2171
2172    /**
2173     * Get Elementary's list of available profiles.
2174     *
2175     * @return The profiles list. List node data are the profile name
2176     *         strings.
2177     * @ingroup Profile
2178     *
2179     * @note One must free this list, after usage, with the function
2180     *       elm_profile_list_free().
2181     */
2182    EAPI Eina_List   *elm_profile_list_get(void);
2183
2184    /**
2185     * Free Elementary's list of available profiles.
2186     *
2187     * @param l The profiles list, as returned by elm_profile_list_get().
2188     * @ingroup Profile
2189     *
2190     */
2191    EAPI void         elm_profile_list_free(Eina_List *l);
2192
2193    /**
2194     * Set Elementary's profile.
2195     *
2196     * This sets the global profile that is applied to Elementary
2197     * applications. Just the process the call comes from will be
2198     * affected.
2199     *
2200     * @param profile The profile's name
2201     * @ingroup Profile
2202     *
2203     */
2204    EAPI void         elm_profile_set(const char *profile);
2205
2206    /**
2207     * Set Elementary's profile.
2208     *
2209     * This sets the global profile that is applied to all Elementary
2210     * applications. All running Elementary windows will be affected.
2211     *
2212     * @param profile The profile's name
2213     * @ingroup Profile
2214     *
2215     */
2216    EAPI void         elm_profile_all_set(const char *profile);
2217
2218    /**
2219     * @}
2220     */
2221
2222    /**
2223     * @defgroup Engine Elementary Engine
2224     *
2225     * These are functions setting and querying which rendering engine
2226     * Elementary will use for drawing its windows' pixels.
2227     *
2228     * The following are the available engines:
2229     * @li "software_x11"
2230     * @li "fb"
2231     * @li "directfb"
2232     * @li "software_16_x11"
2233     * @li "software_8_x11"
2234     * @li "xrender_x11"
2235     * @li "opengl_x11"
2236     * @li "software_gdi"
2237     * @li "software_16_wince_gdi"
2238     * @li "sdl"
2239     * @li "software_16_sdl"
2240     * @li "opengl_sdl"
2241     * @li "buffer"
2242     * @li "ews"
2243     * @li "opengl_cocoa"
2244     * @li "psl1ght"
2245     *
2246     * @{
2247     */
2248
2249    /**
2250     * @brief Get Elementary's rendering engine in use.
2251     *
2252     * @return The rendering engine's name
2253     * @note there's no need to free the returned string, here.
2254     *
2255     * This gets the global rendering engine that is applied to all Elementary
2256     * applications.
2257     *
2258     * @see elm_engine_set()
2259     */
2260    EAPI const char  *elm_engine_current_get(void);
2261
2262    /**
2263     * @brief Set Elementary's rendering engine for use.
2264     *
2265     * @param engine The rendering engine's name
2266     *
2267     * This sets global rendering engine that is applied to all Elementary
2268     * applications. Note that it will take effect only to Elementary windows
2269     * created after this is called.
2270     *
2271     * @see elm_win_add()
2272     */
2273    EAPI void         elm_engine_set(const char *engine);
2274
2275    /**
2276     * @}
2277     */
2278
2279    /**
2280     * @defgroup Fonts Elementary Fonts
2281     *
2282     * These are functions dealing with font rendering, selection and the
2283     * like for Elementary applications. One might fetch which system
2284     * fonts are there to use and set custom fonts for individual classes
2285     * of UI items containing text (text classes).
2286     *
2287     * @{
2288     */
2289
2290   typedef struct _Elm_Text_Class
2291     {
2292        const char *name;
2293        const char *desc;
2294     } Elm_Text_Class;
2295
2296   typedef struct _Elm_Font_Overlay
2297     {
2298        const char     *text_class;
2299        const char     *font;
2300        Evas_Font_Size  size;
2301     } Elm_Font_Overlay;
2302
2303   typedef struct _Elm_Font_Properties
2304     {
2305        const char *name;
2306        Eina_List  *styles;
2307     } Elm_Font_Properties;
2308
2309    /**
2310     * Get Elementary's list of supported text classes.
2311     *
2312     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2313     * @ingroup Fonts
2314     *
2315     * Release the list with elm_text_classes_list_free().
2316     */
2317    EAPI const Eina_List     *elm_text_classes_list_get(void);
2318
2319    /**
2320     * Free Elementary's list of supported text classes.
2321     *
2322     * @ingroup Fonts
2323     *
2324     * @see elm_text_classes_list_get().
2325     */
2326    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2327
2328    /**
2329     * Get Elementary's list of font overlays, set with
2330     * elm_font_overlay_set().
2331     *
2332     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2333     * data.
2334     *
2335     * @ingroup Fonts
2336     *
2337     * For each text class, one can set a <b>font overlay</b> for it,
2338     * overriding the default font properties for that class coming from
2339     * the theme in use. There is no need to free this list.
2340     *
2341     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2342     */
2343    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2344
2345    /**
2346     * Set a font overlay for a given Elementary text class.
2347     *
2348     * @param text_class Text class name
2349     * @param font Font name and style string
2350     * @param size Font size
2351     *
2352     * @ingroup Fonts
2353     *
2354     * @p font has to be in the format returned by
2355     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2356     * and elm_font_overlay_unset().
2357     */
2358    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2359
2360    /**
2361     * Unset a font overlay for a given Elementary text class.
2362     *
2363     * @param text_class Text class name
2364     *
2365     * @ingroup Fonts
2366     *
2367     * This will bring back text elements belonging to text class
2368     * @p text_class back to their default font settings.
2369     */
2370    EAPI void                 elm_font_overlay_unset(const char *text_class);
2371
2372    /**
2373     * Apply the changes made with elm_font_overlay_set() and
2374     * elm_font_overlay_unset() on the current Elementary window.
2375     *
2376     * @ingroup Fonts
2377     *
2378     * This applies all font overlays set to all objects in the UI.
2379     */
2380    EAPI void                 elm_font_overlay_apply(void);
2381
2382    /**
2383     * Apply the changes made with elm_font_overlay_set() and
2384     * elm_font_overlay_unset() on all Elementary application windows.
2385     *
2386     * @ingroup Fonts
2387     *
2388     * This applies all font overlays set to all objects in the UI.
2389     */
2390    EAPI void                 elm_font_overlay_all_apply(void);
2391
2392    /**
2393     * Translate a font (family) name string in fontconfig's font names
2394     * syntax into an @c Elm_Font_Properties struct.
2395     *
2396     * @param font The font name and styles string
2397     * @return the font properties struct
2398     *
2399     * @ingroup Fonts
2400     *
2401     * @note The reverse translation can be achived with
2402     * elm_font_fontconfig_name_get(), for one style only (single font
2403     * instance, not family).
2404     */
2405    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2406
2407    /**
2408     * Free font properties return by elm_font_properties_get().
2409     *
2410     * @param efp the font properties struct
2411     *
2412     * @ingroup Fonts
2413     */
2414    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2415
2416    /**
2417     * Translate a font name, bound to a style, into fontconfig's font names
2418     * syntax.
2419     *
2420     * @param name The font (family) name
2421     * @param style The given style (may be @c NULL)
2422     *
2423     * @return the font name and style string
2424     *
2425     * @ingroup Fonts
2426     *
2427     * @note The reverse translation can be achived with
2428     * elm_font_properties_get(), for one style only (single font
2429     * instance, not family).
2430     */
2431    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2432
2433    /**
2434     * Free the font string return by elm_font_fontconfig_name_get().
2435     *
2436     * @param efp the font properties struct
2437     *
2438     * @ingroup Fonts
2439     */
2440    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2441
2442    /**
2443     * Create a font hash table of available system fonts.
2444     *
2445     * One must call it with @p list being the return value of
2446     * evas_font_available_list(). The hash will be indexed by font
2447     * (family) names, being its values @c Elm_Font_Properties blobs.
2448     *
2449     * @param list The list of available system fonts, as returned by
2450     * evas_font_available_list().
2451     * @return the font hash.
2452     *
2453     * @ingroup Fonts
2454     *
2455     * @note The user is supposed to get it populated at least with 3
2456     * default font families (Sans, Serif, Monospace), which should be
2457     * present on most systems.
2458     */
2459    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2460
2461    /**
2462     * Free the hash return by elm_font_available_hash_add().
2463     *
2464     * @param hash the hash to be freed.
2465     *
2466     * @ingroup Fonts
2467     */
2468    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2469
2470    /**
2471     * @}
2472     */
2473
2474    /**
2475     * @defgroup Fingers Fingers
2476     *
2477     * Elementary is designed to be finger-friendly for touchscreens,
2478     * and so in addition to scaling for display resolution, it can
2479     * also scale based on finger "resolution" (or size). You can then
2480     * customize the granularity of the areas meant to receive clicks
2481     * on touchscreens.
2482     *
2483     * Different profiles may have pre-set values for finger sizes.
2484     *
2485     * @ref general_functions_example_page "This" example contemplates
2486     * some of these functions.
2487     *
2488     * @{
2489     */
2490
2491    /**
2492     * Get the configured "finger size"
2493     *
2494     * @return The finger size
2495     *
2496     * This gets the globally configured finger size, <b>in pixels</b>
2497     *
2498     * @ingroup Fingers
2499     */
2500    EAPI Evas_Coord       elm_finger_size_get(void);
2501
2502    /**
2503     * Set the configured finger size
2504     *
2505     * This sets the globally configured finger size in pixels
2506     *
2507     * @param size The finger size
2508     * @ingroup Fingers
2509     */
2510    EAPI void             elm_finger_size_set(Evas_Coord size);
2511
2512    /**
2513     * Set the configured finger size for all applications on the display
2514     *
2515     * This sets the globally configured finger size in pixels for all
2516     * applications on the display
2517     *
2518     * @param size The finger size
2519     * @ingroup Fingers
2520     */
2521    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2522
2523    /**
2524     * @}
2525     */
2526
2527    /**
2528     * @defgroup Focus Focus
2529     *
2530     * An Elementary application has, at all times, one (and only one)
2531     * @b focused object. This is what determines where the input
2532     * events go to within the application's window. Also, focused
2533     * objects can be decorated differently, in order to signal to the
2534     * user where the input is, at a given moment.
2535     *
2536     * Elementary applications also have the concept of <b>focus
2537     * chain</b>: one can cycle through all the windows' focusable
2538     * objects by input (tab key) or programmatically. The default
2539     * focus chain for an application is the one define by the order in
2540     * which the widgets where added in code. One will cycle through
2541     * top level widgets, and, for each one containg sub-objects, cycle
2542     * through them all, before returning to the level
2543     * above. Elementary also allows one to set @b custom focus chains
2544     * for their applications.
2545     *
2546     * Besides the focused decoration a widget may exhibit, when it
2547     * gets focus, Elementary has a @b global focus highlight object
2548     * that can be enabled for a window. If one chooses to do so, this
2549     * extra highlight effect will surround the current focused object,
2550     * too.
2551     *
2552     * @note Some Elementary widgets are @b unfocusable, after
2553     * creation, by their very nature: they are not meant to be
2554     * interacted with input events, but are there just for visual
2555     * purposes.
2556     *
2557     * @ref general_functions_example_page "This" example contemplates
2558     * some of these functions.
2559     */
2560
2561    /**
2562     * Get the enable status of the focus highlight
2563     *
2564     * This gets whether the highlight on focused objects is enabled or not
2565     * @ingroup Focus
2566     */
2567    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2568
2569    /**
2570     * Set the enable status of the focus highlight
2571     *
2572     * Set whether to show or not the highlight on focused objects
2573     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2574     * @ingroup Focus
2575     */
2576    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2577
2578    /**
2579     * Get the enable status of the highlight animation
2580     *
2581     * Get whether the focus highlight, if enabled, will animate its switch from
2582     * one object to the next
2583     * @ingroup Focus
2584     */
2585    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2586
2587    /**
2588     * Set the enable status of the highlight animation
2589     *
2590     * Set whether the focus highlight, if enabled, will animate its switch from
2591     * one object to the next
2592     * @param animate Enable animation if EINA_TRUE, disable otherwise
2593     * @ingroup Focus
2594     */
2595    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2596
2597    /**
2598     * Get the whether an Elementary object has the focus or not.
2599     *
2600     * @param obj The Elementary object to get the information from
2601     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2602     *            not (and on errors).
2603     *
2604     * @see elm_object_focus_set()
2605     *
2606     * @ingroup Focus
2607     */
2608    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2609
2610    /**
2611     * Set/unset focus to a given Elementary object.
2612     *
2613     * @param obj The Elementary object to operate on.
2614     * @param enable @c EINA_TRUE Set focus to a given object,
2615     *               @c EINA_FALSE Unset focus to a given object.
2616     *
2617     * @note When you set focus to this object, if it can handle focus, will
2618     * take the focus away from the one who had it previously and will, for
2619     * now on, be the one receiving input events. Unsetting focus will remove
2620     * the focus from @p obj, passing it back to the previous element in the
2621     * focus chain list.
2622     *
2623     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2624     *
2625     * @ingroup Focus
2626     */
2627    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2628
2629    /**
2630     * Make a given Elementary object the focused one.
2631     *
2632     * @param obj The Elementary object to make focused.
2633     *
2634     * @note This object, if it can handle focus, will take the focus
2635     * away from the one who had it previously and will, for now on, be
2636     * the one receiving input events.
2637     *
2638     * @see elm_object_focus_get()
2639     * @deprecated use elm_object_focus_set() instead.
2640     *
2641     * @ingroup Focus
2642     */
2643    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2644
2645    /**
2646     * Remove the focus from an Elementary object
2647     *
2648     * @param obj The Elementary to take focus from
2649     *
2650     * This removes the focus from @p obj, passing it back to the
2651     * previous element in the focus chain list.
2652     *
2653     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2654     * @deprecated use elm_object_focus_set() instead.
2655     *
2656     * @ingroup Focus
2657     */
2658    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2659
2660    /**
2661     * Set the ability for an Element object to be focused
2662     *
2663     * @param obj The Elementary object to operate on
2664     * @param enable @c EINA_TRUE if the object can be focused, @c
2665     *        EINA_FALSE if not (and on errors)
2666     *
2667     * This sets whether the object @p obj is able to take focus or
2668     * not. Unfocusable objects do nothing when programmatically
2669     * focused, being the nearest focusable parent object the one
2670     * really getting focus. Also, when they receive mouse input, they
2671     * will get the event, but not take away the focus from where it
2672     * was previously.
2673     *
2674     * @ingroup Focus
2675     */
2676    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2677
2678    /**
2679     * Get whether an Elementary object is focusable or not
2680     *
2681     * @param obj The Elementary object to operate on
2682     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2683     *             EINA_FALSE if not (and on errors)
2684     *
2685     * @note Objects which are meant to be interacted with by input
2686     * events are created able to be focused, by default. All the
2687     * others are not.
2688     *
2689     * @ingroup Focus
2690     */
2691    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2692
2693    /**
2694     * Set custom focus chain.
2695     *
2696     * This function overwrites any previous custom focus chain within
2697     * the list of objects. The previous list will be deleted and this list
2698     * will be managed by elementary. After it is set, don't modify it.
2699     *
2700     * @note On focus cycle, only will be evaluated children of this container.
2701     *
2702     * @param obj The container object
2703     * @param objs Chain of objects to pass focus
2704     * @ingroup Focus
2705     */
2706    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2707
2708    /**
2709     * Unset a custom focus chain on a given Elementary widget
2710     *
2711     * @param obj The container object to remove focus chain from
2712     *
2713     * Any focus chain previously set on @p obj (for its child objects)
2714     * is removed entirely after this call.
2715     *
2716     * @ingroup Focus
2717     */
2718    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2719
2720    /**
2721     * Get custom focus chain
2722     *
2723     * @param obj The container object
2724     * @ingroup Focus
2725     */
2726    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2727
2728    /**
2729     * Append object to custom focus chain.
2730     *
2731     * @note If relative_child equal to NULL or not in custom chain, the object
2732     * will be added in end.
2733     *
2734     * @note On focus cycle, only will be evaluated children of this container.
2735     *
2736     * @param obj The container object
2737     * @param child The child to be added in custom chain
2738     * @param relative_child The relative object to position the child
2739     * @ingroup Focus
2740     */
2741    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2742
2743    /**
2744     * Prepend object to custom focus chain.
2745     *
2746     * @note If relative_child equal to NULL or not in custom chain, the object
2747     * will be added in begin.
2748     *
2749     * @note On focus cycle, only will be evaluated children of this container.
2750     *
2751     * @param obj The container object
2752     * @param child The child to be added in custom chain
2753     * @param relative_child The relative object to position the child
2754     * @ingroup Focus
2755     */
2756    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2757
2758    /**
2759     * Give focus to next object in object tree.
2760     *
2761     * Give focus to next object in focus chain of one object sub-tree.
2762     * If the last object of chain already have focus, the focus will go to the
2763     * first object of chain.
2764     *
2765     * @param obj The object root of sub-tree
2766     * @param dir Direction to cycle the focus
2767     *
2768     * @ingroup Focus
2769     */
2770    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2771
2772    /**
2773     * Give focus to near object in one direction.
2774     *
2775     * Give focus to near object in direction of one object.
2776     * If none focusable object in given direction, the focus will not change.
2777     *
2778     * @param obj The reference object
2779     * @param x Horizontal component of direction to focus
2780     * @param y Vertical component of direction to focus
2781     *
2782     * @ingroup Focus
2783     */
2784    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2785
2786    /**
2787     * Make the elementary object and its children to be unfocusable
2788     * (or focusable).
2789     *
2790     * @param obj The Elementary object to operate on
2791     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2792     *        @c EINA_FALSE for focusable.
2793     *
2794     * This sets whether the object @p obj and its children objects
2795     * are able to take focus or not. If the tree is set as unfocusable,
2796     * newest focused object which is not in this tree will get focus.
2797     * This API can be helpful for an object to be deleted.
2798     * When an object will be deleted soon, it and its children may not
2799     * want to get focus (by focus reverting or by other focus controls).
2800     * Then, just use this API before deleting.
2801     *
2802     * @see elm_object_tree_unfocusable_get()
2803     *
2804     * @ingroup Focus
2805     */
2806    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2807
2808    /**
2809     * Get whether an Elementary object and its children are unfocusable or not.
2810     *
2811     * @param obj The Elementary object to get the information from
2812     * @return @c EINA_TRUE, if the tree is unfocussable,
2813     *         @c EINA_FALSE if not (and on errors).
2814     *
2815     * @see elm_object_tree_unfocusable_set()
2816     *
2817     * @ingroup Focus
2818     */
2819    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2820
2821    /**
2822     * @defgroup Scrolling Scrolling
2823     *
2824     * These are functions setting how scrollable views in Elementary
2825     * widgets should behave on user interaction.
2826     *
2827     * @{
2828     */
2829
2830    /**
2831     * Get whether scrollers should bounce when they reach their
2832     * viewport's edge during a scroll.
2833     *
2834     * @return the thumb scroll bouncing state
2835     *
2836     * This is the default behavior for touch screens, in general.
2837     * @ingroup Scrolling
2838     */
2839    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2840
2841    /**
2842     * Set whether scrollers should bounce when they reach their
2843     * viewport's edge during a scroll.
2844     *
2845     * @param enabled the thumb scroll bouncing state
2846     *
2847     * @see elm_thumbscroll_bounce_enabled_get()
2848     * @ingroup Scrolling
2849     */
2850    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2851
2852    /**
2853     * Set whether scrollers should bounce when they reach their
2854     * viewport's edge during a scroll, for all Elementary application
2855     * windows.
2856     *
2857     * @param enabled the thumb scroll bouncing state
2858     *
2859     * @see elm_thumbscroll_bounce_enabled_get()
2860     * @ingroup Scrolling
2861     */
2862    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2863
2864    /**
2865     * Get the amount of inertia a scroller will impose at bounce
2866     * animations.
2867     *
2868     * @return the thumb scroll bounce friction
2869     *
2870     * @ingroup Scrolling
2871     */
2872    EAPI double           elm_scroll_bounce_friction_get(void);
2873
2874    /**
2875     * Set the amount of inertia a scroller will impose at bounce
2876     * animations.
2877     *
2878     * @param friction the thumb scroll bounce friction
2879     *
2880     * @see elm_thumbscroll_bounce_friction_get()
2881     * @ingroup Scrolling
2882     */
2883    EAPI void             elm_scroll_bounce_friction_set(double friction);
2884
2885    /**
2886     * Set the amount of inertia a scroller will impose at bounce
2887     * animations, for all Elementary application windows.
2888     *
2889     * @param friction the thumb scroll bounce friction
2890     *
2891     * @see elm_thumbscroll_bounce_friction_get()
2892     * @ingroup Scrolling
2893     */
2894    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2895
2896    /**
2897     * Get the amount of inertia a <b>paged</b> scroller will impose at
2898     * page fitting animations.
2899     *
2900     * @return the page scroll friction
2901     *
2902     * @ingroup Scrolling
2903     */
2904    EAPI double           elm_scroll_page_scroll_friction_get(void);
2905
2906    /**
2907     * Set the amount of inertia a <b>paged</b> scroller will impose at
2908     * page fitting animations.
2909     *
2910     * @param friction the page scroll friction
2911     *
2912     * @see elm_thumbscroll_page_scroll_friction_get()
2913     * @ingroup Scrolling
2914     */
2915    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2916
2917    /**
2918     * Set the amount of inertia a <b>paged</b> scroller will impose at
2919     * page fitting animations, for all Elementary application windows.
2920     *
2921     * @param friction the page scroll friction
2922     *
2923     * @see elm_thumbscroll_page_scroll_friction_get()
2924     * @ingroup Scrolling
2925     */
2926    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2927
2928    /**
2929     * Get the amount of inertia a scroller will impose at region bring
2930     * animations.
2931     *
2932     * @return the bring in scroll friction
2933     *
2934     * @ingroup Scrolling
2935     */
2936    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2937
2938    /**
2939     * Set the amount of inertia a scroller will impose at region bring
2940     * animations.
2941     *
2942     * @param friction the bring in scroll friction
2943     *
2944     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2945     * @ingroup Scrolling
2946     */
2947    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2948
2949    /**
2950     * Set the amount of inertia a scroller will impose at region bring
2951     * animations, for all Elementary application windows.
2952     *
2953     * @param friction the bring in scroll friction
2954     *
2955     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2956     * @ingroup Scrolling
2957     */
2958    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2959
2960    /**
2961     * Get the amount of inertia scrollers will impose at animations
2962     * triggered by Elementary widgets' zooming API.
2963     *
2964     * @return the zoom friction
2965     *
2966     * @ingroup Scrolling
2967     */
2968    EAPI double           elm_scroll_zoom_friction_get(void);
2969
2970    /**
2971     * Set the amount of inertia scrollers will impose at animations
2972     * triggered by Elementary widgets' zooming API.
2973     *
2974     * @param friction the zoom friction
2975     *
2976     * @see elm_thumbscroll_zoom_friction_get()
2977     * @ingroup Scrolling
2978     */
2979    EAPI void             elm_scroll_zoom_friction_set(double friction);
2980
2981    /**
2982     * Set the amount of inertia scrollers will impose at animations
2983     * triggered by Elementary widgets' zooming API, for all Elementary
2984     * application windows.
2985     *
2986     * @param friction the zoom friction
2987     *
2988     * @see elm_thumbscroll_zoom_friction_get()
2989     * @ingroup Scrolling
2990     */
2991    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2992
2993    /**
2994     * Get whether scrollers should be draggable from any point in their
2995     * views.
2996     *
2997     * @return the thumb scroll state
2998     *
2999     * @note This is the default behavior for touch screens, in general.
3000     * @note All other functions namespaced with "thumbscroll" will only
3001     *       have effect if this mode is enabled.
3002     *
3003     * @ingroup Scrolling
3004     */
3005    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
3006
3007    /**
3008     * Set whether scrollers should be draggable from any point in their
3009     * views.
3010     *
3011     * @param enabled the thumb scroll state
3012     *
3013     * @see elm_thumbscroll_enabled_get()
3014     * @ingroup Scrolling
3015     */
3016    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
3017
3018    /**
3019     * Set whether scrollers should be draggable from any point in their
3020     * views, for all Elementary application windows.
3021     *
3022     * @param enabled the thumb scroll state
3023     *
3024     * @see elm_thumbscroll_enabled_get()
3025     * @ingroup Scrolling
3026     */
3027    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
3028
3029    /**
3030     * Get the number of pixels one should travel while dragging a
3031     * scroller's view to actually trigger scrolling.
3032     *
3033     * @return the thumb scroll threshould
3034     *
3035     * One would use higher values for touch screens, in general, because
3036     * of their inherent imprecision.
3037     * @ingroup Scrolling
3038     */
3039    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
3040
3041    /**
3042     * Set the number of pixels one should travel while dragging a
3043     * scroller's view to actually trigger scrolling.
3044     *
3045     * @param threshold the thumb scroll threshould
3046     *
3047     * @see elm_thumbscroll_threshould_get()
3048     * @ingroup Scrolling
3049     */
3050    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
3051
3052    /**
3053     * Set the number of pixels one should travel while dragging a
3054     * scroller's view to actually trigger scrolling, for all Elementary
3055     * application windows.
3056     *
3057     * @param threshold the thumb scroll threshould
3058     *
3059     * @see elm_thumbscroll_threshould_get()
3060     * @ingroup Scrolling
3061     */
3062    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
3063
3064    /**
3065     * Get the minimum speed of mouse cursor movement which will trigger
3066     * list self scrolling animation after a mouse up event
3067     * (pixels/second).
3068     *
3069     * @return the thumb scroll momentum threshould
3070     *
3071     * @ingroup Scrolling
3072     */
3073    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
3074
3075    /**
3076     * Set the minimum speed of mouse cursor movement which will trigger
3077     * list self scrolling animation after a mouse up event
3078     * (pixels/second).
3079     *
3080     * @param threshold the thumb scroll momentum threshould
3081     *
3082     * @see elm_thumbscroll_momentum_threshould_get()
3083     * @ingroup Scrolling
3084     */
3085    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
3086
3087    /**
3088     * Set the minimum speed of mouse cursor movement which will trigger
3089     * list self scrolling animation after a mouse up event
3090     * (pixels/second), for all Elementary application windows.
3091     *
3092     * @param threshold the thumb scroll momentum threshould
3093     *
3094     * @see elm_thumbscroll_momentum_threshould_get()
3095     * @ingroup Scrolling
3096     */
3097    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3098
3099    /**
3100     * Get the amount of inertia a scroller will impose at self scrolling
3101     * animations.
3102     *
3103     * @return the thumb scroll friction
3104     *
3105     * @ingroup Scrolling
3106     */
3107    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3108
3109    /**
3110     * Set the amount of inertia a scroller will impose at self scrolling
3111     * animations.
3112     *
3113     * @param friction the thumb scroll friction
3114     *
3115     * @see elm_thumbscroll_friction_get()
3116     * @ingroup Scrolling
3117     */
3118    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3119
3120    /**
3121     * Set the amount of inertia a scroller will impose at self scrolling
3122     * animations, for all Elementary application windows.
3123     *
3124     * @param friction the thumb scroll friction
3125     *
3126     * @see elm_thumbscroll_friction_get()
3127     * @ingroup Scrolling
3128     */
3129    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3130
3131    /**
3132     * Get the amount of lag between your actual mouse cursor dragging
3133     * movement and a scroller's view movement itself, while pushing it
3134     * into bounce state manually.
3135     *
3136     * @return the thumb scroll border friction
3137     *
3138     * @ingroup Scrolling
3139     */
3140    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3141
3142    /**
3143     * Set the amount of lag between your actual mouse cursor dragging
3144     * movement and a scroller's view movement itself, while pushing it
3145     * into bounce state manually.
3146     *
3147     * @param friction the thumb scroll border friction. @c 0.0 for
3148     *        perfect synchrony between two movements, @c 1.0 for maximum
3149     *        lag.
3150     *
3151     * @see elm_thumbscroll_border_friction_get()
3152     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3153     *
3154     * @ingroup Scrolling
3155     */
3156    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3157
3158    /**
3159     * Set the amount of lag between your actual mouse cursor dragging
3160     * movement and a scroller's view movement itself, while pushing it
3161     * into bounce state manually, for all Elementary application windows.
3162     *
3163     * @param friction the thumb scroll border friction. @c 0.0 for
3164     *        perfect synchrony between two movements, @c 1.0 for maximum
3165     *        lag.
3166     *
3167     * @see elm_thumbscroll_border_friction_get()
3168     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3169     *
3170     * @ingroup Scrolling
3171     */
3172    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3173
3174    /**
3175     * Get the sensitivity amount which is be multiplied by the length of
3176     * mouse dragging.
3177     *
3178     * @return the thumb scroll sensitivity friction
3179     *
3180     * @ingroup Scrolling
3181     */
3182    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3183
3184    /**
3185     * Set the sensitivity amount which is be multiplied by the length of
3186     * mouse dragging.
3187     *
3188     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3189     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3190     *        is proper.
3191     *
3192     * @see elm_thumbscroll_sensitivity_friction_get()
3193     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3194     *
3195     * @ingroup Scrolling
3196     */
3197    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3198
3199    /**
3200     * Set the sensitivity amount which is be multiplied by the length of
3201     * mouse dragging, for all Elementary application windows.
3202     *
3203     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3204     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3205     *        is proper.
3206     *
3207     * @see elm_thumbscroll_sensitivity_friction_get()
3208     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3209     *
3210     * @ingroup Scrolling
3211     */
3212    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3213
3214    /**
3215     * @}
3216     */
3217
3218    /**
3219     * @defgroup Scrollhints Scrollhints
3220     *
3221     * Objects when inside a scroller can scroll, but this may not always be
3222     * desirable in certain situations. This allows an object to hint to itself
3223     * and parents to "not scroll" in one of 2 ways. If any child object of a
3224     * scroller has pushed a scroll freeze or hold then it affects all parent
3225     * scrollers until all children have released them.
3226     *
3227     * 1. To hold on scrolling. This means just flicking and dragging may no
3228     * longer scroll, but pressing/dragging near an edge of the scroller will
3229     * still scroll. This is automatically used by the entry object when
3230     * selecting text.
3231     *
3232     * 2. To totally freeze scrolling. This means it stops. until
3233     * popped/released.
3234     *
3235     * @{
3236     */
3237
3238    /**
3239     * Push the scroll hold by 1
3240     *
3241     * This increments the scroll hold count by one. If it is more than 0 it will
3242     * take effect on the parents of the indicated object.
3243     *
3244     * @param obj The object
3245     * @ingroup Scrollhints
3246     */
3247    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3248
3249    /**
3250     * Pop the scroll hold by 1
3251     *
3252     * This decrements the scroll hold count by one. If it is more than 0 it will
3253     * take effect on the parents of the indicated object.
3254     *
3255     * @param obj The object
3256     * @ingroup Scrollhints
3257     */
3258    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3259
3260    /**
3261     * Push the scroll freeze by 1
3262     *
3263     * This increments the scroll freeze count by one. If it is more
3264     * than 0 it will take effect on the parents of the indicated
3265     * object.
3266     *
3267     * @param obj The object
3268     * @ingroup Scrollhints
3269     */
3270    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3271
3272    /**
3273     * Pop the scroll freeze by 1
3274     *
3275     * This decrements the scroll freeze count by one. If it is more
3276     * than 0 it will take effect on the parents of the indicated
3277     * object.
3278     *
3279     * @param obj The object
3280     * @ingroup Scrollhints
3281     */
3282    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3283
3284    /**
3285     * Lock the scrolling of the given widget (and thus all parents)
3286     *
3287     * This locks the given object from scrolling in the X axis (and implicitly
3288     * also locks all parent scrollers too from doing the same).
3289     *
3290     * @param obj The object
3291     * @param lock The lock state (1 == locked, 0 == unlocked)
3292     * @ingroup Scrollhints
3293     */
3294    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3295
3296    /**
3297     * Lock the scrolling of the given widget (and thus all parents)
3298     *
3299     * This locks the given object from scrolling in the Y axis (and implicitly
3300     * also locks all parent scrollers too from doing the same).
3301     *
3302     * @param obj The object
3303     * @param lock The lock state (1 == locked, 0 == unlocked)
3304     * @ingroup Scrollhints
3305     */
3306    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3307
3308    /**
3309     * Get the scrolling lock of the given widget
3310     *
3311     * This gets the lock for X axis scrolling.
3312     *
3313     * @param obj The object
3314     * @ingroup Scrollhints
3315     */
3316    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3317
3318    /**
3319     * Get the scrolling lock of the given widget
3320     *
3321     * This gets the lock for X axis scrolling.
3322     *
3323     * @param obj The object
3324     * @ingroup Scrollhints
3325     */
3326    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3327
3328    /**
3329     * @}
3330     */
3331
3332    /**
3333     * Send a signal to the widget edje object.
3334     *
3335     * This function sends a signal to the edje object of the obj. An
3336     * edje program can respond to a signal by specifying matching
3337     * 'signal' and 'source' fields.
3338     *
3339     * @param obj The object
3340     * @param emission The signal's name.
3341     * @param source The signal's source.
3342     * @ingroup General
3343     */
3344    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3345
3346    /**
3347     * Add a callback for a signal emitted by widget edje object.
3348     *
3349     * This function connects a callback function to a signal emitted by the
3350     * edje object of the obj.
3351     * Globs can occur in either the emission or source name.
3352     *
3353     * @param obj The object
3354     * @param emission The signal's name.
3355     * @param source The signal's source.
3356     * @param func The callback function to be executed when the signal is
3357     * emitted.
3358     * @param data A pointer to data to pass in to the callback function.
3359     * @ingroup General
3360     */
3361    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);
3362
3363    /**
3364     * Remove a signal-triggered callback from a widget edje object.
3365     *
3366     * This function removes a callback, previoulsy attached to a
3367     * signal emitted by the edje object of the obj.  The parameters
3368     * emission, source and func must match exactly those passed to a
3369     * previous call to elm_object_signal_callback_add(). The data
3370     * pointer that was passed to this call will be returned.
3371     *
3372     * @param obj The object
3373     * @param emission The signal's name.
3374     * @param source The signal's source.
3375     * @param func The callback function to be executed when the signal is
3376     * emitted.
3377     * @return The data pointer
3378     * @ingroup General
3379     */
3380    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);
3381
3382    /**
3383     * Add a callback for input events (key up, key down, mouse wheel)
3384     * on a given Elementary widget
3385     *
3386     * @param obj The widget to add an event callback on
3387     * @param func The callback function to be executed when the event
3388     * happens
3389     * @param data Data to pass in to @p func
3390     *
3391     * Every widget in an Elementary interface set to receive focus,
3392     * with elm_object_focus_allow_set(), will propagate @b all of its
3393     * key up, key down and mouse wheel input events up to its parent
3394     * object, and so on. All of the focusable ones in this chain which
3395     * had an event callback set, with this call, will be able to treat
3396     * those events. There are two ways of making the propagation of
3397     * these event upwards in the tree of widgets to @b cease:
3398     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3399     *   the event was @b not processed, so the propagation will go on.
3400     * - The @c event_info pointer passed to @p func will contain the
3401     *   event's structure and, if you OR its @c event_flags inner
3402     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3403     *   one has already handled it, thus killing the event's
3404     *   propagation, too.
3405     *
3406     * @note Your event callback will be issued on those events taking
3407     * place only if no other child widget of @obj has consumed the
3408     * event already.
3409     *
3410     * @note Not to be confused with @c
3411     * evas_object_event_callback_add(), which will add event callbacks
3412     * per type on general Evas objects (no event propagation
3413     * infrastructure taken in account).
3414     *
3415     * @note Not to be confused with @c
3416     * elm_object_signal_callback_add(), which will add callbacks to @b
3417     * signals coming from a widget's theme, not input events.
3418     *
3419     * @note Not to be confused with @c
3420     * edje_object_signal_callback_add(), which does the same as
3421     * elm_object_signal_callback_add(), but directly on an Edje
3422     * object.
3423     *
3424     * @note Not to be confused with @c
3425     * evas_object_smart_callback_add(), which adds callbacks to smart
3426     * objects' <b>smart events</b>, and not input events.
3427     *
3428     * @see elm_object_event_callback_del()
3429     *
3430     * @ingroup General
3431     */
3432    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3433
3434    /**
3435     * Remove an event callback from a widget.
3436     *
3437     * This function removes a callback, previoulsy attached to event emission
3438     * by the @p obj.
3439     * The parameters func and data must match exactly those passed to
3440     * a previous call to elm_object_event_callback_add(). The data pointer that
3441     * was passed to this call will be returned.
3442     *
3443     * @param obj The object
3444     * @param func The callback function to be executed when the event is
3445     * emitted.
3446     * @param data Data to pass in to the callback function.
3447     * @return The data pointer
3448     * @ingroup General
3449     */
3450    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3451
3452    /**
3453     * Adjust size of an element for finger usage.
3454     *
3455     * @param times_w How many fingers should fit horizontally
3456     * @param w Pointer to the width size to adjust
3457     * @param times_h How many fingers should fit vertically
3458     * @param h Pointer to the height size to adjust
3459     *
3460     * This takes width and height sizes (in pixels) as input and a
3461     * size multiple (which is how many fingers you want to place
3462     * within the area, being "finger" the size set by
3463     * elm_finger_size_set()), and adjusts the size to be large enough
3464     * to accommodate the resulting size -- if it doesn't already
3465     * accommodate it. On return the @p w and @p h sizes pointed to by
3466     * these parameters will be modified, on those conditions.
3467     *
3468     * @note This is kind of a low level Elementary call, most useful
3469     * on size evaluation times for widgets. An external user wouldn't
3470     * be calling, most of the time.
3471     *
3472     * @ingroup Fingers
3473     */
3474    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3475
3476    /**
3477     * Get the duration for occuring long press event.
3478     *
3479     * @return Timeout for long press event
3480     * @ingroup Longpress
3481     */
3482    EAPI double           elm_longpress_timeout_get(void);
3483
3484    /**
3485     * Set the duration for occuring long press event.
3486     *
3487     * @param lonpress_timeout Timeout for long press event
3488     * @ingroup Longpress
3489     */
3490    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3491
3492    /**
3493     * @defgroup Debug Debug
3494     * don't use it unless you are sure
3495     *
3496     * @{
3497     */
3498
3499    /**
3500     * Print Tree object hierarchy in stdout
3501     *
3502     * @param obj The root object
3503     * @ingroup Debug
3504     */
3505    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3506
3507    /**
3508     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3509     *
3510     * @param obj The root object
3511     * @param file The path of output file
3512     * @ingroup Debug
3513     */
3514    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3515
3516    /**
3517     * @}
3518     */
3519
3520    /**
3521     * @defgroup Theme Theme
3522     *
3523     * Elementary uses Edje to theme its widgets, naturally. But for the most
3524     * part this is hidden behind a simpler interface that lets the user set
3525     * extensions and choose the style of widgets in a much easier way.
3526     *
3527     * Instead of thinking in terms of paths to Edje files and their groups
3528     * each time you want to change the appearance of a widget, Elementary
3529     * works so you can add any theme file with extensions or replace the
3530     * main theme at one point in the application, and then just set the style
3531     * of widgets with elm_object_style_set() and related functions. Elementary
3532     * will then look in its list of themes for a matching group and apply it,
3533     * and when the theme changes midway through the application, all widgets
3534     * will be updated accordingly.
3535     *
3536     * There are three concepts you need to know to understand how Elementary
3537     * theming works: default theme, extensions and overlays.
3538     *
3539     * Default theme, obviously enough, is the one that provides the default
3540     * look of all widgets. End users can change the theme used by Elementary
3541     * by setting the @c ELM_THEME environment variable before running an
3542     * application, or globally for all programs using the @c elementary_config
3543     * utility. Applications can change the default theme using elm_theme_set(),
3544     * but this can go against the user wishes, so it's not an adviced practice.
3545     *
3546     * Ideally, applications should find everything they need in the already
3547     * provided theme, but there may be occasions when that's not enough and
3548     * custom styles are required to correctly express the idea. For this
3549     * cases, Elementary has extensions.
3550     *
3551     * Extensions allow the application developer to write styles of its own
3552     * to apply to some widgets. This requires knowledge of how each widget
3553     * is themed, as extensions will always replace the entire group used by
3554     * the widget, so important signals and parts need to be there for the
3555     * object to behave properly (see documentation of Edje for details).
3556     * Once the theme for the extension is done, the application needs to add
3557     * it to the list of themes Elementary will look into, using
3558     * elm_theme_extension_add(), and set the style of the desired widgets as
3559     * he would normally with elm_object_style_set().
3560     *
3561     * Overlays, on the other hand, can replace the look of all widgets by
3562     * overriding the default style. Like extensions, it's up to the application
3563     * developer to write the theme for the widgets it wants, the difference
3564     * being that when looking for the theme, Elementary will check first the
3565     * list of overlays, then the set theme and lastly the list of extensions,
3566     * so with overlays it's possible to replace the default view and every
3567     * widget will be affected. This is very much alike to setting the whole
3568     * theme for the application and will probably clash with the end user
3569     * options, not to mention the risk of ending up with not matching styles
3570     * across the program. Unless there's a very special reason to use them,
3571     * overlays should be avoided for the resons exposed before.
3572     *
3573     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3574     * keeps one default internally and every function that receives one of
3575     * these can be called with NULL to refer to this default (except for
3576     * elm_theme_free()). It's possible to create a new instance of a
3577     * ::Elm_Theme to set other theme for a specific widget (and all of its
3578     * children), but this is as discouraged, if not even more so, than using
3579     * overlays. Don't use this unless you really know what you are doing.
3580     *
3581     * But to be less negative about things, you can look at the following
3582     * examples:
3583     * @li @ref theme_example_01 "Using extensions"
3584     * @li @ref theme_example_02 "Using overlays"
3585     *
3586     * @{
3587     */
3588    /**
3589     * @typedef Elm_Theme
3590     *
3591     * Opaque handler for the list of themes Elementary looks for when
3592     * rendering widgets.
3593     *
3594     * Stay out of this unless you really know what you are doing. For most
3595     * cases, sticking to the default is all a developer needs.
3596     */
3597    typedef struct _Elm_Theme Elm_Theme;
3598
3599    /**
3600     * Create a new specific theme
3601     *
3602     * This creates an empty specific theme that only uses the default theme. A
3603     * specific theme has its own private set of extensions and overlays too
3604     * (which are empty by default). Specific themes do not fall back to themes
3605     * of parent objects. They are not intended for this use. Use styles, overlays
3606     * and extensions when needed, but avoid specific themes unless there is no
3607     * other way (example: you want to have a preview of a new theme you are
3608     * selecting in a "theme selector" window. The preview is inside a scroller
3609     * and should display what the theme you selected will look like, but not
3610     * actually apply it yet. The child of the scroller will have a specific
3611     * theme set to show this preview before the user decides to apply it to all
3612     * applications).
3613     */
3614    EAPI Elm_Theme       *elm_theme_new(void);
3615
3616    /**
3617     * Free a specific theme
3618     *
3619     * @param th The theme to free
3620     *
3621     * This frees a theme created with elm_theme_new().
3622     */
3623    EAPI void             elm_theme_free(Elm_Theme *th);
3624
3625    /**
3626     * Copy the theme fom the source to the destination theme
3627     *
3628     * @param th The source theme to copy from
3629     * @param thdst The destination theme to copy data to
3630     *
3631     * This makes a one-time static copy of all the theme config, extensions
3632     * and overlays from @p th to @p thdst. If @p th references a theme, then
3633     * @p thdst is also set to reference it, with all the theme settings,
3634     * overlays and extensions that @p th had.
3635     */
3636    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3637
3638    /**
3639     * Tell the source theme to reference the ref theme
3640     *
3641     * @param th The theme that will do the referencing
3642     * @param thref The theme that is the reference source
3643     *
3644     * This clears @p th to be empty and then sets it to refer to @p thref
3645     * so @p th acts as an override to @p thref, but where its overrides
3646     * don't apply, it will fall through to @p thref for configuration.
3647     */
3648    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3649
3650    /**
3651     * Return the theme referred to
3652     *
3653     * @param th The theme to get the reference from
3654     * @return The referenced theme handle
3655     *
3656     * This gets the theme set as the reference theme by elm_theme_ref_set().
3657     * If no theme is set as a reference, NULL is returned.
3658     */
3659    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3660
3661    /**
3662     * Return the default theme
3663     *
3664     * @return The default theme handle
3665     *
3666     * This returns the internal default theme setup handle that all widgets
3667     * use implicitly unless a specific theme is set. This is also often use
3668     * as a shorthand of NULL.
3669     */
3670    EAPI Elm_Theme       *elm_theme_default_get(void);
3671
3672    /**
3673     * Prepends a theme overlay to the list of overlays
3674     *
3675     * @param th The theme to add to, or if NULL, the default theme
3676     * @param item The Edje file path to be used
3677     *
3678     * Use this if your application needs to provide some custom overlay theme
3679     * (An Edje file that replaces some default styles of widgets) where adding
3680     * new styles, or changing system theme configuration is not possible. Do
3681     * NOT use this instead of a proper system theme configuration. Use proper
3682     * configuration files, profiles, environment variables etc. to set a theme
3683     * so that the theme can be altered by simple confiugration by a user. Using
3684     * this call to achieve that effect is abusing the API and will create lots
3685     * of trouble.
3686     *
3687     * @see elm_theme_extension_add()
3688     */
3689    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3690
3691    /**
3692     * Delete a theme overlay from the list of overlays
3693     *
3694     * @param th The theme to delete from, or if NULL, the default theme
3695     * @param item The name of the theme overlay
3696     *
3697     * @see elm_theme_overlay_add()
3698     */
3699    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3700
3701    /**
3702     * Appends a theme extension to the list of extensions.
3703     *
3704     * @param th The theme to add to, or if NULL, the default theme
3705     * @param item The Edje file path to be used
3706     *
3707     * This is intended when an application needs more styles of widgets or new
3708     * widget themes that the default does not provide (or may not provide). The
3709     * application has "extended" usage by coming up with new custom style names
3710     * for widgets for specific uses, but as these are not "standard", they are
3711     * not guaranteed to be provided by a default theme. This means the
3712     * application is required to provide these extra elements itself in specific
3713     * Edje files. This call adds one of those Edje files to the theme search
3714     * path to be search after the default theme. The use of this call is
3715     * encouraged when default styles do not meet the needs of the application.
3716     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3717     *
3718     * @see elm_object_style_set()
3719     */
3720    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3721
3722    /**
3723     * Deletes a theme extension from the list of extensions.
3724     *
3725     * @param th The theme to delete from, or if NULL, the default theme
3726     * @param item The name of the theme extension
3727     *
3728     * @see elm_theme_extension_add()
3729     */
3730    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3731
3732    /**
3733     * Set the theme search order for the given theme
3734     *
3735     * @param th The theme to set the search order, or if NULL, the default theme
3736     * @param theme Theme search string
3737     *
3738     * This sets the search string for the theme in path-notation from first
3739     * theme to search, to last, delimited by the : character. Example:
3740     *
3741     * "shiny:/path/to/file.edj:default"
3742     *
3743     * See the ELM_THEME environment variable for more information.
3744     *
3745     * @see elm_theme_get()
3746     * @see elm_theme_list_get()
3747     */
3748    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3749
3750    /**
3751     * Return the theme search order
3752     *
3753     * @param th The theme to get the search order, or if NULL, the default theme
3754     * @return The internal search order path
3755     *
3756     * This function returns a colon separated string of theme elements as
3757     * returned by elm_theme_list_get().
3758     *
3759     * @see elm_theme_set()
3760     * @see elm_theme_list_get()
3761     */
3762    EAPI const char      *elm_theme_get(Elm_Theme *th);
3763
3764    /**
3765     * Return a list of theme elements to be used in a theme.
3766     *
3767     * @param th Theme to get the list of theme elements from.
3768     * @return The internal list of theme elements
3769     *
3770     * This returns the internal list of theme elements (will only be valid as
3771     * long as the theme is not modified by elm_theme_set() or theme is not
3772     * freed by elm_theme_free(). This is a list of strings which must not be
3773     * altered as they are also internal. If @p th is NULL, then the default
3774     * theme element list is returned.
3775     *
3776     * A theme element can consist of a full or relative path to a .edj file,
3777     * or a name, without extension, for a theme to be searched in the known
3778     * theme paths for Elemementary.
3779     *
3780     * @see elm_theme_set()
3781     * @see elm_theme_get()
3782     */
3783    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3784
3785    /**
3786     * Return the full patrh for a theme element
3787     *
3788     * @param f The theme element name
3789     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3790     * @return The full path to the file found.
3791     *
3792     * This returns a string you should free with free() on success, NULL on
3793     * failure. This will search for the given theme element, and if it is a
3794     * full or relative path element or a simple searchable name. The returned
3795     * path is the full path to the file, if searched, and the file exists, or it
3796     * is simply the full path given in the element or a resolved path if
3797     * relative to home. The @p in_search_path boolean pointed to is set to
3798     * EINA_TRUE if the file was a searchable file andis in the search path,
3799     * and EINA_FALSE otherwise.
3800     */
3801    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3802
3803    /**
3804     * Flush the current theme.
3805     *
3806     * @param th Theme to flush
3807     *
3808     * This flushes caches that let elementary know where to find theme elements
3809     * in the given theme. If @p th is NULL, then the default theme is flushed.
3810     * Call this function if source theme data has changed in such a way as to
3811     * make any caches Elementary kept invalid.
3812     */
3813    EAPI void             elm_theme_flush(Elm_Theme *th);
3814
3815    /**
3816     * This flushes all themes (default and specific ones).
3817     *
3818     * This will flush all themes in the current application context, by calling
3819     * elm_theme_flush() on each of them.
3820     */
3821    EAPI void             elm_theme_full_flush(void);
3822
3823    /**
3824     * Set the theme for all elementary using applications on the current display
3825     *
3826     * @param theme The name of the theme to use. Format same as the ELM_THEME
3827     * environment variable.
3828     */
3829    EAPI void             elm_theme_all_set(const char *theme);
3830
3831    /**
3832     * Return a list of theme elements in the theme search path
3833     *
3834     * @return A list of strings that are the theme element names.
3835     *
3836     * This lists all available theme files in the standard Elementary search path
3837     * for theme elements, and returns them in alphabetical order as theme
3838     * element names in a list of strings. Free this with
3839     * elm_theme_name_available_list_free() when you are done with the list.
3840     */
3841    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3842
3843    /**
3844     * Free the list returned by elm_theme_name_available_list_new()
3845     *
3846     * This frees the list of themes returned by
3847     * elm_theme_name_available_list_new(). Once freed the list should no longer
3848     * be used. a new list mys be created.
3849     */
3850    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3851
3852    /**
3853     * Set a specific theme to be used for this object and its children
3854     *
3855     * @param obj The object to set the theme on
3856     * @param th The theme to set
3857     *
3858     * This sets a specific theme that will be used for the given object and any
3859     * child objects it has. If @p th is NULL then the theme to be used is
3860     * cleared and the object will inherit its theme from its parent (which
3861     * ultimately will use the default theme if no specific themes are set).
3862     *
3863     * Use special themes with great care as this will annoy users and make
3864     * configuration difficult. Avoid any custom themes at all if it can be
3865     * helped.
3866     */
3867    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3868
3869    /**
3870     * Get the specific theme to be used
3871     *
3872     * @param obj The object to get the specific theme from
3873     * @return The specifc theme set.
3874     *
3875     * This will return a specific theme set, or NULL if no specific theme is
3876     * set on that object. It will not return inherited themes from parents, only
3877     * the specific theme set for that specific object. See elm_object_theme_set()
3878     * for more information.
3879     */
3880    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3881
3882    /**
3883     * Get a data item from a theme
3884     *
3885     * @param th The theme, or NULL for default theme
3886     * @param key The data key to search with
3887     * @return The data value, or NULL on failure
3888     *
3889     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3890     * It works the same way as edje_file_data_get() except that the return is stringshared.
3891     */
3892    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3893
3894    /**
3895     * @}
3896     */
3897
3898    /* win */
3899    /** @defgroup Win Win
3900     *
3901     * @image html img/widget/win/preview-00.png
3902     * @image latex img/widget/win/preview-00.eps
3903     *
3904     * The window class of Elementary.  Contains functions to manipulate
3905     * windows. The Evas engine used to render the window contents is specified
3906     * in the system or user elementary config files (whichever is found last),
3907     * and can be overridden with the ELM_ENGINE environment variable for
3908     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3909     * compilation setup and modules actually installed at runtime) are (listed
3910     * in order of best supported and most likely to be complete and work to
3911     * lowest quality).
3912     *
3913     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3914     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3915     * rendering in X11)
3916     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3917     * exits)
3918     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3919     * rendering)
3920     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3921     * buffer)
3922     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3923     * rendering using SDL as the buffer)
3924     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3925     * GDI with software)
3926     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3927     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3928     * grayscale using dedicated 8bit software engine in X11)
3929     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3930     * X11 using 16bit software engine)
3931     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3932     * (Windows CE rendering via GDI with 16bit software renderer)
3933     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3934     * buffer with 16bit software renderer)
3935     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3936     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3937     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3938     *
3939     * All engines use a simple string to select the engine to render, EXCEPT
3940     * the "shot" engine. This actually encodes the output of the virtual
3941     * screenshot and how long to delay in the engine string. The engine string
3942     * is encoded in the following way:
3943     *
3944     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3945     *
3946     * Where options are separated by a ":" char if more than one option is
3947     * given, with delay, if provided being the first option and file the last
3948     * (order is important). The delay specifies how long to wait after the
3949     * window is shown before doing the virtual "in memory" rendering and then
3950     * save the output to the file specified by the file option (and then exit).
3951     * If no delay is given, the default is 0.5 seconds. If no file is given the
3952     * default output file is "out.png". Repeat option is for continous
3953     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3954     * fixed to "out001.png" Some examples of using the shot engine:
3955     *
3956     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3957     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3958     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3959     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3960     *   ELM_ENGINE="shot:" elementary_test
3961     *
3962     * Signals that you can add callbacks for are:
3963     *
3964     * @li "delete,request": the user requested to close the window. See
3965     * elm_win_autodel_set().
3966     * @li "focus,in": window got focus
3967     * @li "focus,out": window lost focus
3968     * @li "moved": window that holds the canvas was moved
3969     *
3970     * Examples:
3971     * @li @ref win_example_01
3972     *
3973     * @{
3974     */
3975    /**
3976     * Defines the types of window that can be created
3977     *
3978     * These are hints set on the window so that a running Window Manager knows
3979     * how the window should be handled and/or what kind of decorations it
3980     * should have.
3981     *
3982     * Currently, only the X11 backed engines use them.
3983     */
3984    typedef enum _Elm_Win_Type
3985      {
3986         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3987                          window. Almost every window will be created with this
3988                          type. */
3989         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3990         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3991                            window holding desktop icons. */
3992         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3993                         be kept on top of any other window by the Window
3994                         Manager. */
3995         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3996                            similar. */
3997         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3998         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3999                            pallete. */
4000         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
4001         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
4002                                  entry in a menubar is clicked. Typically used
4003                                  with elm_win_override_set(). This hint exists
4004                                  for completion only, as the EFL way of
4005                                  implementing a menu would not normally use a
4006                                  separate window for its contents. */
4007         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
4008                               triggered by right-clicking an object. */
4009         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
4010                            explanatory text that typically appear after the
4011                            mouse cursor hovers over an object for a while.
4012                            Typically used with elm_win_override_set() and also
4013                            not very commonly used in the EFL. */
4014         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
4015                                 battery life or a new E-Mail received. */
4016         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
4017                          usually used in the EFL. */
4018         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
4019                        object being dragged across different windows, or even
4020                        applications. Typically used with
4021                        elm_win_override_set(). */
4022         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
4023                                  buffer. No actual window is created for this
4024                                  type, instead the window and all of its
4025                                  contents will be rendered to an image buffer.
4026                                  This allows to have children window inside a
4027                                  parent one just like any other object would
4028                                  be, and do other things like applying @c
4029                                  Evas_Map effects to it. This is the only type
4030                                  of window that requires the @c parent
4031                                  parameter of elm_win_add() to be a valid @c
4032                                  Evas_Object. */
4033      } Elm_Win_Type;
4034
4035    /**
4036     * The differents layouts that can be requested for the virtual keyboard.
4037     *
4038     * When the application window is being managed by Illume, it may request
4039     * any of the following layouts for the virtual keyboard.
4040     */
4041    typedef enum _Elm_Win_Keyboard_Mode
4042      {
4043         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
4044         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
4045         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
4046         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
4047         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
4048         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
4049         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
4050         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
4051         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
4052         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
4053         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
4054         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
4055         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
4056         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
4057         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
4058         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
4059      } Elm_Win_Keyboard_Mode;
4060
4061    /**
4062     * Available commands that can be sent to the Illume manager.
4063     *
4064     * When running under an Illume session, a window may send commands to the
4065     * Illume manager to perform different actions.
4066     */
4067    typedef enum _Elm_Illume_Command
4068      {
4069         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
4070                                          window */
4071         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
4072                                             in the list */
4073         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
4074                                          screen */
4075         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
4076      } Elm_Illume_Command;
4077
4078    /**
4079     * Adds a window object. If this is the first window created, pass NULL as
4080     * @p parent.
4081     *
4082     * @param parent Parent object to add the window to, or NULL
4083     * @param name The name of the window
4084     * @param type The window type, one of #Elm_Win_Type.
4085     *
4086     * The @p parent paramter can be @c NULL for every window @p type except
4087     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
4088     * which the image object will be created.
4089     *
4090     * @return The created object, or NULL on failure
4091     */
4092    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
4093
4094    /**
4095     * Adds a window object with standard setup
4096     *
4097     * @param name The name of the window
4098     * @param title The title for the window
4099     *
4100     * This creates a window like elm_win_add() but also puts in a standard
4101     * background with elm_bg_add(), as well as setting the window title to
4102     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
4103     * as the parent widget.
4104     *
4105     * @return The created object, or NULL on failure
4106     *
4107     * @see elm_win_add()
4108     */
4109    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4110
4111    /**
4112     * Add @p subobj as a resize object of window @p obj.
4113     *
4114     *
4115     * Setting an object as a resize object of the window means that the
4116     * @p subobj child's size and position will be controlled by the window
4117     * directly. That is, the object will be resized to match the window size
4118     * and should never be moved or resized manually by the developer.
4119     *
4120     * In addition, resize objects of the window control what the minimum size
4121     * of it will be, as well as whether it can or not be resized by the user.
4122     *
4123     * For the end user to be able to resize a window by dragging the handles
4124     * or borders provided by the Window Manager, or using any other similar
4125     * mechanism, all of the resize objects in the window should have their
4126     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4127     *
4128     * Also notice that the window can get resized to the current size of the
4129     * object if the EVAS_HINT_EXPAND is set @b after the call to
4130     * elm_win_resize_object_add(). So if the object should get resized to the
4131     * size of the window, set this hint @b before adding it as a resize object
4132     * (this happens because the size of the window and the object are evaluated
4133     * as soon as the object is added to the window).
4134     *
4135     * @param obj The window object
4136     * @param subobj The resize object to add
4137     */
4138    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4139
4140    /**
4141     * Delete @p subobj as a resize object of window @p obj.
4142     *
4143     * This function removes the object @p subobj from the resize objects of
4144     * the window @p obj. It will not delete the object itself, which will be
4145     * left unmanaged and should be deleted by the developer, manually handled
4146     * or set as child of some other container.
4147     *
4148     * @param obj The window object
4149     * @param subobj The resize object to add
4150     */
4151    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4152
4153    /**
4154     * Set the title of the window
4155     *
4156     * @param obj The window object
4157     * @param title The title to set
4158     */
4159    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4160
4161    /**
4162     * Get the title of the window
4163     *
4164     * The returned string is an internal one and should not be freed or
4165     * modified. It will also be rendered invalid if a new title is set or if
4166     * the window is destroyed.
4167     *
4168     * @param obj The window object
4169     * @return The title
4170     */
4171    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4172
4173    /**
4174     * Set the window's autodel state.
4175     *
4176     * When closing the window in any way outside of the program control, like
4177     * pressing the X button in the titlebar or using a command from the
4178     * Window Manager, a "delete,request" signal is emitted to indicate that
4179     * this event occurred and the developer can take any action, which may
4180     * include, or not, destroying the window object.
4181     *
4182     * When the @p autodel parameter is set, the window will be automatically
4183     * destroyed when this event occurs, after the signal is emitted.
4184     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4185     * and is up to the program to do so when it's required.
4186     *
4187     * @param obj The window object
4188     * @param autodel If true, the window will automatically delete itself when
4189     * closed
4190     */
4191    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4192
4193    /**
4194     * Get the window's autodel state.
4195     *
4196     * @param obj The window object
4197     * @return If the window will automatically delete itself when closed
4198     *
4199     * @see elm_win_autodel_set()
4200     */
4201    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4202
4203    /**
4204     * Activate a window object.
4205     *
4206     * This function sends a request to the Window Manager to activate the
4207     * window pointed by @p obj. If honored by the WM, the window will receive
4208     * the keyboard focus.
4209     *
4210     * @note This is just a request that a Window Manager may ignore, so calling
4211     * this function does not ensure in any way that the window will be the
4212     * active one after it.
4213     *
4214     * @param obj The window object
4215     */
4216    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4217
4218    /**
4219     * Lower a window object.
4220     *
4221     * Places the window pointed by @p obj at the bottom of the stack, so that
4222     * no other window is covered by it.
4223     *
4224     * If elm_win_override_set() is not set, the Window Manager may ignore this
4225     * request.
4226     *
4227     * @param obj The window object
4228     */
4229    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4230
4231    /**
4232     * Raise a window object.
4233     *
4234     * Places the window pointed by @p obj at the top of the stack, so that it's
4235     * not covered by any other window.
4236     *
4237     * If elm_win_override_set() is not set, the Window Manager may ignore this
4238     * request.
4239     *
4240     * @param obj The window object
4241     */
4242    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4243
4244    /**
4245     * Center a window on its screen
4246     *
4247     * This function centers window @p obj horizontally and/or vertically based on the values
4248     * of @p h and @v.
4249     * @param obj The window object
4250     * @param h If true, center horizontally. If false, do not change horizontal location.
4251     * @param v If true, center vertically. If false, do not change vertical location.
4252     */
4253    EAPI void         elm_win_center(Evas_Object *obj, Eina_Bool h, Eina_Bool v) EINA_ARG_NONNULL(1);
4254
4255    /**
4256     * Set the borderless state of a window.
4257     *
4258     * This function requests the Window Manager to not draw any decoration
4259     * around the window.
4260     *
4261     * @param obj The window object
4262     * @param borderless If true, the window is borderless
4263     */
4264    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4265
4266    /**
4267     * Get the borderless state of a window.
4268     *
4269     * @param obj The window object
4270     * @return If true, the window is borderless
4271     */
4272    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4273
4274    /**
4275     * Set the shaped state of a window.
4276     *
4277     * Shaped windows, when supported, will render the parts of the window that
4278     * has no content, transparent.
4279     *
4280     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4281     * background object or cover the entire window in any other way, or the
4282     * parts of the canvas that have no data will show framebuffer artifacts.
4283     *
4284     * @param obj The window object
4285     * @param shaped If true, the window is shaped
4286     *
4287     * @see elm_win_alpha_set()
4288     */
4289    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4290
4291    /**
4292     * Get the shaped state of a window.
4293     *
4294     * @param obj The window object
4295     * @return If true, the window is shaped
4296     *
4297     * @see elm_win_shaped_set()
4298     */
4299    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4300
4301    /**
4302     * Set the alpha channel state of a window.
4303     *
4304     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4305     * possibly making parts of the window completely or partially transparent.
4306     * This is also subject to the underlying system supporting it, like for
4307     * example, running under a compositing manager. If no compositing is
4308     * available, enabling this option will instead fallback to using shaped
4309     * windows, with elm_win_shaped_set().
4310     *
4311     * @param obj The window object
4312     * @param alpha If true, the window has an alpha channel
4313     *
4314     * @see elm_win_alpha_set()
4315     */
4316    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4317
4318    /**
4319     * Get the transparency state of a window.
4320     *
4321     * @param obj The window object
4322     * @return If true, the window is transparent
4323     *
4324     * @see elm_win_transparent_set()
4325     */
4326    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4327
4328    /**
4329     * Set the transparency state of a window.
4330     *
4331     * Use elm_win_alpha_set() instead.
4332     *
4333     * @param obj The window object
4334     * @param transparent If true, the window is transparent
4335     *
4336     * @see elm_win_alpha_set()
4337     */
4338    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4339
4340    /**
4341     * Get the alpha channel state of a window.
4342     *
4343     * @param obj The window object
4344     * @return If true, the window has an alpha channel
4345     */
4346    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4347
4348    /**
4349     * Set the override state of a window.
4350     *
4351     * A window with @p override set to EINA_TRUE will not be managed by the
4352     * Window Manager. This means that no decorations of any kind will be shown
4353     * for it, moving and resizing must be handled by the application, as well
4354     * as the window visibility.
4355     *
4356     * This should not be used for normal windows, and even for not so normal
4357     * ones, it should only be used when there's a good reason and with a lot
4358     * of care. Mishandling override windows may result situations that
4359     * disrupt the normal workflow of the end user.
4360     *
4361     * @param obj The window object
4362     * @param override If true, the window is overridden
4363     */
4364    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4365
4366    /**
4367     * Get the override state of a window.
4368     *
4369     * @param obj The window object
4370     * @return If true, the window is overridden
4371     *
4372     * @see elm_win_override_set()
4373     */
4374    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4375
4376    /**
4377     * Set the fullscreen state of a window.
4378     *
4379     * @param obj The window object
4380     * @param fullscreen If true, the window is fullscreen
4381     */
4382    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4383
4384    /**
4385     * Get the fullscreen state of a window.
4386     *
4387     * @param obj The window object
4388     * @return If true, the window is fullscreen
4389     */
4390    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4391
4392    /**
4393     * Set the maximized state of a window.
4394     *
4395     * @param obj The window object
4396     * @param maximized If true, the window is maximized
4397     */
4398    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4399
4400    /**
4401     * Get the maximized state of a window.
4402     *
4403     * @param obj The window object
4404     * @return If true, the window is maximized
4405     */
4406    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4407
4408    /**
4409     * Set the iconified state of a window.
4410     *
4411     * @param obj The window object
4412     * @param iconified If true, the window is iconified
4413     */
4414    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4415
4416    /**
4417     * Get the iconified state of a window.
4418     *
4419     * @param obj The window object
4420     * @return If true, the window is iconified
4421     */
4422    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4423
4424    /**
4425     * Set the layer of the window.
4426     *
4427     * What this means exactly will depend on the underlying engine used.
4428     *
4429     * In the case of X11 backed engines, the value in @p layer has the
4430     * following meanings:
4431     * @li < 3: The window will be placed below all others.
4432     * @li > 5: The window will be placed above all others.
4433     * @li other: The window will be placed in the default layer.
4434     *
4435     * @param obj The window object
4436     * @param layer The layer of the window
4437     */
4438    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4439
4440    /**
4441     * Get the layer of the window.
4442     *
4443     * @param obj The window object
4444     * @return The layer of the window
4445     *
4446     * @see elm_win_layer_set()
4447     */
4448    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4449
4450    /**
4451     * Set the rotation of the window.
4452     *
4453     * Most engines only work with multiples of 90.
4454     *
4455     * This function is used to set the orientation of the window @p obj to
4456     * match that of the screen. The window itself will be resized to adjust
4457     * to the new geometry of its contents. If you want to keep the window size,
4458     * see elm_win_rotation_with_resize_set().
4459     *
4460     * @param obj The window object
4461     * @param rotation The rotation of the window, in degrees (0-360),
4462     * counter-clockwise.
4463     */
4464    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4465
4466    /**
4467     * Rotates the window and resizes it.
4468     *
4469     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4470     * that they fit inside the current window geometry.
4471     *
4472     * @param obj The window object
4473     * @param layer The rotation of the window in degrees (0-360),
4474     * counter-clockwise.
4475     */
4476    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4477
4478    /**
4479     * Get the rotation of the window.
4480     *
4481     * @param obj The window object
4482     * @return The rotation of the window in degrees (0-360)
4483     *
4484     * @see elm_win_rotation_set()
4485     * @see elm_win_rotation_with_resize_set()
4486     */
4487    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4488
4489    /**
4490     * Set the sticky state of the window.
4491     *
4492     * Hints the Window Manager that the window in @p obj should be left fixed
4493     * at its position even when the virtual desktop it's on moves or changes.
4494     *
4495     * @param obj The window object
4496     * @param sticky If true, the window's sticky state is enabled
4497     */
4498    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4499
4500    /**
4501     * Get the sticky state of the window.
4502     *
4503     * @param obj The window object
4504     * @return If true, the window's sticky state is enabled
4505     *
4506     * @see elm_win_sticky_set()
4507     */
4508    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4509
4510    /**
4511     * Set if this window is an illume conformant window
4512     *
4513     * @param obj The window object
4514     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4515     */
4516    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4517
4518    /**
4519     * Get if this window is an illume conformant window
4520     *
4521     * @param obj The window object
4522     * @return A boolean if this window is illume conformant or not
4523     */
4524    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4525
4526    /**
4527     * Set a window to be an illume quickpanel window
4528     *
4529     * By default window objects are not quickpanel windows.
4530     *
4531     * @param obj The window object
4532     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4533     */
4534    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4535
4536    /**
4537     * Get if this window is a quickpanel or not
4538     *
4539     * @param obj The window object
4540     * @return A boolean if this window is a quickpanel or not
4541     */
4542    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4543
4544    /**
4545     * Set the major priority of a quickpanel window
4546     *
4547     * @param obj The window object
4548     * @param priority The major priority for this quickpanel
4549     */
4550    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4551
4552    /**
4553     * Get the major priority of a quickpanel window
4554     *
4555     * @param obj The window object
4556     * @return The major priority of this quickpanel
4557     */
4558    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4559
4560    /**
4561     * Set the minor priority of a quickpanel window
4562     *
4563     * @param obj The window object
4564     * @param priority The minor priority for this quickpanel
4565     */
4566    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4567
4568    /**
4569     * Get the minor priority of a quickpanel window
4570     *
4571     * @param obj The window object
4572     * @return The minor priority of this quickpanel
4573     */
4574    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4575
4576    /**
4577     * Set which zone this quickpanel should appear in
4578     *
4579     * @param obj The window object
4580     * @param zone The requested zone for this quickpanel
4581     */
4582    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4583
4584    /**
4585     * Get which zone this quickpanel should appear in
4586     *
4587     * @param obj The window object
4588     * @return The requested zone for this quickpanel
4589     */
4590    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4591
4592    /**
4593     * Set the window to be skipped by keyboard focus
4594     *
4595     * This sets the window to be skipped by normal keyboard input. This means
4596     * a window manager will be asked to not focus this window as well as omit
4597     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4598     *
4599     * Call this and enable it on a window BEFORE you show it for the first time,
4600     * otherwise it may have no effect.
4601     *
4602     * Use this for windows that have only output information or might only be
4603     * interacted with by the mouse or fingers, and never for typing input.
4604     * Be careful that this may have side-effects like making the window
4605     * non-accessible in some cases unless the window is specially handled. Use
4606     * this with care.
4607     *
4608     * @param obj The window object
4609     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4610     */
4611    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4612
4613    /**
4614     * Send a command to the windowing environment
4615     *
4616     * This is intended to work in touchscreen or small screen device
4617     * environments where there is a more simplistic window management policy in
4618     * place. This uses the window object indicated to select which part of the
4619     * environment to control (the part that this window lives in), and provides
4620     * a command and an optional parameter structure (use NULL for this if not
4621     * needed).
4622     *
4623     * @param obj The window object that lives in the environment to control
4624     * @param command The command to send
4625     * @param params Optional parameters for the command
4626     */
4627    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4628
4629    /**
4630     * Get the inlined image object handle
4631     *
4632     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4633     * then the window is in fact an evas image object inlined in the parent
4634     * canvas. You can get this object (be careful to not manipulate it as it
4635     * is under control of elementary), and use it to do things like get pixel
4636     * data, save the image to a file, etc.
4637     *
4638     * @param obj The window object to get the inlined image from
4639     * @return The inlined image object, or NULL if none exists
4640     */
4641    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4642
4643    /**
4644     * Determine whether a window has focus
4645     * @param obj The window to query
4646     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4647     */
4648    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4649
4650    /**
4651     * Constrain the maximum width and height of a window to the width and height of its screen
4652     *
4653     * When @p constrain is true, @p obj will never resize larger than the screen.
4654     * @param obj The window object
4655     * @param constrain EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4656     */
4657    EAPI void         elm_win_screen_constrain_set(Evas_Object *obj, Eina_Bool constrain) EINA_ARG_NONNULL(1);
4658
4659    /**
4660     * Retrieve the constraints on the maximum width and height of a window relative to the width and height of its screen
4661     *
4662     * When this function returns true, @p obj will never resize larger than the screen.
4663     * @param obj The window object
4664     * @return EINA_TRUE to restrict the window's maximum size, EINA_FALSE to disable restriction
4665     */
4666    EAPI Eina_Bool    elm_win_screen_constrain_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4667
4668    /**
4669     * Get screen geometry details for the screen that a window is on
4670     * @param obj The window to query
4671     * @param x where to return the horizontal offset value. May be NULL.
4672     * @param y  where to return the vertical offset value. May be NULL.
4673     * @param w  where to return the width value. May be NULL.
4674     * @param h  where to return the height value. May be NULL.
4675     */
4676    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4677
4678    /**
4679     * Set the enabled status for the focus highlight in a window
4680     *
4681     * This function will enable or disable the focus highlight only for the
4682     * given window, regardless of the global setting for it
4683     *
4684     * @param obj The window where to enable the highlight
4685     * @param enabled The enabled value for the highlight
4686     */
4687    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4688
4689    /**
4690     * Get the enabled value of the focus highlight for this window
4691     *
4692     * @param obj The window in which to check if the focus highlight is enabled
4693     *
4694     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4695     */
4696    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4697
4698    /**
4699     * Set the style for the focus highlight on this window
4700     *
4701     * Sets the style to use for theming the highlight of focused objects on
4702     * the given window. If @p style is NULL, the default will be used.
4703     *
4704     * @param obj The window where to set the style
4705     * @param style The style to set
4706     */
4707    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4708
4709    /**
4710     * Get the style set for the focus highlight object
4711     *
4712     * Gets the style set for this windows highilght object, or NULL if none
4713     * is set.
4714     *
4715     * @param obj The window to retrieve the highlights style from
4716     *
4717     * @return The style set or NULL if none was. Default is used in that case.
4718     */
4719    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4720
4721    /*...
4722     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4723     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4724     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4725     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4726     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4727     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4728     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4729     *
4730     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4731     * (blank mouse, private mouse obj, defaultmouse)
4732     *
4733     */
4734
4735    /**
4736     * Sets the keyboard mode of the window.
4737     *
4738     * @param obj The window object
4739     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4740     */
4741    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4742
4743    /**
4744     * Gets the keyboard mode of the window.
4745     *
4746     * @param obj The window object
4747     * @return The mode, one of #Elm_Win_Keyboard_Mode
4748     */
4749    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4750
4751    /**
4752     * Sets whether the window is a keyboard.
4753     *
4754     * @param obj The window object
4755     * @param is_keyboard If true, the window is a virtual keyboard
4756     */
4757    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4758
4759    /**
4760     * Gets whether the window is a keyboard.
4761     *
4762     * @param obj The window object
4763     * @return If the window is a virtual keyboard
4764     */
4765    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4766
4767    /**
4768     * Get the screen position of a window.
4769     *
4770     * @param obj The window object
4771     * @param x The int to store the x coordinate to
4772     * @param y The int to store the y coordinate to
4773     */
4774    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4775
4776    /**
4777     * @}
4778     */
4779
4780    /**
4781     * @defgroup Inwin Inwin
4782     *
4783     * @image html img/widget/inwin/preview-00.png
4784     * @image latex img/widget/inwin/preview-00.eps
4785     * @image html img/widget/inwin/preview-01.png
4786     * @image latex img/widget/inwin/preview-01.eps
4787     * @image html img/widget/inwin/preview-02.png
4788     * @image latex img/widget/inwin/preview-02.eps
4789     *
4790     * An inwin is a window inside a window that is useful for a quick popup.
4791     * It does not hover.
4792     *
4793     * It works by creating an object that will occupy the entire window, so it
4794     * must be created using an @ref Win "elm_win" as parent only. The inwin
4795     * object can be hidden or restacked below every other object if it's
4796     * needed to show what's behind it without destroying it. If this is done,
4797     * the elm_win_inwin_activate() function can be used to bring it back to
4798     * full visibility again.
4799     *
4800     * There are three styles available in the default theme. These are:
4801     * @li default: The inwin is sized to take over most of the window it's
4802     * placed in.
4803     * @li minimal: The size of the inwin will be the minimum necessary to show
4804     * its contents.
4805     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4806     * possible, but it's sized vertically the most it needs to fit its\
4807     * contents.
4808     *
4809     * Some examples of Inwin can be found in the following:
4810     * @li @ref inwin_example_01
4811     *
4812     * @{
4813     */
4814
4815    /**
4816     * Adds an inwin to the current window
4817     *
4818     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4819     * Never call this function with anything other than the top-most window
4820     * as its parameter, unless you are fond of undefined behavior.
4821     *
4822     * After creating the object, the widget will set itself as resize object
4823     * for the window with elm_win_resize_object_add(), so when shown it will
4824     * appear to cover almost the entire window (how much of it depends on its
4825     * content and the style used). It must not be added into other container
4826     * objects and it needs not be moved or resized manually.
4827     *
4828     * @param parent The parent object
4829     * @return The new object or NULL if it cannot be created
4830     */
4831    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4832
4833    /**
4834     * Activates an inwin object, ensuring its visibility
4835     *
4836     * This function will make sure that the inwin @p obj is completely visible
4837     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4838     * to the front. It also sets the keyboard focus to it, which will be passed
4839     * onto its content.
4840     *
4841     * The object's theme will also receive the signal "elm,action,show" with
4842     * source "elm".
4843     *
4844     * @param obj The inwin to activate
4845     */
4846    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4847
4848    /**
4849     * Set the content of an inwin object.
4850     *
4851     * Once the content object is set, a previously set one will be deleted.
4852     * If you want to keep that old content object, use the
4853     * elm_win_inwin_content_unset() function.
4854     *
4855     * @param obj The inwin object
4856     * @param content The object to set as content
4857     */
4858    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4859
4860    /**
4861     * Get the content of an inwin object.
4862     *
4863     * Return the content object which is set for this widget.
4864     *
4865     * The returned object is valid as long as the inwin is still alive and no
4866     * other content is set on it. Deleting the object will notify the inwin
4867     * about it and this one will be left empty.
4868     *
4869     * If you need to remove an inwin's content to be reused somewhere else,
4870     * see elm_win_inwin_content_unset().
4871     *
4872     * @param obj The inwin object
4873     * @return The content that is being used
4874     */
4875    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4876
4877    /**
4878     * Unset the content of an inwin object.
4879     *
4880     * Unparent and return the content object which was set for this widget.
4881     *
4882     * @param obj The inwin object
4883     * @return The content that was being used
4884     */
4885    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4886
4887    /**
4888     * @}
4889     */
4890    /* X specific calls - won't work on non-x engines (return 0) */
4891
4892    /**
4893     * Get the Ecore_X_Window of an Evas_Object
4894     *
4895     * @param obj The object
4896     *
4897     * @return The Ecore_X_Window of @p obj
4898     *
4899     * @ingroup Win
4900     */
4901    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4902
4903    /* smart callbacks called:
4904     * "delete,request" - the user requested to delete the window
4905     * "focus,in" - window got focus
4906     * "focus,out" - window lost focus
4907     * "moved" - window that holds the canvas was moved
4908     */
4909
4910    /**
4911     * @defgroup Bg Bg
4912     *
4913     * @image html img/widget/bg/preview-00.png
4914     * @image latex img/widget/bg/preview-00.eps
4915     *
4916     * @brief Background object, used for setting a solid color, image or Edje
4917     * group as background to a window or any container object.
4918     *
4919     * The bg object is used for setting a solid background to a window or
4920     * packing into any container object. It works just like an image, but has
4921     * some properties useful to a background, like setting it to tiled,
4922     * centered, scaled or stretched.
4923     *
4924     * Default contents parts of the bg widget that you can use for are:
4925     * @li "overlay" - overlay of the bg
4926     *
4927     * Here is some sample code using it:
4928     * @li @ref bg_01_example_page
4929     * @li @ref bg_02_example_page
4930     * @li @ref bg_03_example_page
4931     */
4932
4933    /* bg */
4934    typedef enum _Elm_Bg_Option
4935      {
4936         ELM_BG_OPTION_CENTER,  /**< center the background */
4937         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4938         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4939         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4940      } Elm_Bg_Option;
4941
4942    /**
4943     * Add a new background to the parent
4944     *
4945     * @param parent The parent object
4946     * @return The new object or NULL if it cannot be created
4947     *
4948     * @ingroup Bg
4949     */
4950    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4951
4952    /**
4953     * Set the file (image or edje) used for the background
4954     *
4955     * @param obj The bg object
4956     * @param file The file path
4957     * @param group Optional key (group in Edje) within the file
4958     *
4959     * This sets the image file used in the background object. The image (or edje)
4960     * will be stretched (retaining aspect if its an image file) to completely fill
4961     * the bg object. This may mean some parts are not visible.
4962     *
4963     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4964     * even if @p file is NULL.
4965     *
4966     * @ingroup Bg
4967     */
4968    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4969
4970    /**
4971     * Get the file (image or edje) used for the background
4972     *
4973     * @param obj The bg object
4974     * @param file The file path
4975     * @param group Optional key (group in Edje) within the file
4976     *
4977     * @ingroup Bg
4978     */
4979    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4980
4981    /**
4982     * Set the option used for the background image
4983     *
4984     * @param obj The bg object
4985     * @param option The desired background option (TILE, SCALE)
4986     *
4987     * This sets the option used for manipulating the display of the background
4988     * image. The image can be tiled or scaled.
4989     *
4990     * @ingroup Bg
4991     */
4992    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4993
4994    /**
4995     * Get the option used for the background image
4996     *
4997     * @param obj The bg object
4998     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4999     *
5000     * @ingroup Bg
5001     */
5002    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5003    /**
5004     * Set the option used for the background color
5005     *
5006     * @param obj The bg object
5007     * @param r
5008     * @param g
5009     * @param b
5010     *
5011     * This sets the color used for the background rectangle. Its range goes
5012     * from 0 to 255.
5013     *
5014     * @ingroup Bg
5015     */
5016    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
5017    /**
5018     * Get the option used for the background color
5019     *
5020     * @param obj The bg object
5021     * @param r
5022     * @param g
5023     * @param b
5024     *
5025     * @ingroup Bg
5026     */
5027    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
5028
5029    /**
5030     * Set the overlay object used for the background object.
5031     *
5032     * @param obj The bg object
5033     * @param overlay The overlay object
5034     *
5035     * This provides a way for elm_bg to have an 'overlay' that will be on top
5036     * of the bg. Once the over object is set, a previously set one will be
5037     * deleted, even if you set the new one to NULL. If you want to keep that
5038     * old content object, use the elm_bg_overlay_unset() function.
5039     *
5040     * @deprecated use elm_object_part_content_set() instead
5041     *
5042     * @ingroup Bg
5043     */
5044
5045    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
5046
5047    /**
5048     * Get the overlay object used for the background object.
5049     *
5050     * @param obj The bg object
5051     * @return The content that is being used
5052     *
5053     * Return the content object which is set for this widget
5054     *
5055     * @deprecated use elm_object_part_content_get() instead
5056     *
5057     * @ingroup Bg
5058     */
5059    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5060
5061    /**
5062     * Get the overlay object used for the background object.
5063     *
5064     * @param obj The bg object
5065     * @return The content that was being used
5066     *
5067     * Unparent and return the overlay object which was set for this widget
5068     *
5069     * @deprecated use elm_object_part_content_unset() instead
5070     *
5071     * @ingroup Bg
5072     */
5073    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5074
5075    /**
5076     * Set the size of the pixmap representation of the image.
5077     *
5078     * This option just makes sense if an image is going to be set in the bg.
5079     *
5080     * @param obj The bg object
5081     * @param w The new width of the image pixmap representation.
5082     * @param h The new height of the image pixmap representation.
5083     *
5084     * This function sets a new size for pixmap representation of the given bg
5085     * image. It allows the image to be loaded already in the specified size,
5086     * reducing the memory usage and load time when loading a big image with load
5087     * size set to a smaller size.
5088     *
5089     * NOTE: this is just a hint, the real size of the pixmap may differ
5090     * depending on the type of image being loaded, being bigger than requested.
5091     *
5092     * @ingroup Bg
5093     */
5094    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
5095
5096    /**
5097     * @}
5098     */
5099
5100    /**
5101     * @defgroup Icon Icon
5102     *
5103     * @image html img/widget/icon/preview-00.png
5104     * @image latex img/widget/icon/preview-00.eps
5105     *
5106     * An object that provides standard icon images (delete, edit, arrows, etc.)
5107     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
5108     *
5109     * The icon image requested can be in the elementary theme, or in the
5110     * freedesktop.org paths. It's possible to set the order of preference from
5111     * where the image will be used.
5112     *
5113     * This API is very similar to @ref Image, but with ready to use images.
5114     *
5115     * Default images provided by the theme are described below.
5116     *
5117     * The first list contains icons that were first intended to be used in
5118     * toolbars, but can be used in many other places too:
5119     * @li home
5120     * @li close
5121     * @li apps
5122     * @li arrow_up
5123     * @li arrow_down
5124     * @li arrow_left
5125     * @li arrow_right
5126     * @li chat
5127     * @li clock
5128     * @li delete
5129     * @li edit
5130     * @li refresh
5131     * @li folder
5132     * @li file
5133     *
5134     * Now some icons that were designed to be used in menus (but again, you can
5135     * use them anywhere else):
5136     * @li menu/home
5137     * @li menu/close
5138     * @li menu/apps
5139     * @li menu/arrow_up
5140     * @li menu/arrow_down
5141     * @li menu/arrow_left
5142     * @li menu/arrow_right
5143     * @li menu/chat
5144     * @li menu/clock
5145     * @li menu/delete
5146     * @li menu/edit
5147     * @li menu/refresh
5148     * @li menu/folder
5149     * @li menu/file
5150     *
5151     * And here we have some media player specific icons:
5152     * @li media_player/forward
5153     * @li media_player/info
5154     * @li media_player/next
5155     * @li media_player/pause
5156     * @li media_player/play
5157     * @li media_player/prev
5158     * @li media_player/rewind
5159     * @li media_player/stop
5160     *
5161     * Signals that you can add callbacks for are:
5162     *
5163     * "clicked" - This is called when a user has clicked the icon
5164     *
5165     * An example of usage for this API follows:
5166     * @li @ref tutorial_icon
5167     */
5168
5169    /**
5170     * @addtogroup Icon
5171     * @{
5172     */
5173
5174    typedef enum _Elm_Icon_Type
5175      {
5176         ELM_ICON_NONE,
5177         ELM_ICON_FILE,
5178         ELM_ICON_STANDARD
5179      } Elm_Icon_Type;
5180
5181    /**
5182     * @enum _Elm_Icon_Lookup_Order
5183     * @typedef Elm_Icon_Lookup_Order
5184     *
5185     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
5186     * theme, FDO paths, or both?
5187     *
5188     * @ingroup Icon
5189     */
5190    typedef enum _Elm_Icon_Lookup_Order
5191      {
5192         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
5193         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
5194         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
5195         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
5196      } Elm_Icon_Lookup_Order;
5197
5198    /**
5199     * Add a new icon object to the parent.
5200     *
5201     * @param parent The parent object
5202     * @return The new object or NULL if it cannot be created
5203     *
5204     * @see elm_icon_file_set()
5205     *
5206     * @ingroup Icon
5207     */
5208    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5209
5210    /**
5211     * Set the file that will be used as icon.
5212     *
5213     * @param obj The icon object
5214     * @param file The path to file that will be used as icon image
5215     * @param group The group that the icon belongs to an edje file
5216     *
5217     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5218     *
5219     * @note The icon image set by this function can be changed by
5220     * elm_icon_standard_set().
5221     *
5222     * @see elm_icon_file_get()
5223     *
5224     * @ingroup Icon
5225     */
5226    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5227
5228    /**
5229     * Set a location in memory to be used as an icon
5230     *
5231     * @param obj The icon object
5232     * @param img The binary data that will be used as an image
5233     * @param size The size of binary data @p img
5234     * @param format Optional format of @p img to pass to the image loader
5235     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5236     *
5237     * The @p format string should be something like "png", "jpg", "tga",
5238     * "tiff", "bmp" etc. if it is provided (NULL if not). This improves
5239     * the loader performance as it tries the "correct" loader first before
5240     * trying a range of other possible loaders until one succeeds.
5241     * 
5242     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5243     *
5244     * @note The icon image set by this function can be changed by
5245     * elm_icon_standard_set().
5246     *
5247     * @ingroup Icon
5248     */
5249    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);
5250
5251    /**
5252     * Get the file that will be used as icon.
5253     *
5254     * @param obj The icon object
5255     * @param file The path to file that will be used as the icon image
5256     * @param group The group that the icon belongs to, in edje file
5257     *
5258     * @see elm_icon_file_set()
5259     *
5260     * @ingroup Icon
5261     */
5262    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5263
5264    /**
5265     * Set the file that will be used, but use a generated thumbnail.
5266     *
5267     * @param obj The icon object
5268     * @param file The path to file that will be used as icon image
5269     * @param group The group that the icon belongs to an edje file
5270     *
5271     * This functions like elm_icon_file_set() but requires the Ethumb library
5272     * support to be enabled successfully with elm_need_ethumb(). When set
5273     * the file indicated has a thumbnail generated and cached on disk for
5274     * future use or will directly use an existing cached thumbnail if it
5275     * is valid.
5276     * 
5277     * @see elm_icon_file_set()
5278     *
5279     * @ingroup Icon
5280     */
5281    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5282
5283    /**
5284     * Set the icon by icon standards names.
5285     *
5286     * @param obj The icon object
5287     * @param name The icon name
5288     *
5289     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5290     *
5291     * For example, freedesktop.org defines standard icon names such as "home",
5292     * "network", etc. There can be different icon sets to match those icon
5293     * keys. The @p name given as parameter is one of these "keys", and will be
5294     * used to look in the freedesktop.org paths and elementary theme. One can
5295     * change the lookup order with elm_icon_order_lookup_set().
5296     *
5297     * If name is not found in any of the expected locations and it is the
5298     * absolute path of an image file, this image will be used.
5299     *
5300     * @note The icon image set by this function can be changed by
5301     * elm_icon_file_set().
5302     *
5303     * @see elm_icon_standard_get()
5304     * @see elm_icon_file_set()
5305     *
5306     * @ingroup Icon
5307     */
5308    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5309
5310    /**
5311     * Get the icon name set by icon standard names.
5312     *
5313     * @param obj The icon object
5314     * @return The icon name
5315     *
5316     * If the icon image was set using elm_icon_file_set() instead of
5317     * elm_icon_standard_set(), then this function will return @c NULL.
5318     *
5319     * @see elm_icon_standard_set()
5320     *
5321     * @ingroup Icon
5322     */
5323    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5324
5325    /**
5326     * Set the smooth scaling for an icon object.
5327     *
5328     * @param obj The icon object
5329     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5330     * otherwise. Default is @c EINA_TRUE.
5331     *
5332     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5333     * scaling provides a better resulting image, but is slower.
5334     *
5335     * The smooth scaling should be disabled when making animations that change
5336     * the icon size, since they will be faster. Animations that don't require
5337     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5338     * is already scaled, since the scaled icon image will be cached).
5339     *
5340     * @see elm_icon_smooth_get()
5341     *
5342     * @ingroup Icon
5343     */
5344    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5345
5346    /**
5347     * Get whether smooth scaling is enabled for an icon object.
5348     *
5349     * @param obj The icon object
5350     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5351     *
5352     * @see elm_icon_smooth_set()
5353     *
5354     * @ingroup Icon
5355     */
5356    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5357
5358    /**
5359     * Disable scaling of this object.
5360     *
5361     * @param obj The icon object.
5362     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5363     * otherwise. Default is @c EINA_FALSE.
5364     *
5365     * This function disables scaling of the icon object through the function
5366     * elm_object_scale_set(). However, this does not affect the object
5367     * size/resize in any way. For that effect, take a look at
5368     * elm_icon_scale_set().
5369     *
5370     * @see elm_icon_no_scale_get()
5371     * @see elm_icon_scale_set()
5372     * @see elm_object_scale_set()
5373     *
5374     * @ingroup Icon
5375     */
5376    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5377
5378    /**
5379     * Get whether scaling is disabled on the object.
5380     *
5381     * @param obj The icon object
5382     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5383     *
5384     * @see elm_icon_no_scale_set()
5385     *
5386     * @ingroup Icon
5387     */
5388    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5389
5390    /**
5391     * Set if the object is (up/down) resizable.
5392     *
5393     * @param obj The icon object
5394     * @param scale_up A bool to set if the object is resizable up. Default is
5395     * @c EINA_TRUE.
5396     * @param scale_down A bool to set if the object is resizable down. Default
5397     * is @c EINA_TRUE.
5398     *
5399     * This function limits the icon object resize ability. If @p scale_up is set to
5400     * @c EINA_FALSE, the object can't have its height or width resized to a value
5401     * higher than the original icon size. Same is valid for @p scale_down.
5402     *
5403     * @see elm_icon_scale_get()
5404     *
5405     * @ingroup Icon
5406     */
5407    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5408
5409    /**
5410     * Get if the object is (up/down) resizable.
5411     *
5412     * @param obj The icon object
5413     * @param scale_up A bool to set if the object is resizable up
5414     * @param scale_down A bool to set if the object is resizable down
5415     *
5416     * @see elm_icon_scale_set()
5417     *
5418     * @ingroup Icon
5419     */
5420    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5421
5422    /**
5423     * Get the object's image size
5424     *
5425     * @param obj The icon object
5426     * @param w A pointer to store the width in
5427     * @param h A pointer to store the height in
5428     *
5429     * @ingroup Icon
5430     */
5431    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5432
5433    /**
5434     * Set if the icon fill the entire object area.
5435     *
5436     * @param obj The icon object
5437     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5438     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5439     *
5440     * When the icon object is resized to a different aspect ratio from the
5441     * original icon image, the icon image will still keep its aspect. This flag
5442     * tells how the image should fill the object's area. They are: keep the
5443     * entire icon inside the limits of height and width of the object (@p
5444     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5445     * of the object, and the icon will fill the entire object (@p fill_outside
5446     * is @c EINA_TRUE).
5447     *
5448     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5449     * retain property to false. Thus, the icon image will always keep its
5450     * original aspect ratio.
5451     *
5452     * @see elm_icon_fill_outside_get()
5453     * @see elm_image_fill_outside_set()
5454     *
5455     * @ingroup Icon
5456     */
5457    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5458
5459    /**
5460     * Get if the object is filled outside.
5461     *
5462     * @param obj The icon object
5463     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5464     *
5465     * @see elm_icon_fill_outside_set()
5466     *
5467     * @ingroup Icon
5468     */
5469    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5470
5471    /**
5472     * Set the prescale size for the icon.
5473     *
5474     * @param obj The icon object
5475     * @param size The prescale size. This value is used for both width and
5476     * height.
5477     *
5478     * This function sets a new size for pixmap representation of the given
5479     * icon. It allows the icon to be loaded already in the specified size,
5480     * reducing the memory usage and load time when loading a big icon with load
5481     * size set to a smaller size.
5482     *
5483     * It's equivalent to the elm_bg_load_size_set() function for bg.
5484     *
5485     * @note this is just a hint, the real size of the pixmap may differ
5486     * depending on the type of icon being loaded, being bigger than requested.
5487     *
5488     * @see elm_icon_prescale_get()
5489     * @see elm_bg_load_size_set()
5490     *
5491     * @ingroup Icon
5492     */
5493    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5494
5495    /**
5496     * Get the prescale size for the icon.
5497     *
5498     * @param obj The icon object
5499     * @return The prescale size
5500     *
5501     * @see elm_icon_prescale_set()
5502     *
5503     * @ingroup Icon
5504     */
5505    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5506
5507    /**
5508     * Gets the image object of the icon. DO NOT MODIFY THIS.
5509     *
5510     * @param obj The icon object
5511     * @return The internal icon object
5512     *
5513     * @ingroup Icon
5514     */
5515    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5516
5517    /**
5518     * Sets the icon lookup order used by elm_icon_standard_set().
5519     *
5520     * @param obj The icon object
5521     * @param order The icon lookup order (can be one of
5522     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5523     * or ELM_ICON_LOOKUP_THEME)
5524     *
5525     * @see elm_icon_order_lookup_get()
5526     * @see Elm_Icon_Lookup_Order
5527     *
5528     * @ingroup Icon
5529     */
5530    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5531
5532    /**
5533     * Gets the icon lookup order.
5534     *
5535     * @param obj The icon object
5536     * @return The icon lookup order
5537     *
5538     * @see elm_icon_order_lookup_set()
5539     * @see Elm_Icon_Lookup_Order
5540     *
5541     * @ingroup Icon
5542     */
5543    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5544
5545    /**
5546     * Enable or disable preloading of the icon
5547     *
5548     * @param obj The icon object
5549     * @param disable If EINA_TRUE, preloading will be disabled
5550     * @ingroup Icon
5551     */
5552    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5553
5554    /**
5555     * Get if the icon supports animation or not.
5556     *
5557     * @param obj The icon object
5558     * @return @c EINA_TRUE if the icon supports animation,
5559     *         @c EINA_FALSE otherwise.
5560     *
5561     * Return if this elm icon's image can be animated. Currently Evas only
5562     * supports gif animation. If the return value is EINA_FALSE, other
5563     * elm_icon_animated_XXX APIs won't work.
5564     * @ingroup Icon
5565     */
5566    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5567
5568    /**
5569     * Set animation mode of the icon.
5570     *
5571     * @param obj The icon object
5572     * @param anim @c EINA_TRUE if the object do animation job,
5573     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5574     *
5575     * Since the default animation mode is set to EINA_FALSE,
5576     * the icon is shown without animation. Files like animated GIF files
5577     * can animate, and this is supported if you enable animated support
5578     * on the icon.
5579     * Set it to EINA_TRUE when the icon needs to be animated.
5580     * @ingroup Icon
5581     */
5582    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5583
5584    /**
5585     * Get animation mode of the icon.
5586     *
5587     * @param obj The icon object
5588     * @return The animation mode of the icon object
5589     * @see elm_icon_animated_set
5590     * @ingroup Icon
5591     */
5592    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5593
5594    /**
5595     * Set animation play mode of the icon.
5596     *
5597     * @param obj The icon object
5598     * @param play @c EINA_TRUE the object play animation images,
5599     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5600     *
5601     * To play elm icon's animation, set play to EINA_TURE.
5602     * For example, you make gif player using this set/get API and click event.
5603     * This literally lets you control current play or paused state. To have
5604     * this work with animated GIF files for example, you first, before
5605     * setting the file have to use elm_icon_animated_set() to enable animation
5606     * at all on the icon.
5607     *
5608     * 1. Click event occurs
5609     * 2. Check play flag using elm_icon_animaged_play_get
5610     * 3. If elm icon was playing, set play to EINA_FALSE.
5611     *    Then animation will be stopped and vice versa
5612     * @ingroup Icon
5613     */
5614    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5615
5616    /**
5617     * Get animation play mode of the icon.
5618     *
5619     * @param obj The icon object
5620     * @return The play mode of the icon object
5621     *
5622     * @see elm_icon_animated_play_get
5623     * @ingroup Icon
5624     */
5625    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5626
5627    /**
5628     * @}
5629     */
5630
5631    /**
5632     * @defgroup Image Image
5633     *
5634     * @image html img/widget/image/preview-00.png
5635     * @image latex img/widget/image/preview-00.eps
5636
5637     *
5638     * An object that allows one to load an image file to it. It can be used
5639     * anywhere like any other elementary widget.
5640     *
5641     * This widget provides most of the functionality provided from @ref Bg or @ref
5642     * Icon, but with a slightly different API (use the one that fits better your
5643     * needs).
5644     *
5645     * The features not provided by those two other image widgets are:
5646     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5647     * @li change the object orientation with elm_image_orient_set();
5648     * @li and turning the image editable with elm_image_editable_set().
5649     *
5650     * Signals that you can add callbacks for are:
5651     *
5652     * @li @c "clicked" - This is called when a user has clicked the image
5653     *
5654     * An example of usage for this API follows:
5655     * @li @ref tutorial_image
5656     */
5657
5658    /**
5659     * @addtogroup Image
5660     * @{
5661     */
5662
5663    /**
5664     * @enum _Elm_Image_Orient
5665     * @typedef Elm_Image_Orient
5666     *
5667     * Possible orientation options for elm_image_orient_set().
5668     *
5669     * @image html elm_image_orient_set.png
5670     * @image latex elm_image_orient_set.eps width=\textwidth
5671     *
5672     * @ingroup Image
5673     */
5674    typedef enum _Elm_Image_Orient
5675      {
5676         ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
5677         ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
5678         ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
5679         ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
5680         ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5681         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CW = 1, /**< rotate 90 degrees clockwise */
5682         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_180_CW = 2, /**< rotate 180 degrees clockwise */
5683         /*EINA_DEPRECATED*/ELM_IMAGE_ROTATE_90_CCW = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5684         ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
5685         ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
5686         ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
5687         ELM_IMAGE_FLIP_TRANSVERSE = 7 /**< flip the image along the y = x line (top-left to bottom-right) */
5688      } Elm_Image_Orient;
5689
5690    /**
5691     * Add a new image to the parent.
5692     *
5693     * @param parent The parent object
5694     * @return The new object or NULL if it cannot be created
5695     *
5696     * @see elm_image_file_set()
5697     *
5698     * @ingroup Image
5699     */
5700    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5701
5702    /**
5703     * Set the file that will be used as image.
5704     *
5705     * @param obj The image object
5706     * @param file The path to file that will be used as image
5707     * @param group The group that the image belongs in edje file (if it's an
5708     * edje image)
5709     *
5710     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5711     *
5712     * @see elm_image_file_get()
5713     *
5714     * @ingroup Image
5715     */
5716    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5717
5718    /**
5719     * Get the file that will be used as image.
5720     *
5721     * @param obj The image object
5722     * @param file The path to file
5723     * @param group The group that the image belongs in edje file
5724     *
5725     * @see elm_image_file_set()
5726     *
5727     * @ingroup Image
5728     */
5729    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5730
5731    /**
5732     * Set the smooth effect for an image.
5733     *
5734     * @param obj The image object
5735     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5736     * otherwise. Default is @c EINA_TRUE.
5737     *
5738     * Set the scaling algorithm to be used when scaling the image. Smooth
5739     * scaling provides a better resulting image, but is slower.
5740     *
5741     * The smooth scaling should be disabled when making animations that change
5742     * the image size, since it will be faster. Animations that don't require
5743     * resizing of the image can keep the smooth scaling enabled (even if the
5744     * image is already scaled, since the scaled image will be cached).
5745     *
5746     * @see elm_image_smooth_get()
5747     *
5748     * @ingroup Image
5749     */
5750    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5751
5752    /**
5753     * Get the smooth effect for an image.
5754     *
5755     * @param obj The image object
5756     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5757     *
5758     * @see elm_image_smooth_get()
5759     *
5760     * @ingroup Image
5761     */
5762    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5763
5764    /**
5765     * Gets the current size of the image.
5766     *
5767     * @param obj The image object.
5768     * @param w Pointer to store width, or NULL.
5769     * @param h Pointer to store height, or NULL.
5770     *
5771     * This is the real size of the image, not the size of the object.
5772     *
5773     * On error, neither w and h will be fileld with 0.
5774     *
5775     * @ingroup Image
5776     */
5777    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5778
5779    /**
5780     * Disable scaling of this object.
5781     *
5782     * @param obj The image object.
5783     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5784     * otherwise. Default is @c EINA_FALSE.
5785     *
5786     * This function disables scaling of the elm_image widget through the
5787     * function elm_object_scale_set(). However, this does not affect the widget
5788     * size/resize in any way. For that effect, take a look at
5789     * elm_image_scale_set().
5790     *
5791     * @see elm_image_no_scale_get()
5792     * @see elm_image_scale_set()
5793     * @see elm_object_scale_set()
5794     *
5795     * @ingroup Image
5796     */
5797    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5798
5799    /**
5800     * Get whether scaling is disabled on the object.
5801     *
5802     * @param obj The image object
5803     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5804     *
5805     * @see elm_image_no_scale_set()
5806     *
5807     * @ingroup Image
5808     */
5809    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5810
5811    /**
5812     * Set if the object is (up/down) resizable.
5813     *
5814     * @param obj The image object
5815     * @param scale_up A bool to set if the object is resizable up. Default is
5816     * @c EINA_TRUE.
5817     * @param scale_down A bool to set if the object is resizable down. Default
5818     * is @c EINA_TRUE.
5819     *
5820     * This function limits the image resize ability. If @p scale_up is set to
5821     * @c EINA_FALSE, the object can't have its height or width resized to a value
5822     * higher than the original image size. Same is valid for @p scale_down.
5823     *
5824     * @see elm_image_scale_get()
5825     *
5826     * @ingroup Image
5827     */
5828    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5829
5830    /**
5831     * Get if the object is (up/down) resizable.
5832     *
5833     * @param obj The image object
5834     * @param scale_up A bool to set if the object is resizable up
5835     * @param scale_down A bool to set if the object is resizable down
5836     *
5837     * @see elm_image_scale_set()
5838     *
5839     * @ingroup Image
5840     */
5841    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5842
5843    /**
5844     * Set if the image fills the entire object area, when keeping the aspect ratio.
5845     *
5846     * @param obj The image object
5847     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5848     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5849     *
5850     * When the image should keep its aspect ratio even if resized to another
5851     * aspect ratio, there are two possibilities to resize it: keep the entire
5852     * image inside the limits of height and width of the object (@p fill_outside
5853     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5854     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5855     *
5856     * @note This option will have no effect if
5857     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5858     *
5859     * @see elm_image_fill_outside_get()
5860     * @see elm_image_aspect_ratio_retained_set()
5861     *
5862     * @ingroup Image
5863     */
5864    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5865
5866    /**
5867     * Get if the object is filled outside
5868     *
5869     * @param obj The image object
5870     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5871     *
5872     * @see elm_image_fill_outside_set()
5873     *
5874     * @ingroup Image
5875     */
5876    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5877
5878    /**
5879     * Set the prescale size for the image
5880     *
5881     * @param obj The image object
5882     * @param size The prescale size. This value is used for both width and
5883     * height.
5884     *
5885     * This function sets a new size for pixmap representation of the given
5886     * image. It allows the image to be loaded already in the specified size,
5887     * reducing the memory usage and load time when loading a big image with load
5888     * size set to a smaller size.
5889     *
5890     * It's equivalent to the elm_bg_load_size_set() function for bg.
5891     *
5892     * @note this is just a hint, the real size of the pixmap may differ
5893     * depending on the type of image being loaded, being bigger than requested.
5894     *
5895     * @see elm_image_prescale_get()
5896     * @see elm_bg_load_size_set()
5897     *
5898     * @ingroup Image
5899     */
5900    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5901
5902    /**
5903     * Get the prescale size for the image
5904     *
5905     * @param obj The image object
5906     * @return The prescale size
5907     *
5908     * @see elm_image_prescale_set()
5909     *
5910     * @ingroup Image
5911     */
5912    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5913
5914    /**
5915     * Set the image orientation.
5916     *
5917     * @param obj The image object
5918     * @param orient The image orientation @ref Elm_Image_Orient
5919     *  Default is #ELM_IMAGE_ORIENT_NONE.
5920     *
5921     * This function allows to rotate or flip the given image.
5922     *
5923     * @see elm_image_orient_get()
5924     * @see @ref Elm_Image_Orient
5925     *
5926     * @ingroup Image
5927     */
5928    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5929
5930    /**
5931     * Get the image orientation.
5932     *
5933     * @param obj The image object
5934     * @return The image orientation @ref Elm_Image_Orient
5935     *
5936     * @see elm_image_orient_set()
5937     * @see @ref Elm_Image_Orient
5938     *
5939     * @ingroup Image
5940     */
5941    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5942
5943    /**
5944     * Make the image 'editable'.
5945     *
5946     * @param obj Image object.
5947     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5948     *
5949     * This means the image is a valid drag target for drag and drop, and can be
5950     * cut or pasted too.
5951     *
5952     * @ingroup Image
5953     */
5954    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5955
5956    /**
5957     * Check if the image 'editable'.
5958     *
5959     * @param obj Image object.
5960     * @return Editability.
5961     *
5962     * A return value of EINA_TRUE means the image is a valid drag target
5963     * for drag and drop, and can be cut or pasted too.
5964     *
5965     * @ingroup Image
5966     */
5967    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5968
5969    /**
5970     * Get the basic Evas_Image object from this object (widget).
5971     *
5972     * @param obj The image object to get the inlined image from
5973     * @return The inlined image object, or NULL if none exists
5974     *
5975     * This function allows one to get the underlying @c Evas_Object of type
5976     * Image from this elementary widget. It can be useful to do things like get
5977     * the pixel data, save the image to a file, etc.
5978     *
5979     * @note Be careful to not manipulate it, as it is under control of
5980     * elementary.
5981     *
5982     * @ingroup Image
5983     */
5984    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5985
5986    /**
5987     * Set whether the original aspect ratio of the image should be kept on resize.
5988     *
5989     * @param obj The image object.
5990     * @param retained @c EINA_TRUE if the image should retain the aspect,
5991     * @c EINA_FALSE otherwise.
5992     *
5993     * The original aspect ratio (width / height) of the image is usually
5994     * distorted to match the object's size. Enabling this option will retain
5995     * this original aspect, and the way that the image is fit into the object's
5996     * area depends on the option set by elm_image_fill_outside_set().
5997     *
5998     * @see elm_image_aspect_ratio_retained_get()
5999     * @see elm_image_fill_outside_set()
6000     *
6001     * @ingroup Image
6002     */
6003    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
6004
6005    /**
6006     * Get if the object retains the original aspect ratio.
6007     *
6008     * @param obj The image object.
6009     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
6010     * otherwise.
6011     *
6012     * @ingroup Image
6013     */
6014    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6015
6016    /**
6017     * @}
6018     */
6019
6020    /* glview */
6021    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
6022
6023    typedef enum _Elm_GLView_Mode
6024      {
6025         ELM_GLVIEW_ALPHA   = 1,
6026         ELM_GLVIEW_DEPTH   = 2,
6027         ELM_GLVIEW_STENCIL = 4
6028      } Elm_GLView_Mode;
6029
6030    /**
6031     * Defines a policy for the glview resizing.
6032     *
6033     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
6034     */
6035    typedef enum _Elm_GLView_Resize_Policy
6036      {
6037         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
6038         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
6039      } Elm_GLView_Resize_Policy;
6040
6041    typedef enum _Elm_GLView_Render_Policy
6042      {
6043         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
6044         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
6045      } Elm_GLView_Render_Policy;
6046
6047    /**
6048     * @defgroup GLView
6049     *
6050     * A simple GLView widget that allows GL rendering.
6051     *
6052     * Signals that you can add callbacks for are:
6053     *
6054     * @{
6055     */
6056
6057    /**
6058     * Add a new glview to the parent
6059     *
6060     * @param parent The parent object
6061     * @return The new object or NULL if it cannot be created
6062     *
6063     * @ingroup GLView
6064     */
6065    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6066
6067    /**
6068     * Sets the size of the glview
6069     *
6070     * @param obj The glview object
6071     * @param width width of the glview object
6072     * @param height height of the glview object
6073     *
6074     * @ingroup GLView
6075     */
6076    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6077
6078    /**
6079     * Gets the size of the glview.
6080     *
6081     * @param obj The glview object
6082     * @param width width of the glview object
6083     * @param height height of the glview object
6084     *
6085     * Note that this function returns the actual image size of the
6086     * glview.  This means that when the scale policy is set to
6087     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
6088     * size.
6089     *
6090     * @ingroup GLView
6091     */
6092    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6093
6094    /**
6095     * Gets the gl api struct for gl rendering
6096     *
6097     * @param obj The glview object
6098     * @return The api object or NULL if it cannot be created
6099     *
6100     * @ingroup GLView
6101     */
6102    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6103
6104    /**
6105     * Set the mode of the GLView. Supports Three simple modes.
6106     *
6107     * @param obj The glview object
6108     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
6109     * @return True if set properly.
6110     *
6111     * @ingroup GLView
6112     */
6113    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
6114
6115    /**
6116     * Set the resize policy for the glview object.
6117     *
6118     * @param obj The glview object.
6119     * @param policy The scaling policy.
6120     *
6121     * By default, the resize policy is set to
6122     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
6123     * destroys the previous surface and recreates the newly specified
6124     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
6125     * however, glview only scales the image object and not the underlying
6126     * GL Surface.
6127     *
6128     * @ingroup GLView
6129     */
6130    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
6131
6132    /**
6133     * Set the render policy for the glview object.
6134     *
6135     * @param obj The glview object.
6136     * @param policy The render policy.
6137     *
6138     * By default, the render policy is set to
6139     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
6140     * that during the render loop, glview is only redrawn if it needs
6141     * to be redrawn. (i.e. When it is visible) If the policy is set to
6142     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
6143     * whether it is visible/need redrawing or not.
6144     *
6145     * @ingroup GLView
6146     */
6147    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
6148
6149    /**
6150     * Set the init function that runs once in the main loop.
6151     *
6152     * @param obj The glview object.
6153     * @param func The init function to be registered.
6154     *
6155     * The registered init function gets called once during the render loop.
6156     *
6157     * @ingroup GLView
6158     */
6159    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6160
6161    /**
6162     * Set the render function that runs in the main loop.
6163     *
6164     * @param obj The glview object.
6165     * @param func The delete function to be registered.
6166     *
6167     * The registered del function gets called when GLView object is deleted.
6168     *
6169     * @ingroup GLView
6170     */
6171    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6172
6173    /**
6174     * Set the resize function that gets called when resize happens.
6175     *
6176     * @param obj The glview object.
6177     * @param func The resize function to be registered.
6178     *
6179     * @ingroup GLView
6180     */
6181    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6182
6183    /**
6184     * Set the render function that runs in the main loop.
6185     *
6186     * @param obj The glview object.
6187     * @param func The render function to be registered.
6188     *
6189     * @ingroup GLView
6190     */
6191    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
6192
6193    /**
6194     * Notifies that there has been changes in the GLView.
6195     *
6196     * @param obj The glview object.
6197     *
6198     * @ingroup GLView
6199     */
6200    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6201
6202    /**
6203     * @}
6204     */
6205
6206    /* box */
6207    /**
6208     * @defgroup Box Box
6209     *
6210     * @image html img/widget/box/preview-00.png
6211     * @image latex img/widget/box/preview-00.eps width=\textwidth
6212     *
6213     * @image html img/box.png
6214     * @image latex img/box.eps width=\textwidth
6215     *
6216     * A box arranges objects in a linear fashion, governed by a layout function
6217     * that defines the details of this arrangement.
6218     *
6219     * By default, the box will use an internal function to set the layout to
6220     * a single row, either vertical or horizontal. This layout is affected
6221     * by a number of parameters, such as the homogeneous flag set by
6222     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
6223     * elm_box_align_set() and the hints set to each object in the box.
6224     *
6225     * For this default layout, it's possible to change the orientation with
6226     * elm_box_horizontal_set(). The box will start in the vertical orientation,
6227     * placing its elements ordered from top to bottom. When horizontal is set,
6228     * the order will go from left to right. If the box is set to be
6229     * homogeneous, every object in it will be assigned the same space, that
6230     * of the largest object. Padding can be used to set some spacing between
6231     * the cell given to each object. The alignment of the box, set with
6232     * elm_box_align_set(), determines how the bounding box of all the elements
6233     * will be placed within the space given to the box widget itself.
6234     *
6235     * The size hints of each object also affect how they are placed and sized
6236     * within the box. evas_object_size_hint_min_set() will give the minimum
6237     * size the object can have, and the box will use it as the basis for all
6238     * latter calculations. Elementary widgets set their own minimum size as
6239     * needed, so there's rarely any need to use it manually.
6240     *
6241     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
6242     * used to tell whether the object will be allocated the minimum size it
6243     * needs or if the space given to it should be expanded. It's important
6244     * to realize that expanding the size given to the object is not the same
6245     * thing as resizing the object. It could very well end being a small
6246     * widget floating in a much larger empty space. If not set, the weight
6247     * for objects will normally be 0.0 for both axis, meaning the widget will
6248     * not be expanded. To take as much space possible, set the weight to
6249     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
6250     *
6251     * Besides how much space each object is allocated, it's possible to control
6252     * how the widget will be placed within that space using
6253     * evas_object_size_hint_align_set(). By default, this value will be 0.5
6254     * for both axis, meaning the object will be centered, but any value from
6255     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
6256     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
6257     * is -1.0, means the object will be resized to fill the entire space it
6258     * was allocated.
6259     *
6260     * In addition, customized functions to define the layout can be set, which
6261     * allow the application developer to organize the objects within the box
6262     * in any number of ways.
6263     *
6264     * The special elm_box_layout_transition() function can be used
6265     * to switch from one layout to another, animating the motion of the
6266     * children of the box.
6267     *
6268     * @note Objects should not be added to box objects using _add() calls.
6269     *
6270     * Some examples on how to use boxes follow:
6271     * @li @ref box_example_01
6272     * @li @ref box_example_02
6273     *
6274     * @{
6275     */
6276    /**
6277     * @typedef Elm_Box_Transition
6278     *
6279     * Opaque handler containing the parameters to perform an animated
6280     * transition of the layout the box uses.
6281     *
6282     * @see elm_box_transition_new()
6283     * @see elm_box_layout_set()
6284     * @see elm_box_layout_transition()
6285     */
6286    typedef struct _Elm_Box_Transition Elm_Box_Transition;
6287
6288    /**
6289     * Add a new box to the parent
6290     *
6291     * By default, the box will be in vertical mode and non-homogeneous.
6292     *
6293     * @param parent The parent object
6294     * @return The new object or NULL if it cannot be created
6295     */
6296    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6297
6298    /**
6299     * Set the horizontal orientation
6300     *
6301     * By default, box object arranges their contents vertically from top to
6302     * bottom.
6303     * By calling this function with @p horizontal as EINA_TRUE, the box will
6304     * become horizontal, arranging contents from left to right.
6305     *
6306     * @note This flag is ignored if a custom layout function is set.
6307     *
6308     * @param obj The box object
6309     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6310     * EINA_FALSE = vertical)
6311     */
6312    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6313
6314    /**
6315     * Get the horizontal orientation
6316     *
6317     * @param obj The box object
6318     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6319     */
6320    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6321
6322    /**
6323     * Set the box to arrange its children homogeneously
6324     *
6325     * If enabled, homogeneous layout makes all items the same size, according
6326     * to the size of the largest of its children.
6327     *
6328     * @note This flag is ignored if a custom layout function is set.
6329     *
6330     * @param obj The box object
6331     * @param homogeneous The homogeneous flag
6332     */
6333    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6334
6335    /**
6336     * Get whether the box is using homogeneous mode or not
6337     *
6338     * @param obj The box object
6339     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6340     */
6341    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6342
6343    /**
6344     * Add an object to the beginning of the pack list
6345     *
6346     * Pack @p subobj into the box @p obj, placing it first in the list of
6347     * children objects. The actual position the object will get on screen
6348     * depends on the layout used. If no custom layout is set, it will be at
6349     * the top or left, depending if the box is vertical or horizontal,
6350     * respectively.
6351     *
6352     * @param obj The box object
6353     * @param subobj The object to add to the box
6354     *
6355     * @see elm_box_pack_end()
6356     * @see elm_box_pack_before()
6357     * @see elm_box_pack_after()
6358     * @see elm_box_unpack()
6359     * @see elm_box_unpack_all()
6360     * @see elm_box_clear()
6361     */
6362    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6363
6364    /**
6365     * Add an object at the end of the pack list
6366     *
6367     * Pack @p subobj into the box @p obj, placing it last in the list of
6368     * children objects. The actual position the object will get on screen
6369     * depends on the layout used. If no custom layout is set, it will be at
6370     * the bottom or right, depending if the box is vertical or horizontal,
6371     * respectively.
6372     *
6373     * @param obj The box object
6374     * @param subobj The object to add to the box
6375     *
6376     * @see elm_box_pack_start()
6377     * @see elm_box_pack_before()
6378     * @see elm_box_pack_after()
6379     * @see elm_box_unpack()
6380     * @see elm_box_unpack_all()
6381     * @see elm_box_clear()
6382     */
6383    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6384
6385    /**
6386     * Adds an object to the box before the indicated object
6387     *
6388     * This will add the @p subobj to the box indicated before the object
6389     * indicated with @p before. If @p before is not already in the box, results
6390     * are undefined. Before means either to the left of the indicated object or
6391     * above it depending on orientation.
6392     *
6393     * @param obj The box object
6394     * @param subobj The object to add to the box
6395     * @param before The object before which to add it
6396     *
6397     * @see elm_box_pack_start()
6398     * @see elm_box_pack_end()
6399     * @see elm_box_pack_after()
6400     * @see elm_box_unpack()
6401     * @see elm_box_unpack_all()
6402     * @see elm_box_clear()
6403     */
6404    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6405
6406    /**
6407     * Adds an object to the box after the indicated object
6408     *
6409     * This will add the @p subobj to the box indicated after the object
6410     * indicated with @p after. If @p after is not already in the box, results
6411     * are undefined. After means either to the right of the indicated object or
6412     * below it depending on orientation.
6413     *
6414     * @param obj The box object
6415     * @param subobj The object to add to the box
6416     * @param after The object after which to add it
6417     *
6418     * @see elm_box_pack_start()
6419     * @see elm_box_pack_end()
6420     * @see elm_box_pack_before()
6421     * @see elm_box_unpack()
6422     * @see elm_box_unpack_all()
6423     * @see elm_box_clear()
6424     */
6425    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6426
6427    /**
6428     * Clear the box of all children
6429     *
6430     * Remove all the elements contained by the box, deleting the respective
6431     * objects.
6432     *
6433     * @param obj The box object
6434     *
6435     * @see elm_box_unpack()
6436     * @see elm_box_unpack_all()
6437     */
6438    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6439
6440    /**
6441     * Unpack a box item
6442     *
6443     * Remove the object given by @p subobj from the box @p obj without
6444     * deleting it.
6445     *
6446     * @param obj The box object
6447     *
6448     * @see elm_box_unpack_all()
6449     * @see elm_box_clear()
6450     */
6451    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6452
6453    /**
6454     * Remove all items from the box, without deleting them
6455     *
6456     * Clear the box from all children, but don't delete the respective objects.
6457     * If no other references of the box children exist, the objects will never
6458     * be deleted, and thus the application will leak the memory. Make sure
6459     * when using this function that you hold a reference to all the objects
6460     * in the box @p obj.
6461     *
6462     * @param obj The box object
6463     *
6464     * @see elm_box_clear()
6465     * @see elm_box_unpack()
6466     */
6467    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6468
6469    /**
6470     * Retrieve a list of the objects packed into the box
6471     *
6472     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6473     * The order of the list corresponds to the packing order the box uses.
6474     *
6475     * You must free this list with eina_list_free() once you are done with it.
6476     *
6477     * @param obj The box object
6478     */
6479    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6480
6481    /**
6482     * Set the space (padding) between the box's elements.
6483     *
6484     * Extra space in pixels that will be added between a box child and its
6485     * neighbors after its containing cell has been calculated. This padding
6486     * is set for all elements in the box, besides any possible padding that
6487     * individual elements may have through their size hints.
6488     *
6489     * @param obj The box object
6490     * @param horizontal The horizontal space between elements
6491     * @param vertical The vertical space between elements
6492     */
6493    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6494
6495    /**
6496     * Get the space (padding) between the box's elements.
6497     *
6498     * @param obj The box object
6499     * @param horizontal The horizontal space between elements
6500     * @param vertical The vertical space between elements
6501     *
6502     * @see elm_box_padding_set()
6503     */
6504    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6505
6506    /**
6507     * Set the alignment of the whole bouding box of contents.
6508     *
6509     * Sets how the bounding box containing all the elements of the box, after
6510     * their sizes and position has been calculated, will be aligned within
6511     * the space given for the whole box widget.
6512     *
6513     * @param obj The box object
6514     * @param horizontal The horizontal alignment of elements
6515     * @param vertical The vertical alignment of elements
6516     */
6517    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6518
6519    /**
6520     * Get the alignment of the whole bouding box of contents.
6521     *
6522     * @param obj The box object
6523     * @param horizontal The horizontal alignment of elements
6524     * @param vertical The vertical alignment of elements
6525     *
6526     * @see elm_box_align_set()
6527     */
6528    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6529
6530    /**
6531     * Force the box to recalculate its children packing.
6532     *
6533     * If any children was added or removed, box will not calculate the
6534     * values immediately rather leaving it to the next main loop
6535     * iteration. While this is great as it would save lots of
6536     * recalculation, whenever you need to get the position of a just
6537     * added item you must force recalculate before doing so.
6538     *
6539     * @param obj The box object.
6540     */
6541    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6542
6543    /**
6544     * Set the layout defining function to be used by the box
6545     *
6546     * Whenever anything changes that requires the box in @p obj to recalculate
6547     * the size and position of its elements, the function @p cb will be called
6548     * to determine what the layout of the children will be.
6549     *
6550     * Once a custom function is set, everything about the children layout
6551     * is defined by it. The flags set by elm_box_horizontal_set() and
6552     * elm_box_homogeneous_set() no longer have any meaning, and the values
6553     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6554     * layout function to decide if they are used and how. These last two
6555     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6556     * passed to @p cb. The @c Evas_Object the function receives is not the
6557     * Elementary widget, but the internal Evas Box it uses, so none of the
6558     * functions described here can be used on it.
6559     *
6560     * Any of the layout functions in @c Evas can be used here, as well as the
6561     * special elm_box_layout_transition().
6562     *
6563     * The final @p data argument received by @p cb is the same @p data passed
6564     * here, and the @p free_data function will be called to free it
6565     * whenever the box is destroyed or another layout function is set.
6566     *
6567     * Setting @p cb to NULL will revert back to the default layout function.
6568     *
6569     * @param obj The box object
6570     * @param cb The callback function used for layout
6571     * @param data Data that will be passed to layout function
6572     * @param free_data Function called to free @p data
6573     *
6574     * @see elm_box_layout_transition()
6575     */
6576    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);
6577
6578    /**
6579     * Special layout function that animates the transition from one layout to another
6580     *
6581     * Normally, when switching the layout function for a box, this will be
6582     * reflected immediately on screen on the next render, but it's also
6583     * possible to do this through an animated transition.
6584     *
6585     * This is done by creating an ::Elm_Box_Transition and setting the box
6586     * layout to this function.
6587     *
6588     * For example:
6589     * @code
6590     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6591     *                            evas_object_box_layout_vertical, // start
6592     *                            NULL, // data for initial layout
6593     *                            NULL, // free function for initial data
6594     *                            evas_object_box_layout_horizontal, // end
6595     *                            NULL, // data for final layout
6596     *                            NULL, // free function for final data
6597     *                            anim_end, // will be called when animation ends
6598     *                            NULL); // data for anim_end function\
6599     * elm_box_layout_set(box, elm_box_layout_transition, t,
6600     *                    elm_box_transition_free);
6601     * @endcode
6602     *
6603     * @note This function can only be used with elm_box_layout_set(). Calling
6604     * it directly will not have the expected results.
6605     *
6606     * @see elm_box_transition_new
6607     * @see elm_box_transition_free
6608     * @see elm_box_layout_set
6609     */
6610    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6611
6612    /**
6613     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6614     *
6615     * If you want to animate the change from one layout to another, you need
6616     * to set the layout function of the box to elm_box_layout_transition(),
6617     * passing as user data to it an instance of ::Elm_Box_Transition with the
6618     * necessary information to perform this animation. The free function to
6619     * set for the layout is elm_box_transition_free().
6620     *
6621     * The parameters to create an ::Elm_Box_Transition sum up to how long
6622     * will it be, in seconds, a layout function to describe the initial point,
6623     * another for the final position of the children and one function to be
6624     * called when the whole animation ends. This last function is useful to
6625     * set the definitive layout for the box, usually the same as the end
6626     * layout for the animation, but could be used to start another transition.
6627     *
6628     * @param start_layout The layout function that will be used to start the animation
6629     * @param start_layout_data The data to be passed the @p start_layout function
6630     * @param start_layout_free_data Function to free @p start_layout_data
6631     * @param end_layout The layout function that will be used to end the animation
6632     * @param end_layout_free_data The data to be passed the @p end_layout function
6633     * @param end_layout_free_data Function to free @p end_layout_data
6634     * @param transition_end_cb Callback function called when animation ends
6635     * @param transition_end_data Data to be passed to @p transition_end_cb
6636     * @return An instance of ::Elm_Box_Transition
6637     *
6638     * @see elm_box_transition_new
6639     * @see elm_box_layout_transition
6640     */
6641    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);
6642
6643    /**
6644     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6645     *
6646     * This function is mostly useful as the @c free_data parameter in
6647     * elm_box_layout_set() when elm_box_layout_transition().
6648     *
6649     * @param data The Elm_Box_Transition instance to be freed.
6650     *
6651     * @see elm_box_transition_new
6652     * @see elm_box_layout_transition
6653     */
6654    EAPI void                elm_box_transition_free(void *data);
6655
6656    /**
6657     * @}
6658     */
6659
6660    /* button */
6661    /**
6662     * @defgroup Button Button
6663     *
6664     * @image html img/widget/button/preview-00.png
6665     * @image latex img/widget/button/preview-00.eps
6666     * @image html img/widget/button/preview-01.png
6667     * @image latex img/widget/button/preview-01.eps
6668     * @image html img/widget/button/preview-02.png
6669     * @image latex img/widget/button/preview-02.eps
6670     *
6671     * This is a push-button. Press it and run some function. It can contain
6672     * a simple label and icon object and it also has an autorepeat feature.
6673     *
6674     * This widgets emits the following signals:
6675     * @li "clicked": the user clicked the button (press/release).
6676     * @li "repeated": the user pressed the button without releasing it.
6677     * @li "pressed": button was pressed.
6678     * @li "unpressed": button was released after being pressed.
6679     * In all three cases, the @c event parameter of the callback will be
6680     * @c NULL.
6681     *
6682     * Also, defined in the default theme, the button has the following styles
6683     * available:
6684     * @li default: a normal button.
6685     * @li anchor: Like default, but the button fades away when the mouse is not
6686     * over it, leaving only the text or icon.
6687     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6688     * continuous look across its options.
6689     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6690     *
6691     * Default contents parts of the button widget that you can use for are:
6692     * @li "icon" - An icon of the button
6693     *
6694     * Default text parts of the button widget that you can use for are:
6695     * @li "default" - Label of the button
6696     *
6697     * Follow through a complete example @ref button_example_01 "here".
6698     * @{
6699     */
6700
6701    /**
6702     * Add a new button to the parent's canvas
6703     *
6704     * @param parent The parent object
6705     * @return The new object or NULL if it cannot be created
6706     */
6707    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6708
6709    /**
6710     * Set the label used in the button
6711     *
6712     * The passed @p label can be NULL to clean any existing text in it and
6713     * leave the button as an icon only object.
6714     *
6715     * @param obj The button object
6716     * @param label The text will be written on the button
6717     * @deprecated use elm_object_text_set() instead.
6718     */
6719    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6720
6721    /**
6722     * Get the label set for the button
6723     *
6724     * The string returned is an internal pointer and should not be freed or
6725     * altered. It will also become invalid when the button is destroyed.
6726     * The string returned, if not NULL, is a stringshare, so if you need to
6727     * keep it around even after the button is destroyed, you can use
6728     * eina_stringshare_ref().
6729     *
6730     * @param obj The button object
6731     * @return The text set to the label, or NULL if nothing is set
6732     * @deprecated use elm_object_text_set() instead.
6733     */
6734    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6735
6736    /**
6737     * Set the icon used for the button
6738     *
6739     * Setting a new icon will delete any other that was previously set, making
6740     * any reference to them invalid. If you need to maintain the previous
6741     * object alive, unset it first with elm_button_icon_unset().
6742     *
6743     * @param obj The button object
6744     * @param icon The icon object for the button
6745     * @deprecated use elm_object_part_content_set() instead.
6746     */
6747    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6748
6749    /**
6750     * Get the icon used for the button
6751     *
6752     * Return the icon object which is set for this widget. If the button is
6753     * destroyed or another icon is set, the returned object will be deleted
6754     * and any reference to it will be invalid.
6755     *
6756     * @param obj The button object
6757     * @return The icon object that is being used
6758     *
6759     * @deprecated use elm_object_part_content_get() instead
6760     */
6761    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6762
6763    /**
6764     * Remove the icon set without deleting it and return the object
6765     *
6766     * This function drops the reference the button holds of the icon object
6767     * and returns this last object. It is used in case you want to remove any
6768     * icon, or set another one, without deleting the actual object. The button
6769     * will be left without an icon set.
6770     *
6771     * @param obj The button object
6772     * @return The icon object that was being used
6773     * @deprecated use elm_object_part_content_unset() instead.
6774     */
6775    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6776
6777    /**
6778     * Turn on/off the autorepeat event generated when the button is kept pressed
6779     *
6780     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6781     * signal when they are clicked.
6782     *
6783     * When on, keeping a button pressed will continuously emit a @c repeated
6784     * signal until the button is released. The time it takes until it starts
6785     * emitting the signal is given by
6786     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6787     * new emission by elm_button_autorepeat_gap_timeout_set().
6788     *
6789     * @param obj The button object
6790     * @param on  A bool to turn on/off the event
6791     */
6792    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6793
6794    /**
6795     * Get whether the autorepeat feature is enabled
6796     *
6797     * @param obj The button object
6798     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6799     *
6800     * @see elm_button_autorepeat_set()
6801     */
6802    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6803
6804    /**
6805     * Set the initial timeout before the autorepeat event is generated
6806     *
6807     * Sets the timeout, in seconds, since the button is pressed until the
6808     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6809     * won't be any delay and the even will be fired the moment the button is
6810     * pressed.
6811     *
6812     * @param obj The button object
6813     * @param t   Timeout in seconds
6814     *
6815     * @see elm_button_autorepeat_set()
6816     * @see elm_button_autorepeat_gap_timeout_set()
6817     */
6818    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6819
6820    /**
6821     * Get the initial timeout before the autorepeat event is generated
6822     *
6823     * @param obj The button object
6824     * @return Timeout in seconds
6825     *
6826     * @see elm_button_autorepeat_initial_timeout_set()
6827     */
6828    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6829
6830    /**
6831     * Set the interval between each generated autorepeat event
6832     *
6833     * After the first @c repeated event is fired, all subsequent ones will
6834     * follow after a delay of @p t seconds for each.
6835     *
6836     * @param obj The button object
6837     * @param t   Interval in seconds
6838     *
6839     * @see elm_button_autorepeat_initial_timeout_set()
6840     */
6841    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6842
6843    /**
6844     * Get the interval between each generated autorepeat event
6845     *
6846     * @param obj The button object
6847     * @return Interval in seconds
6848     */
6849    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6850
6851    /**
6852     * @}
6853     */
6854
6855    /**
6856     * @defgroup File_Selector_Button File Selector Button
6857     *
6858     * @image html img/widget/fileselector_button/preview-00.png
6859     * @image latex img/widget/fileselector_button/preview-00.eps
6860     * @image html img/widget/fileselector_button/preview-01.png
6861     * @image latex img/widget/fileselector_button/preview-01.eps
6862     * @image html img/widget/fileselector_button/preview-02.png
6863     * @image latex img/widget/fileselector_button/preview-02.eps
6864     *
6865     * This is a button that, when clicked, creates an Elementary
6866     * window (or inner window) <b> with a @ref Fileselector "file
6867     * selector widget" within</b>. When a file is chosen, the (inner)
6868     * window is closed and the button emits a signal having the
6869     * selected file as it's @c event_info.
6870     *
6871     * This widget encapsulates operations on its internal file
6872     * selector on its own API. There is less control over its file
6873     * selector than that one would have instatiating one directly.
6874     *
6875     * The following styles are available for this button:
6876     * @li @c "default"
6877     * @li @c "anchor"
6878     * @li @c "hoversel_vertical"
6879     * @li @c "hoversel_vertical_entry"
6880     *
6881     * Smart callbacks one can register to:
6882     * - @c "file,chosen" - the user has selected a path, whose string
6883     *   pointer comes as the @c event_info data (a stringshared
6884     *   string)
6885     *
6886     * Here is an example on its usage:
6887     * @li @ref fileselector_button_example
6888     *
6889     * @see @ref File_Selector_Entry for a similar widget.
6890     * @{
6891     */
6892
6893    /**
6894     * Add a new file selector button widget to the given parent
6895     * Elementary (container) object
6896     *
6897     * @param parent The parent object
6898     * @return a new file selector button widget handle or @c NULL, on
6899     * errors
6900     */
6901    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6902
6903    /**
6904     * Set the label for a given file selector button widget
6905     *
6906     * @param obj The file selector button widget
6907     * @param label The text label to be displayed on @p obj
6908     *
6909     * @deprecated use elm_object_text_set() instead.
6910     */
6911    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6912
6913    /**
6914     * Get the label set for a given file selector button widget
6915     *
6916     * @param obj The file selector button widget
6917     * @return The button label
6918     *
6919     * @deprecated use elm_object_text_set() instead.
6920     */
6921    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6922
6923    /**
6924     * Set the icon on a given file selector button widget
6925     *
6926     * @param obj The file selector button widget
6927     * @param icon The icon object for the button
6928     *
6929     * Once the icon object is set, a previously set one will be
6930     * deleted. If you want to keep the latter, use the
6931     * elm_fileselector_button_icon_unset() function.
6932     *
6933     * @see elm_fileselector_button_icon_get()
6934     */
6935    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6936
6937    /**
6938     * Get the icon set for a given file selector button widget
6939     *
6940     * @param obj The file selector button widget
6941     * @return The icon object currently set on @p obj or @c NULL, if
6942     * none is
6943     *
6944     * @see elm_fileselector_button_icon_set()
6945     */
6946    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6947
6948    /**
6949     * Unset the icon used in a given file selector button widget
6950     *
6951     * @param obj The file selector button widget
6952     * @return The icon object that was being used on @p obj or @c
6953     * NULL, on errors
6954     *
6955     * Unparent and return the icon object which was set for this
6956     * widget.
6957     *
6958     * @see elm_fileselector_button_icon_set()
6959     */
6960    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6961
6962    /**
6963     * Set the title for a given file selector button widget's window
6964     *
6965     * @param obj The file selector button widget
6966     * @param title The title string
6967     *
6968     * This will change the window's title, when the file selector pops
6969     * out after a click on the button. Those windows have the default
6970     * (unlocalized) value of @c "Select a file" as titles.
6971     *
6972     * @note It will only take any effect if the file selector
6973     * button widget is @b not under "inwin mode".
6974     *
6975     * @see elm_fileselector_button_window_title_get()
6976     */
6977    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6978
6979    /**
6980     * Get the title set for a given file selector button widget's
6981     * window
6982     *
6983     * @param obj The file selector button widget
6984     * @return Title of the file selector button's window
6985     *
6986     * @see elm_fileselector_button_window_title_get() for more details
6987     */
6988    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6989
6990    /**
6991     * Set the size of a given file selector button widget's window,
6992     * holding the file selector itself.
6993     *
6994     * @param obj The file selector button widget
6995     * @param width The window's width
6996     * @param height The window's height
6997     *
6998     * @note it will only take any effect if the file selector button
6999     * widget is @b not under "inwin mode". The default size for the
7000     * window (when applicable) is 400x400 pixels.
7001     *
7002     * @see elm_fileselector_button_window_size_get()
7003     */
7004    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7005
7006    /**
7007     * Get the size of a given file selector button widget's window,
7008     * holding the file selector itself.
7009     *
7010     * @param obj The file selector button widget
7011     * @param width Pointer into which to store the width value
7012     * @param height Pointer into which to store the height value
7013     *
7014     * @note Use @c NULL pointers on the size values you're not
7015     * interested in: they'll be ignored by the function.
7016     *
7017     * @see elm_fileselector_button_window_size_set(), for more details
7018     */
7019    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7020
7021    /**
7022     * Set the initial file system path for a given file selector
7023     * button widget
7024     *
7025     * @param obj The file selector button widget
7026     * @param path The path string
7027     *
7028     * It must be a <b>directory</b> path, which will have the contents
7029     * displayed initially in the file selector's view, when invoked
7030     * from @p obj. The default initial path is the @c "HOME"
7031     * environment variable's value.
7032     *
7033     * @see elm_fileselector_button_path_get()
7034     */
7035    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7036
7037    /**
7038     * Get the initial file system path set for a given file selector
7039     * button widget
7040     *
7041     * @param obj The file selector button widget
7042     * @return path The path string
7043     *
7044     * @see elm_fileselector_button_path_set() for more details
7045     */
7046    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7047
7048    /**
7049     * Enable/disable a tree view in the given file selector button
7050     * widget's internal file selector
7051     *
7052     * @param obj The file selector button widget
7053     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7054     * disable
7055     *
7056     * This has the same effect as elm_fileselector_expandable_set(),
7057     * but now applied to a file selector button's internal file
7058     * selector.
7059     *
7060     * @note There's no way to put a file selector button's internal
7061     * file selector in "grid mode", as one may do with "pure" file
7062     * selectors.
7063     *
7064     * @see elm_fileselector_expandable_get()
7065     */
7066    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7067
7068    /**
7069     * Get whether tree view is enabled for the given file selector
7070     * button widget's internal file selector
7071     *
7072     * @param obj The file selector button widget
7073     * @return @c EINA_TRUE if @p obj widget's internal file selector
7074     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7075     *
7076     * @see elm_fileselector_expandable_set() for more details
7077     */
7078    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7079
7080    /**
7081     * Set whether a given file selector button widget's internal file
7082     * selector is to display folders only or the directory contents,
7083     * as well.
7084     *
7085     * @param obj The file selector button widget
7086     * @param only @c EINA_TRUE to make @p obj widget's internal file
7087     * selector only display directories, @c EINA_FALSE to make files
7088     * to be displayed in it too
7089     *
7090     * This has the same effect as elm_fileselector_folder_only_set(),
7091     * but now applied to a file selector button's internal file
7092     * selector.
7093     *
7094     * @see elm_fileselector_folder_only_get()
7095     */
7096    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7097
7098    /**
7099     * Get whether a given file selector button widget's internal file
7100     * selector is displaying folders only or the directory contents,
7101     * as well.
7102     *
7103     * @param obj The file selector button widget
7104     * @return @c EINA_TRUE if @p obj widget's internal file
7105     * selector is only displaying directories, @c EINA_FALSE if files
7106     * are being displayed in it too (and on errors)
7107     *
7108     * @see elm_fileselector_button_folder_only_set() for more details
7109     */
7110    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7111
7112    /**
7113     * Enable/disable the file name entry box where the user can type
7114     * in a name for a file, in a given file selector button widget's
7115     * internal file selector.
7116     *
7117     * @param obj The file selector button widget
7118     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7119     * file selector a "saving dialog", @c EINA_FALSE otherwise
7120     *
7121     * This has the same effect as elm_fileselector_is_save_set(),
7122     * but now applied to a file selector button's internal file
7123     * selector.
7124     *
7125     * @see elm_fileselector_is_save_get()
7126     */
7127    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7128
7129    /**
7130     * Get whether the given file selector button widget's internal
7131     * file selector is in "saving dialog" mode
7132     *
7133     * @param obj The file selector button widget
7134     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7135     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7136     * errors)
7137     *
7138     * @see elm_fileselector_button_is_save_set() for more details
7139     */
7140    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7141
7142    /**
7143     * Set whether a given file selector button widget's internal file
7144     * selector will raise an Elementary "inner window", instead of a
7145     * dedicated Elementary window. By default, it won't.
7146     *
7147     * @param obj The file selector button widget
7148     * @param value @c EINA_TRUE to make it use an inner window, @c
7149     * EINA_TRUE to make it use a dedicated window
7150     *
7151     * @see elm_win_inwin_add() for more information on inner windows
7152     * @see elm_fileselector_button_inwin_mode_get()
7153     */
7154    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7155
7156    /**
7157     * Get whether a given file selector button widget's internal file
7158     * selector will raise an Elementary "inner window", instead of a
7159     * dedicated Elementary window.
7160     *
7161     * @param obj The file selector button widget
7162     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7163     * if it will use a dedicated window
7164     *
7165     * @see elm_fileselector_button_inwin_mode_set() for more details
7166     */
7167    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7168
7169    /**
7170     * @}
7171     */
7172
7173     /**
7174     * @defgroup File_Selector_Entry File Selector Entry
7175     *
7176     * @image html img/widget/fileselector_entry/preview-00.png
7177     * @image latex img/widget/fileselector_entry/preview-00.eps
7178     *
7179     * This is an entry made to be filled with or display a <b>file
7180     * system path string</b>. Besides the entry itself, the widget has
7181     * a @ref File_Selector_Button "file selector button" on its side,
7182     * which will raise an internal @ref Fileselector "file selector widget",
7183     * when clicked, for path selection aided by file system
7184     * navigation.
7185     *
7186     * This file selector may appear in an Elementary window or in an
7187     * inner window. When a file is chosen from it, the (inner) window
7188     * is closed and the selected file's path string is exposed both as
7189     * an smart event and as the new text on the entry.
7190     *
7191     * This widget encapsulates operations on its internal file
7192     * selector on its own API. There is less control over its file
7193     * selector than that one would have instatiating one directly.
7194     *
7195     * Smart callbacks one can register to:
7196     * - @c "changed" - The text within the entry was changed
7197     * - @c "activated" - The entry has had editing finished and
7198     *   changes are to be "committed"
7199     * - @c "press" - The entry has been clicked
7200     * - @c "longpressed" - The entry has been clicked (and held) for a
7201     *   couple seconds
7202     * - @c "clicked" - The entry has been clicked
7203     * - @c "clicked,double" - The entry has been double clicked
7204     * - @c "focused" - The entry has received focus
7205     * - @c "unfocused" - The entry has lost focus
7206     * - @c "selection,paste" - A paste action has occurred on the
7207     *   entry
7208     * - @c "selection,copy" - A copy action has occurred on the entry
7209     * - @c "selection,cut" - A cut action has occurred on the entry
7210     * - @c "unpressed" - The file selector entry's button was released
7211     *   after being pressed.
7212     * - @c "file,chosen" - The user has selected a path via the file
7213     *   selector entry's internal file selector, whose string pointer
7214     *   comes as the @c event_info data (a stringshared string)
7215     *
7216     * Here is an example on its usage:
7217     * @li @ref fileselector_entry_example
7218     *
7219     * @see @ref File_Selector_Button for a similar widget.
7220     * @{
7221     */
7222
7223    /**
7224     * Add a new file selector entry widget to the given parent
7225     * Elementary (container) object
7226     *
7227     * @param parent The parent object
7228     * @return a new file selector entry widget handle or @c NULL, on
7229     * errors
7230     */
7231    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7232
7233    /**
7234     * Set the label for a given file selector entry widget's button
7235     *
7236     * @param obj The file selector entry widget
7237     * @param label The text label to be displayed on @p obj widget's
7238     * button
7239     *
7240     * @deprecated use elm_object_text_set() instead.
7241     */
7242    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7243
7244    /**
7245     * Get the label set for a given file selector entry widget's button
7246     *
7247     * @param obj The file selector entry widget
7248     * @return The widget button's label
7249     *
7250     * @deprecated use elm_object_text_set() instead.
7251     */
7252    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7253
7254    /**
7255     * Set the icon on a given file selector entry widget's button
7256     *
7257     * @param obj The file selector entry widget
7258     * @param icon The icon object for the entry's button
7259     *
7260     * Once the icon object is set, a previously set one will be
7261     * deleted. If you want to keep the latter, use the
7262     * elm_fileselector_entry_button_icon_unset() function.
7263     *
7264     * @see elm_fileselector_entry_button_icon_get()
7265     */
7266    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7267
7268    /**
7269     * Get the icon set for a given file selector entry widget's button
7270     *
7271     * @param obj The file selector entry widget
7272     * @return The icon object currently set on @p obj widget's button
7273     * or @c NULL, if none is
7274     *
7275     * @see elm_fileselector_entry_button_icon_set()
7276     */
7277    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7278
7279    /**
7280     * Unset the icon used in a given file selector entry widget's
7281     * button
7282     *
7283     * @param obj The file selector entry widget
7284     * @return The icon object that was being used on @p obj widget's
7285     * button or @c NULL, on errors
7286     *
7287     * Unparent and return the icon object which was set for this
7288     * widget's button.
7289     *
7290     * @see elm_fileselector_entry_button_icon_set()
7291     */
7292    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7293
7294    /**
7295     * Set the title for a given file selector entry widget's window
7296     *
7297     * @param obj The file selector entry widget
7298     * @param title The title string
7299     *
7300     * This will change the window's title, when the file selector pops
7301     * out after a click on the entry's button. Those windows have the
7302     * default (unlocalized) value of @c "Select a file" as titles.
7303     *
7304     * @note It will only take any effect if the file selector
7305     * entry widget is @b not under "inwin mode".
7306     *
7307     * @see elm_fileselector_entry_window_title_get()
7308     */
7309    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7310
7311    /**
7312     * Get the title set for a given file selector entry widget's
7313     * window
7314     *
7315     * @param obj The file selector entry widget
7316     * @return Title of the file selector entry's window
7317     *
7318     * @see elm_fileselector_entry_window_title_get() for more details
7319     */
7320    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7321
7322    /**
7323     * Set the size of a given file selector entry widget's window,
7324     * holding the file selector itself.
7325     *
7326     * @param obj The file selector entry widget
7327     * @param width The window's width
7328     * @param height The window's height
7329     *
7330     * @note it will only take any effect if the file selector entry
7331     * widget is @b not under "inwin mode". The default size for the
7332     * window (when applicable) is 400x400 pixels.
7333     *
7334     * @see elm_fileselector_entry_window_size_get()
7335     */
7336    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7337
7338    /**
7339     * Get the size of a given file selector entry widget's window,
7340     * holding the file selector itself.
7341     *
7342     * @param obj The file selector entry widget
7343     * @param width Pointer into which to store the width value
7344     * @param height Pointer into which to store the height value
7345     *
7346     * @note Use @c NULL pointers on the size values you're not
7347     * interested in: they'll be ignored by the function.
7348     *
7349     * @see elm_fileselector_entry_window_size_set(), for more details
7350     */
7351    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7352
7353    /**
7354     * Set the initial file system path and the entry's path string for
7355     * a given file selector entry widget
7356     *
7357     * @param obj The file selector entry widget
7358     * @param path The path string
7359     *
7360     * It must be a <b>directory</b> path, which will have the contents
7361     * displayed initially in the file selector's view, when invoked
7362     * from @p obj. The default initial path is the @c "HOME"
7363     * environment variable's value.
7364     *
7365     * @see elm_fileselector_entry_path_get()
7366     */
7367    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7368
7369    /**
7370     * Get the entry's path string for a given file selector entry
7371     * widget
7372     *
7373     * @param obj The file selector entry widget
7374     * @return path The path string
7375     *
7376     * @see elm_fileselector_entry_path_set() for more details
7377     */
7378    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7379
7380    /**
7381     * Enable/disable a tree view in the given file selector entry
7382     * widget's internal file selector
7383     *
7384     * @param obj The file selector entry widget
7385     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7386     * disable
7387     *
7388     * This has the same effect as elm_fileselector_expandable_set(),
7389     * but now applied to a file selector entry's internal file
7390     * selector.
7391     *
7392     * @note There's no way to put a file selector entry's internal
7393     * file selector in "grid mode", as one may do with "pure" file
7394     * selectors.
7395     *
7396     * @see elm_fileselector_expandable_get()
7397     */
7398    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7399
7400    /**
7401     * Get whether tree view is enabled for the given file selector
7402     * entry widget's internal file selector
7403     *
7404     * @param obj The file selector entry widget
7405     * @return @c EINA_TRUE if @p obj widget's internal file selector
7406     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7407     *
7408     * @see elm_fileselector_expandable_set() for more details
7409     */
7410    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7411
7412    /**
7413     * Set whether a given file selector entry widget's internal file
7414     * selector is to display folders only or the directory contents,
7415     * as well.
7416     *
7417     * @param obj The file selector entry widget
7418     * @param only @c EINA_TRUE to make @p obj widget's internal file
7419     * selector only display directories, @c EINA_FALSE to make files
7420     * to be displayed in it too
7421     *
7422     * This has the same effect as elm_fileselector_folder_only_set(),
7423     * but now applied to a file selector entry's internal file
7424     * selector.
7425     *
7426     * @see elm_fileselector_folder_only_get()
7427     */
7428    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7429
7430    /**
7431     * Get whether a given file selector entry widget's internal file
7432     * selector is displaying folders only or the directory contents,
7433     * as well.
7434     *
7435     * @param obj The file selector entry widget
7436     * @return @c EINA_TRUE if @p obj widget's internal file
7437     * selector is only displaying directories, @c EINA_FALSE if files
7438     * are being displayed in it too (and on errors)
7439     *
7440     * @see elm_fileselector_entry_folder_only_set() for more details
7441     */
7442    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7443
7444    /**
7445     * Enable/disable the file name entry box where the user can type
7446     * in a name for a file, in a given file selector entry widget's
7447     * internal file selector.
7448     *
7449     * @param obj The file selector entry widget
7450     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7451     * file selector a "saving dialog", @c EINA_FALSE otherwise
7452     *
7453     * This has the same effect as elm_fileselector_is_save_set(),
7454     * but now applied to a file selector entry's internal file
7455     * selector.
7456     *
7457     * @see elm_fileselector_is_save_get()
7458     */
7459    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7460
7461    /**
7462     * Get whether the given file selector entry widget's internal
7463     * file selector is in "saving dialog" mode
7464     *
7465     * @param obj The file selector entry widget
7466     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7467     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7468     * errors)
7469     *
7470     * @see elm_fileselector_entry_is_save_set() for more details
7471     */
7472    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7473
7474    /**
7475     * Set whether a given file selector entry widget's internal file
7476     * selector will raise an Elementary "inner window", instead of a
7477     * dedicated Elementary window. By default, it won't.
7478     *
7479     * @param obj The file selector entry widget
7480     * @param value @c EINA_TRUE to make it use an inner window, @c
7481     * EINA_TRUE to make it use a dedicated window
7482     *
7483     * @see elm_win_inwin_add() for more information on inner windows
7484     * @see elm_fileselector_entry_inwin_mode_get()
7485     */
7486    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7487
7488    /**
7489     * Get whether a given file selector entry widget's internal file
7490     * selector will raise an Elementary "inner window", instead of a
7491     * dedicated Elementary window.
7492     *
7493     * @param obj The file selector entry widget
7494     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7495     * if it will use a dedicated window
7496     *
7497     * @see elm_fileselector_entry_inwin_mode_set() for more details
7498     */
7499    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7500
7501    /**
7502     * Set the initial file system path for a given file selector entry
7503     * widget
7504     *
7505     * @param obj The file selector entry widget
7506     * @param path The path string
7507     *
7508     * It must be a <b>directory</b> path, which will have the contents
7509     * displayed initially in the file selector's view, when invoked
7510     * from @p obj. The default initial path is the @c "HOME"
7511     * environment variable's value.
7512     *
7513     * @see elm_fileselector_entry_path_get()
7514     */
7515    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7516
7517    /**
7518     * Get the parent directory's path to the latest file selection on
7519     * a given filer selector entry widget
7520     *
7521     * @param obj The file selector object
7522     * @return The (full) path of the directory of the last selection
7523     * on @p obj widget, a @b stringshared string
7524     *
7525     * @see elm_fileselector_entry_path_set()
7526     */
7527    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7528
7529    /**
7530     * @}
7531     */
7532
7533    /**
7534     * @defgroup Scroller Scroller
7535     *
7536     * A scroller holds a single object and "scrolls it around". This means that
7537     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7538     * region around, allowing to move through a much larger object that is
7539     * contained in the scroller. The scroller will always have a small minimum
7540     * size by default as it won't be limited by the contents of the scroller.
7541     *
7542     * Signals that you can add callbacks for are:
7543     * @li "edge,left" - the left edge of the content has been reached
7544     * @li "edge,right" - the right edge of the content has been reached
7545     * @li "edge,top" - the top edge of the content has been reached
7546     * @li "edge,bottom" - the bottom edge of the content has been reached
7547     * @li "scroll" - the content has been scrolled (moved)
7548     * @li "scroll,anim,start" - scrolling animation has started
7549     * @li "scroll,anim,stop" - scrolling animation has stopped
7550     * @li "scroll,drag,start" - dragging the contents around has started
7551     * @li "scroll,drag,stop" - dragging the contents around has stopped
7552     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7553     * user intervetion.
7554     *
7555     * @note When Elemementary is in embedded mode the scrollbars will not be
7556     * dragable, they appear merely as indicators of how much has been scrolled.
7557     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7558     * fingerscroll) won't work.
7559     *
7560     * Default contents parts of the scroller widget that you can use for are:
7561     * @li "default" - A content of the scroller
7562     *
7563     * In @ref tutorial_scroller you'll find an example of how to use most of
7564     * this API.
7565     * @{
7566     */
7567
7568    /**
7569     * @brief Type that controls when scrollbars should appear.
7570     *
7571     * @see elm_scroller_policy_set()
7572     */
7573    typedef enum _Elm_Scroller_Policy
7574      {
7575         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7576         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7577         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7578         ELM_SCROLLER_POLICY_LAST
7579      } Elm_Scroller_Policy;
7580
7581    /**
7582     * @brief Add a new scroller to the parent
7583     *
7584     * @param parent The parent object
7585     * @return The new object or NULL if it cannot be created
7586     */
7587    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7588
7589    /**
7590     * @brief Set the content of the scroller widget (the object to be scrolled around).
7591     *
7592     * @param obj The scroller object
7593     * @param content The new content object
7594     *
7595     * Once the content object is set, a previously set one will be deleted.
7596     * If you want to keep that old content object, use the
7597     * elm_scroller_content_unset() function.
7598     * @deprecated use elm_object_content_set() instead
7599     */
7600    EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7601
7602    /**
7603     * @brief Get the content of the scroller widget
7604     *
7605     * @param obj The slider object
7606     * @return The content that is being used
7607     *
7608     * Return the content object which is set for this widget
7609     *
7610     * @see elm_scroller_content_set()
7611     * @deprecated use elm_object_content_get() instead.
7612     */
7613    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7614
7615    /**
7616     * @brief Unset the content of the scroller widget
7617     *
7618     * @param obj The slider object
7619     * @return The content that was being used
7620     *
7621     * Unparent and return the content object which was set for this widget
7622     *
7623     * @see elm_scroller_content_set()
7624     * @deprecated use elm_object_content_unset() instead.
7625     */
7626    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7627
7628    /**
7629     * @brief Set custom theme elements for the scroller
7630     *
7631     * @param obj The scroller object
7632     * @param widget The widget name to use (default is "scroller")
7633     * @param base The base name to use (default is "base")
7634     */
7635    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7636
7637    /**
7638     * @brief Make the scroller minimum size limited to the minimum size of the content
7639     *
7640     * @param obj The scroller object
7641     * @param w Enable limiting minimum size horizontally
7642     * @param h Enable limiting minimum size vertically
7643     *
7644     * By default the scroller will be as small as its design allows,
7645     * irrespective of its content. This will make the scroller minimum size the
7646     * right size horizontally and/or vertically to perfectly fit its content in
7647     * that direction.
7648     */
7649    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7650
7651    /**
7652     * @brief Show a specific virtual region within the scroller content object
7653     *
7654     * @param obj The scroller object
7655     * @param x X coordinate of the region
7656     * @param y Y coordinate of the region
7657     * @param w Width of the region
7658     * @param h Height of the region
7659     *
7660     * This will ensure all (or part if it does not fit) of the designated
7661     * region in the virtual content object (0, 0 starting at the top-left of the
7662     * virtual content object) is shown within the scroller.
7663     */
7664    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);
7665
7666    /**
7667     * @brief Set the scrollbar visibility policy
7668     *
7669     * @param obj The scroller object
7670     * @param policy_h Horizontal scrollbar policy
7671     * @param policy_v Vertical scrollbar policy
7672     *
7673     * This sets the scrollbar visibility policy for the given scroller.
7674     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7675     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7676     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7677     * respectively for the horizontal and vertical scrollbars.
7678     */
7679    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7680
7681    /**
7682     * @brief Gets scrollbar visibility policy
7683     *
7684     * @param obj The scroller object
7685     * @param policy_h Horizontal scrollbar policy
7686     * @param policy_v Vertical scrollbar policy
7687     *
7688     * @see elm_scroller_policy_set()
7689     */
7690    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7691
7692    /**
7693     * @brief Get the currently visible content region
7694     *
7695     * @param obj The scroller object
7696     * @param x X coordinate of the region
7697     * @param y Y coordinate of the region
7698     * @param w Width of the region
7699     * @param h Height of the region
7700     *
7701     * This gets the current region in the content object that is visible through
7702     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7703     * w, @p h values pointed to.
7704     *
7705     * @note All coordinates are relative to the content.
7706     *
7707     * @see elm_scroller_region_show()
7708     */
7709    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);
7710
7711    /**
7712     * @brief Get the size of the content object
7713     *
7714     * @param obj The scroller object
7715     * @param w Width of the content object.
7716     * @param h Height of the content object.
7717     *
7718     * This gets the size of the content object of the scroller.
7719     */
7720    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7721
7722    /**
7723     * @brief Set bouncing behavior
7724     *
7725     * @param obj The scroller object
7726     * @param h_bounce Allow bounce horizontally
7727     * @param v_bounce Allow bounce vertically
7728     *
7729     * When scrolling, the scroller may "bounce" when reaching an edge of the
7730     * content object. This is a visual way to indicate the end has been reached.
7731     * This is enabled by default for both axis. This API will set if it is enabled
7732     * for the given axis with the boolean parameters for each axis.
7733     */
7734    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7735
7736    /**
7737     * @brief Get the bounce behaviour
7738     *
7739     * @param obj The Scroller object
7740     * @param h_bounce Will the scroller bounce horizontally or not
7741     * @param v_bounce Will the scroller bounce vertically or not
7742     *
7743     * @see elm_scroller_bounce_set()
7744     */
7745    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7746
7747    /**
7748     * @brief Set scroll page size relative to viewport size.
7749     *
7750     * @param obj The scroller object
7751     * @param h_pagerel The horizontal page relative size
7752     * @param v_pagerel The vertical page relative size
7753     *
7754     * The scroller is capable of limiting scrolling by the user to "pages". That
7755     * is to jump by and only show a "whole page" at a time as if the continuous
7756     * area of the scroller content is split into page sized pieces. This sets
7757     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7758     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7759     * axis. This is mutually exclusive with page size
7760     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7761     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7762     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7763     * the other axis.
7764     */
7765    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7766
7767    /**
7768     * @brief Set scroll page size.
7769     *
7770     * @param obj The scroller object
7771     * @param h_pagesize The horizontal page size
7772     * @param v_pagesize The vertical page size
7773     *
7774     * This sets the page size to an absolute fixed value, with 0 turning it off
7775     * for that axis.
7776     *
7777     * @see elm_scroller_page_relative_set()
7778     */
7779    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7780
7781    /**
7782     * @brief Get scroll current page number.
7783     *
7784     * @param obj The scroller object
7785     * @param h_pagenumber The horizontal page number
7786     * @param v_pagenumber The vertical page number
7787     *
7788     * The page number starts from 0. 0 is the first page.
7789     * Current page means the page which meets the top-left of the viewport.
7790     * If there are two or more pages in the viewport, it returns the number of the page
7791     * which meets the top-left of the viewport.
7792     *
7793     * @see elm_scroller_last_page_get()
7794     * @see elm_scroller_page_show()
7795     * @see elm_scroller_page_brint_in()
7796     */
7797    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7798
7799    /**
7800     * @brief Get scroll last page number.
7801     *
7802     * @param obj The scroller object
7803     * @param h_pagenumber The horizontal page number
7804     * @param v_pagenumber The vertical page number
7805     *
7806     * The page number starts from 0. 0 is the first page.
7807     * This returns the last page number among the pages.
7808     *
7809     * @see elm_scroller_current_page_get()
7810     * @see elm_scroller_page_show()
7811     * @see elm_scroller_page_brint_in()
7812     */
7813    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7814
7815    /**
7816     * Show a specific virtual region within the scroller content object by page number.
7817     *
7818     * @param obj The scroller object
7819     * @param h_pagenumber The horizontal page number
7820     * @param v_pagenumber The vertical page number
7821     *
7822     * 0, 0 of the indicated page is located at the top-left of the viewport.
7823     * This will jump to the page directly without animation.
7824     *
7825     * Example of usage:
7826     *
7827     * @code
7828     * sc = elm_scroller_add(win);
7829     * elm_scroller_content_set(sc, content);
7830     * elm_scroller_page_relative_set(sc, 1, 0);
7831     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7832     * elm_scroller_page_show(sc, h_page + 1, v_page);
7833     * @endcode
7834     *
7835     * @see elm_scroller_page_bring_in()
7836     */
7837    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7838
7839    /**
7840     * Show a specific virtual region within the scroller content object by page number.
7841     *
7842     * @param obj The scroller object
7843     * @param h_pagenumber The horizontal page number
7844     * @param v_pagenumber The vertical page number
7845     *
7846     * 0, 0 of the indicated page is located at the top-left of the viewport.
7847     * This will slide to the page with animation.
7848     *
7849     * Example of usage:
7850     *
7851     * @code
7852     * sc = elm_scroller_add(win);
7853     * elm_scroller_content_set(sc, content);
7854     * elm_scroller_page_relative_set(sc, 1, 0);
7855     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7856     * elm_scroller_page_bring_in(sc, h_page, v_page);
7857     * @endcode
7858     *
7859     * @see elm_scroller_page_show()
7860     */
7861    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7862
7863    /**
7864     * @brief Show a specific virtual region within the scroller content object.
7865     *
7866     * @param obj The scroller object
7867     * @param x X coordinate of the region
7868     * @param y Y coordinate of the region
7869     * @param w Width of the region
7870     * @param h Height of the region
7871     *
7872     * This will ensure all (or part if it does not fit) of the designated
7873     * region in the virtual content object (0, 0 starting at the top-left of the
7874     * virtual content object) is shown within the scroller. Unlike
7875     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7876     * to this location (if configuration in general calls for transitions). It
7877     * may not jump immediately to the new location and make take a while and
7878     * show other content along the way.
7879     *
7880     * @see elm_scroller_region_show()
7881     */
7882    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);
7883
7884    /**
7885     * @brief Set event propagation on a scroller
7886     *
7887     * @param obj The scroller object
7888     * @param propagation If propagation is enabled or not
7889     *
7890     * This enables or disabled event propagation from the scroller content to
7891     * the scroller and its parent. By default event propagation is disabled.
7892     */
7893    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7894
7895    /**
7896     * @brief Get event propagation for a scroller
7897     *
7898     * @param obj The scroller object
7899     * @return The propagation state
7900     *
7901     * This gets the event propagation for a scroller.
7902     *
7903     * @see elm_scroller_propagate_events_set()
7904     */
7905    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7906
7907    /**
7908     * @brief Set scrolling gravity on a scroller
7909     *
7910     * @param obj The scroller object
7911     * @param x The scrolling horizontal gravity
7912     * @param y The scrolling vertical gravity
7913     *
7914     * The gravity, defines how the scroller will adjust its view
7915     * when the size of the scroller contents increase.
7916     *
7917     * The scroller will adjust the view to glue itself as follows.
7918     *
7919     *  x=0.0, for showing the left most region of the content.
7920     *  x=1.0, for showing the right most region of the content.
7921     *  y=0.0, for showing the bottom most region of the content.
7922     *  y=1.0, for showing the top most region of the content.
7923     *
7924     * Default values for x and y are 0.0
7925     */
7926    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7927
7928    /**
7929     * @brief Get scrolling gravity values for a scroller
7930     *
7931     * @param obj The scroller object
7932     * @param x The scrolling horizontal gravity
7933     * @param y The scrolling vertical gravity
7934     *
7935     * This gets gravity values for a scroller.
7936     *
7937     * @see elm_scroller_gravity_set()
7938     *
7939     */
7940    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7941
7942    /**
7943     * @}
7944     */
7945
7946    /**
7947     * @defgroup Label Label
7948     *
7949     * @image html img/widget/label/preview-00.png
7950     * @image latex img/widget/label/preview-00.eps
7951     *
7952     * @brief Widget to display text, with simple html-like markup.
7953     *
7954     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7955     * text doesn't fit the geometry of the label it will be ellipsized or be
7956     * cut. Elementary provides several styles for this widget:
7957     * @li default - No animation
7958     * @li marker - Centers the text in the label and make it bold by default
7959     * @li slide_long - The entire text appears from the right of the screen and
7960     * slides until it disappears in the left of the screen(reappering on the
7961     * right again).
7962     * @li slide_short - The text appears in the left of the label and slides to
7963     * the right to show the overflow. When all of the text has been shown the
7964     * position is reset.
7965     * @li slide_bounce - The text appears in the left of the label and slides to
7966     * the right to show the overflow. When all of the text has been shown the
7967     * animation reverses, moving the text to the left.
7968     *
7969     * Custom themes can of course invent new markup tags and style them any way
7970     * they like.
7971     *
7972     * The following signals may be emitted by the label widget:
7973     * @li "language,changed": The program's language changed.
7974     *
7975     * See @ref tutorial_label for a demonstration of how to use a label widget.
7976     * @{
7977     */
7978
7979    /**
7980     * @brief Add a new label to the parent
7981     *
7982     * @param parent The parent object
7983     * @return The new object or NULL if it cannot be created
7984     */
7985    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7986
7987    /**
7988     * @brief Set the label on the label object
7989     *
7990     * @param obj The label object
7991     * @param label The label will be used on the label object
7992     * @deprecated See elm_object_text_set()
7993     */
7994    EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7995
7996    /**
7997     * @brief Get the label used on the label object
7998     *
7999     * @param obj The label object
8000     * @return The string inside the label
8001     * @deprecated See elm_object_text_get()
8002     */
8003    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8004
8005    /**
8006     * @brief Set the wrapping behavior of the label
8007     *
8008     * @param obj The label object
8009     * @param wrap To wrap text or not
8010     *
8011     * By default no wrapping is done. Possible values for @p wrap are:
8012     * @li ELM_WRAP_NONE - No wrapping
8013     * @li ELM_WRAP_CHAR - wrap between characters
8014     * @li ELM_WRAP_WORD - wrap between words
8015     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
8016     */
8017    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8018
8019    /**
8020     * @brief Get the wrapping behavior of the label
8021     *
8022     * @param obj The label object
8023     * @return Wrap type
8024     *
8025     * @see elm_label_line_wrap_set()
8026     */
8027    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8028
8029    /**
8030     * @brief Set wrap width of the label
8031     *
8032     * @param obj The label object
8033     * @param w The wrap width in pixels at a minimum where words need to wrap
8034     *
8035     * This function sets the maximum width size hint of the label.
8036     *
8037     * @warning This is only relevant if the label is inside a container.
8038     */
8039    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
8040
8041    /**
8042     * @brief Get wrap width of the label
8043     *
8044     * @param obj The label object
8045     * @return The wrap width in pixels at a minimum where words need to wrap
8046     *
8047     * @see elm_label_wrap_width_set()
8048     */
8049    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8050
8051    /**
8052     * @brief Set wrap height of the label
8053     *
8054     * @param obj The label object
8055     * @param h The wrap height in pixels at a minimum where words need to wrap
8056     *
8057     * This function sets the maximum height size hint of the label.
8058     *
8059     * @warning This is only relevant if the label is inside a container.
8060     */
8061    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
8062
8063    /**
8064     * @brief get wrap width of the label
8065     *
8066     * @param obj The label object
8067     * @return The wrap height in pixels at a minimum where words need to wrap
8068     */
8069    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8070
8071    /**
8072     * @brief Set the font size on the label object.
8073     *
8074     * @param obj The label object
8075     * @param size font size
8076     *
8077     * @warning NEVER use this. It is for hyper-special cases only. use styles
8078     * instead. e.g. "default", "marker", "slide_long" etc.
8079     */
8080    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
8081
8082    /**
8083     * @brief Set the text color on the label object
8084     *
8085     * @param obj The label object
8086     * @param r Red property background color of The label object
8087     * @param g Green property background color of The label object
8088     * @param b Blue property background color of The label object
8089     * @param a Alpha property background color of The label object
8090     *
8091     * @warning NEVER use this. It is for hyper-special cases only. use styles
8092     * instead. e.g. "default", "marker", "slide_long" etc.
8093     */
8094    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);
8095
8096    /**
8097     * @brief Set the text align on the label object
8098     *
8099     * @param obj The label object
8100     * @param align align mode ("left", "center", "right")
8101     *
8102     * @warning NEVER use this. It is for hyper-special cases only. use styles
8103     * instead. e.g. "default", "marker", "slide_long" etc.
8104     */
8105    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
8106
8107    /**
8108     * @brief Set background color of the label
8109     *
8110     * @param obj The label object
8111     * @param r Red property background color of The label object
8112     * @param g Green property background color of The label object
8113     * @param b Blue property background color of The label object
8114     * @param a Alpha property background alpha of The label object
8115     *
8116     * @warning NEVER use this. It is for hyper-special cases only. use styles
8117     * instead. e.g. "default", "marker", "slide_long" etc.
8118     */
8119    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);
8120
8121    /**
8122     * @brief Set the ellipsis behavior of the label
8123     *
8124     * @param obj The label object
8125     * @param ellipsis To ellipsis text or not
8126     *
8127     * If set to true and the text doesn't fit in the label an ellipsis("...")
8128     * will be shown at the end of the widget.
8129     *
8130     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
8131     * choosen wrap method was ELM_WRAP_WORD.
8132     */
8133    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
8134
8135    /**
8136     * @brief Set the text slide of the label
8137     *
8138     * @param obj The label object
8139     * @param slide To start slide or stop
8140     *
8141     * If set to true, the text of the label will slide/scroll through the length of
8142     * label.
8143     *
8144     * @warning This only works with the themes "slide_short", "slide_long" and
8145     * "slide_bounce".
8146     */
8147    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
8148
8149    /**
8150     * @brief Get the text slide mode of the label
8151     *
8152     * @param obj The label object
8153     * @return slide slide mode value
8154     *
8155     * @see elm_label_slide_set()
8156     */
8157    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8158
8159    /**
8160     * @brief Set the slide duration(speed) of the label
8161     *
8162     * @param obj The label object
8163     * @return The duration in seconds in moving text from slide begin position
8164     * to slide end position
8165     */
8166    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
8167
8168    /**
8169     * @brief Get the slide duration(speed) of the label
8170     *
8171     * @param obj The label object
8172     * @return The duration time in moving text from slide begin position to slide end position
8173     *
8174     * @see elm_label_slide_duration_set()
8175     */
8176    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
8177
8178    /**
8179     * @}
8180     */
8181
8182    /**
8183     * @defgroup Toggle Toggle
8184     *
8185     * @image html img/widget/toggle/preview-00.png
8186     * @image latex img/widget/toggle/preview-00.eps
8187     *
8188     * @brief A toggle is a slider which can be used to toggle between
8189     * two values.  It has two states: on and off.
8190     *
8191     * This widget is deprecated. Please use elm_check_add() instead using the
8192     * toggle style like:
8193     *
8194     * @code
8195     * obj = elm_check_add(parent);
8196     * elm_object_style_set(obj, "toggle");
8197     * elm_object_part_text_set(obj, "on", "ON");
8198     * elm_object_part_text_set(obj, "off", "OFF");
8199     * @endcode
8200     *
8201     * Signals that you can add callbacks for are:
8202     * @li "changed" - Whenever the toggle value has been changed.  Is not called
8203     *                 until the toggle is released by the cursor (assuming it
8204     *                 has been triggered by the cursor in the first place).
8205     *
8206     * Default contents parts of the toggle widget that you can use for are:
8207     * @li "icon" - An icon of the toggle
8208     *
8209     * Default text parts of the toggle widget that you can use for are:
8210     * @li "elm.text" - Label of the toggle
8211     *
8212     * @ref tutorial_toggle show how to use a toggle.
8213     * @{
8214     */
8215
8216    /**
8217     * @brief Add a toggle to @p parent.
8218     *
8219     * @param parent The parent object
8220     *
8221     * @return The toggle object
8222     */
8223    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8224
8225    /**
8226     * @brief Sets the label to be displayed with the toggle.
8227     *
8228     * @param obj The toggle object
8229     * @param label The label to be displayed
8230     *
8231     * @deprecated use elm_object_text_set() instead.
8232     */
8233    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8234
8235    /**
8236     * @brief Gets the label of the toggle
8237     *
8238     * @param obj  toggle object
8239     * @return The label of the toggle
8240     *
8241     * @deprecated use elm_object_text_get() instead.
8242     */
8243    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8244
8245    /**
8246     * @brief Set the icon used for the toggle
8247     *
8248     * @param obj The toggle object
8249     * @param icon The icon object for the button
8250     *
8251     * Once the icon object is set, a previously set one will be deleted
8252     * If you want to keep that old content object, use the
8253     * elm_toggle_icon_unset() function.
8254     *
8255     * @deprecated use elm_object_part_content_set() instead.
8256     */
8257    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8258
8259    /**
8260     * @brief Get the icon used for the toggle
8261     *
8262     * @param obj The toggle object
8263     * @return The icon object that is being used
8264     *
8265     * Return the icon object which is set for this widget.
8266     *
8267     * @see elm_toggle_icon_set()
8268     *
8269     * @deprecated use elm_object_part_content_get() instead.
8270     */
8271    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8272
8273    /**
8274     * @brief Unset the icon used for the toggle
8275     *
8276     * @param obj The toggle object
8277     * @return The icon object that was being used
8278     *
8279     * Unparent and return the icon object which was set for this widget.
8280     *
8281     * @see elm_toggle_icon_set()
8282     *
8283     * @deprecated use elm_object_part_content_unset() instead.
8284     */
8285    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8286
8287    /**
8288     * @brief Sets the labels to be associated with the on and off states of the toggle.
8289     *
8290     * @param obj The toggle object
8291     * @param onlabel The label displayed when the toggle is in the "on" state
8292     * @param offlabel The label displayed when the toggle is in the "off" state
8293     *
8294     * @deprecated use elm_object_part_text_set() for "on" and "off" parts
8295     * instead.
8296     */
8297    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
8298
8299    /**
8300     * @brief Gets the labels associated with the on and off states of the
8301     * toggle.
8302     *
8303     * @param obj The toggle object
8304     * @param onlabel A char** to place the onlabel of @p obj into
8305     * @param offlabel A char** to place the offlabel of @p obj into
8306     *
8307     * @deprecated use elm_object_part_text_get() for "on" and "off" parts
8308     * instead.
8309     */
8310    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
8311
8312    /**
8313     * @brief Sets the state of the toggle to @p state.
8314     *
8315     * @param obj The toggle object
8316     * @param state The state of @p obj
8317     *
8318     * @deprecated use elm_check_state_set() instead.
8319     */
8320    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
8321
8322    /**
8323     * @brief Gets the state of the toggle to @p state.
8324     *
8325     * @param obj The toggle object
8326     * @return The state of @p obj
8327     *
8328     * @deprecated use elm_check_state_get() instead.
8329     */
8330    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8331
8332    /**
8333     * @brief Sets the state pointer of the toggle to @p statep.
8334     *
8335     * @param obj The toggle object
8336     * @param statep The state pointer of @p obj
8337     *
8338     * @deprecated use elm_check_state_pointer_set() instead.
8339     */
8340    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
8341
8342    /**
8343     * @}
8344     */
8345
8346    /**
8347     * @defgroup Frame Frame
8348     *
8349     * @image html img/widget/frame/preview-00.png
8350     * @image latex img/widget/frame/preview-00.eps
8351     *
8352     * @brief Frame is a widget that holds some content and has a title.
8353     *
8354     * The default look is a frame with a title, but Frame supports multple
8355     * styles:
8356     * @li default
8357     * @li pad_small
8358     * @li pad_medium
8359     * @li pad_large
8360     * @li pad_huge
8361     * @li outdent_top
8362     * @li outdent_bottom
8363     *
8364     * Of all this styles only default shows the title. Frame emits no signals.
8365     *
8366     * Default contents parts of the frame widget that you can use for are:
8367     * @li "default" - A content of the frame
8368     *
8369     * Default text parts of the frame widget that you can use for are:
8370     * @li "elm.text" - Label of the frame
8371     *
8372     * For a detailed example see the @ref tutorial_frame.
8373     *
8374     * @{
8375     */
8376
8377    /**
8378     * @brief Add a new frame to the parent
8379     *
8380     * @param parent The parent object
8381     * @return The new object or NULL if it cannot be created
8382     */
8383    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8384
8385    /**
8386     * @brief Set the frame label
8387     *
8388     * @param obj The frame object
8389     * @param label The label of this frame object
8390     *
8391     * @deprecated use elm_object_text_set() instead.
8392     */
8393    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8394
8395    /**
8396     * @brief Get the frame label
8397     *
8398     * @param obj The frame object
8399     *
8400     * @return The label of this frame objet or NULL if unable to get frame
8401     *
8402     * @deprecated use elm_object_text_get() instead.
8403     */
8404    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8405
8406    /**
8407     * @brief Set the content of the frame widget
8408     *
8409     * Once the content object is set, a previously set one will be deleted.
8410     * If you want to keep that old content object, use the
8411     * elm_frame_content_unset() function.
8412     *
8413     * @param obj The frame object
8414     * @param content The content will be filled in this frame object
8415     *
8416     * @deprecated use elm_object_content_set() instead.
8417     */
8418    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8419
8420    /**
8421     * @brief Get the content of the frame widget
8422     *
8423     * Return the content object which is set for this widget
8424     *
8425     * @param obj The frame object
8426     * @return The content that is being used
8427     *
8428     * @deprecated use elm_object_content_get() instead.
8429     */
8430    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8431
8432    /**
8433     * @brief Unset the content of the frame widget
8434     *
8435     * Unparent and return the content object which was set for this widget
8436     *
8437     * @param obj The frame object
8438     * @return The content that was being used
8439     *
8440     * @deprecated use elm_object_content_unset() instead.
8441     */
8442    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8443
8444    /**
8445     * @}
8446     */
8447
8448    /**
8449     * @defgroup Table Table
8450     *
8451     * A container widget to arrange other widgets in a table where items can
8452     * also span multiple columns or rows - even overlap (and then be raised or
8453     * lowered accordingly to adjust stacking if they do overlap).
8454     *
8455     * For a Table widget the row/column count is not fixed.
8456     * The table widget adjusts itself when subobjects are added to it dynamically.
8457     *
8458     * The followin are examples of how to use a table:
8459     * @li @ref tutorial_table_01
8460     * @li @ref tutorial_table_02
8461     *
8462     * @{
8463     */
8464
8465    /**
8466     * @brief Add a new table to the parent
8467     *
8468     * @param parent The parent object
8469     * @return The new object or NULL if it cannot be created
8470     */
8471    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8472
8473    /**
8474     * @brief Set the homogeneous layout in the table
8475     *
8476     * @param obj The layout object
8477     * @param homogeneous A boolean to set if the layout is homogeneous in the
8478     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8479     */
8480    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8481
8482    /**
8483     * @brief Get the current table homogeneous mode.
8484     *
8485     * @param obj The table object
8486     * @return A boolean to indicating if the layout is homogeneous in the table
8487     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8488     */
8489    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8490
8491    /**
8492     * @brief Set padding between cells.
8493     *
8494     * @param obj The layout object.
8495     * @param horizontal set the horizontal padding.
8496     * @param vertical set the vertical padding.
8497     *
8498     * Default value is 0.
8499     */
8500    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8501
8502    /**
8503     * @brief Get padding between cells.
8504     *
8505     * @param obj The layout object.
8506     * @param horizontal set the horizontal padding.
8507     * @param vertical set the vertical padding.
8508     */
8509    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8510
8511    /**
8512     * @brief Add a subobject on the table with the coordinates passed
8513     *
8514     * @param obj The table object
8515     * @param subobj The subobject to be added to the table
8516     * @param x Row number
8517     * @param y Column number
8518     * @param w rowspan
8519     * @param h colspan
8520     *
8521     * @note All positioning inside the table is relative to rows and columns, so
8522     * a value of 0 for x and y, means the top left cell of the table, and a
8523     * value of 1 for w and h means @p subobj only takes that 1 cell.
8524     */
8525    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8526
8527    /**
8528     * @brief Remove child from table.
8529     *
8530     * @param obj The table object
8531     * @param subobj The subobject
8532     */
8533    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8534
8535    /**
8536     * @brief Faster way to remove all child objects from a table object.
8537     *
8538     * @param obj The table object
8539     * @param clear If true, will delete children, else just remove from table.
8540     */
8541    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8542
8543    /**
8544     * @brief Set the packing location of an existing child of the table
8545     *
8546     * @param subobj The subobject to be modified in the table
8547     * @param x Row number
8548     * @param y Column number
8549     * @param w rowspan
8550     * @param h colspan
8551     *
8552     * Modifies the position of an object already in the table.
8553     *
8554     * @note All positioning inside the table is relative to rows and columns, so
8555     * a value of 0 for x and y, means the top left cell of the table, and a
8556     * value of 1 for w and h means @p subobj only takes that 1 cell.
8557     */
8558    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8559
8560    /**
8561     * @brief Get the packing location of an existing child of the table
8562     *
8563     * @param subobj The subobject to be modified in the table
8564     * @param x Row number
8565     * @param y Column number
8566     * @param w rowspan
8567     * @param h colspan
8568     *
8569     * @see elm_table_pack_set()
8570     */
8571    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8572
8573    /**
8574     * @}
8575     */
8576
8577    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
8578    typedef struct Elm_Gen_Item Elm_Gen_Item;
8579    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
8580    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
8581    typedef char        *(*Elm_Gen_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
8582    typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
8583    typedef Eina_Bool    (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
8584    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
8585    struct _Elm_Gen_Item_Class
8586      {
8587         const char             *item_style;
8588         struct _Elm_Gen_Item_Class_Func
8589           {
8590              Elm_Gen_Item_Text_Get_Cb  text_get;
8591              Elm_Gen_Item_Content_Get_Cb  content_get;
8592              Elm_Gen_Item_State_Get_Cb state_get;
8593              Elm_Gen_Item_Del_Cb       del;
8594           } func;
8595      };
8596    EINA_DEPRECATED EAPI void elm_gen_clear(Evas_Object *obj);
8597    EINA_DEPRECATED EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
8598    EINA_DEPRECATED EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
8599    EINA_DEPRECATED EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
8600    EINA_DEPRECATED EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
8601    EINA_DEPRECATED EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
8602    EINA_DEPRECATED EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
8603    EINA_DEPRECATED EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
8604    EINA_DEPRECATED EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
8605    EINA_DEPRECATED EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
8606    EINA_DEPRECATED EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
8607
8608    EINA_DEPRECATED EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
8609    EINA_DEPRECATED EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8610    EINA_DEPRECATED EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8611    EINA_DEPRECATED EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8612    EINA_DEPRECATED EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8613    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8614    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8615    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8616    EINA_DEPRECATED EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8617    EINA_DEPRECATED EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8618
8619    /**
8620     * @defgroup Gengrid Gengrid (Generic grid)
8621     *
8622     * This widget aims to position objects in a grid layout while
8623     * actually creating and rendering only the visible ones, using the
8624     * same idea as the @ref Genlist "genlist": the user defines a @b
8625     * class for each item, specifying functions that will be called at
8626     * object creation, deletion, etc. When those items are selected by
8627     * the user, a callback function is issued. Users may interact with
8628     * a gengrid via the mouse (by clicking on items to select them and
8629     * clicking on the grid's viewport and swiping to pan the whole
8630     * view) or via the keyboard, navigating through item with the
8631     * arrow keys.
8632     *
8633     * @section Gengrid_Layouts Gengrid layouts
8634     *
8635     * Gengrid may layout its items in one of two possible layouts:
8636     * - horizontal or
8637     * - vertical.
8638     *
8639     * When in "horizontal mode", items will be placed in @b columns,
8640     * from top to bottom and, when the space for a column is filled,
8641     * another one is started on the right, thus expanding the grid
8642     * horizontally, making for horizontal scrolling. When in "vertical
8643     * mode" , though, items will be placed in @b rows, from left to
8644     * right and, when the space for a row is filled, another one is
8645     * started below, thus expanding the grid vertically (and making
8646     * for vertical scrolling).
8647     *
8648     * @section Gengrid_Items Gengrid items
8649     *
8650     * An item in a gengrid can have 0 or more texts (they can be
8651     * regular text or textblock Evas objects - that's up to the style
8652     * to determine), 0 or more contents (which are simply objects
8653     * swallowed into the gengrid item's theming Edje object) and 0 or
8654     * more <b>boolean states</b>, which have the behavior left to the
8655     * user to define. The Edje part names for each of these properties
8656     * will be looked up, in the theme file for the gengrid, under the
8657     * Edje (string) data items named @c "texts", @c "contents" and @c
8658     * "states", respectively. For each of those properties, if more
8659     * than one part is provided, they must have names listed separated
8660     * by spaces in the data fields. For the default gengrid item
8661     * theme, we have @b one text part (@c "elm.text"), @b two content 
8662     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8663     * no state parts.
8664     *
8665     * A gengrid item may be at one of several styles. Elementary
8666     * provides one by default - "default", but this can be extended by
8667     * system or application custom themes/overlays/extensions (see
8668     * @ref Theme "themes" for more details).
8669     *
8670     * @section Gengrid_Item_Class Gengrid item classes
8671     *
8672     * In order to have the ability to add and delete items on the fly,
8673     * gengrid implements a class (callback) system where the
8674     * application provides a structure with information about that
8675     * type of item (gengrid may contain multiple different items with
8676     * different classes, states and styles). Gengrid will call the
8677     * functions in this struct (methods) when an item is "realized"
8678     * (i.e., created dynamically, while the user is scrolling the
8679     * grid). All objects will simply be deleted when no longer needed
8680     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8681     * contains the following members:
8682     * - @c item_style - This is a constant string and simply defines
8683     * the name of the item style. It @b must be specified and the
8684     * default should be @c "default".
8685     * - @c func.text_get - This function is called when an item
8686     * object is actually created. The @c data parameter will point to
8687     * the same data passed to elm_gengrid_item_append() and related
8688     * item creation functions. The @c obj parameter is the gengrid
8689     * object itself, while the @c part one is the name string of one
8690     * of the existing text parts in the Edje group implementing the
8691     * item's theme. This function @b must return a strdup'()ed string,
8692     * as the caller will free() it when done. See
8693     * #Elm_Gengrid_Item_Text_Get_Cb.
8694     * - @c func.content_get - This function is called when an item object
8695     * is actually created. The @c data parameter will point to the
8696     * same data passed to elm_gengrid_item_append() and related item
8697     * creation functions. The @c obj parameter is the gengrid object
8698     * itself, while the @c part one is the name string of one of the
8699     * existing (content) swallow parts in the Edje group implementing the
8700     * item's theme. It must return @c NULL, when no content is desired,
8701     * or a valid object handle, otherwise. The object will be deleted
8702     * by the gengrid on its deletion or when the item is "unrealized".
8703     * See #Elm_Gengrid_Item_Content_Get_Cb.
8704     * - @c func.state_get - This function is called when an item
8705     * object is actually created. The @c data parameter will point to
8706     * the same data passed to elm_gengrid_item_append() and related
8707     * item creation functions. The @c obj parameter is the gengrid
8708     * object itself, while the @c part one is the name string of one
8709     * of the state parts in the Edje group implementing the item's
8710     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8711     * true/on. Gengrids will emit a signal to its theming Edje object
8712     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8713     * "source" arguments, respectively, when the state is true (the
8714     * default is false), where @c XXX is the name of the (state) part.
8715     * See #Elm_Gengrid_Item_State_Get_Cb.
8716     * - @c func.del - This is called when elm_gengrid_item_del() is
8717     * called on an item or elm_gengrid_clear() is called on the
8718     * gengrid. This is intended for use when gengrid items are
8719     * deleted, so any data attached to the item (e.g. its data
8720     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8721     *
8722     * @section Gengrid_Usage_Hints Usage hints
8723     *
8724     * If the user wants to have multiple items selected at the same
8725     * time, elm_gengrid_multi_select_set() will permit it. If the
8726     * gengrid is single-selection only (the default), then
8727     * elm_gengrid_select_item_get() will return the selected item or
8728     * @c NULL, if none is selected. If the gengrid is under
8729     * multi-selection, then elm_gengrid_selected_items_get() will
8730     * return a list (that is only valid as long as no items are
8731     * modified (added, deleted, selected or unselected) of child items
8732     * on a gengrid.
8733     *
8734     * If an item changes (internal (boolean) state, text or content
8735     * changes), then use elm_gengrid_item_update() to have gengrid
8736     * update the item with the new state. A gengrid will re-"realize"
8737     * the item, thus calling the functions in the
8738     * #Elm_Gengrid_Item_Class set for that item.
8739     *
8740     * To programmatically (un)select an item, use
8741     * elm_gengrid_item_selected_set(). To get its selected state use
8742     * elm_gengrid_item_selected_get(). To make an item disabled
8743     * (unable to be selected and appear differently) use
8744     * elm_gengrid_item_disabled_set() to set this and
8745     * elm_gengrid_item_disabled_get() to get the disabled state.
8746     *
8747     * Grid cells will only have their selection smart callbacks called
8748     * when firstly getting selected. Any further clicks will do
8749     * nothing, unless you enable the "always select mode", with
8750     * elm_gengrid_always_select_mode_set(), thus making every click to
8751     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8752     * turn off the ability to select items entirely in the widget and
8753     * they will neither appear selected nor call the selection smart
8754     * callbacks.
8755     *
8756     * Remember that you can create new styles and add your own theme
8757     * augmentation per application with elm_theme_extension_add(). If
8758     * you absolutely must have a specific style that overrides any
8759     * theme the user or system sets up you can use
8760     * elm_theme_overlay_add() to add such a file.
8761     *
8762     * @section Gengrid_Smart_Events Gengrid smart events
8763     *
8764     * Smart events that you can add callbacks for are:
8765     * - @c "activated" - The user has double-clicked or pressed
8766     *   (enter|return|spacebar) on an item. The @c event_info parameter
8767     *   is the gengrid item that was activated.
8768     * - @c "clicked,double" - The user has double-clicked an item.
8769     *   The @c event_info parameter is the gengrid item that was double-clicked.
8770     * - @c "longpressed" - This is called when the item is pressed for a certain
8771     *   amount of time. By default it's 1 second.
8772     * - @c "selected" - The user has made an item selected. The
8773     *   @c event_info parameter is the gengrid item that was selected.
8774     * - @c "unselected" - The user has made an item unselected. The
8775     *   @c event_info parameter is the gengrid item that was unselected.
8776     * - @c "realized" - This is called when the item in the gengrid
8777     *   has its implementing Evas object instantiated, de facto. @c
8778     *   event_info is the gengrid item that was created. The object
8779     *   may be deleted at any time, so it is highly advised to the
8780     *   caller @b not to use the object pointer returned from
8781     *   elm_gengrid_item_object_get(), because it may point to freed
8782     *   objects.
8783     * - @c "unrealized" - This is called when the implementing Evas
8784     *   object for this item is deleted. @c event_info is the gengrid
8785     *   item that was deleted.
8786     * - @c "changed" - Called when an item is added, removed, resized
8787     *   or moved and when the gengrid is resized or gets "horizontal"
8788     *   property changes.
8789     * - @c "scroll,anim,start" - This is called when scrolling animation has
8790     *   started.
8791     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8792     *   stopped.
8793     * - @c "drag,start,up" - Called when the item in the gengrid has
8794     *   been dragged (not scrolled) up.
8795     * - @c "drag,start,down" - Called when the item in the gengrid has
8796     *   been dragged (not scrolled) down.
8797     * - @c "drag,start,left" - Called when the item in the gengrid has
8798     *   been dragged (not scrolled) left.
8799     * - @c "drag,start,right" - Called when the item in the gengrid has
8800     *   been dragged (not scrolled) right.
8801     * - @c "drag,stop" - Called when the item in the gengrid has
8802     *   stopped being dragged.
8803     * - @c "drag" - Called when the item in the gengrid is being
8804     *   dragged.
8805     * - @c "scroll" - called when the content has been scrolled
8806     *   (moved).
8807     * - @c "scroll,drag,start" - called when dragging the content has
8808     *   started.
8809     * - @c "scroll,drag,stop" - called when dragging the content has
8810     *   stopped.
8811     * - @c "edge,top" - This is called when the gengrid is scrolled until
8812     *   the top edge.
8813     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8814     *   until the bottom edge.
8815     * - @c "edge,left" - This is called when the gengrid is scrolled
8816     *   until the left edge.
8817     * - @c "edge,right" - This is called when the gengrid is scrolled
8818     *   until the right edge.
8819     *
8820     * List of gengrid examples:
8821     * @li @ref gengrid_example
8822     */
8823
8824    /**
8825     * @addtogroup Gengrid
8826     * @{
8827     */
8828
8829    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8830    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8831    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8832    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8833    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8834
8835    /**
8836     * Text fetching class function for Elm_Gen_Item_Class.
8837     * @param data The data passed in the item creation function
8838     * @param obj The base widget object
8839     * @param part The part name of the swallow
8840     * @return The allocated (NOT stringshared) string to set as the text 
8841     */
8842    typedef char        *(*Elm_Gengrid_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8843
8844    /**
8845     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8846     * @param data The data passed in the item creation function
8847     * @param obj The base widget object
8848     * @param part The part name of the swallow
8849     * @return The content object to swallow
8850     */
8851    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8852
8853    /**
8854     * State fetching class function for Elm_Gen_Item_Class.
8855     * @param data The data passed in the item creation function
8856     * @param obj The base widget object
8857     * @param part The part name of the swallow
8858     * @return The hell if I know
8859     */
8860    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8861
8862    /**
8863     * Deletion class function for Elm_Gen_Item_Class.
8864     * @param data The data passed in the item creation function
8865     * @param obj The base widget object
8866     */
8867    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8868
8869    /**
8870     * @struct _Elm_Gengrid_Item_Class
8871     *
8872     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8873     * field details.
8874     */
8875    struct _Elm_Gengrid_Item_Class
8876      {
8877         const char             *item_style;
8878         struct _Elm_Gengrid_Item_Class_Func
8879           {
8880              Elm_Gengrid_Item_Text_Get_Cb    text_get; /**< Text fetching class function for gengrid item classes.*/
8881              Elm_Gengrid_Item_Content_Get_Cb content_get; /**< Content fetching class function for gengrid item classes. */
8882              Elm_Gengrid_Item_State_Get_Cb   state_get; /**< State fetching class function for gengrid item classes. */
8883              Elm_Gengrid_Item_Del_Cb         del; /**< Deletion class function for gengrid item classes. */
8884           } func;
8885      }; /**< #Elm_Gengrid_Item_Class member definitions */
8886    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8887
8888    /**
8889     * Add a new gengrid widget to the given parent Elementary
8890     * (container) object
8891     *
8892     * @param parent The parent object
8893     * @return a new gengrid widget handle or @c NULL, on errors
8894     *
8895     * This function inserts a new gengrid widget on the canvas.
8896     *
8897     * @see elm_gengrid_item_size_set()
8898     * @see elm_gengrid_group_item_size_set()
8899     * @see elm_gengrid_horizontal_set()
8900     * @see elm_gengrid_item_append()
8901     * @see elm_gengrid_item_del()
8902     * @see elm_gengrid_clear()
8903     *
8904     * @ingroup Gengrid
8905     */
8906    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8907
8908    /**
8909     * Set the size for the items of a given gengrid widget
8910     *
8911     * @param obj The gengrid object.
8912     * @param w The items' width.
8913     * @param h The items' height;
8914     *
8915     * A gengrid, after creation, has still no information on the size
8916     * to give to each of its cells. So, you most probably will end up
8917     * with squares one @ref Fingers "finger" wide, the default
8918     * size. Use this function to force a custom size for you items,
8919     * making them as big as you wish.
8920     *
8921     * @see elm_gengrid_item_size_get()
8922     *
8923     * @ingroup Gengrid
8924     */
8925    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8926
8927    /**
8928     * Get the size set for the items of a given gengrid widget
8929     *
8930     * @param obj The gengrid object.
8931     * @param w Pointer to a variable where to store the items' width.
8932     * @param h Pointer to a variable where to store the items' height.
8933     *
8934     * @note Use @c NULL pointers on the size values you're not
8935     * interested in: they'll be ignored by the function.
8936     *
8937     * @see elm_gengrid_item_size_get() for more details
8938     *
8939     * @ingroup Gengrid
8940     */
8941    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8942
8943    /**
8944     * Set the size for the group items of a given gengrid widget
8945     *
8946     * @param obj The gengrid object.
8947     * @param w The group items' width.
8948     * @param h The group items' height;
8949     *
8950     * A gengrid, after creation, has still no information on the size
8951     * to give to each of its cells. So, you most probably will end up
8952     * with squares one @ref Fingers "finger" wide, the default
8953     * size. Use this function to force a custom size for you group items,
8954     * making them as big as you wish.
8955     *
8956     * @see elm_gengrid_group_item_size_get()
8957     *
8958     * @ingroup Gengrid
8959     */
8960    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8961
8962    /**
8963     * Get the size set for the group items of a given gengrid widget
8964     *
8965     * @param obj The gengrid object.
8966     * @param w Pointer to a variable where to store the group items' width.
8967     * @param h Pointer to a variable where to store the group items' height.
8968     *
8969     * @note Use @c NULL pointers on the size values you're not
8970     * interested in: they'll be ignored by the function.
8971     *
8972     * @see elm_gengrid_group_item_size_get() for more details
8973     *
8974     * @ingroup Gengrid
8975     */
8976    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8977
8978    /**
8979     * Set the items grid's alignment within a given gengrid widget
8980     *
8981     * @param obj The gengrid object.
8982     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8983     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8984     *
8985     * This sets the alignment of the whole grid of items of a gengrid
8986     * within its given viewport. By default, those values are both
8987     * 0.5, meaning that the gengrid will have its items grid placed
8988     * exactly in the middle of its viewport.
8989     *
8990     * @note If given alignment values are out of the cited ranges,
8991     * they'll be changed to the nearest boundary values on the valid
8992     * ranges.
8993     *
8994     * @see elm_gengrid_align_get()
8995     *
8996     * @ingroup Gengrid
8997     */
8998    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8999
9000    /**
9001     * Get the items grid's alignment values within a given gengrid
9002     * widget
9003     *
9004     * @param obj The gengrid object.
9005     * @param align_x Pointer to a variable where to store the
9006     * horizontal alignment.
9007     * @param align_y Pointer to a variable where to store the vertical
9008     * alignment.
9009     *
9010     * @note Use @c NULL pointers on the alignment values you're not
9011     * interested in: they'll be ignored by the function.
9012     *
9013     * @see elm_gengrid_align_set() for more details
9014     *
9015     * @ingroup Gengrid
9016     */
9017    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
9018
9019    /**
9020     * Set whether a given gengrid widget is or not able have items
9021     * @b reordered
9022     *
9023     * @param obj The gengrid object
9024     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
9025     * @c EINA_FALSE to turn it off
9026     *
9027     * If a gengrid is set to allow reordering, a click held for more
9028     * than 0.5 over a given item will highlight it specially,
9029     * signalling the gengrid has entered the reordering state. From
9030     * that time on, the user will be able to, while still holding the
9031     * mouse button down, move the item freely in the gengrid's
9032     * viewport, replacing to said item to the locations it goes to.
9033     * The replacements will be animated and, whenever the user
9034     * releases the mouse button, the item being replaced gets a new
9035     * definitive place in the grid.
9036     *
9037     * @see elm_gengrid_reorder_mode_get()
9038     *
9039     * @ingroup Gengrid
9040     */
9041    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
9042
9043    /**
9044     * Get whether a given gengrid widget is or not able have items
9045     * @b reordered
9046     *
9047     * @param obj The gengrid object
9048     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
9049     * off
9050     *
9051     * @see elm_gengrid_reorder_mode_set() for more details
9052     *
9053     * @ingroup Gengrid
9054     */
9055    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9056
9057    /**
9058     * Append a new item in a given gengrid widget.
9059     *
9060     * @param obj The gengrid object.
9061     * @param gic The item class for the item.
9062     * @param data The item data.
9063     * @param func Convenience function called when the item is
9064     * selected.
9065     * @param func_data Data to be passed to @p func.
9066     * @return A handle to the item added or @c NULL, on errors.
9067     *
9068     * This adds an item to the beginning of the gengrid.
9069     *
9070     * @see elm_gengrid_item_prepend()
9071     * @see elm_gengrid_item_insert_before()
9072     * @see elm_gengrid_item_insert_after()
9073     * @see elm_gengrid_item_del()
9074     *
9075     * @ingroup Gengrid
9076     */
9077    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);
9078
9079    /**
9080     * Prepend a new item in a given gengrid widget.
9081     *
9082     * @param obj The gengrid object.
9083     * @param gic The item class for the item.
9084     * @param data The item data.
9085     * @param func Convenience function called when the item is
9086     * selected.
9087     * @param func_data Data to be passed to @p func.
9088     * @return A handle to the item added or @c NULL, on errors.
9089     *
9090     * This adds an item to the end of the gengrid.
9091     *
9092     * @see elm_gengrid_item_append()
9093     * @see elm_gengrid_item_insert_before()
9094     * @see elm_gengrid_item_insert_after()
9095     * @see elm_gengrid_item_del()
9096     *
9097     * @ingroup Gengrid
9098     */
9099    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);
9100
9101    /**
9102     * Insert an item before another in a gengrid widget
9103     *
9104     * @param obj The gengrid object.
9105     * @param gic The item class for the item.
9106     * @param data The item data.
9107     * @param relative The item to place this new one before.
9108     * @param func Convenience function called when the item is
9109     * selected.
9110     * @param func_data Data to be passed to @p func.
9111     * @return A handle to the item added or @c NULL, on errors.
9112     *
9113     * This inserts an item before another in the gengrid.
9114     *
9115     * @see elm_gengrid_item_append()
9116     * @see elm_gengrid_item_prepend()
9117     * @see elm_gengrid_item_insert_after()
9118     * @see elm_gengrid_item_del()
9119     *
9120     * @ingroup Gengrid
9121     */
9122    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);
9123
9124    /**
9125     * Insert an item after another in a gengrid widget
9126     *
9127     * @param obj The gengrid object.
9128     * @param gic The item class for the item.
9129     * @param data The item data.
9130     * @param relative The item to place this new one after.
9131     * @param func Convenience function called when the item is
9132     * selected.
9133     * @param func_data Data to be passed to @p func.
9134     * @return A handle to the item added or @c NULL, on errors.
9135     *
9136     * This inserts an item after another in the gengrid.
9137     *
9138     * @see elm_gengrid_item_append()
9139     * @see elm_gengrid_item_prepend()
9140     * @see elm_gengrid_item_insert_after()
9141     * @see elm_gengrid_item_del()
9142     *
9143     * @ingroup Gengrid
9144     */
9145    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);
9146
9147    /**
9148     * Insert an item in a gengrid widget using a user-defined sort function.
9149     *
9150     * @param obj The gengrid object.
9151     * @param gic The item class for the item.
9152     * @param data The item data.
9153     * @param comp User defined comparison function that defines the sort order based on
9154     * Elm_Gen_Item and its data param.
9155     * @param func Convenience function called when the item is selected.
9156     * @param func_data Data to be passed to @p func.
9157     * @return A handle to the item added or @c NULL, on errors.
9158     *
9159     * This inserts an item in the gengrid based on user defined comparison function.
9160     *
9161     * @see elm_gengrid_item_append()
9162     * @see elm_gengrid_item_prepend()
9163     * @see elm_gengrid_item_insert_after()
9164     * @see elm_gengrid_item_del()
9165     * @see elm_gengrid_item_direct_sorted_insert()
9166     *
9167     * @ingroup Gengrid
9168     */
9169    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);
9170
9171    /**
9172     * Insert an item in a gengrid widget using a user-defined sort function.
9173     *
9174     * @param obj The gengrid object.
9175     * @param gic The item class for the item.
9176     * @param data The item data.
9177     * @param comp User defined comparison function that defines the sort order based on
9178     * Elm_Gen_Item.
9179     * @param func Convenience function called when the item is selected.
9180     * @param func_data Data to be passed to @p func.
9181     * @return A handle to the item added or @c NULL, on errors.
9182     *
9183     * This inserts an item in the gengrid based on user defined comparison function.
9184     *
9185     * @see elm_gengrid_item_append()
9186     * @see elm_gengrid_item_prepend()
9187     * @see elm_gengrid_item_insert_after()
9188     * @see elm_gengrid_item_del()
9189     * @see elm_gengrid_item_sorted_insert()
9190     *
9191     * @ingroup Gengrid
9192     */
9193    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);
9194
9195    /**
9196     * Set whether items on a given gengrid widget are to get their
9197     * selection callbacks issued for @b every subsequent selection
9198     * click on them or just for the first click.
9199     *
9200     * @param obj The gengrid object
9201     * @param always_select @c EINA_TRUE to make items "always
9202     * selected", @c EINA_FALSE, otherwise
9203     *
9204     * By default, grid items will only call their selection callback
9205     * function when firstly getting selected, any subsequent further
9206     * clicks will do nothing. With this call, you make those
9207     * subsequent clicks also to issue the selection callbacks.
9208     *
9209     * @note <b>Double clicks</b> will @b always be reported on items.
9210     *
9211     * @see elm_gengrid_always_select_mode_get()
9212     *
9213     * @ingroup Gengrid
9214     */
9215    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
9216
9217    /**
9218     * Get whether items on a given gengrid widget have their selection
9219     * callbacks issued for @b every subsequent selection click on them
9220     * or just for the first click.
9221     *
9222     * @param obj The gengrid object.
9223     * @return @c EINA_TRUE if the gengrid items are "always selected",
9224     * @c EINA_FALSE, otherwise
9225     *
9226     * @see elm_gengrid_always_select_mode_set() for more details
9227     *
9228     * @ingroup Gengrid
9229     */
9230    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9231
9232    /**
9233     * Set whether items on a given gengrid widget can be selected or not.
9234     *
9235     * @param obj The gengrid object
9236     * @param no_select @c EINA_TRUE to make items selectable,
9237     * @c EINA_FALSE otherwise
9238     *
9239     * This will make items in @p obj selectable or not. In the latter
9240     * case, any user interaction on the gengrid items will neither make
9241     * them appear selected nor them call their selection callback
9242     * functions.
9243     *
9244     * @see elm_gengrid_no_select_mode_get()
9245     *
9246     * @ingroup Gengrid
9247     */
9248    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
9249
9250    /**
9251     * Get whether items on a given gengrid widget can be selected or
9252     * not.
9253     *
9254     * @param obj The gengrid object
9255     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
9256     * otherwise
9257     *
9258     * @see elm_gengrid_no_select_mode_set() for more details
9259     *
9260     * @ingroup Gengrid
9261     */
9262    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9263
9264    /**
9265     * Enable or disable multi-selection in a given gengrid widget
9266     *
9267     * @param obj The gengrid object.
9268     * @param multi @c EINA_TRUE, to enable multi-selection,
9269     * @c EINA_FALSE to disable it.
9270     *
9271     * Multi-selection is the ability to have @b more than one
9272     * item selected, on a given gengrid, simultaneously. When it is
9273     * enabled, a sequence of clicks on different items will make them
9274     * all selected, progressively. A click on an already selected item
9275     * will unselect it. If interacting via the keyboard,
9276     * multi-selection is enabled while holding the "Shift" key.
9277     *
9278     * @note By default, multi-selection is @b disabled on gengrids
9279     *
9280     * @see elm_gengrid_multi_select_get()
9281     *
9282     * @ingroup Gengrid
9283     */
9284    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
9285
9286    /**
9287     * Get whether multi-selection is enabled or disabled for a given
9288     * gengrid widget
9289     *
9290     * @param obj The gengrid object.
9291     * @return @c EINA_TRUE, if multi-selection is enabled, @c
9292     * EINA_FALSE otherwise
9293     *
9294     * @see elm_gengrid_multi_select_set() for more details
9295     *
9296     * @ingroup Gengrid
9297     */
9298    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9299
9300    /**
9301     * Enable or disable bouncing effect for a given gengrid widget
9302     *
9303     * @param obj The gengrid object
9304     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
9305     * @c EINA_FALSE to disable it
9306     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
9307     * @c EINA_FALSE to disable it
9308     *
9309     * The bouncing effect occurs whenever one reaches the gengrid's
9310     * edge's while panning it -- it will scroll past its limits a
9311     * little bit and return to the edge again, in a animated for,
9312     * automatically.
9313     *
9314     * @note By default, gengrids have bouncing enabled on both axis
9315     *
9316     * @see elm_gengrid_bounce_get()
9317     *
9318     * @ingroup Gengrid
9319     */
9320    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9321
9322    /**
9323     * Get whether bouncing effects are enabled or disabled, for a
9324     * given gengrid widget, on each axis
9325     *
9326     * @param obj The gengrid object
9327     * @param h_bounce Pointer to a variable where to store the
9328     * horizontal bouncing flag.
9329     * @param v_bounce Pointer to a variable where to store the
9330     * vertical bouncing flag.
9331     *
9332     * @see elm_gengrid_bounce_set() for more details
9333     *
9334     * @ingroup Gengrid
9335     */
9336    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9337
9338    /**
9339     * Set a given gengrid widget's scrolling page size, relative to
9340     * its viewport size.
9341     *
9342     * @param obj The gengrid object
9343     * @param h_pagerel The horizontal page (relative) size
9344     * @param v_pagerel The vertical page (relative) size
9345     *
9346     * The gengrid's scroller is capable of binding scrolling by the
9347     * user to "pages". It means that, while scrolling and, specially
9348     * after releasing the mouse button, the grid will @b snap to the
9349     * nearest displaying page's area. When page sizes are set, the
9350     * grid's continuous content area is split into (equal) page sized
9351     * pieces.
9352     *
9353     * This function sets the size of a page <b>relatively to the
9354     * viewport dimensions</b> of the gengrid, for each axis. A value
9355     * @c 1.0 means "the exact viewport's size", in that axis, while @c
9356     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
9357     * a viewport". Sane usable values are, than, between @c 0.0 and @c
9358     * 1.0. Values beyond those will make it behave behave
9359     * inconsistently. If you only want one axis to snap to pages, use
9360     * the value @c 0.0 for the other one.
9361     *
9362     * There is a function setting page size values in @b absolute
9363     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
9364     * is mutually exclusive to this one.
9365     *
9366     * @see elm_gengrid_page_relative_get()
9367     *
9368     * @ingroup Gengrid
9369     */
9370    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
9371
9372    /**
9373     * Get a given gengrid widget's scrolling page size, relative to
9374     * its viewport size.
9375     *
9376     * @param obj The gengrid object
9377     * @param h_pagerel Pointer to a variable where to store the
9378     * horizontal page (relative) size
9379     * @param v_pagerel Pointer to a variable where to store the
9380     * vertical page (relative) size
9381     *
9382     * @see elm_gengrid_page_relative_set() for more details
9383     *
9384     * @ingroup Gengrid
9385     */
9386    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
9387
9388    /**
9389     * Set a given gengrid widget's scrolling page size
9390     *
9391     * @param obj The gengrid object
9392     * @param h_pagerel The horizontal page size, in pixels
9393     * @param v_pagerel The vertical page size, in pixels
9394     *
9395     * The gengrid's scroller is capable of binding scrolling by the
9396     * user to "pages". It means that, while scrolling and, specially
9397     * after releasing the mouse button, the grid will @b snap to the
9398     * nearest displaying page's area. When page sizes are set, the
9399     * grid's continuous content area is split into (equal) page sized
9400     * pieces.
9401     *
9402     * This function sets the size of a page of the gengrid, in pixels,
9403     * for each axis. Sane usable values are, between @c 0 and the
9404     * dimensions of @p obj, for each axis. Values beyond those will
9405     * make it behave behave inconsistently. If you only want one axis
9406     * to snap to pages, use the value @c 0 for the other one.
9407     *
9408     * There is a function setting page size values in @b relative
9409     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
9410     * use is mutually exclusive to this one.
9411     *
9412     * @ingroup Gengrid
9413     */
9414    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
9415
9416    /**
9417     * @brief Get gengrid current page number.
9418     *
9419     * @param obj The gengrid object
9420     * @param h_pagenumber The horizontal page number
9421     * @param v_pagenumber The vertical page number
9422     *
9423     * The page number starts from 0. 0 is the first page.
9424     * Current page means the page which meet the top-left of the viewport.
9425     * If there are two or more pages in the viewport, it returns the number of page
9426     * which meet the top-left of the viewport.
9427     *
9428     * @see elm_gengrid_last_page_get()
9429     * @see elm_gengrid_page_show()
9430     * @see elm_gengrid_page_brint_in()
9431     */
9432    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9433
9434    /**
9435     * @brief Get scroll last page number.
9436     *
9437     * @param obj The gengrid object
9438     * @param h_pagenumber The horizontal page number
9439     * @param v_pagenumber The vertical page number
9440     *
9441     * The page number starts from 0. 0 is the first page.
9442     * This returns the last page number among the pages.
9443     *
9444     * @see elm_gengrid_current_page_get()
9445     * @see elm_gengrid_page_show()
9446     * @see elm_gengrid_page_brint_in()
9447     */
9448    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
9449
9450    /**
9451     * Show a specific virtual region within the gengrid content object by page number.
9452     *
9453     * @param obj The gengrid object
9454     * @param h_pagenumber The horizontal page number
9455     * @param v_pagenumber The vertical page number
9456     *
9457     * 0, 0 of the indicated page is located at the top-left of the viewport.
9458     * This will jump to the page directly without animation.
9459     *
9460     * Example of usage:
9461     *
9462     * @code
9463     * sc = elm_gengrid_add(win);
9464     * elm_gengrid_content_set(sc, content);
9465     * elm_gengrid_page_relative_set(sc, 1, 0);
9466     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
9467     * elm_gengrid_page_show(sc, h_page + 1, v_page);
9468     * @endcode
9469     *
9470     * @see elm_gengrid_page_bring_in()
9471     */
9472    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9473
9474    /**
9475     * Show a specific virtual region within the gengrid content object by page number.
9476     *
9477     * @param obj The gengrid object
9478     * @param h_pagenumber The horizontal page number
9479     * @param v_pagenumber The vertical page number
9480     *
9481     * 0, 0 of the indicated page is located at the top-left of the viewport.
9482     * This will slide to the page with animation.
9483     *
9484     * Example of usage:
9485     *
9486     * @code
9487     * sc = elm_gengrid_add(win);
9488     * elm_gengrid_content_set(sc, content);
9489     * elm_gengrid_page_relative_set(sc, 1, 0);
9490     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
9491     * elm_gengrid_page_bring_in(sc, h_page, v_page);
9492     * @endcode
9493     *
9494     * @see elm_gengrid_page_show()
9495     */
9496     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
9497
9498    /**
9499     * Set the direction in which a given gengrid widget will expand while
9500     * placing its items.
9501     *
9502     * @param obj The gengrid object.
9503     * @param setting @c EINA_TRUE to make the gengrid expand
9504     * horizontally, @c EINA_FALSE to expand vertically.
9505     *
9506     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
9507     * in @b columns, from top to bottom and, when the space for a
9508     * column is filled, another one is started on the right, thus
9509     * expanding the grid horizontally. When in "vertical mode"
9510     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
9511     * to right and, when the space for a row is filled, another one is
9512     * started below, thus expanding the grid vertically.
9513     *
9514     * @see elm_gengrid_horizontal_get()
9515     *
9516     * @ingroup Gengrid
9517     */
9518    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
9519
9520    /**
9521     * Get for what direction a given gengrid widget will expand while
9522     * placing its items.
9523     *
9524     * @param obj The gengrid object.
9525     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
9526     * @c EINA_FALSE if it's set to expand vertically.
9527     *
9528     * @see elm_gengrid_horizontal_set() for more detais
9529     *
9530     * @ingroup Gengrid
9531     */
9532    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9533
9534    /**
9535     * Get the first item in a given gengrid widget
9536     *
9537     * @param obj The gengrid object
9538     * @return The first item's handle or @c NULL, if there are no
9539     * items in @p obj (and on errors)
9540     *
9541     * This returns the first item in the @p obj's internal list of
9542     * items.
9543     *
9544     * @see elm_gengrid_last_item_get()
9545     *
9546     * @ingroup Gengrid
9547     */
9548    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9549
9550    /**
9551     * Get the last item in a given gengrid widget
9552     *
9553     * @param obj The gengrid object
9554     * @return The last item's handle or @c NULL, if there are no
9555     * items in @p obj (and on errors)
9556     *
9557     * This returns the last item in the @p obj's internal list of
9558     * items.
9559     *
9560     * @see elm_gengrid_first_item_get()
9561     *
9562     * @ingroup Gengrid
9563     */
9564    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9565
9566    /**
9567     * Get the @b next item in a gengrid widget's internal list of items,
9568     * given a handle to one of those items.
9569     *
9570     * @param item The gengrid item to fetch next from
9571     * @return The item after @p item, or @c NULL if there's none (and
9572     * on errors)
9573     *
9574     * This returns the item placed after the @p item, on the container
9575     * gengrid.
9576     *
9577     * @see elm_gengrid_item_prev_get()
9578     *
9579     * @ingroup Gengrid
9580     */
9581    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9582
9583    /**
9584     * Get the @b previous item in a gengrid widget's internal list of items,
9585     * given a handle to one of those items.
9586     *
9587     * @param item The gengrid item to fetch previous from
9588     * @return The item before @p item, or @c NULL if there's none (and
9589     * on errors)
9590     *
9591     * This returns the item placed before the @p item, on the container
9592     * gengrid.
9593     *
9594     * @see elm_gengrid_item_next_get()
9595     *
9596     * @ingroup Gengrid
9597     */
9598    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9599
9600    /**
9601     * Get the gengrid object's handle which contains a given gengrid
9602     * item
9603     *
9604     * @param item The item to fetch the container from
9605     * @return The gengrid (parent) object
9606     *
9607     * This returns the gengrid object itself that an item belongs to.
9608     *
9609     * @ingroup Gengrid
9610     */
9611    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9612
9613    /**
9614     * Remove a gengrid item from its parent, deleting it.
9615     *
9616     * @param item The item to be removed.
9617     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
9618     *
9619     * @see elm_gengrid_clear(), to remove all items in a gengrid at
9620     * once.
9621     *
9622     * @ingroup Gengrid
9623     */
9624    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9625
9626    /**
9627     * Update the contents of a given gengrid item
9628     *
9629     * @param item The gengrid item
9630     *
9631     * This updates an item by calling all the item class functions
9632     * again to get the contents, texts and states. Use this when the
9633     * original item data has changed and you want the changes to be
9634     * reflected.
9635     *
9636     * @ingroup Gengrid
9637     */
9638    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9639
9640    /**
9641     * Get the Gengrid Item class for the given Gengrid Item.
9642     *
9643     * @param item The gengrid item
9644     *
9645     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9646     * the function pointers and item_style.
9647     *
9648     * @ingroup Gengrid
9649     */
9650    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9651
9652    /**
9653     * Get the Gengrid Item class for the given Gengrid Item.
9654     *
9655     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9656     * the function pointers and item_style.
9657     *
9658     * @param item The gengrid item
9659     * @param gic The gengrid item class describing the function pointers and the item style.
9660     *
9661     * @ingroup Gengrid
9662     */
9663    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9664
9665    /**
9666     * Return the data associated to a given gengrid item
9667     *
9668     * @param item The gengrid item.
9669     * @return the data associated with this item.
9670     *
9671     * This returns the @c data value passed on the
9672     * elm_gengrid_item_append() and related item addition calls.
9673     *
9674     * @see elm_gengrid_item_append()
9675     * @see elm_gengrid_item_data_set()
9676     *
9677     * @ingroup Gengrid
9678     */
9679    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9680
9681    /**
9682     * Set the data associated with a given gengrid item
9683     *
9684     * @param item The gengrid item
9685     * @param data The data pointer to set on it
9686     *
9687     * This @b overrides the @c data value passed on the
9688     * elm_gengrid_item_append() and related item addition calls. This
9689     * function @b won't call elm_gengrid_item_update() automatically,
9690     * so you'd issue it afterwards if you want to have the item
9691     * updated to reflect the new data.
9692     *
9693     * @see elm_gengrid_item_data_get()
9694     * @see elm_gengrid_item_update()
9695     *
9696     * @ingroup Gengrid
9697     */
9698    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9699
9700    /**
9701     * Get a given gengrid item's position, relative to the whole
9702     * gengrid's grid area.
9703     *
9704     * @param item The Gengrid item.
9705     * @param x Pointer to variable to store the item's <b>row number</b>.
9706     * @param y Pointer to variable to store the item's <b>column number</b>.
9707     *
9708     * This returns the "logical" position of the item within the
9709     * gengrid. For example, @c (0, 1) would stand for first row,
9710     * second column.
9711     *
9712     * @ingroup Gengrid
9713     */
9714    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9715
9716    /**
9717     * Set whether a given gengrid item is selected or not
9718     *
9719     * @param item The gengrid item
9720     * @param selected Use @c EINA_TRUE, to make it selected, @c
9721     * EINA_FALSE to make it unselected
9722     *
9723     * This sets the selected state of an item. If multi-selection is
9724     * not enabled on the containing gengrid and @p selected is @c
9725     * EINA_TRUE, any other previously selected items will get
9726     * unselected in favor of this new one.
9727     *
9728     * @see elm_gengrid_item_selected_get()
9729     *
9730     * @ingroup Gengrid
9731     */
9732    EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9733
9734    /**
9735     * Get whether a given gengrid item is selected or not
9736     *
9737     * @param item The gengrid item
9738     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9739     *
9740     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9741     *
9742     * @see elm_gengrid_item_selected_set() for more details
9743     *
9744     * @ingroup Gengrid
9745     */
9746    EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9747
9748    /**
9749     * Get the real Evas object created to implement the view of a
9750     * given gengrid item
9751     *
9752     * @param item The gengrid item.
9753     * @return the Evas object implementing this item's view.
9754     *
9755     * This returns the actual Evas object used to implement the
9756     * specified gengrid item's view. This may be @c NULL, as it may
9757     * not have been created or may have been deleted, at any time, by
9758     * the gengrid. <b>Do not modify this object</b> (move, resize,
9759     * show, hide, etc.), as the gengrid is controlling it. This
9760     * function is for querying, emitting custom signals or hooking
9761     * lower level callbacks for events on that object. Do not delete
9762     * this object under any circumstances.
9763     *
9764     * @see elm_gengrid_item_data_get()
9765     *
9766     * @ingroup Gengrid
9767     */
9768    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9769
9770    /**
9771     * Show the portion of a gengrid's internal grid containing a given
9772     * item, @b immediately.
9773     *
9774     * @param item The item to display
9775     *
9776     * This causes gengrid to @b redraw its viewport's contents to the
9777     * region contining the given @p item item, if it is not fully
9778     * visible.
9779     *
9780     * @see elm_gengrid_item_bring_in()
9781     *
9782     * @ingroup Gengrid
9783     */
9784    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9785
9786    /**
9787     * Animatedly bring in, to the visible area of a gengrid, a given
9788     * item on it.
9789     *
9790     * @param item The gengrid item to display
9791     *
9792     * This causes gengrid to jump to the given @p item and show
9793     * it (by scrolling), if it is not fully visible. This will use
9794     * animation to do so and take a period of time to complete.
9795     *
9796     * @see elm_gengrid_item_show()
9797     *
9798     * @ingroup Gengrid
9799     */
9800    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9801
9802    /**
9803     * Set whether a given gengrid item is disabled or not.
9804     *
9805     * @param item The gengrid item
9806     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9807     * to enable it back.
9808     *
9809     * A disabled item cannot be selected or unselected. It will also
9810     * change its appearance, to signal the user it's disabled.
9811     *
9812     * @see elm_gengrid_item_disabled_get()
9813     *
9814     * @ingroup Gengrid
9815     */
9816    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9817
9818    /**
9819     * Get whether a given gengrid item is disabled or not.
9820     *
9821     * @param item The gengrid item
9822     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9823     * (and on errors).
9824     *
9825     * @see elm_gengrid_item_disabled_set() for more details
9826     *
9827     * @ingroup Gengrid
9828     */
9829    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9830
9831    /**
9832     * Set the text to be shown in a given gengrid item's tooltips.
9833     *
9834     * @param item The gengrid item
9835     * @param text The text to set in the content
9836     *
9837     * This call will setup the text to be used as tooltip to that item
9838     * (analogous to elm_object_tooltip_text_set(), but being item
9839     * tooltips with higher precedence than object tooltips). It can
9840     * have only one tooltip at a time, so any previous tooltip data
9841     * will get removed.
9842     *
9843     * @ingroup Gengrid
9844     */
9845    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9846
9847    /**
9848     * Set the content to be shown in a given gengrid item's tooltip
9849     *
9850     * @param item The gengrid item.
9851     * @param func The function returning the tooltip contents.
9852     * @param data What to provide to @a func as callback data/context.
9853     * @param del_cb Called when data is not needed anymore, either when
9854     *        another callback replaces @p func, the tooltip is unset with
9855     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9856     *        dies. This callback receives as its first parameter the
9857     *        given @p data, being @c event_info the item handle.
9858     *
9859     * This call will setup the tooltip's contents to @p item
9860     * (analogous to elm_object_tooltip_content_cb_set(), but being
9861     * item tooltips with higher precedence than object tooltips). It
9862     * can have only one tooltip at a time, so any previous tooltip
9863     * content will get removed. @p func (with @p data) will be called
9864     * every time Elementary needs to show the tooltip and it should
9865     * return a valid Evas object, which will be fully managed by the
9866     * tooltip system, getting deleted when the tooltip is gone.
9867     *
9868     * @ingroup Gengrid
9869     */
9870    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);
9871
9872    /**
9873     * Unset a tooltip from a given gengrid item
9874     *
9875     * @param item gengrid item to remove a previously set tooltip from.
9876     *
9877     * This call removes any tooltip set on @p item. The callback
9878     * provided as @c del_cb to
9879     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9880     * notify it is not used anymore (and have resources cleaned, if
9881     * need be).
9882     *
9883     * @see elm_gengrid_item_tooltip_content_cb_set()
9884     *
9885     * @ingroup Gengrid
9886     */
9887    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9888
9889    /**
9890     * Set a different @b style for a given gengrid item's tooltip.
9891     *
9892     * @param item gengrid item with tooltip set
9893     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9894     * "default", @c "transparent", etc)
9895     *
9896     * Tooltips can have <b>alternate styles</b> to be displayed on,
9897     * which are defined by the theme set on Elementary. This function
9898     * works analogously as elm_object_tooltip_style_set(), but here
9899     * applied only to gengrid item objects. The default style for
9900     * tooltips is @c "default".
9901     *
9902     * @note before you set a style you should define a tooltip with
9903     *       elm_gengrid_item_tooltip_content_cb_set() or
9904     *       elm_gengrid_item_tooltip_text_set()
9905     *
9906     * @see elm_gengrid_item_tooltip_style_get()
9907     *
9908     * @ingroup Gengrid
9909     */
9910    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9911
9912    /**
9913     * Get the style set a given gengrid item's tooltip.
9914     *
9915     * @param item gengrid item with tooltip already set on.
9916     * @return style the theme style in use, which defaults to
9917     *         "default". If the object does not have a tooltip set,
9918     *         then @c NULL is returned.
9919     *
9920     * @see elm_gengrid_item_tooltip_style_set() for more details
9921     *
9922     * @ingroup Gengrid
9923     */
9924    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9925
9926    /**
9927     * @brief Disable size restrictions on an object's tooltip
9928     * @param item The tooltip's anchor object
9929     * @param disable If EINA_TRUE, size restrictions are disabled
9930     * @return EINA_FALSE on failure, EINA_TRUE on success
9931     *
9932     * This function allows a tooltip to expand beyond its parant window's canvas.
9933     * It will instead be limited only by the size of the display.
9934     */
9935    EAPI Eina_Bool          elm_gengrid_item_tooltip_window_mode_set(Elm_Gengrid_Item *item, Eina_Bool disable);
9936
9937    /**
9938     * @brief Retrieve size restriction state of an object's tooltip
9939     * @param item The tooltip's anchor object
9940     * @return If EINA_TRUE, size restrictions are disabled
9941     *
9942     * This function returns whether a tooltip is allowed to expand beyond
9943     * its parant window's canvas.
9944     * It will instead be limited only by the size of the display.
9945     */
9946    EAPI Eina_Bool          elm_gengrid_item_tooltip_window_mode_get(const Elm_Gengrid_Item *item);
9947
9948    /**
9949     * Set the type of mouse pointer/cursor decoration to be shown,
9950     * when the mouse pointer is over the given gengrid widget item
9951     *
9952     * @param item gengrid item to customize cursor on
9953     * @param cursor the cursor type's name
9954     *
9955     * This function works analogously as elm_object_cursor_set(), but
9956     * here the cursor's changing area is restricted to the item's
9957     * area, and not the whole widget's. Note that that item cursors
9958     * have precedence over widget cursors, so that a mouse over @p
9959     * item will always show cursor @p type.
9960     *
9961     * If this function is called twice for an object, a previously set
9962     * cursor will be unset on the second call.
9963     *
9964     * @see elm_object_cursor_set()
9965     * @see elm_gengrid_item_cursor_get()
9966     * @see elm_gengrid_item_cursor_unset()
9967     *
9968     * @ingroup Gengrid
9969     */
9970    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9971
9972    /**
9973     * Get the type of mouse pointer/cursor decoration set to be shown,
9974     * when the mouse pointer is over the given gengrid widget item
9975     *
9976     * @param item gengrid item with custom cursor set
9977     * @return the cursor type's name or @c NULL, if no custom cursors
9978     * were set to @p item (and on errors)
9979     *
9980     * @see elm_object_cursor_get()
9981     * @see elm_gengrid_item_cursor_set() for more details
9982     * @see elm_gengrid_item_cursor_unset()
9983     *
9984     * @ingroup Gengrid
9985     */
9986    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9987
9988    /**
9989     * Unset any custom mouse pointer/cursor decoration set to be
9990     * shown, when the mouse pointer is over the given gengrid widget
9991     * item, thus making it show the @b default cursor again.
9992     *
9993     * @param item a gengrid item
9994     *
9995     * Use this call to undo any custom settings on this item's cursor
9996     * decoration, bringing it back to defaults (no custom style set).
9997     *
9998     * @see elm_object_cursor_unset()
9999     * @see elm_gengrid_item_cursor_set() for more details
10000     *
10001     * @ingroup Gengrid
10002     */
10003    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10004
10005    /**
10006     * Set a different @b style for a given custom cursor set for a
10007     * gengrid item.
10008     *
10009     * @param item gengrid item with custom cursor set
10010     * @param style the <b>theme style</b> to use (e.g. @c "default",
10011     * @c "transparent", etc)
10012     *
10013     * This function only makes sense when one is using custom mouse
10014     * cursor decorations <b>defined in a theme file</b> , which can
10015     * have, given a cursor name/type, <b>alternate styles</b> on
10016     * it. It works analogously as elm_object_cursor_style_set(), but
10017     * here applied only to gengrid item objects.
10018     *
10019     * @warning Before you set a cursor style you should have defined a
10020     *       custom cursor previously on the item, with
10021     *       elm_gengrid_item_cursor_set()
10022     *
10023     * @see elm_gengrid_item_cursor_engine_only_set()
10024     * @see elm_gengrid_item_cursor_style_get()
10025     *
10026     * @ingroup Gengrid
10027     */
10028    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
10029
10030    /**
10031     * Get the current @b style set for a given gengrid item's custom
10032     * cursor
10033     *
10034     * @param item gengrid item with custom cursor set.
10035     * @return style the cursor style in use. If the object does not
10036     *         have a cursor set, then @c NULL is returned.
10037     *
10038     * @see elm_gengrid_item_cursor_style_set() for more details
10039     *
10040     * @ingroup Gengrid
10041     */
10042    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10043
10044    /**
10045     * Set if the (custom) cursor for a given gengrid item should be
10046     * searched in its theme, also, or should only rely on the
10047     * rendering engine.
10048     *
10049     * @param item item with custom (custom) cursor already set on
10050     * @param engine_only Use @c EINA_TRUE to have cursors looked for
10051     * only on those provided by the rendering engine, @c EINA_FALSE to
10052     * have them searched on the widget's theme, as well.
10053     *
10054     * @note This call is of use only if you've set a custom cursor
10055     * for gengrid items, with elm_gengrid_item_cursor_set().
10056     *
10057     * @note By default, cursors will only be looked for between those
10058     * provided by the rendering engine.
10059     *
10060     * @ingroup Gengrid
10061     */
10062    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
10063
10064    /**
10065     * Get if the (custom) cursor for a given gengrid item is being
10066     * searched in its theme, also, or is only relying on the rendering
10067     * engine.
10068     *
10069     * @param item a gengrid item
10070     * @return @c EINA_TRUE, if cursors are being looked for only on
10071     * those provided by the rendering engine, @c EINA_FALSE if they
10072     * are being searched on the widget's theme, as well.
10073     *
10074     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
10075     *
10076     * @ingroup Gengrid
10077     */
10078    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
10079
10080    /**
10081     * Remove all items from a given gengrid widget
10082     *
10083     * @param obj The gengrid object.
10084     *
10085     * This removes (and deletes) all items in @p obj, leaving it
10086     * empty.
10087     *
10088     * @see elm_gengrid_item_del(), to remove just one item.
10089     *
10090     * @ingroup Gengrid
10091     */
10092    EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10093
10094    /**
10095     * Get the selected item in a given gengrid widget
10096     *
10097     * @param obj The gengrid object.
10098     * @return The selected item's handleor @c NULL, if none is
10099     * selected at the moment (and on errors)
10100     *
10101     * This returns the selected item in @p obj. If multi selection is
10102     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
10103     * the first item in the list is selected, which might not be very
10104     * useful. For that case, see elm_gengrid_selected_items_get().
10105     *
10106     * @ingroup Gengrid
10107     */
10108    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10109
10110    /**
10111     * Get <b>a list</b> of selected items in a given gengrid
10112     *
10113     * @param obj The gengrid object.
10114     * @return The list of selected items or @c NULL, if none is
10115     * selected at the moment (and on errors)
10116     *
10117     * This returns a list of the selected items, in the order that
10118     * they appear in the grid. This list is only valid as long as no
10119     * more items are selected or unselected (or unselected implictly
10120     * by deletion). The list contains #Elm_Gengrid_Item pointers as
10121     * data, naturally.
10122     *
10123     * @see elm_gengrid_selected_item_get()
10124     *
10125     * @ingroup Gengrid
10126     */
10127    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10128
10129    /**
10130     * @}
10131     */
10132
10133    /**
10134     * @defgroup Clock Clock
10135     *
10136     * @image html img/widget/clock/preview-00.png
10137     * @image latex img/widget/clock/preview-00.eps
10138     *
10139     * This is a @b digital clock widget. In its default theme, it has a
10140     * vintage "flipping numbers clock" appearance, which will animate
10141     * sheets of individual algarisms individually as time goes by.
10142     *
10143     * A newly created clock will fetch system's time (already
10144     * considering local time adjustments) to start with, and will tick
10145     * accondingly. It may or may not show seconds.
10146     *
10147     * Clocks have an @b edition mode. When in it, the sheets will
10148     * display extra arrow indications on the top and bottom and the
10149     * user may click on them to raise or lower the time values. After
10150     * it's told to exit edition mode, it will keep ticking with that
10151     * new time set (it keeps the difference from local time).
10152     *
10153     * Also, when under edition mode, user clicks on the cited arrows
10154     * which are @b held for some time will make the clock to flip the
10155     * sheet, thus editing the time, continuosly and automatically for
10156     * the user. The interval between sheet flips will keep growing in
10157     * time, so that it helps the user to reach a time which is distant
10158     * from the one set.
10159     *
10160     * The time display is, by default, in military mode (24h), but an
10161     * am/pm indicator may be optionally shown, too, when it will
10162     * switch to 12h.
10163     *
10164     * Smart callbacks one can register to:
10165     * - "changed" - the clock's user changed the time
10166     *
10167     * Here is an example on its usage:
10168     * @li @ref clock_example
10169     */
10170
10171    /**
10172     * @addtogroup Clock
10173     * @{
10174     */
10175
10176    /**
10177     * Identifiers for which clock digits should be editable, when a
10178     * clock widget is in edition mode. Values may be ORed together to
10179     * make a mask, naturally.
10180     *
10181     * @see elm_clock_edit_set()
10182     * @see elm_clock_digit_edit_set()
10183     */
10184    typedef enum _Elm_Clock_Digedit
10185      {
10186         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
10187         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
10188         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
10189         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
10190         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
10191         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
10192         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
10193         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
10194      } Elm_Clock_Digedit;
10195
10196    /**
10197     * Add a new clock widget to the given parent Elementary
10198     * (container) object
10199     *
10200     * @param parent The parent object
10201     * @return a new clock widget handle or @c NULL, on errors
10202     *
10203     * This function inserts a new clock widget on the canvas.
10204     *
10205     * @ingroup Clock
10206     */
10207    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10208
10209    /**
10210     * Set a clock widget's time, programmatically
10211     *
10212     * @param obj The clock widget object
10213     * @param hrs The hours to set
10214     * @param min The minutes to set
10215     * @param sec The secondes to set
10216     *
10217     * This function updates the time that is showed by the clock
10218     * widget.
10219     *
10220     *  Values @b must be set within the following ranges:
10221     * - 0 - 23, for hours
10222     * - 0 - 59, for minutes
10223     * - 0 - 59, for seconds,
10224     *
10225     * even if the clock is not in "military" mode.
10226     *
10227     * @warning The behavior for values set out of those ranges is @b
10228     * undefined.
10229     *
10230     * @ingroup Clock
10231     */
10232    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
10233
10234    /**
10235     * Get a clock widget's time values
10236     *
10237     * @param obj The clock object
10238     * @param[out] hrs Pointer to the variable to get the hours value
10239     * @param[out] min Pointer to the variable to get the minutes value
10240     * @param[out] sec Pointer to the variable to get the seconds value
10241     *
10242     * This function gets the time set for @p obj, returning
10243     * it on the variables passed as the arguments to function
10244     *
10245     * @note Use @c NULL pointers on the time values you're not
10246     * interested in: they'll be ignored by the function.
10247     *
10248     * @ingroup Clock
10249     */
10250    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
10251
10252    /**
10253     * Set whether a given clock widget is under <b>edition mode</b> or
10254     * under (default) displaying-only mode.
10255     *
10256     * @param obj The clock object
10257     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
10258     * put it back to "displaying only" mode
10259     *
10260     * This function makes a clock's time to be editable or not <b>by
10261     * user interaction</b>. When in edition mode, clocks @b stop
10262     * ticking, until one brings them back to canonical mode. The
10263     * elm_clock_digit_edit_set() function will influence which digits
10264     * of the clock will be editable. By default, all of them will be
10265     * (#ELM_CLOCK_NONE).
10266     *
10267     * @note am/pm sheets, if being shown, will @b always be editable
10268     * under edition mode.
10269     *
10270     * @see elm_clock_edit_get()
10271     *
10272     * @ingroup Clock
10273     */
10274    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10275
10276    /**
10277     * Retrieve whether a given clock widget is under <b>edition
10278     * mode</b> or under (default) displaying-only mode.
10279     *
10280     * @param obj The clock object
10281     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
10282     * otherwise
10283     *
10284     * This function retrieves whether the clock's time can be edited
10285     * or not by user interaction.
10286     *
10287     * @see elm_clock_edit_set() for more details
10288     *
10289     * @ingroup Clock
10290     */
10291    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10292
10293    /**
10294     * Set what digits of the given clock widget should be editable
10295     * when in edition mode.
10296     *
10297     * @param obj The clock object
10298     * @param digedit Bit mask indicating the digits to be editable
10299     * (values in #Elm_Clock_Digedit).
10300     *
10301     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
10302     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
10303     * EINA_FALSE).
10304     *
10305     * @see elm_clock_digit_edit_get()
10306     *
10307     * @ingroup Clock
10308     */
10309    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
10310
10311    /**
10312     * Retrieve what digits of the given clock widget should be
10313     * editable when in edition mode.
10314     *
10315     * @param obj The clock object
10316     * @return Bit mask indicating the digits to be editable
10317     * (values in #Elm_Clock_Digedit).
10318     *
10319     * @see elm_clock_digit_edit_set() for more details
10320     *
10321     * @ingroup Clock
10322     */
10323    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10324
10325    /**
10326     * Set if the given clock widget must show hours in military or
10327     * am/pm mode
10328     *
10329     * @param obj The clock object
10330     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
10331     * to military mode
10332     *
10333     * This function sets if the clock must show hours in military or
10334     * am/pm mode. In some countries like Brazil the military mode
10335     * (00-24h-format) is used, in opposition to the USA, where the
10336     * am/pm mode is more commonly used.
10337     *
10338     * @see elm_clock_show_am_pm_get()
10339     *
10340     * @ingroup Clock
10341     */
10342    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
10343
10344    /**
10345     * Get if the given clock widget shows hours in military or am/pm
10346     * mode
10347     *
10348     * @param obj The clock object
10349     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
10350     * military
10351     *
10352     * This function gets if the clock shows hours in military or am/pm
10353     * mode.
10354     *
10355     * @see elm_clock_show_am_pm_set() for more details
10356     *
10357     * @ingroup Clock
10358     */
10359    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10360
10361    /**
10362     * Set if the given clock widget must show time with seconds or not
10363     *
10364     * @param obj The clock object
10365     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
10366     *
10367     * This function sets if the given clock must show or not elapsed
10368     * seconds. By default, they are @b not shown.
10369     *
10370     * @see elm_clock_show_seconds_get()
10371     *
10372     * @ingroup Clock
10373     */
10374    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
10375
10376    /**
10377     * Get whether the given clock widget is showing time with seconds
10378     * or not
10379     *
10380     * @param obj The clock object
10381     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
10382     *
10383     * This function gets whether @p obj is showing or not the elapsed
10384     * seconds.
10385     *
10386     * @see elm_clock_show_seconds_set()
10387     *
10388     * @ingroup Clock
10389     */
10390    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10391
10392    /**
10393     * Set the interval on time updates for an user mouse button hold
10394     * on clock widgets' time edition.
10395     *
10396     * @param obj The clock object
10397     * @param interval The (first) interval value in seconds
10398     *
10399     * This interval value is @b decreased while the user holds the
10400     * mouse pointer either incrementing or decrementing a given the
10401     * clock digit's value.
10402     *
10403     * This helps the user to get to a given time distant from the
10404     * current one easier/faster, as it will start to flip quicker and
10405     * quicker on mouse button holds.
10406     *
10407     * The calculation for the next flip interval value, starting from
10408     * the one set with this call, is the previous interval divided by
10409     * 1.05, so it decreases a little bit.
10410     *
10411     * The default starting interval value for automatic flips is
10412     * @b 0.85 seconds.
10413     *
10414     * @see elm_clock_interval_get()
10415     *
10416     * @ingroup Clock
10417     */
10418    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
10419
10420    /**
10421     * Get the interval on time updates for an user mouse button hold
10422     * on clock widgets' time edition.
10423     *
10424     * @param obj The clock object
10425     * @return The (first) interval value, in seconds, set on it
10426     *
10427     * @see elm_clock_interval_set() for more details
10428     *
10429     * @ingroup Clock
10430     */
10431    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10432
10433    /**
10434     * @}
10435     */
10436
10437    /**
10438     * @defgroup Layout Layout
10439     *
10440     * @image html img/widget/layout/preview-00.png
10441     * @image latex img/widget/layout/preview-00.eps width=\textwidth
10442     *
10443     * @image html img/layout-predefined.png
10444     * @image latex img/layout-predefined.eps width=\textwidth
10445     *
10446     * This is a container widget that takes a standard Edje design file and
10447     * wraps it very thinly in a widget.
10448     *
10449     * An Edje design (theme) file has a very wide range of possibilities to
10450     * describe the behavior of elements added to the Layout. Check out the Edje
10451     * documentation and the EDC reference to get more information about what can
10452     * be done with Edje.
10453     *
10454     * Just like @ref List, @ref Box, and other container widgets, any
10455     * object added to the Layout will become its child, meaning that it will be
10456     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
10457     *
10458     * The Layout widget can contain as many Contents, Boxes or Tables as
10459     * described in its theme file. For instance, objects can be added to
10460     * different Tables by specifying the respective Table part names. The same
10461     * is valid for Content and Box.
10462     *
10463     * The objects added as child of the Layout will behave as described in the
10464     * part description where they were added. There are 3 possible types of
10465     * parts where a child can be added:
10466     *
10467     * @section secContent Content (SWALLOW part)
10468     *
10469     * Only one object can be added to the @c SWALLOW part (but you still can
10470     * have many @c SWALLOW parts and one object on each of them). Use the @c
10471     * elm_object_content_set/get/unset functions to set, retrieve and unset
10472     * objects as content of the @c SWALLOW. After being set to this part, the
10473     * object size, position, visibility, clipping and other description
10474     * properties will be totally controlled by the description of the given part
10475     * (inside the Edje theme file).
10476     *
10477     * One can use @c evas_object_size_hint_* functions on the child to have some
10478     * kind of control over its behavior, but the resulting behavior will still
10479     * depend heavily on the @c SWALLOW part description.
10480     *
10481     * The Edje theme also can change the part description, based on signals or
10482     * scripts running inside the theme. This change can also be animated. All of
10483     * this will affect the child object set as content accordingly. The object
10484     * size will be changed if the part size is changed, it will animate move if
10485     * the part is moving, and so on.
10486     *
10487     * The following picture demonstrates a Layout widget with a child object
10488     * added to its @c SWALLOW:
10489     *
10490     * @image html layout_swallow.png
10491     * @image latex layout_swallow.eps width=\textwidth
10492     *
10493     * @section secBox Box (BOX part)
10494     *
10495     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
10496     * allows one to add objects to the box and have them distributed along its
10497     * area, accordingly to the specified @a layout property (now by @a layout we
10498     * mean the chosen layouting design of the Box, not the Layout widget
10499     * itself).
10500     *
10501     * A similar effect for having a box with its position, size and other things
10502     * controlled by the Layout theme would be to create an Elementary @ref Box
10503     * widget and add it as a Content in the @c SWALLOW part.
10504     *
10505     * The main difference of using the Layout Box is that its behavior, the box
10506     * properties like layouting format, padding, align, etc. will be all
10507     * controlled by the theme. This means, for example, that a signal could be
10508     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
10509     * handled the signal by changing the box padding, or align, or both. Using
10510     * the Elementary @ref Box widget is not necessarily harder or easier, it
10511     * just depends on the circunstances and requirements.
10512     *
10513     * The Layout Box can be used through the @c elm_layout_box_* set of
10514     * functions.
10515     *
10516     * The following picture demonstrates a Layout widget with many child objects
10517     * added to its @c BOX part:
10518     *
10519     * @image html layout_box.png
10520     * @image latex layout_box.eps width=\textwidth
10521     *
10522     * @section secTable Table (TABLE part)
10523     *
10524     * Just like the @ref secBox, the Layout Table is very similar to the
10525     * Elementary @ref Table widget. It allows one to add objects to the Table
10526     * specifying the row and column where the object should be added, and any
10527     * column or row span if necessary.
10528     *
10529     * Again, we could have this design by adding a @ref Table widget to the @c
10530     * SWALLOW part using elm_object_part_content_set(). The same difference happens
10531     * here when choosing to use the Layout Table (a @c TABLE part) instead of
10532     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
10533     *
10534     * The Layout Table can be used through the @c elm_layout_table_* set of
10535     * functions.
10536     *
10537     * The following picture demonstrates a Layout widget with many child objects
10538     * added to its @c TABLE part:
10539     *
10540     * @image html layout_table.png
10541     * @image latex layout_table.eps width=\textwidth
10542     *
10543     * @section secPredef Predefined Layouts
10544     *
10545     * Another interesting thing about the Layout widget is that it offers some
10546     * predefined themes that come with the default Elementary theme. These
10547     * themes can be set by the call elm_layout_theme_set(), and provide some
10548     * basic functionality depending on the theme used.
10549     *
10550     * Most of them already send some signals, some already provide a toolbar or
10551     * back and next buttons.
10552     *
10553     * These are available predefined theme layouts. All of them have class = @c
10554     * layout, group = @c application, and style = one of the following options:
10555     *
10556     * @li @c toolbar-content - application with toolbar and main content area
10557     * @li @c toolbar-content-back - application with toolbar and main content
10558     * area with a back button and title area
10559     * @li @c toolbar-content-back-next - application with toolbar and main
10560     * content area with a back and next buttons and title area
10561     * @li @c content-back - application with a main content area with a back
10562     * button and title area
10563     * @li @c content-back-next - application with a main content area with a
10564     * back and next buttons and title area
10565     * @li @c toolbar-vbox - application with toolbar and main content area as a
10566     * vertical box
10567     * @li @c toolbar-table - application with toolbar and main content area as a
10568     * table
10569     *
10570     * @section secExamples Examples
10571     *
10572     * Some examples of the Layout widget can be found here:
10573     * @li @ref layout_example_01
10574     * @li @ref layout_example_02
10575     * @li @ref layout_example_03
10576     * @li @ref layout_example_edc
10577     *
10578     */
10579
10580    /**
10581     * Add a new layout to the parent
10582     *
10583     * @param parent The parent object
10584     * @return The new object or NULL if it cannot be created
10585     *
10586     * @see elm_layout_file_set()
10587     * @see elm_layout_theme_set()
10588     *
10589     * @ingroup Layout
10590     */
10591    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10592
10593    /**
10594     * Set the file that will be used as layout
10595     *
10596     * @param obj The layout object
10597     * @param file The path to file (edj) that will be used as layout
10598     * @param group The group that the layout belongs in edje file
10599     *
10600     * @return (1 = success, 0 = error)
10601     *
10602     * @ingroup Layout
10603     */
10604    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
10605
10606    /**
10607     * Set the edje group from the elementary theme that will be used as layout
10608     *
10609     * @param obj The layout object
10610     * @param clas the clas of the group
10611     * @param group the group
10612     * @param style the style to used
10613     *
10614     * @return (1 = success, 0 = error)
10615     *
10616     * @ingroup Layout
10617     */
10618    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
10619
10620    /**
10621     * Set the layout content.
10622     *
10623     * @param obj The layout object
10624     * @param swallow The swallow part name in the edje file
10625     * @param content The child that will be added in this layout object
10626     *
10627     * Once the content object is set, a previously set one will be deleted.
10628     * If you want to keep that old content object, use the
10629     * elm_object_part_content_unset() function.
10630     *
10631     * @note In an Edje theme, the part used as a content container is called @c
10632     * SWALLOW. This is why the parameter name is called @p swallow, but it is
10633     * expected to be a part name just like the second parameter of
10634     * elm_layout_box_append().
10635     *
10636     * @see elm_layout_box_append()
10637     * @see elm_object_part_content_get()
10638     * @see elm_object_part_content_unset()
10639     * @see @ref secBox
10640     * @deprecated use elm_object_part_content_set() instead
10641     *
10642     * @ingroup Layout
10643     */
10644    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10645
10646    /**
10647     * Get the child object in the given content part.
10648     *
10649     * @param obj The layout object
10650     * @param swallow The SWALLOW part to get its content
10651     *
10652     * @return The swallowed object or NULL if none or an error occurred
10653     *
10654     * @deprecated use elm_object_part_content_get() instead
10655     *
10656     * @ingroup Layout
10657     */
10658    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10659
10660    /**
10661     * Unset the layout content.
10662     *
10663     * @param obj The layout object
10664     * @param swallow The swallow part name in the edje file
10665     * @return The content that was being used
10666     *
10667     * Unparent and return the content object which was set for this part.
10668     *
10669     * @deprecated use elm_object_part_content_unset() instead
10670     *
10671     * @ingroup Layout
10672     */
10673    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10674
10675    /**
10676     * Set the text of the given part
10677     *
10678     * @param obj The layout object
10679     * @param part The TEXT part where to set the text
10680     * @param text The text to set
10681     *
10682     * @ingroup Layout
10683     * @deprecated use elm_object_part_text_set() instead.
10684     */
10685    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10686
10687    /**
10688     * Get the text set in the given part
10689     *
10690     * @param obj The layout object
10691     * @param part The TEXT part to retrieve the text off
10692     *
10693     * @return The text set in @p part
10694     *
10695     * @ingroup Layout
10696     * @deprecated use elm_object_part_text_get() instead.
10697     */
10698    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10699
10700    /**
10701     * Append child to layout box part.
10702     *
10703     * @param obj the layout object
10704     * @param part the box part to which the object will be appended.
10705     * @param child the child object to append to box.
10706     *
10707     * Once the object is appended, it will become child of the layout. Its
10708     * lifetime will be bound to the layout, whenever the layout dies the child
10709     * will be deleted automatically. One should use elm_layout_box_remove() to
10710     * make this layout forget about the object.
10711     *
10712     * @see elm_layout_box_prepend()
10713     * @see elm_layout_box_insert_before()
10714     * @see elm_layout_box_insert_at()
10715     * @see elm_layout_box_remove()
10716     *
10717     * @ingroup Layout
10718     */
10719    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10720
10721    /**
10722     * Prepend child to layout box part.
10723     *
10724     * @param obj the layout object
10725     * @param part the box part to prepend.
10726     * @param child the child object to prepend to box.
10727     *
10728     * Once the object is prepended, it will become child of the layout. Its
10729     * lifetime will be bound to the layout, whenever the layout dies the child
10730     * will be deleted automatically. One should use elm_layout_box_remove() to
10731     * make this layout forget about the object.
10732     *
10733     * @see elm_layout_box_append()
10734     * @see elm_layout_box_insert_before()
10735     * @see elm_layout_box_insert_at()
10736     * @see elm_layout_box_remove()
10737     *
10738     * @ingroup Layout
10739     */
10740    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10741
10742    /**
10743     * Insert child to layout box part before a reference object.
10744     *
10745     * @param obj the layout object
10746     * @param part the box part to insert.
10747     * @param child the child object to insert into box.
10748     * @param reference another reference object to insert before in box.
10749     *
10750     * Once the object is inserted, it will become child of the layout. Its
10751     * lifetime will be bound to the layout, whenever the layout dies the child
10752     * will be deleted automatically. One should use elm_layout_box_remove() to
10753     * make this layout forget about the object.
10754     *
10755     * @see elm_layout_box_append()
10756     * @see elm_layout_box_prepend()
10757     * @see elm_layout_box_insert_before()
10758     * @see elm_layout_box_remove()
10759     *
10760     * @ingroup Layout
10761     */
10762    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10763
10764    /**
10765     * Insert child to layout box part at a given position.
10766     *
10767     * @param obj the layout object
10768     * @param part the box part to insert.
10769     * @param child the child object to insert into box.
10770     * @param pos the numeric position >=0 to insert the child.
10771     *
10772     * Once the object is inserted, it will become child of the layout. Its
10773     * lifetime will be bound to the layout, whenever the layout dies the child
10774     * will be deleted automatically. One should use elm_layout_box_remove() to
10775     * make this layout forget about the object.
10776     *
10777     * @see elm_layout_box_append()
10778     * @see elm_layout_box_prepend()
10779     * @see elm_layout_box_insert_before()
10780     * @see elm_layout_box_remove()
10781     *
10782     * @ingroup Layout
10783     */
10784    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10785
10786    /**
10787     * Remove a child of the given part box.
10788     *
10789     * @param obj The layout object
10790     * @param part The box part name to remove child.
10791     * @param child The object to remove from box.
10792     * @return The object that was being used, or NULL if not found.
10793     *
10794     * The object will be removed from the box part and its lifetime will
10795     * not be handled by the layout anymore. This is equivalent to
10796     * elm_object_part_content_unset() for box.
10797     *
10798     * @see elm_layout_box_append()
10799     * @see elm_layout_box_remove_all()
10800     *
10801     * @ingroup Layout
10802     */
10803    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10804
10805    /**
10806     * Remove all children of the given part box.
10807     *
10808     * @param obj The layout object
10809     * @param part The box part name to remove child.
10810     * @param clear If EINA_TRUE, then all objects will be deleted as
10811     *        well, otherwise they will just be removed and will be
10812     *        dangling on the canvas.
10813     *
10814     * The objects will be removed from the box part and their lifetime will
10815     * not be handled by the layout anymore. This is equivalent to
10816     * elm_layout_box_remove() for all box children.
10817     *
10818     * @see elm_layout_box_append()
10819     * @see elm_layout_box_remove()
10820     *
10821     * @ingroup Layout
10822     */
10823    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10824
10825    /**
10826     * Insert child to layout table part.
10827     *
10828     * @param obj the layout object
10829     * @param part the box part to pack child.
10830     * @param child_obj the child object to pack into table.
10831     * @param col the column to which the child should be added. (>= 0)
10832     * @param row the row to which the child should be added. (>= 0)
10833     * @param colspan how many columns should be used to store this object. (>=
10834     *        1)
10835     * @param rowspan how many rows should be used to store this object. (>= 1)
10836     *
10837     * Once the object is inserted, it will become child of the table. Its
10838     * lifetime will be bound to the layout, and whenever the layout dies the
10839     * child will be deleted automatically. One should use
10840     * elm_layout_table_remove() to make this layout forget about the object.
10841     *
10842     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10843     * more space than a single cell. For instance, the following code:
10844     * @code
10845     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10846     * @endcode
10847     *
10848     * Would result in an object being added like the following picture:
10849     *
10850     * @image html layout_colspan.png
10851     * @image latex layout_colspan.eps width=\textwidth
10852     *
10853     * @see elm_layout_table_unpack()
10854     * @see elm_layout_table_clear()
10855     *
10856     * @ingroup Layout
10857     */
10858    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);
10859
10860    /**
10861     * Unpack (remove) a child of the given part table.
10862     *
10863     * @param obj The layout object
10864     * @param part The table part name to remove child.
10865     * @param child_obj The object to remove from table.
10866     * @return The object that was being used, or NULL if not found.
10867     *
10868     * The object will be unpacked from the table part and its lifetime
10869     * will not be handled by the layout anymore. This is equivalent to
10870     * elm_object_part_content_unset() for table.
10871     *
10872     * @see elm_layout_table_pack()
10873     * @see elm_layout_table_clear()
10874     *
10875     * @ingroup Layout
10876     */
10877    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10878
10879    /**
10880     * Remove all the child objects of the given part table.
10881     *
10882     * @param obj The layout object
10883     * @param part The table part name to remove child.
10884     * @param clear If EINA_TRUE, then all objects will be deleted as
10885     *        well, otherwise they will just be removed and will be
10886     *        dangling on the canvas.
10887     *
10888     * The objects will be removed from the table part and their lifetime will
10889     * not be handled by the layout anymore. This is equivalent to
10890     * elm_layout_table_unpack() for all table children.
10891     *
10892     * @see elm_layout_table_pack()
10893     * @see elm_layout_table_unpack()
10894     *
10895     * @ingroup Layout
10896     */
10897    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10898
10899    /**
10900     * Get the edje layout
10901     *
10902     * @param obj The layout object
10903     *
10904     * @return A Evas_Object with the edje layout settings loaded
10905     * with function elm_layout_file_set
10906     *
10907     * This returns the edje object. It is not expected to be used to then
10908     * swallow objects via edje_object_part_swallow() for example. Use
10909     * elm_object_part_content_set() instead so child object handling and sizing is
10910     * done properly.
10911     *
10912     * @note This function should only be used if you really need to call some
10913     * low level Edje function on this edje object. All the common stuff (setting
10914     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10915     * with proper elementary functions.
10916     *
10917     * @see elm_object_signal_callback_add()
10918     * @see elm_object_signal_emit()
10919     * @see elm_object_part_text_set()
10920     * @see elm_object_part_content_set()
10921     * @see elm_layout_box_append()
10922     * @see elm_layout_table_pack()
10923     * @see elm_layout_data_get()
10924     *
10925     * @ingroup Layout
10926     */
10927    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10928
10929    /**
10930     * Get the edje data from the given layout
10931     *
10932     * @param obj The layout object
10933     * @param key The data key
10934     *
10935     * @return The edje data string
10936     *
10937     * This function fetches data specified inside the edje theme of this layout.
10938     * This function return NULL if data is not found.
10939     *
10940     * In EDC this comes from a data block within the group block that @p
10941     * obj was loaded from. E.g.
10942     *
10943     * @code
10944     * collections {
10945     *   group {
10946     *     name: "a_group";
10947     *     data {
10948     *       item: "key1" "value1";
10949     *       item: "key2" "value2";
10950     *     }
10951     *   }
10952     * }
10953     * @endcode
10954     *
10955     * @ingroup Layout
10956     */
10957    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10958
10959    /**
10960     * Eval sizing
10961     *
10962     * @param obj The layout object
10963     *
10964     * Manually forces a sizing re-evaluation. This is useful when the minimum
10965     * size required by the edje theme of this layout has changed. The change on
10966     * the minimum size required by the edje theme is not immediately reported to
10967     * the elementary layout, so one needs to call this function in order to tell
10968     * the widget (layout) that it needs to reevaluate its own size.
10969     *
10970     * The minimum size of the theme is calculated based on minimum size of
10971     * parts, the size of elements inside containers like box and table, etc. All
10972     * of this can change due to state changes, and that's when this function
10973     * should be called.
10974     *
10975     * Also note that a standard signal of "size,eval" "elm" emitted from the
10976     * edje object will cause this to happen too.
10977     *
10978     * @ingroup Layout
10979     */
10980    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10981
10982    /**
10983     * Sets a specific cursor for an edje part.
10984     *
10985     * @param obj The layout object.
10986     * @param part_name a part from loaded edje group.
10987     * @param cursor cursor name to use, see Elementary_Cursor.h
10988     *
10989     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10990     *         part not exists or it has "mouse_events: 0".
10991     *
10992     * @ingroup Layout
10993     */
10994    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10995
10996    /**
10997     * Get the cursor to be shown when mouse is over an edje part
10998     *
10999     * @param obj The layout object.
11000     * @param part_name a part from loaded edje group.
11001     * @return the cursor name.
11002     *
11003     * @ingroup Layout
11004     */
11005    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11006
11007    /**
11008     * Unsets a cursor previously set with elm_layout_part_cursor_set().
11009     *
11010     * @param obj The layout object.
11011     * @param part_name a part from loaded edje group, that had a cursor set
11012     *        with elm_layout_part_cursor_set().
11013     *
11014     * @ingroup Layout
11015     */
11016    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11017
11018    /**
11019     * Sets a specific cursor style for an edje part.
11020     *
11021     * @param obj The layout object.
11022     * @param part_name a part from loaded edje group.
11023     * @param style the theme style to use (default, transparent, ...)
11024     *
11025     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11026     *         part not exists or it did not had a cursor set.
11027     *
11028     * @ingroup Layout
11029     */
11030    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
11031
11032    /**
11033     * Gets a specific cursor style for an edje part.
11034     *
11035     * @param obj The layout object.
11036     * @param part_name a part from loaded edje group.
11037     *
11038     * @return the theme style in use, defaults to "default". If the
11039     *         object does not have a cursor set, then NULL is returned.
11040     *
11041     * @ingroup Layout
11042     */
11043    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11044
11045    /**
11046     * Sets if the cursor set should be searched on the theme or should use
11047     * the provided by the engine, only.
11048     *
11049     * @note before you set if should look on theme you should define a
11050     * cursor with elm_layout_part_cursor_set(). By default it will only
11051     * look for cursors provided by the engine.
11052     *
11053     * @param obj The layout object.
11054     * @param part_name a part from loaded edje group.
11055     * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
11056     *        or should also search on widget's theme as well (EINA_FALSE)
11057     *
11058     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
11059     *         part not exists or it did not had a cursor set.
11060     *
11061     * @ingroup Layout
11062     */
11063    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);
11064
11065    /**
11066     * Gets a specific cursor engine_only for an edje part.
11067     *
11068     * @param obj The layout object.
11069     * @param part_name a part from loaded edje group.
11070     *
11071     * @return whenever the cursor is just provided by engine or also from theme.
11072     *
11073     * @ingroup Layout
11074     */
11075    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
11076
11077 /**
11078  * @def elm_layout_icon_set
11079  * Convenience macro to set the icon object in a layout that follows the
11080  * Elementary naming convention for its parts.
11081  *
11082  * @ingroup Layout
11083  */
11084 #define elm_layout_icon_set(_ly, _obj) \
11085   do { \
11086     const char *sig; \
11087     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
11088     if ((_obj)) sig = "elm,state,icon,visible"; \
11089     else sig = "elm,state,icon,hidden"; \
11090     elm_object_signal_emit((_ly), sig, "elm"); \
11091   } while (0)
11092
11093 /**
11094  * @def elm_layout_icon_get
11095  * Convienience macro to get the icon object from a layout that follows the
11096  * Elementary naming convention for its parts.
11097  *
11098  * @ingroup Layout
11099  */
11100 #define elm_layout_icon_get(_ly) \
11101   elm_object_part_content_get((_ly), "elm.swallow.icon")
11102
11103 /**
11104  * @def elm_layout_end_set
11105  * Convienience macro to set the end object in a layout that follows the
11106  * Elementary naming convention for its parts.
11107  *
11108  * @ingroup Layout
11109  */
11110 #define elm_layout_end_set(_ly, _obj) \
11111   do { \
11112     const char *sig; \
11113     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
11114     if ((_obj)) sig = "elm,state,end,visible"; \
11115     else sig = "elm,state,end,hidden"; \
11116     elm_object_signal_emit((_ly), sig, "elm"); \
11117   } while (0)
11118
11119 /**
11120  * @def elm_layout_end_get
11121  * Convienience macro to get the end object in a layout that follows the
11122  * Elementary naming convention for its parts.
11123  *
11124  * @ingroup Layout
11125  */
11126 #define elm_layout_end_get(_ly) \
11127   elm_object_part_content_get((_ly), "elm.swallow.end")
11128
11129 /**
11130  * @def elm_layout_label_set
11131  * Convienience macro to set the label in a layout that follows the
11132  * Elementary naming convention for its parts.
11133  *
11134  * @ingroup Layout
11135  * @deprecated use elm_object_text_set() instead.
11136  */
11137 #define elm_layout_label_set(_ly, _txt) \
11138   elm_layout_text_set((_ly), "elm.text", (_txt))
11139
11140 /**
11141  * @def elm_layout_label_get
11142  * Convenience macro to get the label in a layout that follows the
11143  * Elementary naming convention for its parts.
11144  *
11145  * @ingroup Layout
11146  * @deprecated use elm_object_text_set() instead.
11147  */
11148 #define elm_layout_label_get(_ly) \
11149   elm_layout_text_get((_ly), "elm.text")
11150
11151    /* smart callbacks called:
11152     * "theme,changed" - when elm theme is changed.
11153     */
11154
11155    /**
11156     * @defgroup Notify Notify
11157     *
11158     * @image html img/widget/notify/preview-00.png
11159     * @image latex img/widget/notify/preview-00.eps
11160     *
11161     * Display a container in a particular region of the parent(top, bottom,
11162     * etc).  A timeout can be set to automatically hide the notify. This is so
11163     * that, after an evas_object_show() on a notify object, if a timeout was set
11164     * on it, it will @b automatically get hidden after that time.
11165     *
11166     * Signals that you can add callbacks for are:
11167     * @li "timeout" - when timeout happens on notify and it's hidden
11168     * @li "block,clicked" - when a click outside of the notify happens
11169     *
11170     * Default contents parts of the notify widget that you can use for are:
11171     * @li "default" - A content of the notify
11172     *
11173     * @ref tutorial_notify show usage of the API.
11174     *
11175     * @{
11176     */
11177
11178    /**
11179     * @brief Possible orient values for notify.
11180     *
11181     * This values should be used in conjunction to elm_notify_orient_set() to
11182     * set the position in which the notify should appear(relative to its parent)
11183     * and in conjunction with elm_notify_orient_get() to know where the notify
11184     * is appearing.
11185     */
11186    typedef enum _Elm_Notify_Orient
11187      {
11188         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
11189         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
11190         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
11191         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
11192         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
11193         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
11194         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
11195         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
11196         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
11197         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
11198      } Elm_Notify_Orient;
11199
11200    /**
11201     * @brief Add a new notify to the parent
11202     *
11203     * @param parent The parent object
11204     * @return The new object or NULL if it cannot be created
11205     */
11206    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11207
11208    /**
11209     * @brief Set the content of the notify widget
11210     *
11211     * @param obj The notify object
11212     * @param content The content will be filled in this notify object
11213     *
11214     * Once the content object is set, a previously set one will be deleted. If
11215     * you want to keep that old content object, use the
11216     * elm_notify_content_unset() function.
11217     *
11218     * @deprecated use elm_object_content_set() instead
11219     *
11220     */
11221    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11222
11223    /**
11224     * @brief Unset the content of the notify widget
11225     *
11226     * @param obj The notify object
11227     * @return The content that was being used
11228     *
11229     * Unparent and return the content object which was set for this widget
11230     *
11231     * @see elm_notify_content_set()
11232     * @deprecated use elm_object_content_unset() instead
11233     *
11234     */
11235    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11236
11237    /**
11238     * @brief Return the content of the notify widget
11239     *
11240     * @param obj The notify object
11241     * @return The content that is being used
11242     *
11243     * @see elm_notify_content_set()
11244     * @deprecated use elm_object_content_get() instead
11245     *
11246     */
11247    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11248
11249    /**
11250     * @brief Set the notify parent
11251     *
11252     * @param obj The notify object
11253     * @param content The new parent
11254     *
11255     * Once the parent object is set, a previously set one will be disconnected
11256     * and replaced.
11257     */
11258    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11259
11260    /**
11261     * @brief Get the notify parent
11262     *
11263     * @param obj The notify object
11264     * @return The parent
11265     *
11266     * @see elm_notify_parent_set()
11267     */
11268    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11269
11270    /**
11271     * @brief Set the orientation
11272     *
11273     * @param obj The notify object
11274     * @param orient The new orientation
11275     *
11276     * Sets the position in which the notify will appear in its parent.
11277     *
11278     * @see @ref Elm_Notify_Orient for possible values.
11279     */
11280    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
11281
11282    /**
11283     * @brief Return the orientation
11284     * @param obj The notify object
11285     * @return The orientation of the notification
11286     *
11287     * @see elm_notify_orient_set()
11288     * @see Elm_Notify_Orient
11289     */
11290    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11291
11292    /**
11293     * @brief Set the time interval after which the notify window is going to be
11294     * hidden.
11295     *
11296     * @param obj The notify object
11297     * @param time The timeout in seconds
11298     *
11299     * This function sets a timeout and starts the timer controlling when the
11300     * notify is hidden. Since calling evas_object_show() on a notify restarts
11301     * the timer controlling when the notify is hidden, setting this before the
11302     * notify is shown will in effect mean starting the timer when the notify is
11303     * shown.
11304     *
11305     * @note Set a value <= 0.0 to disable a running timer.
11306     *
11307     * @note If the value > 0.0 and the notify is previously visible, the
11308     * timer will be started with this value, canceling any running timer.
11309     */
11310    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
11311
11312    /**
11313     * @brief Return the timeout value (in seconds)
11314     * @param obj the notify object
11315     *
11316     * @see elm_notify_timeout_set()
11317     */
11318    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11319
11320    /**
11321     * @brief Sets whether events should be passed to by a click outside
11322     * its area.
11323     *
11324     * @param obj The notify object
11325     * @param repeats EINA_TRUE Events are repeats, else no
11326     *
11327     * When true if the user clicks outside the window the events will be caught
11328     * by the others widgets, else the events are blocked.
11329     *
11330     * @note The default value is EINA_TRUE.
11331     */
11332    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
11333
11334    /**
11335     * @brief Return true if events are repeat below the notify object
11336     * @param obj the notify object
11337     *
11338     * @see elm_notify_repeat_events_set()
11339     */
11340    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11341
11342    /**
11343     * @}
11344     */
11345
11346    /**
11347     * @defgroup Hover Hover
11348     *
11349     * @image html img/widget/hover/preview-00.png
11350     * @image latex img/widget/hover/preview-00.eps
11351     *
11352     * A Hover object will hover over its @p parent object at the @p target
11353     * location. Anything in the background will be given a darker coloring to
11354     * indicate that the hover object is on top (at the default theme). When the
11355     * hover is clicked it is dismissed(hidden), if the contents of the hover are
11356     * clicked that @b doesn't cause the hover to be dismissed.
11357     *
11358     * A Hover object has two parents. One parent that owns it during creation
11359     * and the other parent being the one over which the hover object spans.
11360     *
11361     *
11362     * @note The hover object will take up the entire space of @p target
11363     * object.
11364     *
11365     * Elementary has the following styles for the hover widget:
11366     * @li default
11367     * @li popout
11368     * @li menu
11369     * @li hoversel_vertical
11370     *
11371     * The following are the available position for content:
11372     * @li left
11373     * @li top-left
11374     * @li top
11375     * @li top-right
11376     * @li right
11377     * @li bottom-right
11378     * @li bottom
11379     * @li bottom-left
11380     * @li middle
11381     * @li smart
11382     *
11383     * Signals that you can add callbacks for are:
11384     * @li "clicked" - the user clicked the empty space in the hover to dismiss
11385     * @li "smart,changed" - a content object placed under the "smart"
11386     *                   policy was replaced to a new slot direction.
11387     *
11388     * See @ref tutorial_hover for more information.
11389     *
11390     * @{
11391     */
11392    typedef enum _Elm_Hover_Axis
11393      {
11394         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
11395         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
11396         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
11397         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
11398      } Elm_Hover_Axis;
11399
11400    /**
11401     * @brief Adds a hover object to @p parent
11402     *
11403     * @param parent The parent object
11404     * @return The hover object or NULL if one could not be created
11405     */
11406    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11407
11408    /**
11409     * @brief Sets the target object for the hover.
11410     *
11411     * @param obj The hover object
11412     * @param target The object to center the hover onto.
11413     *
11414     * This function will cause the hover to be centered on the target object.
11415     */
11416    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
11417
11418    /**
11419     * @brief Gets the target object for the hover.
11420     *
11421     * @param obj The hover object
11422     * @return The target object for the hover.
11423     *
11424     * @see elm_hover_target_set()
11425     */
11426    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11427
11428    /**
11429     * @brief Sets the parent object for the hover.
11430     *
11431     * @param obj The hover object
11432     * @param parent The object to locate the hover over.
11433     *
11434     * This function will cause the hover to take up the entire space that the
11435     * parent object fills.
11436     */
11437    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11438
11439    /**
11440     * @brief Gets the parent object for the hover.
11441     *
11442     * @param obj The hover object
11443     * @return The parent object to locate the hover over.
11444     *
11445     * @see elm_hover_parent_set()
11446     */
11447    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11448
11449    /**
11450     * @brief Sets the content of the hover object and the direction in which it
11451     * will pop out.
11452     *
11453     * @param obj The hover object
11454     * @param swallow The direction that the object will be displayed
11455     * at. Accepted values are "left", "top-left", "top", "top-right",
11456     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
11457     * "smart".
11458     * @param content The content to place at @p swallow
11459     *
11460     * Once the content object is set for a given direction, a previously
11461     * set one (on the same direction) will be deleted. If you want to
11462     * keep that old content object, use the elm_hover_content_unset()
11463     * function.
11464     *
11465     * All directions may have contents at the same time, except for
11466     * "smart". This is a special placement hint and its use case
11467     * independs of the calculations coming from
11468     * elm_hover_best_content_location_get(). Its use is for cases when
11469     * one desires only one hover content, but with a dynamic special
11470     * placement within the hover area. The content's geometry, whenever
11471     * it changes, will be used to decide on a best location, not
11472     * extrapolating the hover's parent object view to show it in (still
11473     * being the hover's target determinant of its medium part -- move and
11474     * resize it to simulate finger sizes, for example). If one of the
11475     * directions other than "smart" are used, a previously content set
11476     * using it will be deleted, and vice-versa.
11477     */
11478    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
11479
11480    /**
11481     * @brief Get the content of the hover object, in a given direction.
11482     *
11483     * Return the content object which was set for this widget in the
11484     * @p swallow direction.
11485     *
11486     * @param obj The hover object
11487     * @param swallow The direction that the object was display at.
11488     * @return The content that was being used
11489     *
11490     * @see elm_hover_content_set()
11491     */
11492    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11493
11494    /**
11495     * @brief Unset the content of the hover object, in a given direction.
11496     *
11497     * Unparent and return the content object set at @p swallow direction.
11498     *
11499     * @param obj The hover object
11500     * @param swallow The direction that the object was display at.
11501     * @return The content that was being used.
11502     *
11503     * @see elm_hover_content_set()
11504     */
11505    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
11506
11507    /**
11508     * @brief Returns the best swallow location for content in the hover.
11509     *
11510     * @param obj The hover object
11511     * @param pref_axis The preferred orientation axis for the hover object to use
11512     * @return The edje location to place content into the hover or @c
11513     *         NULL, on errors.
11514     *
11515     * Best is defined here as the location at which there is the most available
11516     * space.
11517     *
11518     * @p pref_axis may be one of
11519     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
11520     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
11521     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
11522     * - @c ELM_HOVER_AXIS_BOTH -- both
11523     *
11524     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
11525     * nescessarily be along the horizontal axis("left" or "right"). If
11526     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
11527     * be along the vertical axis("top" or "bottom"). Chossing
11528     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
11529     * returned position may be in either axis.
11530     *
11531     * @see elm_hover_content_set()
11532     */
11533    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
11534
11535    /**
11536     * @}
11537     */
11538
11539    /* entry */
11540    /**
11541     * @defgroup Entry Entry
11542     *
11543     * @image html img/widget/entry/preview-00.png
11544     * @image latex img/widget/entry/preview-00.eps width=\textwidth
11545     * @image html img/widget/entry/preview-01.png
11546     * @image latex img/widget/entry/preview-01.eps width=\textwidth
11547     * @image html img/widget/entry/preview-02.png
11548     * @image latex img/widget/entry/preview-02.eps width=\textwidth
11549     * @image html img/widget/entry/preview-03.png
11550     * @image latex img/widget/entry/preview-03.eps width=\textwidth
11551     *
11552     * An entry is a convenience widget which shows a box that the user can
11553     * enter text into. Entries by default don't scroll, so they grow to
11554     * accomodate the entire text, resizing the parent window as needed. This
11555     * can be changed with the elm_entry_scrollable_set() function.
11556     *
11557     * They can also be single line or multi line (the default) and when set
11558     * to multi line mode they support text wrapping in any of the modes
11559     * indicated by #Elm_Wrap_Type.
11560     *
11561     * Other features include password mode, filtering of inserted text with
11562     * elm_entry_text_filter_append() and related functions, inline "items" and
11563     * formatted markup text.
11564     *
11565     * @section entry-markup Formatted text
11566     *
11567     * The markup tags supported by the Entry are defined by the theme, but
11568     * even when writing new themes or extensions it's a good idea to stick to
11569     * a sane default, to maintain coherency and avoid application breakages.
11570     * Currently defined by the default theme are the following tags:
11571     * @li \<br\>: Inserts a line break.
11572     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
11573     * breaks.
11574     * @li \<tab\>: Inserts a tab.
11575     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
11576     * enclosed text.
11577     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
11578     * @li \<link\>...\</link\>: Underlines the enclosed text.
11579     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
11580     *
11581     * @section entry-special Special markups
11582     *
11583     * Besides those used to format text, entries support two special markup
11584     * tags used to insert clickable portions of text or items inlined within
11585     * the text.
11586     *
11587     * @subsection entry-anchors Anchors
11588     *
11589     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
11590     * \</a\> tags and an event will be generated when this text is clicked,
11591     * like this:
11592     *
11593     * @code
11594     * This text is outside <a href=anc-01>but this one is an anchor</a>
11595     * @endcode
11596     *
11597     * The @c href attribute in the opening tag gives the name that will be
11598     * used to identify the anchor and it can be any valid utf8 string.
11599     *
11600     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
11601     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
11602     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
11603     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
11604     * an anchor.
11605     *
11606     * @subsection entry-items Items
11607     *
11608     * Inlined in the text, any other @c Evas_Object can be inserted by using
11609     * \<item\> tags this way:
11610     *
11611     * @code
11612     * <item size=16x16 vsize=full href=emoticon/haha></item>
11613     * @endcode
11614     *
11615     * Just like with anchors, the @c href identifies each item, but these need,
11616     * in addition, to indicate their size, which is done using any one of
11617     * @c size, @c absize or @c relsize attributes. These attributes take their
11618     * value in the WxH format, where W is the width and H the height of the
11619     * item.
11620     *
11621     * @li absize: Absolute pixel size for the item. Whatever value is set will
11622     * be the item's size regardless of any scale value the object may have
11623     * been set to. The final line height will be adjusted to fit larger items.
11624     * @li size: Similar to @c absize, but it's adjusted to the scale value set
11625     * for the object.
11626     * @li relsize: Size is adjusted for the item to fit within the current
11627     * line height.
11628     *
11629     * Besides their size, items are specificed a @c vsize value that affects
11630     * how their final size and position are calculated. The possible values
11631     * are:
11632     * @li ascent: Item will be placed within the line's baseline and its
11633     * ascent. That is, the height between the line where all characters are
11634     * positioned and the highest point in the line. For @c size and @c absize
11635     * items, the descent value will be added to the total line height to make
11636     * them fit. @c relsize items will be adjusted to fit within this space.
11637     * @li full: Items will be placed between the descent and ascent, or the
11638     * lowest point in the line and its highest.
11639     *
11640     * The next image shows different configurations of items and how
11641     * the previously mentioned options affect their sizes. In all cases,
11642     * the green line indicates the ascent, blue for the baseline and red for
11643     * the descent.
11644     *
11645     * @image html entry_item.png
11646     * @image latex entry_item.eps width=\textwidth
11647     *
11648     * And another one to show how size differs from absize. In the first one,
11649     * the scale value is set to 1.0, while the second one is using one of 2.0.
11650     *
11651     * @image html entry_item_scale.png
11652     * @image latex entry_item_scale.eps width=\textwidth
11653     *
11654     * After the size for an item is calculated, the entry will request an
11655     * object to place in its space. For this, the functions set with
11656     * elm_entry_item_provider_append() and related functions will be called
11657     * in order until one of them returns a @c non-NULL value. If no providers
11658     * are available, or all of them return @c NULL, then the entry falls back
11659     * to one of the internal defaults, provided the name matches with one of
11660     * them.
11661     *
11662     * All of the following are currently supported:
11663     *
11664     * - emoticon/angry
11665     * - emoticon/angry-shout
11666     * - emoticon/crazy-laugh
11667     * - emoticon/evil-laugh
11668     * - emoticon/evil
11669     * - emoticon/goggle-smile
11670     * - emoticon/grumpy
11671     * - emoticon/grumpy-smile
11672     * - emoticon/guilty
11673     * - emoticon/guilty-smile
11674     * - emoticon/haha
11675     * - emoticon/half-smile
11676     * - emoticon/happy-panting
11677     * - emoticon/happy
11678     * - emoticon/indifferent
11679     * - emoticon/kiss
11680     * - emoticon/knowing-grin
11681     * - emoticon/laugh
11682     * - emoticon/little-bit-sorry
11683     * - emoticon/love-lots
11684     * - emoticon/love
11685     * - emoticon/minimal-smile
11686     * - emoticon/not-happy
11687     * - emoticon/not-impressed
11688     * - emoticon/omg
11689     * - emoticon/opensmile
11690     * - emoticon/smile
11691     * - emoticon/sorry
11692     * - emoticon/squint-laugh
11693     * - emoticon/surprised
11694     * - emoticon/suspicious
11695     * - emoticon/tongue-dangling
11696     * - emoticon/tongue-poke
11697     * - emoticon/uh
11698     * - emoticon/unhappy
11699     * - emoticon/very-sorry
11700     * - emoticon/what
11701     * - emoticon/wink
11702     * - emoticon/worried
11703     * - emoticon/wtf
11704     *
11705     * Alternatively, an item may reference an image by its path, using
11706     * the URI form @c file:///path/to/an/image.png and the entry will then
11707     * use that image for the item.
11708     *
11709     * @section entry-files Loading and saving files
11710     *
11711     * Entries have convinience functions to load text from a file and save
11712     * changes back to it after a short delay. The automatic saving is enabled
11713     * by default, but can be disabled with elm_entry_autosave_set() and files
11714     * can be loaded directly as plain text or have any markup in them
11715     * recognized. See elm_entry_file_set() for more details.
11716     *
11717     * @section entry-signals Emitted signals
11718     *
11719     * This widget emits the following signals:
11720     *
11721     * @li "changed": The text within the entry was changed.
11722     * @li "changed,user": The text within the entry was changed because of user interaction.
11723     * @li "activated": The enter key was pressed on a single line entry.
11724     * @li "press": A mouse button has been pressed on the entry.
11725     * @li "longpressed": A mouse button has been pressed and held for a couple
11726     * seconds.
11727     * @li "clicked": The entry has been clicked (mouse press and release).
11728     * @li "clicked,double": The entry has been double clicked.
11729     * @li "clicked,triple": The entry has been triple clicked.
11730     * @li "focused": The entry has received focus.
11731     * @li "unfocused": The entry has lost focus.
11732     * @li "selection,paste": A paste of the clipboard contents was requested.
11733     * @li "selection,copy": A copy of the selected text into the clipboard was
11734     * requested.
11735     * @li "selection,cut": A cut of the selected text into the clipboard was
11736     * requested.
11737     * @li "selection,start": A selection has begun and no previous selection
11738     * existed.
11739     * @li "selection,changed": The current selection has changed.
11740     * @li "selection,cleared": The current selection has been cleared.
11741     * @li "cursor,changed": The cursor has changed position.
11742     * @li "anchor,clicked": An anchor has been clicked. The event_info
11743     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11744     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11745     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11746     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11747     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11748     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11749     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11750     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11751     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11752     * @li "preedit,changed": The preedit string has changed.
11753     * @li "language,changed": Program language changed.
11754     *
11755     * @section entry-examples
11756     *
11757     * An overview of the Entry API can be seen in @ref entry_example_01
11758     *
11759     * @{
11760     */
11761
11762    /**
11763     * @typedef Elm_Entry_Anchor_Info
11764     *
11765     * The info sent in the callback for the "anchor,clicked" signals emitted
11766     * by entries.
11767     */
11768    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11769
11770    /**
11771     * @struct _Elm_Entry_Anchor_Info
11772     *
11773     * The info sent in the callback for the "anchor,clicked" signals emitted
11774     * by entries.
11775     */
11776    struct _Elm_Entry_Anchor_Info
11777      {
11778         const char *name; /**< The name of the anchor, as stated in its href */
11779         int         button; /**< The mouse button used to click on it */
11780         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11781                     y, /**< Anchor geometry, relative to canvas */
11782                     w, /**< Anchor geometry, relative to canvas */
11783                     h; /**< Anchor geometry, relative to canvas */
11784      };
11785
11786    /**
11787     * @typedef Elm_Entry_Filter_Cb
11788     * This callback type is used by entry filters to modify text.
11789     * @param data The data specified as the last param when adding the filter
11790     * @param entry The entry object
11791     * @param text A pointer to the location of the text being filtered. This data can be modified,
11792     * but any additional allocations must be managed by the user.
11793     * @see elm_entry_text_filter_append
11794     * @see elm_entry_text_filter_prepend
11795     */
11796    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11797
11798    /**
11799     * @typedef Elm_Entry_Change_Info
11800     * This corresponds to Edje_Entry_Change_Info. Includes information about
11801     * a change in the entry.
11802     */
11803    typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
11804
11805
11806    /**
11807     * This adds an entry to @p parent object.
11808     *
11809     * By default, entries are:
11810     * @li not scrolled
11811     * @li multi-line
11812     * @li word wrapped
11813     * @li autosave is enabled
11814     *
11815     * @param parent The parent object
11816     * @return The new object or NULL if it cannot be created
11817     */
11818    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11819
11820    /**
11821     * Sets the entry to single line mode.
11822     *
11823     * In single line mode, entries don't ever wrap when the text reaches the
11824     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11825     * key will generate an @c "activate" event instead of adding a new line.
11826     *
11827     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11828     * and pressing enter will break the text into a different line
11829     * without generating any events.
11830     *
11831     * @param obj The entry object
11832     * @param single_line If true, the text in the entry
11833     * will be on a single line.
11834     */
11835    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11836
11837    /**
11838     * Gets whether the entry is set to be single line.
11839     *
11840     * @param obj The entry object
11841     * @return single_line If true, the text in the entry is set to display
11842     * on a single line.
11843     *
11844     * @see elm_entry_single_line_set()
11845     */
11846    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11847
11848    /**
11849     * Sets the entry to password mode.
11850     *
11851     * In password mode, entries are implicitly single line and the display of
11852     * any text in them is replaced with asterisks (*).
11853     *
11854     * @param obj The entry object
11855     * @param password If true, password mode is enabled.
11856     */
11857    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11858
11859    /**
11860     * Gets whether the entry is set to password mode.
11861     *
11862     * @param obj The entry object
11863     * @return If true, the entry is set to display all characters
11864     * as asterisks (*).
11865     *
11866     * @see elm_entry_password_set()
11867     */
11868    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11869
11870    /**
11871     * This sets the text displayed within the entry to @p entry.
11872     *
11873     * @param obj The entry object
11874     * @param entry The text to be displayed
11875     *
11876     * @deprecated Use elm_object_text_set() instead.
11877     * @note Using this function bypasses text filters
11878     */
11879    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11880
11881    /**
11882     * This returns the text currently shown in object @p entry.
11883     * See also elm_entry_entry_set().
11884     *
11885     * @param obj The entry object
11886     * @return The currently displayed text or NULL on failure
11887     *
11888     * @deprecated Use elm_object_text_get() instead.
11889     */
11890    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11891
11892    /**
11893     * Appends @p entry to the text of the entry.
11894     *
11895     * Adds the text in @p entry to the end of any text already present in the
11896     * widget.
11897     *
11898     * The appended text is subject to any filters set for the widget.
11899     *
11900     * @param obj The entry object
11901     * @param entry The text to be displayed
11902     *
11903     * @see elm_entry_text_filter_append()
11904     */
11905    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11906
11907    /**
11908     * Gets whether the entry is empty.
11909     *
11910     * Empty means no text at all. If there are any markup tags, like an item
11911     * tag for which no provider finds anything, and no text is displayed, this
11912     * function still returns EINA_FALSE.
11913     *
11914     * @param obj The entry object
11915     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11916     */
11917    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11918
11919    /**
11920     * Gets any selected text within the entry.
11921     *
11922     * If there's any selected text in the entry, this function returns it as
11923     * a string in markup format. NULL is returned if no selection exists or
11924     * if an error occurred.
11925     *
11926     * The returned value points to an internal string and should not be freed
11927     * or modified in any way. If the @p entry object is deleted or its
11928     * contents are changed, the returned pointer should be considered invalid.
11929     *
11930     * @param obj The entry object
11931     * @return The selected text within the entry or NULL on failure
11932     */
11933    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11934
11935    /**
11936     * Returns the actual textblock object of the entry.
11937     *
11938     * This function exposes the internal textblock object that actually
11939     * contains and draws the text. This should be used for low-level
11940     * manipulations that are otherwise not possible.
11941     *
11942     * Changing the textblock directly from here will not notify edje/elm to
11943     * recalculate the textblock size automatically, so any modifications
11944     * done to the textblock returned by this function should be followed by
11945     * a call to elm_entry_calc_force().
11946     *
11947     * The return value is marked as const as an additional warning.
11948     * One should not use the returned object with any of the generic evas
11949     * functions (geometry_get/resize/move and etc), but only with the textblock
11950     * functions; The former will either not work at all, or break the correct
11951     * functionality.
11952     *
11953     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11954     * the internal textblock object. Do NOT cache the returned object, and try
11955     * not to mix calls on this object with regular elm_entry calls (which may
11956     * change the internal textblock object). This applies to all cursors
11957     * returned from textblock calls, and all the other derivative values.
11958     *
11959     * @param obj The entry object
11960     * @return The textblock object.
11961     */
11962    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11963
11964    /**
11965     * Forces calculation of the entry size and text layouting.
11966     *
11967     * This should be used after modifying the textblock object directly. See
11968     * elm_entry_textblock_get() for more information.
11969     *
11970     * @param obj The entry object
11971     *
11972     * @see elm_entry_textblock_get()
11973     */
11974    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11975
11976    /**
11977     * Inserts the given text into the entry at the current cursor position.
11978     *
11979     * This inserts text at the cursor position as if it was typed
11980     * by the user (note that this also allows markup which a user
11981     * can't just "type" as it would be converted to escaped text, so this
11982     * call can be used to insert things like emoticon items or bold push/pop
11983     * tags, other font and color change tags etc.)
11984     *
11985     * If any selection exists, it will be replaced by the inserted text.
11986     *
11987     * The inserted text is subject to any filters set for the widget.
11988     *
11989     * @param obj The entry object
11990     * @param entry The text to insert
11991     *
11992     * @see elm_entry_text_filter_append()
11993     */
11994    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11995
11996    /**
11997     * Set the line wrap type to use on multi-line entries.
11998     *
11999     * Sets the wrap type used by the entry to any of the specified in
12000     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
12001     * line (without inserting a line break or paragraph separator) when it
12002     * reaches the far edge of the widget.
12003     *
12004     * Note that this only makes sense for multi-line entries. A widget set
12005     * to be single line will never wrap.
12006     *
12007     * @param obj The entry object
12008     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
12009     */
12010    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
12011
12012    /**
12013     * Gets the wrap mode the entry was set to use.
12014     *
12015     * @param obj The entry object
12016     * @return Wrap type
12017     *
12018     * @see also elm_entry_line_wrap_set()
12019     */
12020    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12021
12022    /**
12023     * Sets if the entry is to be editable or not.
12024     *
12025     * By default, entries are editable and when focused, any text input by the
12026     * user will be inserted at the current cursor position. But calling this
12027     * function with @p editable as EINA_FALSE will prevent the user from
12028     * inputting text into the entry.
12029     *
12030     * The only way to change the text of a non-editable entry is to use
12031     * elm_object_text_set(), elm_entry_entry_insert() and other related
12032     * functions.
12033     *
12034     * @param obj The entry object
12035     * @param editable If EINA_TRUE, user input will be inserted in the entry,
12036     * if not, the entry is read-only and no user input is allowed.
12037     */
12038    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
12039
12040    /**
12041     * Gets whether the entry is editable or not.
12042     *
12043     * @param obj The entry object
12044     * @return If true, the entry is editable by the user.
12045     * If false, it is not editable by the user
12046     *
12047     * @see elm_entry_editable_set()
12048     */
12049    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12050
12051    /**
12052     * This drops any existing text selection within the entry.
12053     *
12054     * @param obj The entry object
12055     */
12056    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
12057
12058    /**
12059     * This selects all text within the entry.
12060     *
12061     * @param obj The entry object
12062     */
12063    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
12064
12065    /**
12066     * This moves the cursor one place to the right within the entry.
12067     *
12068     * @param obj The entry object
12069     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12070     */
12071    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
12072
12073    /**
12074     * This moves the cursor one place to the left within the entry.
12075     *
12076     * @param obj The entry object
12077     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12078     */
12079    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
12080
12081    /**
12082     * This moves the cursor one line up within the entry.
12083     *
12084     * @param obj The entry object
12085     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12086     */
12087    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
12088
12089    /**
12090     * This moves the cursor one line down within the entry.
12091     *
12092     * @param obj The entry object
12093     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12094     */
12095    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
12096
12097    /**
12098     * This moves the cursor to the beginning of the entry.
12099     *
12100     * @param obj The entry object
12101     */
12102    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12103
12104    /**
12105     * This moves the cursor to the end of the entry.
12106     *
12107     * @param obj The entry object
12108     */
12109    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12110
12111    /**
12112     * This moves the cursor to the beginning of the current line.
12113     *
12114     * @param obj The entry object
12115     */
12116    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12117
12118    /**
12119     * This moves the cursor to the end of the current line.
12120     *
12121     * @param obj The entry object
12122     */
12123    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
12124
12125    /**
12126     * This begins a selection within the entry as though
12127     * the user were holding down the mouse button to make a selection.
12128     *
12129     * @param obj The entry object
12130     */
12131    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12132
12133    /**
12134     * This ends a selection within the entry as though
12135     * the user had just released the mouse button while making a selection.
12136     *
12137     * @param obj The entry object
12138     */
12139    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12140
12141    /**
12142     * Gets whether a format node exists at the current cursor position.
12143     *
12144     * A format node is anything that defines how the text is rendered. It can
12145     * be a visible format node, such as a line break or a paragraph separator,
12146     * or an invisible one, such as bold begin or end tag.
12147     * This function returns whether any format node exists at the current
12148     * cursor position.
12149     *
12150     * @param obj The entry object
12151     * @return EINA_TRUE if the current cursor position contains a format node,
12152     * EINA_FALSE otherwise.
12153     *
12154     * @see elm_entry_cursor_is_visible_format_get()
12155     */
12156    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12157
12158    /**
12159     * Gets if the current cursor position holds a visible format node.
12160     *
12161     * @param obj The entry object
12162     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
12163     * if it's an invisible one or no format exists.
12164     *
12165     * @see elm_entry_cursor_is_format_get()
12166     */
12167    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12168
12169    /**
12170     * Gets the character pointed by the cursor at its current position.
12171     *
12172     * This function returns a string with the utf8 character stored at the
12173     * current cursor position.
12174     * Only the text is returned, any format that may exist will not be part
12175     * of the return value.
12176     *
12177     * @param obj The entry object
12178     * @return The text pointed by the cursors.
12179     */
12180    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12181
12182    /**
12183     * This function returns the geometry of the cursor.
12184     *
12185     * It's useful if you want to draw something on the cursor (or where it is),
12186     * or for example in the case of scrolled entry where you want to show the
12187     * cursor.
12188     *
12189     * @param obj The entry object
12190     * @param x returned geometry
12191     * @param y returned geometry
12192     * @param w returned geometry
12193     * @param h returned geometry
12194     * @return EINA_TRUE upon success, EINA_FALSE upon failure
12195     */
12196    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);
12197
12198    /**
12199     * Sets the cursor position in the entry to the given value
12200     *
12201     * The value in @p pos is the index of the character position within the
12202     * contents of the string as returned by elm_entry_cursor_pos_get().
12203     *
12204     * @param obj The entry object
12205     * @param pos The position of the cursor
12206     */
12207    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
12208
12209    /**
12210     * Retrieves the current position of the cursor in the entry
12211     *
12212     * @param obj The entry object
12213     * @return The cursor position
12214     */
12215    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12216
12217    /**
12218     * This executes a "cut" action on the selected text in the entry.
12219     *
12220     * @param obj The entry object
12221     */
12222    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
12223
12224    /**
12225     * This executes a "copy" action on the selected text in the entry.
12226     *
12227     * @param obj The entry object
12228     */
12229    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
12230
12231    /**
12232     * This executes a "paste" action in the entry.
12233     *
12234     * @param obj The entry object
12235     */
12236    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
12237
12238    /**
12239     * This clears and frees the items in a entry's contextual (longpress)
12240     * menu.
12241     *
12242     * @param obj The entry object
12243     *
12244     * @see elm_entry_context_menu_item_add()
12245     */
12246    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12247
12248    /**
12249     * This adds an item to the entry's contextual menu.
12250     *
12251     * A longpress on an entry will make the contextual menu show up, if this
12252     * hasn't been disabled with elm_entry_context_menu_disabled_set().
12253     * By default, this menu provides a few options like enabling selection mode,
12254     * which is useful on embedded devices that need to be explicit about it,
12255     * and when a selection exists it also shows the copy and cut actions.
12256     *
12257     * With this function, developers can add other options to this menu to
12258     * perform any action they deem necessary.
12259     *
12260     * @param obj The entry object
12261     * @param label The item's text label
12262     * @param icon_file The item's icon file
12263     * @param icon_type The item's icon type
12264     * @param func The callback to execute when the item is clicked
12265     * @param data The data to associate with the item for related functions
12266     */
12267    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);
12268
12269    /**
12270     * This disables the entry's contextual (longpress) menu.
12271     *
12272     * @param obj The entry object
12273     * @param disabled If true, the menu is disabled
12274     */
12275    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12276
12277    /**
12278     * This returns whether the entry's contextual (longpress) menu is
12279     * disabled.
12280     *
12281     * @param obj The entry object
12282     * @return If true, the menu is disabled
12283     */
12284    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12285
12286    /**
12287     * This appends a custom item provider to the list for that entry
12288     *
12289     * This appends the given callback. The list is walked from beginning to end
12290     * with each function called given the item href string in the text. If the
12291     * function returns an object handle other than NULL (it should create an
12292     * object to do this), then this object is used to replace that item. If
12293     * not the next provider is called until one provides an item object, or the
12294     * default provider in entry does.
12295     *
12296     * @param obj The entry object
12297     * @param func The function called to provide the item object
12298     * @param data The data passed to @p func
12299     *
12300     * @see @ref entry-items
12301     */
12302    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);
12303
12304    /**
12305     * This prepends a custom item provider to the list for that entry
12306     *
12307     * This prepends the given callback. See elm_entry_item_provider_append() for
12308     * more information
12309     *
12310     * @param obj The entry object
12311     * @param func The function called to provide the item object
12312     * @param data The data passed to @p func
12313     */
12314    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);
12315
12316    /**
12317     * This removes a custom item provider to the list for that entry
12318     *
12319     * This removes the given callback. See elm_entry_item_provider_append() for
12320     * more information
12321     *
12322     * @param obj The entry object
12323     * @param func The function called to provide the item object
12324     * @param data The data passed to @p func
12325     */
12326    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);
12327
12328    /**
12329     * Append a filter function for text inserted in the entry
12330     *
12331     * Append the given callback to the list. This functions will be called
12332     * whenever any text is inserted into the entry, with the text to be inserted
12333     * as a parameter. The callback function is free to alter the text in any way
12334     * it wants, but it must remember to free the given pointer and update it.
12335     * If the new text is to be discarded, the function can free it and set its
12336     * text parameter to NULL. This will also prevent any following filters from
12337     * being called.
12338     *
12339     * @param obj The entry object
12340     * @param func The function to use as text filter
12341     * @param data User data to pass to @p func
12342     */
12343    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12344
12345    /**
12346     * Prepend a filter function for text insdrted in the entry
12347     *
12348     * Prepend the given callback to the list. See elm_entry_text_filter_append()
12349     * for more information
12350     *
12351     * @param obj The entry object
12352     * @param func The function to use as text filter
12353     * @param data User data to pass to @p func
12354     */
12355    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12356
12357    /**
12358     * Remove a filter from the list
12359     *
12360     * Removes the given callback from the filter list. See
12361     * elm_entry_text_filter_append() for more information.
12362     *
12363     * @param obj The entry object
12364     * @param func The filter function to remove
12365     * @param data The user data passed when adding the function
12366     */
12367    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
12368
12369    /**
12370     * This converts a markup (HTML-like) string into UTF-8.
12371     *
12372     * The returned string is a malloc'ed buffer and it should be freed when
12373     * not needed anymore.
12374     *
12375     * @param s The string (in markup) to be converted
12376     * @return The converted string (in UTF-8). It should be freed.
12377     */
12378    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12379
12380    /**
12381     * This converts a UTF-8 string into markup (HTML-like).
12382     *
12383     * The returned string is a malloc'ed buffer and it should be freed when
12384     * not needed anymore.
12385     *
12386     * @param s The string (in UTF-8) to be converted
12387     * @return The converted string (in markup). It should be freed.
12388     */
12389    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
12390
12391    /**
12392     * This sets the file (and implicitly loads it) for the text to display and
12393     * then edit. All changes are written back to the file after a short delay if
12394     * the entry object is set to autosave (which is the default).
12395     *
12396     * If the entry had any other file set previously, any changes made to it
12397     * will be saved if the autosave feature is enabled, otherwise, the file
12398     * will be silently discarded and any non-saved changes will be lost.
12399     *
12400     * @param obj The entry object
12401     * @param file The path to the file to load and save
12402     * @param format The file format
12403     */
12404    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
12405
12406    /**
12407     * Gets the file being edited by the entry.
12408     *
12409     * This function can be used to retrieve any file set on the entry for
12410     * edition, along with the format used to load and save it.
12411     *
12412     * @param obj The entry object
12413     * @param file The path to the file to load and save
12414     * @param format The file format
12415     */
12416    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
12417
12418    /**
12419     * This function writes any changes made to the file set with
12420     * elm_entry_file_set()
12421     *
12422     * @param obj The entry object
12423     */
12424    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
12425
12426    /**
12427     * This sets the entry object to 'autosave' the loaded text file or not.
12428     *
12429     * @param obj The entry object
12430     * @param autosave Autosave the loaded file or not
12431     *
12432     * @see elm_entry_file_set()
12433     */
12434    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
12435
12436    /**
12437     * This gets the entry object's 'autosave' status.
12438     *
12439     * @param obj The entry object
12440     * @return Autosave the loaded file or not
12441     *
12442     * @see elm_entry_file_set()
12443     */
12444    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12445
12446    /**
12447     * Control pasting of text and images for the widget.
12448     *
12449     * Normally the entry allows both text and images to be pasted.  By setting
12450     * textonly to be true, this prevents images from being pasted.
12451     *
12452     * Note this only changes the behaviour of text.
12453     *
12454     * @param obj The entry object
12455     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
12456     * text+image+other.
12457     */
12458    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
12459
12460    /**
12461     * Getting elm_entry text paste/drop mode.
12462     *
12463     * In textonly mode, only text may be pasted or dropped into the widget.
12464     *
12465     * @param obj The entry object
12466     * @return If the widget only accepts text from pastes.
12467     */
12468    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12469
12470    /**
12471     * Enable or disable scrolling in entry
12472     *
12473     * Normally the entry is not scrollable unless you enable it with this call.
12474     *
12475     * @param obj The entry object
12476     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
12477     */
12478    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
12479
12480    /**
12481     * Get the scrollable state of the entry
12482     *
12483     * Normally the entry is not scrollable. This gets the scrollable state
12484     * of the entry. See elm_entry_scrollable_set() for more information.
12485     *
12486     * @param obj The entry object
12487     * @return The scrollable state
12488     */
12489    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
12490
12491    /**
12492     * This sets a widget to be displayed to the left of a scrolled entry.
12493     *
12494     * @param obj The scrolled entry object
12495     * @param icon The widget to display on the left side of the scrolled
12496     * entry.
12497     *
12498     * @note A previously set widget will be destroyed.
12499     * @note If the object being set does not have minimum size hints set,
12500     * it won't get properly displayed.
12501     *
12502     * @see elm_entry_end_set()
12503     */
12504    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
12505
12506    /**
12507     * Gets the leftmost widget of the scrolled entry. This object is
12508     * owned by the scrolled entry and should not be modified.
12509     *
12510     * @param obj The scrolled entry object
12511     * @return the left widget inside the scroller
12512     */
12513    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
12514
12515    /**
12516     * Unset the leftmost widget of the scrolled entry, unparenting and
12517     * returning it.
12518     *
12519     * @param obj The scrolled entry object
12520     * @return the previously set icon sub-object of this entry, on
12521     * success.
12522     *
12523     * @see elm_entry_icon_set()
12524     */
12525    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
12526
12527    /**
12528     * Sets the visibility of the left-side widget of the scrolled entry,
12529     * set by elm_entry_icon_set().
12530     *
12531     * @param obj The scrolled entry object
12532     * @param setting EINA_TRUE if the object should be displayed,
12533     * EINA_FALSE if not.
12534     */
12535    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
12536
12537    /**
12538     * This sets a widget to be displayed to the end of a scrolled entry.
12539     *
12540     * @param obj The scrolled entry object
12541     * @param end The widget to display on the right side of the scrolled
12542     * entry.
12543     *
12544     * @note A previously set widget will be destroyed.
12545     * @note If the object being set does not have minimum size hints set,
12546     * it won't get properly displayed.
12547     *
12548     * @see elm_entry_icon_set
12549     */
12550    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
12551
12552    /**
12553     * Gets the endmost widget of the scrolled entry. This object is owned
12554     * by the scrolled entry and should not be modified.
12555     *
12556     * @param obj The scrolled entry object
12557     * @return the right widget inside the scroller
12558     */
12559    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
12560
12561    /**
12562     * Unset the endmost widget of the scrolled entry, unparenting and
12563     * returning it.
12564     *
12565     * @param obj The scrolled entry object
12566     * @return the previously set icon sub-object of this entry, on
12567     * success.
12568     *
12569     * @see elm_entry_icon_set()
12570     */
12571    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
12572
12573    /**
12574     * Sets the visibility of the end widget of the scrolled entry, set by
12575     * elm_entry_end_set().
12576     *
12577     * @param obj The scrolled entry object
12578     * @param setting EINA_TRUE if the object should be displayed,
12579     * EINA_FALSE if not.
12580     */
12581    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
12582
12583    /**
12584     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
12585     * them).
12586     *
12587     * Setting an entry to single-line mode with elm_entry_single_line_set()
12588     * will automatically disable the display of scrollbars when the entry
12589     * moves inside its scroller.
12590     *
12591     * @param obj The scrolled entry object
12592     * @param h The horizontal scrollbar policy to apply
12593     * @param v The vertical scrollbar policy to apply
12594     */
12595    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
12596
12597    /**
12598     * This enables/disables bouncing within the entry.
12599     *
12600     * This function sets whether the entry will bounce when scrolling reaches
12601     * the end of the contained entry.
12602     *
12603     * @param obj The scrolled entry object
12604     * @param h The horizontal bounce state
12605     * @param v The vertical bounce state
12606     */
12607    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
12608
12609    /**
12610     * Get the bounce mode
12611     *
12612     * @param obj The Entry object
12613     * @param h_bounce Allow bounce horizontally
12614     * @param v_bounce Allow bounce vertically
12615     */
12616    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
12617
12618    /* pre-made filters for entries */
12619    /**
12620     * @typedef Elm_Entry_Filter_Limit_Size
12621     *
12622     * Data for the elm_entry_filter_limit_size() entry filter.
12623     */
12624    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
12625
12626    /**
12627     * @struct _Elm_Entry_Filter_Limit_Size
12628     *
12629     * Data for the elm_entry_filter_limit_size() entry filter.
12630     */
12631    struct _Elm_Entry_Filter_Limit_Size
12632      {
12633         int max_char_count; /**< The maximum number of characters allowed. */
12634         int max_byte_count; /**< The maximum number of bytes allowed*/
12635      };
12636
12637    /**
12638     * Filter inserted text based on user defined character and byte limits
12639     *
12640     * Add this filter to an entry to limit the characters that it will accept
12641     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
12642     * The funtion works on the UTF-8 representation of the string, converting
12643     * it from the set markup, thus not accounting for any format in it.
12644     *
12645     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
12646     * it as data when setting the filter. In it, it's possible to set limits
12647     * by character count or bytes (any of them is disabled if 0), and both can
12648     * be set at the same time. In that case, it first checks for characters,
12649     * then bytes.
12650     *
12651     * The function will cut the inserted text in order to allow only the first
12652     * number of characters that are still allowed. The cut is made in
12653     * characters, even when limiting by bytes, in order to always contain
12654     * valid ones and avoid half unicode characters making it in.
12655     *
12656     * This filter, like any others, does not apply when setting the entry text
12657     * directly with elm_object_text_set() (or the deprecated
12658     * elm_entry_entry_set()).
12659     */
12660    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
12661
12662    /**
12663     * @typedef Elm_Entry_Filter_Accept_Set
12664     *
12665     * Data for the elm_entry_filter_accept_set() entry filter.
12666     */
12667    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
12668
12669    /**
12670     * @struct _Elm_Entry_Filter_Accept_Set
12671     *
12672     * Data for the elm_entry_filter_accept_set() entry filter.
12673     */
12674    struct _Elm_Entry_Filter_Accept_Set
12675      {
12676         const char *accepted; /**< Set of characters accepted in the entry. */
12677         const char *rejected; /**< Set of characters rejected from the entry. */
12678      };
12679
12680    /**
12681     * Filter inserted text based on accepted or rejected sets of characters
12682     *
12683     * Add this filter to an entry to restrict the set of accepted characters
12684     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
12685     * This structure contains both accepted and rejected sets, but they are
12686     * mutually exclusive.
12687     *
12688     * The @c accepted set takes preference, so if it is set, the filter will
12689     * only work based on the accepted characters, ignoring anything in the
12690     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
12691     *
12692     * In both cases, the function filters by matching utf8 characters to the
12693     * raw markup text, so it can be used to remove formatting tags.
12694     *
12695     * This filter, like any others, does not apply when setting the entry text
12696     * directly with elm_object_text_set() (or the deprecated
12697     * elm_entry_entry_set()).
12698     */
12699    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
12700    /**
12701     * Set the input panel layout of the entry
12702     *
12703     * @param obj The entry object
12704     * @param layout layout type
12705     */
12706    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
12707
12708    /**
12709     * Get the input panel layout of the entry
12710     *
12711     * @param obj The entry object
12712     * @return layout type
12713     *
12714     * @see elm_entry_input_panel_layout_set
12715     */
12716    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12717
12718    /**
12719     * Set the autocapitalization type on the immodule.
12720     *
12721     * @param obj The entry object
12722     * @param autocapital_type The type of autocapitalization
12723     */
12724    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
12725
12726    /**
12727     * Retrieve the autocapitalization type on the immodule.
12728     *
12729     * @param obj The entry object
12730     * @return autocapitalization type
12731     */
12732    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12733
12734    /**
12735     * Sets the attribute to show the input panel automatically.
12736     *
12737     * @param obj The entry object
12738     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
12739     */
12740    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
12741
12742    /**
12743     * Retrieve the attribute to show the input panel automatically.
12744     *
12745     * @param obj The entry object
12746     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
12747     */
12748    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12749
12750    /**
12751     * @}
12752     */
12753
12754    /* composite widgets - these basically put together basic widgets above
12755     * in convenient packages that do more than basic stuff */
12756
12757    /* anchorview */
12758    /**
12759     * @defgroup Anchorview Anchorview
12760     *
12761     * @image html img/widget/anchorview/preview-00.png
12762     * @image latex img/widget/anchorview/preview-00.eps
12763     *
12764     * Anchorview is for displaying text that contains markup with anchors
12765     * like <c>\<a href=1234\>something\</\></c> in it.
12766     *
12767     * Besides being styled differently, the anchorview widget provides the
12768     * necessary functionality so that clicking on these anchors brings up a
12769     * popup with user defined content such as "call", "add to contacts" or
12770     * "open web page". This popup is provided using the @ref Hover widget.
12771     *
12772     * This widget is very similar to @ref Anchorblock, so refer to that
12773     * widget for an example. The only difference Anchorview has is that the
12774     * widget is already provided with scrolling functionality, so if the
12775     * text set to it is too large to fit in the given space, it will scroll,
12776     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12777     * text can be displayed.
12778     *
12779     * This widget emits the following signals:
12780     * @li "anchor,clicked": will be called when an anchor is clicked. The
12781     * @p event_info parameter on the callback will be a pointer of type
12782     * ::Elm_Entry_Anchorview_Info.
12783     *
12784     * See @ref Anchorblock for an example on how to use both of them.
12785     *
12786     * @see Anchorblock
12787     * @see Entry
12788     * @see Hover
12789     *
12790     * @{
12791     */
12792
12793    /**
12794     * @typedef Elm_Entry_Anchorview_Info
12795     *
12796     * The info sent in the callback for "anchor,clicked" signals emitted by
12797     * the Anchorview widget.
12798     */
12799    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12800
12801    /**
12802     * @struct _Elm_Entry_Anchorview_Info
12803     *
12804     * The info sent in the callback for "anchor,clicked" signals emitted by
12805     * the Anchorview widget.
12806     */
12807    struct _Elm_Entry_Anchorview_Info
12808      {
12809         const char     *name; /**< Name of the anchor, as indicated in its href
12810                                    attribute */
12811         int             button; /**< The mouse button used to click on it */
12812         Evas_Object    *hover; /**< The hover object to use for the popup */
12813         struct {
12814              Evas_Coord    x, y, w, h;
12815         } anchor, /**< Geometry selection of text used as anchor */
12816           hover_parent; /**< Geometry of the object used as parent by the
12817                              hover */
12818         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12819                                              for content on the left side of
12820                                              the hover. Before calling the
12821                                              callback, the widget will make the
12822                                              necessary calculations to check
12823                                              which sides are fit to be set with
12824                                              content, based on the position the
12825                                              hover is activated and its distance
12826                                              to the edges of its parent object
12827                                              */
12828         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12829                                               the right side of the hover.
12830                                               See @ref hover_left */
12831         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12832                                             of the hover. See @ref hover_left */
12833         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12834                                                below the hover. See @ref
12835                                                hover_left */
12836      };
12837
12838    /**
12839     * Add a new Anchorview object
12840     *
12841     * @param parent The parent object
12842     * @return The new object or NULL if it cannot be created
12843     */
12844    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12845
12846    /**
12847     * Set the text to show in the anchorview
12848     *
12849     * Sets the text of the anchorview to @p text. This text can include markup
12850     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12851     * text that will be specially styled and react to click events, ended with
12852     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12853     * "anchor,clicked" signal that you can attach a callback to with
12854     * evas_object_smart_callback_add(). The name of the anchor given in the
12855     * event info struct will be the one set in the href attribute, in this
12856     * case, anchorname.
12857     *
12858     * Other markup can be used to style the text in different ways, but it's
12859     * up to the style defined in the theme which tags do what.
12860     * @deprecated use elm_object_text_set() instead.
12861     */
12862    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12863
12864    /**
12865     * Get the markup text set for the anchorview
12866     *
12867     * Retrieves the text set on the anchorview, with markup tags included.
12868     *
12869     * @param obj The anchorview object
12870     * @return The markup text set or @c NULL if nothing was set or an error
12871     * occurred
12872     * @deprecated use elm_object_text_set() instead.
12873     */
12874    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12875
12876    /**
12877     * Set the parent of the hover popup
12878     *
12879     * Sets the parent object to use by the hover created by the anchorview
12880     * when an anchor is clicked. See @ref Hover for more details on this.
12881     * If no parent is set, the same anchorview object will be used.
12882     *
12883     * @param obj The anchorview object
12884     * @param parent The object to use as parent for the hover
12885     */
12886    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12887
12888    /**
12889     * Get the parent of the hover popup
12890     *
12891     * Get the object used as parent for the hover created by the anchorview
12892     * widget. See @ref Hover for more details on this.
12893     *
12894     * @param obj The anchorview object
12895     * @return The object used as parent for the hover, NULL if none is set.
12896     */
12897    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12898
12899    /**
12900     * Set the style that the hover should use
12901     *
12902     * When creating the popup hover, anchorview will request that it's
12903     * themed according to @p style.
12904     *
12905     * @param obj The anchorview object
12906     * @param style The style to use for the underlying hover
12907     *
12908     * @see elm_object_style_set()
12909     */
12910    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12911
12912    /**
12913     * Get the style that the hover should use
12914     *
12915     * Get the style the hover created by anchorview will use.
12916     *
12917     * @param obj The anchorview object
12918     * @return The style to use by the hover. NULL means the default is used.
12919     *
12920     * @see elm_object_style_set()
12921     */
12922    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12923
12924    /**
12925     * Ends the hover popup in the anchorview
12926     *
12927     * When an anchor is clicked, the anchorview widget will create a hover
12928     * object to use as a popup with user provided content. This function
12929     * terminates this popup, returning the anchorview to its normal state.
12930     *
12931     * @param obj The anchorview object
12932     */
12933    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12934
12935    /**
12936     * Set bouncing behaviour when the scrolled content reaches an edge
12937     *
12938     * Tell the internal scroller object whether it should bounce or not
12939     * when it reaches the respective edges for each axis.
12940     *
12941     * @param obj The anchorview object
12942     * @param h_bounce Whether to bounce or not in the horizontal axis
12943     * @param v_bounce Whether to bounce or not in the vertical axis
12944     *
12945     * @see elm_scroller_bounce_set()
12946     */
12947    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12948
12949    /**
12950     * Get the set bouncing behaviour of the internal scroller
12951     *
12952     * Get whether the internal scroller should bounce when the edge of each
12953     * axis is reached scrolling.
12954     *
12955     * @param obj The anchorview object
12956     * @param h_bounce Pointer where to store the bounce state of the horizontal
12957     *                 axis
12958     * @param v_bounce Pointer where to store the bounce state of the vertical
12959     *                 axis
12960     *
12961     * @see elm_scroller_bounce_get()
12962     */
12963    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12964
12965    /**
12966     * Appends a custom item provider to the given anchorview
12967     *
12968     * Appends the given function to the list of items providers. This list is
12969     * called, one function at a time, with the given @p data pointer, the
12970     * anchorview object and, in the @p item parameter, the item name as
12971     * referenced in its href string. Following functions in the list will be
12972     * called in order until one of them returns something different to NULL,
12973     * which should be an Evas_Object which will be used in place of the item
12974     * element.
12975     *
12976     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12977     * href=item/name\>\</item\>
12978     *
12979     * @param obj The anchorview object
12980     * @param func The function to add to the list of providers
12981     * @param data User data that will be passed to the callback function
12982     *
12983     * @see elm_entry_item_provider_append()
12984     */
12985    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);
12986
12987    /**
12988     * Prepend a custom item provider to the given anchorview
12989     *
12990     * Like elm_anchorview_item_provider_append(), but it adds the function
12991     * @p func to the beginning of the list, instead of the end.
12992     *
12993     * @param obj The anchorview object
12994     * @param func The function to add to the list of providers
12995     * @param data User data that will be passed to the callback function
12996     */
12997    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);
12998
12999    /**
13000     * Remove a custom item provider from the list of the given anchorview
13001     *
13002     * Removes the function and data pairing that matches @p func and @p data.
13003     * That is, unless the same function and same user data are given, the
13004     * function will not be removed from the list. This allows us to add the
13005     * same callback several times, with different @p data pointers and be
13006     * able to remove them later without conflicts.
13007     *
13008     * @param obj The anchorview object
13009     * @param func The function to remove from the list
13010     * @param data The data matching the function to remove from the list
13011     */
13012    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);
13013
13014    /**
13015     * @}
13016     */
13017
13018    /* anchorblock */
13019    /**
13020     * @defgroup Anchorblock Anchorblock
13021     *
13022     * @image html img/widget/anchorblock/preview-00.png
13023     * @image latex img/widget/anchorblock/preview-00.eps
13024     *
13025     * Anchorblock is for displaying text that contains markup with anchors
13026     * like <c>\<a href=1234\>something\</\></c> in it.
13027     *
13028     * Besides being styled differently, the anchorblock widget provides the
13029     * necessary functionality so that clicking on these anchors brings up a
13030     * popup with user defined content such as "call", "add to contacts" or
13031     * "open web page". This popup is provided using the @ref Hover widget.
13032     *
13033     * This widget emits the following signals:
13034     * @li "anchor,clicked": will be called when an anchor is clicked. The
13035     * @p event_info parameter on the callback will be a pointer of type
13036     * ::Elm_Entry_Anchorblock_Info.
13037     *
13038     * @see Anchorview
13039     * @see Entry
13040     * @see Hover
13041     *
13042     * Since examples are usually better than plain words, we might as well
13043     * try @ref tutorial_anchorblock_example "one".
13044     */
13045
13046    /**
13047     * @addtogroup Anchorblock
13048     * @{
13049     */
13050
13051    /**
13052     * @typedef Elm_Entry_Anchorblock_Info
13053     *
13054     * The info sent in the callback for "anchor,clicked" signals emitted by
13055     * the Anchorblock widget.
13056     */
13057    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
13058
13059    /**
13060     * @struct _Elm_Entry_Anchorblock_Info
13061     *
13062     * The info sent in the callback for "anchor,clicked" signals emitted by
13063     * the Anchorblock widget.
13064     */
13065    struct _Elm_Entry_Anchorblock_Info
13066      {
13067         const char     *name; /**< Name of the anchor, as indicated in its href
13068                                    attribute */
13069         int             button; /**< The mouse button used to click on it */
13070         Evas_Object    *hover; /**< The hover object to use for the popup */
13071         struct {
13072              Evas_Coord    x, y, w, h;
13073         } anchor, /**< Geometry selection of text used as anchor */
13074           hover_parent; /**< Geometry of the object used as parent by the
13075                              hover */
13076         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
13077                                              for content on the left side of
13078                                              the hover. Before calling the
13079                                              callback, the widget will make the
13080                                              necessary calculations to check
13081                                              which sides are fit to be set with
13082                                              content, based on the position the
13083                                              hover is activated and its distance
13084                                              to the edges of its parent object
13085                                              */
13086         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
13087                                               the right side of the hover.
13088                                               See @ref hover_left */
13089         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
13090                                             of the hover. See @ref hover_left */
13091         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
13092                                                below the hover. See @ref
13093                                                hover_left */
13094      };
13095
13096 /**
13097     * Add a new Anchorblock object
13098     *
13099     * @param parent The parent object
13100     * @return The new object or NULL if it cannot be created
13101     */
13102    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13103
13104    /**
13105     * Set the text to show in the anchorblock
13106     *
13107     * Sets the text of the anchorblock to @p text. This text can include markup
13108     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
13109     * of text that will be specially styled and react to click events, ended
13110     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
13111     * "anchor,clicked" signal that you can attach a callback to with
13112     * evas_object_smart_callback_add(). The name of the anchor given in the
13113     * event info struct will be the one set in the href attribute, in this
13114     * case, anchorname.
13115     *
13116     * Other markup can be used to style the text in different ways, but it's
13117     * up to the style defined in the theme which tags do what.
13118     * @deprecated use elm_object_text_set() instead.
13119     */
13120    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
13121
13122    /**
13123     * Get the markup text set for the anchorblock
13124     *
13125     * Retrieves the text set on the anchorblock, with markup tags included.
13126     *
13127     * @param obj The anchorblock object
13128     * @return The markup text set or @c NULL if nothing was set or an error
13129     * occurred
13130     * @deprecated use elm_object_text_set() instead.
13131     */
13132    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13133
13134    /**
13135     * Set the parent of the hover popup
13136     *
13137     * Sets the parent object to use by the hover created by the anchorblock
13138     * when an anchor is clicked. See @ref Hover for more details on this.
13139     *
13140     * @param obj The anchorblock object
13141     * @param parent The object to use as parent for the hover
13142     */
13143    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13144
13145    /**
13146     * Get the parent of the hover popup
13147     *
13148     * Get the object used as parent for the hover created by the anchorblock
13149     * widget. See @ref Hover for more details on this.
13150     * If no parent is set, the same anchorblock object will be used.
13151     *
13152     * @param obj The anchorblock object
13153     * @return The object used as parent for the hover, NULL if none is set.
13154     */
13155    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13156
13157    /**
13158     * Set the style that the hover should use
13159     *
13160     * When creating the popup hover, anchorblock will request that it's
13161     * themed according to @p style.
13162     *
13163     * @param obj The anchorblock object
13164     * @param style The style to use for the underlying hover
13165     *
13166     * @see elm_object_style_set()
13167     */
13168    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13169
13170    /**
13171     * Get the style that the hover should use
13172     *
13173     * Get the style, the hover created by anchorblock will use.
13174     *
13175     * @param obj The anchorblock object
13176     * @return The style to use by the hover. NULL means the default is used.
13177     *
13178     * @see elm_object_style_set()
13179     */
13180    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13181
13182    /**
13183     * Ends the hover popup in the anchorblock
13184     *
13185     * When an anchor is clicked, the anchorblock widget will create a hover
13186     * object to use as a popup with user provided content. This function
13187     * terminates this popup, returning the anchorblock to its normal state.
13188     *
13189     * @param obj The anchorblock object
13190     */
13191    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13192
13193    /**
13194     * Appends a custom item provider to the given anchorblock
13195     *
13196     * Appends the given function to the list of items providers. This list is
13197     * called, one function at a time, with the given @p data pointer, the
13198     * anchorblock object and, in the @p item parameter, the item name as
13199     * referenced in its href string. Following functions in the list will be
13200     * called in order until one of them returns something different to NULL,
13201     * which should be an Evas_Object which will be used in place of the item
13202     * element.
13203     *
13204     * Items in the markup text take the form \<item relsize=16x16 vsize=full
13205     * href=item/name\>\</item\>
13206     *
13207     * @param obj The anchorblock object
13208     * @param func The function to add to the list of providers
13209     * @param data User data that will be passed to the callback function
13210     *
13211     * @see elm_entry_item_provider_append()
13212     */
13213    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);
13214
13215    /**
13216     * Prepend a custom item provider to the given anchorblock
13217     *
13218     * Like elm_anchorblock_item_provider_append(), but it adds the function
13219     * @p func to the beginning of the list, instead of the end.
13220     *
13221     * @param obj The anchorblock object
13222     * @param func The function to add to the list of providers
13223     * @param data User data that will be passed to the callback function
13224     */
13225    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);
13226
13227    /**
13228     * Remove a custom item provider from the list of the given anchorblock
13229     *
13230     * Removes the function and data pairing that matches @p func and @p data.
13231     * That is, unless the same function and same user data are given, the
13232     * function will not be removed from the list. This allows us to add the
13233     * same callback several times, with different @p data pointers and be
13234     * able to remove them later without conflicts.
13235     *
13236     * @param obj The anchorblock object
13237     * @param func The function to remove from the list
13238     * @param data The data matching the function to remove from the list
13239     */
13240    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);
13241
13242    /**
13243     * @}
13244     */
13245
13246    /**
13247     * @defgroup Bubble Bubble
13248     *
13249     * @image html img/widget/bubble/preview-00.png
13250     * @image latex img/widget/bubble/preview-00.eps
13251     * @image html img/widget/bubble/preview-01.png
13252     * @image latex img/widget/bubble/preview-01.eps
13253     * @image html img/widget/bubble/preview-02.png
13254     * @image latex img/widget/bubble/preview-02.eps
13255     *
13256     * @brief The Bubble is a widget to show text similar to how speech is
13257     * represented in comics.
13258     *
13259     * The bubble widget contains 5 important visual elements:
13260     * @li The frame is a rectangle with rounded edjes and an "arrow".
13261     * @li The @p icon is an image to which the frame's arrow points to.
13262     * @li The @p label is a text which appears to the right of the icon if the
13263     * corner is "top_left" or "bottom_left" and is right aligned to the frame
13264     * otherwise.
13265     * @li The @p info is a text which appears to the right of the label. Info's
13266     * font is of a ligther color than label.
13267     * @li The @p content is an evas object that is shown inside the frame.
13268     *
13269     * The position of the arrow, icon, label and info depends on which corner is
13270     * selected. The four available corners are:
13271     * @li "top_left" - Default
13272     * @li "top_right"
13273     * @li "bottom_left"
13274     * @li "bottom_right"
13275     *
13276     * Signals that you can add callbacks for are:
13277     * @li "clicked" - This is called when a user has clicked the bubble.
13278     *
13279     * Default contents parts of the bubble that you can use for are:
13280     * @li "default" - A content of the bubble
13281     * @li "icon" - An icon of the bubble
13282     *
13283     * Default text parts of the button widget that you can use for are:
13284     * @li NULL - Label of the bubble
13285     *
13286          * For an example of using a buble see @ref bubble_01_example_page "this".
13287     *
13288     * @{
13289     */
13290
13291    /**
13292     * Add a new bubble to the parent
13293     *
13294     * @param parent The parent object
13295     * @return The new object or NULL if it cannot be created
13296     *
13297     * This function adds a text bubble to the given parent evas object.
13298     */
13299    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13300
13301    /**
13302     * Set the label of the bubble
13303     *
13304     * @param obj The bubble object
13305     * @param label The string to set in the label
13306     *
13307     * This function sets the title of the bubble. Where this appears depends on
13308     * the selected corner.
13309     * @deprecated use elm_object_text_set() instead.
13310     */
13311    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13312
13313    /**
13314     * Get the label of the bubble
13315     *
13316     * @param obj The bubble object
13317     * @return The string of set in the label
13318     *
13319     * This function gets the title of the bubble.
13320     * @deprecated use elm_object_text_get() instead.
13321     */
13322    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13323
13324    /**
13325     * Set the info of the bubble
13326     *
13327     * @param obj The bubble object
13328     * @param info The given info about the bubble
13329     *
13330     * This function sets the info of the bubble. Where this appears depends on
13331     * the selected corner.
13332     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
13333     */
13334    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
13335
13336    /**
13337     * Get the info of the bubble
13338     *
13339     * @param obj The bubble object
13340     *
13341     * @return The "info" string of the bubble
13342     *
13343     * This function gets the info text.
13344     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
13345     */
13346    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13347
13348    /**
13349     * Set the content to be shown in the bubble
13350     *
13351     * Once the content object is set, a previously set one will be deleted.
13352     * If you want to keep the old content object, use the
13353     * elm_bubble_content_unset() function.
13354     *
13355     * @param obj The bubble object
13356     * @param content The given content of the bubble
13357     *
13358     * This function sets the content shown on the middle of the bubble.
13359     *
13360     * @deprecated use elm_object_content_set() instead
13361     *
13362     */
13363    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
13364
13365    /**
13366     * Get the content shown in the bubble
13367     *
13368     * Return the content object which is set for this widget.
13369     *
13370     * @param obj The bubble object
13371     * @return The content that is being used
13372     *
13373     * @deprecated use elm_object_content_get() instead
13374     *
13375     */
13376    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13377
13378    /**
13379     * Unset the content shown in the bubble
13380     *
13381     * Unparent and return the content object which was set for this widget.
13382     *
13383     * @param obj The bubble object
13384     * @return The content that was being used
13385     *
13386     * @deprecated use elm_object_content_unset() instead
13387     *
13388     */
13389    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13390
13391    /**
13392     * Set the icon of the bubble
13393     *
13394     * Once the icon object is set, a previously set one will be deleted.
13395     * If you want to keep the old content object, use the
13396     * elm_icon_content_unset() function.
13397     *
13398     * @param obj The bubble object
13399     * @param icon The given icon for the bubble
13400     *
13401     * @deprecated use elm_object_part_content_set() instead
13402     *
13403     */
13404    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13405
13406    /**
13407     * Get the icon of the bubble
13408     *
13409     * @param obj The bubble object
13410     * @return The icon for the bubble
13411     *
13412     * This function gets the icon shown on the top left of bubble.
13413     *
13414     * @deprecated use elm_object_part_content_get() instead
13415     *
13416     */
13417    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13418
13419    /**
13420     * Unset the icon of the bubble
13421     *
13422     * Unparent and return the icon object which was set for this widget.
13423     *
13424     * @param obj The bubble object
13425     * @return The icon that was being used
13426     *
13427     * @deprecated use elm_object_part_content_unset() instead
13428     *
13429     */
13430    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13431
13432    /**
13433     * Set the corner of the bubble
13434     *
13435     * @param obj The bubble object.
13436     * @param corner The given corner for the bubble.
13437     *
13438     * This function sets the corner of the bubble. The corner will be used to
13439     * determine where the arrow in the frame points to and where label, icon and
13440     * info are shown.
13441     *
13442     * Possible values for corner are:
13443     * @li "top_left" - Default
13444     * @li "top_right"
13445     * @li "bottom_left"
13446     * @li "bottom_right"
13447     */
13448    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
13449
13450    /**
13451     * Get the corner of the bubble
13452     *
13453     * @param obj The bubble object.
13454     * @return The given corner for the bubble.
13455     *
13456     * This function gets the selected corner of the bubble.
13457     */
13458    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13459
13460    /**
13461     * @}
13462     */
13463
13464    /**
13465     * @defgroup Photo Photo
13466     *
13467     * For displaying the photo of a person (contact). Simple, yet
13468     * with a very specific purpose.
13469     *
13470     * Signals that you can add callbacks for are:
13471     *
13472     * "clicked" - This is called when a user has clicked the photo
13473     * "drag,start" - Someone started dragging the image out of the object
13474     * "drag,end" - Dragged item was dropped (somewhere)
13475     *
13476     * @{
13477     */
13478
13479    /**
13480     * Add a new photo to the parent
13481     *
13482     * @param parent The parent object
13483     * @return The new object or NULL if it cannot be created
13484     *
13485     * @ingroup Photo
13486     */
13487    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13488
13489    /**
13490     * Set the file that will be used as photo
13491     *
13492     * @param obj The photo object
13493     * @param file The path to file that will be used as photo
13494     *
13495     * @return (1 = success, 0 = error)
13496     *
13497     * @ingroup Photo
13498     */
13499    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
13500
13501     /**
13502     * Set the file that will be used as thumbnail in the photo.
13503     *
13504     * @param obj The photo object.
13505     * @param file The path to file that will be used as thumb.
13506     * @param group The key used in case of an EET file.
13507     *
13508     * @ingroup Photo
13509     */
13510    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
13511
13512    /**
13513     * Set the size that will be used on the photo
13514     *
13515     * @param obj The photo object
13516     * @param size The size that the photo will be
13517     *
13518     * @ingroup Photo
13519     */
13520    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
13521
13522    /**
13523     * Set if the photo should be completely visible or not.
13524     *
13525     * @param obj The photo object
13526     * @param fill if true the photo will be completely visible
13527     *
13528     * @ingroup Photo
13529     */
13530    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
13531
13532    /**
13533     * Set editability of the photo.
13534     *
13535     * An editable photo can be dragged to or from, and can be cut or
13536     * pasted too.  Note that pasting an image or dropping an item on
13537     * the image will delete the existing content.
13538     *
13539     * @param obj The photo object.
13540     * @param set To set of clear editablity.
13541     */
13542    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
13543
13544    /**
13545     * @}
13546     */
13547
13548    /* gesture layer */
13549    /**
13550     * @defgroup Elm_Gesture_Layer Gesture Layer
13551     * Gesture Layer Usage:
13552     *
13553     * Use Gesture Layer to detect gestures.
13554     * The advantage is that you don't have to implement
13555     * gesture detection, just set callbacks of gesture state.
13556     * By using gesture layer we make standard interface.
13557     *
13558     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
13559     * with a parent object parameter.
13560     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
13561     * call. Usually with same object as target (2nd parameter).
13562     *
13563     * Now you need to tell gesture layer what gestures you follow.
13564     * This is done with @ref elm_gesture_layer_cb_set call.
13565     * By setting the callback you actually saying to gesture layer:
13566     * I would like to know when the gesture @ref Elm_Gesture_Types
13567     * switches to state @ref Elm_Gesture_State.
13568     *
13569     * Next, you need to implement the actual action that follows the input
13570     * in your callback.
13571     *
13572     * Note that if you like to stop being reported about a gesture, just set
13573     * all callbacks referring this gesture to NULL.
13574     * (again with @ref elm_gesture_layer_cb_set)
13575     *
13576     * The information reported by gesture layer to your callback is depending
13577     * on @ref Elm_Gesture_Types:
13578     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
13579     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
13580     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
13581     *
13582     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
13583     * @ref ELM_GESTURE_MOMENTUM.
13584     *
13585     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
13586     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
13587     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
13588     * Note that we consider a flick as a line-gesture that should be completed
13589     * in flick-time-limit as defined in @ref Config.
13590     *
13591     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
13592     *
13593     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
13594     *
13595     *
13596     * Gesture Layer Tweaks:
13597     *
13598     * Note that line, flick, gestures can start without the need to remove fingers from surface.
13599     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
13600     *
13601     * Setting glayer_continues_enable to false in @ref Config will change this behavior
13602     * so gesture starts when user touches (a *DOWN event) touch-surface
13603     * and ends when no fingers touches surface (a *UP event).
13604     */
13605
13606    /**
13607     * @enum _Elm_Gesture_Types
13608     * Enum of supported gesture types.
13609     * @ingroup Elm_Gesture_Layer
13610     */
13611    enum _Elm_Gesture_Types
13612      {
13613         ELM_GESTURE_FIRST = 0,
13614
13615         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
13616         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
13617         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
13618         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
13619
13620         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
13621
13622         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
13623         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
13624
13625         ELM_GESTURE_ZOOM, /**< Zoom */
13626         ELM_GESTURE_ROTATE, /**< Rotate */
13627
13628         ELM_GESTURE_LAST
13629      };
13630
13631    /**
13632     * @typedef Elm_Gesture_Types
13633     * gesture types enum
13634     * @ingroup Elm_Gesture_Layer
13635     */
13636    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
13637
13638    /**
13639     * @enum _Elm_Gesture_State
13640     * Enum of gesture states.
13641     * @ingroup Elm_Gesture_Layer
13642     */
13643    enum _Elm_Gesture_State
13644      {
13645         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
13646         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
13647         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
13648         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
13649         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
13650      };
13651
13652    /**
13653     * @typedef Elm_Gesture_State
13654     * gesture states enum
13655     * @ingroup Elm_Gesture_Layer
13656     */
13657    typedef enum _Elm_Gesture_State Elm_Gesture_State;
13658
13659    /**
13660     * @struct _Elm_Gesture_Taps_Info
13661     * Struct holds taps info for user
13662     * @ingroup Elm_Gesture_Layer
13663     */
13664    struct _Elm_Gesture_Taps_Info
13665      {
13666         Evas_Coord x, y;         /**< Holds center point between fingers */
13667         unsigned int n;          /**< Number of fingers tapped           */
13668         unsigned int timestamp;  /**< event timestamp       */
13669      };
13670
13671    /**
13672     * @typedef Elm_Gesture_Taps_Info
13673     * holds taps info for user
13674     * @ingroup Elm_Gesture_Layer
13675     */
13676    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
13677
13678    /**
13679     * @struct _Elm_Gesture_Momentum_Info
13680     * Struct holds momentum info for user
13681     * x1 and y1 are not necessarily in sync
13682     * x1 holds x value of x direction starting point
13683     * and same holds for y1.
13684     * This is noticeable when doing V-shape movement
13685     * @ingroup Elm_Gesture_Layer
13686     */
13687    struct _Elm_Gesture_Momentum_Info
13688      {  /* Report line ends, timestamps, and momentum computed        */
13689         Evas_Coord x1; /**< Final-swipe direction starting point on X */
13690         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
13691         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
13692         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
13693
13694         unsigned int tx; /**< Timestamp of start of final x-swipe */
13695         unsigned int ty; /**< Timestamp of start of final y-swipe */
13696
13697         Evas_Coord mx; /**< Momentum on X */
13698         Evas_Coord my; /**< Momentum on Y */
13699
13700         unsigned int n;  /**< Number of fingers */
13701      };
13702
13703    /**
13704     * @typedef Elm_Gesture_Momentum_Info
13705     * holds momentum info for user
13706     * @ingroup Elm_Gesture_Layer
13707     */
13708     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
13709
13710    /**
13711     * @struct _Elm_Gesture_Line_Info
13712     * Struct holds line info for user
13713     * @ingroup Elm_Gesture_Layer
13714     */
13715    struct _Elm_Gesture_Line_Info
13716      {  /* Report line ends, timestamps, and momentum computed      */
13717         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
13718         double angle;              /**< Angle (direction) of lines  */
13719      };
13720
13721    /**
13722     * @typedef Elm_Gesture_Line_Info
13723     * Holds line info for user
13724     * @ingroup Elm_Gesture_Layer
13725     */
13726     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
13727
13728    /**
13729     * @struct _Elm_Gesture_Zoom_Info
13730     * Struct holds zoom info for user
13731     * @ingroup Elm_Gesture_Layer
13732     */
13733    struct _Elm_Gesture_Zoom_Info
13734      {
13735         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
13736         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13737         double zoom;            /**< Zoom value: 1.0 means no zoom             */
13738         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
13739      };
13740
13741    /**
13742     * @typedef Elm_Gesture_Zoom_Info
13743     * Holds zoom info for user
13744     * @ingroup Elm_Gesture_Layer
13745     */
13746    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
13747
13748    /**
13749     * @struct _Elm_Gesture_Rotate_Info
13750     * Struct holds rotation info for user
13751     * @ingroup Elm_Gesture_Layer
13752     */
13753    struct _Elm_Gesture_Rotate_Info
13754      {
13755         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
13756         Evas_Coord radius; /**< Holds radius between fingers reported to user */
13757         double base_angle; /**< Holds start-angle */
13758         double angle;      /**< Rotation value: 0.0 means no rotation         */
13759         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
13760      };
13761
13762    /**
13763     * @typedef Elm_Gesture_Rotate_Info
13764     * Holds rotation info for user
13765     * @ingroup Elm_Gesture_Layer
13766     */
13767    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
13768
13769    /**
13770     * @typedef Elm_Gesture_Event_Cb
13771     * User callback used to stream gesture info from gesture layer
13772     * @param data user data
13773     * @param event_info gesture report info
13774     * Returns a flag field to be applied on the causing event.
13775     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
13776     * upon the event, in an irreversible way.
13777     *
13778     * @ingroup Elm_Gesture_Layer
13779     */
13780    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
13781
13782    /**
13783     * Use function to set callbacks to be notified about
13784     * change of state of gesture.
13785     * When a user registers a callback with this function
13786     * this means this gesture has to be tested.
13787     *
13788     * When ALL callbacks for a gesture are set to NULL
13789     * it means user isn't interested in gesture-state
13790     * and it will not be tested.
13791     *
13792     * @param obj Pointer to gesture-layer.
13793     * @param idx The gesture you would like to track its state.
13794     * @param cb callback function pointer.
13795     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13796     * @param data user info to be sent to callback (usually, Smart Data)
13797     *
13798     * @ingroup Elm_Gesture_Layer
13799     */
13800    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);
13801
13802    /**
13803     * Call this function to get repeat-events settings.
13804     *
13805     * @param obj Pointer to gesture-layer.
13806     *
13807     * @return repeat events settings.
13808     * @see elm_gesture_layer_hold_events_set()
13809     * @ingroup Elm_Gesture_Layer
13810     */
13811    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13812
13813    /**
13814     * This function called in order to make gesture-layer repeat events.
13815     * Set this of you like to get the raw events only if gestures were not detected.
13816     * Clear this if you like gesture layer to fwd events as testing gestures.
13817     *
13818     * @param obj Pointer to gesture-layer.
13819     * @param r Repeat: TRUE/FALSE
13820     *
13821     * @ingroup Elm_Gesture_Layer
13822     */
13823    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13824
13825    /**
13826     * This function sets step-value for zoom action.
13827     * Set step to any positive value.
13828     * Cancel step setting by setting to 0.0
13829     *
13830     * @param obj Pointer to gesture-layer.
13831     * @param s new zoom step value.
13832     *
13833     * @ingroup Elm_Gesture_Layer
13834     */
13835    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13836
13837    /**
13838     * This function sets step-value for rotate action.
13839     * Set step to any positive value.
13840     * Cancel step setting by setting to 0.0
13841     *
13842     * @param obj Pointer to gesture-layer.
13843     * @param s new roatate step value.
13844     *
13845     * @ingroup Elm_Gesture_Layer
13846     */
13847    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13848
13849    /**
13850     * This function called to attach gesture-layer to an Evas_Object.
13851     * @param obj Pointer to gesture-layer.
13852     * @param t Pointer to underlying object (AKA Target)
13853     *
13854     * @return TRUE, FALSE on success, failure.
13855     *
13856     * @ingroup Elm_Gesture_Layer
13857     */
13858    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13859
13860    /**
13861     * Call this function to construct a new gesture-layer object.
13862     * This does not activate the gesture layer. You have to
13863     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13864     *
13865     * @param parent the parent object.
13866     *
13867     * @return Pointer to new gesture-layer object.
13868     *
13869     * @ingroup Elm_Gesture_Layer
13870     */
13871    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13872
13873    /**
13874     * @defgroup Thumb Thumb
13875     *
13876     * @image html img/widget/thumb/preview-00.png
13877     * @image latex img/widget/thumb/preview-00.eps
13878     *
13879     * A thumb object is used for displaying the thumbnail of an image or video.
13880     * You must have compiled Elementary with Ethumb_Client support and the DBus
13881     * service must be present and auto-activated in order to have thumbnails to
13882     * be generated.
13883     *
13884     * Once the thumbnail object becomes visible, it will check if there is a
13885     * previously generated thumbnail image for the file set on it. If not, it
13886     * will start generating this thumbnail.
13887     *
13888     * Different config settings will cause different thumbnails to be generated
13889     * even on the same file.
13890     *
13891     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13892     * Ethumb documentation to change this path, and to see other configuration
13893     * options.
13894     *
13895     * Signals that you can add callbacks for are:
13896     *
13897     * - "clicked" - This is called when a user has clicked the thumb without dragging
13898     *             around.
13899     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13900     * - "press" - This is called when a user has pressed down the thumb.
13901     * - "generate,start" - The thumbnail generation started.
13902     * - "generate,stop" - The generation process stopped.
13903     * - "generate,error" - The generation failed.
13904     * - "load,error" - The thumbnail image loading failed.
13905     *
13906     * available styles:
13907     * - default
13908     * - noframe
13909     *
13910     * An example of use of thumbnail:
13911     *
13912     * - @ref thumb_example_01
13913     */
13914
13915    /**
13916     * @addtogroup Thumb
13917     * @{
13918     */
13919
13920    /**
13921     * @enum _Elm_Thumb_Animation_Setting
13922     * @typedef Elm_Thumb_Animation_Setting
13923     *
13924     * Used to set if a video thumbnail is animating or not.
13925     *
13926     * @ingroup Thumb
13927     */
13928    typedef enum _Elm_Thumb_Animation_Setting
13929      {
13930         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13931         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13932         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13933         ELM_THUMB_ANIMATION_LAST
13934      } Elm_Thumb_Animation_Setting;
13935
13936    /**
13937     * Add a new thumb object to the parent.
13938     *
13939     * @param parent The parent object.
13940     * @return The new object or NULL if it cannot be created.
13941     *
13942     * @see elm_thumb_file_set()
13943     * @see elm_thumb_ethumb_client_get()
13944     *
13945     * @ingroup Thumb
13946     */
13947    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13948
13949    /**
13950     * Reload thumbnail if it was generated before.
13951     *
13952     * @param obj The thumb object to reload
13953     *
13954     * This is useful if the ethumb client configuration changed, like its
13955     * size, aspect or any other property one set in the handle returned
13956     * by elm_thumb_ethumb_client_get().
13957     *
13958     * If the options didn't change, the thumbnail won't be generated again, but
13959     * the old one will still be used.
13960     *
13961     * @see elm_thumb_file_set()
13962     *
13963     * @ingroup Thumb
13964     */
13965    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13966
13967    /**
13968     * Set the file that will be used as thumbnail.
13969     *
13970     * @param obj The thumb object.
13971     * @param file The path to file that will be used as thumb.
13972     * @param key The key used in case of an EET file.
13973     *
13974     * The file can be an image or a video (in that case, acceptable extensions are:
13975     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13976     * function elm_thumb_animate().
13977     *
13978     * @see elm_thumb_file_get()
13979     * @see elm_thumb_reload()
13980     * @see elm_thumb_animate()
13981     *
13982     * @ingroup Thumb
13983     */
13984    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13985
13986    /**
13987     * Get the image or video path and key used to generate the thumbnail.
13988     *
13989     * @param obj The thumb object.
13990     * @param file Pointer to filename.
13991     * @param key Pointer to key.
13992     *
13993     * @see elm_thumb_file_set()
13994     * @see elm_thumb_path_get()
13995     *
13996     * @ingroup Thumb
13997     */
13998    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13999
14000    /**
14001     * Get the path and key to the image or video generated by ethumb.
14002     *
14003     * One just need to make sure that the thumbnail was generated before getting
14004     * its path; otherwise, the path will be NULL. One way to do that is by asking
14005     * for the path when/after the "generate,stop" smart callback is called.
14006     *
14007     * @param obj The thumb object.
14008     * @param file Pointer to thumb path.
14009     * @param key Pointer to thumb key.
14010     *
14011     * @see elm_thumb_file_get()
14012     *
14013     * @ingroup Thumb
14014     */
14015    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
14016
14017    /**
14018     * Set the animation state for the thumb object. If its content is an animated
14019     * video, you may start/stop the animation or tell it to play continuously and
14020     * looping.
14021     *
14022     * @param obj The thumb object.
14023     * @param setting The animation setting.
14024     *
14025     * @see elm_thumb_file_set()
14026     *
14027     * @ingroup Thumb
14028     */
14029    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
14030
14031    /**
14032     * Get the animation state for the thumb object.
14033     *
14034     * @param obj The thumb object.
14035     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
14036     * on errors.
14037     *
14038     * @see elm_thumb_animate_set()
14039     *
14040     * @ingroup Thumb
14041     */
14042    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14043
14044    /**
14045     * Get the ethumb_client handle so custom configuration can be made.
14046     *
14047     * @return Ethumb_Client instance or NULL.
14048     *
14049     * This must be called before the objects are created to be sure no object is
14050     * visible and no generation started.
14051     *
14052     * Example of usage:
14053     *
14054     * @code
14055     * #include <Elementary.h>
14056     * #ifndef ELM_LIB_QUICKLAUNCH
14057     * EAPI_MAIN int
14058     * elm_main(int argc, char **argv)
14059     * {
14060     *    Ethumb_Client *client;
14061     *
14062     *    elm_need_ethumb();
14063     *
14064     *    // ... your code
14065     *
14066     *    client = elm_thumb_ethumb_client_get();
14067     *    if (!client)
14068     *      {
14069     *         ERR("could not get ethumb_client");
14070     *         return 1;
14071     *      }
14072     *    ethumb_client_size_set(client, 100, 100);
14073     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
14074     *    // ... your code
14075     *
14076     *    // Create elm_thumb objects here
14077     *
14078     *    elm_run();
14079     *    elm_shutdown();
14080     *    return 0;
14081     * }
14082     * #endif
14083     * ELM_MAIN()
14084     * @endcode
14085     *
14086     * @note There's only one client handle for Ethumb, so once a configuration
14087     * change is done to it, any other request for thumbnails (for any thumbnail
14088     * object) will use that configuration. Thus, this configuration is global.
14089     *
14090     * @ingroup Thumb
14091     */
14092    EAPI void                        *elm_thumb_ethumb_client_get(void);
14093
14094    /**
14095     * Get the ethumb_client connection state.
14096     *
14097     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
14098     * otherwise.
14099     */
14100    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
14101
14102    /**
14103     * Make the thumbnail 'editable'.
14104     *
14105     * @param obj Thumb object.
14106     * @param set Turn on or off editability. Default is @c EINA_FALSE.
14107     *
14108     * This means the thumbnail is a valid drag target for drag and drop, and can be
14109     * cut or pasted too.
14110     *
14111     * @see elm_thumb_editable_get()
14112     *
14113     * @ingroup Thumb
14114     */
14115    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
14116
14117    /**
14118     * Make the thumbnail 'editable'.
14119     *
14120     * @param obj Thumb object.
14121     * @return Editability.
14122     *
14123     * This means the thumbnail is a valid drag target for drag and drop, and can be
14124     * cut or pasted too.
14125     *
14126     * @see elm_thumb_editable_set()
14127     *
14128     * @ingroup Thumb
14129     */
14130    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14131
14132    /**
14133     * @}
14134     */
14135
14136    /**
14137     * @defgroup Web Web
14138     *
14139     * @image html img/widget/web/preview-00.png
14140     * @image latex img/widget/web/preview-00.eps
14141     *
14142     * A web object is used for displaying web pages (HTML/CSS/JS)
14143     * using WebKit-EFL. You must have compiled Elementary with
14144     * ewebkit support.
14145     *
14146     * Signals that you can add callbacks for are:
14147     * @li "download,request": A file download has been requested. Event info is
14148     * a pointer to a Elm_Web_Download
14149     * @li "editorclient,contents,changed": Editor client's contents changed
14150     * @li "editorclient,selection,changed": Editor client's selection changed
14151     * @li "frame,created": A new frame was created. Event info is an
14152     * Evas_Object which can be handled with WebKit's ewk_frame API
14153     * @li "icon,received": An icon was received by the main frame
14154     * @li "inputmethod,changed": Input method changed. Event info is an
14155     * Eina_Bool indicating whether it's enabled or not
14156     * @li "js,windowobject,clear": JS window object has been cleared
14157     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
14158     * is a char *link[2], where the first string contains the URL the link
14159     * points to, and the second one the title of the link
14160     * @li "link,hover,out": Mouse cursor left the link
14161     * @li "load,document,finished": Loading of a document finished. Event info
14162     * is the frame that finished loading
14163     * @li "load,error": Load failed. Event info is a pointer to
14164     * Elm_Web_Frame_Load_Error
14165     * @li "load,finished": Load finished. Event info is NULL on success, on
14166     * error it's a pointer to Elm_Web_Frame_Load_Error
14167     * @li "load,newwindow,show": A new window was created and is ready to be
14168     * shown
14169     * @li "load,progress": Overall load progress. Event info is a pointer to
14170     * a double containing a value between 0.0 and 1.0
14171     * @li "load,provisional": Started provisional load
14172     * @li "load,started": Loading of a document started
14173     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
14174     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
14175     * the menubar is visible, or EINA_FALSE in case it's not
14176     * @li "menubar,visible,set": Informs menubar visibility. Event info is
14177     * an Eina_Bool indicating the visibility
14178     * @li "popup,created": A dropdown widget was activated, requesting its
14179     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
14180     * @li "popup,willdelete": The web object is ready to destroy the popup
14181     * object created. Event info is a pointer to Elm_Web_Menu
14182     * @li "ready": Page is fully loaded
14183     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
14184     * info is a pointer to Eina_Bool where the visibility state should be set
14185     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
14186     * is an Eina_Bool with the visibility state set
14187     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
14188     * a string with the new text
14189     * @li "statusbar,visible,get": Queries visibility of the status bar.
14190     * Event info is a pointer to Eina_Bool where the visibility state should be
14191     * set.
14192     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
14193     * an Eina_Bool with the visibility value
14194     * @li "title,changed": Title of the main frame changed. Event info is a
14195     * string with the new title
14196     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
14197     * is a pointer to Eina_Bool where the visibility state should be set
14198     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
14199     * info is an Eina_Bool with the visibility state
14200     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
14201     * a string with the text to show
14202     * @li "uri,changed": URI of the main frame changed. Event info is a string
14203     * with the new URI
14204     * @li "view,resized": The web object internal's view changed sized
14205     * @li "windows,close,request": A JavaScript request to close the current
14206     * window was requested
14207     * @li "zoom,animated,end": Animated zoom finished
14208     *
14209     * available styles:
14210     * - default
14211     *
14212     * An example of use of web:
14213     *
14214     * - @ref web_example_01 TBD
14215     */
14216
14217    /**
14218     * @addtogroup Web
14219     * @{
14220     */
14221
14222    /**
14223     * Structure used to report load errors.
14224     *
14225     * Load errors are reported as signal by elm_web. All the strings are
14226     * temporary references and should @b not be used after the signal
14227     * callback returns. If it's required, make copies with strdup() or
14228     * eina_stringshare_add() (they are not even guaranteed to be
14229     * stringshared, so must use eina_stringshare_add() and not
14230     * eina_stringshare_ref()).
14231     */
14232    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
14233
14234    /**
14235     * Structure used to report load errors.
14236     *
14237     * Load errors are reported as signal by elm_web. All the strings are
14238     * temporary references and should @b not be used after the signal
14239     * callback returns. If it's required, make copies with strdup() or
14240     * eina_stringshare_add() (they are not even guaranteed to be
14241     * stringshared, so must use eina_stringshare_add() and not
14242     * eina_stringshare_ref()).
14243     */
14244    struct _Elm_Web_Frame_Load_Error
14245      {
14246         int code; /**< Numeric error code */
14247         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
14248         const char *domain; /**< Error domain name */
14249         const char *description; /**< Error description (already localized) */
14250         const char *failing_url; /**< The URL that failed to load */
14251         Evas_Object *frame; /**< Frame object that produced the error */
14252      };
14253
14254    /**
14255     * The possibles types that the items in a menu can be
14256     */
14257    typedef enum _Elm_Web_Menu_Item_Type
14258      {
14259         ELM_WEB_MENU_SEPARATOR,
14260         ELM_WEB_MENU_GROUP,
14261         ELM_WEB_MENU_OPTION
14262      } Elm_Web_Menu_Item_Type;
14263
14264    /**
14265     * Structure describing the items in a menu
14266     */
14267    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
14268
14269    /**
14270     * Structure describing the items in a menu
14271     */
14272    struct _Elm_Web_Menu_Item
14273      {
14274         const char *text; /**< The text for the item */
14275         Elm_Web_Menu_Item_Type type; /**< The type of the item */
14276      };
14277
14278    /**
14279     * Structure describing the menu of a popup
14280     *
14281     * This structure will be passed as the @c event_info for the "popup,create"
14282     * signal, which is emitted when a dropdown menu is opened. Users wanting
14283     * to handle these popups by themselves should listen to this signal and
14284     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14285     * property as @c EINA_FALSE means that the user will not handle the popup
14286     * and the default implementation will be used.
14287     *
14288     * When the popup is ready to be dismissed, a "popup,willdelete" signal
14289     * will be emitted to notify the user that it can destroy any objects and
14290     * free all data related to it.
14291     *
14292     * @see elm_web_popup_selected_set()
14293     * @see elm_web_popup_destroy()
14294     */
14295    typedef struct _Elm_Web_Menu Elm_Web_Menu;
14296
14297    /**
14298     * Structure describing the menu of a popup
14299     *
14300     * This structure will be passed as the @c event_info for the "popup,create"
14301     * signal, which is emitted when a dropdown menu is opened. Users wanting
14302     * to handle these popups by themselves should listen to this signal and
14303     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
14304     * property as @c EINA_FALSE means that the user will not handle the popup
14305     * and the default implementation will be used.
14306     *
14307     * When the popup is ready to be dismissed, a "popup,willdelete" signal
14308     * will be emitted to notify the user that it can destroy any objects and
14309     * free all data related to it.
14310     *
14311     * @see elm_web_popup_selected_set()
14312     * @see elm_web_popup_destroy()
14313     */
14314    struct _Elm_Web_Menu
14315      {
14316         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
14317         int x; /**< The X position of the popup, relative to the elm_web object */
14318         int y; /**< The Y position of the popup, relative to the elm_web object */
14319         int width; /**< Width of the popup menu */
14320         int height; /**< Height of the popup menu */
14321
14322         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. */
14323      };
14324
14325    typedef struct _Elm_Web_Download Elm_Web_Download;
14326    struct _Elm_Web_Download
14327      {
14328         const char *url;
14329      };
14330
14331    /**
14332     * Types of zoom available.
14333     */
14334    typedef enum _Elm_Web_Zoom_Mode
14335      {
14336         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
14337         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
14338         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
14339         ELM_WEB_ZOOM_MODE_LAST
14340      } Elm_Web_Zoom_Mode;
14341
14342    /**
14343     * Opaque handler containing the features (such as statusbar, menubar, etc)
14344     * that are to be set on a newly requested window.
14345     */
14346    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
14347
14348    /**
14349     * Callback type for the create_window hook.
14350     *
14351     * The function parameters are:
14352     * @li @p data User data pointer set when setting the hook function
14353     * @li @p obj The elm_web object requesting the new window
14354     * @li @p js Set to @c EINA_TRUE if the request was originated from
14355     * JavaScript. @c EINA_FALSE otherwise.
14356     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
14357     * the features requested for the new window.
14358     *
14359     * The returned value of the function should be the @c elm_web widget where
14360     * the request will be loaded. That is, if a new window or tab is created,
14361     * the elm_web widget in it should be returned, and @b NOT the window
14362     * object.
14363     * Returning @c NULL should cancel the request.
14364     *
14365     * @see elm_web_window_create_hook_set()
14366     */
14367    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
14368
14369    /**
14370     * Callback type for the JS alert hook.
14371     *
14372     * The function parameters are:
14373     * @li @p data User data pointer set when setting the hook function
14374     * @li @p obj The elm_web object requesting the new window
14375     * @li @p message The message to show in the alert dialog
14376     *
14377     * The function should return the object representing the alert dialog.
14378     * Elm_Web will run a second main loop to handle the dialog and normal
14379     * flow of the application will be restored when the object is deleted, so
14380     * the user should handle the popup properly in order to delete the object
14381     * when the action is finished.
14382     * If the function returns @c NULL the popup will be ignored.
14383     *
14384     * @see elm_web_dialog_alert_hook_set()
14385     */
14386    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
14387
14388    /**
14389     * Callback type for the JS confirm hook.
14390     *
14391     * The function parameters are:
14392     * @li @p data User data pointer set when setting the hook function
14393     * @li @p obj The elm_web object requesting the new window
14394     * @li @p message The message to show in the confirm dialog
14395     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14396     * the user selected @c Ok, @c EINA_FALSE otherwise.
14397     *
14398     * The function should return the object representing the confirm dialog.
14399     * Elm_Web will run a second main loop to handle the dialog and normal
14400     * flow of the application will be restored when the object is deleted, so
14401     * the user should handle the popup properly in order to delete the object
14402     * when the action is finished.
14403     * If the function returns @c NULL the popup will be ignored.
14404     *
14405     * @see elm_web_dialog_confirm_hook_set()
14406     */
14407    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
14408
14409    /**
14410     * Callback type for the JS prompt hook.
14411     *
14412     * The function parameters are:
14413     * @li @p data User data pointer set when setting the hook function
14414     * @li @p obj The elm_web object requesting the new window
14415     * @li @p message The message to show in the prompt dialog
14416     * @li @p def_value The default value to present the user in the entry
14417     * @li @p value Pointer where to store the value given by the user. Must
14418     * be a malloc'ed string or @c NULL if the user cancelled the popup.
14419     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14420     * the user selected @c Ok, @c EINA_FALSE otherwise.
14421     *
14422     * The function should return the object representing the prompt dialog.
14423     * Elm_Web will run a second main loop to handle the dialog and normal
14424     * flow of the application will be restored when the object is deleted, so
14425     * the user should handle the popup properly in order to delete the object
14426     * when the action is finished.
14427     * If the function returns @c NULL the popup will be ignored.
14428     *
14429     * @see elm_web_dialog_prompt_hook_set()
14430     */
14431    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
14432
14433    /**
14434     * Callback type for the JS file selector hook.
14435     *
14436     * The function parameters are:
14437     * @li @p data User data pointer set when setting the hook function
14438     * @li @p obj The elm_web object requesting the new window
14439     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
14440     * @li @p accept_types Mime types accepted
14441     * @li @p selected Pointer where to store the list of malloc'ed strings
14442     * containing the path to each file selected. Must be @c NULL if the file
14443     * dialog is cancelled
14444     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
14445     * the user selected @c Ok, @c EINA_FALSE otherwise.
14446     *
14447     * The function should return the object representing the file selector
14448     * dialog.
14449     * Elm_Web will run a second main loop to handle the dialog and normal
14450     * flow of the application will be restored when the object is deleted, so
14451     * the user should handle the popup properly in order to delete the object
14452     * when the action is finished.
14453     * If the function returns @c NULL the popup will be ignored.
14454     *
14455     * @see elm_web_dialog_file selector_hook_set()
14456     */
14457    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);
14458
14459    /**
14460     * Callback type for the JS console message hook.
14461     *
14462     * When a console message is added from JavaScript, any set function to the
14463     * console message hook will be called for the user to handle. There is no
14464     * default implementation of this hook.
14465     *
14466     * The function parameters are:
14467     * @li @p data User data pointer set when setting the hook function
14468     * @li @p obj The elm_web object that originated the message
14469     * @li @p message The message sent
14470     * @li @p line_number The line number
14471     * @li @p source_id Source id
14472     *
14473     * @see elm_web_console_message_hook_set()
14474     */
14475    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
14476
14477    /**
14478     * Add a new web object to the parent.
14479     *
14480     * @param parent The parent object.
14481     * @return The new object or NULL if it cannot be created.
14482     *
14483     * @see elm_web_uri_set()
14484     * @see elm_web_webkit_view_get()
14485     */
14486    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14487
14488    /**
14489     * Get internal ewk_view object from web object.
14490     *
14491     * Elementary may not provide some low level features of EWebKit,
14492     * instead of cluttering the API with proxy methods we opted to
14493     * return the internal reference. Be careful using it as it may
14494     * interfere with elm_web behavior.
14495     *
14496     * @param obj The web object.
14497     * @return The internal ewk_view object or NULL if it does not
14498     *         exist. (Failure to create or Elementary compiled without
14499     *         ewebkit)
14500     *
14501     * @see elm_web_add()
14502     */
14503    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14504
14505    /**
14506     * Sets the function to call when a new window is requested
14507     *
14508     * This hook will be called when a request to create a new window is
14509     * issued from the web page loaded.
14510     * There is no default implementation for this feature, so leaving this
14511     * unset or passing @c NULL in @p func will prevent new windows from
14512     * opening.
14513     *
14514     * @param obj The web object where to set the hook function
14515     * @param func The hook function to be called when a window is requested
14516     * @param data User data
14517     */
14518    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
14519
14520    /**
14521     * Sets the function to call when an alert dialog
14522     *
14523     * This hook will be called when a JavaScript alert dialog is requested.
14524     * If no function is set or @c NULL is passed in @p func, the default
14525     * implementation will take place.
14526     *
14527     * @param obj The web object where to set the hook function
14528     * @param func The callback function to be used
14529     * @param data User data
14530     *
14531     * @see elm_web_inwin_mode_set()
14532     */
14533    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
14534
14535    /**
14536     * Sets the function to call when an confirm dialog
14537     *
14538     * This hook will be called when a JavaScript confirm dialog is requested.
14539     * If no function is set or @c NULL is passed in @p func, the default
14540     * implementation will take place.
14541     *
14542     * @param obj The web object where to set the hook function
14543     * @param func The callback function to be used
14544     * @param data User data
14545     *
14546     * @see elm_web_inwin_mode_set()
14547     */
14548    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
14549
14550    /**
14551     * Sets the function to call when an prompt dialog
14552     *
14553     * This hook will be called when a JavaScript prompt dialog is requested.
14554     * If no function is set or @c NULL is passed in @p func, the default
14555     * implementation will take place.
14556     *
14557     * @param obj The web object where to set the hook function
14558     * @param func The callback function to be used
14559     * @param data User data
14560     *
14561     * @see elm_web_inwin_mode_set()
14562     */
14563    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
14564
14565    /**
14566     * Sets the function to call when an file selector dialog
14567     *
14568     * This hook will be called when a JavaScript file selector dialog is
14569     * requested.
14570     * If no function is set or @c NULL is passed in @p func, the default
14571     * implementation will take place.
14572     *
14573     * @param obj The web object where to set the hook function
14574     * @param func The callback function to be used
14575     * @param data User data
14576     *
14577     * @see elm_web_inwin_mode_set()
14578     */
14579    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
14580
14581    /**
14582     * Sets the function to call when a console message is emitted from JS
14583     *
14584     * This hook will be called when a console message is emitted from
14585     * JavaScript. There is no default implementation for this feature.
14586     *
14587     * @param obj The web object where to set the hook function
14588     * @param func The callback function to be used
14589     * @param data User data
14590     */
14591    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
14592
14593    /**
14594     * Gets the status of the tab propagation
14595     *
14596     * @param obj The web object to query
14597     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
14598     *
14599     * @see elm_web_tab_propagate_set()
14600     */
14601    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
14602
14603    /**
14604     * Sets whether to use tab propagation
14605     *
14606     * If tab propagation is enabled, whenever the user presses the Tab key,
14607     * Elementary will handle it and switch focus to the next widget.
14608     * The default value is disabled, where WebKit will handle the Tab key to
14609     * cycle focus though its internal objects, jumping to the next widget
14610     * only when that cycle ends.
14611     *
14612     * @param obj The web object
14613     * @param propagate Whether to propagate Tab keys to Elementary or not
14614     */
14615    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
14616
14617    /**
14618     * Sets the URI for the web object
14619     *
14620     * It must be a full URI, with resource included, in the form
14621     * http://www.enlightenment.org or file:///tmp/something.html
14622     *
14623     * @param obj The web object
14624     * @param uri The URI to set
14625     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
14626     */
14627    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
14628
14629    /**
14630     * Gets the current URI for the object
14631     *
14632     * The returned string must not be freed and is guaranteed to be
14633     * stringshared.
14634     *
14635     * @param obj The web object
14636     * @return A stringshared internal string with the current URI, or NULL on
14637     * failure
14638     */
14639    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
14640
14641    /**
14642     * Gets the current title
14643     *
14644     * The returned string must not be freed and is guaranteed to be
14645     * stringshared.
14646     *
14647     * @param obj The web object
14648     * @return A stringshared internal string with the current title, or NULL on
14649     * failure
14650     */
14651    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
14652
14653    /**
14654     * Sets the background color to be used by the web object
14655     *
14656     * This is the color that will be used by default when the loaded page
14657     * does not set it's own. Color values are pre-multiplied.
14658     *
14659     * @param obj The web object
14660     * @param r Red component
14661     * @param g Green component
14662     * @param b Blue component
14663     * @param a Alpha component
14664     */
14665    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
14666
14667    /**
14668     * Gets the background color to be used by the web object
14669     *
14670     * This is the color that will be used by default when the loaded page
14671     * does not set it's own. Color values are pre-multiplied.
14672     *
14673     * @param obj The web object
14674     * @param r Red component
14675     * @param g Green component
14676     * @param b Blue component
14677     * @param a Alpha component
14678     */
14679    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
14680
14681    /**
14682     * Gets a copy of the currently selected text
14683     *
14684     * The string returned must be freed by the user when it's done with it.
14685     *
14686     * @param obj The web object
14687     * @return A newly allocated string, or NULL if nothing is selected or an
14688     * error occurred
14689     */
14690    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
14691
14692    /**
14693     * Tells the web object which index in the currently open popup was selected
14694     *
14695     * When the user handles the popup creation from the "popup,created" signal,
14696     * it needs to tell the web object which item was selected by calling this
14697     * function with the index corresponding to the item.
14698     *
14699     * @param obj The web object
14700     * @param index The index selected
14701     *
14702     * @see elm_web_popup_destroy()
14703     */
14704    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
14705
14706    /**
14707     * Dismisses an open dropdown popup
14708     *
14709     * When the popup from a dropdown widget is to be dismissed, either after
14710     * selecting an option or to cancel it, this function must be called, which
14711     * will later emit an "popup,willdelete" signal to notify the user that
14712     * any memory and objects related to this popup can be freed.
14713     *
14714     * @param obj The web object
14715     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
14716     * if there was no menu to destroy
14717     */
14718    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
14719
14720    /**
14721     * Searches the given string in a document.
14722     *
14723     * @param obj The web object where to search the text
14724     * @param string String to search
14725     * @param case_sensitive If search should be case sensitive or not
14726     * @param forward If search is from cursor and on or backwards
14727     * @param wrap If search should wrap at the end
14728     *
14729     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
14730     * or failure
14731     */
14732    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
14733
14734    /**
14735     * Marks matches of the given string in a document.
14736     *
14737     * @param obj The web object where to search text
14738     * @param string String to match
14739     * @param case_sensitive If match should be case sensitive or not
14740     * @param highlight If matches should be highlighted
14741     * @param limit Maximum amount of matches, or zero to unlimited
14742     *
14743     * @return number of matched @a string
14744     */
14745    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
14746
14747    /**
14748     * Clears all marked matches in the document
14749     *
14750     * @param obj The web object
14751     *
14752     * @return EINA_TRUE on success, EINA_FALSE otherwise
14753     */
14754    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
14755
14756    /**
14757     * Sets whether to highlight the matched marks
14758     *
14759     * If enabled, marks set with elm_web_text_matches_mark() will be
14760     * highlighted.
14761     *
14762     * @param obj The web object
14763     * @param highlight Whether to highlight the marks or not
14764     *
14765     * @return EINA_TRUE on success, EINA_FALSE otherwise
14766     */
14767    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
14768
14769    /**
14770     * Gets whether highlighting marks is enabled
14771     *
14772     * @param The web object
14773     *
14774     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
14775     * otherwise
14776     */
14777    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
14778
14779    /**
14780     * Gets the overall loading progress of the page
14781     *
14782     * Returns the estimated loading progress of the page, with a value between
14783     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
14784     * included in the page.
14785     *
14786     * @param The web object
14787     *
14788     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
14789     * failure
14790     */
14791    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
14792
14793    /**
14794     * Stops loading the current page
14795     *
14796     * Cancels the loading of the current page in the web object. This will
14797     * cause a "load,error" signal to be emitted, with the is_cancellation
14798     * flag set to EINA_TRUE.
14799     *
14800     * @param obj The web object
14801     *
14802     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
14803     */
14804    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
14805
14806    /**
14807     * Requests a reload of the current document in the object
14808     *
14809     * @param obj The web object
14810     *
14811     * @return EINA_TRUE on success, EINA_FALSE otherwise
14812     */
14813    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
14814
14815    /**
14816     * Requests a reload of the current document, avoiding any existing caches
14817     *
14818     * @param obj The web object
14819     *
14820     * @return EINA_TRUE on success, EINA_FALSE otherwise
14821     */
14822    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
14823
14824    /**
14825     * Goes back one step in the browsing history
14826     *
14827     * This is equivalent to calling elm_web_object_navigate(obj, -1);
14828     *
14829     * @param obj The web object
14830     *
14831     * @return EINA_TRUE on success, EINA_FALSE otherwise
14832     *
14833     * @see elm_web_history_enable_set()
14834     * @see elm_web_back_possible()
14835     * @see elm_web_forward()
14836     * @see elm_web_navigate()
14837     */
14838    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14839
14840    /**
14841     * Goes forward one step in the browsing history
14842     *
14843     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14844     *
14845     * @param obj The web object
14846     *
14847     * @return EINA_TRUE on success, EINA_FALSE otherwise
14848     *
14849     * @see elm_web_history_enable_set()
14850     * @see elm_web_forward_possible()
14851     * @see elm_web_back()
14852     * @see elm_web_navigate()
14853     */
14854    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14855
14856    /**
14857     * Jumps the given number of steps in the browsing history
14858     *
14859     * The @p steps value can be a negative integer to back in history, or a
14860     * positive to move forward.
14861     *
14862     * @param obj The web object
14863     * @param steps The number of steps to jump
14864     *
14865     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14866     * history exists to jump the given number of steps
14867     *
14868     * @see elm_web_history_enable_set()
14869     * @see elm_web_navigate_possible()
14870     * @see elm_web_back()
14871     * @see elm_web_forward()
14872     */
14873    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14874
14875    /**
14876     * Queries whether it's possible to go back in history
14877     *
14878     * @param obj The web object
14879     *
14880     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14881     * otherwise
14882     */
14883    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14884
14885    /**
14886     * Queries whether it's possible to go forward in history
14887     *
14888     * @param obj The web object
14889     *
14890     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14891     * otherwise
14892     */
14893    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14894
14895    /**
14896     * Queries whether it's possible to jump the given number of steps
14897     *
14898     * The @p steps value can be a negative integer to back in history, or a
14899     * positive to move forward.
14900     *
14901     * @param obj The web object
14902     * @param steps The number of steps to check for
14903     *
14904     * @return EINA_TRUE if enough history exists to perform the given jump,
14905     * EINA_FALSE otherwise
14906     */
14907    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14908
14909    /**
14910     * Gets whether browsing history is enabled for the given object
14911     *
14912     * @param obj The web object
14913     *
14914     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14915     */
14916    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14917
14918    /**
14919     * Enables or disables the browsing history
14920     *
14921     * @param obj The web object
14922     * @param enable Whether to enable or disable the browsing history
14923     */
14924    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14925
14926    /**
14927     * Sets the zoom level of the web object
14928     *
14929     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14930     * values meaning zoom in and lower meaning zoom out. This function will
14931     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14932     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14933     *
14934     * @param obj The web object
14935     * @param zoom The zoom level to set
14936     */
14937    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14938
14939    /**
14940     * Gets the current zoom level set on the web object
14941     *
14942     * Note that this is the zoom level set on the web object and not that
14943     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14944     * the two zoom levels should match, but for the other two modes the
14945     * Webkit zoom is calculated internally to match the chosen mode without
14946     * changing the zoom level set for the web object.
14947     *
14948     * @param obj The web object
14949     *
14950     * @return The zoom level set on the object
14951     */
14952    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14953
14954    /**
14955     * Sets the zoom mode to use
14956     *
14957     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14958     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14959     *
14960     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14961     * with the elm_web_zoom_set() function.
14962     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14963     * make sure the entirety of the web object's contents are shown.
14964     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14965     * fit the contents in the web object's size, without leaving any space
14966     * unused.
14967     *
14968     * @param obj The web object
14969     * @param mode The mode to set
14970     */
14971    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14972
14973    /**
14974     * Gets the currently set zoom mode
14975     *
14976     * @param obj The web object
14977     *
14978     * @return The current zoom mode set for the object, or
14979     * ::ELM_WEB_ZOOM_MODE_LAST on error
14980     */
14981    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14982
14983    /**
14984     * Shows the given region in the web object
14985     *
14986     * @param obj The web object
14987     * @param x The x coordinate of the region to show
14988     * @param y The y coordinate of the region to show
14989     * @param w The width of the region to show
14990     * @param h The height of the region to show
14991     */
14992    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14993
14994    /**
14995     * Brings in the region to the visible area
14996     *
14997     * Like elm_web_region_show(), but it animates the scrolling of the object
14998     * to show the area
14999     *
15000     * @param obj The web object
15001     * @param x The x coordinate of the region to show
15002     * @param y The y coordinate of the region to show
15003     * @param w The width of the region to show
15004     * @param h The height of the region to show
15005     */
15006    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
15007
15008    /**
15009     * Sets the default dialogs to use an Inwin instead of a normal window
15010     *
15011     * If set, then the default implementation for the JavaScript dialogs and
15012     * file selector will be opened in an Inwin. Otherwise they will use a
15013     * normal separated window.
15014     *
15015     * @param obj The web object
15016     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
15017     */
15018    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
15019
15020    /**
15021     * Gets whether Inwin mode is set for the current object
15022     *
15023     * @param obj The web object
15024     *
15025     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
15026     */
15027    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
15028
15029    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
15030    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
15031    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);
15032    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
15033
15034    /**
15035     * @}
15036     */
15037
15038    /**
15039     * @defgroup Hoversel Hoversel
15040     *
15041     * @image html img/widget/hoversel/preview-00.png
15042     * @image latex img/widget/hoversel/preview-00.eps
15043     *
15044     * A hoversel is a button that pops up a list of items (automatically
15045     * choosing the direction to display) that have a label and, optionally, an
15046     * icon to select from. It is a convenience widget to avoid the need to do
15047     * all the piecing together yourself. It is intended for a small number of
15048     * items in the hoversel menu (no more than 8), though is capable of many
15049     * more.
15050     *
15051     * Signals that you can add callbacks for are:
15052     * "clicked" - the user clicked the hoversel button and popped up the sel
15053     * "selected" - an item in the hoversel list is selected. event_info is the item
15054     * "dismissed" - the hover is dismissed
15055     *
15056     * Default contents parts of the hoversel widget that you can use for are:
15057     * @li "icon" - An icon of the hoversel
15058     * 
15059     * Default text parts of the hoversel widget that you can use for are:
15060     * @li "default" - Label of the hoversel
15061     *  
15062     * Supported elm_object common APIs.
15063     * @li elm_object_disabled_set
15064     * @li elm_object_text_set
15065     * @li elm_object_part_text_set
15066     * @li elm_object_text_get
15067     * @li elm_object_part_text_get
15068     * @li elm_object_content_set
15069     * @li elm_object_part_content_set
15070     * @li elm_object_content_unset
15071     * @li elm_object_part_content_unset
15072     *
15073     * Supported elm_object_item common APIs.
15074     * @li elm_object_item_text_get
15075     * @li elm_object_item_part_text_get
15076     *
15077     * See @ref tutorial_hoversel for an example.
15078     * @{
15079     */
15080
15081    /**
15082     * @brief Add a new Hoversel object
15083     *
15084     * @param parent The parent object
15085     * @return The new object or NULL if it cannot be created
15086     */
15087    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15088
15089    /**
15090     * @brief This sets the hoversel to expand horizontally.
15091     *
15092     * @param obj The hoversel object
15093     * @param horizontal If true, the hover will expand horizontally to the
15094     * right.
15095     *
15096     * @note The initial button will display horizontally regardless of this
15097     * setting.
15098     */
15099    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15100
15101    /**
15102     * @brief This returns whether the hoversel is set to expand horizontally.
15103     *
15104     * @param obj The hoversel object
15105     * @return If true, the hover will expand horizontally to the right.
15106     *
15107     * @see elm_hoversel_horizontal_set()
15108     */
15109    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15110
15111    /**
15112     * @brief Set the Hover parent
15113     *
15114     * @param obj The hoversel object
15115     * @param parent The parent to use
15116     *
15117     * Sets the hover parent object, the area that will be darkened when the
15118     * hoversel is clicked. Should probably be the window that the hoversel is
15119     * in. See @ref Hover objects for more information.
15120     */
15121    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15122    /**
15123     * @brief Get the Hover parent
15124     *
15125     * @param obj The hoversel object
15126     * @return The used parent
15127     *
15128     * Gets the hover parent object.
15129     *
15130     * @see elm_hoversel_hover_parent_set()
15131     */
15132    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15133
15134    /**
15135     * @brief Set the hoversel button label
15136     *
15137     * @param obj The hoversel object
15138     * @param label The label text.
15139     *
15140     * This sets the label of the button that is always visible (before it is
15141     * clicked and expanded).
15142     *
15143     * @deprecated elm_object_text_set()
15144     */
15145    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15146
15147    /**
15148     * @brief Get the hoversel button label
15149     *
15150     * @param obj The hoversel object
15151     * @return The label text.
15152     *
15153     * @deprecated elm_object_text_get()
15154     */
15155    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15156
15157    /**
15158     * @brief Set the icon of the hoversel button
15159     *
15160     * @param obj The hoversel object
15161     * @param icon The icon object
15162     *
15163     * Sets the icon of the button that is always visible (before it is clicked
15164     * and expanded).  Once the icon object is set, a previously set one will be
15165     * deleted, if you want to keep that old content object, use the
15166     * elm_hoversel_icon_unset() function.
15167     *
15168     * @see elm_object_content_set() for the button widget
15169     * @deprecated Use elm_object_item_part_content_set() instead
15170     */
15171    EINA_DEPRECATED EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15172
15173    /**
15174     * @brief Get the icon of the hoversel button
15175     *
15176     * @param obj The hoversel object
15177     * @return The icon object
15178     *
15179     * Get the icon of the button that is always visible (before it is clicked
15180     * and expanded). Also see elm_object_content_get() for the button widget.
15181     *
15182     * @see elm_hoversel_icon_set()
15183     * @deprecated Use elm_object_item_part_content_get() instead
15184     */
15185    EINA_DEPRECATED EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15186
15187    /**
15188     * @brief Get and unparent the icon of the hoversel button
15189     *
15190     * @param obj The hoversel object
15191     * @return The icon object that was being used
15192     *
15193     * Unparent and return the icon of the button that is always visible
15194     * (before it is clicked and expanded).
15195     *
15196     * @see elm_hoversel_icon_set()
15197     * @see elm_object_content_unset() for the button widget
15198     * @deprecated Use elm_object_item_part_content_unset() instead
15199     */
15200    EINA_DEPRECATED EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15201
15202    /**
15203     * @brief This triggers the hoversel popup from code, the same as if the user
15204     * had clicked the button.
15205     *
15206     * @param obj The hoversel object
15207     */
15208    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
15209
15210    /**
15211     * @brief This dismisses the hoversel popup as if the user had clicked
15212     * outside the hover.
15213     *
15214     * @param obj The hoversel object
15215     */
15216    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
15217
15218    /**
15219     * @brief Returns whether the hoversel is expanded.
15220     *
15221     * @param obj The hoversel object
15222     * @return  This will return EINA_TRUE if the hoversel is expanded or
15223     * EINA_FALSE if it is not expanded.
15224     */
15225    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15226
15227    /**
15228     * @brief This will remove all the children items from the hoversel.
15229     *
15230     * @param obj The hoversel object
15231     *
15232     * @warning Should @b not be called while the hoversel is active; use
15233     * elm_hoversel_expanded_get() to check first.
15234     *
15235     * @see elm_hoversel_item_del_cb_set()
15236     * @see elm_hoversel_item_del()
15237     */
15238    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15239
15240    /**
15241     * @brief Get the list of items within the given hoversel.
15242     *
15243     * @param obj The hoversel object
15244     * @return Returns a list of Elm_Object_Item*
15245     *
15246     * @see elm_hoversel_item_add()
15247     */
15248    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15249
15250    /**
15251     * @brief Add an item to the hoversel button
15252     *
15253     * @param obj The hoversel object
15254     * @param label The text label to use for the item (NULL if not desired)
15255     * @param icon_file An image file path on disk to use for the icon or standard
15256     * icon name (NULL if not desired)
15257     * @param icon_type The icon type if relevant
15258     * @param func Convenience function to call when this item is selected
15259     * @param data Data to pass to item-related functions
15260     * @return A handle to the item added.
15261     *
15262     * This adds an item to the hoversel to show when it is clicked. Note: if you
15263     * need to use an icon from an edje file then use
15264     * elm_hoversel_item_icon_set() right after the this function, and set
15265     * icon_file to NULL here.
15266     *
15267     * For more information on what @p icon_file and @p icon_type are see the
15268     * @ref Icon "icon documentation".
15269     */
15270    EAPI Elm_Object_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);
15271
15272    /**
15273     * @brief Delete an item from the hoversel
15274     *
15275     * @param it The item to delete
15276     *
15277     * This deletes the item from the hoversel (should not be called while the
15278     * hoversel is active; use elm_hoversel_expanded_get() to check first).
15279     *
15280     * @see elm_hoversel_item_add()
15281     * @see elm_hoversel_item_del_cb_set()
15282     */
15283    EAPI void               elm_hoversel_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15284
15285    /**
15286     * @brief Set the function to be called when an item from the hoversel is
15287     * freed.
15288     *
15289     * @param item The item to set the callback on
15290     * @param func The function called
15291     *
15292     * That function will receive these parameters:
15293     * @li void * item data
15294     * @li Evas_Object * hoversel object
15295     * @li Elm_Object_Item * hoversel item
15296     *
15297     * @see elm_hoversel_item_add()
15298     */
15299    EAPI void               elm_hoversel_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15300
15301    /**
15302     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
15303     * that will be passed to associated function callbacks.
15304     *
15305     * @param it The item to get the data from
15306     * @return The data pointer set with elm_hoversel_item_add()
15307     *
15308     * @see elm_hoversel_item_add()
15309     * @deprecated Use elm_object_item_data_get() instead
15310     */
15311    EINA_DEPRECATED EAPI void              *elm_hoversel_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15312
15313    /**
15314     * @brief This returns the label text of the given hoversel item.
15315     *
15316     * @param it The item to get the label
15317     * @return The label text of the hoversel item
15318     *
15319     * @see elm_hoversel_item_add()
15320     * @deprecated Use elm_object_item_text_get() instead
15321     */
15322    EINA_DEPRECATED EAPI const char        *elm_hoversel_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15323
15324    /**
15325     * @brief This sets the icon for the given hoversel item.
15326     *
15327     * @param item The item to set the icon
15328     * @param icon_file An image file path on disk to use for the icon or standard
15329     * icon name
15330     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
15331     * to NULL if the icon is not an edje file
15332     * @param icon_type The icon type
15333     *
15334     * The icon can be loaded from the standard set, from an image file, or from
15335     * an edje file.
15336     *
15337     * @see elm_hoversel_item_add()
15338     */
15339    EAPI void               elm_hoversel_item_icon_set(Elm_Object_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
15340
15341    /**
15342     * @brief Get the icon object of the hoversel item
15343     *
15344     * @param item The item to get the icon from
15345     * @param icon_file The image file path on disk used for the icon or standard
15346     * icon name
15347     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
15348     * if the icon is not an edje file
15349     * @param icon_type The icon type
15350     *
15351     * @see elm_hoversel_item_icon_set()
15352     * @see elm_hoversel_item_add()
15353     */
15354    EAPI void               elm_hoversel_item_icon_get(const Elm_Object_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
15355
15356    /**
15357     * @}
15358     */
15359
15360    /**
15361     * @defgroup Toolbar Toolbar
15362     * @ingroup Elementary
15363     *
15364     * @image html img/widget/toolbar/preview-00.png
15365     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
15366     *
15367     * @image html img/toolbar.png
15368     * @image latex img/toolbar.eps width=\textwidth
15369     *
15370     * A toolbar is a widget that displays a list of items inside
15371     * a box. It can be scrollable, show a menu with items that don't fit
15372     * to toolbar size or even crop them.
15373     *
15374     * Only one item can be selected at a time.
15375     *
15376     * Items can have multiple states, or show menus when selected by the user.
15377     *
15378     * Smart callbacks one can listen to:
15379     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
15380     * - "language,changed" - when the program language changes
15381     *
15382     * Available styles for it:
15383     * - @c "default"
15384     * - @c "transparent" - no background or shadow, just show the content
15385     *
15386     * Default text parts of the toolbar items that you can use for are:
15387     * @li "default" - label of the toolbar item
15388     *  
15389     * Supported elm_object_item common APIs.
15390     * @li elm_object_item_disabled_set
15391     * @li elm_object_item_text_set
15392     * @li elm_object_item_part_text_set
15393     * @li elm_object_item_text_get
15394     * @li elm_object_item_part_text_get
15395     *
15396     * List of examples:
15397     * @li @ref toolbar_example_01
15398     * @li @ref toolbar_example_02
15399     * @li @ref toolbar_example_03
15400     */
15401
15402    /**
15403     * @addtogroup Toolbar
15404     * @{
15405     */
15406
15407    /**
15408     * @enum _Elm_Toolbar_Shrink_Mode
15409     * @typedef Elm_Toolbar_Shrink_Mode
15410     *
15411     * Set toolbar's items display behavior, it can be scrollabel,
15412     * show a menu with exceeding items, or simply hide them.
15413     *
15414     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
15415     * from elm config.
15416     *
15417     * Values <b> don't </b> work as bitmask, only one can be choosen.
15418     *
15419     * @see elm_toolbar_mode_shrink_set()
15420     * @see elm_toolbar_mode_shrink_get()
15421     *
15422     * @ingroup Toolbar
15423     */
15424    typedef enum _Elm_Toolbar_Shrink_Mode
15425      {
15426         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
15427         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
15428         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
15429         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
15430         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
15431      } Elm_Toolbar_Shrink_Mode;
15432
15433    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(). */
15434
15435    /**
15436     * Add a new toolbar widget to the given parent Elementary
15437     * (container) object.
15438     *
15439     * @param parent The parent object.
15440     * @return a new toolbar widget handle or @c NULL, on errors.
15441     *
15442     * This function inserts a new toolbar widget on the canvas.
15443     *
15444     * @ingroup Toolbar
15445     */
15446    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15447
15448    /**
15449     * Set the icon size, in pixels, to be used by toolbar items.
15450     *
15451     * @param obj The toolbar object
15452     * @param icon_size The icon size in pixels
15453     *
15454     * @note Default value is @c 32. It reads value from elm config.
15455     *
15456     * @see elm_toolbar_icon_size_get()
15457     *
15458     * @ingroup Toolbar
15459     */
15460    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
15461
15462    /**
15463     * Get the icon size, in pixels, to be used by toolbar items.
15464     *
15465     * @param obj The toolbar object.
15466     * @return The icon size in pixels.
15467     *
15468     * @see elm_toolbar_icon_size_set() for details.
15469     *
15470     * @ingroup Toolbar
15471     */
15472    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15473
15474    /**
15475     * Sets icon lookup order, for toolbar items' icons.
15476     *
15477     * @param obj The toolbar object.
15478     * @param order The icon lookup order.
15479     *
15480     * Icons added before calling this function will not be affected.
15481     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
15482     *
15483     * @see elm_toolbar_icon_order_lookup_get()
15484     *
15485     * @ingroup Toolbar
15486     */
15487    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
15488
15489    /**
15490     * Gets the icon lookup order.
15491     *
15492     * @param obj The toolbar object.
15493     * @return The icon lookup order.
15494     *
15495     * @see elm_toolbar_icon_order_lookup_set() for details.
15496     *
15497     * @ingroup Toolbar
15498     */
15499    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15500
15501    /**
15502     * Set whether the toolbar should always have an item selected.
15503     *
15504     * @param obj The toolbar object.
15505     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
15506     * disable it.
15507     *
15508     * This will cause the toolbar to always have an item selected, and clicking
15509     * the selected item will not cause a selected event to be emitted. Enabling this mode
15510     * will immediately select the first toolbar item.
15511     *
15512     * Always-selected is disabled by default.
15513     *
15514     * @see elm_toolbar_always_select_mode_get().
15515     *
15516     * @ingroup Toolbar
15517     */
15518    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15519
15520    /**
15521     * Get whether the toolbar should always have an item selected.
15522     *
15523     * @param obj The toolbar object.
15524     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
15525     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
15526     *
15527     * @see elm_toolbar_always_select_mode_set() for details.
15528     *
15529     * @ingroup Toolbar
15530     */
15531    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15532
15533    /**
15534     * Set whether the toolbar items' should be selected by the user or not.
15535     *
15536     * @param obj The toolbar object.
15537     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
15538     * enable it.
15539     *
15540     * This will turn off the ability to select items entirely and they will
15541     * neither appear selected nor emit selected signals. The clicked
15542     * callback function will still be called.
15543     *
15544     * Selection is enabled by default.
15545     *
15546     * @see elm_toolbar_no_select_mode_get().
15547     *
15548     * @ingroup Toolbar
15549     */
15550    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
15551
15552    /**
15553     * Set whether the toolbar items' should be selected by the user or not.
15554     *
15555     * @param obj The toolbar object.
15556     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
15557     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
15558     *
15559     * @see elm_toolbar_no_select_mode_set() for details.
15560     *
15561     * @ingroup Toolbar
15562     */
15563    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15564
15565    /**
15566     * Append item to the toolbar.
15567     *
15568     * @param obj The toolbar object.
15569     * @param icon A string with icon name or the absolute path of an image file.
15570     * @param label The label of the item.
15571     * @param func The function to call when the item is clicked.
15572     * @param data The data to associate with the item for related callbacks.
15573     * @return The created item or @c NULL upon failure.
15574     *
15575     * A new item will be created and appended to the toolbar, i.e., will
15576     * be set as @b last item.
15577     *
15578     * Items created with this method can be deleted with
15579     * elm_toolbar_item_del().
15580     *
15581     * Associated @p data can be properly freed when item is deleted if a
15582     * callback function is set with elm_toolbar_item_del_cb_set().
15583     *
15584     * If a function is passed as argument, it will be called everytime this item
15585     * is selected, i.e., the user clicks over an unselected item.
15586     * If such function isn't needed, just passing
15587     * @c NULL as @p func is enough. The same should be done for @p data.
15588     *
15589     * Toolbar will load icon image from fdo or current theme.
15590     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15591     * If an absolute path is provided it will load it direct from a file.
15592     *
15593     * @see elm_toolbar_item_icon_set()
15594     * @see elm_toolbar_item_del()
15595     * @see elm_toolbar_item_del_cb_set()
15596     *
15597     * @ingroup Toolbar
15598     */
15599    EAPI Elm_Object_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);
15600
15601    /**
15602     * Prepend item to the toolbar.
15603     *
15604     * @param obj The toolbar object.
15605     * @param icon A string with icon name or the absolute path of an image file.
15606     * @param label The label of the item.
15607     * @param func The function to call when the item is clicked.
15608     * @param data The data to associate with the item for related callbacks.
15609     * @return The created item or @c NULL upon failure.
15610     *
15611     * A new item will be created and prepended to the toolbar, i.e., will
15612     * be set as @b first item.
15613     *
15614     * Items created with this method can be deleted with
15615     * elm_toolbar_item_del().
15616     *
15617     * Associated @p data can be properly freed when item is deleted if a
15618     * callback function is set with elm_toolbar_item_del_cb_set().
15619     *
15620     * If a function is passed as argument, it will be called everytime this item
15621     * is selected, i.e., the user clicks over an unselected item.
15622     * If such function isn't needed, just passing
15623     * @c NULL as @p func is enough. The same should be done for @p data.
15624     *
15625     * Toolbar will load icon image from fdo or current theme.
15626     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15627     * If an absolute path is provided it will load it direct from a file.
15628     *
15629     * @see elm_toolbar_item_icon_set()
15630     * @see elm_toolbar_item_del()
15631     * @see elm_toolbar_item_del_cb_set()
15632     *
15633     * @ingroup Toolbar
15634     */
15635    EAPI Elm_Object_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);
15636
15637    /**
15638     * Insert a new item into the toolbar object before item @p before.
15639     *
15640     * @param obj The toolbar object.
15641     * @param before The toolbar item to insert before.
15642     * @param icon A string with icon name or the absolute path of an image file.
15643     * @param label The label of the item.
15644     * @param func The function to call when the item is clicked.
15645     * @param data The data to associate with the item for related callbacks.
15646     * @return The created item or @c NULL upon failure.
15647     *
15648     * A new item will be created and added to the toolbar. Its position in
15649     * this toolbar will be just before item @p before.
15650     *
15651     * Items created with this method can be deleted with
15652     * elm_toolbar_item_del().
15653     *
15654     * Associated @p data can be properly freed when item is deleted if a
15655     * callback function is set with elm_toolbar_item_del_cb_set().
15656     *
15657     * If a function is passed as argument, it will be called everytime this item
15658     * is selected, i.e., the user clicks over an unselected item.
15659     * If such function isn't needed, just passing
15660     * @c NULL as @p func is enough. The same should be done for @p data.
15661     *
15662     * Toolbar will load icon image from fdo or current theme.
15663     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15664     * If an absolute path is provided it will load it direct from a file.
15665     *
15666     * @see elm_toolbar_item_icon_set()
15667     * @see elm_toolbar_item_del()
15668     * @see elm_toolbar_item_del_cb_set()
15669     *
15670     * @ingroup Toolbar
15671     */
15672    EAPI Elm_Object_Item       *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15673
15674    /**
15675     * Insert a new item into the toolbar object after item @p after.
15676     *
15677     * @param obj The toolbar object.
15678     * @param after The toolbar item to insert after.
15679     * @param icon A string with icon name or the absolute path of an image file.
15680     * @param label The label of the item.
15681     * @param func The function to call when the item is clicked.
15682     * @param data The data to associate with the item for related callbacks.
15683     * @return The created item or @c NULL upon failure.
15684     *
15685     * A new item will be created and added to the toolbar. Its position in
15686     * this toolbar will be just after item @p after.
15687     *
15688     * Items created with this method can be deleted with
15689     * elm_toolbar_item_del().
15690     *
15691     * Associated @p data can be properly freed when item is deleted if a
15692     * callback function is set with elm_toolbar_item_del_cb_set().
15693     *
15694     * If a function is passed as argument, it will be called everytime this item
15695     * is selected, i.e., the user clicks over an unselected item.
15696     * If such function isn't needed, just passing
15697     * @c NULL as @p func is enough. The same should be done for @p data.
15698     *
15699     * Toolbar will load icon image from fdo or current theme.
15700     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15701     * If an absolute path is provided it will load it direct from a file.
15702     *
15703     * @see elm_toolbar_item_icon_set()
15704     * @see elm_toolbar_item_del()
15705     * @see elm_toolbar_item_del_cb_set()
15706     *
15707     * @ingroup Toolbar
15708     */
15709    EAPI Elm_Object_Item       *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15710
15711    /**
15712     * Get the first item in the given toolbar widget's list of
15713     * items.
15714     *
15715     * @param obj The toolbar object
15716     * @return The first item or @c NULL, if it has no items (and on
15717     * errors)
15718     *
15719     * @see elm_toolbar_item_append()
15720     * @see elm_toolbar_last_item_get()
15721     *
15722     * @ingroup Toolbar
15723     */
15724    EAPI Elm_Object_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15725
15726    /**
15727     * Get the last item in the given toolbar widget's list of
15728     * items.
15729     *
15730     * @param obj The toolbar object
15731     * @return The last item or @c NULL, if it has no items (and on
15732     * errors)
15733     *
15734     * @see elm_toolbar_item_prepend()
15735     * @see elm_toolbar_first_item_get()
15736     *
15737     * @ingroup Toolbar
15738     */
15739    EAPI Elm_Object_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15740
15741    /**
15742     * Get the item after @p item in toolbar.
15743     *
15744     * @param it The toolbar item.
15745     * @return The item after @p item, or @c NULL if none or on failure.
15746     *
15747     * @note If it is the last item, @c NULL will be returned.
15748     *
15749     * @see elm_toolbar_item_append()
15750     *
15751     * @ingroup Toolbar
15752     */
15753    EAPI Elm_Object_Item       *elm_toolbar_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15754
15755    /**
15756     * Get the item before @p item in toolbar.
15757     *
15758     * @param item The toolbar item.
15759     * @return The item before @p item, or @c NULL if none or on failure.
15760     *
15761     * @note If it is the first item, @c NULL will be returned.
15762     *
15763     * @see elm_toolbar_item_prepend()
15764     *
15765     * @ingroup Toolbar
15766     */
15767    EAPI Elm_Object_Item       *elm_toolbar_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15768
15769    /**
15770     * Get the toolbar object from an item.
15771     *
15772     * @param it The item.
15773     * @return The toolbar object.
15774     *
15775     * This returns the toolbar object itself that an item belongs to.
15776     *
15777          * @deprecated use elm_object_item_object_get() instead.
15778     * @ingroup Toolbar
15779     */
15780    EINA_DEPRECATED EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15781
15782    /**
15783     * Set the priority of a toolbar item.
15784     *
15785     * @param it The toolbar item.
15786     * @param priority The item priority. The default is zero.
15787     *
15788     * This is used only when the toolbar shrink mode is set to
15789     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
15790     * When space is less than required, items with low priority
15791     * will be removed from the toolbar and added to a dynamically-created menu,
15792     * while items with higher priority will remain on the toolbar,
15793     * with the same order they were added.
15794     *
15795     * @see elm_toolbar_item_priority_get()
15796     *
15797     * @ingroup Toolbar
15798     */
15799    EAPI void                    elm_toolbar_item_priority_set(Elm_Object_Item *it, int priority) EINA_ARG_NONNULL(1);
15800
15801    /**
15802     * Get the priority of a toolbar item.
15803     *
15804     * @param it The toolbar item.
15805     * @return The @p item priority, or @c 0 on failure.
15806     *
15807     * @see elm_toolbar_item_priority_set() for details.
15808     *
15809     * @ingroup Toolbar
15810     */
15811    EAPI int                     elm_toolbar_item_priority_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15812
15813    /**
15814     * Get the label of item.
15815     *
15816     * @param it The item of toolbar.
15817     * @return The label of item.
15818     *
15819     * The return value is a pointer to the label associated to @p item when
15820     * it was created, with function elm_toolbar_item_append() or similar,
15821     * or later,
15822     * with function elm_toolbar_item_label_set. If no label
15823     * was passed as argument, it will return @c NULL.
15824     *
15825     * @see elm_toolbar_item_label_set() for more details.
15826     * @see elm_toolbar_item_append()
15827     *
15828          * @deprecated use elm_object_item_text_get() instead.
15829     * @ingroup Toolbar
15830     */
15831    EINA_DEPRECATED EAPI const char             *elm_toolbar_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15832
15833    /**
15834     * Set the label of item.
15835     *
15836     * @param it The item of toolbar.
15837     * @param text The label of item.
15838     *
15839     * The label to be displayed by the item.
15840     * Label will be placed at icons bottom (if set).
15841     *
15842     * If a label was passed as argument on item creation, with function
15843     * elm_toolbar_item_append() or similar, it will be already
15844     * displayed by the item.
15845     *
15846     * @see elm_toolbar_item_label_get()
15847     * @see elm_toolbar_item_append()
15848     *
15849          * @deprecated use elm_object_item_text_set() instead
15850     * @ingroup Toolbar
15851     */
15852    EINA_DEPRECATED EAPI void                    elm_toolbar_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
15853
15854    /**
15855     * Return the data associated with a given toolbar widget item.
15856     *
15857     * @param it The toolbar widget item handle.
15858     * @return The data associated with @p item.
15859     *
15860     * @see elm_toolbar_item_data_set()
15861     *
15862     * @deprecated use elm_object_item_data_get() instead.
15863     * @ingroup Toolbar
15864     */
15865    EINA_DEPRECATED EAPI void                   *elm_toolbar_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15866
15867    /**
15868     * Set the data associated with a given toolbar widget item.
15869     *
15870     * @param it The toolbar widget item handle
15871     * @param data The new data pointer to set to @p item.
15872     *
15873     * This sets new item data on @p item.
15874     *
15875     * @warning The old data pointer won't be touched by this function, so
15876     * the user had better to free that old data himself/herself.
15877     *
15878     * @deprecated use elm_object_item_data_set() instead.
15879     * @ingroup Toolbar
15880     */
15881    EINA_DEPRECATED EAPI void                    elm_toolbar_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
15882
15883    /**
15884     * Returns a pointer to a toolbar item by its label.
15885     *
15886     * @param obj The toolbar object.
15887     * @param label The label of the item to find.
15888     *
15889     * @return The pointer to the toolbar item matching @p label or @c NULL
15890     * on failure.
15891     *
15892     * @ingroup Toolbar
15893     */
15894    EAPI Elm_Object_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15895
15896    /*
15897     * Get whether the @p item is selected or not.
15898     *
15899     * @param it The toolbar item.
15900     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15901     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15902     *
15903     * @see elm_toolbar_selected_item_set() for details.
15904     * @see elm_toolbar_item_selected_get()
15905     *
15906     * @ingroup Toolbar
15907     */
15908    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15909
15910    /**
15911     * Set the selected state of an item.
15912     *
15913     * @param it The toolbar item
15914     * @param selected The selected state
15915     *
15916     * This sets the selected state of the given item @p it.
15917     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15918     *
15919     * If a new item is selected the previosly selected will be unselected.
15920     * Previoulsy selected item can be get with function
15921     * elm_toolbar_selected_item_get().
15922     *
15923     * Selected items will be highlighted.
15924     *
15925     * @see elm_toolbar_item_selected_get()
15926     * @see elm_toolbar_selected_item_get()
15927     *
15928     * @ingroup Toolbar
15929     */
15930    EAPI void                    elm_toolbar_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
15931
15932    /**
15933     * Get the selected item.
15934     *
15935     * @param obj The toolbar object.
15936     * @return The selected toolbar item.
15937     *
15938     * The selected item can be unselected with function
15939     * elm_toolbar_item_selected_set().
15940     *
15941     * The selected item always will be highlighted on toolbar.
15942     *
15943     * @see elm_toolbar_selected_items_get()
15944     *
15945     * @ingroup Toolbar
15946     */
15947    EAPI Elm_Object_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15948
15949    /**
15950     * Set the icon associated with @p item.
15951     *
15952     * @param obj The parent of this item.
15953     * @param it The toolbar item.
15954     * @param icon A string with icon name or the absolute path of an image file.
15955     *
15956     * Toolbar will load icon image from fdo or current theme.
15957     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15958     * If an absolute path is provided it will load it direct from a file.
15959     *
15960     * @see elm_toolbar_icon_order_lookup_set()
15961     * @see elm_toolbar_icon_order_lookup_get()
15962     *
15963     * @ingroup Toolbar
15964     */
15965    EAPI void                    elm_toolbar_item_icon_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1);
15966
15967    /**
15968     * Get the string used to set the icon of @p item.
15969     *
15970     * @param it The toolbar item.
15971     * @return The string associated with the icon object.
15972     *
15973     * @see elm_toolbar_item_icon_set() for details.
15974     *
15975     * @ingroup Toolbar
15976     */
15977    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15978
15979    /**
15980     * Get the object of @p item.
15981     *
15982     * @param it The toolbar item.
15983     * @return The object
15984     *
15985     * @ingroup Toolbar
15986     */
15987    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
15988
15989    /**
15990     * Get the icon object of @p item.
15991     *
15992     * @param it The toolbar item.
15993     * @return The icon object
15994     *
15995     * @see elm_toolbar_item_icon_set(), elm_toolbar_item_icon_file_set(),
15996     * or elm_toolbar_item_icon_memfile_set() for details.
15997     *
15998     * @ingroup Toolbar
15999     */
16000    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16001
16002    /**
16003     * Set the icon associated with @p item to an image in a binary buffer.
16004     *
16005     * @param it The toolbar item.
16006     * @param img The binary data that will be used as an image
16007     * @param size The size of binary data @p img
16008     * @param format Optional format of @p img to pass to the image loader
16009     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16010     *
16011     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16012     *
16013     * @note The icon image set by this function can be changed by
16014     * elm_toolbar_item_icon_set().
16015     *
16016     * @ingroup Toolbar
16017     */
16018    EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Object_Item *it, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
16019
16020    /**
16021     * Set the icon associated with @p item to an image in a binary buffer.
16022     *
16023     * @param it The toolbar item.
16024     * @param file The file that contains the image
16025     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
16026     *
16027     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
16028     *
16029     * @note The icon image set by this function can be changed by
16030     * elm_toolbar_item_icon_set().
16031     *
16032     * @ingroup Toolbar
16033     */
16034    EAPI Eina_Bool elm_toolbar_item_icon_file_set(Elm_Object_Item *it, const char *file, const char *key) EINA_ARG_NONNULL(1);
16035
16036    /**
16037     * Delete them item from the toolbar.
16038     *
16039     * @param it The item of toolbar to be deleted.
16040     *
16041     * @see elm_toolbar_item_append()
16042     * @see elm_toolbar_item_del_cb_set()
16043     *
16044     * @ingroup Toolbar
16045     */
16046    EAPI void                    elm_toolbar_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16047
16048    /**
16049     * Set the function called when a toolbar item is freed.
16050     *
16051     * @param it The item to set the callback on.
16052     * @param func The function called.
16053     *
16054     * If there is a @p func, then it will be called prior item's memory release.
16055     * That will be called with the following arguments:
16056     * @li item's data;
16057     * @li item's Evas object;
16058     * @li item itself;
16059     *
16060     * This way, a data associated to a toolbar item could be properly freed.
16061     *
16062     * @ingroup Toolbar
16063     */
16064    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16065
16066    /**
16067     * Get a value whether toolbar item is disabled or not.
16068     *
16069     * @param it The item.
16070     * @return The disabled state.
16071     *
16072     * @see elm_toolbar_item_disabled_set() for more details.
16073     *
16074     * @deprecated use elm_object_item_disabled_get() instead.
16075     * @ingroup Toolbar
16076     */
16077    EINA_DEPRECATED EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16078
16079    /**
16080     * Sets the disabled/enabled state of a toolbar item.
16081     *
16082     * @param it The item.
16083     * @param disabled The disabled state.
16084     *
16085     * A disabled item cannot be selected or unselected. It will also
16086     * change its appearance (generally greyed out). This sets the
16087     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16088     * enabled).
16089     *
16090     * @deprecated use elm_object_item_disabled_set() instead.
16091     * @ingroup Toolbar
16092     */
16093    EINA_DEPRECATED EAPI void                    elm_toolbar_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16094
16095    /**
16096     * Set or unset item as a separator.
16097     *
16098     * @param it The toolbar item.
16099     * @param setting @c EINA_TRUE to set item @p item as separator or
16100     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16101     *
16102     * Items aren't set as separator by default.
16103     *
16104     * If set as separator it will display separator theme, so won't display
16105     * icons or label.
16106     *
16107     * @see elm_toolbar_item_separator_get()
16108     *
16109     * @ingroup Toolbar
16110     */
16111    EAPI void                    elm_toolbar_item_separator_set(Elm_Object_Item *it, Eina_Bool separator) EINA_ARG_NONNULL(1);
16112
16113    /**
16114     * Get a value whether item is a separator or not.
16115     *
16116     * @param it The toolbar item.
16117     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16118     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16119     *
16120     * @see elm_toolbar_item_separator_set() for details.
16121     *
16122     * @ingroup Toolbar
16123     */
16124    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16125
16126    /**
16127     * Set the shrink state of toolbar @p obj.
16128     *
16129     * @param obj The toolbar object.
16130     * @param shrink_mode Toolbar's items display behavior.
16131     *
16132     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
16133     * but will enforce a minimun size so all the items will fit, won't scroll
16134     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
16135     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
16136     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
16137     *
16138     * @ingroup Toolbar
16139     */
16140    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
16141
16142    /**
16143     * Get the shrink mode of toolbar @p obj.
16144     *
16145     * @param obj The toolbar object.
16146     * @return Toolbar's items display behavior.
16147     *
16148     * @see elm_toolbar_mode_shrink_set() for details.
16149     *
16150     * @ingroup Toolbar
16151     */
16152    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16153
16154    /**
16155     * Enable/disable homogeneous mode.
16156     *
16157     * @param obj The toolbar object
16158     * @param homogeneous Assume the items within the toolbar are of the
16159     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
16160     *
16161     * This will enable the homogeneous mode where items are of the same size.
16162     * @see elm_toolbar_homogeneous_get()
16163     *
16164     * @ingroup Toolbar
16165     */
16166    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16167
16168    /**
16169     * Get whether the homogeneous mode is enabled.
16170     *
16171     * @param obj The toolbar object.
16172     * @return Assume the items within the toolbar are of the same height
16173     * and width (EINA_TRUE = on, EINA_FALSE = off).
16174     *
16175     * @see elm_toolbar_homogeneous_set()
16176     *
16177     * @ingroup Toolbar
16178     */
16179    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16180
16181    /**
16182     * Set the parent object of the toolbar items' menus.
16183     *
16184     * @param obj The toolbar object.
16185     * @param parent The parent of the menu objects.
16186     *
16187     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
16188     *
16189     * For more details about setting the parent for toolbar menus, see
16190     * elm_menu_parent_set().
16191     *
16192     * @see elm_menu_parent_set() for details.
16193     * @see elm_toolbar_item_menu_set() for details.
16194     *
16195     * @ingroup Toolbar
16196     */
16197    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16198
16199    /**
16200     * Get the parent object of the toolbar items' menus.
16201     *
16202     * @param obj The toolbar object.
16203     * @return The parent of the menu objects.
16204     *
16205     * @see elm_toolbar_menu_parent_set() for details.
16206     *
16207     * @ingroup Toolbar
16208     */
16209    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16210
16211    /**
16212     * Set the alignment of the items.
16213     *
16214     * @param obj The toolbar object.
16215     * @param align The new alignment, a float between <tt> 0.0 </tt>
16216     * and <tt> 1.0 </tt>.
16217     *
16218     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
16219     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
16220     * items.
16221     *
16222     * Centered items by default.
16223     *
16224     * @see elm_toolbar_align_get()
16225     *
16226     * @ingroup Toolbar
16227     */
16228    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
16229
16230    /**
16231     * Get the alignment of the items.
16232     *
16233     * @param obj The toolbar object.
16234     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
16235     * <tt> 1.0 </tt>.
16236     *
16237     * @see elm_toolbar_align_set() for details.
16238     *
16239     * @ingroup Toolbar
16240     */
16241    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16242
16243    /**
16244     * Set whether the toolbar item opens a menu.
16245     *
16246     * @param it The toolbar item.
16247     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
16248     *
16249     * A toolbar item can be set to be a menu, using this function.
16250     *
16251     * Once it is set to be a menu, it can be manipulated through the
16252     * menu-like function elm_toolbar_menu_parent_set() and the other
16253     * elm_menu functions, using the Evas_Object @c menu returned by
16254     * elm_toolbar_item_menu_get().
16255     *
16256     * So, items to be displayed in this item's menu should be added with
16257     * elm_menu_item_add().
16258     *
16259     * The following code exemplifies the most basic usage:
16260     * @code
16261     * tb = elm_toolbar_add(win)
16262     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
16263     * elm_toolbar_item_menu_set(item, EINA_TRUE);
16264     * elm_toolbar_menu_parent_set(tb, win);
16265     * menu = elm_toolbar_item_menu_get(item);
16266     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
16267     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
16268     * NULL);
16269     * @endcode
16270     *
16271     * @see elm_toolbar_item_menu_get()
16272     *
16273     * @ingroup Toolbar
16274     */
16275    EAPI void                    elm_toolbar_item_menu_set(Elm_Object_Item *it, Eina_Bool menu) EINA_ARG_NONNULL(1);
16276
16277    /**
16278     * Get toolbar item's menu.
16279     *
16280     * @param it The toolbar item.
16281     * @return Item's menu object or @c NULL on failure.
16282     *
16283     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
16284     * this function will set it.
16285     *
16286     * @see elm_toolbar_item_menu_set() for details.
16287     *
16288     * @ingroup Toolbar
16289     */
16290    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16291
16292    /**
16293     * Add a new state to @p item.
16294     *
16295     * @param it The toolbar item.
16296     * @param icon A string with icon name or the absolute path of an image file.
16297     * @param label The label of the new state.
16298     * @param func The function to call when the item is clicked when this
16299     * state is selected.
16300     * @param data The data to associate with the state.
16301     * @return The toolbar item state, or @c NULL upon failure.
16302     *
16303     * Toolbar will load icon image from fdo or current theme.
16304     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
16305     * If an absolute path is provided it will load it direct from a file.
16306     *
16307     * States created with this function can be removed with
16308     * elm_toolbar_item_state_del().
16309     *
16310     * @see elm_toolbar_item_state_del()
16311     * @see elm_toolbar_item_state_sel()
16312     * @see elm_toolbar_item_state_get()
16313     *
16314     * @ingroup Toolbar
16315     */
16316    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Object_Item *it, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16317
16318    /**
16319     * Delete a previoulsy added state to @p item.
16320     *
16321     * @param it The toolbar item.
16322     * @param state The state to be deleted.
16323     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16324     *
16325     * @see elm_toolbar_item_state_add()
16326     */
16327    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16328
16329    /**
16330     * Set @p state as the current state of @p it.
16331     *
16332     * @param it The toolbar item.
16333     * @param state The state to use.
16334     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
16335     *
16336     * If @p state is @c NULL, it won't select any state and the default item's
16337     * icon and label will be used. It's the same behaviour than
16338     * elm_toolbar_item_state_unser().
16339     *
16340     * @see elm_toolbar_item_state_unset()
16341     *
16342     * @ingroup Toolbar
16343     */
16344    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Object_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
16345
16346    /**
16347     * Unset the state of @p it.
16348     *
16349     * @param it The toolbar item.
16350     *
16351     * The default icon and label from this item will be displayed.
16352     *
16353     * @see elm_toolbar_item_state_set() for more details.
16354     *
16355     * @ingroup Toolbar
16356     */
16357    EAPI void                    elm_toolbar_item_state_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16358
16359    /**
16360     * Get the current state of @p it.
16361     *
16362     * @param it The toolbar item.
16363     * @return The selected state or @c NULL if none is selected or on failure.
16364     *
16365     * @see elm_toolbar_item_state_set() for details.
16366     * @see elm_toolbar_item_state_unset()
16367     * @see elm_toolbar_item_state_add()
16368     *
16369     * @ingroup Toolbar
16370     */
16371    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16372
16373    /**
16374     * Get the state after selected state in toolbar's @p item.
16375     *
16376     * @param it The toolbar item to change state.
16377     * @return The state after current state, or @c NULL on failure.
16378     *
16379     * If last state is selected, this function will return first state.
16380     *
16381     * @see elm_toolbar_item_state_set()
16382     * @see elm_toolbar_item_state_add()
16383     *
16384     * @ingroup Toolbar
16385     */
16386    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16387
16388    /**
16389     * Get the state before selected state in toolbar's @p item.
16390     *
16391     * @param it The toolbar item to change state.
16392     * @return The state before current state, or @c NULL on failure.
16393     *
16394     * If first state is selected, this function will return last state.
16395     *
16396     * @see elm_toolbar_item_state_set()
16397     * @see elm_toolbar_item_state_add()
16398     *
16399     * @ingroup Toolbar
16400     */
16401    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16402
16403    /**
16404     * Set the text to be shown in a given toolbar item's tooltips.
16405     *
16406     * @param it toolbar item.
16407     * @param text The text to set in the content.
16408     *
16409     * Setup the text as tooltip to object. The item can have only one tooltip,
16410     * so any previous tooltip data - set with this function or
16411     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
16412     *
16413     * @see elm_object_tooltip_text_set() for more details.
16414     *
16415     * @ingroup Toolbar
16416     */
16417    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Object_Item *it, const char *text) EINA_ARG_NONNULL(1);
16418
16419    /**
16420     * Set the content to be shown in the tooltip item.
16421     *
16422     * Setup the tooltip to item. The item can have only one tooltip,
16423     * so any previous tooltip data is removed. @p func(with @p data) will
16424     * be called every time that need show the tooltip and it should
16425     * return a valid Evas_Object. This object is then managed fully by
16426     * tooltip system and is deleted when the tooltip is gone.
16427     *
16428     * @param it the toolbar item being attached a tooltip.
16429     * @param func the function used to create the tooltip contents.
16430     * @param data what to provide to @a func as callback data/context.
16431     * @param del_cb called when data is not needed anymore, either when
16432     *        another callback replaces @a func, the tooltip is unset with
16433     *        elm_toolbar_item_tooltip_unset() or the owner @a item
16434     *        dies. This callback receives as the first parameter the
16435     *        given @a data, and @c event_info is the item.
16436     *
16437     * @see elm_object_tooltip_content_cb_set() for more details.
16438     *
16439     * @ingroup Toolbar
16440     */
16441    EAPI void             elm_toolbar_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
16442
16443    /**
16444     * Unset tooltip from item.
16445     *
16446     * @param it toolbar item to remove previously set tooltip.
16447     *
16448     * Remove tooltip from item. The callback provided as del_cb to
16449     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
16450     * it is not used anymore.
16451     *
16452     * @see elm_object_tooltip_unset() for more details.
16453     * @see elm_toolbar_item_tooltip_content_cb_set()
16454     *
16455     * @ingroup Toolbar
16456     */
16457    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16458
16459    /**
16460     * Sets a different style for this item tooltip.
16461     *
16462     * @note before you set a style you should define a tooltip with
16463     *       elm_toolbar_item_tooltip_content_cb_set() or
16464     *       elm_toolbar_item_tooltip_text_set()
16465     *
16466     * @param it toolbar item with tooltip already set.
16467     * @param style the theme style to use (default, transparent, ...)
16468     *
16469     * @see elm_object_tooltip_style_set() for more details.
16470     *
16471     * @ingroup Toolbar
16472     */
16473    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16474
16475    /**
16476     * Get the style for this item tooltip.
16477     *
16478     * @param it toolbar item with tooltip already set.
16479     * @return style the theme style in use, defaults to "default". If the
16480     *         object does not have a tooltip set, then NULL is returned.
16481     *
16482     * @see elm_object_tooltip_style_get() for more details.
16483     * @see elm_toolbar_item_tooltip_style_set()
16484     *
16485     * @ingroup Toolbar
16486     */
16487    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16488
16489    /**
16490     * Set the type of mouse pointer/cursor decoration to be shown,
16491     * when the mouse pointer is over the given toolbar widget item
16492     *
16493     * @param it toolbar item to customize cursor on
16494     * @param cursor the cursor type's name
16495     *
16496     * This function works analogously as elm_object_cursor_set(), but
16497     * here the cursor's changing area is restricted to the item's
16498     * area, and not the whole widget's. Note that that item cursors
16499     * have precedence over widget cursors, so that a mouse over an
16500     * item with custom cursor set will always show @b that cursor.
16501     *
16502     * If this function is called twice for an object, a previously set
16503     * cursor will be unset on the second call.
16504     *
16505     * @see elm_object_cursor_set()
16506     * @see elm_toolbar_item_cursor_get()
16507     * @see elm_toolbar_item_cursor_unset()
16508     *
16509     * @ingroup Toolbar
16510     */
16511    EAPI void             elm_toolbar_item_cursor_set(Elm_Object_Item *it, const char *cursor) EINA_ARG_NONNULL(1);
16512
16513    /*
16514     * Get the type of mouse pointer/cursor decoration set to be shown,
16515     * when the mouse pointer is over the given toolbar widget item
16516     *
16517     * @param it toolbar item with custom cursor set
16518     * @return the cursor type's name or @c NULL, if no custom cursors
16519     * were set to @p item (and on errors)
16520     *
16521     * @see elm_object_cursor_get()
16522     * @see elm_toolbar_item_cursor_set()
16523     * @see elm_toolbar_item_cursor_unset()
16524     *
16525     * @ingroup Toolbar
16526     */
16527    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16528
16529    /**
16530     * Unset any custom mouse pointer/cursor decoration set to be
16531     * shown, when the mouse pointer is over the given toolbar widget
16532     * item, thus making it show the @b default cursor again.
16533     *
16534     * @param it a toolbar item
16535     *
16536     * Use this call to undo any custom settings on this item's cursor
16537     * decoration, bringing it back to defaults (no custom style set).
16538     *
16539     * @see elm_object_cursor_unset()
16540     * @see elm_toolbar_item_cursor_set()
16541     *
16542     * @ingroup Toolbar
16543     */
16544    EAPI void             elm_toolbar_item_cursor_unset(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16545
16546    /**
16547     * Set a different @b style for a given custom cursor set for a
16548     * toolbar item.
16549     *
16550     * @param it toolbar item with custom cursor set
16551     * @param style the <b>theme style</b> to use (e.g. @c "default",
16552     * @c "transparent", etc)
16553     *
16554     * This function only makes sense when one is using custom mouse
16555     * cursor decorations <b>defined in a theme file</b>, which can have,
16556     * given a cursor name/type, <b>alternate styles</b> on it. It
16557     * works analogously as elm_object_cursor_style_set(), but here
16558     * applyed only to toolbar item objects.
16559     *
16560     * @warning Before you set a cursor style you should have definen a
16561     *       custom cursor previously on the item, with
16562     *       elm_toolbar_item_cursor_set()
16563     *
16564     * @see elm_toolbar_item_cursor_engine_only_set()
16565     * @see elm_toolbar_item_cursor_style_get()
16566     *
16567     * @ingroup Toolbar
16568     */
16569    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Object_Item *it, const char *style) EINA_ARG_NONNULL(1);
16570
16571    /**
16572     * Get the current @b style set for a given toolbar item's custom
16573     * cursor
16574     *
16575     * @param it toolbar item with custom cursor set.
16576     * @return style the cursor style in use. If the object does not
16577     *         have a cursor set, then @c NULL is returned.
16578     *
16579     * @see elm_toolbar_item_cursor_style_set() for more details
16580     *
16581     * @ingroup Toolbar
16582     */
16583    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16584
16585    /**
16586     * Set if the (custom)cursor for a given toolbar item should be
16587     * searched in its theme, also, or should only rely on the
16588     * rendering engine.
16589     *
16590     * @param it item with custom (custom) cursor already set on
16591     * @param engine_only Use @c EINA_TRUE to have cursors looked for
16592     * only on those provided by the rendering engine, @c EINA_FALSE to
16593     * have them searched on the widget's theme, as well.
16594     *
16595     * @note This call is of use only if you've set a custom cursor
16596     * for toolbar items, with elm_toolbar_item_cursor_set().
16597     *
16598     * @note By default, cursors will only be looked for between those
16599     * provided by the rendering engine.
16600     *
16601     * @ingroup Toolbar
16602     */
16603    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16604
16605    /**
16606     * Get if the (custom) cursor for a given toolbar item is being
16607     * searched in its theme, also, or is only relying on the rendering
16608     * engine.
16609     *
16610     * @param it a toolbar item
16611     * @return @c EINA_TRUE, if cursors are being looked for only on
16612     * those provided by the rendering engine, @c EINA_FALSE if they
16613     * are being searched on the widget's theme, as well.
16614     *
16615     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
16616     *
16617     * @ingroup Toolbar
16618     */
16619    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16620
16621    /**
16622     * Change a toolbar's orientation
16623     * @param obj The toolbar object
16624     * @param vertical If @c EINA_TRUE, the toolbar is vertical
16625     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16626     * @ingroup Toolbar
16627     * @deprecated use elm_toolbar_horizontal_set() instead.
16628     */
16629    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
16630
16631    /**
16632     * Change a toolbar's orientation
16633     * @param obj The toolbar object
16634     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
16635     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
16636     * @ingroup Toolbar
16637     */
16638    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16639
16640    /**
16641     * Get a toolbar's orientation
16642     * @param obj The toolbar object
16643     * @return If @c EINA_TRUE, the toolbar is vertical
16644     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16645     * @ingroup Toolbar
16646     * @deprecated use elm_toolbar_horizontal_get() instead.
16647     */
16648    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16649
16650    /**
16651     * Get a toolbar's orientation
16652     * @param obj The toolbar object
16653     * @return If @c EINA_TRUE, the toolbar is horizontal
16654     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
16655     * @ingroup Toolbar
16656     */
16657    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
16658    /**
16659     * @}
16660     */
16661
16662    /**
16663     * @defgroup Tooltips Tooltips
16664     *
16665     * The Tooltip is an (internal, for now) smart object used to show a
16666     * content in a frame on mouse hover of objects(or widgets), with
16667     * tips/information about them.
16668     *
16669     * @{
16670     */
16671
16672    EAPI double       elm_tooltip_delay_get(void);
16673    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
16674    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
16675    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
16676    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
16677    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
16678 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
16679    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);
16680    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16681    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16682    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16683    EAPI Eina_Bool    elm_object_tooltip_window_mode_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
16684    EAPI Eina_Bool    elm_object_tooltip_window_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16685
16686    /**
16687     * @}
16688     */
16689
16690    /**
16691     * @defgroup Cursors Cursors
16692     *
16693     * The Elementary cursor is an internal smart object used to
16694     * customize the mouse cursor displayed over objects (or
16695     * widgets). In the most common scenario, the cursor decoration
16696     * comes from the graphical @b engine Elementary is running
16697     * on. Those engines may provide different decorations for cursors,
16698     * and Elementary provides functions to choose them (think of X11
16699     * cursors, as an example).
16700     *
16701     * There's also the possibility of, besides using engine provided
16702     * cursors, also use ones coming from Edje theming files. Both
16703     * globally and per widget, Elementary makes it possible for one to
16704     * make the cursors lookup to be held on engines only or on
16705     * Elementary's theme file, too. To set cursor's hot spot,
16706     * two data items should be added to cursor's theme: "hot_x" and
16707     * "hot_y", that are the offset from upper-left corner of the cursor
16708     * (coordinates 0,0).
16709     *
16710     * @{
16711     */
16712
16713    /**
16714     * Set the cursor to be shown when mouse is over the object
16715     *
16716     * Set the cursor that will be displayed when mouse is over the
16717     * object. The object can have only one cursor set to it, so if
16718     * this function is called twice for an object, the previous set
16719     * will be unset.
16720     * If using X cursors, a definition of all the valid cursor names
16721     * is listed on Elementary_Cursors.h. If an invalid name is set
16722     * the default cursor will be used.
16723     *
16724     * @param obj the object being set a cursor.
16725     * @param cursor the cursor name to be used.
16726     *
16727     * @ingroup Cursors
16728     */
16729    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
16730
16731    /**
16732     * Get the cursor to be shown when mouse is over the object
16733     *
16734     * @param obj an object with cursor already set.
16735     * @return the cursor name.
16736     *
16737     * @ingroup Cursors
16738     */
16739    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16740
16741    /**
16742     * Unset cursor for object
16743     *
16744     * Unset cursor for object, and set the cursor to default if the mouse
16745     * was over this object.
16746     *
16747     * @param obj Target object
16748     * @see elm_object_cursor_set()
16749     *
16750     * @ingroup Cursors
16751     */
16752    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16753
16754    /**
16755     * Sets a different style for this object cursor.
16756     *
16757     * @note before you set a style you should define a cursor with
16758     *       elm_object_cursor_set()
16759     *
16760     * @param obj an object with cursor already set.
16761     * @param style the theme style to use (default, transparent, ...)
16762     *
16763     * @ingroup Cursors
16764     */
16765    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
16766
16767    /**
16768     * Get the style for this object cursor.
16769     *
16770     * @param obj an object with cursor already set.
16771     * @return style the theme style in use, defaults to "default". If the
16772     *         object does not have a cursor set, then NULL is returned.
16773     *
16774     * @ingroup Cursors
16775     */
16776    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16777
16778    /**
16779     * Set if the cursor set should be searched on the theme or should use
16780     * the provided by the engine, only.
16781     *
16782     * @note before you set if should look on theme you should define a cursor
16783     * with elm_object_cursor_set(). By default it will only look for cursors
16784     * provided by the engine.
16785     *
16786     * @param obj an object with cursor already set.
16787     * @param engine_only boolean to define it cursors should be looked only
16788     * between the provided by the engine or searched on widget's theme as well.
16789     *
16790     * @ingroup Cursors
16791     */
16792    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16793
16794    /**
16795     * Get the cursor engine only usage for this object cursor.
16796     *
16797     * @param obj an object with cursor already set.
16798     * @return engine_only boolean to define it cursors should be
16799     * looked only between the provided by the engine or searched on
16800     * widget's theme as well. If the object does not have a cursor
16801     * set, then EINA_FALSE is returned.
16802     *
16803     * @ingroup Cursors
16804     */
16805    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16806
16807    /**
16808     * Get the configured cursor engine only usage
16809     *
16810     * This gets the globally configured exclusive usage of engine cursors.
16811     *
16812     * @return 1 if only engine cursors should be used
16813     * @ingroup Cursors
16814     */
16815    EAPI int          elm_cursor_engine_only_get(void);
16816
16817    /**
16818     * Set the configured cursor engine only usage
16819     *
16820     * This sets the globally configured exclusive usage of engine cursors.
16821     * It won't affect cursors set before changing this value.
16822     *
16823     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
16824     * look for them on theme before.
16825     * @return EINA_TRUE if value is valid and setted (0 or 1)
16826     * @ingroup Cursors
16827     */
16828    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
16829
16830    /**
16831     * @}
16832     */
16833
16834    /**
16835     * @defgroup Menu Menu
16836     *
16837     * @image html img/widget/menu/preview-00.png
16838     * @image latex img/widget/menu/preview-00.eps
16839     *
16840     * A menu is a list of items displayed above its parent. When the menu is
16841     * showing its parent is darkened. Each item can have a sub-menu. The menu
16842     * object can be used to display a menu on a right click event, in a toolbar,
16843     * anywhere.
16844     *
16845     * Signals that you can add callbacks for are:
16846     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
16847     *
16848     * Default contents parts of the menu items that you can use for are:
16849     * @li "default" - A main content of the menu item
16850     *
16851     * Default text parts of the menu items that you can use for are:
16852     * @li "default" - label in the menu item
16853     *
16854     * @see @ref tutorial_menu
16855     * @{
16856     */
16857
16858    /**
16859     * @brief Add a new menu to the parent
16860     *
16861     * @param parent The parent object.
16862     * @return The new object or NULL if it cannot be created.
16863     */
16864    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16865
16866    /**
16867     * @brief Set the parent for the given menu widget
16868     *
16869     * @param obj The menu object.
16870     * @param parent The new parent.
16871     */
16872    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
16873
16874    /**
16875     * @brief Get the parent for the given menu widget
16876     *
16877     * @param obj The menu object.
16878     * @return The parent.
16879     *
16880     * @see elm_menu_parent_set()
16881     */
16882    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16883
16884    /**
16885     * @brief Move the menu to a new position
16886     *
16887     * @param obj The menu object.
16888     * @param x The new position.
16889     * @param y The new position.
16890     *
16891     * Sets the top-left position of the menu to (@p x,@p y).
16892     *
16893     * @note @p x and @p y coordinates are relative to parent.
16894     */
16895    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
16896
16897    /**
16898     * @brief Close a opened menu
16899     *
16900     * @param obj the menu object
16901     * @return void
16902     *
16903     * Hides the menu and all it's sub-menus.
16904     */
16905    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
16906
16907    /**
16908     * @brief Returns a list of @p item's items.
16909     *
16910     * @param obj The menu object
16911     * @return An Eina_List* of @p item's items
16912     */
16913    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16914
16915    /**
16916     * @brief Get the Evas_Object of an Elm_Object_Item
16917     *
16918     * @param it The menu item object.
16919     * @return The edje object containing the swallowed content
16920     *
16921     * @warning Don't manipulate this object!
16922     *
16923     */
16924    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16925
16926    /**
16927     * @brief Add an item at the end of the given menu widget
16928     *
16929     * @param obj The menu object.
16930     * @param parent The parent menu item (optional)
16931     * @param icon An icon display on the item. The icon will be destryed by the menu.
16932     * @param label The label of the item.
16933     * @param func Function called when the user select the item.
16934     * @param data Data sent by the callback.
16935     * @return Returns the new item.
16936     */
16937    EAPI Elm_Object_Item     *elm_menu_item_add(Evas_Object *obj, Elm_Object_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16938
16939    /**
16940     * @brief Add an object swallowed in an item at the end of the given menu
16941     * widget
16942     *
16943     * @param obj The menu object.
16944     * @param parent The parent menu item (optional)
16945     * @param subobj The object to swallow
16946     * @param func Function called when the user select the item.
16947     * @param data Data sent by the callback.
16948     * @return Returns the new item.
16949     *
16950     * Add an evas object as an item to the menu.
16951     */
16952    EAPI Elm_Object_Item     *elm_menu_item_add_object(Evas_Object *obj, Elm_Object_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
16953
16954    /**
16955     * @brief Set the label of a menu item
16956     *
16957     * @param it The menu item object.
16958     * @param label The label to set for @p item
16959     *
16960     * @warning Don't use this funcion on items created with
16961     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16962     *
16963     * @deprecated Use elm_object_item_text_set() instead
16964     */
16965    EINA_DEPRECATED EAPI void               elm_menu_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
16966
16967    /**
16968     * @brief Get the label of a menu item
16969     *
16970     * @param it The menu item object.
16971     * @return The label of @p item
16972          * @deprecated Use elm_object_item_text_get() instead
16973     */
16974    EINA_DEPRECATED EAPI const char        *elm_menu_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16975
16976    /**
16977     * @brief Set the icon of a menu item to the standard icon with name @p icon
16978     *
16979     * @param it The menu item object.
16980     * @param icon The icon object to set for the content of @p item
16981     *
16982     * Once this icon is set, any previously set icon will be deleted.
16983     */
16984    EAPI void               elm_menu_item_object_icon_name_set(Elm_Object_Item *it, const char *icon) EINA_ARG_NONNULL(1, 2);
16985
16986    /**
16987     * @brief Get the string representation from the icon of a menu item
16988     *
16989     * @param it The menu item object.
16990     * @return The string representation of @p item's icon or NULL
16991     *
16992     * @see elm_menu_item_object_icon_name_set()
16993     */
16994    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
16995
16996    /**
16997     * @brief Set the content object of a menu item
16998     *
16999     * @param it The menu item object
17000     * @param The content object or NULL
17001     * @return EINA_TRUE on success, else EINA_FALSE
17002     *
17003     * Use this function to change the object swallowed by a menu item, deleting
17004     * any previously swallowed object.
17005     *
17006     * @deprecated Use elm_object_item_content_set() instead
17007     */
17008    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Object_Item *it, Evas_Object *obj) EINA_ARG_NONNULL(1);
17009
17010    /**
17011     * @brief Get the content object of a menu item
17012     *
17013     * @param it The menu item object
17014     * @return The content object or NULL
17015     * @note If @p item was added with elm_menu_item_add_object, this
17016     * function will return the object passed, else it will return the
17017     * icon object.
17018     *
17019     * @see elm_menu_item_object_content_set()
17020     *
17021     * @deprecated Use elm_object_item_content_get() instead
17022     */
17023    EINA_DEPRECATED EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17024
17025    /**
17026     * @brief Set the selected state of @p item.
17027     *
17028     * @param it The menu item object.
17029     * @param selected The selected/unselected state of the item
17030     */
17031    EAPI void               elm_menu_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
17032
17033    /**
17034     * @brief Get the selected state of @p item.
17035     *
17036     * @param it The menu item object.
17037     * @return The selected/unselected state of the item
17038     *
17039     * @see elm_menu_item_selected_set()
17040     */
17041    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17042
17043    /**
17044     * @brief Set the disabled state of @p item.
17045     *
17046     * @param it The menu item object.
17047     * @param disabled The enabled/disabled state of the item
17048     * @deprecated Use elm_object_item_disabled_set() instead
17049     */
17050    EINA_DEPRECATED EAPI void               elm_menu_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17051
17052    /**
17053     * @brief Get the disabled state of @p item.
17054     *
17055     * @param it The menu item object.
17056     * @return The enabled/disabled state of the item
17057     *
17058     * @see elm_menu_item_disabled_set()
17059     * @deprecated Use elm_object_item_disabled_get() instead
17060     */
17061    EINA_DEPRECATED EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17062
17063    /**
17064     * @brief Add a separator item to menu @p obj under @p parent.
17065     *
17066     * @param obj The menu object
17067     * @param parent The item to add the separator under
17068     * @return The created item or NULL on failure
17069     *
17070     * This is item is a @ref Separator.
17071     */
17072    EAPI Elm_Object_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Object_Item *parent) EINA_ARG_NONNULL(1);
17073
17074    /**
17075     * @brief Returns whether @p item is a separator.
17076     *
17077     * @param it The item to check
17078     * @return If true, @p item is a separator
17079     *
17080     * @see elm_menu_item_separator_add()
17081     */
17082    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17083
17084    /**
17085     * @brief Deletes an item from the menu.
17086     *
17087     * @param it The item to delete.
17088     *
17089     * @see elm_menu_item_add()
17090     */
17091    EAPI void               elm_menu_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17092
17093    /**
17094     * @brief Set the function called when a menu item is deleted.
17095     *
17096     * @param it The item to set the callback on
17097     * @param func The function called
17098     *
17099     * @see elm_menu_item_add()
17100     * @see elm_menu_item_del()
17101     */
17102    EAPI void               elm_menu_item_del_cb_set(Elm_Object_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17103
17104    /**
17105     * @brief Returns the data associated with menu item @p item.
17106     *
17107     * @param it The item
17108     * @return The data associated with @p item or NULL if none was set.
17109     *
17110     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
17111     *
17112     * @deprecated Use elm_object_item_data_get() instead
17113     */
17114    EINA_DEPRECATED EAPI void              *elm_menu_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17115
17116    /**
17117     * @brief Sets the data to be associated with menu item @p item.
17118     *
17119     * @param it The item
17120     * @param data The data to be associated with @p item
17121     *
17122     * @deprecated Use elm_object_item_data_set() instead
17123     */
17124    EINA_DEPRECATED EAPI void               elm_menu_item_data_set(Elm_Object_Item *it, const void *data) EINA_ARG_NONNULL(1);
17125
17126    /**
17127     * @brief Returns a list of @p item's subitems.
17128     *
17129     * @param it The item
17130     * @return An Eina_List* of @p item's subitems
17131     *
17132     * @see elm_menu_add()
17133     */
17134    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17135
17136    /**
17137     * @brief Get the position of a menu item
17138     *
17139     * @param it The menu item
17140     * @return The item's index
17141     *
17142     * This function returns the index position of a menu item in a menu.
17143     * For a sub-menu, this number is relative to the first item in the sub-menu.
17144     *
17145     * @note Index values begin with 0
17146     */
17147    EAPI unsigned int       elm_menu_item_index_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17148
17149    /**
17150     * @brief @brief Return a menu item's owner menu
17151     *
17152     * @param it The menu item
17153     * @return The menu object owning @p item, or NULL on failure
17154     *
17155     * Use this function to get the menu object owning an item.
17156     */
17157    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1) EINA_PURE;
17158
17159    /**
17160     * @brief Get the selected item in the menu
17161     *
17162     * @param obj The menu object
17163     * @return The selected item, or NULL if none
17164     *
17165     * @see elm_menu_item_selected_get()
17166     * @see elm_menu_item_selected_set()
17167     */
17168    EAPI Elm_Object_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17169
17170    /**
17171     * @brief Get the last item in the menu
17172     *
17173     * @param obj The menu object
17174     * @return The last item, or NULL if none
17175     */
17176    EAPI Elm_Object_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17177
17178    /**
17179     * @brief Get the first item in the menu
17180     *
17181     * @param obj The menu object
17182     * @return The first item, or NULL if none
17183     */
17184    EAPI Elm_Object_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
17185
17186    /**
17187     * @brief Get the next item in the menu.
17188     *
17189     * @param it The menu item object.
17190     * @return The item after it, or NULL if none
17191     */
17192    EAPI Elm_Object_Item *elm_menu_item_next_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17193
17194    /**
17195     * @brief Get the previous item in the menu.
17196     *
17197     * @param it The menu item object.
17198     * @return The item before it, or NULL if none
17199     */
17200    EAPI Elm_Object_Item *elm_menu_item_prev_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
17201
17202    /**
17203     * @}
17204     */
17205
17206    /**
17207     * @defgroup List List
17208     * @ingroup Elementary
17209     *
17210     * @image html img/widget/list/preview-00.png
17211     * @image latex img/widget/list/preview-00.eps width=\textwidth
17212     *
17213     * @image html img/list.png
17214     * @image latex img/list.eps width=\textwidth
17215     *
17216     * A list widget is a container whose children are displayed vertically or
17217     * horizontally, in order, and can be selected.
17218     * The list can accept only one or multiple items selection. Also has many
17219     * modes of items displaying.
17220     *
17221     * A list is a very simple type of list widget.  For more robust
17222     * lists, @ref Genlist should probably be used.
17223     *
17224     * Smart callbacks one can listen to:
17225     * - @c "activated" - The user has double-clicked or pressed
17226     *   (enter|return|spacebar) on an item. The @c event_info parameter
17227     *   is the item that was activated.
17228     * - @c "clicked,double" - The user has double-clicked an item.
17229     *   The @c event_info parameter is the item that was double-clicked.
17230     * - "selected" - when the user selected an item
17231     * - "unselected" - when the user unselected an item
17232     * - "longpressed" - an item in the list is long-pressed
17233     * - "edge,top" - the list is scrolled until the top edge
17234     * - "edge,bottom" - the list is scrolled until the bottom edge
17235     * - "edge,left" - the list is scrolled until the left edge
17236     * - "edge,right" - the list is scrolled until the right edge
17237     * - "language,changed" - the program's language changed
17238     *
17239     * Available styles for it:
17240     * - @c "default"
17241     *
17242     * List of examples:
17243     * @li @ref list_example_01
17244     * @li @ref list_example_02
17245     * @li @ref list_example_03
17246     */
17247
17248    /**
17249     * @addtogroup List
17250     * @{
17251     */
17252
17253    /**
17254     * @enum _Elm_List_Mode
17255     * @typedef Elm_List_Mode
17256     *
17257     * Set list's resize behavior, transverse axis scroll and
17258     * items cropping. See each mode's description for more details.
17259     *
17260     * @note Default value is #ELM_LIST_SCROLL.
17261     *
17262     * Values <b> don't </b> work as bitmask, only one can be choosen.
17263     *
17264     * @see elm_list_mode_set()
17265     * @see elm_list_mode_get()
17266     *
17267     * @ingroup List
17268     */
17269    typedef enum _Elm_List_Mode
17270      {
17271         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. */
17272         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). */
17273         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. */
17274         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. */
17275         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
17276      } Elm_List_Mode;
17277
17278    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().  */
17279
17280    /**
17281     * Add a new list widget to the given parent Elementary
17282     * (container) object.
17283     *
17284     * @param parent The parent object.
17285     * @return a new list widget handle or @c NULL, on errors.
17286     *
17287     * This function inserts a new list widget on the canvas.
17288     *
17289     * @ingroup List
17290     */
17291    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17292
17293    /**
17294     * Starts the list.
17295     *
17296     * @param obj The list object
17297     *
17298     * @note Call before running show() on the list object.
17299     * @warning If not called, it won't display the list properly.
17300     *
17301     * @code
17302     * li = elm_list_add(win);
17303     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
17304     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
17305     * elm_list_go(li);
17306     * evas_object_show(li);
17307     * @endcode
17308     *
17309     * @ingroup List
17310     */
17311    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
17312
17313    /**
17314     * Enable or disable multiple items selection on the list object.
17315     *
17316     * @param obj The list object
17317     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
17318     * disable it.
17319     *
17320     * Disabled by default. If disabled, the user can select a single item of
17321     * the list each time. Selected items are highlighted on list.
17322     * If enabled, many items can be selected.
17323     *
17324     * If a selected item is selected again, it will be unselected.
17325     *
17326     * @see elm_list_multi_select_get()
17327     *
17328     * @ingroup List
17329     */
17330    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17331
17332    /**
17333     * Get a value whether multiple items selection is enabled or not.
17334     *
17335     * @see elm_list_multi_select_set() for details.
17336     *
17337     * @param obj The list object.
17338     * @return @c EINA_TRUE means multiple items selection is enabled.
17339     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17340     * @c EINA_FALSE is returned.
17341     *
17342     * @ingroup List
17343     */
17344    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17345
17346    /**
17347     * Set which mode to use for the list object.
17348     *
17349     * @param obj The list object
17350     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17351     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
17352     *
17353     * Set list's resize behavior, transverse axis scroll and
17354     * items cropping. See each mode's description for more details.
17355     *
17356     * @note Default value is #ELM_LIST_SCROLL.
17357     *
17358     * Only one can be set, if a previous one was set, it will be changed
17359     * by the new mode set. Bitmask won't work as well.
17360     *
17361     * @see elm_list_mode_get()
17362     *
17363     * @ingroup List
17364     */
17365    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17366
17367    /**
17368     * Get the mode the list is at.
17369     *
17370     * @param obj The list object
17371     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
17372     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
17373     *
17374     * @note see elm_list_mode_set() for more information.
17375     *
17376     * @ingroup List
17377     */
17378    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17379
17380    /**
17381     * Enable or disable horizontal mode on the list object.
17382     *
17383     * @param obj The list object.
17384     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
17385     * disable it, i.e., to enable vertical mode.
17386     *
17387     * @note Vertical mode is set by default.
17388     *
17389     * On horizontal mode items are displayed on list from left to right,
17390     * instead of from top to bottom. Also, the list will scroll horizontally.
17391     * Each item will presents left icon on top and right icon, or end, at
17392     * the bottom.
17393     *
17394     * @see elm_list_horizontal_get()
17395     *
17396     * @ingroup List
17397     */
17398    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17399
17400    /**
17401     * Get a value whether horizontal mode is enabled or not.
17402     *
17403     * @param obj The list object.
17404     * @return @c EINA_TRUE means horizontal mode selection is enabled.
17405     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17406     * @c EINA_FALSE is returned.
17407     *
17408     * @see elm_list_horizontal_set() for details.
17409     *
17410     * @ingroup List
17411     */
17412    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17413
17414    /**
17415     * Enable or disable always select mode on the list object.
17416     *
17417     * @param obj The list object
17418     * @param always_select @c EINA_TRUE to enable always select mode or
17419     * @c EINA_FALSE to disable it.
17420     *
17421     * @note Always select mode is disabled by default.
17422     *
17423     * Default behavior of list items is to only call its callback function
17424     * the first time it's pressed, i.e., when it is selected. If a selected
17425     * item is pressed again, and multi-select is disabled, it won't call
17426     * this function (if multi-select is enabled it will unselect the item).
17427     *
17428     * If always select is enabled, it will call the callback function
17429     * everytime a item is pressed, so it will call when the item is selected,
17430     * and again when a selected item is pressed.
17431     *
17432     * @see elm_list_always_select_mode_get()
17433     * @see elm_list_multi_select_set()
17434     *
17435     * @ingroup List
17436     */
17437    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17438
17439    /**
17440     * Get a value whether always select mode is enabled or not, meaning that
17441     * an item will always call its callback function, even if already selected.
17442     *
17443     * @param obj The list object
17444     * @return @c EINA_TRUE means horizontal mode selection is enabled.
17445     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
17446     * @c EINA_FALSE is returned.
17447     *
17448     * @see elm_list_always_select_mode_set() for details.
17449     *
17450     * @ingroup List
17451     */
17452    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17453
17454    /**
17455     * Set bouncing behaviour when the scrolled content reaches an edge.
17456     *
17457     * Tell the internal scroller object whether it should bounce or not
17458     * when it reaches the respective edges for each axis.
17459     *
17460     * @param obj The list object
17461     * @param h_bounce Whether to bounce or not in the horizontal axis.
17462     * @param v_bounce Whether to bounce or not in the vertical axis.
17463     *
17464     * @see elm_scroller_bounce_set()
17465     *
17466     * @ingroup List
17467     */
17468    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17469
17470    /**
17471     * Get the bouncing behaviour of the internal scroller.
17472     *
17473     * Get whether the internal scroller should bounce when the edge of each
17474     * axis is reached scrolling.
17475     *
17476     * @param obj The list object.
17477     * @param h_bounce Pointer where to store the bounce state of the horizontal
17478     * axis.
17479     * @param v_bounce Pointer where to store the bounce state of the vertical
17480     * axis.
17481     *
17482     * @see elm_scroller_bounce_get()
17483     * @see elm_list_bounce_set()
17484     *
17485     * @ingroup List
17486     */
17487    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17488
17489    /**
17490     * Set the scrollbar policy.
17491     *
17492     * @param obj The list object
17493     * @param policy_h Horizontal scrollbar policy.
17494     * @param policy_v Vertical scrollbar policy.
17495     *
17496     * This sets the scrollbar visibility policy for the given scroller.
17497     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
17498     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
17499     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
17500     * This applies respectively for the horizontal and vertical scrollbars.
17501     *
17502     * The both are disabled by default, i.e., are set to
17503     * #ELM_SCROLLER_POLICY_OFF.
17504     *
17505     * @ingroup List
17506     */
17507    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17508
17509    /**
17510     * Get the scrollbar policy.
17511     *
17512     * @see elm_list_scroller_policy_get() for details.
17513     *
17514     * @param obj The list object.
17515     * @param policy_h Pointer where to store horizontal scrollbar policy.
17516     * @param policy_v Pointer where to store vertical scrollbar policy.
17517     *
17518     * @ingroup List
17519     */
17520    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);
17521
17522    /**
17523     * Append a new item to the list object.
17524     *
17525     * @param obj The list object.
17526     * @param label The label of the list item.
17527     * @param icon The icon object to use for the left side of the item. An
17528     * icon can be any Evas object, but usually it is an icon created
17529     * with elm_icon_add().
17530     * @param end The icon object to use for the right side of the item. An
17531     * icon can be any Evas object.
17532     * @param func The function to call when the item is clicked.
17533     * @param data The data to associate with the item for related callbacks.
17534     *
17535     * @return The created item or @c NULL upon failure.
17536     *
17537     * A new item will be created and appended to the list, i.e., will
17538     * be set as @b last item.
17539     *
17540     * Items created with this method can be deleted with
17541     * elm_list_item_del().
17542     *
17543     * Associated @p data can be properly freed when item is deleted if a
17544     * callback function is set with elm_list_item_del_cb_set().
17545     *
17546     * If a function is passed as argument, it will be called everytime this item
17547     * is selected, i.e., the user clicks over an unselected item.
17548     * If always select is enabled it will call this function every time
17549     * user clicks over an item (already selected or not).
17550     * If such function isn't needed, just passing
17551     * @c NULL as @p func is enough. The same should be done for @p data.
17552     *
17553     * Simple example (with no function callback or data associated):
17554     * @code
17555     * li = elm_list_add(win);
17556     * ic = elm_icon_add(win);
17557     * elm_icon_file_set(ic, "path/to/image", NULL);
17558     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
17559     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
17560     * elm_list_go(li);
17561     * evas_object_show(li);
17562     * @endcode
17563     *
17564     * @see elm_list_always_select_mode_set()
17565     * @see elm_list_item_del()
17566     * @see elm_list_item_del_cb_set()
17567     * @see elm_list_clear()
17568     * @see elm_icon_add()
17569     *
17570     * @ingroup List
17571     */
17572    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);
17573
17574    /**
17575     * Prepend a new item to the list object.
17576     *
17577     * @param obj The list object.
17578     * @param label The label of the list item.
17579     * @param icon The icon object to use for the left side of the item. An
17580     * icon can be any Evas object, but usually it is an icon created
17581     * with elm_icon_add().
17582     * @param end The icon object to use for the right side of the item. An
17583     * icon can be any Evas object.
17584     * @param func The function to call when the item is clicked.
17585     * @param data The data to associate with the item for related callbacks.
17586     *
17587     * @return The created item or @c NULL upon failure.
17588     *
17589     * A new item will be created and prepended to the list, i.e., will
17590     * be set as @b first item.
17591     *
17592     * Items created with this method can be deleted with
17593     * elm_list_item_del().
17594     *
17595     * Associated @p data can be properly freed when item is deleted if a
17596     * callback function is set with elm_list_item_del_cb_set().
17597     *
17598     * If a function is passed as argument, it will be called everytime this item
17599     * is selected, i.e., the user clicks over an unselected item.
17600     * If always select is enabled it will call this function every time
17601     * user clicks over an item (already selected or not).
17602     * If such function isn't needed, just passing
17603     * @c NULL as @p func is enough. The same should be done for @p data.
17604     *
17605     * @see elm_list_item_append() for a simple code example.
17606     * @see elm_list_always_select_mode_set()
17607     * @see elm_list_item_del()
17608     * @see elm_list_item_del_cb_set()
17609     * @see elm_list_clear()
17610     * @see elm_icon_add()
17611     *
17612     * @ingroup List
17613     */
17614    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);
17615
17616    /**
17617     * Insert a new item into the list object before item @p before.
17618     *
17619     * @param obj The list object.
17620     * @param before The list item to insert before.
17621     * @param label The label of the list item.
17622     * @param icon The icon object to use for the left side of the item. An
17623     * icon can be any Evas object, but usually it is an icon created
17624     * with elm_icon_add().
17625     * @param end The icon object to use for the right side of the item. An
17626     * icon can be any Evas object.
17627     * @param func The function to call when the item is clicked.
17628     * @param data The data to associate with the item for related callbacks.
17629     *
17630     * @return The created item or @c NULL upon failure.
17631     *
17632     * A new item will be created and added to the list. Its position in
17633     * this list will be just before item @p before.
17634     *
17635     * Items created with this method can be deleted with
17636     * elm_list_item_del().
17637     *
17638     * Associated @p data can be properly freed when item is deleted if a
17639     * callback function is set with elm_list_item_del_cb_set().
17640     *
17641     * If a function is passed as argument, it will be called everytime this item
17642     * is selected, i.e., the user clicks over an unselected item.
17643     * If always select is enabled it will call this function every time
17644     * user clicks over an item (already selected or not).
17645     * If such function isn't needed, just passing
17646     * @c NULL as @p func is enough. The same should be done for @p data.
17647     *
17648     * @see elm_list_item_append() for a simple code example.
17649     * @see elm_list_always_select_mode_set()
17650     * @see elm_list_item_del()
17651     * @see elm_list_item_del_cb_set()
17652     * @see elm_list_clear()
17653     * @see elm_icon_add()
17654     *
17655     * @ingroup List
17656     */
17657    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);
17658
17659    /**
17660     * Insert a new item into the list object after item @p after.
17661     *
17662     * @param obj The list object.
17663     * @param after The list item to insert after.
17664     * @param label The label of the list item.
17665     * @param icon The icon object to use for the left side of the item. An
17666     * icon can be any Evas object, but usually it is an icon created
17667     * with elm_icon_add().
17668     * @param end The icon object to use for the right side of the item. An
17669     * icon can be any Evas object.
17670     * @param func The function to call when the item is clicked.
17671     * @param data The data to associate with the item for related callbacks.
17672     *
17673     * @return The created item or @c NULL upon failure.
17674     *
17675     * A new item will be created and added to the list. Its position in
17676     * this list will be just after item @p after.
17677     *
17678     * Items created with this method can be deleted with
17679     * elm_list_item_del().
17680     *
17681     * Associated @p data can be properly freed when item is deleted if a
17682     * callback function is set with elm_list_item_del_cb_set().
17683     *
17684     * If a function is passed as argument, it will be called everytime this item
17685     * is selected, i.e., the user clicks over an unselected item.
17686     * If always select is enabled it will call this function every time
17687     * user clicks over an item (already selected or not).
17688     * If such function isn't needed, just passing
17689     * @c NULL as @p func is enough. The same should be done for @p data.
17690     *
17691     * @see elm_list_item_append() for a simple code example.
17692     * @see elm_list_always_select_mode_set()
17693     * @see elm_list_item_del()
17694     * @see elm_list_item_del_cb_set()
17695     * @see elm_list_clear()
17696     * @see elm_icon_add()
17697     *
17698     * @ingroup List
17699     */
17700    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);
17701
17702    /**
17703     * Insert a new item into the sorted list object.
17704     *
17705     * @param obj The list object.
17706     * @param label The label of the list item.
17707     * @param icon The icon object to use for the left side of the item. An
17708     * icon can be any Evas object, but usually it is an icon created
17709     * with elm_icon_add().
17710     * @param end The icon object to use for the right side of the item. An
17711     * icon can be any Evas object.
17712     * @param func The function to call when the item is clicked.
17713     * @param data The data to associate with the item for related callbacks.
17714     * @param cmp_func The comparing function to be used to sort list
17715     * items <b>by #Elm_List_Item item handles</b>. This function will
17716     * receive two items and compare them, returning a non-negative integer
17717     * if the second item should be place after the first, or negative value
17718     * if should be placed before.
17719     *
17720     * @return The created item or @c NULL upon failure.
17721     *
17722     * @note This function inserts values into a list object assuming it was
17723     * sorted and the result will be sorted.
17724     *
17725     * A new item will be created and added to the list. Its position in
17726     * this list will be found comparing the new item with previously inserted
17727     * items using function @p cmp_func.
17728     *
17729     * Items created with this method can be deleted with
17730     * elm_list_item_del().
17731     *
17732     * Associated @p data can be properly freed when item is deleted if a
17733     * callback function is set with elm_list_item_del_cb_set().
17734     *
17735     * If a function is passed as argument, it will be called everytime this item
17736     * is selected, i.e., the user clicks over an unselected item.
17737     * If always select is enabled it will call this function every time
17738     * user clicks over an item (already selected or not).
17739     * If such function isn't needed, just passing
17740     * @c NULL as @p func is enough. The same should be done for @p data.
17741     *
17742     * @see elm_list_item_append() for a simple code example.
17743     * @see elm_list_always_select_mode_set()
17744     * @see elm_list_item_del()
17745     * @see elm_list_item_del_cb_set()
17746     * @see elm_list_clear()
17747     * @see elm_icon_add()
17748     *
17749     * @ingroup List
17750     */
17751    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);
17752
17753    /**
17754     * Remove all list's items.
17755     *
17756     * @param obj The list object
17757     *
17758     * @see elm_list_item_del()
17759     * @see elm_list_item_append()
17760     *
17761     * @ingroup List
17762     */
17763    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17764
17765    /**
17766     * Get a list of all the list items.
17767     *
17768     * @param obj The list object
17769     * @return An @c Eina_List of list items, #Elm_List_Item,
17770     * or @c NULL on failure.
17771     *
17772     * @see elm_list_item_append()
17773     * @see elm_list_item_del()
17774     * @see elm_list_clear()
17775     *
17776     * @ingroup List
17777     */
17778    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17779
17780    /**
17781     * Get the selected item.
17782     *
17783     * @param obj The list object.
17784     * @return The selected list item.
17785     *
17786     * The selected item can be unselected with function
17787     * elm_list_item_selected_set().
17788     *
17789     * The selected item always will be highlighted on list.
17790     *
17791     * @see elm_list_selected_items_get()
17792     *
17793     * @ingroup List
17794     */
17795    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17796
17797    /**
17798     * Return a list of the currently selected list items.
17799     *
17800     * @param obj The list object.
17801     * @return An @c Eina_List of list items, #Elm_List_Item,
17802     * or @c NULL on failure.
17803     *
17804     * Multiple items can be selected if multi select is enabled. It can be
17805     * done with elm_list_multi_select_set().
17806     *
17807     * @see elm_list_selected_item_get()
17808     * @see elm_list_multi_select_set()
17809     *
17810     * @ingroup List
17811     */
17812    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17813
17814    /**
17815     * Set the selected state of an item.
17816     *
17817     * @param item The list item
17818     * @param selected The selected state
17819     *
17820     * This sets the selected state of the given item @p it.
17821     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
17822     *
17823     * If a new item is selected the previosly selected will be unselected,
17824     * unless multiple selection is enabled with elm_list_multi_select_set().
17825     * Previoulsy selected item can be get with function
17826     * elm_list_selected_item_get().
17827     *
17828     * Selected items will be highlighted.
17829     *
17830     * @see elm_list_item_selected_get()
17831     * @see elm_list_selected_item_get()
17832     * @see elm_list_multi_select_set()
17833     *
17834     * @ingroup List
17835     */
17836    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17837
17838    /*
17839     * Get whether the @p item is selected or not.
17840     *
17841     * @param item The list item.
17842     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
17843     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
17844     *
17845     * @see elm_list_selected_item_set() for details.
17846     * @see elm_list_item_selected_get()
17847     *
17848     * @ingroup List
17849     */
17850    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17851
17852    /**
17853     * Set or unset item as a separator.
17854     *
17855     * @param it The list item.
17856     * @param setting @c EINA_TRUE to set item @p it as separator or
17857     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
17858     *
17859     * Items aren't set as separator by default.
17860     *
17861     * If set as separator it will display separator theme, so won't display
17862     * icons or label.
17863     *
17864     * @see elm_list_item_separator_get()
17865     *
17866     * @ingroup List
17867     */
17868    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
17869
17870    /**
17871     * Get a value whether item is a separator or not.
17872     *
17873     * @see elm_list_item_separator_set() for details.
17874     *
17875     * @param it The list item.
17876     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
17877     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
17878     *
17879     * @ingroup List
17880     */
17881    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17882
17883    /**
17884     * Show @p item in the list view.
17885     *
17886     * @param item The list item to be shown.
17887     *
17888     * It won't animate list until item is visible. If such behavior is wanted,
17889     * use elm_list_bring_in() intead.
17890     *
17891     * @ingroup List
17892     */
17893    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17894
17895    /**
17896     * Bring in the given item to list view.
17897     *
17898     * @param item The item.
17899     *
17900     * This causes list to jump to the given item @p item and show it
17901     * (by scrolling), if it is not fully visible.
17902     *
17903     * This may use animation to do so and take a period of time.
17904     *
17905     * If animation isn't wanted, elm_list_item_show() can be used.
17906     *
17907     * @ingroup List
17908     */
17909    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17910
17911    /**
17912     * Delete them item from the list.
17913     *
17914     * @param item The item of list to be deleted.
17915     *
17916     * If deleting all list items is required, elm_list_clear()
17917     * should be used instead of getting items list and deleting each one.
17918     *
17919     * @see elm_list_clear()
17920     * @see elm_list_item_append()
17921     * @see elm_list_item_del_cb_set()
17922     *
17923     * @ingroup List
17924     */
17925    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17926
17927    /**
17928     * Set the function called when a list item is freed.
17929     *
17930     * @param item The item to set the callback on
17931     * @param func The function called
17932     *
17933     * If there is a @p func, then it will be called prior item's memory release.
17934     * That will be called with the following arguments:
17935     * @li item's data;
17936     * @li item's Evas object;
17937     * @li item itself;
17938     *
17939     * This way, a data associated to a list item could be properly freed.
17940     *
17941     * @ingroup List
17942     */
17943    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17944
17945    /**
17946     * Get the data associated to the item.
17947     *
17948     * @param item The list item
17949     * @return The data associated to @p item
17950     *
17951     * The return value is a pointer to data associated to @p item when it was
17952     * created, with function elm_list_item_append() or similar. If no data
17953     * was passed as argument, it will return @c NULL.
17954     *
17955     * @see elm_list_item_append()
17956     *
17957     * @ingroup List
17958     */
17959    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17960
17961    /**
17962     * Get the left side icon associated to the item.
17963     *
17964     * @param item The list item
17965     * @return The left side icon associated to @p item
17966     *
17967     * The return value is a pointer to the icon associated to @p item when
17968     * it was
17969     * created, with function elm_list_item_append() or similar, or later
17970     * with function elm_list_item_icon_set(). If no icon
17971     * was passed as argument, it will return @c NULL.
17972     *
17973     * @see elm_list_item_append()
17974     * @see elm_list_item_icon_set()
17975     *
17976     * @ingroup List
17977     */
17978    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17979
17980    /**
17981     * Set the left side icon associated to the item.
17982     *
17983     * @param item The list item
17984     * @param icon The left side icon object to associate with @p item
17985     *
17986     * The icon object to use at left side of the item. An
17987     * icon can be any Evas object, but usually it is an icon created
17988     * with elm_icon_add().
17989     *
17990     * Once the icon object is set, a previously set one will be deleted.
17991     * @warning Setting the same icon for two items will cause the icon to
17992     * dissapear from the first item.
17993     *
17994     * If an icon was passed as argument on item creation, with function
17995     * elm_list_item_append() or similar, it will be already
17996     * associated to the item.
17997     *
17998     * @see elm_list_item_append()
17999     * @see elm_list_item_icon_get()
18000     *
18001     * @ingroup List
18002     */
18003    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
18004
18005    /**
18006     * Get the right side icon associated to the item.
18007     *
18008     * @param item The list item
18009     * @return The right side icon associated to @p item
18010     *
18011     * The return value is a pointer to the icon associated to @p item when
18012     * it was
18013     * created, with function elm_list_item_append() or similar, or later
18014     * with function elm_list_item_icon_set(). If no icon
18015     * was passed as argument, it will return @c NULL.
18016     *
18017     * @see elm_list_item_append()
18018     * @see elm_list_item_icon_set()
18019     *
18020     * @ingroup List
18021     */
18022    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18023
18024    /**
18025     * Set the right side icon associated to the item.
18026     *
18027     * @param item The list item
18028     * @param end The right side icon object to associate with @p item
18029     *
18030     * The icon object to use at right side of the item. An
18031     * icon can be any Evas object, but usually it is an icon created
18032     * with elm_icon_add().
18033     *
18034     * Once the icon object is set, a previously set one will be deleted.
18035     * @warning Setting the same icon for two items will cause the icon to
18036     * dissapear from the first item.
18037     *
18038     * If an icon was passed as argument on item creation, with function
18039     * elm_list_item_append() or similar, it will be already
18040     * associated to the item.
18041     *
18042     * @see elm_list_item_append()
18043     * @see elm_list_item_end_get()
18044     *
18045     * @ingroup List
18046     */
18047    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
18048
18049    /**
18050     * Gets the base object of the item.
18051     *
18052     * @param item The list item
18053     * @return The base object associated with @p item
18054     *
18055     * Base object is the @c Evas_Object that represents that item.
18056     *
18057     * @ingroup List
18058     */
18059    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18060    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18061
18062    /**
18063     * Get the label of item.
18064     *
18065     * @param item The item of list.
18066     * @return The label of item.
18067     *
18068     * The return value is a pointer to the label associated to @p item when
18069     * it was created, with function elm_list_item_append(), or later
18070     * with function elm_list_item_label_set. If no label
18071     * was passed as argument, it will return @c NULL.
18072     *
18073     * @see elm_list_item_label_set() for more details.
18074     * @see elm_list_item_append()
18075     *
18076     * @ingroup List
18077     */
18078    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18079
18080    /**
18081     * Set the label of item.
18082     *
18083     * @param item The item of list.
18084     * @param text The label of item.
18085     *
18086     * The label to be displayed by the item.
18087     * Label will be placed between left and right side icons (if set).
18088     *
18089     * If a label was passed as argument on item creation, with function
18090     * elm_list_item_append() or similar, it will be already
18091     * displayed by the item.
18092     *
18093     * @see elm_list_item_label_get()
18094     * @see elm_list_item_append()
18095     *
18096     * @ingroup List
18097     */
18098    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18099
18100    /**
18101     * Get the item before @p it in list.
18102     *
18103     * @param it The list item.
18104     * @return The item before @p it, or @c NULL if none or on failure.
18105     *
18106     * @note If it is the first item, @c NULL will be returned.
18107     *
18108     * @see elm_list_item_append()
18109     * @see elm_list_items_get()
18110     *
18111     * @ingroup List
18112     */
18113    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18114
18115    /**
18116     * Get the item after @p it in list.
18117     *
18118     * @param it The list item.
18119     * @return The item after @p it, or @c NULL if none or on failure.
18120     *
18121     * @note If it is the last item, @c NULL will be returned.
18122     *
18123     * @see elm_list_item_append()
18124     * @see elm_list_items_get()
18125     *
18126     * @ingroup List
18127     */
18128    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18129
18130    /**
18131     * Sets the disabled/enabled state of a list item.
18132     *
18133     * @param it The item.
18134     * @param disabled The disabled state.
18135     *
18136     * A disabled item cannot be selected or unselected. It will also
18137     * change its appearance (generally greyed out). This sets the
18138     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
18139     * enabled).
18140     *
18141     * @ingroup List
18142     */
18143    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18144
18145    /**
18146     * Get a value whether list item is disabled or not.
18147     *
18148     * @param it The item.
18149     * @return The disabled state.
18150     *
18151     * @see elm_list_item_disabled_set() for more details.
18152     *
18153     * @ingroup List
18154     */
18155    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
18156
18157    /**
18158     * Set the text to be shown in a given list item's tooltips.
18159     *
18160     * @param item Target item.
18161     * @param text The text to set in the content.
18162     *
18163     * Setup the text as tooltip to object. The item can have only one tooltip,
18164     * so any previous tooltip data - set with this function or
18165     * elm_list_item_tooltip_content_cb_set() - is removed.
18166     *
18167     * @see elm_object_tooltip_text_set() for more details.
18168     *
18169     * @ingroup List
18170     */
18171    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
18172
18173    /**
18174     * @brief Disable size restrictions on an object's tooltip
18175     * @param item The tooltip's anchor object
18176     * @param disable If EINA_TRUE, size restrictions are disabled
18177     * @return EINA_FALSE on failure, EINA_TRUE on success
18178     *
18179     * This function allows a tooltip to expand beyond its parant window's canvas.
18180     * It will instead be limited only by the size of the display.
18181     */
18182    EAPI Eina_Bool        elm_list_item_tooltip_window_mode_set(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
18183    /**
18184     * @brief Retrieve size restriction state of an object's tooltip
18185     * @param obj The tooltip's anchor object
18186     * @return If EINA_TRUE, size restrictions are disabled
18187     *
18188     * This function returns whether a tooltip is allowed to expand beyond
18189     * its parant window's canvas.
18190     * It will instead be limited only by the size of the display.
18191     */
18192    EAPI Eina_Bool        elm_list_item_tooltip_window_mode_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18193
18194    /**
18195     * Set the content to be shown in the tooltip item.
18196     *
18197     * Setup the tooltip to item. The item can have only one tooltip,
18198     * so any previous tooltip data is removed. @p func(with @p data) will
18199     * be called every time that need show the tooltip and it should
18200     * return a valid Evas_Object. This object is then managed fully by
18201     * tooltip system and is deleted when the tooltip is gone.
18202     *
18203     * @param item the list item being attached a tooltip.
18204     * @param func the function used to create the tooltip contents.
18205     * @param data what to provide to @a func as callback data/context.
18206     * @param del_cb called when data is not needed anymore, either when
18207     *        another callback replaces @a func, the tooltip is unset with
18208     *        elm_list_item_tooltip_unset() or the owner @a item
18209     *        dies. This callback receives as the first parameter the
18210     *        given @a data, and @c event_info is the item.
18211     *
18212     * @see elm_object_tooltip_content_cb_set() for more details.
18213     *
18214     * @ingroup List
18215     */
18216    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);
18217
18218    /**
18219     * Unset tooltip from item.
18220     *
18221     * @param item list item to remove previously set tooltip.
18222     *
18223     * Remove tooltip from item. The callback provided as del_cb to
18224     * elm_list_item_tooltip_content_cb_set() will be called to notify
18225     * it is not used anymore.
18226     *
18227     * @see elm_object_tooltip_unset() for more details.
18228     * @see elm_list_item_tooltip_content_cb_set()
18229     *
18230     * @ingroup List
18231     */
18232    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18233
18234    /**
18235     * Sets a different style for this item tooltip.
18236     *
18237     * @note before you set a style you should define a tooltip with
18238     *       elm_list_item_tooltip_content_cb_set() or
18239     *       elm_list_item_tooltip_text_set()
18240     *
18241     * @param item list item with tooltip already set.
18242     * @param style the theme style to use (default, transparent, ...)
18243     *
18244     * @see elm_object_tooltip_style_set() for more details.
18245     *
18246     * @ingroup List
18247     */
18248    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18249
18250    /**
18251     * Get the style for this item tooltip.
18252     *
18253     * @param item list item with tooltip already set.
18254     * @return style the theme style in use, defaults to "default". If the
18255     *         object does not have a tooltip set, then NULL is returned.
18256     *
18257     * @see elm_object_tooltip_style_get() for more details.
18258     * @see elm_list_item_tooltip_style_set()
18259     *
18260     * @ingroup List
18261     */
18262    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18263
18264    /**
18265     * Set the type of mouse pointer/cursor decoration to be shown,
18266     * when the mouse pointer is over the given list widget item
18267     *
18268     * @param item list item to customize cursor on
18269     * @param cursor the cursor type's name
18270     *
18271     * This function works analogously as elm_object_cursor_set(), but
18272     * here the cursor's changing area is restricted to the item's
18273     * area, and not the whole widget's. Note that that item cursors
18274     * have precedence over widget cursors, so that a mouse over an
18275     * item with custom cursor set will always show @b that cursor.
18276     *
18277     * If this function is called twice for an object, a previously set
18278     * cursor will be unset on the second call.
18279     *
18280     * @see elm_object_cursor_set()
18281     * @see elm_list_item_cursor_get()
18282     * @see elm_list_item_cursor_unset()
18283     *
18284     * @ingroup List
18285     */
18286    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18287
18288    /*
18289     * Get the type of mouse pointer/cursor decoration set to be shown,
18290     * when the mouse pointer is over the given list widget item
18291     *
18292     * @param item list item with custom cursor set
18293     * @return the cursor type's name or @c NULL, if no custom cursors
18294     * were set to @p item (and on errors)
18295     *
18296     * @see elm_object_cursor_get()
18297     * @see elm_list_item_cursor_set()
18298     * @see elm_list_item_cursor_unset()
18299     *
18300     * @ingroup List
18301     */
18302    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18303
18304    /**
18305     * Unset any custom mouse pointer/cursor decoration set to be
18306     * shown, when the mouse pointer is over the given list widget
18307     * item, thus making it show the @b default cursor again.
18308     *
18309     * @param item a list item
18310     *
18311     * Use this call to undo any custom settings on this item's cursor
18312     * decoration, bringing it back to defaults (no custom style set).
18313     *
18314     * @see elm_object_cursor_unset()
18315     * @see elm_list_item_cursor_set()
18316     *
18317     * @ingroup List
18318     */
18319    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
18320
18321    /**
18322     * Set a different @b style for a given custom cursor set for a
18323     * list item.
18324     *
18325     * @param item list item with custom cursor set
18326     * @param style the <b>theme style</b> to use (e.g. @c "default",
18327     * @c "transparent", etc)
18328     *
18329     * This function only makes sense when one is using custom mouse
18330     * cursor decorations <b>defined in a theme file</b>, which can have,
18331     * given a cursor name/type, <b>alternate styles</b> on it. It
18332     * works analogously as elm_object_cursor_style_set(), but here
18333     * applyed only to list item objects.
18334     *
18335     * @warning Before you set a cursor style you should have definen a
18336     *       custom cursor previously on the item, with
18337     *       elm_list_item_cursor_set()
18338     *
18339     * @see elm_list_item_cursor_engine_only_set()
18340     * @see elm_list_item_cursor_style_get()
18341     *
18342     * @ingroup List
18343     */
18344    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
18345
18346    /**
18347     * Get the current @b style set for a given list item's custom
18348     * cursor
18349     *
18350     * @param item list item with custom cursor set.
18351     * @return style the cursor style in use. If the object does not
18352     *         have a cursor set, then @c NULL is returned.
18353     *
18354     * @see elm_list_item_cursor_style_set() for more details
18355     *
18356     * @ingroup List
18357     */
18358    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18359
18360    /**
18361     * Set if the (custom)cursor for a given list item should be
18362     * searched in its theme, also, or should only rely on the
18363     * rendering engine.
18364     *
18365     * @param item item with custom (custom) cursor already set on
18366     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18367     * only on those provided by the rendering engine, @c EINA_FALSE to
18368     * have them searched on the widget's theme, as well.
18369     *
18370     * @note This call is of use only if you've set a custom cursor
18371     * for list items, with elm_list_item_cursor_set().
18372     *
18373     * @note By default, cursors will only be looked for between those
18374     * provided by the rendering engine.
18375     *
18376     * @ingroup List
18377     */
18378    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18379
18380    /**
18381     * Get if the (custom) cursor for a given list item is being
18382     * searched in its theme, also, or is only relying on the rendering
18383     * engine.
18384     *
18385     * @param item a list item
18386     * @return @c EINA_TRUE, if cursors are being looked for only on
18387     * those provided by the rendering engine, @c EINA_FALSE if they
18388     * are being searched on the widget's theme, as well.
18389     *
18390     * @see elm_list_item_cursor_engine_only_set(), for more details
18391     *
18392     * @ingroup List
18393     */
18394    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
18395
18396    /**
18397     * @}
18398     */
18399
18400    /**
18401     * @defgroup Slider Slider
18402     * @ingroup Elementary
18403     *
18404     * @image html img/widget/slider/preview-00.png
18405     * @image latex img/widget/slider/preview-00.eps width=\textwidth
18406     *
18407     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
18408     * something within a range.
18409     *
18410     * A slider can be horizontal or vertical. It can contain an Icon and has a
18411     * primary label as well as a units label (that is formatted with floating
18412     * point values and thus accepts a printf-style format string, like
18413     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
18414     * else (like on the slider itself) that also accepts a format string like
18415     * units. Label, Icon Unit and Indicator strings/objects are optional.
18416     *
18417     * A slider may be inverted which means values invert, with high vales being
18418     * on the left or top and low values on the right or bottom (as opposed to
18419     * normally being low on the left or top and high on the bottom and right).
18420     *
18421     * The slider should have its minimum and maximum values set by the
18422     * application with  elm_slider_min_max_set() and value should also be set by
18423     * the application before use with  elm_slider_value_set(). The span of the
18424     * slider is its length (horizontally or vertically). This will be scaled by
18425     * the object or applications scaling factor. At any point code can query the
18426     * slider for its value with elm_slider_value_get().
18427     *
18428     * Smart callbacks one can listen to:
18429     * - "changed" - Whenever the slider value is changed by the user.
18430     * - "slider,drag,start" - dragging the slider indicator around has started.
18431     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
18432     * - "delay,changed" - A short time after the value is changed by the user.
18433     * This will be called only when the user stops dragging for
18434     * a very short period or when they release their
18435     * finger/mouse, so it avoids possibly expensive reactions to
18436     * the value change.
18437     *
18438     * Available styles for it:
18439     * - @c "default"
18440     *
18441     * Default contents parts of the slider widget that you can use for are:
18442     * @li "icon" - An icon of the slider
18443     * @li "end" - A end part content of the slider
18444     *
18445     * Default text parts of the silder widget that you can use for are:
18446     * @li "default" - Label of the silder
18447     * Here is an example on its usage:
18448     * @li @ref slider_example
18449     */
18450
18451    /**
18452     * @addtogroup Slider
18453     * @{
18454     */
18455
18456    /**
18457     * Add a new slider widget to the given parent Elementary
18458     * (container) object.
18459     *
18460     * @param parent The parent object.
18461     * @return a new slider widget handle or @c NULL, on errors.
18462     *
18463     * This function inserts a new slider widget on the canvas.
18464     *
18465     * @ingroup Slider
18466     */
18467    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18468
18469    /**
18470     * Set the label of a given slider widget
18471     *
18472     * @param obj The progress bar object
18473     * @param label The text label string, in UTF-8
18474     *
18475     * @ingroup Slider
18476     * @deprecated use elm_object_text_set() instead.
18477     */
18478    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18479
18480    /**
18481     * Get the label of a given slider widget
18482     *
18483     * @param obj The progressbar object
18484     * @return The text label string, in UTF-8
18485     *
18486     * @ingroup Slider
18487     * @deprecated use elm_object_text_get() instead.
18488     */
18489    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18490
18491    /**
18492     * Set the icon object of the slider object.
18493     *
18494     * @param obj The slider object.
18495     * @param icon The icon object.
18496     *
18497     * On horizontal mode, icon is placed at left, and on vertical mode,
18498     * placed at top.
18499     *
18500     * @note Once the icon object is set, a previously set one will be deleted.
18501     * If you want to keep that old content object, use the
18502     * elm_slider_icon_unset() function.
18503     *
18504     * @warning If the object being set does not have minimum size hints set,
18505     * it won't get properly displayed.
18506     *
18507     * @ingroup Slider
18508     * @deprecated use elm_object_part_content_set() instead.
18509     */
18510    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18511
18512    /**
18513     * Unset an icon set on a given slider widget.
18514     *
18515     * @param obj The slider object.
18516     * @return The icon object that was being used, if any was set, or
18517     * @c NULL, otherwise (and on errors).
18518     *
18519     * On horizontal mode, icon is placed at left, and on vertical mode,
18520     * placed at top.
18521     *
18522     * This call will unparent and return the icon object which was set
18523     * for this widget, previously, on success.
18524     *
18525     * @see elm_slider_icon_set() for more details
18526     * @see elm_slider_icon_get()
18527     * @deprecated use elm_object_part_content_unset() instead.
18528     *
18529     * @ingroup Slider
18530     */
18531    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18532
18533    /**
18534     * Retrieve the icon object set for a given slider widget.
18535     *
18536     * @param obj The slider object.
18537     * @return The icon object's handle, if @p obj had one set, or @c NULL,
18538     * otherwise (and on errors).
18539     *
18540     * On horizontal mode, icon is placed at left, and on vertical mode,
18541     * placed at top.
18542     *
18543     * @see elm_slider_icon_set() for more details
18544     * @see elm_slider_icon_unset()
18545     *
18546     * @deprecated use elm_object_part_content_get() instead.
18547     *
18548     * @ingroup Slider
18549     */
18550    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18551
18552    /**
18553     * Set the end object of the slider object.
18554     *
18555     * @param obj The slider object.
18556     * @param end The end object.
18557     *
18558     * On horizontal mode, end is placed at left, and on vertical mode,
18559     * placed at bottom.
18560     *
18561     * @note Once the icon object is set, a previously set one will be deleted.
18562     * If you want to keep that old content object, use the
18563     * elm_slider_end_unset() function.
18564     *
18565     * @warning If the object being set does not have minimum size hints set,
18566     * it won't get properly displayed.
18567     *
18568     * @deprecated use elm_object_part_content_set() instead.
18569     *
18570     * @ingroup Slider
18571     */
18572    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
18573
18574    /**
18575     * Unset an end object set on a given slider widget.
18576     *
18577     * @param obj The slider object.
18578     * @return The end object that was being used, if any was set, or
18579     * @c NULL, otherwise (and on errors).
18580     *
18581     * On horizontal mode, end is placed at left, and on vertical mode,
18582     * placed at bottom.
18583     *
18584     * This call will unparent and return the icon object which was set
18585     * for this widget, previously, on success.
18586     *
18587     * @see elm_slider_end_set() for more details.
18588     * @see elm_slider_end_get()
18589     *
18590     * @deprecated use elm_object_part_content_unset() instead
18591     * instead.
18592     *
18593     * @ingroup Slider
18594     */
18595    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18596
18597    /**
18598     * Retrieve the end object set for a given slider widget.
18599     *
18600     * @param obj The slider object.
18601     * @return The end object's handle, if @p obj had one set, or @c NULL,
18602     * otherwise (and on errors).
18603     *
18604     * On horizontal mode, icon is placed at right, and on vertical mode,
18605     * placed at bottom.
18606     *
18607     * @see elm_slider_end_set() for more details.
18608     * @see elm_slider_end_unset()
18609     *
18610     *
18611     * @deprecated use elm_object_part_content_get() instead
18612     * instead.
18613     *
18614     * @ingroup Slider
18615     */
18616    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18617
18618    /**
18619     * Set the (exact) length of the bar region of a given slider widget.
18620     *
18621     * @param obj The slider object.
18622     * @param size The length of the slider's bar region.
18623     *
18624     * This sets the minimum width (when in horizontal mode) or height
18625     * (when in vertical mode) of the actual bar area of the slider
18626     * @p obj. This in turn affects the object's minimum size. Use
18627     * this when you're not setting other size hints expanding on the
18628     * given direction (like weight and alignment hints) and you would
18629     * like it to have a specific size.
18630     *
18631     * @note Icon, end, label, indicator and unit text around @p obj
18632     * will require their
18633     * own space, which will make @p obj to require more the @p size,
18634     * actually.
18635     *
18636     * @see elm_slider_span_size_get()
18637     *
18638     * @ingroup Slider
18639     */
18640    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
18641
18642    /**
18643     * Get the length set for the bar region of a given slider widget
18644     *
18645     * @param obj The slider object.
18646     * @return The length of the slider's bar region.
18647     *
18648     * If that size was not set previously, with
18649     * elm_slider_span_size_set(), this call will return @c 0.
18650     *
18651     * @ingroup Slider
18652     */
18653    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18654
18655    /**
18656     * Set the format string for the unit label.
18657     *
18658     * @param obj The slider object.
18659     * @param format The format string for the unit display.
18660     *
18661     * Unit label is displayed all the time, if set, after slider's bar.
18662     * In horizontal mode, at right and in vertical mode, at bottom.
18663     *
18664     * If @c NULL, unit label won't be visible. If not it sets the format
18665     * string for the label text. To the label text is provided a floating point
18666     * value, so the label text can display up to 1 floating point value.
18667     * Note that this is optional.
18668     *
18669     * Use a format string such as "%1.2f meters" for example, and it will
18670     * display values like: "3.14 meters" for a value equal to 3.14159.
18671     *
18672     * Default is unit label disabled.
18673     *
18674     * @see elm_slider_indicator_format_get()
18675     *
18676     * @ingroup Slider
18677     */
18678    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
18679
18680    /**
18681     * Get the unit label format of the slider.
18682     *
18683     * @param obj The slider object.
18684     * @return The unit label format string in UTF-8.
18685     *
18686     * Unit label is displayed all the time, if set, after slider's bar.
18687     * In horizontal mode, at right and in vertical mode, at bottom.
18688     *
18689     * @see elm_slider_unit_format_set() for more
18690     * information on how this works.
18691     *
18692     * @ingroup Slider
18693     */
18694    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18695
18696    /**
18697     * Set the format string for the indicator label.
18698     *
18699     * @param obj The slider object.
18700     * @param indicator The format string for the indicator display.
18701     *
18702     * The slider may display its value somewhere else then unit label,
18703     * for example, above the slider knob that is dragged around. This function
18704     * sets the format string used for this.
18705     *
18706     * If @c NULL, indicator label won't be visible. If not it sets the format
18707     * string for the label text. To the label text is provided a floating point
18708     * value, so the label text can display up to 1 floating point value.
18709     * Note that this is optional.
18710     *
18711     * Use a format string such as "%1.2f meters" for example, and it will
18712     * display values like: "3.14 meters" for a value equal to 3.14159.
18713     *
18714     * Default is indicator label disabled.
18715     *
18716     * @see elm_slider_indicator_format_get()
18717     *
18718     * @ingroup Slider
18719     */
18720    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
18721
18722    /**
18723     * Get the indicator label format of the slider.
18724     *
18725     * @param obj The slider object.
18726     * @return The indicator label format string in UTF-8.
18727     *
18728     * The slider may display its value somewhere else then unit label,
18729     * for example, above the slider knob that is dragged around. This function
18730     * gets the format string used for this.
18731     *
18732     * @see elm_slider_indicator_format_set() for more
18733     * information on how this works.
18734     *
18735     * @ingroup Slider
18736     */
18737    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18738
18739    /**
18740     * Set the format function pointer for the indicator label
18741     *
18742     * @param obj The slider object.
18743     * @param func The indicator format function.
18744     * @param free_func The freeing function for the format string.
18745     *
18746     * Set the callback function to format the indicator string.
18747     *
18748     * @see elm_slider_indicator_format_set() for more info on how this works.
18749     *
18750     * @ingroup Slider
18751     */
18752   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);
18753
18754   /**
18755    * Set the format function pointer for the units label
18756    *
18757    * @param obj The slider object.
18758    * @param func The units format function.
18759    * @param free_func The freeing function for the format string.
18760    *
18761    * Set the callback function to format the indicator string.
18762    *
18763    * @see elm_slider_units_format_set() for more info on how this works.
18764    *
18765    * @ingroup Slider
18766    */
18767   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);
18768
18769   /**
18770    * Set the orientation of a given slider widget.
18771    *
18772    * @param obj The slider object.
18773    * @param horizontal Use @c EINA_TRUE to make @p obj to be
18774    * @b horizontal, @c EINA_FALSE to make it @b vertical.
18775    *
18776    * Use this function to change how your slider is to be
18777    * disposed: vertically or horizontally.
18778    *
18779    * By default it's displayed horizontally.
18780    *
18781    * @see elm_slider_horizontal_get()
18782    *
18783    * @ingroup Slider
18784    */
18785    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
18786
18787    /**
18788     * Retrieve the orientation of a given slider widget
18789     *
18790     * @param obj The slider object.
18791     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
18792     * @c EINA_FALSE if it's @b vertical (and on errors).
18793     *
18794     * @see elm_slider_horizontal_set() for more details.
18795     *
18796     * @ingroup Slider
18797     */
18798    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18799
18800    /**
18801     * Set the minimum and maximum values for the slider.
18802     *
18803     * @param obj The slider object.
18804     * @param min The minimum value.
18805     * @param max The maximum value.
18806     *
18807     * Define the allowed range of values to be selected by the user.
18808     *
18809     * If actual value is less than @p min, it will be updated to @p min. If it
18810     * is bigger then @p max, will be updated to @p max. Actual value can be
18811     * get with elm_slider_value_get().
18812     *
18813     * By default, min is equal to 0.0, and max is equal to 1.0.
18814     *
18815     * @warning Maximum must be greater than minimum, otherwise behavior
18816     * is undefined.
18817     *
18818     * @see elm_slider_min_max_get()
18819     *
18820     * @ingroup Slider
18821     */
18822    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
18823
18824    /**
18825     * Get the minimum and maximum values of the slider.
18826     *
18827     * @param obj The slider object.
18828     * @param min Pointer where to store the minimum value.
18829     * @param max Pointer where to store the maximum value.
18830     *
18831     * @note If only one value is needed, the other pointer can be passed
18832     * as @c NULL.
18833     *
18834     * @see elm_slider_min_max_set() for details.
18835     *
18836     * @ingroup Slider
18837     */
18838    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
18839
18840    /**
18841     * Set the value the slider displays.
18842     *
18843     * @param obj The slider object.
18844     * @param val The value to be displayed.
18845     *
18846     * Value will be presented on the unit label following format specified with
18847     * elm_slider_unit_format_set() and on indicator with
18848     * elm_slider_indicator_format_set().
18849     *
18850     * @warning The value must to be between min and max values. This values
18851     * are set by elm_slider_min_max_set().
18852     *
18853     * @see elm_slider_value_get()
18854     * @see elm_slider_unit_format_set()
18855     * @see elm_slider_indicator_format_set()
18856     * @see elm_slider_min_max_set()
18857     *
18858     * @ingroup Slider
18859     */
18860    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
18861
18862    /**
18863     * Get the value displayed by the spinner.
18864     *
18865     * @param obj The spinner object.
18866     * @return The value displayed.
18867     *
18868     * @see elm_spinner_value_set() for details.
18869     *
18870     * @ingroup Slider
18871     */
18872    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18873
18874    /**
18875     * Invert a given slider widget's displaying values order
18876     *
18877     * @param obj The slider object.
18878     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
18879     * @c EINA_FALSE to bring it back to default, non-inverted values.
18880     *
18881     * A slider may be @b inverted, in which state it gets its
18882     * values inverted, with high vales being on the left or top and
18883     * low values on the right or bottom, as opposed to normally have
18884     * the low values on the former and high values on the latter,
18885     * respectively, for horizontal and vertical modes.
18886     *
18887     * @see elm_slider_inverted_get()
18888     *
18889     * @ingroup Slider
18890     */
18891    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
18892
18893    /**
18894     * Get whether a given slider widget's displaying values are
18895     * inverted or not.
18896     *
18897     * @param obj The slider object.
18898     * @return @c EINA_TRUE, if @p obj has inverted values,
18899     * @c EINA_FALSE otherwise (and on errors).
18900     *
18901     * @see elm_slider_inverted_set() for more details.
18902     *
18903     * @ingroup Slider
18904     */
18905    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18906
18907    /**
18908     * Set whether to enlarge slider indicator (augmented knob) or not.
18909     *
18910     * @param obj The slider object.
18911     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
18912     * let the knob always at default size.
18913     *
18914     * By default, indicator will be bigger while dragged by the user.
18915     *
18916     * @warning It won't display values set with
18917     * elm_slider_indicator_format_set() if you disable indicator.
18918     *
18919     * @ingroup Slider
18920     */
18921    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
18922
18923    /**
18924     * Get whether a given slider widget's enlarging indicator or not.
18925     *
18926     * @param obj The slider object.
18927     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
18928     * @c EINA_FALSE otherwise (and on errors).
18929     *
18930     * @see elm_slider_indicator_show_set() for details.
18931     *
18932     * @ingroup Slider
18933     */
18934    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18935
18936    /**
18937     * @}
18938     */
18939
18940    /**
18941     * @addtogroup Actionslider Actionslider
18942     *
18943     * @image html img/widget/actionslider/preview-00.png
18944     * @image latex img/widget/actionslider/preview-00.eps
18945     *
18946     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18947     * properties. The user drags and releases the indicator, to choose a label.
18948     *
18949     * Labels occupy the following positions.
18950     * a. Left
18951     * b. Right
18952     * c. Center
18953     *
18954     * Positions can be enabled or disabled.
18955     *
18956     * Magnets can be set on the above positions.
18957     *
18958     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18959     *
18960     * @note By default all positions are set as enabled.
18961     *
18962     * Signals that you can add callbacks for are:
18963     *
18964     * "selected" - when user selects an enabled position (the label is passed
18965     *              as event info)".
18966     * @n
18967     * "pos_changed" - when the indicator reaches any of the positions("left",
18968     *                 "right" or "center").
18969     *
18970     * See an example of actionslider usage @ref actionslider_example_page "here"
18971     * @{
18972     */
18973    typedef enum _Elm_Actionslider_Pos
18974      {
18975         ELM_ACTIONSLIDER_NONE = 0,
18976         ELM_ACTIONSLIDER_LEFT = 1 << 0,
18977         ELM_ACTIONSLIDER_CENTER = 1 << 1,
18978         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
18979         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
18980      } Elm_Actionslider_Pos;
18981
18982    /**
18983     * Add a new actionslider to the parent.
18984     *
18985     * @param parent The parent object
18986     * @return The new actionslider object or NULL if it cannot be created
18987     */
18988    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18989
18990    /**
18991     * Set actionslider labels.
18992     *
18993     * @param obj The actionslider object
18994     * @param left_label The label to be set on the left.
18995     * @param center_label The label to be set on the center.
18996     * @param right_label The label to be set on the right.
18997     * @deprecated use elm_object_text_set() instead.
18998     */
18999    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
19000
19001    /**
19002     * Get actionslider labels.
19003     *
19004     * @param obj The actionslider object
19005     * @param left_label A char** to place the left_label of @p obj into.
19006     * @param center_label A char** to place the center_label of @p obj into.
19007     * @param right_label A char** to place the right_label of @p obj into.
19008     * @deprecated use elm_object_text_set() instead.
19009     */
19010    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
19011
19012    /**
19013     * Get actionslider selected label.
19014     *
19015     * @param obj The actionslider object
19016     * @return The selected label
19017     */
19018    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19019
19020    /**
19021     * Set actionslider indicator position.
19022     *
19023     * @param obj The actionslider object.
19024     * @param pos The position of the indicator.
19025     */
19026    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19027
19028    /**
19029     * Get actionslider indicator position.
19030     *
19031     * @param obj The actionslider object.
19032     * @return The position of the indicator.
19033     */
19034    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19035
19036    /**
19037     * Set actionslider magnet position. To make multiple positions magnets @c or
19038     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
19039     *
19040     * @param obj The actionslider object.
19041     * @param pos Bit mask indicating the magnet positions.
19042     */
19043    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19044
19045    /**
19046     * Get actionslider magnet position.
19047     *
19048     * @param obj The actionslider object.
19049     * @return The positions with magnet property.
19050     */
19051    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19052
19053    /**
19054     * Set actionslider enabled position. To set multiple positions as enabled @c or
19055     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
19056     *
19057     * @note All the positions are enabled by default.
19058     *
19059     * @param obj The actionslider object.
19060     * @param pos Bit mask indicating the enabled positions.
19061     */
19062    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
19063
19064    /**
19065     * Get actionslider enabled position.
19066     *
19067     * @param obj The actionslider object.
19068     * @return The enabled positions.
19069     */
19070    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19071
19072    /**
19073     * Set the label used on the indicator.
19074     *
19075     * @param obj The actionslider object
19076     * @param label The label to be set on the indicator.
19077     * @deprecated use elm_object_text_set() instead.
19078     */
19079    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19080
19081    /**
19082     * Get the label used on the indicator object.
19083     *
19084     * @param obj The actionslider object
19085     * @return The indicator label
19086     * @deprecated use elm_object_text_get() instead.
19087     */
19088    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
19089
19090    /**
19091     * @}
19092     */
19093
19094    /**
19095     * @defgroup Genlist Genlist
19096     *
19097     * @image html img/widget/genlist/preview-00.png
19098     * @image latex img/widget/genlist/preview-00.eps
19099     * @image html img/genlist.png
19100     * @image latex img/genlist.eps
19101     *
19102     * This widget aims to have more expansive list than the simple list in
19103     * Elementary that could have more flexible items and allow many more entries
19104     * while still being fast and low on memory usage. At the same time it was
19105     * also made to be able to do tree structures. But the price to pay is more
19106     * complexity when it comes to usage. If all you want is a simple list with
19107     * icons and a single text, use the normal @ref List object.
19108     *
19109     * Genlist has a fairly large API, mostly because it's relatively complex,
19110     * trying to be both expansive, powerful and efficient. First we will begin
19111     * an overview on the theory behind genlist.
19112     *
19113     * @section Genlist_Item_Class Genlist item classes - creating items
19114     *
19115     * In order to have the ability to add and delete items on the fly, genlist
19116     * implements a class (callback) system where the application provides a
19117     * structure with information about that type of item (genlist may contain
19118     * multiple different items with different classes, states and styles).
19119     * Genlist will call the functions in this struct (methods) when an item is
19120     * "realized" (i.e., created dynamically, while the user is scrolling the
19121     * grid). All objects will simply be deleted when no longer needed with
19122     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
19123     * following members:
19124     * - @c item_style - This is a constant string and simply defines the name
19125     *   of the item style. It @b must be specified and the default should be @c
19126     *   "default".
19127     *
19128     * - @c func - A struct with pointers to functions that will be called when
19129     *   an item is going to be actually created. All of them receive a @c data
19130     *   parameter that will point to the same data passed to
19131     *   elm_genlist_item_append() and related item creation functions, and a @c
19132     *   obj parameter that points to the genlist object itself.
19133     *
19134     * The function pointers inside @c func are @c text_get, @c content_get, @c
19135     * state_get and @c del. The 3 first functions also receive a @c part
19136     * parameter described below. A brief description of these functions follows:
19137     *
19138     * - @c text_get - The @c part parameter is the name string of one of the
19139     *   existing text parts in the Edje group implementing the item's theme.
19140     *   This function @b must return a strdup'()ed string, as the caller will
19141     *   free() it when done. See #Elm_Genlist_Item_Text_Get_Cb.
19142     * - @c content_get - The @c part parameter is the name string of one of the
19143     *   existing (content) swallow parts in the Edje group implementing the item's
19144     *   theme. It must return @c NULL, when no content is desired, or a valid
19145     *   object handle, otherwise.  The object will be deleted by the genlist on
19146     *   its deletion or when the item is "unrealized".  See
19147     *   #Elm_Genlist_Item_Content_Get_Cb.
19148     * - @c func.state_get - The @c part parameter is the name string of one of
19149     *   the state parts in the Edje group implementing the item's theme. Return
19150     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
19151     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
19152     *   and @c "elm" as "emission" and "source" arguments, respectively, when
19153     *   the state is true (the default is false), where @c XXX is the name of
19154     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
19155     * - @c func.del - This is intended for use when genlist items are deleted,
19156     *   so any data attached to the item (e.g. its data parameter on creation)
19157     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
19158     *
19159     * available item styles:
19160     * - default
19161     * - default_style - The text part is a textblock
19162     *
19163     * @image html img/widget/genlist/preview-04.png
19164     * @image latex img/widget/genlist/preview-04.eps
19165     *
19166     * - double_label
19167     *
19168     * @image html img/widget/genlist/preview-01.png
19169     * @image latex img/widget/genlist/preview-01.eps
19170     *
19171     * - icon_top_text_bottom
19172     *
19173     * @image html img/widget/genlist/preview-02.png
19174     * @image latex img/widget/genlist/preview-02.eps
19175     *
19176     * - group_index
19177     *
19178     * @image html img/widget/genlist/preview-03.png
19179     * @image latex img/widget/genlist/preview-03.eps
19180     *
19181     * @section Genlist_Items Structure of items
19182     *
19183     * An item in a genlist can have 0 or more texts (they can be regular
19184     * text or textblock Evas objects - that's up to the style to determine), 0
19185     * or more contents (which are simply objects swallowed into the genlist item's
19186     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
19187     * behavior left to the user to define. The Edje part names for each of
19188     * these properties will be looked up, in the theme file for the genlist,
19189     * under the Edje (string) data items named @c "labels", @c "contents" and @c
19190     * "states", respectively. For each of those properties, if more than one
19191     * part is provided, they must have names listed separated by spaces in the
19192     * data fields. For the default genlist item theme, we have @b one text 
19193     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
19194     * "elm.swallow.end") and @b no state parts.
19195     *
19196     * A genlist item may be at one of several styles. Elementary provides one
19197     * by default - "default", but this can be extended by system or application
19198     * custom themes/overlays/extensions (see @ref Theme "themes" for more
19199     * details).
19200     *
19201     * @section Genlist_Manipulation Editing and Navigating
19202     *
19203     * Items can be added by several calls. All of them return a @ref
19204     * Elm_Genlist_Item handle that is an internal member inside the genlist.
19205     * They all take a data parameter that is meant to be used for a handle to
19206     * the applications internal data (eg the struct with the original item
19207     * data). The parent parameter is the parent genlist item this belongs to if
19208     * it is a tree or an indexed group, and NULL if there is no parent. The
19209     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
19210     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
19211     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
19212     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
19213     * is set then this item is group index item that is displayed at the top
19214     * until the next group comes. The func parameter is a convenience callback
19215     * that is called when the item is selected and the data parameter will be
19216     * the func_data parameter, obj be the genlist object and event_info will be
19217     * the genlist item.
19218     *
19219     * elm_genlist_item_append() adds an item to the end of the list, or if
19220     * there is a parent, to the end of all the child items of the parent.
19221     * elm_genlist_item_prepend() is the same but adds to the beginning of
19222     * the list or children list. elm_genlist_item_insert_before() inserts at
19223     * item before another item and elm_genlist_item_insert_after() inserts after
19224     * the indicated item.
19225     *
19226     * The application can clear the list with elm_genlist_clear() which deletes
19227     * all the items in the list and elm_genlist_item_del() will delete a specific
19228     * item. elm_genlist_item_subitems_clear() will clear all items that are
19229     * children of the indicated parent item.
19230     *
19231     * To help inspect list items you can jump to the item at the top of the list
19232     * with elm_genlist_first_item_get() which will return the item pointer, and
19233     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
19234     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
19235     * and previous items respectively relative to the indicated item. Using
19236     * these calls you can walk the entire item list/tree. Note that as a tree
19237     * the items are flattened in the list, so elm_genlist_item_parent_get() will
19238     * let you know which item is the parent (and thus know how to skip them if
19239     * wanted).
19240     *
19241     * @section Genlist_Muti_Selection Multi-selection
19242     *
19243     * If the application wants multiple items to be able to be selected,
19244     * elm_genlist_multi_select_set() can enable this. If the list is
19245     * single-selection only (the default), then elm_genlist_selected_item_get()
19246     * will return the selected item, if any, or NULL if none is selected. If the
19247     * list is multi-select then elm_genlist_selected_items_get() will return a
19248     * list (that is only valid as long as no items are modified (added, deleted,
19249     * selected or unselected)).
19250     *
19251     * @section Genlist_Usage_Hints Usage hints
19252     *
19253     * There are also convenience functions. elm_genlist_item_genlist_get() will
19254     * return the genlist object the item belongs to. elm_genlist_item_show()
19255     * will make the scroller scroll to show that specific item so its visible.
19256     * elm_genlist_item_data_get() returns the data pointer set by the item
19257     * creation functions.
19258     *
19259     * If an item changes (state of boolean changes, text or contents change),
19260     * then use elm_genlist_item_update() to have genlist update the item with
19261     * the new state. Genlist will re-realize the item thus call the functions
19262     * in the _Elm_Genlist_Item_Class for that item.
19263     *
19264     * To programmatically (un)select an item use elm_genlist_item_selected_set().
19265     * To get its selected state use elm_genlist_item_selected_get(). Similarly
19266     * to expand/contract an item and get its expanded state, use
19267     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
19268     * again to make an item disabled (unable to be selected and appear
19269     * differently) use elm_genlist_item_disabled_set() to set this and
19270     * elm_genlist_item_disabled_get() to get the disabled state.
19271     *
19272     * In general to indicate how the genlist should expand items horizontally to
19273     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
19274     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
19275     * mode means that if items are too wide to fit, the scroller will scroll
19276     * horizontally. Otherwise items are expanded to fill the width of the
19277     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
19278     * to the viewport width and limited to that size. This can be combined with
19279     * a different style that uses edjes' ellipsis feature (cutting text off like
19280     * this: "tex...").
19281     *
19282     * Items will only call their selection func and callback when first becoming
19283     * selected. Any further clicks will do nothing, unless you enable always
19284     * select with elm_genlist_always_select_mode_set(). This means even if
19285     * selected, every click will make the selected callbacks be called.
19286     * elm_genlist_no_select_mode_set() will turn off the ability to select
19287     * items entirely and they will neither appear selected nor call selected
19288     * callback functions.
19289     *
19290     * Remember that you can create new styles and add your own theme augmentation
19291     * per application with elm_theme_extension_add(). If you absolutely must
19292     * have a specific style that overrides any theme the user or system sets up
19293     * you can use elm_theme_overlay_add() to add such a file.
19294     *
19295     * @section Genlist_Implementation Implementation
19296     *
19297     * Evas tracks every object you create. Every time it processes an event
19298     * (mouse move, down, up etc.) it needs to walk through objects and find out
19299     * what event that affects. Even worse every time it renders display updates,
19300     * in order to just calculate what to re-draw, it needs to walk through many
19301     * many many objects. Thus, the more objects you keep active, the more
19302     * overhead Evas has in just doing its work. It is advisable to keep your
19303     * active objects to the minimum working set you need. Also remember that
19304     * object creation and deletion carries an overhead, so there is a
19305     * middle-ground, which is not easily determined. But don't keep massive lists
19306     * of objects you can't see or use. Genlist does this with list objects. It
19307     * creates and destroys them dynamically as you scroll around. It groups them
19308     * into blocks so it can determine the visibility etc. of a whole block at
19309     * once as opposed to having to walk the whole list. This 2-level list allows
19310     * for very large numbers of items to be in the list (tests have used up to
19311     * 2,000,000 items). Also genlist employs a queue for adding items. As items
19312     * may be different sizes, every item added needs to be calculated as to its
19313     * size and thus this presents a lot of overhead on populating the list, this
19314     * genlist employs a queue. Any item added is queued and spooled off over
19315     * time, actually appearing some time later, so if your list has many members
19316     * you may find it takes a while for them to all appear, with your process
19317     * consuming a lot of CPU while it is busy spooling.
19318     *
19319     * Genlist also implements a tree structure, but it does so with callbacks to
19320     * the application, with the application filling in tree structures when
19321     * requested (allowing for efficient building of a very deep tree that could
19322     * even be used for file-management). See the above smart signal callbacks for
19323     * details.
19324     *
19325     * @section Genlist_Smart_Events Genlist smart events
19326     *
19327     * Signals that you can add callbacks for are:
19328     * - @c "activated" - The user has double-clicked or pressed
19329     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
19330     *   item that was activated.
19331     * - @c "clicked,double" - The user has double-clicked an item.  The @c
19332     *   event_info parameter is the item that was double-clicked.
19333     * - @c "selected" - This is called when a user has made an item selected.
19334     *   The event_info parameter is the genlist item that was selected.
19335     * - @c "unselected" - This is called when a user has made an item
19336     *   unselected. The event_info parameter is the genlist item that was
19337     *   unselected.
19338     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
19339     *   called and the item is now meant to be expanded. The event_info
19340     *   parameter is the genlist item that was indicated to expand.  It is the
19341     *   job of this callback to then fill in the child items.
19342     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
19343     *   called and the item is now meant to be contracted. The event_info
19344     *   parameter is the genlist item that was indicated to contract. It is the
19345     *   job of this callback to then delete the child items.
19346     * - @c "expand,request" - This is called when a user has indicated they want
19347     *   to expand a tree branch item. The callback should decide if the item can
19348     *   expand (has any children) and then call elm_genlist_item_expanded_set()
19349     *   appropriately to set the state. The event_info parameter is the genlist
19350     *   item that was indicated to expand.
19351     * - @c "contract,request" - This is called when a user has indicated they
19352     *   want to contract a tree branch item. The callback should decide if the
19353     *   item can contract (has any children) and then call
19354     *   elm_genlist_item_expanded_set() appropriately to set the state. The
19355     *   event_info parameter is the genlist item that was indicated to contract.
19356     * - @c "realized" - This is called when the item in the list is created as a
19357     *   real evas object. event_info parameter is the genlist item that was
19358     *   created. The object may be deleted at any time, so it is up to the
19359     *   caller to not use the object pointer from elm_genlist_item_object_get()
19360     *   in a way where it may point to freed objects.
19361     * - @c "unrealized" - This is called just before an item is unrealized.
19362     *   After this call content objects provided will be deleted and the item
19363     *   object itself delete or be put into a floating cache.
19364     * - @c "drag,start,up" - This is called when the item in the list has been
19365     *   dragged (not scrolled) up.
19366     * - @c "drag,start,down" - This is called when the item in the list has been
19367     *   dragged (not scrolled) down.
19368     * - @c "drag,start,left" - This is called when the item in the list has been
19369     *   dragged (not scrolled) left.
19370     * - @c "drag,start,right" - This is called when the item in the list has
19371     *   been dragged (not scrolled) right.
19372     * - @c "drag,stop" - This is called when the item in the list has stopped
19373     *   being dragged.
19374     * - @c "drag" - This is called when the item in the list is being dragged.
19375     * - @c "longpressed" - This is called when the item is pressed for a certain
19376     *   amount of time. By default it's 1 second.
19377     * - @c "scroll,anim,start" - This is called when scrolling animation has
19378     *   started.
19379     * - @c "scroll,anim,stop" - This is called when scrolling animation has
19380     *   stopped.
19381     * - @c "scroll,drag,start" - This is called when dragging the content has
19382     *   started.
19383     * - @c "scroll,drag,stop" - This is called when dragging the content has
19384     *   stopped.
19385     * - @c "edge,top" - This is called when the genlist is scrolled until
19386     *   the top edge.
19387     * - @c "edge,bottom" - This is called when the genlist is scrolled
19388     *   until the bottom edge.
19389     * - @c "edge,left" - This is called when the genlist is scrolled
19390     *   until the left edge.
19391     * - @c "edge,right" - This is called when the genlist is scrolled
19392     *   until the right edge.
19393     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
19394     *   swiped left.
19395     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
19396     *   swiped right.
19397     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
19398     *   swiped up.
19399     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
19400     *   swiped down.
19401     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
19402     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
19403     *   multi-touch pinched in.
19404     * - @c "swipe" - This is called when the genlist is swiped.
19405     * - @c "moved" - This is called when a genlist item is moved.
19406     * - @c "language,changed" - This is called when the program's language is
19407     *   changed.
19408     *
19409     * @section Genlist_Examples Examples
19410     *
19411     * Here is a list of examples that use the genlist, trying to show some of
19412     * its capabilities:
19413     * - @ref genlist_example_01
19414     * - @ref genlist_example_02
19415     * - @ref genlist_example_03
19416     * - @ref genlist_example_04
19417     * - @ref genlist_example_05
19418     */
19419
19420    /**
19421     * @addtogroup Genlist
19422     * @{
19423     */
19424
19425    /**
19426     * @enum _Elm_Genlist_Item_Flags
19427     * @typedef Elm_Genlist_Item_Flags
19428     *
19429     * Defines if the item is of any special type (has subitems or it's the
19430     * index of a group), or is just a simple item.
19431     *
19432     * @ingroup Genlist
19433     */
19434    typedef enum _Elm_Genlist_Item_Flags
19435      {
19436         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
19437         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
19438         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
19439      } Elm_Genlist_Item_Flags;
19440    typedef enum _Elm_Genlist_Item_Field_Flags
19441      {
19442         ELM_GENLIST_ITEM_FIELD_ALL = 0,
19443         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
19444         ELM_GENLIST_ITEM_FIELD_CONTENT = (1 << 1),
19445         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
19446      } Elm_Genlist_Item_Field_Flags;
19447    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
19448    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
19449    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19450    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
19451    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
19452
19453    /**
19454     * Text fetching class function for Elm_Gen_Item_Class.
19455     * @param data The data passed in the item creation function
19456     * @param obj The base widget object
19457     * @param part The part name of the swallow
19458     * @return The allocated (NOT stringshared) string to set as the text
19459     */
19460    typedef char        *(*Elm_Genlist_Item_Text_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19461
19462    /**
19463     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
19464     * @param data The data passed in the item creation function
19465     * @param obj The base widget object
19466     * @param part The part name of the swallow
19467     * @return The content object to swallow
19468     */
19469    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
19470
19471    /**
19472     * State fetching class function for Elm_Gen_Item_Class.
19473     * @param data The data passed in the item creation function
19474     * @param obj The base widget object
19475     * @param part The part name of the swallow
19476     * @return The hell if I know
19477     */
19478    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
19479
19480    /**
19481     * Deletion class function for Elm_Gen_Item_Class.
19482     * @param data The data passed in the item creation function
19483     * @param obj The base widget object
19484     */
19485    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj);
19486
19487    /**
19488     * @struct _Elm_Genlist_Item_Class
19489     *
19490     * Genlist item class definition structs.
19491     *
19492     * This struct contains the style and fetching functions that will define the
19493     * contents of each item.
19494     *
19495     * @see @ref Genlist_Item_Class
19496     */
19497    struct _Elm_Genlist_Item_Class
19498      {
19499         const char                *item_style; /**< style of this class. */
19500         struct Elm_Genlist_Item_Class_Func
19501           {
19502              Elm_Genlist_Item_Text_Get_Cb    text_get; /**< Text fetching class function for genlist item classes.*/
19503              Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
19504              Elm_Genlist_Item_State_Get_Cb   state_get; /**< State fetching class function for genlist item classes. */
19505              Elm_Genlist_Item_Del_Cb         del; /**< Deletion class function for genlist item classes. */
19506           } func;
19507      };
19508    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
19509    /**
19510     * Add a new genlist widget to the given parent Elementary
19511     * (container) object
19512     *
19513     * @param parent The parent object
19514     * @return a new genlist widget handle or @c NULL, on errors
19515     *
19516     * This function inserts a new genlist widget on the canvas.
19517     *
19518     * @see elm_genlist_item_append()
19519     * @see elm_genlist_item_del()
19520     * @see elm_genlist_clear()
19521     *
19522     * @ingroup Genlist
19523     */
19524    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19525
19526    /**
19527     * Remove all items from a given genlist widget.
19528     *
19529     * @param obj The genlist object
19530     *
19531     * This removes (and deletes) all items in @p obj, leaving it empty.
19532     *
19533     * @see elm_genlist_item_del(), to remove just one item.
19534     *
19535     * @ingroup Genlist
19536     */
19537    EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19538
19539    /**
19540     * Enable or disable multi-selection in the genlist
19541     *
19542     * @param obj The genlist object
19543     * @param multi Multi-select enable/disable. Default is disabled.
19544     *
19545     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
19546     * the list. This allows more than 1 item to be selected. To retrieve the list
19547     * of selected items, use elm_genlist_selected_items_get().
19548     *
19549     * @see elm_genlist_selected_items_get()
19550     * @see elm_genlist_multi_select_get()
19551     *
19552     * @ingroup Genlist
19553     */
19554    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
19555
19556    /**
19557     * Gets if multi-selection in genlist is enabled or disabled.
19558     *
19559     * @param obj The genlist object
19560     * @return Multi-select enabled/disabled
19561     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
19562     *
19563     * @see elm_genlist_multi_select_set()
19564     *
19565     * @ingroup Genlist
19566     */
19567    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19568
19569    /**
19570     * This sets the horizontal stretching mode.
19571     *
19572     * @param obj The genlist object
19573     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
19574     *
19575     * This sets the mode used for sizing items horizontally. Valid modes
19576     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
19577     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
19578     * the scroller will scroll horizontally. Otherwise items are expanded
19579     * to fill the width of the viewport of the scroller. If it is
19580     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
19581     * limited to that size.
19582     *
19583     * @see elm_genlist_horizontal_get()
19584     *
19585     * @ingroup Genlist
19586     */
19587    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19588    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
19589
19590    /**
19591     * Gets the horizontal stretching mode.
19592     *
19593     * @param obj The genlist object
19594     * @return The mode to use
19595     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
19596     *
19597     * @see elm_genlist_horizontal_set()
19598     *
19599     * @ingroup Genlist
19600     */
19601    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19602    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19603
19604    /**
19605     * Set the always select mode.
19606     *
19607     * @param obj The genlist object
19608     * @param always_select The always select mode (@c EINA_TRUE = on, @c
19609     * EINA_FALSE = off). Default is @c EINA_FALSE.
19610     *
19611     * Items will only call their selection func and callback when first
19612     * becoming selected. Any further clicks will do nothing, unless you
19613     * enable always select with elm_genlist_always_select_mode_set().
19614     * This means that, even if selected, every click will make the selected
19615     * callbacks be called.
19616     *
19617     * @see elm_genlist_always_select_mode_get()
19618     *
19619     * @ingroup Genlist
19620     */
19621    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
19622
19623    /**
19624     * Get the always select mode.
19625     *
19626     * @param obj The genlist object
19627     * @return The always select mode
19628     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19629     *
19630     * @see elm_genlist_always_select_mode_set()
19631     *
19632     * @ingroup Genlist
19633     */
19634    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19635
19636    /**
19637     * Enable/disable the no select mode.
19638     *
19639     * @param obj The genlist object
19640     * @param no_select The no select mode
19641     * (EINA_TRUE = on, EINA_FALSE = off)
19642     *
19643     * This will turn off the ability to select items entirely and they
19644     * will neither appear selected nor call selected callback functions.
19645     *
19646     * @see elm_genlist_no_select_mode_get()
19647     *
19648     * @ingroup Genlist
19649     */
19650    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
19651
19652    /**
19653     * Gets whether the no select mode is enabled.
19654     *
19655     * @param obj The genlist object
19656     * @return The no select mode
19657     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19658     *
19659     * @see elm_genlist_no_select_mode_set()
19660     *
19661     * @ingroup Genlist
19662     */
19663    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19664
19665    /**
19666     * Enable/disable compress mode.
19667     *
19668     * @param obj The genlist object
19669     * @param compress The compress mode
19670     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
19671     *
19672     * This will enable the compress mode where items are "compressed"
19673     * horizontally to fit the genlist scrollable viewport width. This is
19674     * special for genlist.  Do not rely on
19675     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
19676     * work as genlist needs to handle it specially.
19677     *
19678     * @see elm_genlist_compress_mode_get()
19679     *
19680     * @ingroup Genlist
19681     */
19682    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
19683
19684    /**
19685     * Get whether the compress mode is enabled.
19686     *
19687     * @param obj The genlist object
19688     * @return The compress mode
19689     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
19690     *
19691     * @see elm_genlist_compress_mode_set()
19692     *
19693     * @ingroup Genlist
19694     */
19695    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19696
19697    /**
19698     * Enable/disable height-for-width mode.
19699     *
19700     * @param obj The genlist object
19701     * @param setting The height-for-width mode (@c EINA_TRUE = on,
19702     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
19703     *
19704     * With height-for-width mode the item width will be fixed (restricted
19705     * to a minimum of) to the list width when calculating its size in
19706     * order to allow the height to be calculated based on it. This allows,
19707     * for instance, text block to wrap lines if the Edje part is
19708     * configured with "text.min: 0 1".
19709     *
19710     * @note This mode will make list resize slower as it will have to
19711     *       recalculate every item height again whenever the list width
19712     *       changes!
19713     *
19714     * @note When height-for-width mode is enabled, it also enables
19715     *       compress mode (see elm_genlist_compress_mode_set()) and
19716     *       disables homogeneous (see elm_genlist_homogeneous_set()).
19717     *
19718     * @ingroup Genlist
19719     */
19720    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
19721
19722    /**
19723     * Get whether the height-for-width mode is enabled.
19724     *
19725     * @param obj The genlist object
19726     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
19727     * off)
19728     *
19729     * @ingroup Genlist
19730     */
19731    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19732
19733    /**
19734     * Enable/disable horizontal and vertical bouncing effect.
19735     *
19736     * @param obj The genlist object
19737     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
19738     * EINA_FALSE = off). Default is @c EINA_FALSE.
19739     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
19740     * EINA_FALSE = off). Default is @c EINA_TRUE.
19741     *
19742     * This will enable or disable the scroller bouncing effect for the
19743     * genlist. See elm_scroller_bounce_set() for details.
19744     *
19745     * @see elm_scroller_bounce_set()
19746     * @see elm_genlist_bounce_get()
19747     *
19748     * @ingroup Genlist
19749     */
19750    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
19751
19752    /**
19753     * Get whether the horizontal and vertical bouncing effect is enabled.
19754     *
19755     * @param obj The genlist object
19756     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
19757     * option is set.
19758     * @param v_bounce Pointer to a bool to receive if the bounce vertically
19759     * option is set.
19760     *
19761     * @see elm_genlist_bounce_set()
19762     *
19763     * @ingroup Genlist
19764     */
19765    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
19766
19767    /**
19768     * Enable/disable homogeneous mode.
19769     *
19770     * @param obj The genlist object
19771     * @param homogeneous Assume the items within the genlist are of the
19772     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
19773     * EINA_FALSE.
19774     *
19775     * This will enable the homogeneous mode where items are of the same
19776     * height and width so that genlist may do the lazy-loading at its
19777     * maximum (which increases the performance for scrolling the list). This
19778     * implies 'compressed' mode.
19779     *
19780     * @see elm_genlist_compress_mode_set()
19781     * @see elm_genlist_homogeneous_get()
19782     *
19783     * @ingroup Genlist
19784     */
19785    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
19786
19787    /**
19788     * Get whether the homogeneous mode is enabled.
19789     *
19790     * @param obj The genlist object
19791     * @return Assume the items within the genlist are of the same height
19792     * and width (EINA_TRUE = on, EINA_FALSE = off)
19793     *
19794     * @see elm_genlist_homogeneous_set()
19795     *
19796     * @ingroup Genlist
19797     */
19798    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19799
19800    /**
19801     * Set the maximum number of items within an item block
19802     *
19803     * @param obj The genlist object
19804     * @param n   Maximum number of items within an item block. Default is 32.
19805     *
19806     * This will configure the block count to tune to the target with
19807     * particular performance matrix.
19808     *
19809     * A block of objects will be used to reduce the number of operations due to
19810     * many objects in the screen. It can determine the visibility, or if the
19811     * object has changed, it theme needs to be updated, etc. doing this kind of
19812     * calculation to the entire block, instead of per object.
19813     *
19814     * The default value for the block count is enough for most lists, so unless
19815     * you know you will have a lot of objects visible in the screen at the same
19816     * time, don't try to change this.
19817     *
19818     * @see elm_genlist_block_count_get()
19819     * @see @ref Genlist_Implementation
19820     *
19821     * @ingroup Genlist
19822     */
19823    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
19824
19825    /**
19826     * Get the maximum number of items within an item block
19827     *
19828     * @param obj The genlist object
19829     * @return Maximum number of items within an item block
19830     *
19831     * @see elm_genlist_block_count_set()
19832     *
19833     * @ingroup Genlist
19834     */
19835    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19836
19837    /**
19838     * Set the timeout in seconds for the longpress event.
19839     *
19840     * @param obj The genlist object
19841     * @param timeout timeout in seconds. Default is 1.
19842     *
19843     * This option will change how long it takes to send an event "longpressed"
19844     * after the mouse down signal is sent to the list. If this event occurs, no
19845     * "clicked" event will be sent.
19846     *
19847     * @see elm_genlist_longpress_timeout_set()
19848     *
19849     * @ingroup Genlist
19850     */
19851    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19852
19853    /**
19854     * Get the timeout in seconds for the longpress event.
19855     *
19856     * @param obj The genlist object
19857     * @return timeout in seconds
19858     *
19859     * @see elm_genlist_longpress_timeout_get()
19860     *
19861     * @ingroup Genlist
19862     */
19863    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19864
19865    /**
19866     * Append a new item in a given genlist widget.
19867     *
19868     * @param obj The genlist object
19869     * @param itc The item class for the item
19870     * @param data The item data
19871     * @param parent The parent item, or NULL if none
19872     * @param flags Item flags
19873     * @param func Convenience function called when the item is selected
19874     * @param func_data Data passed to @p func above.
19875     * @return A handle to the item added or @c NULL if not possible
19876     *
19877     * This adds the given item to the end of the list or the end of
19878     * the children list if the @p parent is given.
19879     *
19880     * @see elm_genlist_item_prepend()
19881     * @see elm_genlist_item_insert_before()
19882     * @see elm_genlist_item_insert_after()
19883     * @see elm_genlist_item_del()
19884     *
19885     * @ingroup Genlist
19886     */
19887    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);
19888
19889    /**
19890     * Prepend a new item in a given genlist widget.
19891     *
19892     * @param obj The genlist object
19893     * @param itc The item class for the item
19894     * @param data The item data
19895     * @param parent The parent item, or NULL if none
19896     * @param flags Item flags
19897     * @param func Convenience function called when the item is selected
19898     * @param func_data Data passed to @p func above.
19899     * @return A handle to the item added or NULL if not possible
19900     *
19901     * This adds an item to the beginning of the list or beginning of the
19902     * children of the parent if given.
19903     *
19904     * @see elm_genlist_item_append()
19905     * @see elm_genlist_item_insert_before()
19906     * @see elm_genlist_item_insert_after()
19907     * @see elm_genlist_item_del()
19908     *
19909     * @ingroup Genlist
19910     */
19911    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);
19912
19913    /**
19914     * Insert an item before another in a genlist widget
19915     *
19916     * @param obj The genlist object
19917     * @param itc The item class for the item
19918     * @param data The item data
19919     * @param before The item to place this new one before.
19920     * @param flags Item flags
19921     * @param func Convenience function called when the item is selected
19922     * @param func_data Data passed to @p func above.
19923     * @return A handle to the item added or @c NULL if not possible
19924     *
19925     * This inserts an item before another in the list. It will be in the
19926     * same tree level or group as the item it is inserted before.
19927     *
19928     * @see elm_genlist_item_append()
19929     * @see elm_genlist_item_prepend()
19930     * @see elm_genlist_item_insert_after()
19931     * @see elm_genlist_item_del()
19932     *
19933     * @ingroup Genlist
19934     */
19935    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);
19936
19937    /**
19938     * Insert an item after another in a genlist widget
19939     *
19940     * @param obj The genlist object
19941     * @param itc The item class for the item
19942     * @param data The item data
19943     * @param after The item to place this new one after.
19944     * @param flags Item flags
19945     * @param func Convenience function called when the item is selected
19946     * @param func_data Data passed to @p func above.
19947     * @return A handle to the item added or @c NULL if not possible
19948     *
19949     * This inserts an item after another in the list. It will be in the
19950     * same tree level or group as the item it is inserted after.
19951     *
19952     * @see elm_genlist_item_append()
19953     * @see elm_genlist_item_prepend()
19954     * @see elm_genlist_item_insert_before()
19955     * @see elm_genlist_item_del()
19956     *
19957     * @ingroup Genlist
19958     */
19959    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);
19960
19961    /**
19962     * Insert a new item into the sorted genlist object
19963     *
19964     * @param obj The genlist object
19965     * @param itc The item class for the item
19966     * @param data The item data
19967     * @param parent The parent item, or NULL if none
19968     * @param flags Item flags
19969     * @param comp The function called for the sort
19970     * @param func Convenience function called when item selected
19971     * @param func_data Data passed to @p func above.
19972     * @return A handle to the item added or NULL if not possible
19973     *
19974     * @ingroup Genlist
19975     */
19976    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);
19977    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);
19978
19979    /* operations to retrieve existing items */
19980    /**
19981     * Get the selectd item in the genlist.
19982     *
19983     * @param obj The genlist object
19984     * @return The selected item, or NULL if none is selected.
19985     *
19986     * This gets the selected item in the list (if multi-selection is enabled, only
19987     * the item that was first selected in the list is returned - which is not very
19988     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19989     * used).
19990     *
19991     * If no item is selected, NULL is returned.
19992     *
19993     * @see elm_genlist_selected_items_get()
19994     *
19995     * @ingroup Genlist
19996     */
19997    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19998
19999    /**
20000     * Get a list of selected items in the genlist.
20001     *
20002     * @param obj The genlist object
20003     * @return The list of selected items, or NULL if none are selected.
20004     *
20005     * It returns a list of the selected items. This list pointer is only valid so
20006     * long as the selection doesn't change (no items are selected or unselected, or
20007     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
20008     * pointers. The order of the items in this list is the order which they were
20009     * selected, i.e. the first item in this list is the first item that was
20010     * selected, and so on.
20011     *
20012     * @note If not in multi-select mode, consider using function
20013     * elm_genlist_selected_item_get() instead.
20014     *
20015     * @see elm_genlist_multi_select_set()
20016     * @see elm_genlist_selected_item_get()
20017     *
20018     * @ingroup Genlist
20019     */
20020    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20021
20022    /**
20023     * Get the mode item style of items in the genlist
20024     * @param obj The genlist object
20025     * @return The mode item style string, or NULL if none is specified
20026     *
20027     * This is a constant string and simply defines the name of the
20028     * style that will be used for mode animations. It can be
20029     * @c NULL if you don't plan to use Genlist mode. See
20030     * elm_genlist_item_mode_set() for more info.
20031     *
20032     * @ingroup Genlist
20033     */
20034    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20035
20036    /**
20037     * Set the mode item style of items in the genlist
20038     * @param obj The genlist object
20039     * @param style The mode item style string, or NULL if none is desired
20040     *
20041     * This is a constant string and simply defines the name of the
20042     * style that will be used for mode animations. It can be
20043     * @c NULL if you don't plan to use Genlist mode. See
20044     * elm_genlist_item_mode_set() for more info.
20045     *
20046     * @ingroup Genlist
20047     */
20048    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
20049
20050    /**
20051     * Get a list of realized items in genlist
20052     *
20053     * @param obj The genlist object
20054     * @return The list of realized items, nor NULL if none are realized.
20055     *
20056     * This returns a list of the realized items in the genlist. The list
20057     * contains Elm_Genlist_Item pointers. The list must be freed by the
20058     * caller when done with eina_list_free(). The item pointers in the
20059     * list are only valid so long as those items are not deleted or the
20060     * genlist is not deleted.
20061     *
20062     * @see elm_genlist_realized_items_update()
20063     *
20064     * @ingroup Genlist
20065     */
20066    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20067
20068    /**
20069     * Get the item that is at the x, y canvas coords.
20070     *
20071     * @param obj The gelinst object.
20072     * @param x The input x coordinate
20073     * @param y The input y coordinate
20074     * @param posret The position relative to the item returned here
20075     * @return The item at the coordinates or NULL if none
20076     *
20077     * This returns the item at the given coordinates (which are canvas
20078     * relative, not object-relative). If an item is at that coordinate,
20079     * that item handle is returned, and if @p posret is not NULL, the
20080     * integer pointed to is set to a value of -1, 0 or 1, depending if
20081     * the coordinate is on the upper portion of that item (-1), on the
20082     * middle section (0) or on the lower part (1). If NULL is returned as
20083     * an item (no item found there), then posret may indicate -1 or 1
20084     * based if the coordinate is above or below all items respectively in
20085     * the genlist.
20086     *
20087     * @ingroup Genlist
20088     */
20089    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);
20090
20091    /**
20092     * Get the first item in the genlist
20093     *
20094     * This returns the first item in the list.
20095     *
20096     * @param obj The genlist object
20097     * @return The first item, or NULL if none
20098     *
20099     * @ingroup Genlist
20100     */
20101    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20102
20103    /**
20104     * Get the last item in the genlist
20105     *
20106     * This returns the last item in the list.
20107     *
20108     * @return The last item, or NULL if none
20109     *
20110     * @ingroup Genlist
20111     */
20112    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20113
20114    /**
20115     * Set the scrollbar policy
20116     *
20117     * @param obj The genlist object
20118     * @param policy_h Horizontal scrollbar policy.
20119     * @param policy_v Vertical scrollbar policy.
20120     *
20121     * This sets the scrollbar visibility policy for the given genlist
20122     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
20123     * made visible if it is needed, and otherwise kept hidden.
20124     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
20125     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
20126     * respectively for the horizontal and vertical scrollbars. Default is
20127     * #ELM_SMART_SCROLLER_POLICY_AUTO
20128     *
20129     * @see elm_genlist_scroller_policy_get()
20130     *
20131     * @ingroup Genlist
20132     */
20133    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
20134
20135    /**
20136     * Get the scrollbar policy
20137     *
20138     * @param obj The genlist object
20139     * @param policy_h Pointer to store the horizontal scrollbar policy.
20140     * @param policy_v Pointer to store the vertical scrollbar policy.
20141     *
20142     * @see elm_genlist_scroller_policy_set()
20143     *
20144     * @ingroup Genlist
20145     */
20146    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);
20147
20148    /**
20149     * Get the @b next item in a genlist widget's internal list of items,
20150     * given a handle to one of those items.
20151     *
20152     * @param item The genlist item to fetch next from
20153     * @return The item after @p item, or @c NULL if there's none (and
20154     * on errors)
20155     *
20156     * This returns the item placed after the @p item, on the container
20157     * genlist.
20158     *
20159     * @see elm_genlist_item_prev_get()
20160     *
20161     * @ingroup Genlist
20162     */
20163    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20164
20165    /**
20166     * Get the @b previous item in a genlist widget's internal list of items,
20167     * given a handle to one of those items.
20168     *
20169     * @param item The genlist item to fetch previous from
20170     * @return The item before @p item, or @c NULL if there's none (and
20171     * on errors)
20172     *
20173     * This returns the item placed before the @p item, on the container
20174     * genlist.
20175     *
20176     * @see elm_genlist_item_next_get()
20177     *
20178     * @ingroup Genlist
20179     */
20180    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20181
20182    /**
20183     * Get the genlist object's handle which contains a given genlist
20184     * item
20185     *
20186     * @param item The item to fetch the container from
20187     * @return The genlist (parent) object
20188     *
20189     * This returns the genlist object itself that an item belongs to.
20190     *
20191     * @ingroup Genlist
20192     */
20193    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20194
20195    /**
20196     * Get the parent item of the given item
20197     *
20198     * @param it The item
20199     * @return The parent of the item or @c NULL if it has no parent.
20200     *
20201     * This returns the item that was specified as parent of the item @p it on
20202     * elm_genlist_item_append() and insertion related functions.
20203     *
20204     * @ingroup Genlist
20205     */
20206    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20207
20208    /**
20209     * Remove all sub-items (children) of the given item
20210     *
20211     * @param it The item
20212     *
20213     * This removes all items that are children (and their descendants) of the
20214     * given item @p it.
20215     *
20216     * @see elm_genlist_clear()
20217     * @see elm_genlist_item_del()
20218     *
20219     * @ingroup Genlist
20220     */
20221    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20222
20223    /**
20224     * Set whether a given genlist item is selected or not
20225     *
20226     * @param it The item
20227     * @param selected Use @c EINA_TRUE, to make it selected, @c
20228     * EINA_FALSE to make it unselected
20229     *
20230     * This sets the selected state of an item. If multi selection is
20231     * not enabled on the containing genlist and @p selected is @c
20232     * EINA_TRUE, any other previously selected items will get
20233     * unselected in favor of this new one.
20234     *
20235     * @see elm_genlist_item_selected_get()
20236     *
20237     * @ingroup Genlist
20238     */
20239    EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
20240
20241    /**
20242     * Get whether a given genlist item is selected or not
20243     *
20244     * @param it The item
20245     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
20246     *
20247     * @see elm_genlist_item_selected_set() for more details
20248     *
20249     * @ingroup Genlist
20250     */
20251    EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20252
20253    /**
20254     * Sets the expanded state of an item.
20255     *
20256     * @param it The item
20257     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
20258     *
20259     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
20260     * expanded or not.
20261     *
20262     * The theme will respond to this change visually, and a signal "expanded" or
20263     * "contracted" will be sent from the genlist with a pointer to the item that
20264     * has been expanded/contracted.
20265     *
20266     * Calling this function won't show or hide any child of this item (if it is
20267     * a parent). You must manually delete and create them on the callbacks fo
20268     * the "expanded" or "contracted" signals.
20269     *
20270     * @see elm_genlist_item_expanded_get()
20271     *
20272     * @ingroup Genlist
20273     */
20274    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
20275
20276    /**
20277     * Get the expanded state of an item
20278     *
20279     * @param it The item
20280     * @return The expanded state
20281     *
20282     * This gets the expanded state of an item.
20283     *
20284     * @see elm_genlist_item_expanded_set()
20285     *
20286     * @ingroup Genlist
20287     */
20288    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20289
20290    /**
20291     * Get the depth of expanded item
20292     *
20293     * @param it The genlist item object
20294     * @return The depth of expanded item
20295     *
20296     * @ingroup Genlist
20297     */
20298    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20299
20300    /**
20301     * Set whether a given genlist item is disabled or not.
20302     *
20303     * @param it The item
20304     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
20305     * to enable it back.
20306     *
20307     * A disabled item cannot be selected or unselected. It will also
20308     * change its appearance, to signal the user it's disabled.
20309     *
20310     * @see elm_genlist_item_disabled_get()
20311     *
20312     * @ingroup Genlist
20313     */
20314    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20315
20316    /**
20317     * Get whether a given genlist item is disabled or not.
20318     *
20319     * @param it The item
20320     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
20321     * (and on errors).
20322     *
20323     * @see elm_genlist_item_disabled_set() for more details
20324     *
20325     * @ingroup Genlist
20326     */
20327    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20328
20329    /**
20330     * Sets the display only state of an item.
20331     *
20332     * @param it The item
20333     * @param display_only @c EINA_TRUE if the item is display only, @c
20334     * EINA_FALSE otherwise.
20335     *
20336     * A display only item cannot be selected or unselected. It is for
20337     * display only and not selecting or otherwise clicking, dragging
20338     * etc. by the user, thus finger size rules will not be applied to
20339     * this item.
20340     *
20341     * It's good to set group index items to display only state.
20342     *
20343     * @see elm_genlist_item_display_only_get()
20344     *
20345     * @ingroup Genlist
20346     */
20347    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
20348
20349    /**
20350     * Get the display only state of an item
20351     *
20352     * @param it The item
20353     * @return @c EINA_TRUE if the item is display only, @c
20354     * EINA_FALSE otherwise.
20355     *
20356     * @see elm_genlist_item_display_only_set()
20357     *
20358     * @ingroup Genlist
20359     */
20360    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20361
20362    /**
20363     * Show the portion of a genlist's internal list containing a given
20364     * item, immediately.
20365     *
20366     * @param it The item to display
20367     *
20368     * This causes genlist to jump to the given item @p it and show it (by
20369     * immediately scrolling to that position), if it is not fully visible.
20370     *
20371     * @see elm_genlist_item_bring_in()
20372     * @see elm_genlist_item_top_show()
20373     * @see elm_genlist_item_middle_show()
20374     *
20375     * @ingroup Genlist
20376     */
20377    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20378
20379    /**
20380     * Animatedly bring in, to the visible are of a genlist, a given
20381     * item on it.
20382     *
20383     * @param it The item to display
20384     *
20385     * This causes genlist to jump to the given item @p it and show it (by
20386     * animatedly scrolling), if it is not fully visible. This may use animation
20387     * to do so and take a period of time
20388     *
20389     * @see elm_genlist_item_show()
20390     * @see elm_genlist_item_top_bring_in()
20391     * @see elm_genlist_item_middle_bring_in()
20392     *
20393     * @ingroup Genlist
20394     */
20395    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20396
20397    /**
20398     * Show the portion of a genlist's internal list containing a given
20399     * item, immediately.
20400     *
20401     * @param it The item to display
20402     *
20403     * This causes genlist to jump to the given item @p it and show it (by
20404     * immediately scrolling to that position), if it is not fully visible.
20405     *
20406     * The item will be positioned at the top of the genlist viewport.
20407     *
20408     * @see elm_genlist_item_show()
20409     * @see elm_genlist_item_top_bring_in()
20410     *
20411     * @ingroup Genlist
20412     */
20413    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20414
20415    /**
20416     * Animatedly bring in, to the visible are of a genlist, a given
20417     * item on it.
20418     *
20419     * @param it The item
20420     *
20421     * This causes genlist to jump to the given item @p it and show it (by
20422     * animatedly scrolling), if it is not fully visible. This may use animation
20423     * to do so and take a period of time
20424     *
20425     * The item will be positioned at the top of the genlist viewport.
20426     *
20427     * @see elm_genlist_item_bring_in()
20428     * @see elm_genlist_item_top_show()
20429     *
20430     * @ingroup Genlist
20431     */
20432    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20433
20434    /**
20435     * Show the portion of a genlist's internal list containing a given
20436     * item, immediately.
20437     *
20438     * @param it The item to display
20439     *
20440     * This causes genlist to jump to the given item @p it and show it (by
20441     * immediately scrolling to that position), if it is not fully visible.
20442     *
20443     * The item will be positioned at the middle of the genlist viewport.
20444     *
20445     * @see elm_genlist_item_show()
20446     * @see elm_genlist_item_middle_bring_in()
20447     *
20448     * @ingroup Genlist
20449     */
20450    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20451
20452    /**
20453     * Animatedly bring in, to the visible are of a genlist, a given
20454     * item on it.
20455     *
20456     * @param it The item
20457     *
20458     * This causes genlist to jump to the given item @p it and show it (by
20459     * animatedly scrolling), if it is not fully visible. This may use animation
20460     * to do so and take a period of time
20461     *
20462     * The item will be positioned at the middle of the genlist viewport.
20463     *
20464     * @see elm_genlist_item_bring_in()
20465     * @see elm_genlist_item_middle_show()
20466     *
20467     * @ingroup Genlist
20468     */
20469    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20470
20471    /**
20472     * Remove a genlist item from the its parent, deleting it.
20473     *
20474     * @param item The item to be removed.
20475     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
20476     *
20477     * @see elm_genlist_clear(), to remove all items in a genlist at
20478     * once.
20479     *
20480     * @ingroup Genlist
20481     */
20482    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20483
20484    /**
20485     * Return the data associated to a given genlist item
20486     *
20487     * @param item The genlist item.
20488     * @return the data associated to this item.
20489     *
20490     * This returns the @c data value passed on the
20491     * elm_genlist_item_append() and related item addition calls.
20492     *
20493     * @see elm_genlist_item_append()
20494     * @see elm_genlist_item_data_set()
20495     *
20496     * @ingroup Genlist
20497     */
20498    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20499
20500    /**
20501     * Set the data associated to a given genlist item
20502     *
20503     * @param item The genlist item
20504     * @param data The new data pointer to set on it
20505     *
20506     * This @b overrides the @c data value passed on the
20507     * elm_genlist_item_append() and related item addition calls. This
20508     * function @b won't call elm_genlist_item_update() automatically,
20509     * so you'd issue it afterwards if you want to hove the item
20510     * updated to reflect the that new data.
20511     *
20512     * @see elm_genlist_item_data_get()
20513     *
20514     * @ingroup Genlist
20515     */
20516    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
20517
20518    /**
20519     * Tells genlist to "orphan" contents fetchs by the item class
20520     *
20521     * @param it The item
20522     *
20523     * This instructs genlist to release references to contents in the item,
20524     * meaning that they will no longer be managed by genlist and are
20525     * floating "orphans" that can be re-used elsewhere if the user wants
20526     * to.
20527     *
20528     * @ingroup Genlist
20529     */
20530    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20531    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20532
20533    /**
20534     * Get the real Evas object created to implement the view of a
20535     * given genlist item
20536     *
20537     * @param item The genlist item.
20538     * @return the Evas object implementing this item's view.
20539     *
20540     * This returns the actual Evas object used to implement the
20541     * specified genlist item's view. This may be @c NULL, as it may
20542     * not have been created or may have been deleted, at any time, by
20543     * the genlist. <b>Do not modify this object</b> (move, resize,
20544     * show, hide, etc.), as the genlist is controlling it. This
20545     * function is for querying, emitting custom signals or hooking
20546     * lower level callbacks for events on that object. Do not delete
20547     * this object under any circumstances.
20548     *
20549     * @see elm_genlist_item_data_get()
20550     *
20551     * @ingroup Genlist
20552     */
20553    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20554
20555    /**
20556     * Update the contents of an item
20557     *
20558     * @param it The item
20559     *
20560     * This updates an item by calling all the item class functions again
20561     * to get the contents, texts and states. Use this when the original
20562     * item data has changed and the changes are desired to be reflected.
20563     *
20564     * Use elm_genlist_realized_items_update() to update all already realized
20565     * items.
20566     *
20567     * @see elm_genlist_realized_items_update()
20568     *
20569     * @ingroup Genlist
20570     */
20571    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20572
20573    /**
20574     * Promote an item to the top of the list
20575     *
20576     * @param it The item
20577     *
20578     * @ingroup Genlist
20579     */
20580    EAPI void               elm_genlist_item_promote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20581
20582    /**
20583     * Demote an item to the end of the list
20584     *
20585     * @param it The item
20586     *
20587     * @ingroup Genlist
20588     */
20589    EAPI void               elm_genlist_item_demote(Elm_Gen_Item *it) EINA_ARG_NONNULL(1);
20590
20591    /**
20592     * Update the part of an item
20593     *
20594     * @param it The item
20595     * @param parts The name of item's part
20596     * @param itf The flags of item's part type
20597     *
20598     * This updates an item's part by calling item's fetching functions again
20599     * to get the contents, texts and states. Use this when the original
20600     * item data has changed and the changes are desired to be reflected.
20601     * Second parts argument is used for globbing to match '*', '?', and '.'
20602     * It can be used at updating multi fields.
20603     *
20604     * Use elm_genlist_realized_items_update() to update an item's all
20605     * property.
20606     *
20607     * @see elm_genlist_item_update()
20608     *
20609     * @ingroup Genlist
20610     */
20611    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
20612
20613    /**
20614     * Update the item class of an item
20615     *
20616     * @param it The item
20617     * @param itc The item class for the item
20618     *
20619     * This sets another class fo the item, changing the way that it is
20620     * displayed. After changing the item class, elm_genlist_item_update() is
20621     * called on the item @p it.
20622     *
20623     * @ingroup Genlist
20624     */
20625    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
20626    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
20627
20628    /**
20629     * Set the text to be shown in a given genlist item's tooltips.
20630     *
20631     * @param item The genlist item
20632     * @param text The text to set in the content
20633     *
20634     * This call will setup the text to be used as tooltip to that item
20635     * (analogous to elm_object_tooltip_text_set(), but being item
20636     * tooltips with higher precedence than object tooltips). It can
20637     * have only one tooltip at a time, so any previous tooltip data
20638     * will get removed.
20639     *
20640     * In order to set a content or something else as a tooltip, look at
20641     * elm_genlist_item_tooltip_content_cb_set().
20642     *
20643     * @ingroup Genlist
20644     */
20645    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
20646
20647    /**
20648     * Set the content to be shown in a given genlist item's tooltips
20649     *
20650     * @param item The genlist item.
20651     * @param func The function returning the tooltip contents.
20652     * @param data What to provide to @a func as callback data/context.
20653     * @param del_cb Called when data is not needed anymore, either when
20654     *        another callback replaces @p func, the tooltip is unset with
20655     *        elm_genlist_item_tooltip_unset() or the owner @p item
20656     *        dies. This callback receives as its first parameter the
20657     *        given @p data, being @c event_info the item handle.
20658     *
20659     * This call will setup the tooltip's contents to @p item
20660     * (analogous to elm_object_tooltip_content_cb_set(), but being
20661     * item tooltips with higher precedence than object tooltips). It
20662     * can have only one tooltip at a time, so any previous tooltip
20663     * content will get removed. @p func (with @p data) will be called
20664     * every time Elementary needs to show the tooltip and it should
20665     * return a valid Evas object, which will be fully managed by the
20666     * tooltip system, getting deleted when the tooltip is gone.
20667     *
20668     * In order to set just a text as a tooltip, look at
20669     * elm_genlist_item_tooltip_text_set().
20670     *
20671     * @ingroup Genlist
20672     */
20673    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);
20674
20675    /**
20676     * Unset a tooltip from a given genlist item
20677     *
20678     * @param item genlist item to remove a previously set tooltip from.
20679     *
20680     * This call removes any tooltip set on @p item. The callback
20681     * provided as @c del_cb to
20682     * elm_genlist_item_tooltip_content_cb_set() will be called to
20683     * notify it is not used anymore (and have resources cleaned, if
20684     * need be).
20685     *
20686     * @see elm_genlist_item_tooltip_content_cb_set()
20687     *
20688     * @ingroup Genlist
20689     */
20690    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20691
20692    /**
20693     * Set a different @b style for a given genlist item's tooltip.
20694     *
20695     * @param item genlist item with tooltip set
20696     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
20697     * "default", @c "transparent", etc)
20698     *
20699     * Tooltips can have <b>alternate styles</b> to be displayed on,
20700     * which are defined by the theme set on Elementary. This function
20701     * works analogously as elm_object_tooltip_style_set(), but here
20702     * applied only to genlist item objects. The default style for
20703     * tooltips is @c "default".
20704     *
20705     * @note before you set a style you should define a tooltip with
20706     *       elm_genlist_item_tooltip_content_cb_set() or
20707     *       elm_genlist_item_tooltip_text_set()
20708     *
20709     * @see elm_genlist_item_tooltip_style_get()
20710     *
20711     * @ingroup Genlist
20712     */
20713    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20714
20715    /**
20716     * Get the style set a given genlist item's tooltip.
20717     *
20718     * @param item genlist item with tooltip already set on.
20719     * @return style the theme style in use, which defaults to
20720     *         "default". If the object does not have a tooltip set,
20721     *         then @c NULL is returned.
20722     *
20723     * @see elm_genlist_item_tooltip_style_set() for more details
20724     *
20725     * @ingroup Genlist
20726     */
20727    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20728
20729    /**
20730     * @brief Disable size restrictions on an object's tooltip
20731     * @param item The tooltip's anchor object
20732     * @param disable If EINA_TRUE, size restrictions are disabled
20733     * @return EINA_FALSE on failure, EINA_TRUE on success
20734     *
20735     * This function allows a tooltip to expand beyond its parant window's canvas.
20736     * It will instead be limited only by the size of the display.
20737     */
20738    EAPI Eina_Bool          elm_genlist_item_tooltip_window_mode_set(Elm_Genlist_Item *item, Eina_Bool disable);
20739
20740    /**
20741     * @brief Retrieve size restriction state of an object's tooltip
20742     * @param item The tooltip's anchor object
20743     * @return If EINA_TRUE, size restrictions are disabled
20744     *
20745     * This function returns whether a tooltip is allowed to expand beyond
20746     * its parant window's canvas.
20747     * It will instead be limited only by the size of the display.
20748     */
20749    EAPI Eina_Bool          elm_genlist_item_tooltip_window_mode_get(const Elm_Genlist_Item *item);
20750
20751    /**
20752     * Set the type of mouse pointer/cursor decoration to be shown,
20753     * when the mouse pointer is over the given genlist widget item
20754     *
20755     * @param item genlist item to customize cursor on
20756     * @param cursor the cursor type's name
20757     *
20758     * This function works analogously as elm_object_cursor_set(), but
20759     * here the cursor's changing area is restricted to the item's
20760     * area, and not the whole widget's. Note that that item cursors
20761     * have precedence over widget cursors, so that a mouse over @p
20762     * item will always show cursor @p type.
20763     *
20764     * If this function is called twice for an object, a previously set
20765     * cursor will be unset on the second call.
20766     *
20767     * @see elm_object_cursor_set()
20768     * @see elm_genlist_item_cursor_get()
20769     * @see elm_genlist_item_cursor_unset()
20770     *
20771     * @ingroup Genlist
20772     */
20773    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
20774
20775    /**
20776     * Get the type of mouse pointer/cursor decoration set to be shown,
20777     * when the mouse pointer is over the given genlist widget item
20778     *
20779     * @param item genlist item with custom cursor set
20780     * @return the cursor type's name or @c NULL, if no custom cursors
20781     * were set to @p item (and on errors)
20782     *
20783     * @see elm_object_cursor_get()
20784     * @see elm_genlist_item_cursor_set() for more details
20785     * @see elm_genlist_item_cursor_unset()
20786     *
20787     * @ingroup Genlist
20788     */
20789    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20790
20791    /**
20792     * Unset any custom mouse pointer/cursor decoration set to be
20793     * shown, when the mouse pointer is over the given genlist widget
20794     * item, thus making it show the @b default cursor again.
20795     *
20796     * @param item a genlist item
20797     *
20798     * Use this call to undo any custom settings on this item's cursor
20799     * decoration, bringing it back to defaults (no custom style set).
20800     *
20801     * @see elm_object_cursor_unset()
20802     * @see elm_genlist_item_cursor_set() for more details
20803     *
20804     * @ingroup Genlist
20805     */
20806    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20807
20808    /**
20809     * Set a different @b style for a given custom cursor set for a
20810     * genlist item.
20811     *
20812     * @param item genlist item with custom cursor set
20813     * @param style the <b>theme style</b> to use (e.g. @c "default",
20814     * @c "transparent", etc)
20815     *
20816     * This function only makes sense when one is using custom mouse
20817     * cursor decorations <b>defined in a theme file</b> , which can
20818     * have, given a cursor name/type, <b>alternate styles</b> on
20819     * it. It works analogously as elm_object_cursor_style_set(), but
20820     * here applied only to genlist item objects.
20821     *
20822     * @warning Before you set a cursor style you should have defined a
20823     *       custom cursor previously on the item, with
20824     *       elm_genlist_item_cursor_set()
20825     *
20826     * @see elm_genlist_item_cursor_engine_only_set()
20827     * @see elm_genlist_item_cursor_style_get()
20828     *
20829     * @ingroup Genlist
20830     */
20831    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
20832
20833    /**
20834     * Get the current @b style set for a given genlist item's custom
20835     * cursor
20836     *
20837     * @param item genlist item with custom cursor set.
20838     * @return style the cursor style in use. If the object does not
20839     *         have a cursor set, then @c NULL is returned.
20840     *
20841     * @see elm_genlist_item_cursor_style_set() for more details
20842     *
20843     * @ingroup Genlist
20844     */
20845    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20846
20847    /**
20848     * Set if the (custom) cursor for a given genlist item should be
20849     * searched in its theme, also, or should only rely on the
20850     * rendering engine.
20851     *
20852     * @param item item with custom (custom) cursor already set on
20853     * @param engine_only Use @c EINA_TRUE to have cursors looked for
20854     * only on those provided by the rendering engine, @c EINA_FALSE to
20855     * have them searched on the widget's theme, as well.
20856     *
20857     * @note This call is of use only if you've set a custom cursor
20858     * for genlist items, with elm_genlist_item_cursor_set().
20859     *
20860     * @note By default, cursors will only be looked for between those
20861     * provided by the rendering engine.
20862     *
20863     * @ingroup Genlist
20864     */
20865    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
20866
20867    /**
20868     * Get if the (custom) cursor for a given genlist item is being
20869     * searched in its theme, also, or is only relying on the rendering
20870     * engine.
20871     *
20872     * @param item a genlist item
20873     * @return @c EINA_TRUE, if cursors are being looked for only on
20874     * those provided by the rendering engine, @c EINA_FALSE if they
20875     * are being searched on the widget's theme, as well.
20876     *
20877     * @see elm_genlist_item_cursor_engine_only_set(), for more details
20878     *
20879     * @ingroup Genlist
20880     */
20881    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
20882
20883    /**
20884     * Get the index of the item. It is only valid once displayed.
20885     *
20886     * @param item a genlist item
20887     * @return the position inside the list of item.
20888     *
20889     * @ingroup Genlist
20890     */
20891    EAPI int elm_genlist_item_index_get(Elm_Gen_Item *it);
20892
20893    /**
20894     * Update the contents of all realized items.
20895     *
20896     * @param obj The genlist object.
20897     *
20898     * This updates all realized items by calling all the item class functions again
20899     * to get the contents, texts and states. Use this when the original
20900     * item data has changed and the changes are desired to be reflected.
20901     *
20902     * To update just one item, use elm_genlist_item_update().
20903     *
20904     * @see elm_genlist_realized_items_get()
20905     * @see elm_genlist_item_update()
20906     *
20907     * @ingroup Genlist
20908     */
20909    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
20910
20911    /**
20912     * Activate a genlist mode on an item
20913     *
20914     * @param item The genlist item
20915     * @param mode Mode name
20916     * @param mode_set Boolean to define set or unset mode.
20917     *
20918     * A genlist mode is a different way of selecting an item. Once a mode is
20919     * activated on an item, any other selected item is immediately unselected.
20920     * This feature provides an easy way of implementing a new kind of animation
20921     * for selecting an item, without having to entirely rewrite the item style
20922     * theme. However, the elm_genlist_selected_* API can't be used to get what
20923     * item is activate for a mode.
20924     *
20925     * The current item style will still be used, but applying a genlist mode to
20926     * an item will select it using a different kind of animation.
20927     *
20928     * The current active item for a mode can be found by
20929     * elm_genlist_mode_item_get().
20930     *
20931     * The characteristics of genlist mode are:
20932     * - Only one mode can be active at any time, and for only one item.
20933     * - Genlist handles deactivating other items when one item is activated.
20934     * - A mode is defined in the genlist theme (edc), and more modes can easily
20935     *   be added.
20936     * - A mode style and the genlist item style are different things. They
20937     *   can be combined to provide a default style to the item, with some kind
20938     *   of animation for that item when the mode is activated.
20939     *
20940     * When a mode is activated on an item, a new view for that item is created.
20941     * The theme of this mode defines the animation that will be used to transit
20942     * the item from the old view to the new view. This second (new) view will be
20943     * active for that item while the mode is active on the item, and will be
20944     * destroyed after the mode is totally deactivated from that item.
20945     *
20946     * @see elm_genlist_mode_get()
20947     * @see elm_genlist_mode_item_get()
20948     *
20949     * @ingroup Genlist
20950     */
20951    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
20952
20953    /**
20954     * Get the last (or current) genlist mode used.
20955     *
20956     * @param obj The genlist object
20957     *
20958     * This function just returns the name of the last used genlist mode. It will
20959     * be the current mode if it's still active.
20960     *
20961     * @see elm_genlist_item_mode_set()
20962     * @see elm_genlist_mode_item_get()
20963     *
20964     * @ingroup Genlist
20965     */
20966    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20967
20968    /**
20969     * Get active genlist mode item
20970     *
20971     * @param obj The genlist object
20972     * @return The active item for that current mode. Or @c NULL if no item is
20973     * activated with any mode.
20974     *
20975     * This function returns the item that was activated with a mode, by the
20976     * function elm_genlist_item_mode_set().
20977     *
20978     * @see elm_genlist_item_mode_set()
20979     * @see elm_genlist_mode_get()
20980     *
20981     * @ingroup Genlist
20982     */
20983    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20984
20985    /**
20986     * Set reorder mode
20987     *
20988     * @param obj The genlist object
20989     * @param reorder_mode The reorder mode
20990     * (EINA_TRUE = on, EINA_FALSE = off)
20991     *
20992     * @ingroup Genlist
20993     */
20994    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
20995
20996    /**
20997     * Get the reorder mode
20998     *
20999     * @param obj The genlist object
21000     * @return The reorder mode
21001     * (EINA_TRUE = on, EINA_FALSE = off)
21002     *
21003     * @ingroup Genlist
21004     */
21005    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21006
21007    /**
21008     * @}
21009     */
21010
21011    /**
21012     * @defgroup Check Check
21013     *
21014     * @image html img/widget/check/preview-00.png
21015     * @image latex img/widget/check/preview-00.eps
21016     * @image html img/widget/check/preview-01.png
21017     * @image latex img/widget/check/preview-01.eps
21018     * @image html img/widget/check/preview-02.png
21019     * @image latex img/widget/check/preview-02.eps
21020     *
21021     * @brief The check widget allows for toggling a value between true and
21022     * false.
21023     *
21024     * Check objects are a lot like radio objects in layout and functionality
21025     * except they do not work as a group, but independently and only toggle the
21026     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
21027     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
21028     * returns the current state. For convenience, like the radio objects, you
21029     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
21030     * for it to modify.
21031     *
21032     * Signals that you can add callbacks for are:
21033     * "changed" - This is called whenever the user changes the state of one of
21034     *             the check object(event_info is NULL).
21035     *
21036     * Default contents parts of the check widget that you can use for are:
21037     * @li "icon" - An icon of the check
21038     *
21039     * Default text parts of the check widget that you can use for are:
21040     * @li "elm.text" - Label of the check
21041     *
21042     * @ref tutorial_check should give you a firm grasp of how to use this widget
21043     * .
21044     * @{
21045     */
21046    /**
21047     * @brief Add a new Check object
21048     *
21049     * @param parent The parent object
21050     * @return The new object or NULL if it cannot be created
21051     */
21052    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21053
21054    /**
21055     * @brief Set the text label of the check object
21056     *
21057     * @param obj The check object
21058     * @param label The text label string in UTF-8
21059     *
21060     * @deprecated use elm_object_text_set() instead.
21061     */
21062    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21063
21064    /**
21065     * @brief Get the text label of the check object
21066     *
21067     * @param obj The check object
21068     * @return The text label string in UTF-8
21069     *
21070     * @deprecated use elm_object_text_get() instead.
21071     */
21072    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21073
21074    /**
21075     * @brief Set the icon object of the check object
21076     *
21077     * @param obj The check object
21078     * @param icon The icon object
21079     *
21080     * Once the icon object is set, a previously set one will be deleted.
21081     * If you want to keep that old content object, use the
21082     * elm_object_content_unset() function.
21083     *
21084     * @deprecated use elm_object_part_content_set() instead.
21085     *
21086     */
21087    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21088
21089    /**
21090     * @brief Get the icon object of the check object
21091     *
21092     * @param obj The check object
21093     * @return The icon object
21094     *
21095     * @deprecated use elm_object_part_content_get() instead.
21096     *
21097     */
21098    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21099
21100    /**
21101     * @brief Unset the icon used for the check object
21102     *
21103     * @param obj The check object
21104     * @return The icon object that was being used
21105     *
21106     * Unparent and return the icon object which was set for this widget.
21107     *
21108     * @deprecated use elm_object_part_content_unset() instead.
21109     *
21110     */
21111    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21112
21113    /**
21114     * @brief Set the on/off state of the check object
21115     *
21116     * @param obj The check object
21117     * @param state The state to use (1 == on, 0 == off)
21118     *
21119     * This sets the state of the check. If set
21120     * with elm_check_state_pointer_set() the state of that variable is also
21121     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
21122     */
21123    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21124
21125    /**
21126     * @brief Get the state of the check object
21127     *
21128     * @param obj The check object
21129     * @return The boolean state
21130     */
21131    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21132
21133    /**
21134     * @brief Set a convenience pointer to a boolean to change
21135     *
21136     * @param obj The check object
21137     * @param statep Pointer to the boolean to modify
21138     *
21139     * This sets a pointer to a boolean, that, in addition to the check objects
21140     * state will also be modified directly. To stop setting the object pointed
21141     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
21142     * then when this is called, the check objects state will also be modified to
21143     * reflect the value of the boolean @p statep points to, just like calling
21144     * elm_check_state_set().
21145     */
21146    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
21147    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
21148    EINA_DEPRECATED EAPI void         elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
21149
21150    /**
21151     * @}
21152     */
21153
21154    /**
21155     * @defgroup Radio Radio
21156     *
21157     * @image html img/widget/radio/preview-00.png
21158     * @image latex img/widget/radio/preview-00.eps
21159     *
21160     * @brief Radio is a widget that allows for 1 or more options to be displayed
21161     * and have the user choose only 1 of them.
21162     *
21163     * A radio object contains an indicator, an optional Label and an optional
21164     * icon object. While it's possible to have a group of only one radio they,
21165     * are normally used in groups of 2 or more. To add a radio to a group use
21166     * elm_radio_group_add(). The radio object(s) will select from one of a set
21167     * of integer values, so any value they are configuring needs to be mapped to
21168     * a set of integers. To configure what value that radio object represents,
21169     * use  elm_radio_state_value_set() to set the integer it represents. To set
21170     * the value the whole group(which one is currently selected) is to indicate
21171     * use elm_radio_value_set() on any group member, and to get the groups value
21172     * use elm_radio_value_get(). For convenience the radio objects are also able
21173     * to directly set an integer(int) to the value that is selected. To specify
21174     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
21175     * The radio objects will modify this directly. That implies the pointer must
21176     * point to valid memory for as long as the radio objects exist.
21177     *
21178     * Signals that you can add callbacks for are:
21179     * @li changed - This is called whenever the user changes the state of one of
21180     * the radio objects within the group of radio objects that work together.
21181     *
21182     * Default contents parts of the radio widget that you can use for are:
21183     * @li "icon" - An icon of the radio
21184     *
21185     * @ref tutorial_radio show most of this API in action.
21186     * @{
21187     */
21188
21189    /**
21190     * @brief Add a new radio to the parent
21191     *
21192     * @param parent The parent object
21193     * @return The new object or NULL if it cannot be created
21194     */
21195    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21196
21197    /**
21198     * @brief Set the text label of the radio object
21199     *
21200     * @param obj The radio object
21201     * @param label The text label string in UTF-8
21202     *
21203     * @deprecated use elm_object_text_set() instead.
21204     */
21205    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21206
21207    /**
21208     * @brief Get the text label of the radio object
21209     *
21210     * @param obj The radio object
21211     * @return The text label string in UTF-8
21212     *
21213     * @deprecated use elm_object_text_set() instead.
21214     */
21215    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21216
21217    /**
21218     * @brief Set the icon object of the radio object
21219     *
21220     * @param obj The radio object
21221     * @param icon The icon object
21222     *
21223     * Once the icon object is set, a previously set one will be deleted. If you
21224     * want to keep that old content object, use the elm_radio_icon_unset()
21225     * function.
21226     *
21227     * @deprecated use elm_object_part_content_set() instead.
21228     *
21229     */
21230    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21231
21232    /**
21233     * @brief Get the icon object of the radio object
21234     *
21235     * @param obj The radio object
21236     * @return The icon object
21237     *
21238     * @see elm_radio_icon_set()
21239     *
21240     * @deprecated use elm_object_part_content_get() instead.
21241     *
21242     */
21243    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21244
21245    /**
21246     * @brief Unset the icon used for the radio object
21247     *
21248     * @param obj The radio object
21249     * @return The icon object that was being used
21250     *
21251     * Unparent and return the icon object which was set for this widget.
21252     *
21253     * @see elm_radio_icon_set()
21254     * @deprecated use elm_object_part_content_unset() instead.
21255     *
21256     */
21257    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21258
21259    /**
21260     * @brief Add this radio to a group of other radio objects
21261     *
21262     * @param obj The radio object
21263     * @param group Any object whose group the @p obj is to join.
21264     *
21265     * Radio objects work in groups. Each member should have a different integer
21266     * value assigned. In order to have them work as a group, they need to know
21267     * about each other. This adds the given radio object to the group of which
21268     * the group object indicated is a member.
21269     */
21270    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
21271
21272    /**
21273     * @brief Set the integer value that this radio object represents
21274     *
21275     * @param obj The radio object
21276     * @param value The value to use if this radio object is selected
21277     *
21278     * This sets the value of the radio.
21279     */
21280    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21281
21282    /**
21283     * @brief Get the integer value that this radio object represents
21284     *
21285     * @param obj The radio object
21286     * @return The value used if this radio object is selected
21287     *
21288     * This gets the value of the radio.
21289     *
21290     * @see elm_radio_value_set()
21291     */
21292    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21293
21294    /**
21295     * @brief Set the value of the radio.
21296     *
21297     * @param obj The radio object
21298     * @param value The value to use for the group
21299     *
21300     * This sets the value of the radio group and will also set the value if
21301     * pointed to, to the value supplied, but will not call any callbacks.
21302     */
21303    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
21304
21305    /**
21306     * @brief Get the state of the radio object
21307     *
21308     * @param obj The radio object
21309     * @return The integer state
21310     */
21311    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21312
21313    /**
21314     * @brief Set a convenience pointer to a integer to change
21315     *
21316     * @param obj The radio object
21317     * @param valuep Pointer to the integer to modify
21318     *
21319     * This sets a pointer to a integer, that, in addition to the radio objects
21320     * state will also be modified directly. To stop setting the object pointed
21321     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
21322     * when this is called, the radio objects state will also be modified to
21323     * reflect the value of the integer valuep points to, just like calling
21324     * elm_radio_value_set().
21325     */
21326    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
21327
21328    /**
21329     * @}
21330     */
21331
21332    /**
21333     * @defgroup Pager Pager
21334     *
21335     * @image html img/widget/pager/preview-00.png
21336     * @image latex img/widget/pager/preview-00.eps
21337     *
21338     * @brief Widget that allows flipping between one or more ā€œpagesā€
21339     * of objects.
21340     *
21341     * The flipping between pages of objects is animated. All content
21342     * in the pager is kept in a stack, being the last content added
21343     * (visible one) on the top of that stack.
21344     *
21345     * Objects can be pushed or popped from the stack or deleted as
21346     * well. Pushes and pops will animate the widget accordingly to its
21347     * style (a pop will also delete the child object once the
21348     * animation is finished). Any object already in the pager can be
21349     * promoted to the top (from its current stacking position) through
21350     * the use of elm_pager_content_promote(). New objects are pushed
21351     * to the top with elm_pager_content_push(). When the top item is
21352     * no longer wanted, simply pop it with elm_pager_content_pop() and
21353     * it will also be deleted. If an object is no longer needed and is
21354     * not the top item, just delete it as normal. You can query which
21355     * objects are the top and bottom with
21356     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
21357     *
21358     * Signals that you can add callbacks for are:
21359     * - @c "show,finished" - when a new page is actually shown on the top
21360     * - @c "hide,finished" - when a previous page is hidden
21361     *
21362     * Only after the first of that signals the child object is
21363     * guaranteed to be visible, as in @c evas_object_visible_get().
21364     *
21365     * This widget has the following styles available:
21366     * - @c "default"
21367     * - @c "fade"
21368     * - @c "fade_translucide"
21369     * - @c "fade_invisible"
21370     *
21371     * @note These styles affect only the flipping animations on the
21372     * default theme; the appearance when not animating is unaffected
21373     * by them.
21374     *
21375     * @ref tutorial_pager gives a good overview of the usage of the API.
21376     * @{
21377     */
21378
21379    /**
21380     * Add a new pager to the parent
21381     *
21382     * @param parent The parent object
21383     * @return The new object or NULL if it cannot be created
21384     *
21385     * @ingroup Pager
21386     */
21387    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21388
21389    /**
21390     * @brief Push an object to the top of the pager stack (and show it).
21391     *
21392     * @param obj The pager object
21393     * @param content The object to push
21394     *
21395     * The object pushed becomes a child of the pager, it will be controlled and
21396     * deleted when the pager is deleted.
21397     *
21398     * @note If the content is already in the stack use
21399     * elm_pager_content_promote().
21400     * @warning Using this function on @p content already in the stack results in
21401     * undefined behavior.
21402     */
21403    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21404
21405    /**
21406     * @brief Pop the object that is on top of the stack
21407     *
21408     * @param obj The pager object
21409     *
21410     * This pops the object that is on the top(visible) of the pager, makes it
21411     * disappear, then deletes the object. The object that was underneath it on
21412     * the stack will become visible.
21413     */
21414    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
21415
21416    /**
21417     * @brief Moves an object already in the pager stack to the top of the stack.
21418     *
21419     * @param obj The pager object
21420     * @param content The object to promote
21421     *
21422     * This will take the @p content and move it to the top of the stack as
21423     * if it had been pushed there.
21424     *
21425     * @note If the content isn't already in the stack use
21426     * elm_pager_content_push().
21427     * @warning Using this function on @p content not already in the stack
21428     * results in undefined behavior.
21429     */
21430    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21431
21432    /**
21433     * @brief Return the object at the bottom of the pager stack
21434     *
21435     * @param obj The pager object
21436     * @return The bottom object or NULL if none
21437     */
21438    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21439
21440    /**
21441     * @brief  Return the object at the top of the pager stack
21442     *
21443     * @param obj The pager object
21444     * @return The top object or NULL if none
21445     */
21446    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21447
21448    /**
21449     * @}
21450     */
21451
21452    /**
21453     * @defgroup Slideshow Slideshow
21454     *
21455     * @image html img/widget/slideshow/preview-00.png
21456     * @image latex img/widget/slideshow/preview-00.eps
21457     *
21458     * This widget, as the name indicates, is a pre-made image
21459     * slideshow panel, with API functions acting on (child) image
21460     * items presentation. Between those actions, are:
21461     * - advance to next/previous image
21462     * - select the style of image transition animation
21463     * - set the exhibition time for each image
21464     * - start/stop the slideshow
21465     *
21466     * The transition animations are defined in the widget's theme,
21467     * consequently new animations can be added without having to
21468     * update the widget's code.
21469     *
21470     * @section Slideshow_Items Slideshow items
21471     *
21472     * For slideshow items, just like for @ref Genlist "genlist" ones,
21473     * the user defines a @b classes, specifying functions that will be
21474     * called on the item's creation and deletion times.
21475     *
21476     * The #Elm_Slideshow_Item_Class structure contains the following
21477     * members:
21478     *
21479     * - @c func.get - When an item is displayed, this function is
21480     *   called, and it's where one should create the item object, de
21481     *   facto. For example, the object can be a pure Evas image object
21482     *   or an Elementary @ref Photocam "photocam" widget. See
21483     *   #SlideshowItemGetFunc.
21484     * - @c func.del - When an item is no more displayed, this function
21485     *   is called, where the user must delete any data associated to
21486     *   the item. See #SlideshowItemDelFunc.
21487     *
21488     * @section Slideshow_Caching Slideshow caching
21489     *
21490     * The slideshow provides facilities to have items adjacent to the
21491     * one being displayed <b>already "realized"</b> (i.e. loaded) for
21492     * you, so that the system does not have to decode image data
21493     * anymore at the time it has to actually switch images on its
21494     * viewport. The user is able to set the numbers of items to be
21495     * cached @b before and @b after the current item, in the widget's
21496     * item list.
21497     *
21498     * Smart events one can add callbacks for are:
21499     *
21500     * - @c "changed" - when the slideshow switches its view to a new
21501     *   item. event_info parameter in callback contains the current visible item
21502     * - @c "transition,end" - when a slide transition ends. event_info parameter
21503     *   in callback contains the current visible item
21504     *
21505     * List of examples for the slideshow widget:
21506     * @li @ref slideshow_example
21507     */
21508
21509    /**
21510     * @addtogroup Slideshow
21511     * @{
21512     */
21513
21514    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
21515    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
21516    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
21517    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
21518
21519    /**
21520     * @struct _Elm_Slideshow_Item_Class
21521     *
21522     * Slideshow item class definition. See @ref Slideshow_Items for
21523     * field details.
21524     */
21525    struct _Elm_Slideshow_Item_Class
21526      {
21527         struct _Elm_Slideshow_Item_Class_Func
21528           {
21529              SlideshowItemGetFunc get;
21530              SlideshowItemDelFunc del;
21531           } func;
21532      }; /**< #Elm_Slideshow_Item_Class member definitions */
21533
21534    /**
21535     * Add a new slideshow widget to the given parent Elementary
21536     * (container) object
21537     *
21538     * @param parent The parent object
21539     * @return A new slideshow widget handle or @c NULL, on errors
21540     *
21541     * This function inserts a new slideshow widget on the canvas.
21542     *
21543     * @ingroup Slideshow
21544     */
21545    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21546
21547    /**
21548     * Add (append) a new item in a given slideshow widget.
21549     *
21550     * @param obj The slideshow object
21551     * @param itc The item class for the item
21552     * @param data The item's data
21553     * @return A handle to the item added or @c NULL, on errors
21554     *
21555     * Add a new item to @p obj's internal list of items, appending it.
21556     * The item's class must contain the function really fetching the
21557     * image object to show for this item, which could be an Evas image
21558     * object or an Elementary photo, for example. The @p data
21559     * parameter is going to be passed to both class functions of the
21560     * item.
21561     *
21562     * @see #Elm_Slideshow_Item_Class
21563     * @see elm_slideshow_item_sorted_insert()
21564     * @see elm_object_item_data_set()
21565     *
21566     * @ingroup Slideshow
21567     */
21568    EAPI Elm_Object_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
21569
21570    /**
21571     * Insert a new item into the given slideshow widget, using the @p func
21572     * function to sort items (by item handles).
21573     *
21574     * @param obj The slideshow object
21575     * @param itc The item class for the item
21576     * @param data The item's data
21577     * @param func The comparing function to be used to sort slideshow
21578     * items <b>by #Elm_Slideshow_Item item handles</b>
21579     * @return Returns The slideshow item handle, on success, or
21580     * @c NULL, on errors
21581     *
21582     * Add a new item to @p obj's internal list of items, in a position
21583     * determined by the @p func comparing function. The item's class
21584     * must contain the function really fetching the image object to
21585     * show for this item, which could be an Evas image object or an
21586     * Elementary photo, for example. The @p data parameter is going to
21587     * be passed to both class functions of the item.
21588     *
21589     * @see #Elm_Slideshow_Item_Class
21590     * @see elm_slideshow_item_add()
21591     *
21592     * @ingroup Slideshow
21593     */
21594    EAPI Elm_Object_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);
21595
21596    /**
21597     * Display a given slideshow widget's item, programmatically.
21598     *
21599     * @param it The item to display on @p obj's viewport
21600     *
21601     * The change between the current item and @p item will use the
21602     * transition @p obj is set to use (@see
21603     * elm_slideshow_transition_set()).
21604     *
21605     * @ingroup Slideshow
21606     */
21607    EAPI void                elm_slideshow_show(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21608
21609    /**
21610     * Slide to the @b next item, in a given slideshow widget
21611     *
21612     * @param obj The slideshow object
21613     *
21614     * The sliding animation @p obj is set to use will be the
21615     * transition effect used, after this call is issued.
21616     *
21617     * @note If the end of the slideshow's internal list of items is
21618     * reached, it'll wrap around to the list's beginning, again.
21619     *
21620     * @ingroup Slideshow
21621     */
21622    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21623
21624    /**
21625     * Slide to the @b previous item, in a given slideshow widget
21626     *
21627     * @param obj The slideshow object
21628     *
21629     * The sliding animation @p obj is set to use will be the
21630     * transition effect used, after this call is issued.
21631     *
21632     * @note If the beginning of the slideshow's internal list of items
21633     * is reached, it'll wrap around to the list's end, again.
21634     *
21635     * @ingroup Slideshow
21636     */
21637    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
21638
21639    /**
21640     * Returns the list of sliding transition/effect names available, for a
21641     * given slideshow widget.
21642     *
21643     * @param obj The slideshow object
21644     * @return The list of transitions (list of @b stringshared strings
21645     * as data)
21646     *
21647     * The transitions, which come from @p obj's theme, must be an EDC
21648     * data item named @c "transitions" on the theme file, with (prefix)
21649     * names of EDC programs actually implementing them.
21650     *
21651     * The available transitions for slideshows on the default theme are:
21652     * - @c "fade" - the current item fades out, while the new one
21653     *   fades in to the slideshow's viewport.
21654     * - @c "black_fade" - the current item fades to black, and just
21655     *   then, the new item will fade in.
21656     * - @c "horizontal" - the current item slides horizontally, until
21657     *   it gets out of the slideshow's viewport, while the new item
21658     *   comes from the left to take its place.
21659     * - @c "vertical" - the current item slides vertically, until it
21660     *   gets out of the slideshow's viewport, while the new item comes
21661     *   from the bottom to take its place.
21662     * - @c "square" - the new item starts to appear from the middle of
21663     *   the current one, but with a tiny size, growing until its
21664     *   target (full) size and covering the old one.
21665     *
21666     * @warning The stringshared strings get no new references
21667     * exclusive to the user grabbing the list, here, so if you'd like
21668     * to use them out of this call's context, you'd better @c
21669     * eina_stringshare_ref() them.
21670     *
21671     * @see elm_slideshow_transition_set()
21672     *
21673     * @ingroup Slideshow
21674     */
21675    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21676
21677    /**
21678     * Set the current slide transition/effect in use for a given
21679     * slideshow widget
21680     *
21681     * @param obj The slideshow object
21682     * @param transition The new transition's name string
21683     *
21684     * If @p transition is implemented in @p obj's theme (i.e., is
21685     * contained in the list returned by
21686     * elm_slideshow_transitions_get()), this new sliding effect will
21687     * be used on the widget.
21688     *
21689     * @see elm_slideshow_transitions_get() for more details
21690     *
21691     * @ingroup Slideshow
21692     */
21693    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
21694
21695    /**
21696     * Get the current slide transition/effect in use for a given
21697     * slideshow widget
21698     *
21699     * @param obj The slideshow object
21700     * @return The current transition's name
21701     *
21702     * @see elm_slideshow_transition_set() for more details
21703     *
21704     * @ingroup Slideshow
21705     */
21706    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21707
21708    /**
21709     * Set the interval between each image transition on a given
21710     * slideshow widget, <b>and start the slideshow, itself</b>
21711     *
21712     * @param obj The slideshow object
21713     * @param timeout The new displaying timeout for images
21714     *
21715     * After this call, the slideshow widget will start cycling its
21716     * view, sequentially and automatically, with the images of the
21717     * items it has. The time between each new image displayed is going
21718     * to be @p timeout, in @b seconds. If a different timeout was set
21719     * previously and an slideshow was in progress, it will continue
21720     * with the new time between transitions, after this call.
21721     *
21722     * @note A value less than or equal to 0 on @p timeout will disable
21723     * the widget's internal timer, thus halting any slideshow which
21724     * could be happening on @p obj.
21725     *
21726     * @see elm_slideshow_timeout_get()
21727     *
21728     * @ingroup Slideshow
21729     */
21730    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
21731
21732    /**
21733     * Get the interval set for image transitions on a given slideshow
21734     * widget.
21735     *
21736     * @param obj The slideshow object
21737     * @return Returns the timeout set on it
21738     *
21739     * @see elm_slideshow_timeout_set() for more details
21740     *
21741     * @ingroup Slideshow
21742     */
21743    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21744
21745    /**
21746     * Set if, after a slideshow is started, for a given slideshow
21747     * widget, its items should be displayed cyclically or not.
21748     *
21749     * @param obj The slideshow object
21750     * @param loop Use @c EINA_TRUE to make it cycle through items or
21751     * @c EINA_FALSE for it to stop at the end of @p obj's internal
21752     * list of items
21753     *
21754     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
21755     * ignore what is set by this functions, i.e., they'll @b always
21756     * cycle through items. This affects only the "automatic"
21757     * slideshow, as set by elm_slideshow_timeout_set().
21758     *
21759     * @see elm_slideshow_loop_get()
21760     *
21761     * @ingroup Slideshow
21762     */
21763    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
21764
21765    /**
21766     * Get if, after a slideshow is started, for a given slideshow
21767     * widget, its items are to be displayed cyclically or not.
21768     *
21769     * @param obj The slideshow object
21770     * @return @c EINA_TRUE, if the items in @p obj will be cycled
21771     * through or @c EINA_FALSE, otherwise
21772     *
21773     * @see elm_slideshow_loop_set() for more details
21774     *
21775     * @ingroup Slideshow
21776     */
21777    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21778
21779    /**
21780     * Remove all items from a given slideshow widget
21781     *
21782     * @param obj The slideshow object
21783     *
21784     * This removes (and deletes) all items in @p obj, leaving it
21785     * empty.
21786     *
21787     * @see elm_slideshow_item_del(), to remove just one item.
21788     *
21789     * @ingroup Slideshow
21790     */
21791    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21792
21793    /**
21794     * Get the internal list of items in a given slideshow widget.
21795     *
21796     * @param obj The slideshow object
21797     * @return The list of items (#Elm_Object_Item as data) or
21798     * @c NULL on errors.
21799     *
21800     * This list is @b not to be modified in any way and must not be
21801     * freed. Use the list members with functions like
21802     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
21803     *
21804     * @warning This list is only valid until @p obj object's internal
21805     * items list is changed. It should be fetched again with another
21806     * call to this function when changes happen.
21807     *
21808     * @ingroup Slideshow
21809     */
21810    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21811
21812    /**
21813     * Delete a given item from a slideshow widget.
21814     *
21815     * @param it The slideshow item
21816     *
21817     * @ingroup Slideshow
21818     */
21819    EAPI void                elm_slideshow_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21820
21821    /**
21822     * Return the data associated with a given slideshow item
21823     *
21824     * @param it The slideshow item
21825     * @return Returns the data associated to this item
21826     *
21827     * @deprecated use elm_object_item_data_get() instead
21828     * @ingroup Slideshow
21829     */
21830    EINA_DEPRECATED EAPI void               *elm_slideshow_item_data_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
21831
21832    /**
21833     * Returns the currently displayed item, in a given slideshow widget
21834     *
21835     * @param obj The slideshow object
21836     * @return A handle to the item being displayed in @p obj or
21837     * @c NULL, if none is (and on errors)
21838     *
21839     * @ingroup Slideshow
21840     */
21841    EAPI Elm_Object_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21842
21843    /**
21844     * Get the real Evas object created to implement the view of a
21845     * given slideshow item
21846     *
21847     * @param item The slideshow item.
21848     * @return the Evas object implementing this item's view.
21849     *
21850     * This returns the actual Evas object used to implement the
21851     * specified slideshow item's view. This may be @c NULL, as it may
21852     * not have been created or may have been deleted, at any time, by
21853     * the slideshow. <b>Do not modify this object</b> (move, resize,
21854     * show, hide, etc.), as the slideshow is controlling it. This
21855     * function is for querying, emitting custom signals or hooking
21856     * lower level callbacks for events on that object. Do not delete
21857     * this object under any circumstances.
21858     *
21859     * @see elm_slideshow_item_data_get()
21860     *
21861     * @ingroup Slideshow
21862     */
21863    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Object_Item* it) EINA_ARG_NONNULL(1);
21864
21865    /**
21866     * Get the the item, in a given slideshow widget, placed at
21867     * position @p nth, in its internal items list
21868     *
21869     * @param obj The slideshow object
21870     * @param nth The number of the item to grab a handle to (0 being
21871     * the first)
21872     * @return The item stored in @p obj at position @p nth or @c NULL,
21873     * if there's no item with that index (and on errors)
21874     *
21875     * @ingroup Slideshow
21876     */
21877    EAPI Elm_Object_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
21878
21879    /**
21880     * Set the current slide layout in use for a given slideshow widget
21881     *
21882     * @param obj The slideshow object
21883     * @param layout The new layout's name string
21884     *
21885     * If @p layout is implemented in @p obj's theme (i.e., is contained
21886     * in the list returned by elm_slideshow_layouts_get()), this new
21887     * images layout will be used on the widget.
21888     *
21889     * @see elm_slideshow_layouts_get() for more details
21890     *
21891     * @ingroup Slideshow
21892     */
21893    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
21894
21895    /**
21896     * Get the current slide layout in use for a given slideshow widget
21897     *
21898     * @param obj The slideshow object
21899     * @return The current layout's name
21900     *
21901     * @see elm_slideshow_layout_set() for more details
21902     *
21903     * @ingroup Slideshow
21904     */
21905    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21906
21907    /**
21908     * Returns the list of @b layout names available, for a given
21909     * slideshow widget.
21910     *
21911     * @param obj The slideshow object
21912     * @return The list of layouts (list of @b stringshared strings
21913     * as data)
21914     *
21915     * Slideshow layouts will change how the widget is to dispose each
21916     * image item in its viewport, with regard to cropping, scaling,
21917     * etc.
21918     *
21919     * The layouts, which come from @p obj's theme, must be an EDC
21920     * data item name @c "layouts" on the theme file, with (prefix)
21921     * names of EDC programs actually implementing them.
21922     *
21923     * The available layouts for slideshows on the default theme are:
21924     * - @c "fullscreen" - item images with original aspect, scaled to
21925     *   touch top and down slideshow borders or, if the image's heigh
21926     *   is not enough, left and right slideshow borders.
21927     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
21928     *   one, but always leaving 10% of the slideshow's dimensions of
21929     *   distance between the item image's borders and the slideshow
21930     *   borders, for each axis.
21931     *
21932     * @warning The stringshared strings get no new references
21933     * exclusive to the user grabbing the list, here, so if you'd like
21934     * to use them out of this call's context, you'd better @c
21935     * eina_stringshare_ref() them.
21936     *
21937     * @see elm_slideshow_layout_set()
21938     *
21939     * @ingroup Slideshow
21940     */
21941    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21942
21943    /**
21944     * Set the number of items to cache, on a given slideshow widget,
21945     * <b>before the current item</b>
21946     *
21947     * @param obj The slideshow object
21948     * @param count Number of items to cache before the current one
21949     *
21950     * The default value for this property is @c 2. See
21951     * @ref Slideshow_Caching "slideshow caching" for more details.
21952     *
21953     * @see elm_slideshow_cache_before_get()
21954     *
21955     * @ingroup Slideshow
21956     */
21957    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21958
21959    /**
21960     * Retrieve the number of items to cache, on a given slideshow widget,
21961     * <b>before the current item</b>
21962     *
21963     * @param obj The slideshow object
21964     * @return The number of items set to be cached before the current one
21965     *
21966     * @see elm_slideshow_cache_before_set() for more details
21967     *
21968     * @ingroup Slideshow
21969     */
21970    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21971
21972    /**
21973     * Set the number of items to cache, on a given slideshow widget,
21974     * <b>after the current item</b>
21975     *
21976     * @param obj The slideshow object
21977     * @param count Number of items to cache after the current one
21978     *
21979     * The default value for this property is @c 2. See
21980     * @ref Slideshow_Caching "slideshow caching" for more details.
21981     *
21982     * @see elm_slideshow_cache_after_get()
21983     *
21984     * @ingroup Slideshow
21985     */
21986    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
21987
21988    /**
21989     * Retrieve the number of items to cache, on a given slideshow widget,
21990     * <b>after the current item</b>
21991     *
21992     * @param obj The slideshow object
21993     * @return The number of items set to be cached after the current one
21994     *
21995     * @see elm_slideshow_cache_after_set() for more details
21996     *
21997     * @ingroup Slideshow
21998     */
21999    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22000
22001    /**
22002     * Get the number of items stored in a given slideshow widget
22003     *
22004     * @param obj The slideshow object
22005     * @return The number of items on @p obj, at the moment of this call
22006     *
22007     * @ingroup Slideshow
22008     */
22009    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22010
22011    /**
22012     * @}
22013     */
22014
22015    /**
22016     * @defgroup Fileselector File Selector
22017     *
22018     * @image html img/widget/fileselector/preview-00.png
22019     * @image latex img/widget/fileselector/preview-00.eps
22020     *
22021     * A file selector is a widget that allows a user to navigate
22022     * through a file system, reporting file selections back via its
22023     * API.
22024     *
22025     * It contains shortcut buttons for home directory (@c ~) and to
22026     * jump one directory upwards (..), as well as cancel/ok buttons to
22027     * confirm/cancel a given selection. After either one of those two
22028     * former actions, the file selector will issue its @c "done" smart
22029     * callback.
22030     *
22031     * There's a text entry on it, too, showing the name of the current
22032     * selection. There's the possibility of making it editable, so it
22033     * is useful on file saving dialogs on applications, where one
22034     * gives a file name to save contents to, in a given directory in
22035     * the system. This custom file name will be reported on the @c
22036     * "done" smart callback (explained in sequence).
22037     *
22038     * Finally, it has a view to display file system items into in two
22039     * possible forms:
22040     * - list
22041     * - grid
22042     *
22043     * If Elementary is built with support of the Ethumb thumbnailing
22044     * library, the second form of view will display preview thumbnails
22045     * of files which it supports.
22046     *
22047     * Smart callbacks one can register to:
22048     *
22049     * - @c "selected" - the user has clicked on a file (when not in
22050     *      folders-only mode) or directory (when in folders-only mode)
22051     * - @c "directory,open" - the list has been populated with new
22052     *      content (@c event_info is a pointer to the directory's
22053     *      path, a @b stringshared string)
22054     * - @c "done" - the user has clicked on the "ok" or "cancel"
22055     *      buttons (@c event_info is a pointer to the selection's
22056     *      path, a @b stringshared string)
22057     *
22058     * Here is an example on its usage:
22059     * @li @ref fileselector_example
22060     */
22061
22062    /**
22063     * @addtogroup Fileselector
22064     * @{
22065     */
22066
22067    /**
22068     * Defines how a file selector widget is to layout its contents
22069     * (file system entries).
22070     */
22071    typedef enum _Elm_Fileselector_Mode
22072      {
22073         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
22074         ELM_FILESELECTOR_GRID, /**< layout as a grid */
22075         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
22076      } Elm_Fileselector_Mode;
22077
22078    /**
22079     * Add a new file selector widget to the given parent Elementary
22080     * (container) object
22081     *
22082     * @param parent The parent object
22083     * @return a new file selector widget handle or @c NULL, on errors
22084     *
22085     * This function inserts a new file selector widget on the canvas.
22086     *
22087     * @ingroup Fileselector
22088     */
22089    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22090
22091    /**
22092     * Enable/disable the file name entry box where the user can type
22093     * in a name for a file, in a given file selector widget
22094     *
22095     * @param obj The file selector object
22096     * @param is_save @c EINA_TRUE to make the file selector a "saving
22097     * dialog", @c EINA_FALSE otherwise
22098     *
22099     * Having the entry editable is useful on file saving dialogs on
22100     * applications, where one gives a file name to save contents to,
22101     * in a given directory in the system. This custom file name will
22102     * be reported on the @c "done" smart callback.
22103     *
22104     * @see elm_fileselector_is_save_get()
22105     *
22106     * @ingroup Fileselector
22107     */
22108    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
22109
22110    /**
22111     * Get whether the given file selector is in "saving dialog" mode
22112     *
22113     * @param obj The file selector object
22114     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
22115     * mode, @c EINA_FALSE otherwise (and on errors)
22116     *
22117     * @see elm_fileselector_is_save_set() for more details
22118     *
22119     * @ingroup Fileselector
22120     */
22121    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22122
22123    /**
22124     * Enable/disable folder-only view for a given file selector widget
22125     *
22126     * @param obj The file selector object
22127     * @param only @c EINA_TRUE to make @p obj only display
22128     * directories, @c EINA_FALSE to make files to be displayed in it
22129     * too
22130     *
22131     * If enabled, the widget's view will only display folder items,
22132     * naturally.
22133     *
22134     * @see elm_fileselector_folder_only_get()
22135     *
22136     * @ingroup Fileselector
22137     */
22138    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
22139
22140    /**
22141     * Get whether folder-only view is set for a given file selector
22142     * widget
22143     *
22144     * @param obj The file selector object
22145     * @return only @c EINA_TRUE if @p obj is only displaying
22146     * directories, @c EINA_FALSE if files are being displayed in it
22147     * too (and on errors)
22148     *
22149     * @see elm_fileselector_folder_only_get()
22150     *
22151     * @ingroup Fileselector
22152     */
22153    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22154
22155    /**
22156     * Enable/disable the "ok" and "cancel" buttons on a given file
22157     * selector widget
22158     *
22159     * @param obj The file selector object
22160     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
22161     *
22162     * @note A file selector without those buttons will never emit the
22163     * @c "done" smart event, and is only usable if one is just hooking
22164     * to the other two events.
22165     *
22166     * @see elm_fileselector_buttons_ok_cancel_get()
22167     *
22168     * @ingroup Fileselector
22169     */
22170    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
22171
22172    /**
22173     * Get whether the "ok" and "cancel" buttons on a given file
22174     * selector widget are being shown.
22175     *
22176     * @param obj The file selector object
22177     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
22178     * otherwise (and on errors)
22179     *
22180     * @see elm_fileselector_buttons_ok_cancel_set() for more details
22181     *
22182     * @ingroup Fileselector
22183     */
22184    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22185
22186    /**
22187     * Enable/disable a tree view in the given file selector widget,
22188     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
22189     *
22190     * @param obj The file selector object
22191     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
22192     * disable
22193     *
22194     * In a tree view, arrows are created on the sides of directories,
22195     * allowing them to expand in place.
22196     *
22197     * @note If it's in other mode, the changes made by this function
22198     * will only be visible when one switches back to "list" mode.
22199     *
22200     * @see elm_fileselector_expandable_get()
22201     *
22202     * @ingroup Fileselector
22203     */
22204    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
22205
22206    /**
22207     * Get whether tree view is enabled for the given file selector
22208     * widget
22209     *
22210     * @param obj The file selector object
22211     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
22212     * otherwise (and or errors)
22213     *
22214     * @see elm_fileselector_expandable_set() for more details
22215     *
22216     * @ingroup Fileselector
22217     */
22218    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22219
22220    /**
22221     * Set, programmatically, the @b directory that a given file
22222     * selector widget will display contents from
22223     *
22224     * @param obj The file selector object
22225     * @param path The path to display in @p obj
22226     *
22227     * This will change the @b directory that @p obj is displaying. It
22228     * will also clear the text entry area on the @p obj object, which
22229     * displays select files' names.
22230     *
22231     * @see elm_fileselector_path_get()
22232     *
22233     * @ingroup Fileselector
22234     */
22235    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22236
22237    /**
22238     * Get the parent directory's path that a given file selector
22239     * widget is displaying
22240     *
22241     * @param obj The file selector object
22242     * @return The (full) path of the directory the file selector is
22243     * displaying, a @b stringshared string
22244     *
22245     * @see elm_fileselector_path_set()
22246     *
22247     * @ingroup Fileselector
22248     */
22249    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22250
22251    /**
22252     * Set, programmatically, the currently selected file/directory in
22253     * the given file selector widget
22254     *
22255     * @param obj The file selector object
22256     * @param path The (full) path to a file or directory
22257     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
22258     * latter case occurs if the directory or file pointed to do not
22259     * exist.
22260     *
22261     * @see elm_fileselector_selected_get()
22262     *
22263     * @ingroup Fileselector
22264     */
22265    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
22266
22267    /**
22268     * Get the currently selected item's (full) path, in the given file
22269     * selector widget
22270     *
22271     * @param obj The file selector object
22272     * @return The absolute path of the selected item, a @b
22273     * stringshared string
22274     *
22275     * @note Custom editions on @p obj object's text entry, if made,
22276     * will appear on the return string of this function, naturally.
22277     *
22278     * @see elm_fileselector_selected_set() for more details
22279     *
22280     * @ingroup Fileselector
22281     */
22282    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22283
22284    /**
22285     * Set the mode in which a given file selector widget will display
22286     * (layout) file system entries in its view
22287     *
22288     * @param obj The file selector object
22289     * @param mode The mode of the fileselector, being it one of
22290     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
22291     * first one, naturally, will display the files in a list. The
22292     * latter will make the widget to display its entries in a grid
22293     * form.
22294     *
22295     * @note By using elm_fileselector_expandable_set(), the user may
22296     * trigger a tree view for that list.
22297     *
22298     * @note If Elementary is built with support of the Ethumb
22299     * thumbnailing library, the second form of view will display
22300     * preview thumbnails of files which it supports. You must have
22301     * elm_need_ethumb() called in your Elementary for thumbnailing to
22302     * work, though.
22303     *
22304     * @see elm_fileselector_expandable_set().
22305     * @see elm_fileselector_mode_get().
22306     *
22307     * @ingroup Fileselector
22308     */
22309    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
22310
22311    /**
22312     * Get the mode in which a given file selector widget is displaying
22313     * (layouting) file system entries in its view
22314     *
22315     * @param obj The fileselector object
22316     * @return The mode in which the fileselector is at
22317     *
22318     * @see elm_fileselector_mode_set() for more details
22319     *
22320     * @ingroup Fileselector
22321     */
22322    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22323
22324    /**
22325     * @}
22326     */
22327
22328    /**
22329     * @defgroup Progressbar Progress bar
22330     *
22331     * The progress bar is a widget for visually representing the
22332     * progress status of a given job/task.
22333     *
22334     * A progress bar may be horizontal or vertical. It may display an
22335     * icon besides it, as well as primary and @b units labels. The
22336     * former is meant to label the widget as a whole, while the
22337     * latter, which is formatted with floating point values (and thus
22338     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
22339     * units"</c>), is meant to label the widget's <b>progress
22340     * value</b>. Label, icon and unit strings/objects are @b optional
22341     * for progress bars.
22342     *
22343     * A progress bar may be @b inverted, in which state it gets its
22344     * values inverted, with high values being on the left or top and
22345     * low values on the right or bottom, as opposed to normally have
22346     * the low values on the former and high values on the latter,
22347     * respectively, for horizontal and vertical modes.
22348     *
22349     * The @b span of the progress, as set by
22350     * elm_progressbar_span_size_set(), is its length (horizontally or
22351     * vertically), unless one puts size hints on the widget to expand
22352     * on desired directions, by any container. That length will be
22353     * scaled by the object or applications scaling factor. At any
22354     * point code can query the progress bar for its value with
22355     * elm_progressbar_value_get().
22356     *
22357     * Available widget styles for progress bars:
22358     * - @c "default"
22359     * - @c "wheel" (simple style, no text, no progression, only
22360     *      "pulse" effect is available)
22361     *
22362     * Default contents parts of the progressbar widget that you can use for are:
22363     * @li "icon" - An icon of the progressbar
22364     *
22365     * Here is an example on its usage:
22366     * @li @ref progressbar_example
22367     */
22368
22369    /**
22370     * Add a new progress bar widget to the given parent Elementary
22371     * (container) object
22372     *
22373     * @param parent The parent object
22374     * @return a new progress bar widget handle or @c NULL, on errors
22375     *
22376     * This function inserts a new progress bar widget on the canvas.
22377     *
22378     * @ingroup Progressbar
22379     */
22380    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22381
22382    /**
22383     * Set whether a given progress bar widget is at "pulsing mode" or
22384     * not.
22385     *
22386     * @param obj The progress bar object
22387     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
22388     * @c EINA_FALSE to put it back to its default one
22389     *
22390     * By default, progress bars will display values from the low to
22391     * high value boundaries. There are, though, contexts in which the
22392     * state of progression of a given task is @b unknown.  For those,
22393     * one can set a progress bar widget to a "pulsing state", to give
22394     * the user an idea that some computation is being held, but
22395     * without exact progress values. In the default theme it will
22396     * animate its bar with the contents filling in constantly and back
22397     * to non-filled, in a loop. To start and stop this pulsing
22398     * animation, one has to explicitly call elm_progressbar_pulse().
22399     *
22400     * @see elm_progressbar_pulse_get()
22401     * @see elm_progressbar_pulse()
22402     *
22403     * @ingroup Progressbar
22404     */
22405    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
22406
22407    /**
22408     * Get whether a given progress bar widget is at "pulsing mode" or
22409     * not.
22410     *
22411     * @param obj The progress bar object
22412     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
22413     * if it's in the default one (and on errors)
22414     *
22415     * @ingroup Progressbar
22416     */
22417    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22418
22419    /**
22420     * Start/stop a given progress bar "pulsing" animation, if its
22421     * under that mode
22422     *
22423     * @param obj The progress bar object
22424     * @param state @c EINA_TRUE, to @b start the pulsing animation,
22425     * @c EINA_FALSE to @b stop it
22426     *
22427     * @note This call won't do anything if @p obj is not under "pulsing mode".
22428     *
22429     * @see elm_progressbar_pulse_set() for more details.
22430     *
22431     * @ingroup Progressbar
22432     */
22433    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
22434
22435    /**
22436     * Set the progress value (in percentage) on a given progress bar
22437     * widget
22438     *
22439     * @param obj The progress bar object
22440     * @param val The progress value (@b must be between @c 0.0 and @c
22441     * 1.0)
22442     *
22443     * Use this call to set progress bar levels.
22444     *
22445     * @note If you passes a value out of the specified range for @p
22446     * val, it will be interpreted as the @b closest of the @b boundary
22447     * values in the range.
22448     *
22449     * @ingroup Progressbar
22450     */
22451    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22452
22453    /**
22454     * Get the progress value (in percentage) on a given progress bar
22455     * widget
22456     *
22457     * @param obj The progress bar object
22458     * @return The value of the progressbar
22459     *
22460     * @see elm_progressbar_value_set() for more details
22461     *
22462     * @ingroup Progressbar
22463     */
22464    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22465
22466    /**
22467     * Set the label of a given progress bar widget
22468     *
22469     * @param obj The progress bar object
22470     * @param label The text label string, in UTF-8
22471     *
22472     * @ingroup Progressbar
22473     * @deprecated use elm_object_text_set() instead.
22474     */
22475    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
22476
22477    /**
22478     * Get the label of a given progress bar widget
22479     *
22480     * @param obj The progressbar object
22481     * @return The text label string, in UTF-8
22482     *
22483     * @ingroup Progressbar
22484     * @deprecated use elm_object_text_set() instead.
22485     */
22486    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22487
22488    /**
22489     * Set the icon object of a given progress bar widget
22490     *
22491     * @param obj The progress bar object
22492     * @param icon The icon object
22493     *
22494     * Use this call to decorate @p obj with an icon next to it.
22495     *
22496     * @note Once the icon object is set, a previously set one will be
22497     * deleted. If you want to keep that old content object, use the
22498     * elm_progressbar_icon_unset() function.
22499     *
22500     * @see elm_progressbar_icon_get()
22501     * @deprecated use elm_object_part_content_set() instead.
22502     *
22503     * @ingroup Progressbar
22504     */
22505    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
22506
22507    /**
22508     * Retrieve the icon object set for a given progress bar widget
22509     *
22510     * @param obj The progress bar object
22511     * @return The icon object's handle, if @p obj had one set, or @c NULL,
22512     * otherwise (and on errors)
22513     *
22514     * @see elm_progressbar_icon_set() for more details
22515     * @deprecated use elm_object_part_content_get() instead.
22516     *
22517     * @ingroup Progressbar
22518     */
22519    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22520
22521    /**
22522     * Unset an icon set on a given progress bar widget
22523     *
22524     * @param obj The progress bar object
22525     * @return The icon object that was being used, if any was set, or
22526     * @c NULL, otherwise (and on errors)
22527     *
22528     * This call will unparent and return the icon object which was set
22529     * for this widget, previously, on success.
22530     *
22531     * @see elm_progressbar_icon_set() for more details
22532     * @deprecated use elm_object_part_content_unset() instead.
22533     *
22534     * @ingroup Progressbar
22535     */
22536    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22537
22538    /**
22539     * Set the (exact) length of the bar region of a given progress bar
22540     * widget
22541     *
22542     * @param obj The progress bar object
22543     * @param size The length of the progress bar's bar region
22544     *
22545     * This sets the minimum width (when in horizontal mode) or height
22546     * (when in vertical mode) of the actual bar area of the progress
22547     * bar @p obj. This in turn affects the object's minimum size. Use
22548     * this when you're not setting other size hints expanding on the
22549     * given direction (like weight and alignment hints) and you would
22550     * like it to have a specific size.
22551     *
22552     * @note Icon, label and unit text around @p obj will require their
22553     * own space, which will make @p obj to require more the @p size,
22554     * actually.
22555     *
22556     * @see elm_progressbar_span_size_get()
22557     *
22558     * @ingroup Progressbar
22559     */
22560    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
22561
22562    /**
22563     * Get the length set for the bar region of a given progress bar
22564     * widget
22565     *
22566     * @param obj The progress bar object
22567     * @return The length of the progress bar's bar region
22568     *
22569     * If that size was not set previously, with
22570     * elm_progressbar_span_size_set(), this call will return @c 0.
22571     *
22572     * @ingroup Progressbar
22573     */
22574    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22575
22576    /**
22577     * Set the format string for a given progress bar widget's units
22578     * label
22579     *
22580     * @param obj The progress bar object
22581     * @param format The format string for @p obj's units label
22582     *
22583     * If @c NULL is passed on @p format, it will make @p obj's units
22584     * area to be hidden completely. If not, it'll set the <b>format
22585     * string</b> for the units label's @b text. The units label is
22586     * provided a floating point value, so the units text is up display
22587     * at most one floating point falue. Note that the units label is
22588     * optional. Use a format string such as "%1.2f meters" for
22589     * example.
22590     *
22591     * @note The default format string for a progress bar is an integer
22592     * percentage, as in @c "%.0f %%".
22593     *
22594     * @see elm_progressbar_unit_format_get()
22595     *
22596     * @ingroup Progressbar
22597     */
22598    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
22599
22600    /**
22601     * Retrieve the format string set for a given progress bar widget's
22602     * units label
22603     *
22604     * @param obj The progress bar object
22605     * @return The format set string for @p obj's units label or
22606     * @c NULL, if none was set (and on errors)
22607     *
22608     * @see elm_progressbar_unit_format_set() for more details
22609     *
22610     * @ingroup Progressbar
22611     */
22612    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22613
22614    /**
22615     * Set the orientation of a given progress bar widget
22616     *
22617     * @param obj The progress bar object
22618     * @param horizontal Use @c EINA_TRUE to make @p obj to be
22619     * @b horizontal, @c EINA_FALSE to make it @b vertical
22620     *
22621     * Use this function to change how your progress bar is to be
22622     * disposed: vertically or horizontally.
22623     *
22624     * @see elm_progressbar_horizontal_get()
22625     *
22626     * @ingroup Progressbar
22627     */
22628    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22629
22630    /**
22631     * Retrieve the orientation of a given progress bar widget
22632     *
22633     * @param obj The progress bar object
22634     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22635     * @c EINA_FALSE if it's @b vertical (and on errors)
22636     *
22637     * @see elm_progressbar_horizontal_set() for more details
22638     *
22639     * @ingroup Progressbar
22640     */
22641    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22642
22643    /**
22644     * Invert a given progress bar widget's displaying values order
22645     *
22646     * @param obj The progress bar object
22647     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
22648     * @c EINA_FALSE to bring it back to default, non-inverted values.
22649     *
22650     * A progress bar may be @b inverted, in which state it gets its
22651     * values inverted, with high values being on the left or top and
22652     * low values on the right or bottom, as opposed to normally have
22653     * the low values on the former and high values on the latter,
22654     * respectively, for horizontal and vertical modes.
22655     *
22656     * @see elm_progressbar_inverted_get()
22657     *
22658     * @ingroup Progressbar
22659     */
22660    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
22661
22662    /**
22663     * Get whether a given progress bar widget's displaying values are
22664     * inverted or not
22665     *
22666     * @param obj The progress bar object
22667     * @return @c EINA_TRUE, if @p obj has inverted values,
22668     * @c EINA_FALSE otherwise (and on errors)
22669     *
22670     * @see elm_progressbar_inverted_set() for more details
22671     *
22672     * @ingroup Progressbar
22673     */
22674    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22675
22676    /**
22677     * @defgroup Separator Separator
22678     *
22679     * @brief Separator is a very thin object used to separate other objects.
22680     *
22681     * A separator can be vertical or horizontal.
22682     *
22683     * @ref tutorial_separator is a good example of how to use a separator.
22684     * @{
22685     */
22686    /**
22687     * @brief Add a separator object to @p parent
22688     *
22689     * @param parent The parent object
22690     *
22691     * @return The separator object, or NULL upon failure
22692     */
22693    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22694    /**
22695     * @brief Set the horizontal mode of a separator object
22696     *
22697     * @param obj The separator object
22698     * @param horizontal If true, the separator is horizontal
22699     */
22700    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22701    /**
22702     * @brief Get the horizontal mode of a separator object
22703     *
22704     * @param obj The separator object
22705     * @return If true, the separator is horizontal
22706     *
22707     * @see elm_separator_horizontal_set()
22708     */
22709    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22710    /**
22711     * @}
22712     */
22713
22714    /**
22715     * @defgroup Spinner Spinner
22716     * @ingroup Elementary
22717     *
22718     * @image html img/widget/spinner/preview-00.png
22719     * @image latex img/widget/spinner/preview-00.eps
22720     *
22721     * A spinner is a widget which allows the user to increase or decrease
22722     * numeric values using arrow buttons, or edit values directly, clicking
22723     * over it and typing the new value.
22724     *
22725     * By default the spinner will not wrap and has a label
22726     * of "%.0f" (just showing the integer value of the double).
22727     *
22728     * A spinner has a label that is formatted with floating
22729     * point values and thus accepts a printf-style format string, like
22730     * ā€œ%1.2f unitsā€.
22731     *
22732     * It also allows specific values to be replaced by pre-defined labels.
22733     *
22734     * Smart callbacks one can register to:
22735     *
22736     * - "changed" - Whenever the spinner value is changed.
22737     * - "delay,changed" - A short time after the value is changed by the user.
22738     *    This will be called only when the user stops dragging for a very short
22739     *    period or when they release their finger/mouse, so it avoids possibly
22740     *    expensive reactions to the value change.
22741     *
22742     * Available styles for it:
22743     * - @c "default";
22744     * - @c "vertical": up/down buttons at the right side and text left aligned.
22745     *
22746     * Here is an example on its usage:
22747     * @ref spinner_example
22748     */
22749
22750    /**
22751     * @addtogroup Spinner
22752     * @{
22753     */
22754
22755    /**
22756     * Add a new spinner widget to the given parent Elementary
22757     * (container) object.
22758     *
22759     * @param parent The parent object.
22760     * @return a new spinner widget handle or @c NULL, on errors.
22761     *
22762     * This function inserts a new spinner widget on the canvas.
22763     *
22764     * @ingroup Spinner
22765     *
22766     */
22767    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22768
22769    /**
22770     * Set the format string of the displayed label.
22771     *
22772     * @param obj The spinner object.
22773     * @param fmt The format string for the label display.
22774     *
22775     * If @c NULL, this sets the format to "%.0f". If not it sets the format
22776     * string for the label text. The label text is provided a floating point
22777     * value, so the label text can display up to 1 floating point value.
22778     * Note that this is optional.
22779     *
22780     * Use a format string such as "%1.2f meters" for example, and it will
22781     * display values like: "3.14 meters" for a value equal to 3.14159.
22782     *
22783     * Default is "%0.f".
22784     *
22785     * @see elm_spinner_label_format_get()
22786     *
22787     * @ingroup Spinner
22788     */
22789    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
22790
22791    /**
22792     * Get the label format of the spinner.
22793     *
22794     * @param obj The spinner object.
22795     * @return The text label format string in UTF-8.
22796     *
22797     * @see elm_spinner_label_format_set() for details.
22798     *
22799     * @ingroup Spinner
22800     */
22801    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22802
22803    /**
22804     * Set the minimum and maximum values for the spinner.
22805     *
22806     * @param obj The spinner object.
22807     * @param min The minimum value.
22808     * @param max The maximum value.
22809     *
22810     * Define the allowed range of values to be selected by the user.
22811     *
22812     * If actual value is less than @p min, it will be updated to @p min. If it
22813     * is bigger then @p max, will be updated to @p max. Actual value can be
22814     * get with elm_spinner_value_get().
22815     *
22816     * By default, min is equal to 0, and max is equal to 100.
22817     *
22818     * @warning Maximum must be greater than minimum.
22819     *
22820     * @see elm_spinner_min_max_get()
22821     *
22822     * @ingroup Spinner
22823     */
22824    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
22825
22826    /**
22827     * Get the minimum and maximum values of the spinner.
22828     *
22829     * @param obj The spinner object.
22830     * @param min Pointer where to store the minimum value.
22831     * @param max Pointer where to store the maximum value.
22832     *
22833     * @note If only one value is needed, the other pointer can be passed
22834     * as @c NULL.
22835     *
22836     * @see elm_spinner_min_max_set() for details.
22837     *
22838     * @ingroup Spinner
22839     */
22840    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
22841
22842    /**
22843     * Set the step used to increment or decrement the spinner value.
22844     *
22845     * @param obj The spinner object.
22846     * @param step The step value.
22847     *
22848     * This value will be incremented or decremented to the displayed value.
22849     * It will be incremented while the user keep right or top arrow pressed,
22850     * and will be decremented while the user keep left or bottom arrow pressed.
22851     *
22852     * The interval to increment / decrement can be set with
22853     * elm_spinner_interval_set().
22854     *
22855     * By default step value is equal to 1.
22856     *
22857     * @see elm_spinner_step_get()
22858     *
22859     * @ingroup Spinner
22860     */
22861    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
22862
22863    /**
22864     * Get the step used to increment or decrement the spinner value.
22865     *
22866     * @param obj The spinner object.
22867     * @return The step value.
22868     *
22869     * @see elm_spinner_step_get() for more details.
22870     *
22871     * @ingroup Spinner
22872     */
22873    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22874
22875    /**
22876     * Set the value the spinner displays.
22877     *
22878     * @param obj The spinner object.
22879     * @param val The value to be displayed.
22880     *
22881     * Value will be presented on the label following format specified with
22882     * elm_spinner_format_set().
22883     *
22884     * @warning The value must to be between min and max values. This values
22885     * are set by elm_spinner_min_max_set().
22886     *
22887     * @see elm_spinner_value_get().
22888     * @see elm_spinner_format_set().
22889     * @see elm_spinner_min_max_set().
22890     *
22891     * @ingroup Spinner
22892     */
22893    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
22894
22895    /**
22896     * Get the value displayed by the spinner.
22897     *
22898     * @param obj The spinner object.
22899     * @return The value displayed.
22900     *
22901     * @see elm_spinner_value_set() for details.
22902     *
22903     * @ingroup Spinner
22904     */
22905    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22906
22907    /**
22908     * Set whether the spinner should wrap when it reaches its
22909     * minimum or maximum value.
22910     *
22911     * @param obj The spinner object.
22912     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
22913     * disable it.
22914     *
22915     * Disabled by default. If disabled, when the user tries to increment the
22916     * value,
22917     * but displayed value plus step value is bigger than maximum value,
22918     * the spinner
22919     * won't allow it. The same happens when the user tries to decrement it,
22920     * but the value less step is less than minimum value.
22921     *
22922     * When wrap is enabled, in such situations it will allow these changes,
22923     * but will get the value that would be less than minimum and subtracts
22924     * from maximum. Or add the value that would be more than maximum to
22925     * the minimum.
22926     *
22927     * E.g.:
22928     * @li min value = 10
22929     * @li max value = 50
22930     * @li step value = 20
22931     * @li displayed value = 20
22932     *
22933     * When the user decrement value (using left or bottom arrow), it will
22934     * displays @c 40, because max - (min - (displayed - step)) is
22935     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
22936     *
22937     * @see elm_spinner_wrap_get().
22938     *
22939     * @ingroup Spinner
22940     */
22941    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
22942
22943    /**
22944     * Get whether the spinner should wrap when it reaches its
22945     * minimum or maximum value.
22946     *
22947     * @param obj The spinner object
22948     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
22949     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22950     *
22951     * @see elm_spinner_wrap_set() for details.
22952     *
22953     * @ingroup Spinner
22954     */
22955    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22956
22957    /**
22958     * Set whether the spinner can be directly edited by the user or not.
22959     *
22960     * @param obj The spinner object.
22961     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
22962     * don't allow users to edit it directly.
22963     *
22964     * Spinner objects can have edition @b disabled, in which state they will
22965     * be changed only by arrows.
22966     * Useful for contexts
22967     * where you don't want your users to interact with it writting the value.
22968     * Specially
22969     * when using special values, the user can see real value instead
22970     * of special label on edition.
22971     *
22972     * It's enabled by default.
22973     *
22974     * @see elm_spinner_editable_get()
22975     *
22976     * @ingroup Spinner
22977     */
22978    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22979
22980    /**
22981     * Get whether the spinner can be directly edited by the user or not.
22982     *
22983     * @param obj The spinner object.
22984     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
22985     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22986     *
22987     * @see elm_spinner_editable_set() for details.
22988     *
22989     * @ingroup Spinner
22990     */
22991    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22992
22993    /**
22994     * Set a special string to display in the place of the numerical value.
22995     *
22996     * @param obj The spinner object.
22997     * @param value The value to be replaced.
22998     * @param label The label to be used.
22999     *
23000     * It's useful for cases when a user should select an item that is
23001     * better indicated by a label than a value. For example, weekdays or months.
23002     *
23003     * E.g.:
23004     * @code
23005     * sp = elm_spinner_add(win);
23006     * elm_spinner_min_max_set(sp, 1, 3);
23007     * elm_spinner_special_value_add(sp, 1, "January");
23008     * elm_spinner_special_value_add(sp, 2, "February");
23009     * elm_spinner_special_value_add(sp, 3, "March");
23010     * evas_object_show(sp);
23011     * @endcode
23012     *
23013     * @ingroup Spinner
23014     */
23015    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
23016
23017    /**
23018     * Set the interval on time updates for an user mouse button hold
23019     * on spinner widgets' arrows.
23020     *
23021     * @param obj The spinner object.
23022     * @param interval The (first) interval value in seconds.
23023     *
23024     * This interval value is @b decreased while the user holds the
23025     * mouse pointer either incrementing or decrementing spinner's value.
23026     *
23027     * This helps the user to get to a given value distant from the
23028     * current one easier/faster, as it will start to change quicker and
23029     * quicker on mouse button holds.
23030     *
23031     * The calculation for the next change interval value, starting from
23032     * the one set with this call, is the previous interval divided by
23033     * @c 1.05, so it decreases a little bit.
23034     *
23035     * The default starting interval value for automatic changes is
23036     * @c 0.85 seconds.
23037     *
23038     * @see elm_spinner_interval_get()
23039     *
23040     * @ingroup Spinner
23041     */
23042    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23043
23044    /**
23045     * Get the interval on time updates for an user mouse button hold
23046     * on spinner widgets' arrows.
23047     *
23048     * @param obj The spinner object.
23049     * @return The (first) interval value, in seconds, set on it.
23050     *
23051     * @see elm_spinner_interval_set() for more details.
23052     *
23053     * @ingroup Spinner
23054     */
23055    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23056
23057    /**
23058     * @}
23059     */
23060
23061    /**
23062     * @defgroup Index Index
23063     *
23064     * @image html img/widget/index/preview-00.png
23065     * @image latex img/widget/index/preview-00.eps
23066     *
23067     * An index widget gives you an index for fast access to whichever
23068     * group of other UI items one might have. It's a list of text
23069     * items (usually letters, for alphabetically ordered access).
23070     *
23071     * Index widgets are by default hidden and just appear when the
23072     * user clicks over it's reserved area in the canvas. In its
23073     * default theme, it's an area one @ref Fingers "finger" wide on
23074     * the right side of the index widget's container.
23075     *
23076     * When items on the index are selected, smart callbacks get
23077     * called, so that its user can make other container objects to
23078     * show a given area or child object depending on the index item
23079     * selected. You'd probably be using an index together with @ref
23080     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
23081     * "general grids".
23082     *
23083     * Smart events one  can add callbacks for are:
23084     * - @c "changed" - When the selected index item changes. @c
23085     *      event_info is the selected item's data pointer.
23086     * - @c "delay,changed" - When the selected index item changes, but
23087     *      after a small idling period. @c event_info is the selected
23088     *      item's data pointer.
23089     * - @c "selected" - When the user releases a mouse button and
23090     *      selects an item. @c event_info is the selected item's data
23091     *      pointer.
23092     * - @c "level,up" - when the user moves a finger from the first
23093     *      level to the second level
23094     * - @c "level,down" - when the user moves a finger from the second
23095     *      level to the first level
23096     *
23097     * The @c "delay,changed" event is so that it'll wait a small time
23098     * before actually reporting those events and, moreover, just the
23099     * last event happening on those time frames will actually be
23100     * reported.
23101     *
23102     * Here are some examples on its usage:
23103     * @li @ref index_example_01
23104     * @li @ref index_example_02
23105     */
23106
23107    /**
23108     * @addtogroup Index
23109     * @{
23110     */
23111
23112    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
23113
23114    /**
23115     * Add a new index widget to the given parent Elementary
23116     * (container) object
23117     *
23118     * @param parent The parent object
23119     * @return a new index widget handle or @c NULL, on errors
23120     *
23121     * This function inserts a new index widget on the canvas.
23122     *
23123     * @ingroup Index
23124     */
23125    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23126
23127    /**
23128     * Set whether a given index widget is or not visible,
23129     * programatically.
23130     *
23131     * @param obj The index object
23132     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
23133     *
23134     * Not to be confused with visible as in @c evas_object_show() --
23135     * visible with regard to the widget's auto hiding feature.
23136     *
23137     * @see elm_index_active_get()
23138     *
23139     * @ingroup Index
23140     */
23141    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
23142
23143    /**
23144     * Get whether a given index widget is currently visible or not.
23145     *
23146     * @param obj The index object
23147     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
23148     *
23149     * @see elm_index_active_set() for more details
23150     *
23151     * @ingroup Index
23152     */
23153    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23154
23155    /**
23156     * Set the items level for a given index widget.
23157     *
23158     * @param obj The index object.
23159     * @param level @c 0 or @c 1, the currently implemented levels.
23160     *
23161     * @see elm_index_item_level_get()
23162     *
23163     * @ingroup Index
23164     */
23165    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23166
23167    /**
23168     * Get the items level set for a given index widget.
23169     *
23170     * @param obj The index object.
23171     * @return @c 0 or @c 1, which are the levels @p obj might be at.
23172     *
23173     * @see elm_index_item_level_set() for more information
23174     *
23175     * @ingroup Index
23176     */
23177    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23178
23179    /**
23180     * Returns the last selected item, for a given index widget.
23181     *
23182     * @param obj The index object.
23183     * @return The last item @b selected on @p obj (or @c NULL, on errors).
23184     *
23185     * @ingroup Index
23186     */
23187    EAPI Elm_Index_Item *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23188
23189    /**
23190     * Append a new item on a given index widget.
23191     *
23192     * @param obj The index object.
23193     * @param letter Letter under which the item should be indexed
23194     * @param item The item data to set for the index's item
23195     *
23196     * Despite the most common usage of the @p letter argument is for
23197     * single char strings, one could use arbitrary strings as index
23198     * entries.
23199     *
23200     * @c item will be the pointer returned back on @c "changed", @c
23201     * "delay,changed" and @c "selected" smart events.
23202     *
23203     * @ingroup Index
23204     */
23205    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23206
23207    /**
23208     * Prepend a new item on a given index widget.
23209     *
23210     * @param obj The index object.
23211     * @param letter Letter under which the item should be indexed
23212     * @param item The item data to set for the index's item
23213     *
23214     * Despite the most common usage of the @p letter argument is for
23215     * single char strings, one could use arbitrary strings as index
23216     * entries.
23217     *
23218     * @c item will be the pointer returned back on @c "changed", @c
23219     * "delay,changed" and @c "selected" smart events.
23220     *
23221     * @ingroup Index
23222     */
23223    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
23224
23225    /**
23226     * Append a new item, on a given index widget, <b>after the item
23227     * having @p relative as data</b>.
23228     *
23229     * @param obj The index object.
23230     * @param letter Letter under which the item should be indexed
23231     * @param item The item data to set for the index's item
23232     * @param relative The index item to be the predecessor of this new one
23233     *
23234     * Despite the most common usage of the @p letter argument is for
23235     * single char strings, one could use arbitrary strings as index
23236     * entries.
23237     *
23238     * @c item will be the pointer returned back on @c "changed", @c
23239     * "delay,changed" and @c "selected" smart events.
23240     *
23241     * @note If @p relative is @c NULL this function will behave as
23242     * elm_index_item_append().
23243     *
23244     * @ingroup Index
23245     */
23246    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23247
23248    /**
23249     * Prepend a new item, on a given index widget, <b>after the item
23250     * having @p relative as data</b>.
23251     *
23252     * @param obj The index object.
23253     * @param letter Letter under which the item should be indexed
23254     * @param item The item data to set for the index's item
23255     * @param relative The index item to be the successor of this new one
23256     *
23257     * Despite the most common usage of the @p letter argument is for
23258     * single char strings, one could use arbitrary strings as index
23259     * entries.
23260     *
23261     * @c item will be the pointer returned back on @c "changed", @c
23262     * "delay,changed" and @c "selected" smart events.
23263     *
23264     * @note If @p relative is @c NULL this function will behave as
23265     * elm_index_item_prepend().
23266     *
23267     * @ingroup Index
23268     */
23269    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const Elm_Index_Item *relative) EINA_ARG_NONNULL(1);
23270
23271    /**
23272     * Insert a new item into the given index widget, using @p cmp_func
23273     * function to sort items (by item handles).
23274     *
23275     * @param obj The index object.
23276     * @param letter Letter under which the item should be indexed
23277     * @param item The item data to set for the index's item
23278     * @param cmp_func The comparing function to be used to sort index
23279     * items <b>by #Elm_Index_Item item handles</b>
23280     * @param cmp_data_func A @b fallback function to be called for the
23281     * sorting of index items <b>by item data</b>). It will be used
23282     * when @p cmp_func returns @c 0 (equality), which means an index
23283     * item with provided item data already exists. To decide which
23284     * data item should be pointed to by the index item in question, @p
23285     * cmp_data_func will be used. If @p cmp_data_func returns a
23286     * non-negative value, the previous index item data will be
23287     * replaced by the given @p item pointer. If the previous data need
23288     * to be freed, it should be done by the @p cmp_data_func function,
23289     * because all references to it will be lost. If this function is
23290     * not provided (@c NULL is given), index items will be @b
23291     * duplicated, if @p cmp_func returns @c 0.
23292     *
23293     * Despite the most common usage of the @p letter argument is for
23294     * single char strings, one could use arbitrary strings as index
23295     * entries.
23296     *
23297     * @c item will be the pointer returned back on @c "changed", @c
23298     * "delay,changed" and @c "selected" smart events.
23299     *
23300     * @ingroup Index
23301     */
23302    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);
23303
23304    /**
23305     * Remove an item from a given index widget, <b>to be referenced by
23306     * it's data value</b>.
23307     *
23308     * @param obj The index object
23309     * @param item The item to be removed from @p obj
23310     *
23311     * If a deletion callback is set, via elm_index_item_del_cb_set(),
23312     * that callback function will be called by this one.
23313     *
23314     * @ingroup Index
23315     */
23316    EAPI void            elm_index_item_del(Evas_Object *obj, Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23317
23318    /**
23319     * Find a given index widget's item, <b>using item data</b>.
23320     *
23321     * @param obj The index object
23322     * @param item The item data pointed to by the desired index item
23323     * @return The index item handle, if found, or @c NULL otherwise
23324     *
23325     * @ingroup Index
23326     */
23327    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
23328
23329    /**
23330     * Removes @b all items from a given index widget.
23331     *
23332     * @param obj The index object.
23333     *
23334     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
23335     * that callback function will be called for each item in @p obj.
23336     *
23337     * @ingroup Index
23338     */
23339    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23340
23341    /**
23342     * Go to a given items level on a index widget
23343     *
23344     * @param obj The index object
23345     * @param level The index level (one of @c 0 or @c 1)
23346     *
23347     * @ingroup Index
23348     */
23349    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
23350
23351    /**
23352     * Return the data associated with a given index widget item
23353     *
23354     * @param it The index widget item handle
23355     * @return The data associated with @p it
23356     *
23357     * @see elm_index_item_data_set()
23358     *
23359     * @ingroup Index
23360     */
23361    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23362
23363    /**
23364     * Set the data associated with a given index widget item
23365     *
23366     * @param it The index widget item handle
23367     * @param data The new data pointer to set to @p it
23368     *
23369     * This sets new item data on @p it.
23370     *
23371     * @warning The old data pointer won't be touched by this function, so
23372     * the user had better to free that old data himself/herself.
23373     *
23374     * @ingroup Index
23375     */
23376    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
23377
23378    /**
23379     * Set the function to be called when a given index widget item is freed.
23380     *
23381     * @param it The item to set the callback on
23382     * @param func The function to call on the item's deletion
23383     *
23384     * When called, @p func will have both @c data and @c event_info
23385     * arguments with the @p it item's data value and, naturally, the
23386     * @c obj argument with a handle to the parent index widget.
23387     *
23388     * @ingroup Index
23389     */
23390    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23391
23392    /**
23393     * Get the letter (string) set on a given index widget item.
23394     *
23395     * @param it The index item handle
23396     * @return The letter string set on @p it
23397     *
23398     * @ingroup Index
23399     */
23400    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
23401
23402    /**
23403     * @}
23404     */
23405
23406    /**
23407     * @defgroup Photocam Photocam
23408     *
23409     * @image html img/widget/photocam/preview-00.png
23410     * @image latex img/widget/photocam/preview-00.eps
23411     *
23412     * This is a widget specifically for displaying high-resolution digital
23413     * camera photos giving speedy feedback (fast load), low memory footprint
23414     * and zooming and panning as well as fitting logic. It is entirely focused
23415     * on jpeg images, and takes advantage of properties of the jpeg format (via
23416     * evas loader features in the jpeg loader).
23417     *
23418     * Signals that you can add callbacks for are:
23419     * @li "clicked" - This is called when a user has clicked the photo without
23420     *                 dragging around.
23421     * @li "press" - This is called when a user has pressed down on the photo.
23422     * @li "longpressed" - This is called when a user has pressed down on the
23423     *                     photo for a long time without dragging around.
23424     * @li "clicked,double" - This is called when a user has double-clicked the
23425     *                        photo.
23426     * @li "load" - Photo load begins.
23427     * @li "loaded" - This is called when the image file load is complete for the
23428     *                first view (low resolution blurry version).
23429     * @li "load,detail" - Photo detailed data load begins.
23430     * @li "loaded,detail" - This is called when the image file load is complete
23431     *                      for the detailed image data (full resolution needed).
23432     * @li "zoom,start" - Zoom animation started.
23433     * @li "zoom,stop" - Zoom animation stopped.
23434     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
23435     * @li "scroll" - the content has been scrolled (moved)
23436     * @li "scroll,anim,start" - scrolling animation has started
23437     * @li "scroll,anim,stop" - scrolling animation has stopped
23438     * @li "scroll,drag,start" - dragging the contents around has started
23439     * @li "scroll,drag,stop" - dragging the contents around has stopped
23440     *
23441     * @ref tutorial_photocam shows the API in action.
23442     * @{
23443     */
23444
23445    /**
23446     * @brief Types of zoom available.
23447     */
23448    typedef enum _Elm_Photocam_Zoom_Mode
23449      {
23450         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
23451         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
23452         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
23453         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, /**< Unzoom until photo fits in photocam */
23454         ELM_PHOTOCAM_ZOOM_MODE_LAST
23455      } Elm_Photocam_Zoom_Mode;
23456
23457    /**
23458     * @brief Add a new Photocam object
23459     *
23460     * @param parent The parent object
23461     * @return The new object or NULL if it cannot be created
23462     */
23463    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23464
23465    /**
23466     * @brief Set the photo file to be shown
23467     *
23468     * @param obj The photocam object
23469     * @param file The photo file
23470     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
23471     *
23472     * This sets (and shows) the specified file (with a relative or absolute
23473     * path) and will return a load error (same error that
23474     * evas_object_image_load_error_get() will return). The image will change and
23475     * adjust its size at this point and begin a background load process for this
23476     * photo that at some time in the future will be displayed at the full
23477     * quality needed.
23478     */
23479    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
23480
23481    /**
23482     * @brief Returns the path of the current image file
23483     *
23484     * @param obj The photocam object
23485     * @return Returns the path
23486     *
23487     * @see elm_photocam_file_set()
23488     */
23489    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23490
23491    /**
23492     * @brief Set the zoom level of the photo
23493     *
23494     * @param obj The photocam object
23495     * @param zoom The zoom level to set
23496     *
23497     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
23498     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
23499     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
23500     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
23501     * 16, 32, etc.).
23502     */
23503    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
23504
23505    /**
23506     * @brief Get the zoom level of the photo
23507     *
23508     * @param obj The photocam object
23509     * @return The current zoom level
23510     *
23511     * This returns the current zoom level of the photocam object. Note that if
23512     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
23513     * (which is the default), the zoom level may be changed at any time by the
23514     * photocam object itself to account for photo size and photocam viewpoer
23515     * size.
23516     *
23517     * @see elm_photocam_zoom_set()
23518     * @see elm_photocam_zoom_mode_set()
23519     */
23520    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23521
23522    /**
23523     * @brief Set the zoom mode
23524     *
23525     * @param obj The photocam object
23526     * @param mode The desired mode
23527     *
23528     * This sets the zoom mode to manual or one of several automatic levels.
23529     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
23530     * elm_photocam_zoom_set() and will stay at that level until changed by code
23531     * or until zoom mode is changed. This is the default mode. The Automatic
23532     * modes will allow the photocam object to automatically adjust zoom mode
23533     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
23534     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
23535     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
23536     * pixels within the frame are left unfilled.
23537     */
23538    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23539
23540    /**
23541     * @brief Get the zoom mode
23542     *
23543     * @param obj The photocam object
23544     * @return The current zoom mode
23545     *
23546     * This gets the current zoom mode of the photocam object.
23547     *
23548     * @see elm_photocam_zoom_mode_set()
23549     */
23550    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23551
23552    /**
23553     * @brief Get the current image pixel width and height
23554     *
23555     * @param obj The photocam object
23556     * @param w A pointer to the width return
23557     * @param h A pointer to the height return
23558     *
23559     * This gets the current photo pixel width and height (for the original).
23560     * The size will be returned in the integers @p w and @p h that are pointed
23561     * to.
23562     */
23563    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
23564
23565    /**
23566     * @brief Get the area of the image that is currently shown
23567     *
23568     * @param obj
23569     * @param x A pointer to the X-coordinate of region
23570     * @param y A pointer to the Y-coordinate of region
23571     * @param w A pointer to the width
23572     * @param h A pointer to the height
23573     *
23574     * @see elm_photocam_image_region_show()
23575     * @see elm_photocam_image_region_bring_in()
23576     */
23577    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
23578
23579    /**
23580     * @brief Set the viewed portion of the image
23581     *
23582     * @param obj The photocam object
23583     * @param x X-coordinate of region in image original pixels
23584     * @param y Y-coordinate of region in image original pixels
23585     * @param w Width of region in image original pixels
23586     * @param h Height of region in image original pixels
23587     *
23588     * This shows the region of the image without using animation.
23589     */
23590    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23591
23592    /**
23593     * @brief Bring in the viewed portion of the image
23594     *
23595     * @param obj The photocam object
23596     * @param x X-coordinate of region in image original pixels
23597     * @param y Y-coordinate of region in image original pixels
23598     * @param w Width of region in image original pixels
23599     * @param h Height of region in image original pixels
23600     *
23601     * This shows the region of the image using animation.
23602     */
23603    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
23604
23605    /**
23606     * @brief Set the paused state for photocam
23607     *
23608     * @param obj The photocam object
23609     * @param paused The pause state to set
23610     *
23611     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
23612     * photocam. The default is off. This will stop zooming using animation on
23613     * zoom levels changes and change instantly. This will stop any existing
23614     * animations that are running.
23615     */
23616    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23617
23618    /**
23619     * @brief Get the paused state for photocam
23620     *
23621     * @param obj The photocam object
23622     * @return The current paused state
23623     *
23624     * This gets the current paused state for the photocam object.
23625     *
23626     * @see elm_photocam_paused_set()
23627     */
23628    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23629
23630    /**
23631     * @brief Get the internal low-res image used for photocam
23632     *
23633     * @param obj The photocam object
23634     * @return The internal image object handle, or NULL if none exists
23635     *
23636     * This gets the internal image object inside photocam. Do not modify it. It
23637     * is for inspection only, and hooking callbacks to. Nothing else. It may be
23638     * deleted at any time as well.
23639     */
23640    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23641
23642    /**
23643     * @brief Set the photocam scrolling bouncing.
23644     *
23645     * @param obj The photocam object
23646     * @param h_bounce bouncing for horizontal
23647     * @param v_bounce bouncing for vertical
23648     */
23649    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23650
23651    /**
23652     * @brief Get the photocam scrolling bouncing.
23653     *
23654     * @param obj The photocam object
23655     * @param h_bounce bouncing for horizontal
23656     * @param v_bounce bouncing for vertical
23657     *
23658     * @see elm_photocam_bounce_set()
23659     */
23660    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23661
23662    /**
23663     * @}
23664     */
23665
23666    /**
23667     * @defgroup Map Map
23668     * @ingroup Elementary
23669     *
23670     * @image html img/widget/map/preview-00.png
23671     * @image latex img/widget/map/preview-00.eps
23672     *
23673     * This is a widget specifically for displaying a map. It uses basically
23674     * OpenStreetMap provider http://www.openstreetmap.org/,
23675     * but custom providers can be added.
23676     *
23677     * It supports some basic but yet nice features:
23678     * @li zoom and scroll
23679     * @li markers with content to be displayed when user clicks over it
23680     * @li group of markers
23681     * @li routes
23682     *
23683     * Smart callbacks one can listen to:
23684     *
23685     * - "clicked" - This is called when a user has clicked the map without
23686     *   dragging around.
23687     * - "press" - This is called when a user has pressed down on the map.
23688     * - "longpressed" - This is called when a user has pressed down on the map
23689     *   for a long time without dragging around.
23690     * - "clicked,double" - This is called when a user has double-clicked
23691     *   the map.
23692     * - "load,detail" - Map detailed data load begins.
23693     * - "loaded,detail" - This is called when all currently visible parts of
23694     *   the map are loaded.
23695     * - "zoom,start" - Zoom animation started.
23696     * - "zoom,stop" - Zoom animation stopped.
23697     * - "zoom,change" - Zoom changed when using an auto zoom mode.
23698     * - "scroll" - the content has been scrolled (moved).
23699     * - "scroll,anim,start" - scrolling animation has started.
23700     * - "scroll,anim,stop" - scrolling animation has stopped.
23701     * - "scroll,drag,start" - dragging the contents around has started.
23702     * - "scroll,drag,stop" - dragging the contents around has stopped.
23703     * - "downloaded" - This is called when all currently required map images
23704     *   are downloaded.
23705     * - "route,load" - This is called when route request begins.
23706     * - "route,loaded" - This is called when route request ends.
23707     * - "name,load" - This is called when name request begins.
23708     * - "name,loaded- This is called when name request ends.
23709     *
23710     * Available style for map widget:
23711     * - @c "default"
23712     *
23713     * Available style for markers:
23714     * - @c "radio"
23715     * - @c "radio2"
23716     * - @c "empty"
23717     *
23718     * Available style for marker bubble:
23719     * - @c "default"
23720     *
23721     * List of examples:
23722     * @li @ref map_example_01
23723     * @li @ref map_example_02
23724     * @li @ref map_example_03
23725     */
23726
23727    /**
23728     * @addtogroup Map
23729     * @{
23730     */
23731
23732    /**
23733     * @enum _Elm_Map_Zoom_Mode
23734     * @typedef Elm_Map_Zoom_Mode
23735     *
23736     * Set map's zoom behavior. It can be set to manual or automatic.
23737     *
23738     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
23739     *
23740     * Values <b> don't </b> work as bitmask, only one can be choosen.
23741     *
23742     * @note Valid sizes are 2^zoom, consequently the map may be smaller
23743     * than the scroller view.
23744     *
23745     * @see elm_map_zoom_mode_set()
23746     * @see elm_map_zoom_mode_get()
23747     *
23748     * @ingroup Map
23749     */
23750    typedef enum _Elm_Map_Zoom_Mode
23751      {
23752         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controlled manually by elm_map_zoom_set(). It's set by default. */
23753         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
23754         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
23755         ELM_MAP_ZOOM_MODE_LAST
23756      } Elm_Map_Zoom_Mode;
23757
23758    /**
23759     * @enum _Elm_Map_Route_Sources
23760     * @typedef Elm_Map_Route_Sources
23761     *
23762     * Set route service to be used. By default used source is
23763     * #ELM_MAP_ROUTE_SOURCE_YOURS.
23764     *
23765     * @see elm_map_route_source_set()
23766     * @see elm_map_route_source_get()
23767     *
23768     * @ingroup Map
23769     */
23770    typedef enum _Elm_Map_Route_Sources
23771      {
23772         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
23773         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. */
23774         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
23775         ELM_MAP_ROUTE_SOURCE_LAST
23776      } Elm_Map_Route_Sources;
23777
23778    typedef enum _Elm_Map_Name_Sources
23779      {
23780         ELM_MAP_NAME_SOURCE_NOMINATIM,
23781         ELM_MAP_NAME_SOURCE_LAST
23782      } Elm_Map_Name_Sources;
23783
23784    /**
23785     * @enum _Elm_Map_Route_Type
23786     * @typedef Elm_Map_Route_Type
23787     *
23788     * Set type of transport used on route.
23789     *
23790     * @see elm_map_route_add()
23791     *
23792     * @ingroup Map
23793     */
23794    typedef enum _Elm_Map_Route_Type
23795      {
23796         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
23797         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
23798         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
23799         ELM_MAP_ROUTE_TYPE_LAST
23800      } Elm_Map_Route_Type;
23801
23802    /**
23803     * @enum _Elm_Map_Route_Method
23804     * @typedef Elm_Map_Route_Method
23805     *
23806     * Set the routing method, what should be priorized, time or distance.
23807     *
23808     * @see elm_map_route_add()
23809     *
23810     * @ingroup Map
23811     */
23812    typedef enum _Elm_Map_Route_Method
23813      {
23814         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
23815         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
23816         ELM_MAP_ROUTE_METHOD_LAST
23817      } Elm_Map_Route_Method;
23818
23819    typedef enum _Elm_Map_Name_Method
23820      {
23821         ELM_MAP_NAME_METHOD_SEARCH,
23822         ELM_MAP_NAME_METHOD_REVERSE,
23823         ELM_MAP_NAME_METHOD_LAST
23824      } Elm_Map_Name_Method;
23825
23826    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(). */
23827    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(). */
23828    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(). */
23829    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(). */
23830    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
23831    typedef struct _Elm_Map_Track           Elm_Map_Track;
23832
23833    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. */
23834    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
23835    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
23836    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
23837
23838    typedef char        *(*ElmMapModuleSourceFunc) (void);
23839    typedef int          (*ElmMapModuleZoomMinFunc) (void);
23840    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
23841    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
23842    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
23843    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
23844    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
23845    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
23846    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
23847
23848    /**
23849     * Add a new map widget to the given parent Elementary (container) object.
23850     *
23851     * @param parent The parent object.
23852     * @return a new map widget handle or @c NULL, on errors.
23853     *
23854     * This function inserts a new map widget on the canvas.
23855     *
23856     * @ingroup Map
23857     */
23858    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23859
23860    /**
23861     * Set the zoom level of the map.
23862     *
23863     * @param obj The map object.
23864     * @param zoom The zoom level to set.
23865     *
23866     * This sets the zoom level.
23867     *
23868     * It will respect limits defined by elm_map_source_zoom_min_set() and
23869     * elm_map_source_zoom_max_set().
23870     *
23871     * By default these values are 0 (world map) and 18 (maximum zoom).
23872     *
23873     * This function should be used when zoom mode is set to
23874     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
23875     * with elm_map_zoom_mode_set().
23876     *
23877     * @see elm_map_zoom_mode_set().
23878     * @see elm_map_zoom_get().
23879     *
23880     * @ingroup Map
23881     */
23882    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23883
23884    /**
23885     * Get the zoom level of the map.
23886     *
23887     * @param obj The map object.
23888     * @return The current zoom level.
23889     *
23890     * This returns the current zoom level of the map object.
23891     *
23892     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
23893     * (which is the default), the zoom level may be changed at any time by the
23894     * map object itself to account for map size and map viewport size.
23895     *
23896     * @see elm_map_zoom_set() for details.
23897     *
23898     * @ingroup Map
23899     */
23900    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23901
23902    /**
23903     * Set the zoom mode used by the map object.
23904     *
23905     * @param obj The map object.
23906     * @param mode The zoom mode of the map, being it one of
23907     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23908     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23909     *
23910     * This sets the zoom mode to manual or one of the automatic levels.
23911     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
23912     * elm_map_zoom_set() and will stay at that level until changed by code
23913     * or until zoom mode is changed. This is the default mode.
23914     *
23915     * The Automatic modes will allow the map object to automatically
23916     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
23917     * adjust zoom so the map fits inside the scroll frame with no pixels
23918     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
23919     * ensure no pixels within the frame are left unfilled. Do not forget that
23920     * the valid sizes are 2^zoom, consequently the map may be smaller than
23921     * the scroller view.
23922     *
23923     * @see elm_map_zoom_set()
23924     *
23925     * @ingroup Map
23926     */
23927    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
23928
23929    /**
23930     * Get the zoom mode used by the map object.
23931     *
23932     * @param obj The map object.
23933     * @return The zoom mode of the map, being it one of
23934     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
23935     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
23936     *
23937     * This function returns the current zoom mode used by the map object.
23938     *
23939     * @see elm_map_zoom_mode_set() for more details.
23940     *
23941     * @ingroup Map
23942     */
23943    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23944
23945    /**
23946     * Get the current coordinates of the map.
23947     *
23948     * @param obj The map object.
23949     * @param lon Pointer where to store longitude.
23950     * @param lat Pointer where to store latitude.
23951     *
23952     * This gets the current center coordinates of the map object. It can be
23953     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
23954     *
23955     * @see elm_map_geo_region_bring_in()
23956     * @see elm_map_geo_region_show()
23957     *
23958     * @ingroup Map
23959     */
23960    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
23961
23962    /**
23963     * Animatedly bring in given coordinates to the center of the map.
23964     *
23965     * @param obj The map object.
23966     * @param lon Longitude to center at.
23967     * @param lat Latitude to center at.
23968     *
23969     * This causes map to jump to the given @p lat and @p lon coordinates
23970     * and show it (by scrolling) in the center of the viewport, if it is not
23971     * already centered. This will use animation to do so and take a period
23972     * of time to complete.
23973     *
23974     * @see elm_map_geo_region_show() for a function to avoid animation.
23975     * @see elm_map_geo_region_get()
23976     *
23977     * @ingroup Map
23978     */
23979    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23980
23981    /**
23982     * Show the given coordinates at the center of the map, @b immediately.
23983     *
23984     * @param obj The map object.
23985     * @param lon Longitude to center at.
23986     * @param lat Latitude to center at.
23987     *
23988     * This causes map to @b redraw its viewport's contents to the
23989     * region contining the given @p lat and @p lon, that will be moved to the
23990     * center of the map.
23991     *
23992     * @see elm_map_geo_region_bring_in() for a function to move with animation.
23993     * @see elm_map_geo_region_get()
23994     *
23995     * @ingroup Map
23996     */
23997    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23998
23999    /**
24000     * Pause or unpause the map.
24001     *
24002     * @param obj The map object.
24003     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
24004     * to unpause it.
24005     *
24006     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24007     * for map.
24008     *
24009     * The default is off.
24010     *
24011     * This will stop zooming using animation, changing zoom levels will
24012     * change instantly. This will stop any existing animations that are running.
24013     *
24014     * @see elm_map_paused_get()
24015     *
24016     * @ingroup Map
24017     */
24018    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24019
24020    /**
24021     * Get a value whether map is paused or not.
24022     *
24023     * @param obj The map object.
24024     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
24025     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24026     *
24027     * This gets the current paused state for the map object.
24028     *
24029     * @see elm_map_paused_set() for details.
24030     *
24031     * @ingroup Map
24032     */
24033    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24034
24035    /**
24036     * Set to show markers during zoom level changes or not.
24037     *
24038     * @param obj The map object.
24039     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
24040     * to show them.
24041     *
24042     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24043     * for map.
24044     *
24045     * The default is off.
24046     *
24047     * This will stop zooming using animation, changing zoom levels will
24048     * change instantly. This will stop any existing animations that are running.
24049     *
24050     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
24051     * for the markers.
24052     *
24053     * The default  is off.
24054     *
24055     * Enabling it will force the map to stop displaying the markers during
24056     * zoom level changes. Set to on if you have a large number of markers.
24057     *
24058     * @see elm_map_paused_markers_get()
24059     *
24060     * @ingroup Map
24061     */
24062    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
24063
24064    /**
24065     * Get a value whether markers will be displayed on zoom level changes or not
24066     *
24067     * @param obj The map object.
24068     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
24069     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
24070     *
24071     * This gets the current markers paused state for the map object.
24072     *
24073     * @see elm_map_paused_markers_set() for details.
24074     *
24075     * @ingroup Map
24076     */
24077    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24078
24079    /**
24080     * Get the information of downloading status.
24081     *
24082     * @param obj The map object.
24083     * @param try_num Pointer where to store number of tiles being downloaded.
24084     * @param finish_num Pointer where to store number of tiles successfully
24085     * downloaded.
24086     *
24087     * This gets the current downloading status for the map object, the number
24088     * of tiles being downloaded and the number of tiles already downloaded.
24089     *
24090     * @ingroup Map
24091     */
24092    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
24093
24094    /**
24095     * Convert a pixel coordinate (x,y) into a geographic coordinate
24096     * (longitude, latitude).
24097     *
24098     * @param obj The map object.
24099     * @param x the coordinate.
24100     * @param y the coordinate.
24101     * @param size the size in pixels of the map.
24102     * The map is a square and generally his size is : pow(2.0, zoom)*256.
24103     * @param lon Pointer where to store the longitude that correspond to x.
24104     * @param lat Pointer where to store the latitude that correspond to y.
24105     *
24106     * @note Origin pixel point is the top left corner of the viewport.
24107     * Map zoom and size are taken on account.
24108     *
24109     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
24110     *
24111     * @ingroup Map
24112     */
24113    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);
24114
24115    /**
24116     * Convert a geographic coordinate (longitude, latitude) into a pixel
24117     * coordinate (x, y).
24118     *
24119     * @param obj The map object.
24120     * @param lon the longitude.
24121     * @param lat the latitude.
24122     * @param size the size in pixels of the map. The map is a square
24123     * and generally his size is : pow(2.0, zoom)*256.
24124     * @param x Pointer where to store the horizontal pixel coordinate that
24125     * correspond to the longitude.
24126     * @param y Pointer where to store the vertical pixel coordinate that
24127     * correspond to the latitude.
24128     *
24129     * @note Origin pixel point is the top left corner of the viewport.
24130     * Map zoom and size are taken on account.
24131     *
24132     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
24133     *
24134     * @ingroup Map
24135     */
24136    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);
24137
24138    /**
24139     * Convert a geographic coordinate (longitude, latitude) into a name
24140     * (address).
24141     *
24142     * @param obj The map object.
24143     * @param lon the longitude.
24144     * @param lat the latitude.
24145     * @return name A #Elm_Map_Name handle for this coordinate.
24146     *
24147     * To get the string for this address, elm_map_name_address_get()
24148     * should be used.
24149     *
24150     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
24151     *
24152     * @ingroup Map
24153     */
24154    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
24155
24156    /**
24157     * Convert a name (address) into a geographic coordinate
24158     * (longitude, latitude).
24159     *
24160     * @param obj The map object.
24161     * @param name The address.
24162     * @return name A #Elm_Map_Name handle for this address.
24163     *
24164     * To get the longitude and latitude, elm_map_name_region_get()
24165     * should be used.
24166     *
24167     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
24168     *
24169     * @ingroup Map
24170     */
24171    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
24172
24173    /**
24174     * Convert a pixel coordinate into a rotated pixel coordinate.
24175     *
24176     * @param obj The map object.
24177     * @param x horizontal coordinate of the point to rotate.
24178     * @param y vertical coordinate of the point to rotate.
24179     * @param cx rotation's center horizontal position.
24180     * @param cy rotation's center vertical position.
24181     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
24182     * @param xx Pointer where to store rotated x.
24183     * @param yy Pointer where to store rotated y.
24184     *
24185     * @ingroup Map
24186     */
24187    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);
24188
24189    /**
24190     * Add a new marker to the map object.
24191     *
24192     * @param obj The map object.
24193     * @param lon The longitude of the marker.
24194     * @param lat The latitude of the marker.
24195     * @param clas The class, to use when marker @b isn't grouped to others.
24196     * @param clas_group The class group, to use when marker is grouped to others
24197     * @param data The data passed to the callbacks.
24198     *
24199     * @return The created marker or @c NULL upon failure.
24200     *
24201     * A marker will be created and shown in a specific point of the map, defined
24202     * by @p lon and @p lat.
24203     *
24204     * It will be displayed using style defined by @p class when this marker
24205     * is displayed alone (not grouped). A new class can be created with
24206     * elm_map_marker_class_new().
24207     *
24208     * If the marker is grouped to other markers, it will be displayed with
24209     * style defined by @p class_group. Markers with the same group are grouped
24210     * if they are close. A new group class can be created with
24211     * elm_map_marker_group_class_new().
24212     *
24213     * Markers created with this method can be deleted with
24214     * elm_map_marker_remove().
24215     *
24216     * A marker can have associated content to be displayed by a bubble,
24217     * when a user click over it, as well as an icon. These objects will
24218     * be fetch using class' callback functions.
24219     *
24220     * @see elm_map_marker_class_new()
24221     * @see elm_map_marker_group_class_new()
24222     * @see elm_map_marker_remove()
24223     *
24224     * @ingroup Map
24225     */
24226    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);
24227
24228    /**
24229     * Set the maximum numbers of markers' content to be displayed in a group.
24230     *
24231     * @param obj The map object.
24232     * @param max The maximum numbers of items displayed in a bubble.
24233     *
24234     * A bubble will be displayed when the user clicks over the group,
24235     * and will place the content of markers that belong to this group
24236     * inside it.
24237     *
24238     * A group can have a long list of markers, consequently the creation
24239     * of the content of the bubble can be very slow.
24240     *
24241     * In order to avoid this, a maximum number of items is displayed
24242     * in a bubble.
24243     *
24244     * By default this number is 30.
24245     *
24246     * Marker with the same group class are grouped if they are close.
24247     *
24248     * @see elm_map_marker_add()
24249     *
24250     * @ingroup Map
24251     */
24252    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
24253
24254    /**
24255     * Remove a marker from the map.
24256     *
24257     * @param marker The marker to remove.
24258     *
24259     * @see elm_map_marker_add()
24260     *
24261     * @ingroup Map
24262     */
24263    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24264
24265    /**
24266     * Get the current coordinates of the marker.
24267     *
24268     * @param marker marker.
24269     * @param lat Pointer where to store the marker's latitude.
24270     * @param lon Pointer where to store the marker's longitude.
24271     *
24272     * These values are set when adding markers, with function
24273     * elm_map_marker_add().
24274     *
24275     * @see elm_map_marker_add()
24276     *
24277     * @ingroup Map
24278     */
24279    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
24280
24281    /**
24282     * Animatedly bring in given marker to the center of the map.
24283     *
24284     * @param marker The marker to center at.
24285     *
24286     * This causes map to jump to the given @p marker's coordinates
24287     * and show it (by scrolling) in the center of the viewport, if it is not
24288     * already centered. This will use animation to do so and take a period
24289     * of time to complete.
24290     *
24291     * @see elm_map_marker_show() for a function to avoid animation.
24292     * @see elm_map_marker_region_get()
24293     *
24294     * @ingroup Map
24295     */
24296    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24297
24298    /**
24299     * Show the given marker at the center of the map, @b immediately.
24300     *
24301     * @param marker The marker to center at.
24302     *
24303     * This causes map to @b redraw its viewport's contents to the
24304     * region contining the given @p marker's coordinates, that will be
24305     * moved to the center of the map.
24306     *
24307     * @see elm_map_marker_bring_in() for a function to move with animation.
24308     * @see elm_map_markers_list_show() if more than one marker need to be
24309     * displayed.
24310     * @see elm_map_marker_region_get()
24311     *
24312     * @ingroup Map
24313     */
24314    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24315
24316    /**
24317     * Move and zoom the map to display a list of markers.
24318     *
24319     * @param markers A list of #Elm_Map_Marker handles.
24320     *
24321     * The map will be centered on the center point of the markers in the list.
24322     * Then the map will be zoomed in order to fit the markers using the maximum
24323     * zoom which allows display of all the markers.
24324     *
24325     * @warning All the markers should belong to the same map object.
24326     *
24327     * @see elm_map_marker_show() to show a single marker.
24328     * @see elm_map_marker_bring_in()
24329     *
24330     * @ingroup Map
24331     */
24332    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
24333
24334    /**
24335     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
24336     *
24337     * @param marker The marker wich content should be returned.
24338     * @return Return the evas object if it exists, else @c NULL.
24339     *
24340     * To set callback function #ElmMapMarkerGetFunc for the marker class,
24341     * elm_map_marker_class_get_cb_set() should be used.
24342     *
24343     * This content is what will be inside the bubble that will be displayed
24344     * when an user clicks over the marker.
24345     *
24346     * This returns the actual Evas object used to be placed inside
24347     * the bubble. This may be @c NULL, as it may
24348     * not have been created or may have been deleted, at any time, by
24349     * the map. <b>Do not modify this object</b> (move, resize,
24350     * show, hide, etc.), as the map is controlling it. This
24351     * function is for querying, emitting custom signals or hooking
24352     * lower level callbacks for events on that object. Do not delete
24353     * this object under any circumstances.
24354     *
24355     * @ingroup Map
24356     */
24357    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24358
24359    /**
24360     * Update the marker
24361     *
24362     * @param marker The marker to be updated.
24363     *
24364     * If a content is set to this marker, it will call function to delete it,
24365     * #ElmMapMarkerDelFunc, and then will fetch the content again with
24366     * #ElmMapMarkerGetFunc.
24367     *
24368     * These functions are set for the marker class with
24369     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
24370     *
24371     * @ingroup Map
24372     */
24373    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
24374
24375    /**
24376     * Close all the bubbles opened by the user.
24377     *
24378     * @param obj The map object.
24379     *
24380     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
24381     * when the user clicks on a marker.
24382     *
24383     * This functions is set for the marker class with
24384     * elm_map_marker_class_get_cb_set().
24385     *
24386     * @ingroup Map
24387     */
24388    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
24389
24390    /**
24391     * Create a new group class.
24392     *
24393     * @param obj The map object.
24394     * @return Returns the new group class.
24395     *
24396     * Each marker must be associated to a group class. Markers in the same
24397     * group are grouped if they are close.
24398     *
24399     * The group class defines the style of the marker when a marker is grouped
24400     * to others markers. When it is alone, another class will be used.
24401     *
24402     * A group class will need to be provided when creating a marker with
24403     * elm_map_marker_add().
24404     *
24405     * Some properties and functions can be set by class, as:
24406     * - style, with elm_map_group_class_style_set()
24407     * - data - to be associated to the group class. It can be set using
24408     *   elm_map_group_class_data_set().
24409     * - min zoom to display markers, set with
24410     *   elm_map_group_class_zoom_displayed_set().
24411     * - max zoom to group markers, set using
24412     *   elm_map_group_class_zoom_grouped_set().
24413     * - visibility - set if markers will be visible or not, set with
24414     *   elm_map_group_class_hide_set().
24415     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
24416     *   It can be set using elm_map_group_class_icon_cb_set().
24417     *
24418     * @see elm_map_marker_add()
24419     * @see elm_map_group_class_style_set()
24420     * @see elm_map_group_class_data_set()
24421     * @see elm_map_group_class_zoom_displayed_set()
24422     * @see elm_map_group_class_zoom_grouped_set()
24423     * @see elm_map_group_class_hide_set()
24424     * @see elm_map_group_class_icon_cb_set()
24425     *
24426     * @ingroup Map
24427     */
24428    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24429
24430    /**
24431     * Set the marker's style of a group class.
24432     *
24433     * @param clas The group class.
24434     * @param style The style to be used by markers.
24435     *
24436     * Each marker must be associated to a group class, and will use the style
24437     * defined by such class when grouped to other markers.
24438     *
24439     * The following styles are provided by default theme:
24440     * @li @c radio - blue circle
24441     * @li @c radio2 - green circle
24442     * @li @c empty
24443     *
24444     * @see elm_map_group_class_new() for more details.
24445     * @see elm_map_marker_add()
24446     *
24447     * @ingroup Map
24448     */
24449    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24450
24451    /**
24452     * Set the icon callback function of a group class.
24453     *
24454     * @param clas The group class.
24455     * @param icon_get The callback function that will return the icon.
24456     *
24457     * Each marker must be associated to a group class, and it can display a
24458     * custom icon. The function @p icon_get must return this icon.
24459     *
24460     * @see elm_map_group_class_new() for more details.
24461     * @see elm_map_marker_add()
24462     *
24463     * @ingroup Map
24464     */
24465    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24466
24467    /**
24468     * Set the data associated to the group class.
24469     *
24470     * @param clas The group class.
24471     * @param data The new user data.
24472     *
24473     * This data will be passed for callback functions, like icon get callback,
24474     * that can be set with elm_map_group_class_icon_cb_set().
24475     *
24476     * If a data was previously set, the object will lose the pointer for it,
24477     * so if needs to be freed, you must do it yourself.
24478     *
24479     * @see elm_map_group_class_new() for more details.
24480     * @see elm_map_group_class_icon_cb_set()
24481     * @see elm_map_marker_add()
24482     *
24483     * @ingroup Map
24484     */
24485    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
24486
24487    /**
24488     * Set the minimum zoom from where the markers are displayed.
24489     *
24490     * @param clas The group class.
24491     * @param zoom The minimum zoom.
24492     *
24493     * Markers only will be displayed when the map is displayed at @p zoom
24494     * or bigger.
24495     *
24496     * @see elm_map_group_class_new() for more details.
24497     * @see elm_map_marker_add()
24498     *
24499     * @ingroup Map
24500     */
24501    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24502
24503    /**
24504     * Set the zoom from where the markers are no more grouped.
24505     *
24506     * @param clas The group class.
24507     * @param zoom The maximum zoom.
24508     *
24509     * Markers only will be grouped when the map is displayed at
24510     * less than @p zoom.
24511     *
24512     * @see elm_map_group_class_new() for more details.
24513     * @see elm_map_marker_add()
24514     *
24515     * @ingroup Map
24516     */
24517    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
24518
24519    /**
24520     * Set if the markers associated to the group class @clas are hidden or not.
24521     *
24522     * @param clas The group class.
24523     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
24524     * to show them.
24525     *
24526     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
24527     * is to show them.
24528     *
24529     * @ingroup Map
24530     */
24531    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
24532
24533    /**
24534     * Create a new marker class.
24535     *
24536     * @param obj The map object.
24537     * @return Returns the new group class.
24538     *
24539     * Each marker must be associated to a class.
24540     *
24541     * The marker class defines the style of the marker when a marker is
24542     * displayed alone, i.e., not grouped to to others markers. When grouped
24543     * it will use group class style.
24544     *
24545     * A marker class will need to be provided when creating a marker with
24546     * elm_map_marker_add().
24547     *
24548     * Some properties and functions can be set by class, as:
24549     * - style, with elm_map_marker_class_style_set()
24550     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
24551     *   It can be set using elm_map_marker_class_icon_cb_set().
24552     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
24553     *   Set using elm_map_marker_class_get_cb_set().
24554     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
24555     *   Set using elm_map_marker_class_del_cb_set().
24556     *
24557     * @see elm_map_marker_add()
24558     * @see elm_map_marker_class_style_set()
24559     * @see elm_map_marker_class_icon_cb_set()
24560     * @see elm_map_marker_class_get_cb_set()
24561     * @see elm_map_marker_class_del_cb_set()
24562     *
24563     * @ingroup Map
24564     */
24565    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
24566
24567    /**
24568     * Set the marker's style of a marker class.
24569     *
24570     * @param clas The marker class.
24571     * @param style The style to be used by markers.
24572     *
24573     * Each marker must be associated to a marker class, and will use the style
24574     * defined by such class when alone, i.e., @b not grouped to other markers.
24575     *
24576     * The following styles are provided by default theme:
24577     * @li @c radio
24578     * @li @c radio2
24579     * @li @c empty
24580     *
24581     * @see elm_map_marker_class_new() for more details.
24582     * @see elm_map_marker_add()
24583     *
24584     * @ingroup Map
24585     */
24586    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
24587
24588    /**
24589     * Set the icon callback function of a marker class.
24590     *
24591     * @param clas The marker class.
24592     * @param icon_get The callback function that will return the icon.
24593     *
24594     * Each marker must be associated to a marker class, and it can display a
24595     * custom icon. The function @p icon_get must return this icon.
24596     *
24597     * @see elm_map_marker_class_new() for more details.
24598     * @see elm_map_marker_add()
24599     *
24600     * @ingroup Map
24601     */
24602    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
24603
24604    /**
24605     * Set the bubble content callback function of a marker class.
24606     *
24607     * @param clas The marker class.
24608     * @param get The callback function that will return the content.
24609     *
24610     * Each marker must be associated to a marker class, and it can display a
24611     * a content on a bubble that opens when the user click over the marker.
24612     * The function @p get must return this content object.
24613     *
24614     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
24615     * can be used.
24616     *
24617     * @see elm_map_marker_class_new() for more details.
24618     * @see elm_map_marker_class_del_cb_set()
24619     * @see elm_map_marker_add()
24620     *
24621     * @ingroup Map
24622     */
24623    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
24624
24625    /**
24626     * Set the callback function used to delete bubble content of a marker class.
24627     *
24628     * @param clas The marker class.
24629     * @param del The callback function that will delete the content.
24630     *
24631     * Each marker must be associated to a marker class, and it can display a
24632     * a content on a bubble that opens when the user click over the marker.
24633     * The function to return such content can be set with
24634     * elm_map_marker_class_get_cb_set().
24635     *
24636     * If this content must be freed, a callback function need to be
24637     * set for that task with this function.
24638     *
24639     * If this callback is defined it will have to delete (or not) the
24640     * object inside, but if the callback is not defined the object will be
24641     * destroyed with evas_object_del().
24642     *
24643     * @see elm_map_marker_class_new() for more details.
24644     * @see elm_map_marker_class_get_cb_set()
24645     * @see elm_map_marker_add()
24646     *
24647     * @ingroup Map
24648     */
24649    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
24650
24651    /**
24652     * Get the list of available sources.
24653     *
24654     * @param obj The map object.
24655     * @return The source names list.
24656     *
24657     * It will provide a list with all available sources, that can be set as
24658     * current source with elm_map_source_name_set(), or get with
24659     * elm_map_source_name_get().
24660     *
24661     * Available sources:
24662     * @li "Mapnik"
24663     * @li "Osmarender"
24664     * @li "CycleMap"
24665     * @li "Maplint"
24666     *
24667     * @see elm_map_source_name_set() for more details.
24668     * @see elm_map_source_name_get()
24669     *
24670     * @ingroup Map
24671     */
24672    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24673
24674    /**
24675     * Set the source of the map.
24676     *
24677     * @param obj The map object.
24678     * @param source The source to be used.
24679     *
24680     * Map widget retrieves images that composes the map from a web service.
24681     * This web service can be set with this method.
24682     *
24683     * A different service can return a different maps with different
24684     * information and it can use different zoom values.
24685     *
24686     * The @p source_name need to match one of the names provided by
24687     * elm_map_source_names_get().
24688     *
24689     * The current source can be get using elm_map_source_name_get().
24690     *
24691     * @see elm_map_source_names_get()
24692     * @see elm_map_source_name_get()
24693     *
24694     *
24695     * @ingroup Map
24696     */
24697    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
24698
24699    /**
24700     * Get the name of currently used source.
24701     *
24702     * @param obj The map object.
24703     * @return Returns the name of the source in use.
24704     *
24705     * @see elm_map_source_name_set() for more details.
24706     *
24707     * @ingroup Map
24708     */
24709    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24710
24711    /**
24712     * Set the source of the route service to be used by the map.
24713     *
24714     * @param obj The map object.
24715     * @param source The route service to be used, being it one of
24716     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
24717     * and #ELM_MAP_ROUTE_SOURCE_ORS.
24718     *
24719     * Each one has its own algorithm, so the route retrieved may
24720     * differ depending on the source route. Now, only the default is working.
24721     *
24722     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
24723     * http://www.yournavigation.org/.
24724     *
24725     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
24726     * assumptions. Its routing core is based on Contraction Hierarchies.
24727     *
24728     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
24729     *
24730     * @see elm_map_route_source_get().
24731     *
24732     * @ingroup Map
24733     */
24734    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
24735
24736    /**
24737     * Get the current route source.
24738     *
24739     * @param obj The map object.
24740     * @return The source of the route service used by the map.
24741     *
24742     * @see elm_map_route_source_set() for details.
24743     *
24744     * @ingroup Map
24745     */
24746    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24747
24748    /**
24749     * Set the minimum zoom of the source.
24750     *
24751     * @param obj The map object.
24752     * @param zoom New minimum zoom value to be used.
24753     *
24754     * By default, it's 0.
24755     *
24756     * @ingroup Map
24757     */
24758    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24759
24760    /**
24761     * Get the minimum zoom of the source.
24762     *
24763     * @param obj The map object.
24764     * @return Returns the minimum zoom of the source.
24765     *
24766     * @see elm_map_source_zoom_min_set() for details.
24767     *
24768     * @ingroup Map
24769     */
24770    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24771
24772    /**
24773     * Set the maximum zoom of the source.
24774     *
24775     * @param obj The map object.
24776     * @param zoom New maximum zoom value to be used.
24777     *
24778     * By default, it's 18.
24779     *
24780     * @ingroup Map
24781     */
24782    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
24783
24784    /**
24785     * Get the maximum zoom of the source.
24786     *
24787     * @param obj The map object.
24788     * @return Returns the maximum zoom of the source.
24789     *
24790     * @see elm_map_source_zoom_min_set() for details.
24791     *
24792     * @ingroup Map
24793     */
24794    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24795
24796    /**
24797     * Set the user agent used by the map object to access routing services.
24798     *
24799     * @param obj The map object.
24800     * @param user_agent The user agent to be used by the map.
24801     *
24802     * User agent is a client application implementing a network protocol used
24803     * in communications within a clientā€“server distributed computing system
24804     *
24805     * The @p user_agent identification string will transmitted in a header
24806     * field @c User-Agent.
24807     *
24808     * @see elm_map_user_agent_get()
24809     *
24810     * @ingroup Map
24811     */
24812    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
24813
24814    /**
24815     * Get the user agent used by the map object.
24816     *
24817     * @param obj The map object.
24818     * @return The user agent identification string used by the map.
24819     *
24820     * @see elm_map_user_agent_set() for details.
24821     *
24822     * @ingroup Map
24823     */
24824    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24825
24826    /**
24827     * Add a new route to the map object.
24828     *
24829     * @param obj The map object.
24830     * @param type The type of transport to be considered when tracing a route.
24831     * @param method The routing method, what should be priorized.
24832     * @param flon The start longitude.
24833     * @param flat The start latitude.
24834     * @param tlon The destination longitude.
24835     * @param tlat The destination latitude.
24836     *
24837     * @return The created route or @c NULL upon failure.
24838     *
24839     * A route will be traced by point on coordinates (@p flat, @p flon)
24840     * to point on coordinates (@p tlat, @p tlon), using the route service
24841     * set with elm_map_route_source_set().
24842     *
24843     * It will take @p type on consideration to define the route,
24844     * depending if the user will be walking or driving, the route may vary.
24845     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
24846     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
24847     *
24848     * Another parameter is what the route should priorize, the minor distance
24849     * or the less time to be spend on the route. So @p method should be one
24850     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
24851     *
24852     * Routes created with this method can be deleted with
24853     * elm_map_route_remove(), colored with elm_map_route_color_set(),
24854     * and distance can be get with elm_map_route_distance_get().
24855     *
24856     * @see elm_map_route_remove()
24857     * @see elm_map_route_color_set()
24858     * @see elm_map_route_distance_get()
24859     * @see elm_map_route_source_set()
24860     *
24861     * @ingroup Map
24862     */
24863    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);
24864
24865    /**
24866     * Remove a route from the map.
24867     *
24868     * @param route The route to remove.
24869     *
24870     * @see elm_map_route_add()
24871     *
24872     * @ingroup Map
24873     */
24874    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24875
24876    /**
24877     * Set the route color.
24878     *
24879     * @param route The route object.
24880     * @param r Red channel value, from 0 to 255.
24881     * @param g Green channel value, from 0 to 255.
24882     * @param b Blue channel value, from 0 to 255.
24883     * @param a Alpha channel value, from 0 to 255.
24884     *
24885     * It uses an additive color model, so each color channel represents
24886     * how much of each primary colors must to be used. 0 represents
24887     * ausence of this color, so if all of the three are set to 0,
24888     * the color will be black.
24889     *
24890     * These component values should be integers in the range 0 to 255,
24891     * (single 8-bit byte).
24892     *
24893     * This sets the color used for the route. By default, it is set to
24894     * solid red (r = 255, g = 0, b = 0, a = 255).
24895     *
24896     * For alpha channel, 0 represents completely transparent, and 255, opaque.
24897     *
24898     * @see elm_map_route_color_get()
24899     *
24900     * @ingroup Map
24901     */
24902    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24903
24904    /**
24905     * Get the route color.
24906     *
24907     * @param route The route object.
24908     * @param r Pointer where to store the red channel value.
24909     * @param g Pointer where to store the green channel value.
24910     * @param b Pointer where to store the blue channel value.
24911     * @param a Pointer where to store the alpha channel value.
24912     *
24913     * @see elm_map_route_color_set() for details.
24914     *
24915     * @ingroup Map
24916     */
24917    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24918
24919    /**
24920     * Get the route distance in kilometers.
24921     *
24922     * @param route The route object.
24923     * @return The distance of route (unit : km).
24924     *
24925     * @ingroup Map
24926     */
24927    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24928
24929    /**
24930     * Get the information of route nodes.
24931     *
24932     * @param route The route object.
24933     * @return Returns a string with the nodes of route.
24934     *
24935     * @ingroup Map
24936     */
24937    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24938
24939    /**
24940     * Get the information of route waypoint.
24941     *
24942     * @param route the route object.
24943     * @return Returns a string with information about waypoint of route.
24944     *
24945     * @ingroup Map
24946     */
24947    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
24948
24949    /**
24950     * Get the address of the name.
24951     *
24952     * @param name The name handle.
24953     * @return Returns the address string of @p name.
24954     *
24955     * This gets the coordinates of the @p name, created with one of the
24956     * conversion functions.
24957     *
24958     * @see elm_map_utils_convert_name_into_coord()
24959     * @see elm_map_utils_convert_coord_into_name()
24960     *
24961     * @ingroup Map
24962     */
24963    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24964
24965    /**
24966     * Get the current coordinates of the name.
24967     *
24968     * @param name The name handle.
24969     * @param lat Pointer where to store the latitude.
24970     * @param lon Pointer where to store The longitude.
24971     *
24972     * This gets the coordinates of the @p name, created with one of the
24973     * conversion functions.
24974     *
24975     * @see elm_map_utils_convert_name_into_coord()
24976     * @see elm_map_utils_convert_coord_into_name()
24977     *
24978     * @ingroup Map
24979     */
24980    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
24981
24982    /**
24983     * Remove a name from the map.
24984     *
24985     * @param name The name to remove.
24986     *
24987     * Basically the struct handled by @p name will be freed, so convertions
24988     * between address and coordinates will be lost.
24989     *
24990     * @see elm_map_utils_convert_name_into_coord()
24991     * @see elm_map_utils_convert_coord_into_name()
24992     *
24993     * @ingroup Map
24994     */
24995    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
24996
24997    /**
24998     * Rotate the map.
24999     *
25000     * @param obj The map object.
25001     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
25002     * @param cx Rotation's center horizontal position.
25003     * @param cy Rotation's center vertical position.
25004     *
25005     * @see elm_map_rotate_get()
25006     *
25007     * @ingroup Map
25008     */
25009    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
25010
25011    /**
25012     * Get the rotate degree of the map
25013     *
25014     * @param obj The map object
25015     * @param degree Pointer where to store degrees from 0.0 to 360.0
25016     * to rotate arount Z axis.
25017     * @param cx Pointer where to store rotation's center horizontal position.
25018     * @param cy Pointer where to store rotation's center vertical position.
25019     *
25020     * @see elm_map_rotate_set() to set map rotation.
25021     *
25022     * @ingroup Map
25023     */
25024    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);
25025
25026    /**
25027     * Enable or disable mouse wheel to be used to zoom in / out the map.
25028     *
25029     * @param obj The map object.
25030     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
25031     * to enable it.
25032     *
25033     * Mouse wheel can be used for the user to zoom in or zoom out the map.
25034     *
25035     * It's disabled by default.
25036     *
25037     * @see elm_map_wheel_disabled_get()
25038     *
25039     * @ingroup Map
25040     */
25041    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25042
25043    /**
25044     * Get a value whether mouse wheel is enabled or not.
25045     *
25046     * @param obj The map object.
25047     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
25048     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25049     *
25050     * Mouse wheel can be used for the user to zoom in or zoom out the map.
25051     *
25052     * @see elm_map_wheel_disabled_set() for details.
25053     *
25054     * @ingroup Map
25055     */
25056    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25057
25058 #ifdef ELM_EMAP
25059    /**
25060     * Add a track on the map
25061     *
25062     * @param obj The map object.
25063     * @param emap The emap route object.
25064     * @return The route object. This is an elm object of type Route.
25065     *
25066     * @see elm_route_add() for details.
25067     *
25068     * @ingroup Map
25069     */
25070    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
25071 #endif
25072
25073    /**
25074     * Remove a track from the map
25075     *
25076     * @param obj The map object.
25077     * @param route The track to remove.
25078     *
25079     * @ingroup Map
25080     */
25081    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
25082
25083    /**
25084     * @}
25085     */
25086
25087    /* Route */
25088    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
25089 #ifdef ELM_EMAP
25090    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
25091 #endif
25092    EAPI double elm_route_lon_min_get(Evas_Object *obj);
25093    EAPI double elm_route_lat_min_get(Evas_Object *obj);
25094    EAPI double elm_route_lon_max_get(Evas_Object *obj);
25095    EAPI double elm_route_lat_max_get(Evas_Object *obj);
25096
25097
25098    /**
25099     * @defgroup Panel Panel
25100     *
25101     * @image html img/widget/panel/preview-00.png
25102     * @image latex img/widget/panel/preview-00.eps
25103     *
25104     * @brief A panel is a type of animated container that contains subobjects.
25105     * It can be expanded or contracted by clicking the button on it's edge.
25106     *
25107     * Orientations are as follows:
25108     * @li ELM_PANEL_ORIENT_TOP
25109     * @li ELM_PANEL_ORIENT_LEFT
25110     * @li ELM_PANEL_ORIENT_RIGHT
25111     *
25112     * Default contents parts of the panel widget that you can use for are:
25113     * @li "default" - A content of the panel
25114     *
25115     * @ref tutorial_panel shows one way to use this widget.
25116     * @{
25117     */
25118    typedef enum _Elm_Panel_Orient
25119      {
25120         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
25121         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
25122         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
25123         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
25124      } Elm_Panel_Orient;
25125
25126    /**
25127     * @brief Adds a panel object
25128     *
25129     * @param parent The parent object
25130     *
25131     * @return The panel object, or NULL on failure
25132     */
25133    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25134
25135    /**
25136     * @brief Sets the orientation of the panel
25137     *
25138     * @param parent The parent object
25139     * @param orient The panel orientation. Can be one of the following:
25140     * @li ELM_PANEL_ORIENT_TOP
25141     * @li ELM_PANEL_ORIENT_LEFT
25142     * @li ELM_PANEL_ORIENT_RIGHT
25143     *
25144     * Sets from where the panel will (dis)appear.
25145     */
25146    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
25147
25148    /**
25149     * @brief Get the orientation of the panel.
25150     *
25151     * @param obj The panel object
25152     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
25153     */
25154    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25155
25156    /**
25157     * @brief Set the content of the panel.
25158     *
25159     * @param obj The panel object
25160     * @param content The panel content
25161     *
25162     * Once the content object is set, a previously set one will be deleted.
25163     * If you want to keep that old content object, use the
25164     * elm_panel_content_unset() function.
25165     *
25166     * @deprecated use elm_object_content_set() instead
25167     *
25168     */
25169    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25170
25171    /**
25172     * @brief Get the content of the panel.
25173     *
25174     * @param obj The panel object
25175     * @return The content that is being used
25176     *
25177     * Return the content object which is set for this widget.
25178     *
25179     * @see elm_panel_content_set()
25180     *
25181     * @deprecated use elm_object_content_get() instead
25182     *
25183     */
25184    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25185
25186    /**
25187     * @brief Unset the content of the panel.
25188     *
25189     * @param obj The panel object
25190     * @return The content that was being used
25191     *
25192     * Unparent and return the content object which was set for this widget.
25193     *
25194     * @see elm_panel_content_set()
25195     *
25196     * @deprecated use elm_object_content_unset() instead
25197     *
25198     */
25199    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25200
25201    /**
25202     * @brief Set the state of the panel.
25203     *
25204     * @param obj The panel object
25205     * @param hidden If true, the panel will run the animation to contract
25206     */
25207    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
25208
25209    /**
25210     * @brief Get the state of the panel.
25211     *
25212     * @param obj The panel object
25213     * @param hidden If true, the panel is in the "hide" state
25214     */
25215    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25216
25217    /**
25218     * @brief Toggle the hidden state of the panel from code
25219     *
25220     * @param obj The panel object
25221     */
25222    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
25223
25224    /**
25225     * @}
25226     */
25227
25228    /**
25229     * @defgroup Panes Panes
25230     * @ingroup Elementary
25231     *
25232     * @image html img/widget/panes/preview-00.png
25233     * @image latex img/widget/panes/preview-00.eps width=\textwidth
25234     *
25235     * @image html img/panes.png
25236     * @image latex img/panes.eps width=\textwidth
25237     *
25238     * The panes adds a dragable bar between two contents. When dragged
25239     * this bar will resize contents size.
25240     *
25241     * Panes can be displayed vertically or horizontally, and contents
25242     * size proportion can be customized (homogeneous by default).
25243     *
25244     * Smart callbacks one can listen to:
25245     * - "press" - The panes has been pressed (button wasn't released yet).
25246     * - "unpressed" - The panes was released after being pressed.
25247     * - "clicked" - The panes has been clicked>
25248     * - "clicked,double" - The panes has been double clicked
25249     *
25250     * Available styles for it:
25251     * - @c "default"
25252     *
25253     * Default contents parts of the panes widget that you can use for are:
25254     * @li "left" - A leftside content of the panes
25255     * @li "right" - A rightside content of the panes
25256     *
25257     * If panes is displayed vertically, left content will be displayed at
25258     * top.
25259     *
25260     * Here is an example on its usage:
25261     * @li @ref panes_example
25262     */
25263
25264    /**
25265     * @addtogroup Panes
25266     * @{
25267     */
25268
25269    /**
25270     * Add a new panes widget to the given parent Elementary
25271     * (container) object.
25272     *
25273     * @param parent The parent object.
25274     * @return a new panes widget handle or @c NULL, on errors.
25275     *
25276     * This function inserts a new panes widget on the canvas.
25277     *
25278     * @ingroup Panes
25279     */
25280    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25281
25282    /**
25283     * Set the left content of the panes widget.
25284     *
25285     * @param obj The panes object.
25286     * @param content The new left content object.
25287     *
25288     * Once the content object is set, a previously set one will be deleted.
25289     * If you want to keep that old content object, use the
25290     * elm_panes_content_left_unset() function.
25291     *
25292     * If panes is displayed vertically, left content will be displayed at
25293     * top.
25294     *
25295     * @see elm_panes_content_left_get()
25296     * @see elm_panes_content_right_set() to set content on the other side.
25297     *
25298     * @deprecated use elm_object_part_content_set() instead
25299     *
25300     * @ingroup Panes
25301     */
25302    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25303
25304    /**
25305     * Set the right content of the panes widget.
25306     *
25307     * @param obj The panes object.
25308     * @param content The new right content object.
25309     *
25310     * Once the content object is set, a previously set one will be deleted.
25311     * If you want to keep that old content object, use the
25312     * elm_panes_content_right_unset() function.
25313     *
25314     * If panes is displayed vertically, left content will be displayed at
25315     * bottom.
25316     *
25317     * @see elm_panes_content_right_get()
25318     * @see elm_panes_content_left_set() to set content on the other side.
25319     *
25320     * @deprecated use elm_object_part_content_set() instead
25321     *
25322     * @ingroup Panes
25323     */
25324    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25325
25326    /**
25327     * Get the left content of the panes.
25328     *
25329     * @param obj The panes object.
25330     * @return The left content object that is being used.
25331     *
25332     * Return the left content object which is set for this widget.
25333     *
25334     * @see elm_panes_content_left_set() for details.
25335     *
25336     * @deprecated use elm_object_part_content_get() instead
25337     *
25338     * @ingroup Panes
25339     */
25340    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25341
25342    /**
25343     * Get the right content of the panes.
25344     *
25345     * @param obj The panes object
25346     * @return The right content object that is being used
25347     *
25348     * Return the right content object which is set for this widget.
25349     *
25350     * @see elm_panes_content_right_set() for details.
25351     *
25352     * @deprecated use elm_object_part_content_get() instead
25353     *
25354     * @ingroup Panes
25355     */
25356    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25357
25358    /**
25359     * Unset the left content used for the panes.
25360     *
25361     * @param obj The panes object.
25362     * @return The left content object that was being used.
25363     *
25364     * Unparent and return the left content object which was set for this widget.
25365     *
25366     * @see elm_panes_content_left_set() for details.
25367     * @see elm_panes_content_left_get().
25368     *
25369     * @deprecated use elm_object_part_content_unset() instead
25370     *
25371     * @ingroup Panes
25372     */
25373    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25374
25375    /**
25376     * Unset the right content used for the panes.
25377     *
25378     * @param obj The panes object.
25379     * @return The right content object that was being used.
25380     *
25381     * Unparent and return the right content object which was set for this
25382     * widget.
25383     *
25384     * @see elm_panes_content_right_set() for details.
25385     * @see elm_panes_content_right_get().
25386     *
25387     * @deprecated use elm_object_part_content_unset() instead
25388     *
25389     * @ingroup Panes
25390     */
25391    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25392
25393    /**
25394     * Get the size proportion of panes widget's left side.
25395     *
25396     * @param obj The panes object.
25397     * @return float value between 0.0 and 1.0 representing size proportion
25398     * of left side.
25399     *
25400     * @see elm_panes_content_left_size_set() for more details.
25401     *
25402     * @ingroup Panes
25403     */
25404    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25405
25406    /**
25407     * Set the size proportion of panes widget's left side.
25408     *
25409     * @param obj The panes object.
25410     * @param size Value between 0.0 and 1.0 representing size proportion
25411     * of left side.
25412     *
25413     * By default it's homogeneous, i.e., both sides have the same size.
25414     *
25415     * If something different is required, it can be set with this function.
25416     * For example, if the left content should be displayed over
25417     * 75% of the panes size, @p size should be passed as @c 0.75.
25418     * This way, right content will be resized to 25% of panes size.
25419     *
25420     * If displayed vertically, left content is displayed at top, and
25421     * right content at bottom.
25422     *
25423     * @note This proportion will change when user drags the panes bar.
25424     *
25425     * @see elm_panes_content_left_size_get()
25426     *
25427     * @ingroup Panes
25428     */
25429    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
25430
25431   /**
25432    * Set the orientation of a given panes widget.
25433    *
25434    * @param obj The panes object.
25435    * @param horizontal Use @c EINA_TRUE to make @p obj to be
25436    * @b horizontal, @c EINA_FALSE to make it @b vertical.
25437    *
25438    * Use this function to change how your panes is to be
25439    * disposed: vertically or horizontally.
25440    *
25441    * By default it's displayed horizontally.
25442    *
25443    * @see elm_panes_horizontal_get()
25444    *
25445    * @ingroup Panes
25446    */
25447    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25448
25449    /**
25450     * Retrieve the orientation of a given panes widget.
25451     *
25452     * @param obj The panes object.
25453     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
25454     * @c EINA_FALSE if it's @b vertical (and on errors).
25455     *
25456     * @see elm_panes_horizontal_set() for more details.
25457     *
25458     * @ingroup Panes
25459     */
25460    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25461    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
25462    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25463
25464    /**
25465     * @}
25466     */
25467
25468    /**
25469     * @defgroup Flip Flip
25470     *
25471     * @image html img/widget/flip/preview-00.png
25472     * @image latex img/widget/flip/preview-00.eps
25473     *
25474     * This widget holds 2 content objects(Evas_Object): one on the front and one
25475     * on the back. It allows you to flip from front to back and vice-versa using
25476     * various animations.
25477     *
25478     * If either the front or back contents are not set the flip will treat that
25479     * as transparent. So if you wore to set the front content but not the back,
25480     * and then call elm_flip_go() you would see whatever is below the flip.
25481     *
25482     * For a list of supported animations see elm_flip_go().
25483     *
25484     * Signals that you can add callbacks for are:
25485     * "animate,begin" - when a flip animation was started
25486     * "animate,done" - when a flip animation is finished
25487     *
25488     * @ref tutorial_flip show how to use most of the API.
25489     *
25490     * @{
25491     */
25492    typedef enum _Elm_Flip_Mode
25493      {
25494         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
25495         ELM_FLIP_ROTATE_X_CENTER_AXIS,
25496         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
25497         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
25498         ELM_FLIP_CUBE_LEFT,
25499         ELM_FLIP_CUBE_RIGHT,
25500         ELM_FLIP_CUBE_UP,
25501         ELM_FLIP_CUBE_DOWN,
25502         ELM_FLIP_PAGE_LEFT,
25503         ELM_FLIP_PAGE_RIGHT,
25504         ELM_FLIP_PAGE_UP,
25505         ELM_FLIP_PAGE_DOWN
25506      } Elm_Flip_Mode;
25507    typedef enum _Elm_Flip_Interaction
25508      {
25509         ELM_FLIP_INTERACTION_NONE,
25510         ELM_FLIP_INTERACTION_ROTATE,
25511         ELM_FLIP_INTERACTION_CUBE,
25512         ELM_FLIP_INTERACTION_PAGE
25513      } Elm_Flip_Interaction;
25514    typedef enum _Elm_Flip_Direction
25515      {
25516         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
25517         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
25518         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
25519         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
25520      } Elm_Flip_Direction;
25521
25522    /**
25523     * @brief Add a new flip to the parent
25524     *
25525     * @param parent The parent object
25526     * @return The new object or NULL if it cannot be created
25527     */
25528    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25529
25530    /**
25531     * @brief Set the front content of the flip widget.
25532     *
25533     * @param obj The flip object
25534     * @param content The new front content object
25535     *
25536     * Once the content object is set, a previously set one will be deleted.
25537     * If you want to keep that old content object, use the
25538     * elm_flip_content_front_unset() function.
25539     */
25540    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25541
25542    /**
25543     * @brief Set the back content of the flip widget.
25544     *
25545     * @param obj The flip object
25546     * @param content The new back content object
25547     *
25548     * Once the content object is set, a previously set one will be deleted.
25549     * If you want to keep that old content object, use the
25550     * elm_flip_content_back_unset() function.
25551     */
25552    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25553
25554    /**
25555     * @brief Get the front content used for the flip
25556     *
25557     * @param obj The flip object
25558     * @return The front content object that is being used
25559     *
25560     * Return the front content object which is set for this widget.
25561     */
25562    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25563
25564    /**
25565     * @brief Get the back content used for the flip
25566     *
25567     * @param obj The flip object
25568     * @return The back content object that is being used
25569     *
25570     * Return the back content object which is set for this widget.
25571     */
25572    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25573
25574    /**
25575     * @brief Unset the front content used for the flip
25576     *
25577     * @param obj The flip object
25578     * @return The front content object that was being used
25579     *
25580     * Unparent and return the front content object which was set for this widget.
25581     */
25582    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25583
25584    /**
25585     * @brief Unset the back content used for the flip
25586     *
25587     * @param obj The flip object
25588     * @return The back content object that was being used
25589     *
25590     * Unparent and return the back content object which was set for this widget.
25591     */
25592    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25593
25594    /**
25595     * @brief Get flip front visibility state
25596     *
25597     * @param obj The flip objct
25598     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
25599     * showing.
25600     */
25601    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25602
25603    /**
25604     * @brief Set flip perspective
25605     *
25606     * @param obj The flip object
25607     * @param foc The coordinate to set the focus on
25608     * @param x The X coordinate
25609     * @param y The Y coordinate
25610     *
25611     * @warning This function currently does nothing.
25612     */
25613    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
25614
25615    /**
25616     * @brief Runs the flip animation
25617     *
25618     * @param obj The flip object
25619     * @param mode The mode type
25620     *
25621     * Flips the front and back contents using the @p mode animation. This
25622     * efectively hides the currently visible content and shows the hidden one.
25623     *
25624     * There a number of possible animations to use for the flipping:
25625     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
25626     * around a horizontal axis in the middle of its height, the other content
25627     * is shown as the other side of the flip.
25628     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
25629     * around a vertical axis in the middle of its width, the other content is
25630     * shown as the other side of the flip.
25631     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
25632     * around a diagonal axis in the middle of its width, the other content is
25633     * shown as the other side of the flip.
25634     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
25635     * around a diagonal axis in the middle of its height, the other content is
25636     * shown as the other side of the flip.
25637     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
25638     * as if the flip was a cube, the other content is show as the right face of
25639     * the cube.
25640     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
25641     * right as if the flip was a cube, the other content is show as the left
25642     * face of the cube.
25643     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
25644     * flip was a cube, the other content is show as the bottom face of the cube.
25645     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
25646     * the flip was a cube, the other content is show as the upper face of the
25647     * cube.
25648     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
25649     * if the flip was a book, the other content is shown as the page below that.
25650     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
25651     * as if the flip was a book, the other content is shown as the page below
25652     * that.
25653     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
25654     * flip was a book, the other content is shown as the page below that.
25655     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
25656     * flip was a book, the other content is shown as the page below that.
25657     *
25658     * @image html elm_flip.png
25659     * @image latex elm_flip.eps width=\textwidth
25660     */
25661    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
25662
25663    /**
25664     * @brief Set the interactive flip mode
25665     *
25666     * @param obj The flip object
25667     * @param mode The interactive flip mode to use
25668     *
25669     * This sets if the flip should be interactive (allow user to click and
25670     * drag a side of the flip to reveal the back page and cause it to flip).
25671     * By default a flip is not interactive. You may also need to set which
25672     * sides of the flip are "active" for flipping and how much space they use
25673     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
25674     * and elm_flip_interacton_direction_hitsize_set()
25675     *
25676     * The four avilable mode of interaction are:
25677     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
25678     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
25679     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
25680     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
25681     *
25682     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
25683     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
25684     * happen, those can only be acheived with elm_flip_go();
25685     */
25686    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
25687
25688    /**
25689     * @brief Get the interactive flip mode
25690     *
25691     * @param obj The flip object
25692     * @return The interactive flip mode
25693     *
25694     * Returns the interactive flip mode set by elm_flip_interaction_set()
25695     */
25696    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
25697
25698    /**
25699     * @brief Set which directions of the flip respond to interactive flip
25700     *
25701     * @param obj The flip object
25702     * @param dir The direction to change
25703     * @param enabled If that direction is enabled or not
25704     *
25705     * By default all directions are disabled, so you may want to enable the
25706     * desired directions for flipping if you need interactive flipping. You must
25707     * call this function once for each direction that should be enabled.
25708     *
25709     * @see elm_flip_interaction_set()
25710     */
25711    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
25712
25713    /**
25714     * @brief Get the enabled state of that flip direction
25715     *
25716     * @param obj The flip object
25717     * @param dir The direction to check
25718     * @return If that direction is enabled or not
25719     *
25720     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
25721     *
25722     * @see elm_flip_interaction_set()
25723     */
25724    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
25725
25726    /**
25727     * @brief Set the amount of the flip that is sensitive to interactive flip
25728     *
25729     * @param obj The flip object
25730     * @param dir The direction to modify
25731     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
25732     *
25733     * Set the amount of the flip that is sensitive to interactive flip, with 0
25734     * representing no area in the flip and 1 representing the entire flip. There
25735     * is however a consideration to be made in that the area will never be
25736     * smaller than the finger size set(as set in your Elementary configuration).
25737     *
25738     * @see elm_flip_interaction_set()
25739     */
25740    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
25741
25742    /**
25743     * @brief Get the amount of the flip that is sensitive to interactive flip
25744     *
25745     * @param obj The flip object
25746     * @param dir The direction to check
25747     * @return The size set for that direction
25748     *
25749     * Returns the amount os sensitive area set by
25750     * elm_flip_interacton_direction_hitsize_set().
25751     */
25752    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
25753
25754    /**
25755     * @}
25756     */
25757
25758    /* scrolledentry */
25759    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25760    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
25761    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25762    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
25763    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25764    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25765    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25766    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25767    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25768    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25769    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
25770    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
25771    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
25772    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25773    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
25774    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
25775    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25776    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25777    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
25778    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
25779    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25780    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25781    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25782    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
25783    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
25784    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
25785    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25786    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25787    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25788    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25789    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25790    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
25791    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
25792    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
25793    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25794    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);
25795    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25796    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25797    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);
25798    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25799    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);
25800    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
25801    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25802    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25803    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25804    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
25805    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25806    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25807    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
25808    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);
25809    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);
25810    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);
25811    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);
25812    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);
25813    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);
25814    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
25815    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
25816    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
25817    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
25818    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25819    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
25820    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
25821
25822    /**
25823     * @defgroup Conformant Conformant
25824     * @ingroup Elementary
25825     *
25826     * @image html img/widget/conformant/preview-00.png
25827     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
25828     *
25829     * @image html img/conformant.png
25830     * @image latex img/conformant.eps width=\textwidth
25831     *
25832     * The aim is to provide a widget that can be used in elementary apps to
25833     * account for space taken up by the indicator, virtual keypad & softkey
25834     * windows when running the illume2 module of E17.
25835     *
25836     * So conformant content will be sized and positioned considering the
25837     * space required for such stuff, and when they popup, as a keyboard
25838     * shows when an entry is selected, conformant content won't change.
25839     *
25840     * Available styles for it:
25841     * - @c "default"
25842     *
25843     * Default contents parts of the conformant widget that you can use for are:
25844     * @li "default" - A content of the conformant
25845     *
25846     * See how to use this widget in this example:
25847     * @ref conformant_example
25848     */
25849
25850    /**
25851     * @addtogroup Conformant
25852     * @{
25853     */
25854
25855    /**
25856     * Add a new conformant widget to the given parent Elementary
25857     * (container) object.
25858     *
25859     * @param parent The parent object.
25860     * @return A new conformant widget handle or @c NULL, on errors.
25861     *
25862     * This function inserts a new conformant widget on the canvas.
25863     *
25864     * @ingroup Conformant
25865     */
25866    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25867
25868    /**
25869     * Set the content of the conformant widget.
25870     *
25871     * @param obj The conformant object.
25872     * @param content The content to be displayed by the conformant.
25873     *
25874     * Content will be sized and positioned considering the space required
25875     * to display a virtual keyboard. So it won't fill all the conformant
25876     * size. This way is possible to be sure that content won't resize
25877     * or be re-positioned after the keyboard is displayed.
25878     *
25879     * Once the content object is set, a previously set one will be deleted.
25880     * If you want to keep that old content object, use the
25881     * elm_object_content_unset() function.
25882     *
25883     * @see elm_object_content_unset()
25884     * @see elm_object_content_get()
25885     *
25886     * @deprecated use elm_object_content_set() instead
25887     *
25888     * @ingroup Conformant
25889     */
25890    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25891
25892    /**
25893     * Get the content of the conformant widget.
25894     *
25895     * @param obj The conformant object.
25896     * @return The content that is being used.
25897     *
25898     * Return the content object which is set for this widget.
25899     * It won't be unparent from conformant. For that, use
25900     * elm_object_content_unset().
25901     *
25902     * @see elm_object_content_set().
25903     * @see elm_object_content_unset()
25904     *
25905     * @deprecated use elm_object_content_get() instead
25906     *
25907     * @ingroup Conformant
25908     */
25909    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25910
25911    /**
25912     * Unset the content of the conformant widget.
25913     *
25914     * @param obj The conformant object.
25915     * @return The content that was being used.
25916     *
25917     * Unparent and return the content object which was set for this widget.
25918     *
25919     * @see elm_object_content_set().
25920     *
25921     * @deprecated use elm_object_content_unset() instead
25922     *
25923     * @ingroup Conformant
25924     */
25925    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25926
25927    /**
25928     * Returns the Evas_Object that represents the content area.
25929     *
25930     * @param obj The conformant object.
25931     * @return The content area of the widget.
25932     *
25933     * @ingroup Conformant
25934     */
25935    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25936
25937    /**
25938     * @}
25939     */
25940
25941    /**
25942     * @defgroup Mapbuf Mapbuf
25943     * @ingroup Elementary
25944     *
25945     * @image html img/widget/mapbuf/preview-00.png
25946     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
25947     *
25948     * This holds one content object and uses an Evas Map of transformation
25949     * points to be later used with this content. So the content will be
25950     * moved, resized, etc as a single image. So it will improve performance
25951     * when you have a complex interafce, with a lot of elements, and will
25952     * need to resize or move it frequently (the content object and its
25953     * children).
25954     *
25955     * Default contents parts of the mapbuf widget that you can use for are:
25956     * @li "default" - A content of the mapbuf
25957     *
25958     * To enable map, elm_mapbuf_enabled_set() should be used.
25959     *
25960     * See how to use this widget in this example:
25961     * @ref mapbuf_example
25962     */
25963
25964    /**
25965     * @addtogroup Mapbuf
25966     * @{
25967     */
25968
25969    /**
25970     * Add a new mapbuf widget to the given parent Elementary
25971     * (container) object.
25972     *
25973     * @param parent The parent object.
25974     * @return A new mapbuf widget handle or @c NULL, on errors.
25975     *
25976     * This function inserts a new mapbuf widget on the canvas.
25977     *
25978     * @ingroup Mapbuf
25979     */
25980    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25981
25982    /**
25983     * Set the content of the mapbuf.
25984     *
25985     * @param obj The mapbuf object.
25986     * @param content The content that will be filled in this mapbuf object.
25987     *
25988     * Once the content object is set, a previously set one will be deleted.
25989     * If you want to keep that old content object, use the
25990     * elm_mapbuf_content_unset() function.
25991     *
25992     * To enable map, elm_mapbuf_enabled_set() should be used.
25993     *
25994     * @deprecated use elm_object_content_set() instead
25995     *
25996     * @ingroup Mapbuf
25997     */
25998    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
25999
26000    /**
26001     * Get the content of the mapbuf.
26002     *
26003     * @param obj The mapbuf object.
26004     * @return The content that is being used.
26005     *
26006     * Return the content object which is set for this widget.
26007     *
26008     * @see elm_mapbuf_content_set() for details.
26009     *
26010     * @deprecated use elm_object_content_get() instead
26011     *
26012     * @ingroup Mapbuf
26013     */
26014    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26015
26016    /**
26017     * Unset the content of the mapbuf.
26018     *
26019     * @param obj The mapbuf object.
26020     * @return The content that was being used.
26021     *
26022     * Unparent and return the content object which was set for this widget.
26023     *
26024     * @see elm_mapbuf_content_set() for details.
26025     *
26026     * @deprecated use elm_object_content_unset() instead
26027     *
26028     * @ingroup Mapbuf
26029     */
26030    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26031
26032    /**
26033     * Enable or disable the map.
26034     *
26035     * @param obj The mapbuf object.
26036     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
26037     *
26038     * This enables the map that is set or disables it. On enable, the object
26039     * geometry will be saved, and the new geometry will change (position and
26040     * size) to reflect the map geometry set.
26041     *
26042     * Also, when enabled, alpha and smooth states will be used, so if the
26043     * content isn't solid, alpha should be enabled, for example, otherwise
26044     * a black retangle will fill the content.
26045     *
26046     * When disabled, the stored map will be freed and geometry prior to
26047     * enabling the map will be restored.
26048     *
26049     * It's disabled by default.
26050     *
26051     * @see elm_mapbuf_alpha_set()
26052     * @see elm_mapbuf_smooth_set()
26053     *
26054     * @ingroup Mapbuf
26055     */
26056    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26057
26058    /**
26059     * Get a value whether map is enabled or not.
26060     *
26061     * @param obj The mapbuf object.
26062     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
26063     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26064     *
26065     * @see elm_mapbuf_enabled_set() for details.
26066     *
26067     * @ingroup Mapbuf
26068     */
26069    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26070
26071    /**
26072     * Enable or disable smooth map rendering.
26073     *
26074     * @param obj The mapbuf object.
26075     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
26076     * to disable it.
26077     *
26078     * This sets smoothing for map rendering. If the object is a type that has
26079     * its own smoothing settings, then both the smooth settings for this object
26080     * and the map must be turned off.
26081     *
26082     * By default smooth maps are enabled.
26083     *
26084     * @ingroup Mapbuf
26085     */
26086    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
26087
26088    /**
26089     * Get a value whether smooth map rendering is enabled or not.
26090     *
26091     * @param obj The mapbuf object.
26092     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
26093     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26094     *
26095     * @see elm_mapbuf_smooth_set() for details.
26096     *
26097     * @ingroup Mapbuf
26098     */
26099    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26100
26101    /**
26102     * Set or unset alpha flag for map rendering.
26103     *
26104     * @param obj The mapbuf object.
26105     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
26106     * to disable it.
26107     *
26108     * This sets alpha flag for map rendering. If the object is a type that has
26109     * its own alpha settings, then this will take precedence. Only image objects
26110     * have this currently. It stops alpha blending of the map area, and is
26111     * useful if you know the object and/or all sub-objects is 100% solid.
26112     *
26113     * Alpha is enabled by default.
26114     *
26115     * @ingroup Mapbuf
26116     */
26117    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
26118
26119    /**
26120     * Get a value whether alpha blending is enabled or not.
26121     *
26122     * @param obj The mapbuf object.
26123     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
26124     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
26125     *
26126     * @see elm_mapbuf_alpha_set() for details.
26127     *
26128     * @ingroup Mapbuf
26129     */
26130    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26131
26132    /**
26133     * @}
26134     */
26135
26136    /**
26137     * @defgroup Flipselector Flip Selector
26138     *
26139     * @image html img/widget/flipselector/preview-00.png
26140     * @image latex img/widget/flipselector/preview-00.eps
26141     *
26142     * A flip selector is a widget to show a set of @b text items, one
26143     * at a time, with the same sheet switching style as the @ref Clock
26144     * "clock" widget, when one changes the current displaying sheet
26145     * (thus, the "flip" in the name).
26146     *
26147     * User clicks to flip sheets which are @b held for some time will
26148     * make the flip selector to flip continuosly and automatically for
26149     * the user. The interval between flips will keep growing in time,
26150     * so that it helps the user to reach an item which is distant from
26151     * the current selection.
26152     *
26153     * Smart callbacks one can register to:
26154     * - @c "selected" - when the widget's selected text item is changed
26155     * - @c "overflowed" - when the widget's current selection is changed
26156     *   from the first item in its list to the last
26157     * - @c "underflowed" - when the widget's current selection is changed
26158     *   from the last item in its list to the first
26159     *
26160     * Available styles for it:
26161     * - @c "default"
26162     *
26163          * To set/get the label of the flipselector item, you can use
26164          * elm_object_item_text_set/get APIs.
26165          * Once the text is set, a previously set one will be deleted.
26166          *
26167     * Here is an example on its usage:
26168     * @li @ref flipselector_example
26169     */
26170
26171    /**
26172     * @addtogroup Flipselector
26173     * @{
26174     */
26175
26176    /**
26177     * Add a new flip selector widget to the given parent Elementary
26178     * (container) widget
26179     *
26180     * @param parent The parent object
26181     * @return a new flip selector widget handle or @c NULL, on errors
26182     *
26183     * This function inserts a new flip selector widget on the canvas.
26184     *
26185     * @ingroup Flipselector
26186     */
26187    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26188
26189    /**
26190     * Programmatically select the next item of a flip selector widget
26191     *
26192     * @param obj The flipselector object
26193     *
26194     * @note The selection will be animated. Also, if it reaches the
26195     * end of its list of member items, it will continue with the first
26196     * one onwards.
26197     *
26198     * @ingroup Flipselector
26199     */
26200    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
26201
26202    /**
26203     * Programmatically select the previous item of a flip selector
26204     * widget
26205     *
26206     * @param obj The flipselector object
26207     *
26208     * @note The selection will be animated.  Also, if it reaches the
26209     * beginning of its list of member items, it will continue with the
26210     * last one backwards.
26211     *
26212     * @ingroup Flipselector
26213     */
26214    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
26215
26216    /**
26217     * Append a (text) item to a flip selector widget
26218     *
26219     * @param obj The flipselector object
26220     * @param label The (text) label of the new item
26221     * @param func Convenience callback function to take place when
26222     * item is selected
26223     * @param data Data passed to @p func, above
26224     * @return A handle to the item added or @c NULL, on errors
26225     *
26226     * The widget's list of labels to show will be appended with the
26227     * given value. If the user wishes so, a callback function pointer
26228     * can be passed, which will get called when this same item is
26229     * selected.
26230     *
26231     * @note The current selection @b won't be modified by appending an
26232     * element to the list.
26233     *
26234     * @note The maximum length of the text label is going to be
26235     * determined <b>by the widget's theme</b>. Strings larger than
26236     * that value are going to be @b truncated.
26237     *
26238     * @ingroup Flipselector
26239     */
26240    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26241
26242    /**
26243     * Prepend a (text) item to a flip selector widget
26244     *
26245     * @param obj The flipselector object
26246     * @param label The (text) label of the new item
26247     * @param func Convenience callback function to take place when
26248     * item is selected
26249     * @param data Data passed to @p func, above
26250     * @return A handle to the item added or @c NULL, on errors
26251     *
26252     * The widget's list of labels to show will be prepended with the
26253     * given value. If the user wishes so, a callback function pointer
26254     * can be passed, which will get called when this same item is
26255     * selected.
26256     *
26257     * @note The current selection @b won't be modified by prepending
26258     * an element to the list.
26259     *
26260     * @note The maximum length of the text label is going to be
26261     * determined <b>by the widget's theme</b>. Strings larger than
26262     * that value are going to be @b truncated.
26263     *
26264     * @ingroup Flipselector
26265     */
26266    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
26267
26268    /**
26269     * Get the internal list of items in a given flip selector widget.
26270     *
26271     * @param obj The flipselector object
26272     * @return The list of items (#Elm_Object_Item as data) or
26273     * @c NULL on errors.
26274     *
26275     * This list is @b not to be modified in any way and must not be
26276     * freed. Use the list members with functions like
26277     * elm_object_item_text_set(),
26278     * elm_object_item_text_get(),
26279     * elm_flipselector_item_del(),
26280     * elm_flipselector_item_selected_get(),
26281     * elm_flipselector_item_selected_set().
26282     *
26283     * @warning This list is only valid until @p obj object's internal
26284     * items list is changed. It should be fetched again with another
26285     * call to this function when changes happen.
26286     *
26287     * @ingroup Flipselector
26288     */
26289    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26290
26291    /**
26292     * Get the first item in the given flip selector widget's list of
26293     * items.
26294     *
26295     * @param obj The flipselector object
26296     * @return The first item or @c NULL, if it has no items (and on
26297     * errors)
26298     *
26299     * @see elm_flipselector_item_append()
26300     * @see elm_flipselector_last_item_get()
26301     *
26302     * @ingroup Flipselector
26303     */
26304    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26305
26306    /**
26307     * Get the last item in the given flip selector widget's list of
26308     * items.
26309     *
26310     * @param obj The flipselector object
26311     * @return The last item or @c NULL, if it has no items (and on
26312     * errors)
26313     *
26314     * @see elm_flipselector_item_prepend()
26315     * @see elm_flipselector_first_item_get()
26316     *
26317     * @ingroup Flipselector
26318     */
26319    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26320
26321    /**
26322     * Get the currently selected item in a flip selector widget.
26323     *
26324     * @param obj The flipselector object
26325     * @return The selected item or @c NULL, if the widget has no items
26326     * (and on erros)
26327     *
26328     * @ingroup Flipselector
26329     */
26330    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26331
26332    /**
26333     * Set whether a given flip selector widget's item should be the
26334     * currently selected one.
26335     *
26336     * @param it The flip selector item
26337     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
26338     *
26339     * This sets whether @p item is or not the selected (thus, under
26340     * display) one. If @p item is different than one under display,
26341     * the latter will be unselected. If the @p item is set to be
26342     * unselected, on the other hand, the @b first item in the widget's
26343     * internal members list will be the new selected one.
26344     *
26345     * @see elm_flipselector_item_selected_get()
26346     *
26347     * @ingroup Flipselector
26348     */
26349    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
26350
26351    /**
26352     * Get whether a given flip selector widget's item is the currently
26353     * selected one.
26354     *
26355     * @param it The flip selector item
26356     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
26357     * (or on errors).
26358     *
26359     * @see elm_flipselector_item_selected_set()
26360     *
26361     * @ingroup Flipselector
26362     */
26363    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26364
26365    /**
26366     * Delete a given item from a flip selector widget.
26367     *
26368     * @param it The item to delete
26369     *
26370     * @ingroup Flipselector
26371     */
26372    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26373
26374    /**
26375     * Get the label of a given flip selector widget's item.
26376     *
26377     * @param it The item to get label from
26378     * @return The text label of @p item or @c NULL, on errors
26379     *
26380     * @see elm_object_item_text_set()
26381     *
26382     * @deprecated see elm_object_item_text_get() instead
26383     * @ingroup Flipselector
26384     */
26385    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26386
26387    /**
26388     * Set the label of a given flip selector widget's item.
26389     *
26390     * @param it The item to set label on
26391     * @param label The text label string, in UTF-8 encoding
26392     *
26393     * @see elm_object_item_text_get()
26394     *
26395          * @deprecated see elm_object_item_text_set() instead
26396     * @ingroup Flipselector
26397     */
26398    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26399
26400    /**
26401     * Gets the item before @p item in a flip selector widget's
26402     * internal list of items.
26403     *
26404     * @param it The item to fetch previous from
26405     * @return The item before the @p item, in its parent's list. If
26406     *         there is no previous item for @p item or there's an
26407     *         error, @c NULL is returned.
26408     *
26409     * @see elm_flipselector_item_next_get()
26410     *
26411     * @ingroup Flipselector
26412     */
26413    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26414
26415    /**
26416     * Gets the item after @p item in a flip selector widget's
26417     * internal list of items.
26418     *
26419     * @param it The item to fetch next from
26420     * @return The item after the @p item, in its parent's list. If
26421     *         there is no next item for @p item or there's an
26422     *         error, @c NULL is returned.
26423     *
26424     * @see elm_flipselector_item_next_get()
26425     *
26426     * @ingroup Flipselector
26427     */
26428    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26429
26430    /**
26431     * Set the interval on time updates for an user mouse button hold
26432     * on a flip selector widget.
26433     *
26434     * @param obj The flip selector object
26435     * @param interval The (first) interval value in seconds
26436     *
26437     * This interval value is @b decreased while the user holds the
26438     * mouse pointer either flipping up or flipping doww a given flip
26439     * selector.
26440     *
26441     * This helps the user to get to a given item distant from the
26442     * current one easier/faster, as it will start to flip quicker and
26443     * quicker on mouse button holds.
26444     *
26445     * The calculation for the next flip interval value, starting from
26446     * the one set with this call, is the previous interval divided by
26447     * 1.05, so it decreases a little bit.
26448     *
26449     * The default starting interval value for automatic flips is
26450     * @b 0.85 seconds.
26451     *
26452     * @see elm_flipselector_interval_get()
26453     *
26454     * @ingroup Flipselector
26455     */
26456    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26457
26458    /**
26459     * Get the interval on time updates for an user mouse button hold
26460     * on a flip selector widget.
26461     *
26462     * @param obj The flip selector object
26463     * @return The (first) interval value, in seconds, set on it
26464     *
26465     * @see elm_flipselector_interval_set() for more details
26466     *
26467     * @ingroup Flipselector
26468     */
26469    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26470    /**
26471     * @}
26472     */
26473
26474    /**
26475     * @addtogroup Calendar
26476     * @{
26477     */
26478
26479    /**
26480     * @enum _Elm_Calendar_Mark_Repeat
26481     * @typedef Elm_Calendar_Mark_Repeat
26482     *
26483     * Event periodicity, used to define if a mark should be repeated
26484     * @b beyond event's day. It's set when a mark is added.
26485     *
26486     * So, for a mark added to 13th May with periodicity set to WEEKLY,
26487     * there will be marks every week after this date. Marks will be displayed
26488     * at 13th, 20th, 27th, 3rd June ...
26489     *
26490     * Values don't work as bitmask, only one can be choosen.
26491     *
26492     * @see elm_calendar_mark_add()
26493     *
26494     * @ingroup Calendar
26495     */
26496    typedef enum _Elm_Calendar_Mark_Repeat
26497      {
26498         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
26499         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
26500         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
26501         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*/
26502         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. */
26503      } Elm_Calendar_Mark_Repeat;
26504
26505    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(). */
26506
26507    /**
26508     * Add a new calendar widget to the given parent Elementary
26509     * (container) object.
26510     *
26511     * @param parent The parent object.
26512     * @return a new calendar widget handle or @c NULL, on errors.
26513     *
26514     * This function inserts a new calendar widget on the canvas.
26515     *
26516     * @ref calendar_example_01
26517     *
26518     * @ingroup Calendar
26519     */
26520    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26521
26522    /**
26523     * Get weekdays names displayed by the calendar.
26524     *
26525     * @param obj The calendar object.
26526     * @return Array of seven strings to be used as weekday names.
26527     *
26528     * By default, weekdays abbreviations get from system are displayed:
26529     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26530     * The first string is related to Sunday, the second to Monday...
26531     *
26532     * @see elm_calendar_weekdays_name_set()
26533     *
26534     * @ref calendar_example_05
26535     *
26536     * @ingroup Calendar
26537     */
26538    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26539
26540    /**
26541     * Set weekdays names to be displayed by the calendar.
26542     *
26543     * @param obj The calendar object.
26544     * @param weekdays Array of seven strings to be used as weekday names.
26545     * @warning It must have 7 elements, or it will access invalid memory.
26546     * @warning The strings must be NULL terminated ('@\0').
26547     *
26548     * By default, weekdays abbreviations get from system are displayed:
26549     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
26550     *
26551     * The first string should be related to Sunday, the second to Monday...
26552     *
26553     * The usage should be like this:
26554     * @code
26555     *   const char *weekdays[] =
26556     *   {
26557     *      "Sunday", "Monday", "Tuesday", "Wednesday",
26558     *      "Thursday", "Friday", "Saturday"
26559     *   };
26560     *   elm_calendar_weekdays_names_set(calendar, weekdays);
26561     * @endcode
26562     *
26563     * @see elm_calendar_weekdays_name_get()
26564     *
26565     * @ref calendar_example_02
26566     *
26567     * @ingroup Calendar
26568     */
26569    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
26570
26571    /**
26572     * Set the minimum and maximum values for the year
26573     *
26574     * @param obj The calendar object
26575     * @param min The minimum year, greater than 1901;
26576     * @param max The maximum year;
26577     *
26578     * Maximum must be greater than minimum, except if you don't wan't to set
26579     * maximum year.
26580     * Default values are 1902 and -1.
26581     *
26582     * If the maximum year is a negative value, it will be limited depending
26583     * on the platform architecture (year 2037 for 32 bits);
26584     *
26585     * @see elm_calendar_min_max_year_get()
26586     *
26587     * @ref calendar_example_03
26588     *
26589     * @ingroup Calendar
26590     */
26591    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
26592
26593    /**
26594     * Get the minimum and maximum values for the year
26595     *
26596     * @param obj The calendar object.
26597     * @param min The minimum year.
26598     * @param max The maximum year.
26599     *
26600     * Default values are 1902 and -1.
26601     *
26602     * @see elm_calendar_min_max_year_get() for more details.
26603     *
26604     * @ref calendar_example_05
26605     *
26606     * @ingroup Calendar
26607     */
26608    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
26609
26610    /**
26611     * Enable or disable day selection
26612     *
26613     * @param obj The calendar object.
26614     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
26615     * disable it.
26616     *
26617     * Enabled by default. If disabled, the user still can select months,
26618     * but not days. Selected days are highlighted on calendar.
26619     * It should be used if you won't need such selection for the widget usage.
26620     *
26621     * When a day is selected, or month is changed, smart callbacks for
26622     * signal "changed" will be called.
26623     *
26624     * @see elm_calendar_day_selection_enable_get()
26625     *
26626     * @ref calendar_example_04
26627     *
26628     * @ingroup Calendar
26629     */
26630    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26631
26632    /**
26633     * Get a value whether day selection is enabled or not.
26634     *
26635     * @see elm_calendar_day_selection_enable_set() for details.
26636     *
26637     * @param obj The calendar object.
26638     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
26639     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
26640     *
26641     * @ref calendar_example_05
26642     *
26643     * @ingroup Calendar
26644     */
26645    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26646
26647
26648    /**
26649     * Set selected date to be highlighted on calendar.
26650     *
26651     * @param obj The calendar object.
26652     * @param selected_time A @b tm struct to represent the selected date.
26653     *
26654     * Set the selected date, changing the displayed month if needed.
26655     * Selected date changes when the user goes to next/previous month or
26656     * select a day pressing over it on calendar.
26657     *
26658     * @see elm_calendar_selected_time_get()
26659     *
26660     * @ref calendar_example_04
26661     *
26662     * @ingroup Calendar
26663     */
26664    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
26665
26666    /**
26667     * Get selected date.
26668     *
26669     * @param obj The calendar object
26670     * @param selected_time A @b tm struct to point to selected date
26671     * @return EINA_FALSE means an error ocurred and returned time shouldn't
26672     * be considered.
26673     *
26674     * Get date selected by the user or set by function
26675     * elm_calendar_selected_time_set().
26676     * Selected date changes when the user goes to next/previous month or
26677     * select a day pressing over it on calendar.
26678     *
26679     * @see elm_calendar_selected_time_get()
26680     *
26681     * @ref calendar_example_05
26682     *
26683     * @ingroup Calendar
26684     */
26685    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
26686
26687    /**
26688     * Set a function to format the string that will be used to display
26689     * month and year;
26690     *
26691     * @param obj The calendar object
26692     * @param format_function Function to set the month-year string given
26693     * the selected date
26694     *
26695     * By default it uses strftime with "%B %Y" format string.
26696     * It should allocate the memory that will be used by the string,
26697     * that will be freed by the widget after usage.
26698     * A pointer to the string and a pointer to the time struct will be provided.
26699     *
26700     * Example:
26701     * @code
26702     * static char *
26703     * _format_month_year(struct tm *selected_time)
26704     * {
26705     *    char buf[32];
26706     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
26707     *    return strdup(buf);
26708     * }
26709     *
26710     * elm_calendar_format_function_set(calendar, _format_month_year);
26711     * @endcode
26712     *
26713     * @ref calendar_example_02
26714     *
26715     * @ingroup Calendar
26716     */
26717    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
26718
26719    /**
26720     * Add a new mark to the calendar
26721     *
26722     * @param obj The calendar object
26723     * @param mark_type A string used to define the type of mark. It will be
26724     * emitted to the theme, that should display a related modification on these
26725     * days representation.
26726     * @param mark_time A time struct to represent the date of inclusion of the
26727     * mark. For marks that repeats it will just be displayed after the inclusion
26728     * date in the calendar.
26729     * @param repeat Repeat the event following this periodicity. Can be a unique
26730     * mark (that don't repeat), daily, weekly, monthly or annually.
26731     * @return The created mark or @p NULL upon failure.
26732     *
26733     * Add a mark that will be drawn in the calendar respecting the insertion
26734     * time and periodicity. It will emit the type as signal to the widget theme.
26735     * Default theme supports "holiday" and "checked", but it can be extended.
26736     *
26737     * It won't immediately update the calendar, drawing the marks.
26738     * For this, call elm_calendar_marks_draw(). However, when user selects
26739     * next or previous month calendar forces marks drawn.
26740     *
26741     * Marks created with this method can be deleted with
26742     * elm_calendar_mark_del().
26743     *
26744     * Example
26745     * @code
26746     * struct tm selected_time;
26747     * time_t current_time;
26748     *
26749     * current_time = time(NULL) + 5 * 84600;
26750     * localtime_r(&current_time, &selected_time);
26751     * elm_calendar_mark_add(cal, "holiday", selected_time,
26752     *     ELM_CALENDAR_ANNUALLY);
26753     *
26754     * current_time = time(NULL) + 1 * 84600;
26755     * localtime_r(&current_time, &selected_time);
26756     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
26757     *
26758     * elm_calendar_marks_draw(cal);
26759     * @endcode
26760     *
26761     * @see elm_calendar_marks_draw()
26762     * @see elm_calendar_mark_del()
26763     *
26764     * @ref calendar_example_06
26765     *
26766     * @ingroup Calendar
26767     */
26768    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);
26769
26770    /**
26771     * Delete mark from the calendar.
26772     *
26773     * @param mark The mark to be deleted.
26774     *
26775     * If deleting all calendar marks is required, elm_calendar_marks_clear()
26776     * should be used instead of getting marks list and deleting each one.
26777     *
26778     * @see elm_calendar_mark_add()
26779     *
26780     * @ref calendar_example_06
26781     *
26782     * @ingroup Calendar
26783     */
26784    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
26785
26786    /**
26787     * Remove all calendar's marks
26788     *
26789     * @param obj The calendar object.
26790     *
26791     * @see elm_calendar_mark_add()
26792     * @see elm_calendar_mark_del()
26793     *
26794     * @ingroup Calendar
26795     */
26796    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26797
26798    /**
26799     * Get a list of all the calendar marks.
26800     *
26801     * @param obj The calendar object.
26802     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
26803     *
26804     * @see elm_calendar_mark_add()
26805     * @see elm_calendar_mark_del()
26806     * @see elm_calendar_marks_clear()
26807     *
26808     * @ingroup Calendar
26809     */
26810    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26811
26812    /**
26813     * Draw calendar marks.
26814     *
26815     * @param obj The calendar object.
26816     *
26817     * Should be used after adding, removing or clearing marks.
26818     * It will go through the entire marks list updating the calendar.
26819     * If lots of marks will be added, add all the marks and then call
26820     * this function.
26821     *
26822     * When the month is changed, i.e. user selects next or previous month,
26823     * marks will be drawed.
26824     *
26825     * @see elm_calendar_mark_add()
26826     * @see elm_calendar_mark_del()
26827     * @see elm_calendar_marks_clear()
26828     *
26829     * @ref calendar_example_06
26830     *
26831     * @ingroup Calendar
26832     */
26833    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
26834
26835    /**
26836     * Set a day text color to the same that represents Saturdays.
26837     *
26838     * @param obj The calendar object.
26839     * @param pos The text position. Position is the cell counter, from left
26840     * to right, up to down. It starts on 0 and ends on 41.
26841     *
26842     * @deprecated use elm_calendar_mark_add() instead like:
26843     *
26844     * @code
26845     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
26846     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26847     * @endcode
26848     *
26849     * @see elm_calendar_mark_add()
26850     *
26851     * @ingroup Calendar
26852     */
26853    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26854
26855    /**
26856     * Set a day text color to the same that represents Sundays.
26857     *
26858     * @param obj The calendar object.
26859     * @param pos The text position. Position is the cell counter, from left
26860     * to right, up to down. It starts on 0 and ends on 41.
26861
26862     * @deprecated use elm_calendar_mark_add() instead like:
26863     *
26864     * @code
26865     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
26866     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
26867     * @endcode
26868     *
26869     * @see elm_calendar_mark_add()
26870     *
26871     * @ingroup Calendar
26872     */
26873    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26874
26875    /**
26876     * Set a day text color to the same that represents Weekdays.
26877     *
26878     * @param obj The calendar object
26879     * @param pos The text position. Position is the cell counter, from left
26880     * to right, up to down. It starts on 0 and ends on 41.
26881     *
26882     * @deprecated use elm_calendar_mark_add() instead like:
26883     *
26884     * @code
26885     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
26886     *
26887     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
26888     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26889     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
26890     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26891     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
26892     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26893     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
26894     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
26895     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
26896     * @endcode
26897     *
26898     * @see elm_calendar_mark_add()
26899     *
26900     * @ingroup Calendar
26901     */
26902    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
26903
26904    /**
26905     * Set the interval on time updates for an user mouse button hold
26906     * on calendar widgets' month selection.
26907     *
26908     * @param obj The calendar object
26909     * @param interval The (first) interval value in seconds
26910     *
26911     * This interval value is @b decreased while the user holds the
26912     * mouse pointer either selecting next or previous month.
26913     *
26914     * This helps the user to get to a given month distant from the
26915     * current one easier/faster, as it will start to change quicker and
26916     * quicker on mouse button holds.
26917     *
26918     * The calculation for the next change interval value, starting from
26919     * the one set with this call, is the previous interval divided by
26920     * 1.05, so it decreases a little bit.
26921     *
26922     * The default starting interval value for automatic changes is
26923     * @b 0.85 seconds.
26924     *
26925     * @see elm_calendar_interval_get()
26926     *
26927     * @ingroup Calendar
26928     */
26929    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
26930
26931    /**
26932     * Get the interval on time updates for an user mouse button hold
26933     * on calendar widgets' month selection.
26934     *
26935     * @param obj The calendar object
26936     * @return The (first) interval value, in seconds, set on it
26937     *
26938     * @see elm_calendar_interval_set() for more details
26939     *
26940     * @ingroup Calendar
26941     */
26942    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26943
26944    /**
26945     * @}
26946     */
26947
26948    /**
26949     * @defgroup Diskselector Diskselector
26950     * @ingroup Elementary
26951     *
26952     * @image html img/widget/diskselector/preview-00.png
26953     * @image latex img/widget/diskselector/preview-00.eps
26954     *
26955     * A diskselector is a kind of list widget. It scrolls horizontally,
26956     * and can contain label and icon objects. Three items are displayed
26957     * with the selected one in the middle.
26958     *
26959     * It can act like a circular list with round mode and labels can be
26960     * reduced for a defined length for side items.
26961     *
26962     * Smart callbacks one can listen to:
26963     * - "selected" - when item is selected, i.e. scroller stops.
26964     *
26965     * Available styles for it:
26966     * - @c "default"
26967     *
26968     * List of examples:
26969     * @li @ref diskselector_example_01
26970     * @li @ref diskselector_example_02
26971     */
26972
26973    /**
26974     * @addtogroup Diskselector
26975     * @{
26976     */
26977
26978    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(). */
26979
26980    /**
26981     * Add a new diskselector widget to the given parent Elementary
26982     * (container) object.
26983     *
26984     * @param parent The parent object.
26985     * @return a new diskselector widget handle or @c NULL, on errors.
26986     *
26987     * This function inserts a new diskselector widget on the canvas.
26988     *
26989     * @ingroup Diskselector
26990     */
26991    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26992
26993    /**
26994     * Enable or disable round mode.
26995     *
26996     * @param obj The diskselector object.
26997     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
26998     * disable it.
26999     *
27000     * Disabled by default. If round mode is enabled the items list will
27001     * work like a circle list, so when the user reaches the last item,
27002     * the first one will popup.
27003     *
27004     * @see elm_diskselector_round_get()
27005     *
27006     * @ingroup Diskselector
27007     */
27008    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
27009
27010    /**
27011     * Get a value whether round mode is enabled or not.
27012     *
27013     * @see elm_diskselector_round_set() for details.
27014     *
27015     * @param obj The diskselector object.
27016     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
27017     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
27018     *
27019     * @ingroup Diskselector
27020     */
27021    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27022
27023    /**
27024     * Get the side labels max length.
27025     *
27026     * @deprecated use elm_diskselector_side_label_length_get() instead:
27027     *
27028     * @param obj The diskselector object.
27029     * @return The max length defined for side labels, or 0 if not a valid
27030     * diskselector.
27031     *
27032     * @ingroup Diskselector
27033     */
27034    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27035
27036    /**
27037     * Set the side labels max length.
27038     *
27039     * @deprecated use elm_diskselector_side_label_length_set() instead:
27040     *
27041     * @param obj The diskselector object.
27042     * @param len The max length defined for side labels.
27043     *
27044     * @ingroup Diskselector
27045     */
27046    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27047
27048    /**
27049     * Get the side labels max length.
27050     *
27051     * @see elm_diskselector_side_label_length_set() for details.
27052     *
27053     * @param obj The diskselector object.
27054     * @return The max length defined for side labels, or 0 if not a valid
27055     * diskselector.
27056     *
27057     * @ingroup Diskselector
27058     */
27059    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27060
27061    /**
27062     * Set the side labels max length.
27063     *
27064     * @param obj The diskselector object.
27065     * @param len The max length defined for side labels.
27066     *
27067     * Length is the number of characters of items' label that will be
27068     * visible when it's set on side positions. It will just crop
27069     * the string after defined size. E.g.:
27070     *
27071     * An item with label "January" would be displayed on side position as
27072     * "Jan" if max length is set to 3, or "Janu", if this property
27073     * is set to 4.
27074     *
27075     * When it's selected, the entire label will be displayed, except for
27076     * width restrictions. In this case label will be cropped and "..."
27077     * will be concatenated.
27078     *
27079     * Default side label max length is 3.
27080     *
27081     * This property will be applyed over all items, included before or
27082     * later this function call.
27083     *
27084     * @ingroup Diskselector
27085     */
27086    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
27087
27088    /**
27089     * Set the number of items to be displayed.
27090     *
27091     * @param obj The diskselector object.
27092     * @param num The number of items the diskselector will display.
27093     *
27094     * Default value is 3, and also it's the minimun. If @p num is less
27095     * than 3, it will be set to 3.
27096     *
27097     * Also, it can be set on theme, using data item @c display_item_num
27098     * on group "elm/diskselector/item/X", where X is style set.
27099     * E.g.:
27100     *
27101     * group { name: "elm/diskselector/item/X";
27102     * data {
27103     *     item: "display_item_num" "5";
27104     *     }
27105     *
27106     * @ingroup Diskselector
27107     */
27108    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
27109
27110    /**
27111     * Get the number of items in the diskselector object.
27112     *
27113     * @param obj The diskselector object.
27114     *
27115     * @ingroup Diskselector
27116     */
27117    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27118
27119    /**
27120     * Set bouncing behaviour when the scrolled content reaches an edge.
27121     *
27122     * Tell the internal scroller object whether it should bounce or not
27123     * when it reaches the respective edges for each axis.
27124     *
27125     * @param obj The diskselector object.
27126     * @param h_bounce Whether to bounce or not in the horizontal axis.
27127     * @param v_bounce Whether to bounce or not in the vertical axis.
27128     *
27129     * @see elm_scroller_bounce_set()
27130     *
27131     * @ingroup Diskselector
27132     */
27133    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
27134
27135    /**
27136     * Get the bouncing behaviour of the internal scroller.
27137     *
27138     * Get whether the internal scroller should bounce when the edge of each
27139     * axis is reached scrolling.
27140     *
27141     * @param obj The diskselector object.
27142     * @param h_bounce Pointer where to store the bounce state of the horizontal
27143     * axis.
27144     * @param v_bounce Pointer where to store the bounce state of the vertical
27145     * axis.
27146     *
27147     * @see elm_scroller_bounce_get()
27148     * @see elm_diskselector_bounce_set()
27149     *
27150     * @ingroup Diskselector
27151     */
27152    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
27153
27154    /**
27155     * Get the scrollbar policy.
27156     *
27157     * @see elm_diskselector_scroller_policy_get() for details.
27158     *
27159     * @param obj The diskselector object.
27160     * @param policy_h Pointer where to store horizontal scrollbar policy.
27161     * @param policy_v Pointer where to store vertical scrollbar policy.
27162     *
27163     * @ingroup Diskselector
27164     */
27165    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);
27166
27167    /**
27168     * Set the scrollbar policy.
27169     *
27170     * @param obj The diskselector object.
27171     * @param policy_h Horizontal scrollbar policy.
27172     * @param policy_v Vertical scrollbar policy.
27173     *
27174     * This sets the scrollbar visibility policy for the given scroller.
27175     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
27176     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
27177     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
27178     * This applies respectively for the horizontal and vertical scrollbars.
27179     *
27180     * The both are disabled by default, i.e., are set to
27181     * #ELM_SCROLLER_POLICY_OFF.
27182     *
27183     * @ingroup Diskselector
27184     */
27185    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
27186
27187    /**
27188     * Remove all diskselector's items.
27189     *
27190     * @param obj The diskselector object.
27191     *
27192     * @see elm_diskselector_item_del()
27193     * @see elm_diskselector_item_append()
27194     *
27195     * @ingroup Diskselector
27196     */
27197    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27198
27199    /**
27200     * Get a list of all the diskselector items.
27201     *
27202     * @param obj The diskselector object.
27203     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
27204     * or @c NULL on failure.
27205     *
27206     * @see elm_diskselector_item_append()
27207     * @see elm_diskselector_item_del()
27208     * @see elm_diskselector_clear()
27209     *
27210     * @ingroup Diskselector
27211     */
27212    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27213
27214    /**
27215     * Appends a new item to the diskselector object.
27216     *
27217     * @param obj The diskselector object.
27218     * @param label The label of the diskselector item.
27219     * @param icon The icon object to use at left side of the item. An
27220     * icon can be any Evas object, but usually it is an icon created
27221     * with elm_icon_add().
27222     * @param func The function to call when the item is selected.
27223     * @param data The data to associate with the item for related callbacks.
27224     *
27225     * @return The created item or @c NULL upon failure.
27226     *
27227     * A new item will be created and appended to the diskselector, i.e., will
27228     * be set as last item. Also, if there is no selected item, it will
27229     * be selected. This will always happens for the first appended item.
27230     *
27231     * If no icon is set, label will be centered on item position, otherwise
27232     * the icon will be placed at left of the label, that will be shifted
27233     * to the right.
27234     *
27235     * Items created with this method can be deleted with
27236     * elm_diskselector_item_del().
27237     *
27238     * Associated @p data can be properly freed when item is deleted if a
27239     * callback function is set with elm_diskselector_item_del_cb_set().
27240     *
27241     * If a function is passed as argument, it will be called everytime this item
27242     * is selected, i.e., the user stops the diskselector with this
27243     * item on center position. If such function isn't needed, just passing
27244     * @c NULL as @p func is enough. The same should be done for @p data.
27245     *
27246     * Simple example (with no function callback or data associated):
27247     * @code
27248     * disk = elm_diskselector_add(win);
27249     * ic = elm_icon_add(win);
27250     * elm_icon_file_set(ic, "path/to/image", NULL);
27251     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27252     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
27253     * @endcode
27254     *
27255     * @see elm_diskselector_item_del()
27256     * @see elm_diskselector_item_del_cb_set()
27257     * @see elm_diskselector_clear()
27258     * @see elm_icon_add()
27259     *
27260     * @ingroup Diskselector
27261     */
27262    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);
27263
27264
27265    /**
27266     * Delete them item from the diskselector.
27267     *
27268     * @param it The item of diskselector to be deleted.
27269     *
27270     * If deleting all diskselector items is required, elm_diskselector_clear()
27271     * should be used instead of getting items list and deleting each one.
27272     *
27273     * @see elm_diskselector_clear()
27274     * @see elm_diskselector_item_append()
27275     * @see elm_diskselector_item_del_cb_set()
27276     *
27277     * @ingroup Diskselector
27278     */
27279    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27280
27281    /**
27282     * Set the function called when a diskselector item is freed.
27283     *
27284     * @param it The item to set the callback on
27285     * @param func The function called
27286     *
27287     * If there is a @p func, then it will be called prior item's memory release.
27288     * That will be called with the following arguments:
27289     * @li item's data;
27290     * @li item's Evas object;
27291     * @li item itself;
27292     *
27293     * This way, a data associated to a diskselector item could be properly
27294     * freed.
27295     *
27296     * @ingroup Diskselector
27297     */
27298    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
27299
27300    /**
27301     * Get the data associated to the item.
27302     *
27303     * @param it The diskselector item
27304     * @return The data associated to @p it
27305     *
27306     * The return value is a pointer to data associated to @p item when it was
27307     * created, with function elm_diskselector_item_append(). If no data
27308     * was passed as argument, it will return @c NULL.
27309     *
27310     * @see elm_diskselector_item_append()
27311     *
27312     * @ingroup Diskselector
27313     */
27314    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27315
27316    /**
27317     * Set the icon associated to the item.
27318     *
27319     * @param it The diskselector item
27320     * @param icon The icon object to associate with @p it
27321     *
27322     * The icon object to use at left side of the item. An
27323     * icon can be any Evas object, but usually it is an icon created
27324     * with elm_icon_add().
27325     *
27326     * Once the icon object is set, a previously set one will be deleted.
27327     * @warning Setting the same icon for two items will cause the icon to
27328     * dissapear from the first item.
27329     *
27330     * If an icon was passed as argument on item creation, with function
27331     * elm_diskselector_item_append(), it will be already
27332     * associated to the item.
27333     *
27334     * @see elm_diskselector_item_append()
27335     * @see elm_diskselector_item_icon_get()
27336     *
27337     * @ingroup Diskselector
27338     */
27339    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
27340
27341    /**
27342     * Get the icon associated to the item.
27343     *
27344     * @param it The diskselector item
27345     * @return The icon associated to @p it
27346     *
27347     * The return value is a pointer to the icon associated to @p item when it was
27348     * created, with function elm_diskselector_item_append(), or later
27349     * with function elm_diskselector_item_icon_set. If no icon
27350     * was passed as argument, it will return @c NULL.
27351     *
27352     * @see elm_diskselector_item_append()
27353     * @see elm_diskselector_item_icon_set()
27354     *
27355     * @ingroup Diskselector
27356     */
27357    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27358
27359    /**
27360     * Set the label of item.
27361     *
27362     * @param it The item of diskselector.
27363     * @param label The label of item.
27364     *
27365     * The label to be displayed by the item.
27366     *
27367     * If no icon is set, label will be centered on item position, otherwise
27368     * the icon will be placed at left of the label, that will be shifted
27369     * to the right.
27370     *
27371     * An item with label "January" would be displayed on side position as
27372     * "Jan" if max length is set to 3 with function
27373     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
27374     * is set to 4.
27375     *
27376     * When this @p item is selected, the entire label will be displayed,
27377     * except for width restrictions.
27378     * In this case label will be cropped and "..." will be concatenated,
27379     * but only for display purposes. It will keep the entire string, so
27380     * if diskselector is resized the remaining characters will be displayed.
27381     *
27382     * If a label was passed as argument on item creation, with function
27383     * elm_diskselector_item_append(), it will be already
27384     * displayed by the item.
27385     *
27386     * @see elm_diskselector_side_label_lenght_set()
27387     * @see elm_diskselector_item_label_get()
27388     * @see elm_diskselector_item_append()
27389     *
27390     * @ingroup Diskselector
27391     */
27392    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
27393
27394    /**
27395     * Get the label of item.
27396     *
27397     * @param it The item of diskselector.
27398     * @return The label of item.
27399     *
27400     * The return value is a pointer to the label associated to @p item when it was
27401     * created, with function elm_diskselector_item_append(), or later
27402     * with function elm_diskselector_item_label_set. If no label
27403     * was passed as argument, it will return @c NULL.
27404     *
27405     * @see elm_diskselector_item_label_set() for more details.
27406     * @see elm_diskselector_item_append()
27407     *
27408     * @ingroup Diskselector
27409     */
27410    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27411
27412    /**
27413     * Get the selected item.
27414     *
27415     * @param obj The diskselector object.
27416     * @return The selected diskselector item.
27417     *
27418     * The selected item can be unselected with function
27419     * elm_diskselector_item_selected_set(), and the first item of
27420     * diskselector will be selected.
27421     *
27422     * The selected item always will be centered on diskselector, with
27423     * full label displayed, i.e., max lenght set to side labels won't
27424     * apply on the selected item. More details on
27425     * elm_diskselector_side_label_length_set().
27426     *
27427     * @ingroup Diskselector
27428     */
27429    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27430
27431    /**
27432     * Set the selected state of an item.
27433     *
27434     * @param it The diskselector item
27435     * @param selected The selected state
27436     *
27437     * This sets the selected state of the given item @p it.
27438     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27439     *
27440     * If a new item is selected the previosly selected will be unselected.
27441     * Previoulsy selected item can be get with function
27442     * elm_diskselector_selected_item_get().
27443     *
27444     * If the item @p it is unselected, the first item of diskselector will
27445     * be selected.
27446     *
27447     * Selected items will be visible on center position of diskselector.
27448     * So if it was on another position before selected, or was invisible,
27449     * diskselector will animate items until the selected item reaches center
27450     * position.
27451     *
27452     * @see elm_diskselector_item_selected_get()
27453     * @see elm_diskselector_selected_item_get()
27454     *
27455     * @ingroup Diskselector
27456     */
27457    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
27458
27459    /*
27460     * Get whether the @p item is selected or not.
27461     *
27462     * @param it The diskselector item.
27463     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
27464     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
27465     *
27466     * @see elm_diskselector_selected_item_set() for details.
27467     * @see elm_diskselector_item_selected_get()
27468     *
27469     * @ingroup Diskselector
27470     */
27471    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27472
27473    /**
27474     * Get the first item of the diskselector.
27475     *
27476     * @param obj The diskselector object.
27477     * @return The first item, or @c NULL if none.
27478     *
27479     * The list of items follows append order. So it will return the first
27480     * item appended to the widget that wasn't deleted.
27481     *
27482     * @see elm_diskselector_item_append()
27483     * @see elm_diskselector_items_get()
27484     *
27485     * @ingroup Diskselector
27486     */
27487    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27488
27489    /**
27490     * Get the last item of the diskselector.
27491     *
27492     * @param obj The diskselector object.
27493     * @return The last item, or @c NULL if none.
27494     *
27495     * The list of items follows append order. So it will return last first
27496     * item appended to the widget that wasn't deleted.
27497     *
27498     * @see elm_diskselector_item_append()
27499     * @see elm_diskselector_items_get()
27500     *
27501     * @ingroup Diskselector
27502     */
27503    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27504
27505    /**
27506     * Get the item before @p item in diskselector.
27507     *
27508     * @param it The diskselector item.
27509     * @return The item before @p item, or @c NULL if none or on failure.
27510     *
27511     * The list of items follows append order. So it will return item appended
27512     * just before @p item and that wasn't deleted.
27513     *
27514     * If it is the first item, @c NULL will be returned.
27515     * First item can be get by elm_diskselector_first_item_get().
27516     *
27517     * @see elm_diskselector_item_append()
27518     * @see elm_diskselector_items_get()
27519     *
27520     * @ingroup Diskselector
27521     */
27522    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27523
27524    /**
27525     * Get the item after @p item in diskselector.
27526     *
27527     * @param it The diskselector item.
27528     * @return The item after @p item, or @c NULL if none or on failure.
27529     *
27530     * The list of items follows append order. So it will return item appended
27531     * just after @p item and that wasn't deleted.
27532     *
27533     * If it is the last item, @c NULL will be returned.
27534     * Last item can be get by elm_diskselector_last_item_get().
27535     *
27536     * @see elm_diskselector_item_append()
27537     * @see elm_diskselector_items_get()
27538     *
27539     * @ingroup Diskselector
27540     */
27541    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27542
27543    /**
27544     * Set the text to be shown in the diskselector item.
27545     *
27546     * @param item Target item
27547     * @param text The text to set in the content
27548     *
27549     * Setup the text as tooltip to object. The item can have only one tooltip,
27550     * so any previous tooltip data is removed.
27551     *
27552     * @see elm_object_tooltip_text_set() for more details.
27553     *
27554     * @ingroup Diskselector
27555     */
27556    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
27557
27558    /**
27559     * Set the content to be shown in the tooltip item.
27560     *
27561     * Setup the tooltip to item. The item can have only one tooltip,
27562     * so any previous tooltip data is removed. @p func(with @p data) will
27563     * be called every time that need show the tooltip and it should
27564     * return a valid Evas_Object. This object is then managed fully by
27565     * tooltip system and is deleted when the tooltip is gone.
27566     *
27567     * @param item the diskselector item being attached a tooltip.
27568     * @param func the function used to create the tooltip contents.
27569     * @param data what to provide to @a func as callback data/context.
27570     * @param del_cb called when data is not needed anymore, either when
27571     *        another callback replaces @p func, the tooltip is unset with
27572     *        elm_diskselector_item_tooltip_unset() or the owner @a item
27573     *        dies. This callback receives as the first parameter the
27574     *        given @a data, and @c event_info is the item.
27575     *
27576     * @see elm_object_tooltip_content_cb_set() for more details.
27577     *
27578     * @ingroup Diskselector
27579     */
27580    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);
27581
27582    /**
27583     * Unset tooltip from item.
27584     *
27585     * @param item diskselector item to remove previously set tooltip.
27586     *
27587     * Remove tooltip from item. The callback provided as del_cb to
27588     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
27589     * it is not used anymore.
27590     *
27591     * @see elm_object_tooltip_unset() for more details.
27592     * @see elm_diskselector_item_tooltip_content_cb_set()
27593     *
27594     * @ingroup Diskselector
27595     */
27596    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27597
27598    /**
27599     * Sets a different style for this item tooltip.
27600     *
27601     * @note before you set a style you should define a tooltip with
27602     *       elm_diskselector_item_tooltip_content_cb_set() or
27603     *       elm_diskselector_item_tooltip_text_set()
27604     *
27605     * @param item diskselector item with tooltip already set.
27606     * @param style the theme style to use (default, transparent, ...)
27607     *
27608     * @see elm_object_tooltip_style_set() for more details.
27609     *
27610     * @ingroup Diskselector
27611     */
27612    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27613
27614    /**
27615     * Get the style for this item tooltip.
27616     *
27617     * @param item diskselector item with tooltip already set.
27618     * @return style the theme style in use, defaults to "default". If the
27619     *         object does not have a tooltip set, then NULL is returned.
27620     *
27621     * @see elm_object_tooltip_style_get() for more details.
27622     * @see elm_diskselector_item_tooltip_style_set()
27623     *
27624     * @ingroup Diskselector
27625     */
27626    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27627
27628    /**
27629     * Set the cursor to be shown when mouse is over the diskselector item
27630     *
27631     * @param item Target item
27632     * @param cursor the cursor name to be used.
27633     *
27634     * @see elm_object_cursor_set() for more details.
27635     *
27636     * @ingroup Diskselector
27637     */
27638    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
27639
27640    /**
27641     * Get the cursor to be shown when mouse is over the diskselector item
27642     *
27643     * @param item diskselector item with cursor already set.
27644     * @return the cursor name.
27645     *
27646     * @see elm_object_cursor_get() for more details.
27647     * @see elm_diskselector_cursor_set()
27648     *
27649     * @ingroup Diskselector
27650     */
27651    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27652
27653    /**
27654     * Unset the cursor to be shown when mouse is over the diskselector item
27655     *
27656     * @param item Target item
27657     *
27658     * @see elm_object_cursor_unset() for more details.
27659     * @see elm_diskselector_cursor_set()
27660     *
27661     * @ingroup Diskselector
27662     */
27663    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27664
27665    /**
27666     * Sets a different style for this item cursor.
27667     *
27668     * @note before you set a style you should define a cursor with
27669     *       elm_diskselector_item_cursor_set()
27670     *
27671     * @param item diskselector item with cursor already set.
27672     * @param style the theme style to use (default, transparent, ...)
27673     *
27674     * @see elm_object_cursor_style_set() for more details.
27675     *
27676     * @ingroup Diskselector
27677     */
27678    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
27679
27680    /**
27681     * Get the style for this item cursor.
27682     *
27683     * @param item diskselector item with cursor already set.
27684     * @return style the theme style in use, defaults to "default". If the
27685     *         object does not have a cursor set, then @c NULL is returned.
27686     *
27687     * @see elm_object_cursor_style_get() for more details.
27688     * @see elm_diskselector_item_cursor_style_set()
27689     *
27690     * @ingroup Diskselector
27691     */
27692    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27693
27694
27695    /**
27696     * Set if the cursor set should be searched on the theme or should use
27697     * the provided by the engine, only.
27698     *
27699     * @note before you set if should look on theme you should define a cursor
27700     * with elm_diskselector_item_cursor_set().
27701     * By default it will only look for cursors provided by the engine.
27702     *
27703     * @param item widget item with cursor already set.
27704     * @param engine_only boolean to define if cursors set with
27705     * elm_diskselector_item_cursor_set() should be searched only
27706     * between cursors provided by the engine or searched on widget's
27707     * theme as well.
27708     *
27709     * @see elm_object_cursor_engine_only_set() for more details.
27710     *
27711     * @ingroup Diskselector
27712     */
27713    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
27714
27715    /**
27716     * Get the cursor engine only usage for this item cursor.
27717     *
27718     * @param item widget item with cursor already set.
27719     * @return engine_only boolean to define it cursors should be looked only
27720     * between the provided by the engine or searched on widget's theme as well.
27721     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
27722     *
27723     * @see elm_object_cursor_engine_only_get() for more details.
27724     * @see elm_diskselector_item_cursor_engine_only_set()
27725     *
27726     * @ingroup Diskselector
27727     */
27728    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
27729
27730    /**
27731     * @}
27732     */
27733
27734    /**
27735     * @defgroup Colorselector Colorselector
27736     *
27737     * @{
27738     *
27739     * @image html img/widget/colorselector/preview-00.png
27740     * @image latex img/widget/colorselector/preview-00.eps
27741     *
27742     * @brief Widget for user to select a color.
27743     *
27744     * Signals that you can add callbacks for are:
27745     * "changed" - When the color value changes(event_info is NULL).
27746     *
27747     * See @ref tutorial_colorselector.
27748     */
27749    /**
27750     * @brief Add a new colorselector to the parent
27751     *
27752     * @param parent The parent object
27753     * @return The new object or NULL if it cannot be created
27754     *
27755     * @ingroup Colorselector
27756     */
27757    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27758    /**
27759     * Set a color for the colorselector
27760     *
27761     * @param obj   Colorselector object
27762     * @param r     r-value of color
27763     * @param g     g-value of color
27764     * @param b     b-value of color
27765     * @param a     a-value of color
27766     *
27767     * @ingroup Colorselector
27768     */
27769    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
27770    /**
27771     * Get a color from the colorselector
27772     *
27773     * @param obj   Colorselector object
27774     * @param r     integer pointer for r-value of color
27775     * @param g     integer pointer for g-value of color
27776     * @param b     integer pointer for b-value of color
27777     * @param a     integer pointer for a-value of color
27778     *
27779     * @ingroup Colorselector
27780     */
27781    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
27782    /**
27783     * @}
27784     */
27785
27786    /**
27787     * @defgroup Ctxpopup Ctxpopup
27788     *
27789     * @image html img/widget/ctxpopup/preview-00.png
27790     * @image latex img/widget/ctxpopup/preview-00.eps
27791     *
27792     * @brief Context popup widet.
27793     *
27794     * A ctxpopup is a widget that, when shown, pops up a list of items.
27795     * It automatically chooses an area inside its parent object's view
27796     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
27797     * optimally fit into it. In the default theme, it will also point an
27798     * arrow to it's top left position at the time one shows it. Ctxpopup
27799     * items have a label and/or an icon. It is intended for a small
27800     * number of items (hence the use of list, not genlist).
27801     *
27802     * @note Ctxpopup is a especialization of @ref Hover.
27803     *
27804     * Signals that you can add callbacks for are:
27805     * "dismissed" - the ctxpopup was dismissed
27806     *
27807     * Default contents parts of the ctxpopup widget that you can use for are:
27808     * @li "default" - A content of the ctxpopup
27809     *
27810     * Default contents parts of the ctxpopup items that you can use for are:
27811     * @li "icon" - An icon in the title area
27812     *
27813     * Default text parts of the ctxpopup items that you can use for are:
27814     * @li "default" - Title label in the title area
27815     *
27816     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
27817     * @{
27818     */
27819
27820    /**
27821     * @addtogroup Ctxpopup
27822     * @{
27823     */
27824
27825    typedef enum _Elm_Ctxpopup_Direction
27826      {
27827         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
27828                                           area */
27829         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
27830                                            the clicked area */
27831         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
27832                                           the clicked area */
27833         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
27834                                         area */
27835         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
27836      } Elm_Ctxpopup_Direction;
27837
27838    /**
27839     * @brief Add a new Ctxpopup object to the parent.
27840     *
27841     * @param parent Parent object
27842     * @return New object or @c NULL, if it cannot be created
27843     *
27844     * @ingroup Ctxpopup
27845     */
27846    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27847
27848    /**
27849     * @brief Set the Ctxpopup's parent
27850     *
27851     * @param obj The ctxpopup object
27852     * @param area The parent to use
27853     *
27854     * Set the parent object.
27855     *
27856     * @note elm_ctxpopup_add() will automatically call this function
27857     * with its @c parent argument.
27858     *
27859     * @see elm_ctxpopup_add()
27860     * @see elm_hover_parent_set()
27861     *
27862     * @ingroup Ctxpopup
27863     */
27864    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
27865
27866    /**
27867     * @brief Get the Ctxpopup's parent
27868     *
27869     * @param obj The ctxpopup object
27870     *
27871     * @see elm_ctxpopup_hover_parent_set() for more information
27872     *
27873     * @ingroup Ctxpopup
27874     */
27875    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27876
27877    /**
27878     * @brief Clear all items in the given ctxpopup object.
27879     *
27880     * @param obj Ctxpopup object
27881     *
27882     * @ingroup Ctxpopup
27883     */
27884    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
27885
27886    /**
27887     * @brief Change the ctxpopup's orientation to horizontal or vertical.
27888     *
27889     * @param obj Ctxpopup object
27890     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
27891     *
27892     * @ingroup Ctxpopup
27893     */
27894    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
27895
27896    /**
27897     * @brief Get the value of current ctxpopup object's orientation.
27898     *
27899     * @param obj Ctxpopup object
27900     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
27901     *
27902     * @see elm_ctxpopup_horizontal_set()
27903     *
27904     * @ingroup Ctxpopup
27905     */
27906    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27907
27908    /**
27909     * @brief Add a new item to a ctxpopup object.
27910     *
27911     * @param obj Ctxpopup object
27912     * @param icon Icon to be set on new item
27913     * @param label The Label of the new item
27914     * @param func Convenience function called when item selected
27915     * @param data Data passed to @p func
27916     * @return A handle to the item added or @c NULL, on errors
27917     *
27918     * @warning Ctxpopup can't hold both an item list and a content at the same
27919     * time. When an item is added, any previous content will be removed.
27920     *
27921     * @see elm_ctxpopup_content_set()
27922     *
27923     * @ingroup Ctxpopup
27924     */
27925    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);
27926
27927    /**
27928     * @brief Delete the given item in a ctxpopup object.
27929     *
27930     * @param it Ctxpopup item to be deleted
27931     *
27932     * @see elm_ctxpopup_item_append()
27933     *
27934     * @ingroup Ctxpopup
27935     */
27936    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27937
27938    /**
27939     * @brief Set the ctxpopup item's state as disabled or enabled.
27940     *
27941     * @param it Ctxpopup item to be enabled/disabled
27942     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
27943     *
27944     * When disabled the item is greyed out to indicate it's state.
27945     * @deprecated use elm_object_item_disabled_set() instead
27946     *
27947     * @ingroup Ctxpopup
27948     */
27949    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
27950
27951    /**
27952     * @brief Get the ctxpopup item's disabled/enabled state.
27953     *
27954     * @param it Ctxpopup item to be enabled/disabled
27955     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
27956     *
27957     * @see elm_ctxpopup_item_disabled_set()
27958     * @deprecated use elm_object_item_disabled_get() instead
27959     *
27960     * @ingroup Ctxpopup
27961     */
27962    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27963
27964    /**
27965     * @brief Get the icon object for the given ctxpopup item.
27966     *
27967     * @param it Ctxpopup item
27968     * @return icon object or @c NULL, if the item does not have icon or an error
27969     * occurred
27970     *
27971     * @see elm_ctxpopup_item_append()
27972     * @see elm_ctxpopup_item_icon_set()
27973     *
27974     * @deprecated use elm_object_item_part_content_get() instead
27975     *
27976     * @ingroup Ctxpopup
27977     */
27978    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
27979
27980    /**
27981     * @brief Sets the side icon associated with the ctxpopup item
27982     *
27983     * @param it Ctxpopup item
27984     * @param icon Icon object to be set
27985     *
27986     * Once the icon object is set, a previously set one will be deleted.
27987     * @warning Setting the same icon for two items will cause the icon to
27988     * dissapear from the first item.
27989     *
27990     * @see elm_ctxpopup_item_append()
27991     *
27992     * @deprecated use elm_object_item_part_content_set() instead
27993     *
27994     * @ingroup Ctxpopup
27995     */
27996    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27997
27998    /**
27999     * @brief Get the label for the given ctxpopup item.
28000     *
28001     * @param it Ctxpopup item
28002     * @return label string or @c NULL, if the item does not have label or an
28003     * error occured
28004     *
28005     * @see elm_ctxpopup_item_append()
28006     * @see elm_ctxpopup_item_label_set()
28007     *
28008     * @deprecated use elm_object_item_text_get() instead
28009     *
28010     * @ingroup Ctxpopup
28011     */
28012    EINA_DEPRECATED EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28013
28014    /**
28015     * @brief (Re)set the label on the given ctxpopup item.
28016     *
28017     * @param it Ctxpopup item
28018     * @param label String to set as label
28019     *
28020     * @deprecated use elm_object_item_text_set() instead
28021     *
28022     * @ingroup Ctxpopup
28023     */
28024    EINA_DEPRECATED EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
28025
28026    /**
28027     * @brief Set an elm widget as the content of the ctxpopup.
28028     *
28029     * @param obj Ctxpopup object
28030     * @param content Content to be swallowed
28031     *
28032     * If the content object is already set, a previous one will bedeleted. If
28033     * you want to keep that old content object, use the
28034     * elm_ctxpopup_content_unset() function.
28035     *
28036     * @warning Ctxpopup can't hold both a item list and a content at the same
28037     * time. When a content is set, any previous items will be removed.
28038     *
28039     * @deprecated use elm_object_content_set() instead
28040     *
28041     * @ingroup Ctxpopup
28042     */
28043    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
28044
28045    /**
28046     * @brief Unset the ctxpopup content
28047     *
28048     * @param obj Ctxpopup object
28049     * @return The content that was being used
28050     *
28051     * Unparent and return the content object which was set for this widget.
28052     *
28053     * @deprecated use elm_object_content_unset()
28054     *
28055     * @see elm_ctxpopup_content_set()
28056     *
28057     * @deprecated use elm_object_content_unset() instead
28058     *
28059     * @ingroup Ctxpopup
28060     */
28061    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
28062
28063    /**
28064     * @brief Set the direction priority of a ctxpopup.
28065     *
28066     * @param obj Ctxpopup object
28067     * @param first 1st priority of direction
28068     * @param second 2nd priority of direction
28069     * @param third 3th priority of direction
28070     * @param fourth 4th priority of direction
28071     *
28072     * This functions gives a chance to user to set the priority of ctxpopup
28073     * showing direction. This doesn't guarantee the ctxpopup will appear in the
28074     * requested direction.
28075     *
28076     * @see Elm_Ctxpopup_Direction
28077     *
28078     * @ingroup Ctxpopup
28079     */
28080    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);
28081
28082    /**
28083     * @brief Get the direction priority of a ctxpopup.
28084     *
28085     * @param obj Ctxpopup object
28086     * @param first 1st priority of direction to be returned
28087     * @param second 2nd priority of direction to be returned
28088     * @param third 3th priority of direction to be returned
28089     * @param fourth 4th priority of direction to be returned
28090     *
28091     * @see elm_ctxpopup_direction_priority_set() for more information.
28092     *
28093     * @ingroup Ctxpopup
28094     */
28095    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);
28096
28097    /**
28098     * @brief Get the current direction of a ctxpopup.
28099     *
28100     * @param obj Ctxpopup object
28101     * @return current direction of a ctxpopup
28102     *
28103     * @warning Once the ctxpopup showed up, the direction would be determined
28104     *
28105     * @ingroup Ctxpopup
28106     */
28107    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28108
28109    /**
28110     * @}
28111     */
28112
28113    /* transit */
28114    /**
28115     *
28116     * @defgroup Transit Transit
28117     * @ingroup Elementary
28118     *
28119     * Transit is designed to apply various animated transition effects to @c
28120     * Evas_Object, such like translation, rotation, etc. For using these
28121     * effects, create an @ref Elm_Transit and add the desired transition effects.
28122     *
28123     * Once the effects are added into transit, they will be automatically
28124     * managed (their callback will be called until the duration is ended, and
28125     * they will be deleted on completion).
28126     *
28127     * Example:
28128     * @code
28129     * Elm_Transit *trans = elm_transit_add();
28130     * elm_transit_object_add(trans, obj);
28131     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
28132     * elm_transit_duration_set(transit, 1);
28133     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
28134     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
28135     * elm_transit_repeat_times_set(transit, 3);
28136     * @endcode
28137     *
28138     * Some transition effects are used to change the properties of objects. They
28139     * are:
28140     * @li @ref elm_transit_effect_translation_add
28141     * @li @ref elm_transit_effect_color_add
28142     * @li @ref elm_transit_effect_rotation_add
28143     * @li @ref elm_transit_effect_wipe_add
28144     * @li @ref elm_transit_effect_zoom_add
28145     * @li @ref elm_transit_effect_resizing_add
28146     *
28147     * Other transition effects are used to make one object disappear and another
28148     * object appear on its old place. These effects are:
28149     *
28150     * @li @ref elm_transit_effect_flip_add
28151     * @li @ref elm_transit_effect_resizable_flip_add
28152     * @li @ref elm_transit_effect_fade_add
28153     * @li @ref elm_transit_effect_blend_add
28154     *
28155     * It's also possible to make a transition chain with @ref
28156     * elm_transit_chain_transit_add.
28157     *
28158     * @warning We strongly recommend to use elm_transit just when edje can not do
28159     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
28160     * animations can be manipulated inside the theme.
28161     *
28162     * List of examples:
28163     * @li @ref transit_example_01_explained
28164     * @li @ref transit_example_02_explained
28165     * @li @ref transit_example_03_c
28166     * @li @ref transit_example_04_c
28167     *
28168     * @{
28169     */
28170
28171    /**
28172     * @enum Elm_Transit_Tween_Mode
28173     *
28174     * The type of acceleration used in the transition.
28175     */
28176    typedef enum
28177      {
28178         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
28179         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
28180                                              over time, then decrease again
28181                                              and stop slowly */
28182         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
28183                                              speed over time */
28184         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
28185                                             over time */
28186      } Elm_Transit_Tween_Mode;
28187
28188    /**
28189     * @enum Elm_Transit_Effect_Flip_Axis
28190     *
28191     * The axis where flip effect should be applied.
28192     */
28193    typedef enum
28194      {
28195         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
28196         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
28197      } Elm_Transit_Effect_Flip_Axis;
28198
28199    /**
28200     * @enum Elm_Transit_Effect_Wipe_Dir
28201     *
28202     * The direction where the wipe effect should occur.
28203     */
28204    typedef enum
28205      {
28206         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
28207         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
28208         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
28209         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
28210      } Elm_Transit_Effect_Wipe_Dir;
28211
28212    /** @enum Elm_Transit_Effect_Wipe_Type
28213     *
28214     * Whether the wipe effect should show or hide the object.
28215     */
28216    typedef enum
28217      {
28218         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
28219                                              animation */
28220         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
28221                                             animation */
28222      } Elm_Transit_Effect_Wipe_Type;
28223
28224    /**
28225     * @typedef Elm_Transit
28226     *
28227     * The Transit created with elm_transit_add(). This type has the information
28228     * about the objects which the transition will be applied, and the
28229     * transition effects that will be used. It also contains info about
28230     * duration, number of repetitions, auto-reverse, etc.
28231     */
28232    typedef struct _Elm_Transit Elm_Transit;
28233    typedef void Elm_Transit_Effect;
28234
28235    /**
28236     * @typedef Elm_Transit_Effect_Transition_Cb
28237     *
28238     * Transition callback called for this effect on each transition iteration.
28239     */
28240    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
28241
28242    /**
28243     * Elm_Transit_Effect_End_Cb
28244     *
28245     * Transition callback called for this effect when the transition is over.
28246     */
28247    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
28248
28249    /**
28250     * Elm_Transit_Del_Cb
28251     *
28252     * A callback called when the transit is deleted.
28253     */
28254    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
28255
28256    /**
28257     * Add new transit.
28258     *
28259     * @note Is not necessary to delete the transit object, it will be deleted at
28260     * the end of its operation.
28261     * @note The transit will start playing when the program enter in the main loop, is not
28262     * necessary to give a start to the transit.
28263     *
28264     * @return The transit object.
28265     *
28266     * @ingroup Transit
28267     */
28268    EAPI Elm_Transit                *elm_transit_add(void);
28269
28270    /**
28271     * Stops the animation and delete the @p transit object.
28272     *
28273     * Call this function if you wants to stop the animation before the duration
28274     * time. Make sure the @p transit object is still alive with
28275     * elm_transit_del_cb_set() function.
28276     * All added effects will be deleted, calling its repective data_free_cb
28277     * functions. The function setted by elm_transit_del_cb_set() will be called.
28278     *
28279     * @see elm_transit_del_cb_set()
28280     *
28281     * @param transit The transit object to be deleted.
28282     *
28283     * @ingroup Transit
28284     * @warning Just call this function if you are sure the transit is alive.
28285     */
28286    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28287
28288    /**
28289     * Add a new effect to the transit.
28290     *
28291     * @note The cb function and the data are the key to the effect. If you try to
28292     * add an already added effect, nothing is done.
28293     * @note After the first addition of an effect in @p transit, if its
28294     * effect list become empty again, the @p transit will be killed by
28295     * elm_transit_del(transit) function.
28296     *
28297     * Exemple:
28298     * @code
28299     * Elm_Transit *transit = elm_transit_add();
28300     * elm_transit_effect_add(transit,
28301     *                        elm_transit_effect_blend_op,
28302     *                        elm_transit_effect_blend_context_new(),
28303     *                        elm_transit_effect_blend_context_free);
28304     * @endcode
28305     *
28306     * @param transit The transit object.
28307     * @param transition_cb The operation function. It is called when the
28308     * animation begins, it is the function that actually performs the animation.
28309     * It is called with the @p data, @p transit and the time progression of the
28310     * animation (a double value between 0.0 and 1.0).
28311     * @param effect The context data of the effect.
28312     * @param end_cb The function to free the context data, it will be called
28313     * at the end of the effect, it must finalize the animation and free the
28314     * @p data.
28315     *
28316     * @ingroup Transit
28317     * @warning The transit free the context data at the and of the transition with
28318     * the data_free_cb function, do not use the context data in another transit.
28319     */
28320    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);
28321
28322    /**
28323     * Delete an added effect.
28324     *
28325     * This function will remove the effect from the @p transit, calling the
28326     * data_free_cb to free the @p data.
28327     *
28328     * @see elm_transit_effect_add()
28329     *
28330     * @note If the effect is not found, nothing is done.
28331     * @note If the effect list become empty, this function will call
28332     * elm_transit_del(transit), that is, it will kill the @p transit.
28333     *
28334     * @param transit The transit object.
28335     * @param transition_cb The operation function.
28336     * @param effect The context data of the effect.
28337     *
28338     * @ingroup Transit
28339     */
28340    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);
28341
28342    /**
28343     * Add new object to apply the effects.
28344     *
28345     * @note After the first addition of an object in @p transit, if its
28346     * object list become empty again, the @p transit will be killed by
28347     * elm_transit_del(transit) function.
28348     * @note If the @p obj belongs to another transit, the @p obj will be
28349     * removed from it and it will only belong to the @p transit. If the old
28350     * transit stays without objects, it will die.
28351     * @note When you add an object into the @p transit, its state from
28352     * evas_object_pass_events_get(obj) is saved, and it is applied when the
28353     * transit ends, if you change this state whith evas_object_pass_events_set()
28354     * after add the object, this state will change again when @p transit stops to
28355     * run.
28356     *
28357     * @param transit The transit object.
28358     * @param obj Object to be animated.
28359     *
28360     * @ingroup Transit
28361     * @warning It is not allowed to add a new object after transit begins to go.
28362     */
28363    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28364
28365    /**
28366     * Removes an added object from the transit.
28367     *
28368     * @note If the @p obj is not in the @p transit, nothing is done.
28369     * @note If the list become empty, this function will call
28370     * elm_transit_del(transit), that is, it will kill the @p transit.
28371     *
28372     * @param transit The transit object.
28373     * @param obj Object to be removed from @p transit.
28374     *
28375     * @ingroup Transit
28376     * @warning It is not allowed to remove objects after transit begins to go.
28377     */
28378    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
28379
28380    /**
28381     * Get the objects of the transit.
28382     *
28383     * @param transit The transit object.
28384     * @return a Eina_List with the objects from the transit.
28385     *
28386     * @ingroup Transit
28387     */
28388    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28389
28390    /**
28391     * Enable/disable keeping up the objects states.
28392     * If it is not kept, the objects states will be reset when transition ends.
28393     *
28394     * @note @p transit can not be NULL.
28395     * @note One state includes geometry, color, map data.
28396     *
28397     * @param transit The transit object.
28398     * @param state_keep Keeping or Non Keeping.
28399     *
28400     * @ingroup Transit
28401     */
28402    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
28403
28404    /**
28405     * Get a value whether the objects states will be reset or not.
28406     *
28407     * @note @p transit can not be NULL
28408     *
28409     * @see elm_transit_objects_final_state_keep_set()
28410     *
28411     * @param transit The transit object.
28412     * @return EINA_TRUE means the states of the objects will be reset.
28413     * If @p transit is NULL, EINA_FALSE is returned
28414     *
28415     * @ingroup Transit
28416     */
28417    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28418
28419    /**
28420     * Set the event enabled when transit is operating.
28421     *
28422     * If @p enabled is EINA_TRUE, the objects of the transit will receives
28423     * events from mouse and keyboard during the animation.
28424     * @note When you add an object with elm_transit_object_add(), its state from
28425     * evas_object_pass_events_get(obj) is saved, and it is applied when the
28426     * transit ends, if you change this state with evas_object_pass_events_set()
28427     * after adding the object, this state will change again when @p transit stops
28428     * to run.
28429     *
28430     * @param transit The transit object.
28431     * @param enabled Events are received when enabled is @c EINA_TRUE, and
28432     * ignored otherwise.
28433     *
28434     * @ingroup Transit
28435     */
28436    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
28437
28438    /**
28439     * Get the value of event enabled status.
28440     *
28441     * @see elm_transit_event_enabled_set()
28442     *
28443     * @param transit The Transit object
28444     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
28445     * EINA_FALSE is returned
28446     *
28447     * @ingroup Transit
28448     */
28449    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28450
28451    /**
28452     * Set the user-callback function when the transit is deleted.
28453     *
28454     * @note Using this function twice will overwrite the first function setted.
28455     * @note the @p transit object will be deleted after call @p cb function.
28456     *
28457     * @param transit The transit object.
28458     * @param cb Callback function pointer. This function will be called before
28459     * the deletion of the transit.
28460     * @param data Callback funtion user data. It is the @p op parameter.
28461     *
28462     * @ingroup Transit
28463     */
28464    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
28465
28466    /**
28467     * Set reverse effect automatically.
28468     *
28469     * If auto reverse is setted, after running the effects with the progress
28470     * parameter from 0 to 1, it will call the effecs again with the progress
28471     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
28472     * where the duration was setted with the function elm_transit_add and
28473     * the repeat with the function elm_transit_repeat_times_set().
28474     *
28475     * @param transit The transit object.
28476     * @param reverse EINA_TRUE means the auto_reverse is on.
28477     *
28478     * @ingroup Transit
28479     */
28480    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
28481
28482    /**
28483     * Get if the auto reverse is on.
28484     *
28485     * @see elm_transit_auto_reverse_set()
28486     *
28487     * @param transit The transit object.
28488     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
28489     * EINA_FALSE is returned
28490     *
28491     * @ingroup Transit
28492     */
28493    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28494
28495    /**
28496     * Set the transit repeat count. Effect will be repeated by repeat count.
28497     *
28498     * This function sets the number of repetition the transit will run after
28499     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
28500     * If the @p repeat is a negative number, it will repeat infinite times.
28501     *
28502     * @note If this function is called during the transit execution, the transit
28503     * will run @p repeat times, ignoring the times it already performed.
28504     *
28505     * @param transit The transit object
28506     * @param repeat Repeat count
28507     *
28508     * @ingroup Transit
28509     */
28510    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
28511
28512    /**
28513     * Get the transit repeat count.
28514     *
28515     * @see elm_transit_repeat_times_set()
28516     *
28517     * @param transit The Transit object.
28518     * @return The repeat count. If @p transit is NULL
28519     * 0 is returned
28520     *
28521     * @ingroup Transit
28522     */
28523    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28524
28525    /**
28526     * Set the transit animation acceleration type.
28527     *
28528     * This function sets the tween mode of the transit that can be:
28529     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
28530     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
28531     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
28532     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
28533     *
28534     * @param transit The transit object.
28535     * @param tween_mode The tween type.
28536     *
28537     * @ingroup Transit
28538     */
28539    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
28540
28541    /**
28542     * Get the transit animation acceleration type.
28543     *
28544     * @note @p transit can not be NULL
28545     *
28546     * @param transit The transit object.
28547     * @return The tween type. If @p transit is NULL
28548     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
28549     *
28550     * @ingroup Transit
28551     */
28552    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28553
28554    /**
28555     * Set the transit animation time
28556     *
28557     * @note @p transit can not be NULL
28558     *
28559     * @param transit The transit object.
28560     * @param duration The animation time.
28561     *
28562     * @ingroup Transit
28563     */
28564    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
28565
28566    /**
28567     * Get the transit animation time
28568     *
28569     * @note @p transit can not be NULL
28570     *
28571     * @param transit The transit object.
28572     *
28573     * @return The transit animation time.
28574     *
28575     * @ingroup Transit
28576     */
28577    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28578
28579    /**
28580     * Starts the transition.
28581     * Once this API is called, the transit begins to measure the time.
28582     *
28583     * @note @p transit can not be NULL
28584     *
28585     * @param transit The transit object.
28586     *
28587     * @ingroup Transit
28588     */
28589    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
28590
28591    /**
28592     * Pause/Resume the transition.
28593     *
28594     * If you call elm_transit_go again, the transit will be started from the
28595     * beginning, and will be unpaused.
28596     *
28597     * @note @p transit can not be NULL
28598     *
28599     * @param transit The transit object.
28600     * @param paused Whether the transition should be paused or not.
28601     *
28602     * @ingroup Transit
28603     */
28604    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
28605
28606    /**
28607     * Get the value of paused status.
28608     *
28609     * @see elm_transit_paused_set()
28610     *
28611     * @note @p transit can not be NULL
28612     *
28613     * @param transit The transit object.
28614     * @return EINA_TRUE means transition is paused. If @p transit is NULL
28615     * EINA_FALSE is returned
28616     *
28617     * @ingroup Transit
28618     */
28619    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28620
28621    /**
28622     * Get the time progression of the animation (a double value between 0.0 and 1.0).
28623     *
28624     * The value returned is a fraction (current time / total time). It
28625     * represents the progression position relative to the total.
28626     *
28627     * @note @p transit can not be NULL
28628     *
28629     * @param transit The transit object.
28630     *
28631     * @return The time progression value. If @p transit is NULL
28632     * 0 is returned
28633     *
28634     * @ingroup Transit
28635     */
28636    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
28637
28638    /**
28639     * Makes the chain relationship between two transits.
28640     *
28641     * @note @p transit can not be NULL. Transit would have multiple chain transits.
28642     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
28643     *
28644     * @param transit The transit object.
28645     * @param chain_transit The chain transit object. This transit will be operated
28646     *        after transit is done.
28647     *
28648     * This function adds @p chain_transit transition to a chain after the @p
28649     * transit, and will be started as soon as @p transit ends. See @ref
28650     * transit_example_02_explained for a full example.
28651     *
28652     * @ingroup Transit
28653     */
28654    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
28655
28656    /**
28657     * Cut off the chain relationship between two transits.
28658     *
28659     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
28660     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
28661     *
28662     * @param transit The transit object.
28663     * @param chain_transit The chain transit object.
28664     *
28665     * This function remove the @p chain_transit transition from the @p transit.
28666     *
28667     * @ingroup Transit
28668     */
28669    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
28670
28671    /**
28672     * Get the current chain transit list.
28673     *
28674     * @note @p transit can not be NULL.
28675     *
28676     * @param transit The transit object.
28677     * @return chain transit list.
28678     *
28679     * @ingroup Transit
28680     */
28681    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
28682
28683    /**
28684     * Add the Resizing Effect to Elm_Transit.
28685     *
28686     * @note This API is one of the facades. It creates resizing effect context
28687     * and add it's required APIs to elm_transit_effect_add.
28688     *
28689     * @see elm_transit_effect_add()
28690     *
28691     * @param transit Transit object.
28692     * @param from_w Object width size when effect begins.
28693     * @param from_h Object height size when effect begins.
28694     * @param to_w Object width size when effect ends.
28695     * @param to_h Object height size when effect ends.
28696     * @return Resizing effect context data.
28697     *
28698     * @ingroup Transit
28699     */
28700    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);
28701
28702    /**
28703     * Add the Translation Effect to Elm_Transit.
28704     *
28705     * @note This API is one of the facades. It creates translation effect context
28706     * and add it's required APIs to elm_transit_effect_add.
28707     *
28708     * @see elm_transit_effect_add()
28709     *
28710     * @param transit Transit object.
28711     * @param from_dx X Position variation when effect begins.
28712     * @param from_dy Y Position variation when effect begins.
28713     * @param to_dx X Position variation when effect ends.
28714     * @param to_dy Y Position variation when effect ends.
28715     * @return Translation effect context data.
28716     *
28717     * @ingroup Transit
28718     * @warning It is highly recommended just create a transit with this effect when
28719     * the window that the objects of the transit belongs has already been created.
28720     * This is because this effect needs the geometry information about the objects,
28721     * and if the window was not created yet, it can get a wrong information.
28722     */
28723    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);
28724
28725    /**
28726     * Add the Zoom Effect to Elm_Transit.
28727     *
28728     * @note This API is one of the facades. It creates zoom effect context
28729     * and add it's required APIs to elm_transit_effect_add.
28730     *
28731     * @see elm_transit_effect_add()
28732     *
28733     * @param transit Transit object.
28734     * @param from_rate Scale rate when effect begins (1 is current rate).
28735     * @param to_rate Scale rate when effect ends.
28736     * @return Zoom effect context data.
28737     *
28738     * @ingroup Transit
28739     * @warning It is highly recommended just create a transit with this effect when
28740     * the window that the objects of the transit belongs has already been created.
28741     * This is because this effect needs the geometry information about the objects,
28742     * and if the window was not created yet, it can get a wrong information.
28743     */
28744    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
28745
28746    /**
28747     * Add the Flip Effect to Elm_Transit.
28748     *
28749     * @note This API is one of the facades. It creates flip effect context
28750     * and add it's required APIs to elm_transit_effect_add.
28751     * @note This effect is applied to each pair of objects in the order they are listed
28752     * in the transit list of objects. The first object in the pair will be the
28753     * "front" object and the second will be the "back" object.
28754     *
28755     * @see elm_transit_effect_add()
28756     *
28757     * @param transit Transit object.
28758     * @param axis Flipping Axis(X or Y).
28759     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28760     * @return Flip effect context data.
28761     *
28762     * @ingroup Transit
28763     * @warning It is highly recommended just create a transit with this effect when
28764     * the window that the objects of the transit belongs has already been created.
28765     * This is because this effect needs the geometry information about the objects,
28766     * and if the window was not created yet, it can get a wrong information.
28767     */
28768    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28769
28770    /**
28771     * Add the Resizable Flip Effect to Elm_Transit.
28772     *
28773     * @note This API is one of the facades. It creates resizable flip effect context
28774     * and add it's required APIs to elm_transit_effect_add.
28775     * @note This effect is applied to each pair of objects in the order they are listed
28776     * in the transit list of objects. The first object in the pair will be the
28777     * "front" object and the second will be the "back" object.
28778     *
28779     * @see elm_transit_effect_add()
28780     *
28781     * @param transit Transit object.
28782     * @param axis Flipping Axis(X or Y).
28783     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
28784     * @return Resizable flip effect context data.
28785     *
28786     * @ingroup Transit
28787     * @warning It is highly recommended just create a transit with this effect when
28788     * the window that the objects of the transit belongs has already been created.
28789     * This is because this effect needs the geometry information about the objects,
28790     * and if the window was not created yet, it can get a wrong information.
28791     */
28792    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
28793
28794    /**
28795     * Add the Wipe Effect to Elm_Transit.
28796     *
28797     * @note This API is one of the facades. It creates wipe effect context
28798     * and add it's required APIs to elm_transit_effect_add.
28799     *
28800     * @see elm_transit_effect_add()
28801     *
28802     * @param transit Transit object.
28803     * @param type Wipe type. Hide or show.
28804     * @param dir Wipe Direction.
28805     * @return Wipe effect context data.
28806     *
28807     * @ingroup Transit
28808     * @warning It is highly recommended just create a transit with this effect when
28809     * the window that the objects of the transit belongs has already been created.
28810     * This is because this effect needs the geometry information about the objects,
28811     * and if the window was not created yet, it can get a wrong information.
28812     */
28813    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
28814
28815    /**
28816     * Add the Color Effect to Elm_Transit.
28817     *
28818     * @note This API is one of the facades. It creates color effect context
28819     * and add it's required APIs to elm_transit_effect_add.
28820     *
28821     * @see elm_transit_effect_add()
28822     *
28823     * @param transit        Transit object.
28824     * @param  from_r        RGB R when effect begins.
28825     * @param  from_g        RGB G when effect begins.
28826     * @param  from_b        RGB B when effect begins.
28827     * @param  from_a        RGB A when effect begins.
28828     * @param  to_r          RGB R when effect ends.
28829     * @param  to_g          RGB G when effect ends.
28830     * @param  to_b          RGB B when effect ends.
28831     * @param  to_a          RGB A when effect ends.
28832     * @return               Color effect context data.
28833     *
28834     * @ingroup Transit
28835     */
28836    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);
28837
28838    /**
28839     * Add the Fade Effect to Elm_Transit.
28840     *
28841     * @note This API is one of the facades. It creates fade effect context
28842     * and add it's required APIs to elm_transit_effect_add.
28843     * @note This effect is applied to each pair of objects in the order they are listed
28844     * in the transit list of objects. The first object in the pair will be the
28845     * "before" object and the second will be the "after" object.
28846     *
28847     * @see elm_transit_effect_add()
28848     *
28849     * @param transit Transit object.
28850     * @return Fade effect context data.
28851     *
28852     * @ingroup Transit
28853     * @warning It is highly recommended just create a transit with this effect when
28854     * the window that the objects of the transit belongs has already been created.
28855     * This is because this effect needs the color information about the objects,
28856     * and if the window was not created yet, it can get a wrong information.
28857     */
28858    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
28859
28860    /**
28861     * Add the Blend Effect to Elm_Transit.
28862     *
28863     * @note This API is one of the facades. It creates blend effect context
28864     * and add it's required APIs to elm_transit_effect_add.
28865     * @note This effect is applied to each pair of objects in the order they are listed
28866     * in the transit list of objects. The first object in the pair will be the
28867     * "before" object and the second will be the "after" object.
28868     *
28869     * @see elm_transit_effect_add()
28870     *
28871     * @param transit Transit object.
28872     * @return Blend effect context data.
28873     *
28874     * @ingroup Transit
28875     * @warning It is highly recommended just create a transit with this effect when
28876     * the window that the objects of the transit belongs has already been created.
28877     * This is because this effect needs the color information about the objects,
28878     * and if the window was not created yet, it can get a wrong information.
28879     */
28880    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
28881
28882    /**
28883     * Add the Rotation Effect to Elm_Transit.
28884     *
28885     * @note This API is one of the facades. It creates rotation effect context
28886     * and add it's required APIs to elm_transit_effect_add.
28887     *
28888     * @see elm_transit_effect_add()
28889     *
28890     * @param transit Transit object.
28891     * @param from_degree Degree when effect begins.
28892     * @param to_degree Degree when effect is ends.
28893     * @return Rotation effect context data.
28894     *
28895     * @ingroup Transit
28896     * @warning It is highly recommended just create a transit with this effect when
28897     * the window that the objects of the transit belongs has already been created.
28898     * This is because this effect needs the geometry information about the objects,
28899     * and if the window was not created yet, it can get a wrong information.
28900     */
28901    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
28902
28903    /**
28904     * Add the ImageAnimation Effect to Elm_Transit.
28905     *
28906     * @note This API is one of the facades. It creates image animation effect context
28907     * and add it's required APIs to elm_transit_effect_add.
28908     * The @p images parameter is a list images paths. This list and
28909     * its contents will be deleted at the end of the effect by
28910     * elm_transit_effect_image_animation_context_free() function.
28911     *
28912     * Example:
28913     * @code
28914     * char buf[PATH_MAX];
28915     * Eina_List *images = NULL;
28916     * Elm_Transit *transi = elm_transit_add();
28917     *
28918     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
28919     * images = eina_list_append(images, eina_stringshare_add(buf));
28920     *
28921     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
28922     * images = eina_list_append(images, eina_stringshare_add(buf));
28923     * elm_transit_effect_image_animation_add(transi, images);
28924     *
28925     * @endcode
28926     *
28927     * @see elm_transit_effect_add()
28928     *
28929     * @param transit Transit object.
28930     * @param images Eina_List of images file paths. This list and
28931     * its contents will be deleted at the end of the effect by
28932     * elm_transit_effect_image_animation_context_free() function.
28933     * @return Image Animation effect context data.
28934     *
28935     * @ingroup Transit
28936     */
28937    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
28938    /**
28939     * @}
28940     */
28941
28942    typedef struct _Elm_Store                      Elm_Store;
28943    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
28944    typedef struct _Elm_Store_Item                 Elm_Store_Item;
28945    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
28946    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
28947    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
28948    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
28949    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
28950    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
28951    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
28952    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
28953
28954    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
28955    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
28956    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
28957    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
28958
28959    typedef enum
28960      {
28961         ELM_STORE_ITEM_MAPPING_NONE = 0,
28962         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
28963         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
28964         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
28965         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
28966         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
28967         // can add more here as needed by common apps
28968         ELM_STORE_ITEM_MAPPING_LAST
28969      } Elm_Store_Item_Mapping_Type;
28970
28971    struct _Elm_Store_Item_Mapping_Icon
28972      {
28973         // FIXME: allow edje file icons
28974         int                   w, h;
28975         Elm_Icon_Lookup_Order lookup_order;
28976         Eina_Bool             standard_name : 1;
28977         Eina_Bool             no_scale : 1;
28978         Eina_Bool             smooth : 1;
28979         Eina_Bool             scale_up : 1;
28980         Eina_Bool             scale_down : 1;
28981      };
28982
28983    struct _Elm_Store_Item_Mapping_Empty
28984      {
28985         Eina_Bool             dummy;
28986      };
28987
28988    struct _Elm_Store_Item_Mapping_Photo
28989      {
28990         int                   size;
28991      };
28992
28993    struct _Elm_Store_Item_Mapping_Custom
28994      {
28995         Elm_Store_Item_Mapping_Cb func;
28996      };
28997
28998    struct _Elm_Store_Item_Mapping
28999      {
29000         Elm_Store_Item_Mapping_Type     type;
29001         const char                     *part;
29002         int                             offset;
29003         union
29004           {
29005              Elm_Store_Item_Mapping_Empty  empty;
29006              Elm_Store_Item_Mapping_Icon   icon;
29007              Elm_Store_Item_Mapping_Photo  photo;
29008              Elm_Store_Item_Mapping_Custom custom;
29009              // add more types here
29010           } details;
29011      };
29012
29013    struct _Elm_Store_Item_Info
29014      {
29015         Elm_Genlist_Item_Class       *item_class;
29016         const Elm_Store_Item_Mapping *mapping;
29017         void                         *data;
29018         char                         *sort_id;
29019      };
29020
29021    struct _Elm_Store_Item_Info_Filesystem
29022      {
29023         Elm_Store_Item_Info  base;
29024         char                *path;
29025      };
29026
29027 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
29028 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
29029
29030    EAPI void                    elm_store_free(Elm_Store *st);
29031
29032    EAPI Elm_Store              *elm_store_filesystem_new(void);
29033    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
29034    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29035    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29036
29037    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
29038
29039    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
29040    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29041    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29042    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29043    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
29044    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29045
29046    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
29047    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
29048    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
29049    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
29050    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29051    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29052    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
29053
29054    /**
29055     * @defgroup SegmentControl SegmentControl
29056     * @ingroup Elementary
29057     *
29058     * @image html img/widget/segment_control/preview-00.png
29059     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
29060     *
29061     * @image html img/segment_control.png
29062     * @image latex img/segment_control.eps width=\textwidth
29063     *
29064     * Segment control widget is a horizontal control made of multiple segment
29065     * items, each segment item functioning similar to discrete two state button.
29066     * A segment control groups the items together and provides compact
29067     * single button with multiple equal size segments.
29068     *
29069     * Segment item size is determined by base widget
29070     * size and the number of items added.
29071     * Only one segment item can be at selected state. A segment item can display
29072     * combination of Text and any Evas_Object like Images or other widget.
29073     *
29074     * Smart callbacks one can listen to:
29075     * - "changed" - When the user clicks on a segment item which is not
29076     *   previously selected and get selected. The event_info parameter is the
29077     *   segment item pointer.
29078     *
29079     * Available styles for it:
29080     * - @c "default"
29081     *
29082     * Here is an example on its usage:
29083     * @li @ref segment_control_example
29084     */
29085
29086    /**
29087     * @addtogroup SegmentControl
29088     * @{
29089     */
29090
29091    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
29092
29093    /**
29094     * Add a new segment control widget to the given parent Elementary
29095     * (container) object.
29096     *
29097     * @param parent The parent object.
29098     * @return a new segment control widget handle or @c NULL, on errors.
29099     *
29100     * This function inserts a new segment control widget on the canvas.
29101     *
29102     * @ingroup SegmentControl
29103     */
29104    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29105
29106    /**
29107     * Append a new item to the segment control object.
29108     *
29109     * @param obj The segment control object.
29110     * @param icon The icon object to use for the left side of the item. An
29111     * icon can be any Evas object, but usually it is an icon created
29112     * with elm_icon_add().
29113     * @param label The label of the item.
29114     *        Note that, NULL is different from empty string "".
29115     * @return The created item or @c NULL upon failure.
29116     *
29117     * A new item will be created and appended to the segment control, i.e., will
29118     * be set as @b last item.
29119     *
29120     * If it should be inserted at another position,
29121     * elm_segment_control_item_insert_at() should be used instead.
29122     *
29123     * Items created with this function can be deleted with function
29124     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29125     *
29126     * @note @p label set to @c NULL is different from empty string "".
29127     * If an item
29128     * only has icon, it will be displayed bigger and centered. If it has
29129     * icon and label, even that an empty string, icon will be smaller and
29130     * positioned at left.
29131     *
29132     * Simple example:
29133     * @code
29134     * sc = elm_segment_control_add(win);
29135     * ic = elm_icon_add(win);
29136     * elm_icon_file_set(ic, "path/to/image", NULL);
29137     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
29138     * elm_segment_control_item_add(sc, ic, "label");
29139     * evas_object_show(sc);
29140     * @endcode
29141     *
29142     * @see elm_segment_control_item_insert_at()
29143     * @see elm_segment_control_item_del()
29144     *
29145     * @ingroup SegmentControl
29146     */
29147    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
29148
29149    /**
29150     * Insert a new item to the segment control object at specified position.
29151     *
29152     * @param obj The segment control object.
29153     * @param icon The icon object to use for the left side of the item. An
29154     * icon can be any Evas object, but usually it is an icon created
29155     * with elm_icon_add().
29156     * @param label The label of the item.
29157     * @param index Item position. Value should be between 0 and items count.
29158     * @return The created item or @c NULL upon failure.
29159
29160     * Index values must be between @c 0, when item will be prepended to
29161     * segment control, and items count, that can be get with
29162     * elm_segment_control_item_count_get(), case when item will be appended
29163     * to segment control, just like elm_segment_control_item_add().
29164     *
29165     * Items created with this function can be deleted with function
29166     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
29167     *
29168     * @note @p label set to @c NULL is different from empty string "".
29169     * If an item
29170     * only has icon, it will be displayed bigger and centered. If it has
29171     * icon and label, even that an empty string, icon will be smaller and
29172     * positioned at left.
29173     *
29174     * @see elm_segment_control_item_add()
29175     * @see elm_segment_control_item_count_get()
29176     * @see elm_segment_control_item_del()
29177     *
29178     * @ingroup SegmentControl
29179     */
29180    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);
29181
29182    /**
29183     * Remove a segment control item from its parent, deleting it.
29184     *
29185     * @param it The item to be removed.
29186     *
29187     * Items can be added with elm_segment_control_item_add() or
29188     * elm_segment_control_item_insert_at().
29189     *
29190     * @ingroup SegmentControl
29191     */
29192    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29193
29194    /**
29195     * Remove a segment control item at given index from its parent,
29196     * deleting it.
29197     *
29198     * @param obj The segment control object.
29199     * @param index The position of the segment control item to be deleted.
29200     *
29201     * Items can be added with elm_segment_control_item_add() or
29202     * elm_segment_control_item_insert_at().
29203     *
29204     * @ingroup SegmentControl
29205     */
29206    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29207
29208    /**
29209     * Get the Segment items count from segment control.
29210     *
29211     * @param obj The segment control object.
29212     * @return Segment items count.
29213     *
29214     * It will just return the number of items added to segment control @p obj.
29215     *
29216     * @ingroup SegmentControl
29217     */
29218    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29219
29220    /**
29221     * Get the item placed at specified index.
29222     *
29223     * @param obj The segment control object.
29224     * @param index The index of the segment item.
29225     * @return The segment control item or @c NULL on failure.
29226     *
29227     * Index is the position of an item in segment control widget. Its
29228     * range is from @c 0 to <tt> count - 1 </tt>.
29229     * Count is the number of items, that can be get with
29230     * elm_segment_control_item_count_get().
29231     *
29232     * @ingroup SegmentControl
29233     */
29234    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29235
29236    /**
29237     * Get the label of item.
29238     *
29239     * @param obj The segment control object.
29240     * @param index The index of the segment item.
29241     * @return The label of the item at @p index.
29242     *
29243     * The return value is a pointer to the label associated to the item when
29244     * it was created, with function elm_segment_control_item_add(), or later
29245     * with function elm_segment_control_item_label_set. If no label
29246     * was passed as argument, it will return @c NULL.
29247     *
29248     * @see elm_segment_control_item_label_set() for more details.
29249     * @see elm_segment_control_item_add()
29250     *
29251     * @ingroup SegmentControl
29252     */
29253    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29254
29255    /**
29256     * Set the label of item.
29257     *
29258     * @param it The item of segment control.
29259     * @param text The label of item.
29260     *
29261     * The label to be displayed by the item.
29262     * Label will be at right of the icon (if set).
29263     *
29264     * If a label was passed as argument on item creation, with function
29265     * elm_control_segment_item_add(), it will be already
29266     * displayed by the item.
29267     *
29268     * @see elm_segment_control_item_label_get()
29269     * @see elm_segment_control_item_add()
29270     *
29271     * @ingroup SegmentControl
29272     */
29273    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
29274
29275    /**
29276     * Get the icon associated to the item.
29277     *
29278     * @param obj The segment control object.
29279     * @param index The index of the segment item.
29280     * @return The left side icon associated to the item at @p index.
29281     *
29282     * The return value is a pointer to the icon associated to the item when
29283     * it was created, with function elm_segment_control_item_add(), or later
29284     * with function elm_segment_control_item_icon_set(). If no icon
29285     * was passed as argument, it will return @c NULL.
29286     *
29287     * @see elm_segment_control_item_add()
29288     * @see elm_segment_control_item_icon_set()
29289     *
29290     * @ingroup SegmentControl
29291     */
29292    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
29293
29294    /**
29295     * Set the icon associated to the item.
29296     *
29297     * @param it The segment control item.
29298     * @param icon The icon object to associate with @p it.
29299     *
29300     * The icon object to use at left side of the item. An
29301     * icon can be any Evas object, but usually it is an icon created
29302     * with elm_icon_add().
29303     *
29304     * Once the icon object is set, a previously set one will be deleted.
29305     * @warning Setting the same icon for two items will cause the icon to
29306     * dissapear from the first item.
29307     *
29308     * If an icon was passed as argument on item creation, with function
29309     * elm_segment_control_item_add(), it will be already
29310     * associated to the item.
29311     *
29312     * @see elm_segment_control_item_add()
29313     * @see elm_segment_control_item_icon_get()
29314     *
29315     * @ingroup SegmentControl
29316     */
29317    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
29318
29319    /**
29320     * Get the index of an item.
29321     *
29322     * @param it The segment control item.
29323     * @return The position of item in segment control widget.
29324     *
29325     * Index is the position of an item in segment control widget. Its
29326     * range is from @c 0 to <tt> count - 1 </tt>.
29327     * Count is the number of items, that can be get with
29328     * elm_segment_control_item_count_get().
29329     *
29330     * @ingroup SegmentControl
29331     */
29332    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29333
29334    /**
29335     * Get the base object of the item.
29336     *
29337     * @param it The segment control item.
29338     * @return The base object associated with @p it.
29339     *
29340     * Base object is the @c Evas_Object that represents that item.
29341     *
29342     * @ingroup SegmentControl
29343     */
29344    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
29345
29346    /**
29347     * Get the selected item.
29348     *
29349     * @param obj The segment control object.
29350     * @return The selected item or @c NULL if none of segment items is
29351     * selected.
29352     *
29353     * The selected item can be unselected with function
29354     * elm_segment_control_item_selected_set().
29355     *
29356     * The selected item always will be highlighted on segment control.
29357     *
29358     * @ingroup SegmentControl
29359     */
29360    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29361
29362    /**
29363     * Set the selected state of an item.
29364     *
29365     * @param it The segment control item
29366     * @param select The selected state
29367     *
29368     * This sets the selected state of the given item @p it.
29369     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
29370     *
29371     * If a new item is selected the previosly selected will be unselected.
29372     * Previoulsy selected item can be get with function
29373     * elm_segment_control_item_selected_get().
29374     *
29375     * The selected item always will be highlighted on segment control.
29376     *
29377     * @see elm_segment_control_item_selected_get()
29378     *
29379     * @ingroup SegmentControl
29380     */
29381    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
29382
29383    /**
29384     * @}
29385     */
29386
29387    /**
29388     * @defgroup Grid Grid
29389     *
29390     * The grid is a grid layout widget that lays out a series of children as a
29391     * fixed "grid" of widgets using a given percentage of the grid width and
29392     * height each using the child object.
29393     *
29394     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
29395     * widgets size itself. The default is 100 x 100, so that means the
29396     * position and sizes of children will effectively be percentages (0 to 100)
29397     * of the width or height of the grid widget
29398     *
29399     * @{
29400     */
29401
29402    /**
29403     * Add a new grid to the parent
29404     *
29405     * @param parent The parent object
29406     * @return The new object or NULL if it cannot be created
29407     *
29408     * @ingroup Grid
29409     */
29410    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
29411
29412    /**
29413     * Set the virtual size of the grid
29414     *
29415     * @param obj The grid object
29416     * @param w The virtual width of the grid
29417     * @param h The virtual height of the grid
29418     *
29419     * @ingroup Grid
29420     */
29421    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
29422
29423    /**
29424     * Get the virtual size of the grid
29425     *
29426     * @param obj The grid object
29427     * @param w Pointer to integer to store the virtual width of the grid
29428     * @param h Pointer to integer to store the virtual height of the grid
29429     *
29430     * @ingroup Grid
29431     */
29432    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
29433
29434    /**
29435     * Pack child at given position and size
29436     *
29437     * @param obj The grid object
29438     * @param subobj The child to pack
29439     * @param x The virtual x coord at which to pack it
29440     * @param y The virtual y coord at which to pack it
29441     * @param w The virtual width at which to pack it
29442     * @param h The virtual height at which to pack it
29443     *
29444     * @ingroup Grid
29445     */
29446    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
29447
29448    /**
29449     * Unpack a child from a grid object
29450     *
29451     * @param obj The grid object
29452     * @param subobj The child to unpack
29453     *
29454     * @ingroup Grid
29455     */
29456    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
29457
29458    /**
29459     * Faster way to remove all child objects from a grid object.
29460     *
29461     * @param obj The grid object
29462     * @param clear If true, it will delete just removed children
29463     *
29464     * @ingroup Grid
29465     */
29466    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
29467
29468    /**
29469     * Set packing of an existing child at to position and size
29470     *
29471     * @param subobj The child to set packing of
29472     * @param x The virtual x coord at which to pack it
29473     * @param y The virtual y coord at which to pack it
29474     * @param w The virtual width at which to pack it
29475     * @param h The virtual height at which to pack it
29476     *
29477     * @ingroup Grid
29478     */
29479    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
29480
29481    /**
29482     * get packing of a child
29483     *
29484     * @param subobj The child to query
29485     * @param x Pointer to integer to store the virtual x coord
29486     * @param y Pointer to integer to store the virtual y coord
29487     * @param w Pointer to integer to store the virtual width
29488     * @param h Pointer to integer to store the virtual height
29489     *
29490     * @ingroup Grid
29491     */
29492    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
29493
29494    /**
29495     * @}
29496     */
29497
29498    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
29499    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
29500    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
29501    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
29502    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
29503    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
29504
29505    /**
29506     * @defgroup Video Video
29507     *
29508     * @addtogroup Video
29509     * @{
29510     *
29511     * Elementary comes with two object that help design application that need
29512     * to display video. The main one, Elm_Video, display a video by using Emotion.
29513     * It does embedded the video inside an Edje object, so you can do some
29514     * animation depending on the video state change. It does also implement a
29515     * ressource management policy to remove this burden from the application writer.
29516     *
29517     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
29518     * It take care of updating its content according to Emotion event and provide a
29519     * way to theme itself. It also does automatically raise the priority of the
29520     * linked Elm_Video so it will use the video decoder if available. It also does
29521     * activate the remember function on the linked Elm_Video object.
29522     *
29523     * Signals that you can add callback for are :
29524     *
29525     * "forward,clicked" - the user clicked the forward button.
29526     * "info,clicked" - the user clicked the info button.
29527     * "next,clicked" - the user clicked the next button.
29528     * "pause,clicked" - the user clicked the pause button.
29529     * "play,clicked" - the user clicked the play button.
29530     * "prev,clicked" - the user clicked the prev button.
29531     * "rewind,clicked" - the user clicked the rewind button.
29532     * "stop,clicked" - the user clicked the stop button.
29533     *
29534     * Default contents parts of the player widget that you can use for are:
29535     * @li "video" - A video of the player
29536     *
29537     */
29538
29539    /**
29540     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
29541     *
29542     * @param parent The parent object
29543     * @return a new player widget handle or @c NULL, on errors.
29544     *
29545     * This function inserts a new player widget on the canvas.
29546     *
29547     * @see elm_object_part_content_set()
29548     *
29549     * @ingroup Video
29550     */
29551    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
29552
29553    /**
29554     * @brief Link a Elm_Payer with an Elm_Video object.
29555     *
29556     * @param player the Elm_Player object.
29557     * @param video The Elm_Video object.
29558     *
29559     * This mean that action on the player widget will affect the
29560     * video object and the state of the video will be reflected in
29561     * the player itself.
29562     *
29563     * @see elm_player_add()
29564     * @see elm_video_add()
29565     * @deprecated use elm_object_part_content_set() instead
29566     *
29567     * @ingroup Video
29568     */
29569    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
29570
29571    /**
29572     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
29573     *
29574     * @param parent The parent object
29575     * @return a new video widget handle or @c NULL, on errors.
29576     *
29577     * This function inserts a new video widget on the canvas.
29578     *
29579     * @seeelm_video_file_set()
29580     * @see elm_video_uri_set()
29581     *
29582     * @ingroup Video
29583     */
29584    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
29585
29586    /**
29587     * @brief Define the file that will be the video source.
29588     *
29589     * @param video The video object to define the file for.
29590     * @param filename The file to target.
29591     *
29592     * This function will explicitly define a filename as a source
29593     * for the video of the Elm_Video object.
29594     *
29595     * @see elm_video_uri_set()
29596     * @see elm_video_add()
29597     * @see elm_player_add()
29598     *
29599     * @ingroup Video
29600     */
29601    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
29602
29603    /**
29604     * @brief Define the uri that will be the video source.
29605     *
29606     * @param video The video object to define the file for.
29607     * @param uri The uri to target.
29608     *
29609     * This function will define an uri as a source for the video of the
29610     * Elm_Video object. URI could be remote source of video, like http:// or local source
29611     * like for example WebCam who are most of the time v4l2:// (but that depend and
29612     * you should use Emotion API to request and list the available Webcam on your system).
29613     *
29614     * @see elm_video_file_set()
29615     * @see elm_video_add()
29616     * @see elm_player_add()
29617     *
29618     * @ingroup Video
29619     */
29620    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
29621
29622    /**
29623     * @brief Get the underlying Emotion object.
29624     *
29625     * @param video The video object to proceed the request on.
29626     * @return the underlying Emotion object.
29627     *
29628     * @ingroup Video
29629     */
29630    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
29631
29632    /**
29633     * @brief Start to play the video
29634     *
29635     * @param video The video object to proceed the request on.
29636     *
29637     * Start to play the video and cancel all suspend state.
29638     *
29639     * @ingroup Video
29640     */
29641    EAPI void elm_video_play(Evas_Object *video);
29642
29643    /**
29644     * @brief Pause the video
29645     *
29646     * @param video The video object to proceed the request on.
29647     *
29648     * Pause the video and start a timer to trigger suspend mode.
29649     *
29650     * @ingroup Video
29651     */
29652    EAPI void elm_video_pause(Evas_Object *video);
29653
29654    /**
29655     * @brief Stop the video
29656     *
29657     * @param video The video object to proceed the request on.
29658     *
29659     * Stop the video and put the emotion in deep sleep mode.
29660     *
29661     * @ingroup Video
29662     */
29663    EAPI void elm_video_stop(Evas_Object *video);
29664
29665    /**
29666     * @brief Is the video actually playing.
29667     *
29668     * @param video The video object to proceed the request on.
29669     * @return EINA_TRUE if the video is actually playing.
29670     *
29671     * You should consider watching event on the object instead of polling
29672     * the object state.
29673     *
29674     * @ingroup Video
29675     */
29676    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
29677
29678    /**
29679     * @brief Is it possible to seek inside the video.
29680     *
29681     * @param video The video object to proceed the request on.
29682     * @return EINA_TRUE if is possible to seek inside the video.
29683     *
29684     * @ingroup Video
29685     */
29686    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
29687
29688    /**
29689     * @brief Is the audio muted.
29690     *
29691     * @param video The video object to proceed the request on.
29692     * @return EINA_TRUE if the audio is muted.
29693     *
29694     * @ingroup Video
29695     */
29696    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
29697
29698    /**
29699     * @brief Change the mute state of the Elm_Video object.
29700     *
29701     * @param video The video object to proceed the request on.
29702     * @param mute The new mute state.
29703     *
29704     * @ingroup Video
29705     */
29706    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
29707
29708    /**
29709     * @brief Get the audio level of the current video.
29710     *
29711     * @param video The video object to proceed the request on.
29712     * @return the current audio level.
29713     *
29714     * @ingroup Video
29715     */
29716    EAPI double elm_video_audio_level_get(const Evas_Object *video);
29717
29718    /**
29719     * @brief Set the audio level of anElm_Video object.
29720     *
29721     * @param video The video object to proceed the request on.
29722     * @param volume The new audio volume.
29723     *
29724     * @ingroup Video
29725     */
29726    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
29727
29728    EAPI double elm_video_play_position_get(const Evas_Object *video);
29729    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
29730    EAPI double elm_video_play_length_get(const Evas_Object *video);
29731    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
29732    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
29733    EAPI const char *elm_video_title_get(const Evas_Object *video);
29734    /**
29735     * @}
29736     */
29737
29738    /**
29739     * @defgroup Naviframe Naviframe
29740     * @ingroup Elementary
29741     *
29742     * @brief Naviframe is a kind of view manager for the applications.
29743     *
29744     * Naviframe provides functions to switch different pages with stack
29745     * mechanism. It means if one page(item) needs to be changed to the new one,
29746     * then naviframe would push the new page to it's internal stack. Of course,
29747     * it can be back to the previous page by popping the top page. Naviframe
29748     * provides some transition effect while the pages are switching (same as
29749     * pager).
29750     *
29751     * Since each item could keep the different styles, users could keep the
29752     * same look & feel for the pages or different styles for the items in it's
29753     * application.
29754     *
29755     * Signals that you can add callback for are:
29756     * @li "transition,finished" - When the transition is finished in changing
29757     *     the item
29758     * @li "title,clicked" - User clicked title area
29759     *
29760     * Default contents parts of the naviframe items that you can use for are:
29761     * @li "default" - A main content of the page
29762     * @li "icon" - An icon in the title area
29763     * @li "prev_btn" - A button to go to the previous page
29764     * @li "next_btn" - A button to go to the next page
29765     *
29766     * Default text parts of the naviframe items that you can use for are:
29767     * @li "default" - Title label in the title area
29768     * @li "subtitle" - Sub-title label in the title area
29769     *
29770     * Supported elm_object common APIs.
29771     * @li elm_object_signal_emit
29772     *
29773     * Supported elm_object_item common APIs.
29774     * @li elm_object_item_text_set
29775     * @li elm_object_item_part_text_set
29776     * @li elm_object_item_text_get
29777     * @li elm_object_item_part_text_get
29778     * @li elm_object_item_content_set
29779     * @li elm_object_item_part_content_set
29780     * @li elm_object_item_content_get
29781     * @li elm_object_item_part_content_get
29782     * @li elm_object_item_content_unset
29783     * @li elm_object_item_part_content_unset
29784     * @li elm_object_item_signal_emit
29785     *
29786     * @ref tutorial_naviframe gives a good overview of the usage of the API.
29787     */
29788
29789    /**
29790     * @addtogroup Naviframe
29791     * @{
29792     */
29793
29794    /**
29795     * @brief Add a new Naviframe object to the parent.
29796     *
29797     * @param parent Parent object
29798     * @return New object or @c NULL, if it cannot be created
29799     *
29800     * @ingroup Naviframe
29801     */
29802    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29803
29804    /**
29805     * @brief Push a new item to the top of the naviframe stack (and show it).
29806     *
29807     * @param obj The naviframe object
29808     * @param title_label The label in the title area. The name of the title
29809     *        label part is "elm.text.title"
29810     * @param prev_btn The button to go to the previous item. If it is NULL,
29811     *        then naviframe will create a back button automatically. The name of
29812     *        the prev_btn part is "elm.swallow.prev_btn"
29813     * @param next_btn The button to go to the next item. Or It could be just an
29814     *        extra function button. The name of the next_btn part is
29815     *        "elm.swallow.next_btn"
29816     * @param content The main content object. The name of content part is
29817     *        "elm.swallow.content"
29818     * @param item_style The current item style name. @c NULL would be default.
29819     * @return The created item or @c NULL upon failure.
29820     *
29821     * The item pushed becomes one page of the naviframe, this item will be
29822     * deleted when it is popped.
29823     *
29824     * @see also elm_naviframe_item_style_set()
29825     * @see also elm_naviframe_item_insert_before()
29826     * @see also elm_naviframe_item_insert_after()
29827     *
29828     * The following styles are available for this item:
29829     * @li @c "default"
29830     *
29831     * @ingroup Naviframe
29832     */
29833    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);
29834
29835    /**
29836     * @brief Insert a new item into the naviframe before item @p before.
29837     *
29838     * @param before The naviframe item to insert before.
29839     * @param title_label The label in the title area. The name of the title
29840     *        label part is "elm.text.title"
29841     * @param prev_btn The button to go to the previous item. If it is NULL,
29842     *        then naviframe will create a back button automatically. The name of
29843     *        the prev_btn part is "elm.swallow.prev_btn"
29844     * @param next_btn The button to go to the next item. Or It could be just an
29845     *        extra function button. The name of the next_btn part is
29846     *        "elm.swallow.next_btn"
29847     * @param content The main content object. The name of content part is
29848     *        "elm.swallow.content"
29849     * @param item_style The current item style name. @c NULL would be default.
29850     * @return The created item or @c NULL upon failure.
29851     *
29852     * The item is inserted into the naviframe straight away without any
29853     * transition operations. This item will be deleted when it is popped.
29854     *
29855     * @see also elm_naviframe_item_style_set()
29856     * @see also elm_naviframe_item_push()
29857     * @see also elm_naviframe_item_insert_after()
29858     *
29859     * The following styles are available for this item:
29860     * @li @c "default"
29861     *
29862     * @ingroup Naviframe
29863     */
29864    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);
29865
29866    /**
29867     * @brief Insert a new item into the naviframe after item @p after.
29868     *
29869     * @param after The naviframe item to insert after.
29870     * @param title_label The label in the title area. The name of the title
29871     *        label part is "elm.text.title"
29872     * @param prev_btn The button to go to the previous item. If it is NULL,
29873     *        then naviframe will create a back button automatically. The name of
29874     *        the prev_btn part is "elm.swallow.prev_btn"
29875     * @param next_btn The button to go to the next item. Or It could be just an
29876     *        extra function button. The name of the next_btn part is
29877     *        "elm.swallow.next_btn"
29878     * @param content The main content object. The name of content part is
29879     *        "elm.swallow.content"
29880     * @param item_style The current item style name. @c NULL would be default.
29881     * @return The created item or @c NULL upon failure.
29882     *
29883     * The item is inserted into the naviframe straight away without any
29884     * transition operations. This item will be deleted when it is popped.
29885     *
29886     * @see also elm_naviframe_item_style_set()
29887     * @see also elm_naviframe_item_push()
29888     * @see also elm_naviframe_item_insert_before()
29889     *
29890     * The following styles are available for this item:
29891     * @li @c "default"
29892     *
29893     * @ingroup Naviframe
29894     */
29895    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);
29896
29897    /**
29898     * @brief Pop an item that is on top of the stack
29899     *
29900     * @param obj The naviframe object
29901     * @return @c NULL or the content object(if the
29902     *         elm_naviframe_content_preserve_on_pop_get is true).
29903     *
29904     * This pops an item that is on the top(visible) of the naviframe, makes it
29905     * disappear, then deletes the item. The item that was underneath it on the
29906     * stack will become visible.
29907     *
29908     * @see also elm_naviframe_content_preserve_on_pop_get()
29909     *
29910     * @ingroup Naviframe
29911     */
29912    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29913
29914    /**
29915     * @brief Pop the items between the top and the above one on the given item.
29916     *
29917     * @param it The naviframe item
29918     *
29919     * @ingroup Naviframe
29920     */
29921    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29922
29923    /**
29924     * Promote an item already in the naviframe stack to the top of the stack
29925     *
29926     * @param it The naviframe item
29927     *
29928     * This will take the indicated item and promote it to the top of the stack
29929     * as if it had been pushed there. The item must already be inside the
29930     * naviframe stack to work.
29931     *
29932     */
29933    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29934
29935    /**
29936     * @brief Delete the given item instantly.
29937     *
29938     * @param it The naviframe item
29939     *
29940     * This just deletes the given item from the naviframe item list instantly.
29941     * So this would not emit any signals for view transitions but just change
29942     * the current view if the given item is a top one.
29943     *
29944     * @ingroup Naviframe
29945     */
29946    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29947
29948    /**
29949     * @brief preserve the content objects when items are popped.
29950     *
29951     * @param obj The naviframe object
29952     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29953     *
29954     * @see also elm_naviframe_content_preserve_on_pop_get()
29955     *
29956     * @ingroup Naviframe
29957     */
29958    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29959
29960    /**
29961     * @brief Get a value whether preserve mode is enabled or not.
29962     *
29963     * @param obj The naviframe object
29964     * @return If @c EINA_TRUE, preserve mode is enabled
29965     *
29966     * @see also elm_naviframe_content_preserve_on_pop_set()
29967     *
29968     * @ingroup Naviframe
29969     */
29970    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29971
29972    /**
29973     * @brief Get a top item on the naviframe stack
29974     *
29975     * @param obj The naviframe object
29976     * @return The top item on the naviframe stack or @c NULL, if the stack is
29977     *         empty
29978     *
29979     * @ingroup Naviframe
29980     */
29981    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29982
29983    /**
29984     * @brief Get a bottom item on the naviframe stack
29985     *
29986     * @param obj The naviframe object
29987     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29988     *         empty
29989     *
29990     * @ingroup Naviframe
29991     */
29992    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29993
29994    /**
29995     * @brief Set an item style
29996     *
29997     * @param obj The naviframe item
29998     * @param item_style The current item style name. @c NULL would be default
29999     *
30000     * The following styles are available for this item:
30001     * @li @c "default"
30002     *
30003     * @see also elm_naviframe_item_style_get()
30004     *
30005     * @ingroup Naviframe
30006     */
30007    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
30008
30009    /**
30010     * @brief Get an item style
30011     *
30012     * @param obj The naviframe item
30013     * @return The current item style name
30014     *
30015     * @see also elm_naviframe_item_style_set()
30016     *
30017     * @ingroup Naviframe
30018     */
30019    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30020
30021    /**
30022     * @brief Show/Hide the title area
30023     *
30024     * @param it The naviframe item
30025     * @param visible If @c EINA_TRUE, title area will be visible, hidden
30026     *        otherwise
30027     *
30028     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
30029     *
30030     * @see also elm_naviframe_item_title_visible_get()
30031     *
30032     * @ingroup Naviframe
30033     */
30034    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
30035
30036    /**
30037     * @brief Get a value whether title area is visible or not.
30038     *
30039     * @param it The naviframe item
30040     * @return If @c EINA_TRUE, title area is visible
30041     *
30042     * @see also elm_naviframe_item_title_visible_set()
30043     *
30044     * @ingroup Naviframe
30045     */
30046    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
30047
30048    /**
30049     * @brief Set creating prev button automatically or not
30050     *
30051     * @param obj The naviframe object
30052     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
30053     *        be created internally when you pass the @c NULL to the prev_btn
30054     *        parameter in elm_naviframe_item_push
30055     *
30056     * @see also elm_naviframe_item_push()
30057     *
30058     * @ingroup Naviframe
30059     */
30060    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
30061
30062    /**
30063     * @brief Get a value whether prev button(back button) will be auto pushed or
30064     *        not.
30065     *
30066     * @param obj The naviframe object
30067     * @return If @c EINA_TRUE, prev button will be auto pushed.
30068     *
30069     * @see also elm_naviframe_item_push()
30070     *           elm_naviframe_prev_btn_auto_pushed_set()
30071     *
30072     * @ingroup Naviframe
30073     */
30074    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30075
30076    /**
30077     * @brief Get a list of all the naviframe items.
30078     *
30079     * @param obj The naviframe object
30080     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
30081     * or @c NULL on failure.
30082     *
30083     * @ingroup Naviframe
30084     */
30085    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30086
30087    /**
30088     * @brief Set the event enabled when pushing/popping items
30089     *
30090     * If @c enabled is EINA_TRUE, the contents of the naviframe item will
30091     * receives events from mouse and keyboard during view changing such as
30092     * item push/pop.
30093     *
30094     * @param obj The naviframe object
30095     * @param enabled Events are received when enabled is @c EINA_TRUE, and
30096     * ignored otherwise.
30097     *
30098     * @warning Events will be blocked by calling evas_object_freeze_events_set()
30099     * internally. So don't call the API whiling pushing/popping items.
30100     *
30101     * @see elm_naviframe_event_enabled_get()
30102     * @see evas_object_freeze_events_set()
30103     *
30104     * @ingroup Naviframe
30105     */
30106    EAPI void                elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
30107
30108    /**
30109     * @brief Get the value of event enabled status.
30110     *
30111     * @param obj The naviframe object
30112     * @return EINA_TRUE, when event is enabled
30113     *
30114     * @see elm_naviframe_event_enabled_set()
30115     *
30116     * @ingroup Naviframe
30117     */
30118    EAPI Eina_Bool           elm_naviframe_event_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30119
30120    /**
30121     * @}
30122     */
30123
30124    /**
30125     * @defgroup Multibuttonentry Multibuttonentry
30126     *
30127     * A Multibuttonentry is a widget to allow a user enter text and manage it as a number of buttons
30128     * Each text button is inserted by pressing the "return" key. If there is no space in the current row,
30129     * a new button is added to the next row. When a text button is pressed, it will become focused.
30130     * Backspace removes the focus.
30131     * When the Multibuttonentry loses focus items longer than 1 lines are shrunk to one line.
30132     *
30133     * Smart callbacks one can register:
30134     * - @c "item,selected" - when item is selected. May be called on backspace key.
30135     * - @c "item,added" - when a new multibuttonentry item is added.
30136     * - @c "item,deleted" - when a multibuttonentry item is deleted.
30137     * - @c "item,clicked" - selected item of multibuttonentry is clicked.
30138     * - @c "clicked" - when multibuttonentry is clicked.
30139     * - @c "focused" - when multibuttonentry is focused.
30140     * - @c "unfocused" - when multibuttonentry is unfocused.
30141     * - @c "expanded" - when multibuttonentry is expanded.
30142     * - @c "shrank" - when multibuttonentry is shrank.
30143     * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
30144     *
30145     * Here is an example on its usage:
30146     * @li @ref multibuttonentry_example
30147     */
30148
30149    /**
30150     * @addtogroup Multibuttonentry
30151     * @{
30152     */
30153
30154    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
30155    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
30156
30157    /**
30158     * @brief Add a new multibuttonentry to the parent
30159     *
30160     * @param parent The parent object
30161     * @return The new object or NULL if it cannot be created
30162     *
30163     */
30164    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30165
30166    /**
30167     * Get the label
30168     *
30169     * @param obj The multibuttonentry object
30170     * @return The label, or NULL if none
30171     *
30172     */
30173    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30174
30175    /**
30176     * Set the label
30177     *
30178     * @param obj The multibuttonentry object
30179     * @param label The text label string
30180     *
30181     */
30182    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
30183
30184    /**
30185     * Get the entry of the multibuttonentry object
30186     *
30187     * @param obj The multibuttonentry object
30188     * @return The entry object, or NULL if none
30189     *
30190     */
30191    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30192
30193    /**
30194     * Get the guide text
30195     *
30196     * @param obj The multibuttonentry object
30197     * @return The guide text, or NULL if none
30198     *
30199     */
30200    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30201
30202    /**
30203     * Set the guide text
30204     *
30205     * @param obj The multibuttonentry object
30206     * @param label The guide text string
30207     *
30208     */
30209    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
30210
30211    /**
30212     * Get the value of shrink_mode state.
30213     *
30214     * @param obj The multibuttonentry object
30215     * @param the value of shrink mode state.
30216     *
30217     */
30218    EAPI int                        elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30219
30220    /**
30221     * Set/Unset the multibuttonentry to shrink mode state of single line
30222     *
30223     * @param obj The multibuttonentry object
30224     * @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.
30225     *
30226     */
30227    EAPI void                       elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
30228
30229    /**
30230     * Prepend a new item to the multibuttonentry
30231     *
30232     * @param obj The multibuttonentry object
30233     * @param label The label of new item
30234     * @param data The ponter to the data to be attached
30235     * @return A handle to the item added or NULL if not possible
30236     *
30237     */
30238    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30239
30240    /**
30241     * Append a new item to the multibuttonentry
30242     *
30243     * @param obj The multibuttonentry object
30244     * @param label The label of new item
30245     * @param data The ponter to the data to be attached
30246     * @return A handle to the item added or NULL if not possible
30247     *
30248     */
30249    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data) EINA_ARG_NONNULL(1);
30250
30251    /**
30252     * Add a new item to the multibuttonentry before the indicated object
30253     *
30254     * reference.
30255     * @param obj The multibuttonentry object
30256     * @param before The item before which to add it
30257     * @param label The label of new item
30258     * @param data The ponter to the data to be attached
30259     * @return A handle to the item added or NULL if not possible
30260     *
30261     */
30262    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_before(Evas_Object *obj, Elm_Multibuttonentry_Item *before, const char *label, void *data) EINA_ARG_NONNULL(1);
30263
30264    /**
30265     * Add a new item to the multibuttonentry after the indicated object
30266     *
30267     * @param obj The multibuttonentry object
30268     * @param after The item after which to add it
30269     * @param label The label of new item
30270     * @param data The ponter to the data to be attached
30271     * @return A handle to the item added or NULL if not possible
30272     *
30273     */
30274    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_insert_after(Evas_Object *obj, Elm_Multibuttonentry_Item *after, const char *label, void *data) EINA_ARG_NONNULL(1);
30275
30276    /**
30277     * Get a list of items in the multibuttonentry
30278     *
30279     * @param obj The multibuttonentry object
30280     * @return The list of items, or NULL if none
30281     *
30282     */
30283    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30284
30285    /**
30286     * Get the first item in the multibuttonentry
30287     *
30288     * @param obj The multibuttonentry object
30289     * @return The first item, or NULL if none
30290     *
30291     */
30292    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30293
30294    /**
30295     * Get the last item in the multibuttonentry
30296     *
30297     * @param obj The multibuttonentry object
30298     * @return The last item, or NULL if none
30299     *
30300     */
30301    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30302
30303    /**
30304     * Get the selected item in the multibuttonentry
30305     *
30306     * @param obj The multibuttonentry object
30307     * @return The selected item, or NULL if none
30308     *
30309     */
30310    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
30311
30312    /**
30313     * Set the selected state of an item
30314     *
30315     * @param item The item
30316     * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30317     *
30318     */
30319    EAPI void                       elm_multibuttonentry_item_select(Elm_Multibuttonentry_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
30320
30321    /**
30322     * unselect all items.
30323     *
30324     * @param obj The multibuttonentry object
30325     *
30326     */
30327    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
30328
30329    /**
30330     * Delete a given item
30331     *
30332     * @param item The item
30333     *
30334     */
30335    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30336
30337    /**
30338     * Remove all items in the multibuttonentry.
30339     *
30340     * @param obj The multibuttonentry object
30341     *
30342     */
30343    EAPI void                       elm_multibuttonentry_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
30344
30345    /**
30346     * Get the label of a given item
30347     *
30348     * @param item The item
30349     * @return The label of a given item, or NULL if none
30350     *
30351     */
30352    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30353
30354    /**
30355     * Set the label of a given item
30356     *
30357     * @param item The item
30358     * @param label The text label string
30359     *
30360     */
30361    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
30362
30363    /**
30364     * Get the previous item in the multibuttonentry
30365     *
30366     * @param item The item
30367     * @return The item before the item @p item
30368     *
30369     */
30370    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30371
30372    /**
30373     * Get the next item in the multibuttonentry
30374     *
30375     * @param item The item
30376     * @return The item after the item @p item
30377     *
30378     */
30379    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next_get(const Elm_Multibuttonentry_Item *item) EINA_ARG_NONNULL(1);
30380
30381    /**
30382     * Append a item filter function for text inserted in the Multibuttonentry
30383     *
30384     * Append the given callback to the list. This functions will be called
30385     * whenever any text is inserted into the Multibuttonentry, with the text to be inserted
30386     * as a parameter. The callback function is free to alter the text in any way
30387     * it wants, but it must remember to free the given pointer and update it.
30388     * If the new text is to be discarded, the function can free it and set it text
30389     * parameter to NULL. This will also prevent any following filters from being
30390     * called.
30391     *
30392     * @param obj The multibuttonentryentry object
30393     * @param func The function to use as item filter
30394     * @param data User data to pass to @p func
30395     *
30396     */
30397    EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30398
30399    /**
30400     * Prepend a filter function for text inserted in the Multibuttentry
30401     *
30402     * Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
30403     * for more information
30404     *
30405     * @param obj The multibuttonentry object
30406     * @param func The function to use as text filter
30407     * @param data User data to pass to @p func
30408     *
30409     */
30410    EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30411
30412    /**
30413     * Remove a filter from the list
30414     *
30415     * Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
30416     * for more information.
30417     *
30418     * @param obj The multibuttonentry object
30419     * @param func The filter function to remove
30420     * @param data The user data passed when adding the function
30421     *
30422     */
30423    EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data) EINA_ARG_NONNULL(1);
30424
30425    /**
30426     * @}
30427     */
30428
30429    /**
30430     * @addtogroup CopyPaste
30431     * @{
30432     */
30433
30434    typedef struct _Elm_Selection_Data Elm_Selection_Data;
30435    typedef Eina_Bool (*Elm_Drop_Cb) (void *d, Evas_Object *o, Elm_Selection_Data *data);
30436
30437    typedef enum _Elm_Sel_Type
30438    {
30439       ELM_SEL_TYPE_PRIMARY,
30440       ELM_SEL_TYPE_SECONDARY,
30441       ELM_SEL_TYPE_CLIPBOARD,
30442       ELM_SEL_TYPE_XDND,
30443
30444       ELM_SEL_TYPE_MAX,
30445    } Elm_Sel_Type;
30446
30447    typedef enum _Elm_Sel_Format
30448    {
30449       /** Targets: for matching every atom requesting */
30450       ELM_SEL_FORMAT_TARGETS  = -1,
30451       /** they come from outside of elm */
30452       ELM_SEL_FORMAT_NONE     = 0x0,
30453       /** Plain unformated text: Used for things that don't want rich markup */
30454       ELM_SEL_FORMAT_TEXT     = 0x01,
30455       /** Edje textblock markup, including inline images */
30456       ELM_SEL_FORMAT_MARKUP   = 0x02,
30457       /** Images */
30458       ELM_SEL_FORMAT_IMAGE    = 0x04,
30459       /** Vcards */
30460       ELM_SEL_FORMAT_VCARD    = 0x08,
30461       /** Raw HTMLish things for widgets that want that stuff (hello webkit!) */
30462       ELM_SEL_FORMAT_HTML     = 0x10,
30463
30464       ELM_SEL_FORMAT_MAX
30465    } Elm_Sel_Format;
30466
30467    struct _Elm_Selection_Data
30468    {
30469       int                   x, y;
30470       Elm_Sel_Format   format;
30471       void                 *data;
30472       size_t                len;
30473    };
30474
30475    /**
30476     * @brief Set a data of a widget to copy and paste.
30477     *
30478     * Append the given callback to the list. This functions will be called
30479     * called.
30480     *
30481     * @param selection selection type for copying and pasting
30482     * @param widget The source widget pointer
30483     * @param format Type of selection format
30484     * @param buf The pointer of data source
30485     * @return If EINA_TRUE, setting data is success.
30486     *
30487     * @ingroup CopyPaste
30488     *
30489     */
30490
30491    EAPI Eina_Bool            elm_cnp_selection_set(Elm_Sel_Type selection, Evas_Object *widget, Elm_Sel_Format format, const void *buf, size_t buflen);
30492
30493    /**
30494     * @brief Retrive the data from the widget which is set for copying and pasting.
30495     *
30496     * Getting the data from the widget which is set for copying and pasting.
30497     * Mainly the widget is elm_entry. If then @p datacb and @p udata are
30498     * can be NULL. If not, @p datacb and @p udata are used for retriving data.
30499     *
30500     * @see also elm_cnp_selection_set()
30501     *
30502     * @param selection selection type for copying and pasting
30503     * @param widget The source widget pointer
30504     * @param datacb The user data callback if the target widget isn't elm_entry
30505     * @param udata The user data pointer for @p datacb
30506     * @return If EINA_TRUE, getting data is success.
30507     *
30508     * @ingroup CopyPaste
30509     *
30510     */
30511
30512    EAPI Eina_Bool            elm_cnp_selection_get(Elm_Sel_Type selection, Elm_Sel_Format format, Evas_Object *widget, Elm_Drop_Cb datacb, void *udata);
30513
30514    /**
30515     * @brief Clear the data in the widget which is set for copying and pasting.
30516     *
30517     * Clear the data in the widget. Normally this function isn't need to call.
30518     *
30519     * @see also elm_cnp_selection_set()
30520     *
30521     * @param selection selection type for copying and pasting
30522     * @param widget The source widget pointer
30523     * @return If EINA_TRUE, clearing data is success.
30524     *
30525     * @ingroup CopyPaste
30526     *
30527     */
30528
30529    EAPI Eina_Bool            elm_cnp_selection_clear(Elm_Sel_Type selection, Evas_Object *widget);
30530
30531    /**
30532     * @}
30533     */
30534
30535 #ifdef __cplusplus
30536 }
30537 #endif
30538
30539 #endif