3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
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 in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 #include <Elementary.h>
56 elm_main(int argc, char **argv)
58 // create window(s) here and do any application init
59 elm_run(); // run main loop
60 elm_shutdown(); // after mainloop finishes running, shutdown
61 return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to buiuld it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
180 * Now let's actually create an interactive "Hello World" gui that you can
181 * click the ok button to exit. It's more code because this now does something
182 * much more significant, but it's still very simple:
185 #include <Elementary.h>
188 on_done(void *data, Evas_Object *obj, void *event_info)
190 // quit the mainloop (elm_run function will return)
195 elm_main(int argc, char **argv)
197 Evas_Object *win, *bg, *box, *lab, *btn;
199 // new window - do the usual and give it a name, title and delete handler
200 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201 elm_win_title_set(win, "Hello");
202 // when the user clicks "close" on a window there is a request to delete
203 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
206 bg = elm_bg_add(win);
207 // add object as a resize object for the window (controls window minimum
208 // size as well as gets resized if window is resized)
209 elm_win_resize_object_add(win, bg);
210 evas_object_show(bg);
212 // add a box object - default is vertical. a box holds children in a row,
213 // either horizontally or vertically. nothing more.
214 box = elm_box_add(win);
215 // make the box hotizontal
216 elm_box_horizontal_set(box, EINA_TRUE);
217 // add object as a resize object for the window (controls window minimum
218 // size as well as gets resized if window is resized)
219 elm_win_resize_object_add(win, box);
220 evas_object_show(box);
222 // add a label widget, set the text and put it in the pad frame
223 lab = elm_label_add(win);
224 // set default text of the label
225 elm_object_text_set(lab, "Hello out there world!");
226 // pack the label at the end of the box
227 elm_box_pack_end(box, lab);
228 evas_object_show(lab);
231 btn = elm_button_add(win);
232 // set default text of button to "OK"
233 elm_object_text_set(btn, "OK");
234 // pack the button at the end of the box
235 elm_box_pack_end(box, btn);
236 evas_object_show(btn);
237 // call on_done when button is clicked
238 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
240 // now we are done, show the window
241 evas_object_show(win);
243 // run the mainloop and process events and callbacks
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
297 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
298 contact with the developers and maintainers.
306 * @brief Elementary's API
311 @ELM_UNIX_DEF@ ELM_UNIX
312 @ELM_WIN32_DEF@ ELM_WIN32
313 @ELM_WINCE_DEF@ ELM_WINCE
314 @ELM_EDBUS_DEF@ ELM_EDBUS
315 @ELM_EFREET_DEF@ ELM_EFREET
316 @ELM_ETHUMB_DEF@ ELM_ETHUMB
317 @ELM_EMAP_DEF@ ELM_EMAP
318 @ELM_DEBUG_DEF@ ELM_DEBUG
319 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
320 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
322 /* Standard headers for standard system calls etc. */
327 #include <sys/types.h>
328 #include <sys/stat.h>
329 #include <sys/time.h>
330 #include <sys/param.h>
343 # ifdef ELM_LIBINTL_H
344 # include <libintl.h>
355 #if defined (ELM_WIN32) || defined (ELM_WINCE)
358 # define alloca _alloca
369 #include <Ecore_Evas.h>
370 #include <Ecore_File.h>
371 #include <Ecore_IMF.h>
372 #include <Ecore_Con.h>
381 # include <Efreet_Mime.h>
382 # include <Efreet_Trash.h>
386 # include <Ethumb_Client.h>
398 # ifdef ELEMENTARY_BUILD
400 # define EAPI __declspec(dllexport)
403 # endif /* ! DLL_EXPORT */
405 # define EAPI __declspec(dllimport)
406 # endif /* ! EFL_EVAS_BUILD */
410 # define EAPI __attribute__ ((visibility("default")))
417 #endif /* ! _WIN32 */
420 /* allow usage from c++ */
425 #define ELM_VERSION_MAJOR @VMAJ@
426 #define ELM_VERSION_MINOR @VMIN@
428 typedef struct _Elm_Version
436 EAPI extern Elm_Version *elm_version;
439 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
440 #define ELM_PI 3.14159265358979323846
443 * @defgroup General General
445 * @brief General Elementary API. Functions that don't relate to
446 * Elementary objects specifically.
448 * Here are documented functions which init/shutdown the library,
449 * that apply to generic Elementary objects, that deal with
450 * configuration, et cetera.
452 * @ref general_functions_example_page "This" example contemplates
453 * some of these functions.
457 * @addtogroup General
462 * Defines couple of standard Evas_Object layers to be used
463 * with evas_object_layer_set().
465 * @note whenever extending with new values, try to keep some padding
466 * to siblings so there is room for further extensions.
468 typedef enum _Elm_Object_Layer
470 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
471 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
472 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
473 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
474 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
475 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
478 /**************************************************************************/
479 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
482 * Emitted when any Elementary's policy value is changed.
484 EAPI extern int ELM_EVENT_POLICY_CHANGED;
487 * @typedef Elm_Event_Policy_Changed
489 * Data on the event when an Elementary policy has changed
491 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
494 * @struct _Elm_Event_Policy_Changed
496 * Data on the event when an Elementary policy has changed
498 struct _Elm_Event_Policy_Changed
500 unsigned int policy; /**< the policy identifier */
501 int new_value; /**< value the policy had before the change */
502 int old_value; /**< new value the policy got */
506 * Policy identifiers.
508 typedef enum _Elm_Policy
510 ELM_POLICY_QUIT, /**< under which circunstances the application
511 * should quit automatically. @see
515 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
518 typedef enum _Elm_Policy_Quit
520 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
522 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
524 * window is closed */
525 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
527 typedef enum _Elm_Focus_Direction
531 } Elm_Focus_Direction;
533 typedef enum _Elm_Text_Format
535 ELM_TEXT_FORMAT_PLAIN_UTF8,
536 ELM_TEXT_FORMAT_MARKUP_UTF8
540 * Line wrapping types.
542 typedef enum _Elm_Wrap_Type
544 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
545 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
546 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
547 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
552 * @typedef Elm_Object_Item
553 * An Elementary Object item handle.
556 typedef struct _Elm_Object_Item Elm_Object_Item;
560 * Called back when a widget's tooltip is activated and needs content.
561 * @param data user-data given to elm_object_tooltip_content_cb_set()
562 * @param obj owner widget.
563 * @param tooltip The tooltip object (affix content to this!)
565 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
568 * Called back when a widget's item tooltip is activated and needs content.
569 * @param data user-data given to elm_object_tooltip_content_cb_set()
570 * @param obj owner widget.
571 * @param tooltip The tooltip object (affix content to this!)
572 * @param item context dependent item. As an example, if tooltip was
573 * set on Elm_List_Item, then it is of this type.
575 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
577 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. */
579 #ifndef ELM_LIB_QUICKLAUNCH
580 #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 */
582 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
585 /**************************************************************************/
589 * Initialize Elementary
591 * @param[in] argc System's argument count value
592 * @param[in] argv System's pointer to array of argument strings
593 * @return The init counter value.
595 * This function initializes Elementary and increments a counter of
596 * the number of calls to it. It returs the new counter's value.
598 * @warning This call is exported only for use by the @c ELM_MAIN()
599 * macro. There is no need to use this if you use this macro (which
600 * is highly advisable). An elm_main() should contain the entry
601 * point code for your application, having the same prototype as
602 * elm_init(), and @b not being static (putting the @c EAPI symbol
603 * in front of its type declaration is advisable). The @c
604 * ELM_MAIN() call should be placed just after it.
607 * @dontinclude bg_example_01.c
611 * See the full @ref bg_example_01_c "example".
613 * @see elm_shutdown().
616 EAPI int elm_init(int argc, char **argv);
619 * Shut down Elementary
621 * @return The init counter value.
623 * This should be called at the end of your application, just
624 * before it ceases to do any more processing. This will clean up
625 * any permanent resources your application may have allocated via
626 * Elementary that would otherwise persist.
628 * @see elm_init() for an example
632 EAPI int elm_shutdown(void);
635 * Run Elementary's main loop
637 * This call should be issued just after all initialization is
638 * completed. This function will not return until elm_exit() is
639 * called. It will keep looping, running the main
640 * (event/processing) loop for Elementary.
642 * @see elm_init() for an example
646 EAPI void elm_run(void);
649 * Exit Elementary's main loop
651 * If this call is issued, it will flag the main loop to cease
652 * processing and return back to its parent function (usually your
653 * elm_main() function).
655 * @see elm_init() for an example. There, just after a request to
656 * close the window comes, the main loop will be left.
658 * @note By using the #ELM_POLICY_QUIT on your Elementary
659 * applications, you'll this function called automatically for you.
663 EAPI void elm_exit(void);
666 * Provide information in order to make Elementary determine the @b
667 * run time location of the software in question, so other data files
668 * such as images, sound files, executable utilities, libraries,
669 * modules and locale files can be found.
671 * @param mainfunc This is your application's main function name,
672 * whose binary's location is to be found. Providing @c NULL
673 * will make Elementary not to use it
674 * @param dom This will be used as the application's "domain", in the
675 * form of a prefix to any environment variables that may
676 * override prefix detection and the directory name, inside the
677 * standard share or data directories, where the software's
678 * data files will be looked for.
679 * @param checkfile This is an (optional) magic file's path to check
680 * for existence (and it must be located in the data directory,
681 * under the share directory provided above). Its presence will
682 * help determine the prefix found was correct. Pass @c NULL if
683 * the check is not to be done.
685 * This function allows one to re-locate the application somewhere
686 * else after compilation, if the developer wishes for easier
687 * distribution of pre-compiled binaries.
689 * The prefix system is designed to locate where the given software is
690 * installed (under a common path prefix) at run time and then report
691 * specific locations of this prefix and common directories inside
692 * this prefix like the binary, library, data and locale directories,
693 * through the @c elm_app_*_get() family of functions.
695 * Call elm_app_info_set() early on before you change working
696 * directory or anything about @c argv[0], so it gets accurate
699 * It will then try and trace back which file @p mainfunc comes from,
700 * if provided, to determine the application's prefix directory.
702 * The @p dom parameter provides a string prefix to prepend before
703 * environment variables, allowing a fallback to @b specific
704 * environment variables to locate the software. You would most
705 * probably provide a lowercase string there, because it will also
706 * serve as directory domain, explained next. For environment
707 * variables purposes, this string is made uppercase. For example if
708 * @c "myapp" is provided as the prefix, then the program would expect
709 * @c "MYAPP_PREFIX" as a master environment variable to specify the
710 * exact install prefix for the software, or more specific environment
711 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
712 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
713 * the user or scripts before launching. If not provided (@c NULL),
714 * environment variables will not be used to override compiled-in
715 * defaults or auto detections.
717 * The @p dom string also provides a subdirectory inside the system
718 * shared data directory for data files. For example, if the system
719 * directory is @c /usr/local/share, then this directory name is
720 * appended, creating @c /usr/local/share/myapp, if it @p was @c
721 * "myapp". It is expected the application installs data files in
724 * The @p checkfile is a file name or path of something inside the
725 * share or data directory to be used to test that the prefix
726 * detection worked. For example, your app will install a wallpaper
727 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
728 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
731 * @see elm_app_compile_bin_dir_set()
732 * @see elm_app_compile_lib_dir_set()
733 * @see elm_app_compile_data_dir_set()
734 * @see elm_app_compile_locale_set()
735 * @see elm_app_prefix_dir_get()
736 * @see elm_app_bin_dir_get()
737 * @see elm_app_lib_dir_get()
738 * @see elm_app_data_dir_get()
739 * @see elm_app_locale_dir_get()
741 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
744 * Provide information on the @b fallback application's binaries
745 * directory, on scenarios where they get overriden by
746 * elm_app_info_set().
748 * @param dir The path to the default binaries directory (compile time
751 * @note Elementary will as well use this path to determine actual
752 * names of binaries' directory paths, maybe changing it to be @c
753 * something/local/bin instead of @c something/bin, only, for
756 * @warning You should call this function @b before
757 * elm_app_info_set().
759 EAPI void elm_app_compile_bin_dir_set(const char *dir);
762 * Provide information on the @b fallback application's libraries
763 * directory, on scenarios where they get overriden by
764 * elm_app_info_set().
766 * @param dir The path to the default libraries directory (compile
769 * @note Elementary will as well use this path to determine actual
770 * names of libraries' directory paths, maybe changing it to be @c
771 * something/lib32 or @c something/lib64 instead of @c something/lib,
774 * @warning You should call this function @b before
775 * elm_app_info_set().
777 EAPI void elm_app_compile_lib_dir_set(const char *dir);
780 * Provide information on the @b fallback application's data
781 * directory, on scenarios where they get overriden by
782 * elm_app_info_set().
784 * @param dir The path to the default data directory (compile time
787 * @note Elementary will as well use this path to determine actual
788 * names of data directory paths, maybe changing it to be @c
789 * something/local/share instead of @c something/share, only, for
792 * @warning You should call this function @b before
793 * elm_app_info_set().
795 EAPI void elm_app_compile_data_dir_set(const char *dir);
798 * Provide information on the @b fallback application's locale
799 * directory, on scenarios where they get overriden by
800 * elm_app_info_set().
802 * @param dir The path to the default locale directory (compile time
805 * @warning You should call this function @b before
806 * elm_app_info_set().
808 EAPI void elm_app_compile_locale_set(const char *dir);
811 * Retrieve the application's run time prefix directory, as set by
812 * elm_app_info_set() and the way (environment) the application was
815 * @return The directory prefix the application is actually using
817 EAPI const char *elm_app_prefix_dir_get(void);
820 * Retrieve the application's run time binaries prefix directory, as
821 * set by elm_app_info_set() and the way (environment) the application
824 * @return The binaries directory prefix the application is actually
827 EAPI const char *elm_app_bin_dir_get(void);
830 * Retrieve the application's run time libraries prefix directory, as
831 * set by elm_app_info_set() and the way (environment) the application
834 * @return The libraries directory prefix the application is actually
837 EAPI const char *elm_app_lib_dir_get(void);
840 * Retrieve the application's run time data prefix directory, as
841 * set by elm_app_info_set() and the way (environment) the application
844 * @return The data directory prefix the application is actually
847 EAPI const char *elm_app_data_dir_get(void);
850 * Retrieve the application's run time locale prefix directory, as
851 * set by elm_app_info_set() and the way (environment) the application
854 * @return The locale directory prefix the application is actually
857 EAPI const char *elm_app_locale_dir_get(void);
859 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
860 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
861 EAPI int elm_quicklaunch_init(int argc, char **argv);
862 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
863 EAPI int elm_quicklaunch_sub_shutdown(void);
864 EAPI int elm_quicklaunch_shutdown(void);
865 EAPI void elm_quicklaunch_seed(void);
866 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
867 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
868 EAPI void elm_quicklaunch_cleanup(void);
869 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
870 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
872 EAPI Eina_Bool elm_need_efreet(void);
873 EAPI Eina_Bool elm_need_e_dbus(void);
876 * This must be called before any other function that handle with
877 * elm_thumb objects or ethumb_client instances.
881 EAPI Eina_Bool elm_need_ethumb(void);
884 * Set a new policy's value (for a given policy group/identifier).
886 * @param policy policy identifier, as in @ref Elm_Policy.
887 * @param value policy value, which depends on the identifier
889 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
891 * Elementary policies define applications' behavior,
892 * somehow. These behaviors are divided in policy groups (see
893 * #Elm_Policy enumeration). This call will emit the Ecore event
894 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
895 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
898 * @note Currently, we have only one policy identifier/group
899 * (#ELM_POLICY_QUIT), which has two possible values.
903 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
906 * Gets the policy value set for given policy identifier.
908 * @param policy policy identifier, as in #Elm_Policy.
909 * @return The currently set policy value, for that
910 * identifier. Will be @c 0 if @p policy passed is invalid.
914 EAPI int elm_policy_get(unsigned int policy);
917 * Set a label of an object
919 * @param obj The Elementary object
920 * @param part The text part name to set (NULL for the default label)
921 * @param label The new text of the label
923 * @note Elementary objects may have many labels (e.g. Action Slider)
927 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
929 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
932 * Get a label of an object
934 * @param obj The Elementary object
935 * @param part The text part name to get (NULL for the default label)
936 * @return text of the label or NULL for any error
938 * @note Elementary objects may have many labels (e.g. Action Slider)
942 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
944 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
947 * Set a content of an object
949 * @param obj The Elementary object
950 * @param part The content part name to set (NULL for the default content)
951 * @param content The new content of the object
953 * @note Elementary objects may have many contents
957 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
959 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
962 * Get a content of an object
964 * @param obj The Elementary object
965 * @param item The content part name to get (NULL for the default content)
966 * @return content of the object or NULL for any error
968 * @note Elementary objects may have many contents
972 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
974 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
977 * Unset a content of an object
979 * @param obj The Elementary object
980 * @param item The content part name to unset (NULL for the default content)
982 * @note Elementary objects may have many contents
986 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
988 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
991 * Set a content of an object item
993 * @param it The Elementary object item
994 * @param part The content part name to unset (NULL for the default content)
995 * @param content The new content of the object item
997 * @note Elementary object items may have many contents
1001 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1003 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1006 * Get a content of an object item
1008 * @param it The Elementary object item
1009 * @param part The content part name to unset (NULL for the default content)
1010 * @return content of the object item or NULL for any error
1012 * @note Elementary object items may have many contents
1016 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1018 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1021 * Unset a content of an object item
1023 * @param it The Elementary object item
1024 * @param part The content part name to unset (NULL for the default content)
1026 * @note Elementary object items may have many contents
1030 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1032 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1035 * Set a label of an objec itemt
1037 * @param it The Elementary object item
1038 * @param part The text part name to set (NULL for the default label)
1039 * @param label The new text of the label
1041 * @note Elementary object items may have many labels
1045 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1047 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1050 * Get a label of an object
1052 * @param it The Elementary object item
1053 * @param part The text part name to get (NULL for the default label)
1054 * @return text of the label or NULL for any error
1056 * @note Elementary object items may have many labels
1060 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1062 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1069 * @defgroup Caches Caches
1071 * These are functions which let one fine-tune some cache values for
1072 * Elementary applications, thus allowing for performance adjustments.
1078 * @brief Flush all caches.
1080 * Frees all data that was in cache and is not currently being used to reduce
1081 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1082 * to calling all of the following functions:
1083 * @li edje_file_cache_flush()
1084 * @li edje_collection_cache_flush()
1085 * @li eet_clearcache()
1086 * @li evas_image_cache_flush()
1087 * @li evas_font_cache_flush()
1088 * @li evas_render_dump()
1089 * @note Evas caches are flushed for every canvas associated with a window.
1093 EAPI void elm_all_flush(void);
1096 * Get the configured cache flush interval time
1098 * This gets the globally configured cache flush interval time, in
1101 * @return The cache flush interval time
1104 * @see elm_all_flush()
1106 EAPI int elm_cache_flush_interval_get(void);
1109 * Set the configured cache flush interval time
1111 * This sets the globally configured cache flush interval time, in ticks
1113 * @param size The cache flush interval time
1116 * @see elm_all_flush()
1118 EAPI void elm_cache_flush_interval_set(int size);
1121 * Set the configured cache flush interval time for all applications on the
1124 * This sets the globally configured cache flush interval time -- in ticks
1125 * -- for all applications on the display.
1127 * @param size The cache flush interval time
1130 EAPI void elm_cache_flush_interval_all_set(int size);
1133 * Get the configured cache flush enabled state
1135 * This gets the globally configured cache flush state - if it is enabled
1136 * or not. When cache flushing is enabled, elementary will regularly
1137 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1138 * memory and allow usage to re-seed caches and data in memory where it
1139 * can do so. An idle application will thus minimise its memory usage as
1140 * data will be freed from memory and not be re-loaded as it is idle and
1141 * not rendering or doing anything graphically right now.
1143 * @return The cache flush state
1146 * @see elm_all_flush()
1148 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1151 * Set the configured cache flush enabled state
1153 * This sets the globally configured cache flush enabled state
1155 * @param size The cache flush enabled state
1158 * @see elm_all_flush()
1160 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1163 * Set the configured cache flush enabled state for all applications on the
1166 * This sets the globally configured cache flush enabled state for all
1167 * applications on the display.
1169 * @param size The cache flush enabled state
1172 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1175 * Get the configured font cache size
1177 * This gets the globally configured font cache size, in bytes
1179 * @return The font cache size
1182 EAPI int elm_font_cache_get(void);
1185 * Set the configured font cache size
1187 * This sets the globally configured font cache size, in bytes
1189 * @param size The font cache size
1192 EAPI void elm_font_cache_set(int size);
1195 * Set the configured font cache size for all applications on the
1198 * This sets the globally configured font cache size -- in bytes
1199 * -- for all applications on the display.
1201 * @param size The font cache size
1204 EAPI void elm_font_cache_all_set(int size);
1207 * Get the configured image cache size
1209 * This gets the globally configured image cache size, in bytes
1211 * @return The image cache size
1214 EAPI int elm_image_cache_get(void);
1217 * Set the configured image cache size
1219 * This sets the globally configured image cache size, in bytes
1221 * @param size The image cache size
1224 EAPI void elm_image_cache_set(int size);
1227 * Set the configured image cache size for all applications on the
1230 * This sets the globally configured image cache size -- in bytes
1231 * -- for all applications on the display.
1233 * @param size The image cache size
1236 EAPI void elm_image_cache_all_set(int size);
1239 * Get the configured edje file cache size.
1241 * This gets the globally configured edje file cache size, in number
1244 * @return The edje file cache size
1247 EAPI int elm_edje_file_cache_get(void);
1250 * Set the configured edje file cache size
1252 * This sets the globally configured edje file cache size, in number
1255 * @param size The edje file cache size
1258 EAPI void elm_edje_file_cache_set(int size);
1261 * Set the configured edje file cache size for all applications on the
1264 * This sets the globally configured edje file cache size -- in number
1265 * of files -- for all applications on the display.
1267 * @param size The edje file cache size
1270 EAPI void elm_edje_file_cache_all_set(int size);
1273 * Get the configured edje collections (groups) cache size.
1275 * This gets the globally configured edje collections cache size, in
1276 * number of collections.
1278 * @return The edje collections cache size
1281 EAPI int elm_edje_collection_cache_get(void);
1284 * Set the configured edje collections (groups) cache size
1286 * This sets the globally configured edje collections cache size, in
1287 * number of collections.
1289 * @param size The edje collections cache size
1292 EAPI void elm_edje_collection_cache_set(int size);
1295 * Set the configured edje collections (groups) cache size for all
1296 * applications on the display
1298 * This sets the globally configured edje collections cache size -- in
1299 * number of collections -- for all applications on the display.
1301 * @param size The edje collections cache size
1304 EAPI void elm_edje_collection_cache_all_set(int size);
1311 * @defgroup Scaling Widget Scaling
1313 * Different widgets can be scaled independently. These functions
1314 * allow you to manipulate this scaling on a per-widget basis. The
1315 * object and all its children get their scaling factors multiplied
1316 * by the scale factor set. This is multiplicative, in that if a
1317 * child also has a scale size set it is in turn multiplied by its
1318 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1319 * double size, @c 0.5 is half, etc.
1321 * @ref general_functions_example_page "This" example contemplates
1322 * some of these functions.
1326 * Get the global scaling factor
1328 * This gets the globally configured scaling factor that is applied to all
1331 * @return The scaling factor
1334 EAPI double elm_scale_get(void);
1337 * Set the global scaling factor
1339 * This sets the globally configured scaling factor that is applied to all
1342 * @param scale The scaling factor to set
1345 EAPI void elm_scale_set(double scale);
1348 * Set the global scaling factor for all applications on the display
1350 * This sets the globally configured scaling factor that is applied to all
1351 * objects for all applications.
1352 * @param scale The scaling factor to set
1355 EAPI void elm_scale_all_set(double scale);
1358 * Set the scaling factor for a given Elementary object
1360 * @param obj The Elementary to operate on
1361 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1366 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1369 * Get the scaling factor for a given Elementary object
1371 * @param obj The object
1372 * @return The scaling factor set by elm_object_scale_set()
1376 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1379 * @defgroup UI-Mirroring Selective Widget mirroring
1381 * These functions allow you to set ui-mirroring on specific
1382 * widgets or the whole interface. Widgets can be in one of two
1383 * modes, automatic and manual. Automatic means they'll be changed
1384 * according to the system mirroring mode and manual means only
1385 * explicit changes will matter. You are not supposed to change
1386 * mirroring state of a widget set to automatic, will mostly work,
1387 * but the behavior is not really defined.
1392 EAPI Eina_Bool elm_mirrored_get(void);
1393 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1396 * Get the system mirrored mode. This determines the default mirrored mode
1399 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1401 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1404 * Set the system mirrored mode. This determines the default mirrored mode
1407 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1409 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1412 * Returns the widget's mirrored mode setting.
1414 * @param obj The widget.
1415 * @return mirrored mode setting of the object.
1418 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1421 * Sets the widget's mirrored mode setting.
1422 * When widget in automatic mode, it follows the system mirrored mode set by
1423 * elm_mirrored_set().
1424 * @param obj The widget.
1425 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1427 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1434 * Set the style to use by a widget
1436 * Sets the style name that will define the appearance of a widget. Styles
1437 * vary from widget to widget and may also be defined by other themes
1438 * by means of extensions and overlays.
1440 * @param obj The Elementary widget to style
1441 * @param style The style name to use
1443 * @see elm_theme_extension_add()
1444 * @see elm_theme_extension_del()
1445 * @see elm_theme_overlay_add()
1446 * @see elm_theme_overlay_del()
1450 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1452 * Get the style used by the widget
1454 * This gets the style being used for that widget. Note that the string
1455 * pointer is only valid as longas the object is valid and the style doesn't
1458 * @param obj The Elementary widget to query for its style
1459 * @return The style name used
1461 * @see elm_object_style_set()
1465 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1468 * @defgroup Styles Styles
1470 * Widgets can have different styles of look. These generic API's
1471 * set styles of widgets, if they support them (and if the theme(s)
1474 * @ref general_functions_example_page "This" example contemplates
1475 * some of these functions.
1479 * Set the disabled state of an Elementary object.
1481 * @param obj The Elementary object to operate on
1482 * @param disabled The state to put in in: @c EINA_TRUE for
1483 * disabled, @c EINA_FALSE for enabled
1485 * Elementary objects can be @b disabled, in which state they won't
1486 * receive input and, in general, will be themed differently from
1487 * their normal state, usually greyed out. Useful for contexts
1488 * where you don't want your users to interact with some of the
1489 * parts of you interface.
1491 * This sets the state for the widget, either disabling it or
1496 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1499 * Get the disabled state of an Elementary object.
1501 * @param obj The Elementary object to operate on
1502 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1503 * if it's enabled (or on errors)
1505 * This gets the state of the widget, which might be enabled or disabled.
1509 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1512 * @defgroup WidgetNavigation Widget Tree Navigation.
1514 * How to check if an Evas Object is an Elementary widget? How to
1515 * get the first elementary widget that is parent of the given
1516 * object? These are all covered in widget tree navigation.
1518 * @ref general_functions_example_page "This" example contemplates
1519 * some of these functions.
1523 * Check if the given Evas Object is an Elementary widget.
1525 * @param obj the object to query.
1526 * @return @c EINA_TRUE if it is an elementary widget variant,
1527 * @c EINA_FALSE otherwise
1528 * @ingroup WidgetNavigation
1530 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1533 * Get the first parent of the given object that is an Elementary
1536 * @param obj the Elementary object to query parent from.
1537 * @return the parent object that is an Elementary widget, or @c
1538 * NULL, if it was not found.
1540 * Use this to query for an object's parent widget.
1542 * @note Most of Elementary users wouldn't be mixing non-Elementary
1543 * smart objects in the objects tree of an application, as this is
1544 * an advanced usage of Elementary with Evas. So, except for the
1545 * application's window, which is the root of that tree, all other
1546 * objects would have valid Elementary widget parents.
1548 * @ingroup WidgetNavigation
1550 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1553 * Get the top level parent of an Elementary widget.
1555 * @param obj The object to query.
1556 * @return The top level Elementary widget, or @c NULL if parent cannot be
1558 * @ingroup WidgetNavigation
1560 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 * Get the string that represents this Elementary widget.
1565 * @note Elementary is weird and exposes itself as a single
1566 * Evas_Object_Smart_Class of type "elm_widget", so
1567 * evas_object_type_get() always return that, making debug and
1568 * language bindings hard. This function tries to mitigate this
1569 * problem, but the solution is to change Elementary to use
1570 * proper inheritance.
1572 * @param obj the object to query.
1573 * @return Elementary widget name, or @c NULL if not a valid widget.
1574 * @ingroup WidgetNavigation
1576 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579 * @defgroup Config Elementary Config
1581 * Elementary configuration is formed by a set options bounded to a
1582 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1583 * "finger size", etc. These are functions with which one syncronizes
1584 * changes made to those values to the configuration storing files, de
1585 * facto. You most probably don't want to use the functions in this
1586 * group unlees you're writing an elementary configuration manager.
1592 * Save back Elementary's configuration, so that it will persist on
1595 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1598 * This function will take effect -- thus, do I/O -- immediately. Use
1599 * it when you want to apply all configuration changes at once. The
1600 * current configuration set will get saved onto the current profile
1601 * configuration file.
1604 EAPI Eina_Bool elm_config_save(void);
1607 * Reload Elementary's configuration, bounded to current selected
1610 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1613 * Useful when you want to force reloading of configuration values for
1614 * a profile. If one removes user custom configuration directories,
1615 * for example, it will force a reload with system values insted.
1618 EAPI void elm_config_reload(void);
1625 * @defgroup Profile Elementary Profile
1627 * Profiles are pre-set options that affect the whole look-and-feel of
1628 * Elementary-based applications. There are, for example, profiles
1629 * aimed at desktop computer applications and others aimed at mobile,
1630 * touchscreen-based ones. You most probably don't want to use the
1631 * functions in this group unlees you're writing an elementary
1632 * configuration manager.
1638 * Get Elementary's profile in use.
1640 * This gets the global profile that is applied to all Elementary
1643 * @return The profile's name
1646 EAPI const char *elm_profile_current_get(void);
1649 * Get an Elementary's profile directory path in the filesystem. One
1650 * may want to fetch a system profile's dir or an user one (fetched
1653 * @param profile The profile's name
1654 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1655 * or a system one (@c EINA_FALSE)
1656 * @return The profile's directory path.
1659 * @note You must free it with elm_profile_dir_free().
1661 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1664 * Free an Elementary's profile directory path, as returned by
1665 * elm_profile_dir_get().
1667 * @param p_dir The profile's path
1671 EAPI void elm_profile_dir_free(const char *p_dir);
1674 * Get Elementary's list of available profiles.
1676 * @return The profiles list. List node data are the profile name
1680 * @note One must free this list, after usage, with the function
1681 * elm_profile_list_free().
1683 EAPI Eina_List *elm_profile_list_get(void);
1686 * Free Elementary's list of available profiles.
1688 * @param l The profiles list, as returned by elm_profile_list_get().
1692 EAPI void elm_profile_list_free(Eina_List *l);
1695 * Set Elementary's profile.
1697 * This sets the global profile that is applied to Elementary
1698 * applications. Just the process the call comes from will be
1701 * @param profile The profile's name
1705 EAPI void elm_profile_set(const char *profile);
1708 * Set Elementary's profile.
1710 * This sets the global profile that is applied to all Elementary
1711 * applications. All running Elementary windows will be affected.
1713 * @param profile The profile's name
1717 EAPI void elm_profile_all_set(const char *profile);
1724 * @defgroup Engine Elementary Engine
1726 * These are functions setting and querying which rendering engine
1727 * Elementary will use for drawing its windows' pixels.
1729 * The following are the available engines:
1730 * @li "software_x11"
1733 * @li "software_16_x11"
1734 * @li "software_8_x11"
1737 * @li "software_gdi"
1738 * @li "software_16_wince_gdi"
1740 * @li "software_16_sdl"
1748 * @brief Get Elementary's rendering engine in use.
1750 * @return The rendering engine's name
1751 * @note there's no need to free the returned string, here.
1753 * This gets the global rendering engine that is applied to all Elementary
1756 * @see elm_engine_set()
1758 EAPI const char *elm_engine_current_get(void);
1761 * @brief Set Elementary's rendering engine for use.
1763 * @param engine The rendering engine's name
1765 * This sets global rendering engine that is applied to all Elementary
1766 * applications. Note that it will take effect only to Elementary windows
1767 * created after this is called.
1769 * @see elm_win_add()
1771 EAPI void elm_engine_set(const char *engine);
1778 * @defgroup Fonts Elementary Fonts
1780 * These are functions dealing with font rendering, selection and the
1781 * like for Elementary applications. One might fetch which system
1782 * fonts are there to use and set custom fonts for individual classes
1783 * of UI items containing text (text classes).
1788 typedef struct _Elm_Text_Class
1794 typedef struct _Elm_Font_Overlay
1796 const char *text_class;
1798 Evas_Font_Size size;
1801 typedef struct _Elm_Font_Properties
1805 } Elm_Font_Properties;
1808 * Get Elementary's list of supported text classes.
1810 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1813 * Release the list with elm_text_classes_list_free().
1815 EAPI const Eina_List *elm_text_classes_list_get(void);
1818 * Free Elementary's list of supported text classes.
1822 * @see elm_text_classes_list_get().
1824 EAPI void elm_text_classes_list_free(const Eina_List *list);
1827 * Get Elementary's list of font overlays, set with
1828 * elm_font_overlay_set().
1830 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1835 * For each text class, one can set a <b>font overlay</b> for it,
1836 * overriding the default font properties for that class coming from
1837 * the theme in use. There is no need to free this list.
1839 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1841 EAPI const Eina_List *elm_font_overlay_list_get(void);
1844 * Set a font overlay for a given Elementary text class.
1846 * @param text_class Text class name
1847 * @param font Font name and style string
1848 * @param size Font size
1852 * @p font has to be in the format returned by
1853 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1854 * and elm_font_overlay_unset().
1856 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1859 * Unset a font overlay for a given Elementary text class.
1861 * @param text_class Text class name
1865 * This will bring back text elements belonging to text class
1866 * @p text_class back to their default font settings.
1868 EAPI void elm_font_overlay_unset(const char *text_class);
1871 * Apply the changes made with elm_font_overlay_set() and
1872 * elm_font_overlay_unset() on the current Elementary window.
1876 * This applies all font overlays set to all objects in the UI.
1878 EAPI void elm_font_overlay_apply(void);
1881 * Apply the changes made with elm_font_overlay_set() and
1882 * elm_font_overlay_unset() on all Elementary application windows.
1886 * This applies all font overlays set to all objects in the UI.
1888 EAPI void elm_font_overlay_all_apply(void);
1891 * Translate a font (family) name string in fontconfig's font names
1892 * syntax into an @c Elm_Font_Properties struct.
1894 * @param font The font name and styles string
1895 * @return the font properties struct
1899 * @note The reverse translation can be achived with
1900 * elm_font_fontconfig_name_get(), for one style only (single font
1901 * instance, not family).
1903 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1906 * Free font properties return by elm_font_properties_get().
1908 * @param efp the font properties struct
1912 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1915 * Translate a font name, bound to a style, into fontconfig's font names
1918 * @param name The font (family) name
1919 * @param style The given style (may be @c NULL)
1921 * @return the font name and style string
1925 * @note The reverse translation can be achived with
1926 * elm_font_properties_get(), for one style only (single font
1927 * instance, not family).
1929 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1932 * Free the font string return by elm_font_fontconfig_name_get().
1934 * @param efp the font properties struct
1938 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1941 * Create a font hash table of available system fonts.
1943 * One must call it with @p list being the return value of
1944 * evas_font_available_list(). The hash will be indexed by font
1945 * (family) names, being its values @c Elm_Font_Properties blobs.
1947 * @param list The list of available system fonts, as returned by
1948 * evas_font_available_list().
1949 * @return the font hash.
1953 * @note The user is supposed to get it populated at least with 3
1954 * default font families (Sans, Serif, Monospace), which should be
1955 * present on most systems.
1957 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1960 * Free the hash return by elm_font_available_hash_add().
1962 * @param hash the hash to be freed.
1966 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1973 * @defgroup Fingers Fingers
1975 * Elementary is designed to be finger-friendly for touchscreens,
1976 * and so in addition to scaling for display resolution, it can
1977 * also scale based on finger "resolution" (or size). You can then
1978 * customize the granularity of the areas meant to receive clicks
1981 * Different profiles may have pre-set values for finger sizes.
1983 * @ref general_functions_example_page "This" example contemplates
1984 * some of these functions.
1990 * Get the configured "finger size"
1992 * @return The finger size
1994 * This gets the globally configured finger size, <b>in pixels</b>
1998 EAPI Evas_Coord elm_finger_size_get(void);
2001 * Set the configured finger size
2003 * This sets the globally configured finger size in pixels
2005 * @param size The finger size
2008 EAPI void elm_finger_size_set(Evas_Coord size);
2011 * Set the configured finger size for all applications on the display
2013 * This sets the globally configured finger size in pixels for all
2014 * applications on the display
2016 * @param size The finger size
2019 EAPI void elm_finger_size_all_set(Evas_Coord size);
2026 * @defgroup Focus Focus
2028 * An Elementary application has, at all times, one (and only one)
2029 * @b focused object. This is what determines where the input
2030 * events go to within the application's window. Also, focused
2031 * objects can be decorated differently, in order to signal to the
2032 * user where the input is, at a given moment.
2034 * Elementary applications also have the concept of <b>focus
2035 * chain</b>: one can cycle through all the windows' focusable
2036 * objects by input (tab key) or programmatically. The default
2037 * focus chain for an application is the one define by the order in
2038 * which the widgets where added in code. One will cycle through
2039 * top level widgets, and, for each one containg sub-objects, cycle
2040 * through them all, before returning to the level
2041 * above. Elementary also allows one to set @b custom focus chains
2042 * for their applications.
2044 * Besides the focused decoration a widget may exhibit, when it
2045 * gets focus, Elementary has a @b global focus highlight object
2046 * that can be enabled for a window. If one chooses to do so, this
2047 * extra highlight effect will surround the current focused object,
2050 * @note Some Elementary widgets are @b unfocusable, after
2051 * creation, by their very nature: they are not meant to be
2052 * interacted with input events, but are there just for visual
2055 * @ref general_functions_example_page "This" example contemplates
2056 * some of these functions.
2060 * Get the enable status of the focus highlight
2062 * This gets whether the highlight on focused objects is enabled or not
2065 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2068 * Set the enable status of the focus highlight
2070 * Set whether to show or not the highlight on focused objects
2071 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2074 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2077 * Get the enable status of the highlight animation
2079 * Get whether the focus highlight, if enabled, will animate its switch from
2080 * one object to the next
2083 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2086 * Set the enable status of the highlight animation
2088 * Set whether the focus highlight, if enabled, will animate its switch from
2089 * one object to the next
2090 * @param animate Enable animation if EINA_TRUE, disable otherwise
2093 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2096 * Get the whether an Elementary object has the focus or not.
2098 * @param obj The Elementary object to get the information from
2099 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2100 * not (and on errors).
2102 * @see elm_object_focus_set()
2106 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2109 * Set/unset focus to a given Elementary object.
2111 * @param obj The Elementary object to operate on.
2112 * @param enable @c EINA_TRUE Set focus to a given object,
2113 * @c EINA_FALSE Unset focus to a given object.
2115 * @note When you set focus to this object, if it can handle focus, will
2116 * take the focus away from the one who had it previously and will, for
2117 * now on, be the one receiving input events. Unsetting focus will remove
2118 * the focus from @p obj, passing it back to the previous element in the
2121 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2125 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2128 * Make a given Elementary object the focused one.
2130 * @param obj The Elementary object to make focused.
2132 * @note This object, if it can handle focus, will take the focus
2133 * away from the one who had it previously and will, for now on, be
2134 * the one receiving input events.
2136 * @see elm_object_focus_get()
2137 * @deprecated use elm_object_focus_set() instead.
2141 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2144 * Remove the focus from an Elementary object
2146 * @param obj The Elementary to take focus from
2148 * This removes the focus from @p obj, passing it back to the
2149 * previous element in the focus chain list.
2151 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2152 * @deprecated use elm_object_focus_set() instead.
2156 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2159 * Set the ability for an Element object to be focused
2161 * @param obj The Elementary object to operate on
2162 * @param enable @c EINA_TRUE if the object can be focused, @c
2163 * EINA_FALSE if not (and on errors)
2165 * This sets whether the object @p obj is able to take focus or
2166 * not. Unfocusable objects do nothing when programmatically
2167 * focused, being the nearest focusable parent object the one
2168 * really getting focus. Also, when they receive mouse input, they
2169 * will get the event, but not take away the focus from where it
2174 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2177 * Get whether an Elementary object is focusable or not
2179 * @param obj The Elementary object to operate on
2180 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2181 * EINA_FALSE if not (and on errors)
2183 * @note Objects which are meant to be interacted with by input
2184 * events are created able to be focused, by default. All the
2189 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2192 * Set custom focus chain.
2194 * This function overwrites any previous custom focus chain within
2195 * the list of objects. The previous list will be deleted and this list
2196 * will be managed by elementary. After it is set, don't modify it.
2198 * @note On focus cycle, only will be evaluated children of this container.
2200 * @param obj The container object
2201 * @param objs Chain of objects to pass focus
2204 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2207 * Unset a custom focus chain on a given Elementary widget
2209 * @param obj The container object to remove focus chain from
2211 * Any focus chain previously set on @p obj (for its child objects)
2212 * is removed entirely after this call.
2216 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2219 * Get custom focus chain
2221 * @param obj The container object
2224 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2227 * Append object to custom focus chain.
2229 * @note If relative_child equal to NULL or not in custom chain, the object
2230 * will be added in end.
2232 * @note On focus cycle, only will be evaluated children of this container.
2234 * @param obj The container object
2235 * @param child The child to be added in custom chain
2236 * @param relative_child The relative object to position the child
2239 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2242 * Prepend object to custom focus chain.
2244 * @note If relative_child equal to NULL or not in custom chain, the object
2245 * will be added in begin.
2247 * @note On focus cycle, only will be evaluated children of this container.
2249 * @param obj The container object
2250 * @param child The child to be added in custom chain
2251 * @param relative_child The relative object to position the child
2254 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2257 * Give focus to next object in object tree.
2259 * Give focus to next object in focus chain of one object sub-tree.
2260 * If the last object of chain already have focus, the focus will go to the
2261 * first object of chain.
2263 * @param obj The object root of sub-tree
2264 * @param dir Direction to cycle the focus
2268 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2271 * Give focus to near object in one direction.
2273 * Give focus to near object in direction of one object.
2274 * If none focusable object in given direction, the focus will not change.
2276 * @param obj The reference object
2277 * @param x Horizontal component of direction to focus
2278 * @param y Vertical component of direction to focus
2282 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2285 * Make the elementary object and its children to be unfocusable
2288 * @param obj The Elementary object to operate on
2289 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2290 * @c EINA_FALSE for focusable.
2292 * This sets whether the object @p obj and its children objects
2293 * are able to take focus or not. If the tree is set as unfocusable,
2294 * newest focused object which is not in this tree will get focus.
2295 * This API can be helpful for an object to be deleted.
2296 * When an object will be deleted soon, it and its children may not
2297 * want to get focus (by focus reverting or by other focus controls).
2298 * Then, just use this API before deleting.
2300 * @see elm_object_tree_unfocusable_get()
2304 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2307 * Get whether an Elementary object and its children are unfocusable or not.
2309 * @param obj The Elementary object to get the information from
2310 * @return @c EINA_TRUE, if the tree is unfocussable,
2311 * @c EINA_FALSE if not (and on errors).
2313 * @see elm_object_tree_unfocusable_set()
2317 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2320 * @defgroup Scrolling Scrolling
2322 * These are functions setting how scrollable views in Elementary
2323 * widgets should behave on user interaction.
2329 * Get whether scrollers should bounce when they reach their
2330 * viewport's edge during a scroll.
2332 * @return the thumb scroll bouncing state
2334 * This is the default behavior for touch screens, in general.
2335 * @ingroup Scrolling
2337 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2340 * Set whether scrollers should bounce when they reach their
2341 * viewport's edge during a scroll.
2343 * @param enabled the thumb scroll bouncing state
2345 * @see elm_thumbscroll_bounce_enabled_get()
2346 * @ingroup Scrolling
2348 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2351 * Set whether scrollers should bounce when they reach their
2352 * viewport's edge during a scroll, for all Elementary application
2355 * @param enabled the thumb scroll bouncing state
2357 * @see elm_thumbscroll_bounce_enabled_get()
2358 * @ingroup Scrolling
2360 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2363 * Get the amount of inertia a scroller will impose at bounce
2366 * @return the thumb scroll bounce friction
2368 * @ingroup Scrolling
2370 EAPI double elm_scroll_bounce_friction_get(void);
2373 * Set the amount of inertia a scroller will impose at bounce
2376 * @param friction the thumb scroll bounce friction
2378 * @see elm_thumbscroll_bounce_friction_get()
2379 * @ingroup Scrolling
2381 EAPI void elm_scroll_bounce_friction_set(double friction);
2384 * Set the amount of inertia a scroller will impose at bounce
2385 * animations, for all Elementary application windows.
2387 * @param friction the thumb scroll bounce friction
2389 * @see elm_thumbscroll_bounce_friction_get()
2390 * @ingroup Scrolling
2392 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2395 * Get the amount of inertia a <b>paged</b> scroller will impose at
2396 * page fitting animations.
2398 * @return the page scroll friction
2400 * @ingroup Scrolling
2402 EAPI double elm_scroll_page_scroll_friction_get(void);
2405 * Set the amount of inertia a <b>paged</b> scroller will impose at
2406 * page fitting animations.
2408 * @param friction the page scroll friction
2410 * @see elm_thumbscroll_page_scroll_friction_get()
2411 * @ingroup Scrolling
2413 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2416 * Set the amount of inertia a <b>paged</b> scroller will impose at
2417 * page fitting animations, for all Elementary application windows.
2419 * @param friction the page scroll friction
2421 * @see elm_thumbscroll_page_scroll_friction_get()
2422 * @ingroup Scrolling
2424 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2427 * Get the amount of inertia a scroller will impose at region bring
2430 * @return the bring in scroll friction
2432 * @ingroup Scrolling
2434 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2437 * Set the amount of inertia a scroller will impose at region bring
2440 * @param friction the bring in scroll friction
2442 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2443 * @ingroup Scrolling
2445 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2448 * Set the amount of inertia a scroller will impose at region bring
2449 * animations, for all Elementary application windows.
2451 * @param friction the bring in scroll friction
2453 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2454 * @ingroup Scrolling
2456 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2459 * Get the amount of inertia scrollers will impose at animations
2460 * triggered by Elementary widgets' zooming API.
2462 * @return the zoom friction
2464 * @ingroup Scrolling
2466 EAPI double elm_scroll_zoom_friction_get(void);
2469 * Set the amount of inertia scrollers will impose at animations
2470 * triggered by Elementary widgets' zooming API.
2472 * @param friction the zoom friction
2474 * @see elm_thumbscroll_zoom_friction_get()
2475 * @ingroup Scrolling
2477 EAPI void elm_scroll_zoom_friction_set(double friction);
2480 * Set the amount of inertia scrollers will impose at animations
2481 * triggered by Elementary widgets' zooming API, for all Elementary
2482 * application windows.
2484 * @param friction the zoom friction
2486 * @see elm_thumbscroll_zoom_friction_get()
2487 * @ingroup Scrolling
2489 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2492 * Get whether scrollers should be draggable from any point in their
2495 * @return the thumb scroll state
2497 * @note This is the default behavior for touch screens, in general.
2498 * @note All other functions namespaced with "thumbscroll" will only
2499 * have effect if this mode is enabled.
2501 * @ingroup Scrolling
2503 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2506 * Set whether scrollers should be draggable from any point in their
2509 * @param enabled the thumb scroll state
2511 * @see elm_thumbscroll_enabled_get()
2512 * @ingroup Scrolling
2514 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2517 * Set whether scrollers should be draggable from any point in their
2518 * views, for all Elementary application windows.
2520 * @param enabled the thumb scroll state
2522 * @see elm_thumbscroll_enabled_get()
2523 * @ingroup Scrolling
2525 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2528 * Get the number of pixels one should travel while dragging a
2529 * scroller's view to actually trigger scrolling.
2531 * @return the thumb scroll threshould
2533 * One would use higher values for touch screens, in general, because
2534 * of their inherent imprecision.
2535 * @ingroup Scrolling
2537 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2540 * Set the number of pixels one should travel while dragging a
2541 * scroller's view to actually trigger scrolling.
2543 * @param threshold the thumb scroll threshould
2545 * @see elm_thumbscroll_threshould_get()
2546 * @ingroup Scrolling
2548 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2551 * Set the number of pixels one should travel while dragging a
2552 * scroller's view to actually trigger scrolling, for all Elementary
2553 * application windows.
2555 * @param threshold the thumb scroll threshould
2557 * @see elm_thumbscroll_threshould_get()
2558 * @ingroup Scrolling
2560 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2563 * Get the minimum speed of mouse cursor movement which will trigger
2564 * list self scrolling animation after a mouse up event
2567 * @return the thumb scroll momentum threshould
2569 * @ingroup Scrolling
2571 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2574 * Set the minimum speed of mouse cursor movement which will trigger
2575 * list self scrolling animation after a mouse up event
2578 * @param threshold the thumb scroll momentum threshould
2580 * @see elm_thumbscroll_momentum_threshould_get()
2581 * @ingroup Scrolling
2583 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2586 * Set the minimum speed of mouse cursor movement which will trigger
2587 * list self scrolling animation after a mouse up event
2588 * (pixels/second), for all Elementary application windows.
2590 * @param threshold the thumb scroll momentum threshould
2592 * @see elm_thumbscroll_momentum_threshould_get()
2593 * @ingroup Scrolling
2595 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2598 * Get the amount of inertia a scroller will impose at self scrolling
2601 * @return the thumb scroll friction
2603 * @ingroup Scrolling
2605 EAPI double elm_scroll_thumbscroll_friction_get(void);
2608 * Set the amount of inertia a scroller will impose at self scrolling
2611 * @param friction the thumb scroll friction
2613 * @see elm_thumbscroll_friction_get()
2614 * @ingroup Scrolling
2616 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2619 * Set the amount of inertia a scroller will impose at self scrolling
2620 * animations, for all Elementary application windows.
2622 * @param friction the thumb scroll friction
2624 * @see elm_thumbscroll_friction_get()
2625 * @ingroup Scrolling
2627 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2630 * Get the amount of lag between your actual mouse cursor dragging
2631 * movement and a scroller's view movement itself, while pushing it
2632 * into bounce state manually.
2634 * @return the thumb scroll border friction
2636 * @ingroup Scrolling
2638 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2641 * Set the amount of lag between your actual mouse cursor dragging
2642 * movement and a scroller's view movement itself, while pushing it
2643 * into bounce state manually.
2645 * @param friction the thumb scroll border friction. @c 0.0 for
2646 * perfect synchrony between two movements, @c 1.0 for maximum
2649 * @see elm_thumbscroll_border_friction_get()
2650 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2652 * @ingroup Scrolling
2654 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2657 * Set the amount of lag between your actual mouse cursor dragging
2658 * movement and a scroller's view movement itself, while pushing it
2659 * into bounce state manually, for all Elementary application windows.
2661 * @param friction the thumb scroll border friction. @c 0.0 for
2662 * perfect synchrony between two movements, @c 1.0 for maximum
2665 * @see elm_thumbscroll_border_friction_get()
2666 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2668 * @ingroup Scrolling
2670 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2677 * @defgroup Scrollhints Scrollhints
2679 * Objects when inside a scroller can scroll, but this may not always be
2680 * desirable in certain situations. This allows an object to hint to itself
2681 * and parents to "not scroll" in one of 2 ways. If any child object of a
2682 * scroller has pushed a scroll freeze or hold then it affects all parent
2683 * scrollers until all children have released them.
2685 * 1. To hold on scrolling. This means just flicking and dragging may no
2686 * longer scroll, but pressing/dragging near an edge of the scroller will
2687 * still scroll. This is automatically used by the entry object when
2690 * 2. To totally freeze scrolling. This means it stops. until
2697 * Push the scroll hold by 1
2699 * This increments the scroll hold count by one. If it is more than 0 it will
2700 * take effect on the parents of the indicated object.
2702 * @param obj The object
2703 * @ingroup Scrollhints
2705 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2708 * Pop the scroll hold by 1
2710 * This decrements the scroll hold count by one. If it is more than 0 it will
2711 * take effect on the parents of the indicated object.
2713 * @param obj The object
2714 * @ingroup Scrollhints
2716 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2719 * Push the scroll freeze by 1
2721 * This increments the scroll freeze count by one. If it is more
2722 * than 0 it will take effect on the parents of the indicated
2725 * @param obj The object
2726 * @ingroup Scrollhints
2728 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2731 * Pop the scroll freeze by 1
2733 * This decrements the scroll freeze count by one. If it is more
2734 * than 0 it will take effect on the parents of the indicated
2737 * @param obj The object
2738 * @ingroup Scrollhints
2740 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2743 * Lock the scrolling of the given widget (and thus all parents)
2745 * This locks the given object from scrolling in the X axis (and implicitly
2746 * also locks all parent scrollers too from doing the same).
2748 * @param obj The object
2749 * @param lock The lock state (1 == locked, 0 == unlocked)
2750 * @ingroup Scrollhints
2752 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2755 * Lock the scrolling of the given widget (and thus all parents)
2757 * This locks the given object from scrolling in the Y axis (and implicitly
2758 * also locks all parent scrollers too from doing the same).
2760 * @param obj The object
2761 * @param lock The lock state (1 == locked, 0 == unlocked)
2762 * @ingroup Scrollhints
2764 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2767 * Get the scrolling lock of the given widget
2769 * This gets the lock for X axis scrolling.
2771 * @param obj The object
2772 * @ingroup Scrollhints
2774 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2777 * Get the scrolling lock of the given widget
2779 * This gets the lock for X axis scrolling.
2781 * @param obj The object
2782 * @ingroup Scrollhints
2784 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2791 * Send a signal to the widget edje object.
2793 * This function sends a signal to the edje object of the obj. An
2794 * edje program can respond to a signal by specifying matching
2795 * 'signal' and 'source' fields.
2797 * @param obj The object
2798 * @param emission The signal's name.
2799 * @param source The signal's source.
2802 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2805 * Add a callback for a signal emitted by widget edje object.
2807 * This function connects a callback function to a signal emitted by the
2808 * edje object of the obj.
2809 * Globs can occur in either the emission or source name.
2811 * @param obj The object
2812 * @param emission The signal's name.
2813 * @param source The signal's source.
2814 * @param func The callback function to be executed when the signal is
2816 * @param data A pointer to data to pass in to the callback function.
2819 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);
2822 * Remove a signal-triggered callback from an widget edje object.
2824 * This function removes a callback, previoulsy attached to a
2825 * signal emitted by the edje object of the obj. The parameters
2826 * emission, source and func must match exactly those passed to a
2827 * previous call to elm_object_signal_callback_add(). The data
2828 * pointer that was passed to this call will be returned.
2830 * @param obj The object
2831 * @param emission The signal's name.
2832 * @param source The signal's source.
2833 * @param func The callback function to be executed when the signal is
2835 * @return The data pointer
2838 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);
2841 * Add a callback for input events (key up, key down, mouse wheel)
2842 * on a given Elementary widget
2844 * @param obj The widget to add an event callback on
2845 * @param func The callback function to be executed when the event
2847 * @param data Data to pass in to @p func
2849 * Every widget in an Elementary interface set to receive focus,
2850 * with elm_object_focus_allow_set(), will propagate @b all of its
2851 * key up, key down and mouse wheel input events up to its parent
2852 * object, and so on. All of the focusable ones in this chain which
2853 * had an event callback set, with this call, will be able to treat
2854 * those events. There are two ways of making the propagation of
2855 * these event upwards in the tree of widgets to @b cease:
2856 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2857 * the event was @b not processed, so the propagation will go on.
2858 * - The @c event_info pointer passed to @p func will contain the
2859 * event's structure and, if you OR its @c event_flags inner
2860 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2861 * one has already handled it, thus killing the event's
2864 * @note Your event callback will be issued on those events taking
2865 * place only if no other child widget of @obj has consumed the
2868 * @note Not to be confused with @c
2869 * evas_object_event_callback_add(), which will add event callbacks
2870 * per type on general Evas objects (no event propagation
2871 * infrastructure taken in account).
2873 * @note Not to be confused with @c
2874 * elm_object_signal_callback_add(), which will add callbacks to @b
2875 * signals coming from a widget's theme, not input events.
2877 * @note Not to be confused with @c
2878 * edje_object_signal_callback_add(), which does the same as
2879 * elm_object_signal_callback_add(), but directly on an Edje
2882 * @note Not to be confused with @c
2883 * evas_object_smart_callback_add(), which adds callbacks to smart
2884 * objects' <b>smart events</b>, and not input events.
2886 * @see elm_object_event_callback_del()
2890 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2893 * Remove a event callback from an widget.
2895 * This function removes a callback, previoulsy attached to event emission
2897 * The parameters func and data must match exactly those passed to
2898 * a previous call to elm_object_event_callback_add(). The data pointer that
2899 * was passed to this call will be returned.
2901 * @param obj The object
2902 * @param func The callback function to be executed when the event is
2904 * @param data Data to pass in to the callback function.
2905 * @return The data pointer
2908 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2911 * Adjust size of an element for finger usage.
2913 * @param times_w How many fingers should fit horizontally
2914 * @param w Pointer to the width size to adjust
2915 * @param times_h How many fingers should fit vertically
2916 * @param h Pointer to the height size to adjust
2918 * This takes width and height sizes (in pixels) as input and a
2919 * size multiple (which is how many fingers you want to place
2920 * within the area, being "finger" the size set by
2921 * elm_finger_size_set()), and adjusts the size to be large enough
2922 * to accommodate the resulting size -- if it doesn't already
2923 * accommodate it. On return the @p w and @p h sizes pointed to by
2924 * these parameters will be modified, on those conditions.
2926 * @note This is kind of a low level Elementary call, most useful
2927 * on size evaluation times for widgets. An external user wouldn't
2928 * be calling, most of the time.
2932 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2935 * Get the duration for occuring long press event.
2937 * @return Timeout for long press event
2938 * @ingroup Longpress
2940 EAPI double elm_longpress_timeout_get(void);
2943 * Set the duration for occuring long press event.
2945 * @param lonpress_timeout Timeout for long press event
2946 * @ingroup Longpress
2948 EAPI void elm_longpress_timeout_set(double longpress_timeout);
2951 * @defgroup Debug Debug
2952 * don't use it unless you are sure
2958 * Print Tree object hierarchy in stdout
2960 * @param obj The root object
2963 EAPI void elm_object_tree_dump(const Evas_Object *top);
2966 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2968 * @param obj The root object
2969 * @param file The path of output file
2972 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2979 * @defgroup Theme Theme
2981 * Elementary uses Edje to theme its widgets, naturally. But for the most
2982 * part this is hidden behind a simpler interface that lets the user set
2983 * extensions and choose the style of widgets in a much easier way.
2985 * Instead of thinking in terms of paths to Edje files and their groups
2986 * each time you want to change the appearance of a widget, Elementary
2987 * works so you can add any theme file with extensions or replace the
2988 * main theme at one point in the application, and then just set the style
2989 * of widgets with elm_object_style_set() and related functions. Elementary
2990 * will then look in its list of themes for a matching group and apply it,
2991 * and when the theme changes midway through the application, all widgets
2992 * will be updated accordingly.
2994 * There are three concepts you need to know to understand how Elementary
2995 * theming works: default theme, extensions and overlays.
2997 * Default theme, obviously enough, is the one that provides the default
2998 * look of all widgets. End users can change the theme used by Elementary
2999 * by setting the @c ELM_THEME environment variable before running an
3000 * application, or globally for all programs using the @c elementary_config
3001 * utility. Applications can change the default theme using elm_theme_set(),
3002 * but this can go against the user wishes, so it's not an adviced practice.
3004 * Ideally, applications should find everything they need in the already
3005 * provided theme, but there may be occasions when that's not enough and
3006 * custom styles are required to correctly express the idea. For this
3007 * cases, Elementary has extensions.
3009 * Extensions allow the application developer to write styles of its own
3010 * to apply to some widgets. This requires knowledge of how each widget
3011 * is themed, as extensions will always replace the entire group used by
3012 * the widget, so important signals and parts need to be there for the
3013 * object to behave properly (see documentation of Edje for details).
3014 * Once the theme for the extension is done, the application needs to add
3015 * it to the list of themes Elementary will look into, using
3016 * elm_theme_extension_add(), and set the style of the desired widgets as
3017 * he would normally with elm_object_style_set().
3019 * Overlays, on the other hand, can replace the look of all widgets by
3020 * overriding the default style. Like extensions, it's up to the application
3021 * developer to write the theme for the widgets it wants, the difference
3022 * being that when looking for the theme, Elementary will check first the
3023 * list of overlays, then the set theme and lastly the list of extensions,
3024 * so with overlays it's possible to replace the default view and every
3025 * widget will be affected. This is very much alike to setting the whole
3026 * theme for the application and will probably clash with the end user
3027 * options, not to mention the risk of ending up with not matching styles
3028 * across the program. Unless there's a very special reason to use them,
3029 * overlays should be avoided for the resons exposed before.
3031 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3032 * keeps one default internally and every function that receives one of
3033 * these can be called with NULL to refer to this default (except for
3034 * elm_theme_free()). It's possible to create a new instance of a
3035 * ::Elm_Theme to set other theme for a specific widget (and all of its
3036 * children), but this is as discouraged, if not even more so, than using
3037 * overlays. Don't use this unless you really know what you are doing.
3039 * But to be less negative about things, you can look at the following
3041 * @li @ref theme_example_01 "Using extensions"
3042 * @li @ref theme_example_02 "Using overlays"
3047 * @typedef Elm_Theme
3049 * Opaque handler for the list of themes Elementary looks for when
3050 * rendering widgets.
3052 * Stay out of this unless you really know what you are doing. For most
3053 * cases, sticking to the default is all a developer needs.
3055 typedef struct _Elm_Theme Elm_Theme;
3058 * Create a new specific theme
3060 * This creates an empty specific theme that only uses the default theme. A
3061 * specific theme has its own private set of extensions and overlays too
3062 * (which are empty by default). Specific themes do not fall back to themes
3063 * of parent objects. They are not intended for this use. Use styles, overlays
3064 * and extensions when needed, but avoid specific themes unless there is no
3065 * other way (example: you want to have a preview of a new theme you are
3066 * selecting in a "theme selector" window. The preview is inside a scroller
3067 * and should display what the theme you selected will look like, but not
3068 * actually apply it yet. The child of the scroller will have a specific
3069 * theme set to show this preview before the user decides to apply it to all
3072 EAPI Elm_Theme *elm_theme_new(void);
3074 * Free a specific theme
3076 * @param th The theme to free
3078 * This frees a theme created with elm_theme_new().
3080 EAPI void elm_theme_free(Elm_Theme *th);
3082 * Copy the theme fom the source to the destination theme
3084 * @param th The source theme to copy from
3085 * @param thdst The destination theme to copy data to
3087 * This makes a one-time static copy of all the theme config, extensions
3088 * and overlays from @p th to @p thdst. If @p th references a theme, then
3089 * @p thdst is also set to reference it, with all the theme settings,
3090 * overlays and extensions that @p th had.
3092 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3094 * Tell the source theme to reference the ref theme
3096 * @param th The theme that will do the referencing
3097 * @param thref The theme that is the reference source
3099 * This clears @p th to be empty and then sets it to refer to @p thref
3100 * so @p th acts as an override to @p thref, but where its overrides
3101 * don't apply, it will fall through to @p thref for configuration.
3103 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3105 * Return the theme referred to
3107 * @param th The theme to get the reference from
3108 * @return The referenced theme handle
3110 * This gets the theme set as the reference theme by elm_theme_ref_set().
3111 * If no theme is set as a reference, NULL is returned.
3113 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3115 * Return the default theme
3117 * @return The default theme handle
3119 * This returns the internal default theme setup handle that all widgets
3120 * use implicitly unless a specific theme is set. This is also often use
3121 * as a shorthand of NULL.
3123 EAPI Elm_Theme *elm_theme_default_get(void);
3125 * Prepends a theme overlay to the list of overlays
3127 * @param th The theme to add to, or if NULL, the default theme
3128 * @param item The Edje file path to be used
3130 * Use this if your application needs to provide some custom overlay theme
3131 * (An Edje file that replaces some default styles of widgets) where adding
3132 * new styles, or changing system theme configuration is not possible. Do
3133 * NOT use this instead of a proper system theme configuration. Use proper
3134 * configuration files, profiles, environment variables etc. to set a theme
3135 * so that the theme can be altered by simple confiugration by a user. Using
3136 * this call to achieve that effect is abusing the API and will create lots
3139 * @see elm_theme_extension_add()
3141 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3143 * Delete a theme overlay from the list of overlays
3145 * @param th The theme to delete from, or if NULL, the default theme
3146 * @param item The name of the theme overlay
3148 * @see elm_theme_overlay_add()
3150 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3152 * Appends a theme extension to the list of extensions.
3154 * @param th The theme to add to, or if NULL, the default theme
3155 * @param item The Edje file path to be used
3157 * This is intended when an application needs more styles of widgets or new
3158 * widget themes that the default does not provide (or may not provide). The
3159 * application has "extended" usage by coming up with new custom style names
3160 * for widgets for specific uses, but as these are not "standard", they are
3161 * not guaranteed to be provided by a default theme. This means the
3162 * application is required to provide these extra elements itself in specific
3163 * Edje files. This call adds one of those Edje files to the theme search
3164 * path to be search after the default theme. The use of this call is
3165 * encouraged when default styles do not meet the needs of the application.
3166 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3168 * @see elm_object_style_set()
3170 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3172 * Deletes a theme extension from the list of extensions.
3174 * @param th The theme to delete from, or if NULL, the default theme
3175 * @param item The name of the theme extension
3177 * @see elm_theme_extension_add()
3179 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3181 * Set the theme search order for the given theme
3183 * @param th The theme to set the search order, or if NULL, the default theme
3184 * @param theme Theme search string
3186 * This sets the search string for the theme in path-notation from first
3187 * theme to search, to last, delimited by the : character. Example:
3189 * "shiny:/path/to/file.edj:default"
3191 * See the ELM_THEME environment variable for more information.
3193 * @see elm_theme_get()
3194 * @see elm_theme_list_get()
3196 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3198 * Return the theme search order
3200 * @param th The theme to get the search order, or if NULL, the default theme
3201 * @return The internal search order path
3203 * This function returns a colon separated string of theme elements as
3204 * returned by elm_theme_list_get().
3206 * @see elm_theme_set()
3207 * @see elm_theme_list_get()
3209 EAPI const char *elm_theme_get(Elm_Theme *th);
3211 * Return a list of theme elements to be used in a theme.
3213 * @param th Theme to get the list of theme elements from.
3214 * @return The internal list of theme elements
3216 * This returns the internal list of theme elements (will only be valid as
3217 * long as the theme is not modified by elm_theme_set() or theme is not
3218 * freed by elm_theme_free(). This is a list of strings which must not be
3219 * altered as they are also internal. If @p th is NULL, then the default
3220 * theme element list is returned.
3222 * A theme element can consist of a full or relative path to a .edj file,
3223 * or a name, without extension, for a theme to be searched in the known
3224 * theme paths for Elemementary.
3226 * @see elm_theme_set()
3227 * @see elm_theme_get()
3229 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3231 * Return the full patrh for a theme element
3233 * @param f The theme element name
3234 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3235 * @return The full path to the file found.
3237 * This returns a string you should free with free() on success, NULL on
3238 * failure. This will search for the given theme element, and if it is a
3239 * full or relative path element or a simple searchable name. The returned
3240 * path is the full path to the file, if searched, and the file exists, or it
3241 * is simply the full path given in the element or a resolved path if
3242 * relative to home. The @p in_search_path boolean pointed to is set to
3243 * EINA_TRUE if the file was a searchable file andis in the search path,
3244 * and EINA_FALSE otherwise.
3246 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3248 * Flush the current theme.
3250 * @param th Theme to flush
3252 * This flushes caches that let elementary know where to find theme elements
3253 * in the given theme. If @p th is NULL, then the default theme is flushed.
3254 * Call this function if source theme data has changed in such a way as to
3255 * make any caches Elementary kept invalid.
3257 EAPI void elm_theme_flush(Elm_Theme *th);
3259 * This flushes all themes (default and specific ones).
3261 * This will flush all themes in the current application context, by calling
3262 * elm_theme_flush() on each of them.
3264 EAPI void elm_theme_full_flush(void);
3266 * Set the theme for all elementary using applications on the current display
3268 * @param theme The name of the theme to use. Format same as the ELM_THEME
3269 * environment variable.
3271 EAPI void elm_theme_all_set(const char *theme);
3273 * Return a list of theme elements in the theme search path
3275 * @return A list of strings that are the theme element names.
3277 * This lists all available theme files in the standard Elementary search path
3278 * for theme elements, and returns them in alphabetical order as theme
3279 * element names in a list of strings. Free this with
3280 * elm_theme_name_available_list_free() when you are done with the list.
3282 EAPI Eina_List *elm_theme_name_available_list_new(void);
3284 * Free the list returned by elm_theme_name_available_list_new()
3286 * This frees the list of themes returned by
3287 * elm_theme_name_available_list_new(). Once freed the list should no longer
3288 * be used. a new list mys be created.
3290 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3292 * Set a specific theme to be used for this object and its children
3294 * @param obj The object to set the theme on
3295 * @param th The theme to set
3297 * This sets a specific theme that will be used for the given object and any
3298 * child objects it has. If @p th is NULL then the theme to be used is
3299 * cleared and the object will inherit its theme from its parent (which
3300 * ultimately will use the default theme if no specific themes are set).
3302 * Use special themes with great care as this will annoy users and make
3303 * configuration difficult. Avoid any custom themes at all if it can be
3306 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3308 * Get the specific theme to be used
3310 * @param obj The object to get the specific theme from
3311 * @return The specifc theme set.
3313 * This will return a specific theme set, or NULL if no specific theme is
3314 * set on that object. It will not return inherited themes from parents, only
3315 * the specific theme set for that specific object. See elm_object_theme_set()
3316 * for more information.
3318 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3324 /** @defgroup Win Win
3326 * @image html img/widget/win/preview-00.png
3327 * @image latex img/widget/win/preview-00.eps
3329 * The window class of Elementary. Contains functions to manipulate
3330 * windows. The Evas engine used to render the window contents is specified
3331 * in the system or user elementary config files (whichever is found last),
3332 * and can be overridden with the ELM_ENGINE environment variable for
3333 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3334 * compilation setup and modules actually installed at runtime) are (listed
3335 * in order of best supported and most likely to be complete and work to
3338 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3339 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3341 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3343 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3345 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3347 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3348 * rendering using SDL as the buffer)
3349 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3350 * GDI with software)
3351 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3352 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3353 * grayscale using dedicated 8bit software engine in X11)
3354 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3355 * X11 using 16bit software engine)
3356 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3357 * (Windows CE rendering via GDI with 16bit software renderer)
3358 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3359 * buffer with 16bit software renderer)
3361 * All engines use a simple string to select the engine to render, EXCEPT
3362 * the "shot" engine. This actually encodes the output of the virtual
3363 * screenshot and how long to delay in the engine string. The engine string
3364 * is encoded in the following way:
3366 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3368 * Where options are separated by a ":" char if more than one option is
3369 * given, with delay, if provided being the first option and file the last
3370 * (order is important). The delay specifies how long to wait after the
3371 * window is shown before doing the virtual "in memory" rendering and then
3372 * save the output to the file specified by the file option (and then exit).
3373 * If no delay is given, the default is 0.5 seconds. If no file is given the
3374 * default output file is "out.png". Repeat option is for continous
3375 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3376 * fixed to "out001.png" Some examples of using the shot engine:
3378 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3379 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3380 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3381 * ELM_ENGINE="shot:delay=2.0" elementary_test
3382 * ELM_ENGINE="shot:" elementary_test
3384 * Signals that you can add callbacks for are:
3386 * @li "delete,request": the user requested to close the window. See
3387 * elm_win_autodel_set().
3388 * @li "focus,in": window got focus
3389 * @li "focus,out": window lost focus
3390 * @li "moved": window that holds the canvas was moved
3393 * @li @ref win_example_01
3398 * Defines the types of window that can be created
3400 * These are hints set on the window so that a running Window Manager knows
3401 * how the window should be handled and/or what kind of decorations it
3404 * Currently, only the X11 backed engines use them.
3406 typedef enum _Elm_Win_Type
3408 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3409 window. Almost every window will be created with this
3411 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3412 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3413 window holding desktop icons. */
3414 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3415 be kept on top of any other window by the Window
3417 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3419 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3420 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3422 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3423 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3424 entry in a menubar is clicked. Typically used
3425 with elm_win_override_set(). This hint exists
3426 for completion only, as the EFL way of
3427 implementing a menu would not normally use a
3428 separate window for its contents. */
3429 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3430 triggered by right-clicking an object. */
3431 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3432 explanatory text that typically appear after the
3433 mouse cursor hovers over an object for a while.
3434 Typically used with elm_win_override_set() and also
3435 not very commonly used in the EFL. */
3436 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3437 battery life or a new E-Mail received. */
3438 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3439 usually used in the EFL. */
3440 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3441 object being dragged across different windows, or even
3442 applications. Typically used with
3443 elm_win_override_set(). */
3444 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3445 buffer. No actual window is created for this
3446 type, instead the window and all of its
3447 contents will be rendered to an image buffer.
3448 This allows to have children window inside a
3449 parent one just like any other object would
3450 be, and do other things like applying @c
3451 Evas_Map effects to it. This is the only type
3452 of window that requires the @c parent
3453 parameter of elm_win_add() to be a valid @c
3458 * The differents layouts that can be requested for the virtual keyboard.
3460 * When the application window is being managed by Illume, it may request
3461 * any of the following layouts for the virtual keyboard.
3463 typedef enum _Elm_Win_Keyboard_Mode
3465 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3466 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3467 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3468 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3469 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3470 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3471 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3472 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3473 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3474 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3475 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3476 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3477 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3478 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3479 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3480 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3481 } Elm_Win_Keyboard_Mode;
3484 * Available commands that can be sent to the Illume manager.
3486 * When running under an Illume session, a window may send commands to the
3487 * Illume manager to perform different actions.
3489 typedef enum _Elm_Illume_Command
3491 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3493 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3495 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3497 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3498 } Elm_Illume_Command;
3501 * Adds a window object. If this is the first window created, pass NULL as
3504 * @param parent Parent object to add the window to, or NULL
3505 * @param name The name of the window
3506 * @param type The window type, one of #Elm_Win_Type.
3508 * The @p parent paramter can be @c NULL for every window @p type except
3509 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3510 * which the image object will be created.
3512 * @return The created object, or NULL on failure
3514 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3516 * Add @p subobj as a resize object of window @p obj.
3519 * Setting an object as a resize object of the window means that the
3520 * @p subobj child's size and position will be controlled by the window
3521 * directly. That is, the object will be resized to match the window size
3522 * and should never be moved or resized manually by the developer.
3524 * In addition, resize objects of the window control what the minimum size
3525 * of it will be, as well as whether it can or not be resized by the user.
3527 * For the end user to be able to resize a window by dragging the handles
3528 * or borders provided by the Window Manager, or using any other similar
3529 * mechanism, all of the resize objects in the window should have their
3530 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3532 * @param obj The window object
3533 * @param subobj The resize object to add
3535 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3537 * Delete @p subobj as a resize object of window @p obj.
3539 * This function removes the object @p subobj from the resize objects of
3540 * the window @p obj. It will not delete the object itself, which will be
3541 * left unmanaged and should be deleted by the developer, manually handled
3542 * or set as child of some other container.
3544 * @param obj The window object
3545 * @param subobj The resize object to add
3547 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3549 * Set the title of the window
3551 * @param obj The window object
3552 * @param title The title to set
3554 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3556 * Get the title of the window
3558 * The returned string is an internal one and should not be freed or
3559 * modified. It will also be rendered invalid if a new title is set or if
3560 * the window is destroyed.
3562 * @param obj The window object
3565 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3567 * Set the window's autodel state.
3569 * When closing the window in any way outside of the program control, like
3570 * pressing the X button in the titlebar or using a command from the
3571 * Window Manager, a "delete,request" signal is emitted to indicate that
3572 * this event occurred and the developer can take any action, which may
3573 * include, or not, destroying the window object.
3575 * When the @p autodel parameter is set, the window will be automatically
3576 * destroyed when this event occurs, after the signal is emitted.
3577 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3578 * and is up to the program to do so when it's required.
3580 * @param obj The window object
3581 * @param autodel If true, the window will automatically delete itself when
3584 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3586 * Get the window's autodel state.
3588 * @param obj The window object
3589 * @return If the window will automatically delete itself when closed
3591 * @see elm_win_autodel_set()
3593 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3595 * Activate a window object.
3597 * This function sends a request to the Window Manager to activate the
3598 * window pointed by @p obj. If honored by the WM, the window will receive
3599 * the keyboard focus.
3601 * @note This is just a request that a Window Manager may ignore, so calling
3602 * this function does not ensure in any way that the window will be the
3603 * active one after it.
3605 * @param obj The window object
3607 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3609 * Lower a window object.
3611 * Places the window pointed by @p obj at the bottom of the stack, so that
3612 * no other window is covered by it.
3614 * If elm_win_override_set() is not set, the Window Manager may ignore this
3617 * @param obj The window object
3619 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3621 * Raise a window object.
3623 * Places the window pointed by @p obj at the top of the stack, so that it's
3624 * not covered by any other window.
3626 * If elm_win_override_set() is not set, the Window Manager may ignore this
3629 * @param obj The window object
3631 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3633 * Set the borderless state of a window.
3635 * This function requests the Window Manager to not draw any decoration
3636 * around the window.
3638 * @param obj The window object
3639 * @param borderless If true, the window is borderless
3641 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3643 * Get the borderless state of a window.
3645 * @param obj The window object
3646 * @return If true, the window is borderless
3648 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3650 * Set the shaped state of a window.
3652 * Shaped windows, when supported, will render the parts of the window that
3653 * has no content, transparent.
3655 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3656 * background object or cover the entire window in any other way, or the
3657 * parts of the canvas that have no data will show framebuffer artifacts.
3659 * @param obj The window object
3660 * @param shaped If true, the window is shaped
3662 * @see elm_win_alpha_set()
3664 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3666 * Get the shaped state of a window.
3668 * @param obj The window object
3669 * @return If true, the window is shaped
3671 * @see elm_win_shaped_set()
3673 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3675 * Set the alpha channel state of a window.
3677 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3678 * possibly making parts of the window completely or partially transparent.
3679 * This is also subject to the underlying system supporting it, like for
3680 * example, running under a compositing manager. If no compositing is
3681 * available, enabling this option will instead fallback to using shaped
3682 * windows, with elm_win_shaped_set().
3684 * @param obj The window object
3685 * @param alpha If true, the window has an alpha channel
3687 * @see elm_win_alpha_set()
3689 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3691 * Get the transparency state of a window.
3693 * @param obj The window object
3694 * @return If true, the window is transparent
3696 * @see elm_win_transparent_set()
3698 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3700 * Set the transparency state of a window.
3702 * Use elm_win_alpha_set() instead.
3704 * @param obj The window object
3705 * @param transparent If true, the window is transparent
3707 * @see elm_win_alpha_set()
3709 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3711 * Get the alpha channel state of a window.
3713 * @param obj The window object
3714 * @return If true, the window has an alpha channel
3716 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3718 * Set the override state of a window.
3720 * A window with @p override set to EINA_TRUE will not be managed by the
3721 * Window Manager. This means that no decorations of any kind will be shown
3722 * for it, moving and resizing must be handled by the application, as well
3723 * as the window visibility.
3725 * This should not be used for normal windows, and even for not so normal
3726 * ones, it should only be used when there's a good reason and with a lot
3727 * of care. Mishandling override windows may result situations that
3728 * disrupt the normal workflow of the end user.
3730 * @param obj The window object
3731 * @param override If true, the window is overridden
3733 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3735 * Get the override state of a window.
3737 * @param obj The window object
3738 * @return If true, the window is overridden
3740 * @see elm_win_override_set()
3742 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3744 * Set the fullscreen state of a window.
3746 * @param obj The window object
3747 * @param fullscreen If true, the window is fullscreen
3749 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3751 * Get the fullscreen state of a window.
3753 * @param obj The window object
3754 * @return If true, the window is fullscreen
3756 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3758 * Set the maximized state of a window.
3760 * @param obj The window object
3761 * @param maximized If true, the window is maximized
3763 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3765 * Get the maximized state of a window.
3767 * @param obj The window object
3768 * @return If true, the window is maximized
3770 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3772 * Set the iconified state of a window.
3774 * @param obj The window object
3775 * @param iconified If true, the window is iconified
3777 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3779 * Get the iconified state of a window.
3781 * @param obj The window object
3782 * @return If true, the window is iconified
3784 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3786 * Set the layer of the window.
3788 * What this means exactly will depend on the underlying engine used.
3790 * In the case of X11 backed engines, the value in @p layer has the
3791 * following meanings:
3792 * @li < 3: The window will be placed below all others.
3793 * @li > 5: The window will be placed above all others.
3794 * @li other: The window will be placed in the default layer.
3796 * @param obj The window object
3797 * @param layer The layer of the window
3799 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3801 * Get the layer of the window.
3803 * @param obj The window object
3804 * @return The layer of the window
3806 * @see elm_win_layer_set()
3808 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3810 * Set the rotation of the window.
3812 * Most engines only work with multiples of 90.
3814 * This function is used to set the orientation of the window @p obj to
3815 * match that of the screen. The window itself will be resized to adjust
3816 * to the new geometry of its contents. If you want to keep the window size,
3817 * see elm_win_rotation_with_resize_set().
3819 * @param obj The window object
3820 * @param rotation The rotation of the window, in degrees (0-360),
3821 * counter-clockwise.
3823 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3825 * Rotates the window and resizes it.
3827 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3828 * that they fit inside the current window geometry.
3830 * @param obj The window object
3831 * @param layer The rotation of the window in degrees (0-360),
3832 * counter-clockwise.
3834 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3836 * Get the rotation of the window.
3838 * @param obj The window object
3839 * @return The rotation of the window in degrees (0-360)
3841 * @see elm_win_rotation_set()
3842 * @see elm_win_rotation_with_resize_set()
3844 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3846 * Set the sticky state of the window.
3848 * Hints the Window Manager that the window in @p obj should be left fixed
3849 * at its position even when the virtual desktop it's on moves or changes.
3851 * @param obj The window object
3852 * @param sticky If true, the window's sticky state is enabled
3854 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3856 * Get the sticky state of the window.
3858 * @param obj The window object
3859 * @return If true, the window's sticky state is enabled
3861 * @see elm_win_sticky_set()
3863 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3865 * Set if this window is an illume conformant window
3867 * @param obj The window object
3868 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3870 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3872 * Get if this window is an illume conformant window
3874 * @param obj The window object
3875 * @return A boolean if this window is illume conformant or not
3877 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3879 * Set a window to be an illume quickpanel window
3881 * By default window objects are not quickpanel windows.
3883 * @param obj The window object
3884 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3886 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3888 * Get if this window is a quickpanel or not
3890 * @param obj The window object
3891 * @return A boolean if this window is a quickpanel or not
3893 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3895 * Set the major priority of a quickpanel window
3897 * @param obj The window object
3898 * @param priority The major priority for this quickpanel
3900 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3902 * Get the major priority of a quickpanel window
3904 * @param obj The window object
3905 * @return The major priority of this quickpanel
3907 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3909 * Set the minor priority of a quickpanel window
3911 * @param obj The window object
3912 * @param priority The minor priority for this quickpanel
3914 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3916 * Get the minor priority of a quickpanel window
3918 * @param obj The window object
3919 * @return The minor priority of this quickpanel
3921 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3923 * Set which zone this quickpanel should appear in
3925 * @param obj The window object
3926 * @param zone The requested zone for this quickpanel
3928 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3930 * Get which zone this quickpanel should appear in
3932 * @param obj The window object
3933 * @return The requested zone for this quickpanel
3935 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3937 * Set the window to be skipped by keyboard focus
3939 * This sets the window to be skipped by normal keyboard input. This means
3940 * a window manager will be asked to not focus this window as well as omit
3941 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3943 * Call this and enable it on a window BEFORE you show it for the first time,
3944 * otherwise it may have no effect.
3946 * Use this for windows that have only output information or might only be
3947 * interacted with by the mouse or fingers, and never for typing input.
3948 * Be careful that this may have side-effects like making the window
3949 * non-accessible in some cases unless the window is specially handled. Use
3952 * @param obj The window object
3953 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3955 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3957 * Send a command to the windowing environment
3959 * This is intended to work in touchscreen or small screen device
3960 * environments where there is a more simplistic window management policy in
3961 * place. This uses the window object indicated to select which part of the
3962 * environment to control (the part that this window lives in), and provides
3963 * a command and an optional parameter structure (use NULL for this if not
3966 * @param obj The window object that lives in the environment to control
3967 * @param command The command to send
3968 * @param params Optional parameters for the command
3970 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3972 * Get the inlined image object handle
3974 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3975 * then the window is in fact an evas image object inlined in the parent
3976 * canvas. You can get this object (be careful to not manipulate it as it
3977 * is under control of elementary), and use it to do things like get pixel
3978 * data, save the image to a file, etc.
3980 * @param obj The window object to get the inlined image from
3981 * @return The inlined image object, or NULL if none exists
3983 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3985 * Set the enabled status for the focus highlight in a window
3987 * This function will enable or disable the focus highlight only for the
3988 * given window, regardless of the global setting for it
3990 * @param obj The window where to enable the highlight
3991 * @param enabled The enabled value for the highlight
3993 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3995 * Get the enabled value of the focus highlight for this window
3997 * @param obj The window in which to check if the focus highlight is enabled
3999 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4001 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4003 * Set the style for the focus highlight on this window
4005 * Sets the style to use for theming the highlight of focused objects on
4006 * the given window. If @p style is NULL, the default will be used.
4008 * @param obj The window where to set the style
4009 * @param style The style to set
4011 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4013 * Get the style set for the focus highlight object
4015 * Gets the style set for this windows highilght object, or NULL if none
4018 * @param obj The window to retrieve the highlights style from
4020 * @return The style set or NULL if none was. Default is used in that case.
4022 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4024 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4025 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4026 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4027 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4028 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4029 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4030 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4032 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4033 * (blank mouse, private mouse obj, defaultmouse)
4037 * Sets the keyboard mode of the window.
4039 * @param obj The window object
4040 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4042 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4044 * Gets the keyboard mode of the window.
4046 * @param obj The window object
4047 * @return The mode, one of #Elm_Win_Keyboard_Mode
4049 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4051 * Sets whether the window is a keyboard.
4053 * @param obj The window object
4054 * @param is_keyboard If true, the window is a virtual keyboard
4056 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4058 * Gets whether the window is a keyboard.
4060 * @param obj The window object
4061 * @return If the window is a virtual keyboard
4063 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4066 * Get the screen position of a window.
4068 * @param obj The window object
4069 * @param x The int to store the x coordinate to
4070 * @param y The int to store the y coordinate to
4072 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4078 * @defgroup Inwin Inwin
4080 * @image html img/widget/inwin/preview-00.png
4081 * @image latex img/widget/inwin/preview-00.eps
4082 * @image html img/widget/inwin/preview-01.png
4083 * @image latex img/widget/inwin/preview-01.eps
4084 * @image html img/widget/inwin/preview-02.png
4085 * @image latex img/widget/inwin/preview-02.eps
4087 * An inwin is a window inside a window that is useful for a quick popup.
4088 * It does not hover.
4090 * It works by creating an object that will occupy the entire window, so it
4091 * must be created using an @ref Win "elm_win" as parent only. The inwin
4092 * object can be hidden or restacked below every other object if it's
4093 * needed to show what's behind it without destroying it. If this is done,
4094 * the elm_win_inwin_activate() function can be used to bring it back to
4095 * full visibility again.
4097 * There are three styles available in the default theme. These are:
4098 * @li default: The inwin is sized to take over most of the window it's
4100 * @li minimal: The size of the inwin will be the minimum necessary to show
4102 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4103 * possible, but it's sized vertically the most it needs to fit its\
4106 * Some examples of Inwin can be found in the following:
4107 * @li @ref inwin_example_01
4112 * Adds an inwin to the current window
4114 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4115 * Never call this function with anything other than the top-most window
4116 * as its parameter, unless you are fond of undefined behavior.
4118 * After creating the object, the widget will set itself as resize object
4119 * for the window with elm_win_resize_object_add(), so when shown it will
4120 * appear to cover almost the entire window (how much of it depends on its
4121 * content and the style used). It must not be added into other container
4122 * objects and it needs not be moved or resized manually.
4124 * @param parent The parent object
4125 * @return The new object or NULL if it cannot be created
4127 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4129 * Activates an inwin object, ensuring its visibility
4131 * This function will make sure that the inwin @p obj is completely visible
4132 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4133 * to the front. It also sets the keyboard focus to it, which will be passed
4136 * The object's theme will also receive the signal "elm,action,show" with
4139 * @param obj The inwin to activate
4141 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4143 * Set the content of an inwin object.
4145 * Once the content object is set, a previously set one will be deleted.
4146 * If you want to keep that old content object, use the
4147 * elm_win_inwin_content_unset() function.
4149 * @param obj The inwin object
4150 * @param content The object to set as content
4152 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4154 * Get the content of an inwin object.
4156 * Return the content object which is set for this widget.
4158 * The returned object is valid as long as the inwin is still alive and no
4159 * other content is set on it. Deleting the object will notify the inwin
4160 * about it and this one will be left empty.
4162 * If you need to remove an inwin's content to be reused somewhere else,
4163 * see elm_win_inwin_content_unset().
4165 * @param obj The inwin object
4166 * @return The content that is being used
4168 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4170 * Unset the content of an inwin object.
4172 * Unparent and return the content object which was set for this widget.
4174 * @param obj The inwin object
4175 * @return The content that was being used
4177 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4181 /* X specific calls - won't work on non-x engines (return 0) */
4184 * Get the Ecore_X_Window of an Evas_Object
4186 * @param obj The object
4188 * @return The Ecore_X_Window of @p obj
4192 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4194 /* smart callbacks called:
4195 * "delete,request" - the user requested to delete the window
4196 * "focus,in" - window got focus
4197 * "focus,out" - window lost focus
4198 * "moved" - window that holds the canvas was moved
4204 * @image html img/widget/bg/preview-00.png
4205 * @image latex img/widget/bg/preview-00.eps
4207 * @brief Background object, used for setting a solid color, image or Edje
4208 * group as background to a window or any container object.
4210 * The bg object is used for setting a solid background to a window or
4211 * packing into any container object. It works just like an image, but has
4212 * some properties useful to a background, like setting it to tiled,
4213 * centered, scaled or stretched.
4215 * Here is some sample code using it:
4216 * @li @ref bg_01_example_page
4217 * @li @ref bg_02_example_page
4218 * @li @ref bg_03_example_page
4222 typedef enum _Elm_Bg_Option
4224 ELM_BG_OPTION_CENTER, /**< center the background */
4225 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4226 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4227 ELM_BG_OPTION_TILE /**< tile background at its original size */
4231 * Add a new background to the parent
4233 * @param parent The parent object
4234 * @return The new object or NULL if it cannot be created
4238 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4241 * Set the file (image or edje) used for the background
4243 * @param obj The bg object
4244 * @param file The file path
4245 * @param group Optional key (group in Edje) within the file
4247 * This sets the image file used in the background object. The image (or edje)
4248 * will be stretched (retaining aspect if its an image file) to completely fill
4249 * the bg object. This may mean some parts are not visible.
4251 * @note Once the image of @p obj is set, a previously set one will be deleted,
4252 * even if @p file is NULL.
4256 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4259 * Get the file (image or edje) used for the background
4261 * @param obj The bg object
4262 * @param file The file path
4263 * @param group Optional key (group in Edje) within the file
4267 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4270 * Set the option used for the background image
4272 * @param obj The bg object
4273 * @param option The desired background option (TILE, SCALE)
4275 * This sets the option used for manipulating the display of the background
4276 * image. The image can be tiled or scaled.
4280 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4283 * Get the option used for the background image
4285 * @param obj The bg object
4286 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4290 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4292 * Set the option used for the background color
4294 * @param obj The bg object
4299 * This sets the color used for the background rectangle. Its range goes
4304 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4306 * Get the option used for the background color
4308 * @param obj The bg object
4315 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4318 * Set the overlay object used for the background object.
4320 * @param obj The bg object
4321 * @param overlay The overlay object
4323 * This provides a way for elm_bg to have an 'overlay' that will be on top
4324 * of the bg. Once the over object is set, a previously set one will be
4325 * deleted, even if you set the new one to NULL. If you want to keep that
4326 * old content object, use the elm_bg_overlay_unset() function.
4331 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4334 * Get the overlay object used for the background object.
4336 * @param obj The bg object
4337 * @return The content that is being used
4339 * Return the content object which is set for this widget
4343 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4346 * Get the overlay object used for the background object.
4348 * @param obj The bg object
4349 * @return The content that was being used
4351 * Unparent and return the overlay object which was set for this widget
4355 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4358 * Set the size of the pixmap representation of the image.
4360 * This option just makes sense if an image is going to be set in the bg.
4362 * @param obj The bg object
4363 * @param w The new width of the image pixmap representation.
4364 * @param h The new height of the image pixmap representation.
4366 * This function sets a new size for pixmap representation of the given bg
4367 * image. It allows the image to be loaded already in the specified size,
4368 * reducing the memory usage and load time when loading a big image with load
4369 * size set to a smaller size.
4371 * NOTE: this is just a hint, the real size of the pixmap may differ
4372 * depending on the type of image being loaded, being bigger than requested.
4376 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4377 /* smart callbacks called:
4381 * @defgroup Icon Icon
4383 * @image html img/widget/icon/preview-00.png
4384 * @image latex img/widget/icon/preview-00.eps
4386 * An object that provides standard icon images (delete, edit, arrows, etc.)
4387 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4389 * The icon image requested can be in the elementary theme, or in the
4390 * freedesktop.org paths. It's possible to set the order of preference from
4391 * where the image will be used.
4393 * This API is very similar to @ref Image, but with ready to use images.
4395 * Default images provided by the theme are described below.
4397 * The first list contains icons that were first intended to be used in
4398 * toolbars, but can be used in many other places too:
4414 * Now some icons that were designed to be used in menus (but again, you can
4415 * use them anywhere else):
4420 * @li menu/arrow_down
4421 * @li menu/arrow_left
4422 * @li menu/arrow_right
4431 * And here we have some media player specific icons:
4432 * @li media_player/forward
4433 * @li media_player/info
4434 * @li media_player/next
4435 * @li media_player/pause
4436 * @li media_player/play
4437 * @li media_player/prev
4438 * @li media_player/rewind
4439 * @li media_player/stop
4441 * Signals that you can add callbacks for are:
4443 * "clicked" - This is called when a user has clicked the icon
4445 * An example of usage for this API follows:
4446 * @li @ref tutorial_icon
4454 typedef enum _Elm_Icon_Type
4461 * @enum _Elm_Icon_Lookup_Order
4462 * @typedef Elm_Icon_Lookup_Order
4464 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4465 * theme, FDO paths, or both?
4469 typedef enum _Elm_Icon_Lookup_Order
4471 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4472 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4473 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4474 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4475 } Elm_Icon_Lookup_Order;
4478 * Add a new icon object to the parent.
4480 * @param parent The parent object
4481 * @return The new object or NULL if it cannot be created
4483 * @see elm_icon_file_set()
4487 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4489 * Set the file that will be used as icon.
4491 * @param obj The icon object
4492 * @param file The path to file that will be used as icon image
4493 * @param group The group that the icon belongs to in edje file
4495 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4497 * @note The icon image set by this function can be changed by
4498 * elm_icon_standard_set().
4500 * @see elm_icon_file_get()
4504 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4506 * Set a location in memory to be used as an icon
4508 * @param obj The icon object
4509 * @param img The binary data that will be used as an image
4510 * @param size The size of binary data @p img
4511 * @param format Optional format of @p img to pass to the image loader
4512 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4514 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4516 * @note The icon image set by this function can be changed by
4517 * elm_icon_standard_set().
4521 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);
4523 * Get the file that will be used as icon.
4525 * @param obj The icon object
4526 * @param file The path to file that will be used as icon icon image
4527 * @param group The group that the icon belongs to in edje file
4529 * @see elm_icon_file_set()
4533 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4534 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4536 * Set the icon by icon standards names.
4538 * @param obj The icon object
4539 * @param name The icon name
4541 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4543 * For example, freedesktop.org defines standard icon names such as "home",
4544 * "network", etc. There can be different icon sets to match those icon
4545 * keys. The @p name given as parameter is one of these "keys", and will be
4546 * used to look in the freedesktop.org paths and elementary theme. One can
4547 * change the lookup order with elm_icon_order_lookup_set().
4549 * If name is not found in any of the expected locations and it is the
4550 * absolute path of an image file, this image will be used.
4552 * @note The icon image set by this function can be changed by
4553 * elm_icon_file_set().
4555 * @see elm_icon_standard_get()
4556 * @see elm_icon_file_set()
4560 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4562 * Get the icon name set by icon standard names.
4564 * @param obj The icon object
4565 * @return The icon name
4567 * If the icon image was set using elm_icon_file_set() instead of
4568 * elm_icon_standard_set(), then this function will return @c NULL.
4570 * @see elm_icon_standard_set()
4574 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4576 * Set the smooth effect for an icon object.
4578 * @param obj The icon object
4579 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4580 * otherwise. Default is @c EINA_TRUE.
4582 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4583 * scaling provides a better resulting image, but is slower.
4585 * The smooth scaling should be disabled when making animations that change
4586 * the icon size, since they will be faster. Animations that don't require
4587 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4588 * is already scaled, since the scaled icon image will be cached).
4590 * @see elm_icon_smooth_get()
4594 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4596 * Get the smooth effect for an icon object.
4598 * @param obj The icon object
4599 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4601 * @see elm_icon_smooth_set()
4605 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4607 * Disable scaling of this object.
4609 * @param obj The icon object.
4610 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4611 * otherwise. Default is @c EINA_FALSE.
4613 * This function disables scaling of the icon object through the function
4614 * elm_object_scale_set(). However, this does not affect the object
4615 * size/resize in any way. For that effect, take a look at
4616 * elm_icon_scale_set().
4618 * @see elm_icon_no_scale_get()
4619 * @see elm_icon_scale_set()
4620 * @see elm_object_scale_set()
4624 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4626 * Get whether scaling is disabled on the object.
4628 * @param obj The icon object
4629 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4631 * @see elm_icon_no_scale_set()
4635 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4637 * Set if the object is (up/down) resizable.
4639 * @param obj The icon object
4640 * @param scale_up A bool to set if the object is resizable up. Default is
4642 * @param scale_down A bool to set if the object is resizable down. Default
4645 * This function limits the icon object resize ability. If @p scale_up is set to
4646 * @c EINA_FALSE, the object can't have its height or width resized to a value
4647 * higher than the original icon size. Same is valid for @p scale_down.
4649 * @see elm_icon_scale_get()
4653 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4655 * Get if the object is (up/down) resizable.
4657 * @param obj The icon object
4658 * @param scale_up A bool to set if the object is resizable up
4659 * @param scale_down A bool to set if the object is resizable down
4661 * @see elm_icon_scale_set()
4665 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4667 * Get the object's image size
4669 * @param obj The icon object
4670 * @param w A pointer to store the width in
4671 * @param h A pointer to store the height in
4675 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4677 * Set if the icon fill the entire object area.
4679 * @param obj The icon object
4680 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4681 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4683 * When the icon object is resized to a different aspect ratio from the
4684 * original icon image, the icon image will still keep its aspect. This flag
4685 * tells how the image should fill the object's area. They are: keep the
4686 * entire icon inside the limits of height and width of the object (@p
4687 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4688 * of the object, and the icon will fill the entire object (@p fill_outside
4691 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4692 * retain property to false. Thus, the icon image will always keep its
4693 * original aspect ratio.
4695 * @see elm_icon_fill_outside_get()
4696 * @see elm_image_fill_outside_set()
4700 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4702 * Get if the object is filled outside.
4704 * @param obj The icon object
4705 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4707 * @see elm_icon_fill_outside_set()
4711 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4713 * Set the prescale size for the icon.
4715 * @param obj The icon object
4716 * @param size The prescale size. This value is used for both width and
4719 * This function sets a new size for pixmap representation of the given
4720 * icon. It allows the icon to be loaded already in the specified size,
4721 * reducing the memory usage and load time when loading a big icon with load
4722 * size set to a smaller size.
4724 * It's equivalent to the elm_bg_load_size_set() function for bg.
4726 * @note this is just a hint, the real size of the pixmap may differ
4727 * depending on the type of icon being loaded, being bigger than requested.
4729 * @see elm_icon_prescale_get()
4730 * @see elm_bg_load_size_set()
4734 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4736 * Get the prescale size for the icon.
4738 * @param obj The icon object
4739 * @return The prescale size
4741 * @see elm_icon_prescale_set()
4745 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4747 * Sets the icon lookup order used by elm_icon_standard_set().
4749 * @param obj The icon object
4750 * @param order The icon lookup order (can be one of
4751 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4752 * or ELM_ICON_LOOKUP_THEME)
4754 * @see elm_icon_order_lookup_get()
4755 * @see Elm_Icon_Lookup_Order
4759 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4761 * Gets the icon lookup order.
4763 * @param obj The icon object
4764 * @return The icon lookup order
4766 * @see elm_icon_order_lookup_set()
4767 * @see Elm_Icon_Lookup_Order
4771 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4773 * Get if the icon supports animation or not.
4775 * @param obj The icon object
4776 * @return @c EINA_TRUE if the icon supports animation,
4777 * @c EINA_FALSE otherwise.
4779 * Return if this elm icon's image can be animated. Currently Evas only
4780 * supports gif animation. If the return value is EINA_FALSE, other
4781 * elm_icon_animated_XXX APIs won't work.
4784 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4786 * Set animation mode of the icon.
4788 * @param obj The icon object
4789 * @param anim @c EINA_TRUE if the object do animation job,
4790 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4792 * Even though elm icon's file can be animated,
4793 * sometimes appication developer want to just first page of image.
4794 * In that time, don't call this function, because default value is EINA_FALSE
4795 * Only when you want icon support anition,
4796 * use this function and set animated to EINA_TURE
4799 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4801 * Get animation mode of the icon.
4803 * @param obj The icon object
4804 * @return The animation mode of the icon object
4805 * @see elm_icon_animated_set
4808 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4810 * Set animation play mode of the icon.
4812 * @param obj The icon object
4813 * @param play @c EINA_TRUE the object play animation images,
4814 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4816 * If you want to play elm icon's animation, you set play to EINA_TURE.
4817 * For example, you make gif player using this set/get API and click event.
4819 * 1. Click event occurs
4820 * 2. Check play flag using elm_icon_animaged_play_get
4821 * 3. If elm icon was playing, set play to EINA_FALSE.
4822 * Then animation will be stopped and vice versa
4825 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4827 * Get animation play mode of the icon.
4829 * @param obj The icon object
4830 * @return The play mode of the icon object
4832 * @see elm_icon_animated_lay_get
4835 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4842 * @defgroup Image Image
4844 * @image html img/widget/image/preview-00.png
4845 * @image latex img/widget/image/preview-00.eps
4848 * An object that allows one to load an image file to it. It can be used
4849 * anywhere like any other elementary widget.
4851 * This widget provides most of the functionality provided from @ref Bg or @ref
4852 * Icon, but with a slightly different API (use the one that fits better your
4855 * The features not provided by those two other image widgets are:
4856 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4857 * @li change the object orientation with elm_image_orient_set();
4858 * @li and turning the image editable with elm_image_editable_set().
4860 * Signals that you can add callbacks for are:
4862 * @li @c "clicked" - This is called when a user has clicked the image
4864 * An example of usage for this API follows:
4865 * @li @ref tutorial_image
4874 * @enum _Elm_Image_Orient
4875 * @typedef Elm_Image_Orient
4877 * Possible orientation options for elm_image_orient_set().
4879 * @image html elm_image_orient_set.png
4880 * @image latex elm_image_orient_set.eps width=\textwidth
4884 typedef enum _Elm_Image_Orient
4886 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4887 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4888 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4889 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4890 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4891 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4892 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4893 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4897 * Add a new image to the parent.
4899 * @param parent The parent object
4900 * @return The new object or NULL if it cannot be created
4902 * @see elm_image_file_set()
4906 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4908 * Set the file that will be used as image.
4910 * @param obj The image object
4911 * @param file The path to file that will be used as image
4912 * @param group The group that the image belongs in edje file (if it's an
4915 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4917 * @see elm_image_file_get()
4921 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4923 * Get the file that will be used as image.
4925 * @param obj The image object
4926 * @param file The path to file
4927 * @param group The group that the image belongs in edje file
4929 * @see elm_image_file_set()
4933 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4935 * Set the smooth effect for an image.
4937 * @param obj The image object
4938 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4939 * otherwise. Default is @c EINA_TRUE.
4941 * Set the scaling algorithm to be used when scaling the image. Smooth
4942 * scaling provides a better resulting image, but is slower.
4944 * The smooth scaling should be disabled when making animations that change
4945 * the image size, since it will be faster. Animations that don't require
4946 * resizing of the image can keep the smooth scaling enabled (even if the
4947 * image is already scaled, since the scaled image will be cached).
4949 * @see elm_image_smooth_get()
4953 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4955 * Get the smooth effect for an image.
4957 * @param obj The image object
4958 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4960 * @see elm_image_smooth_get()
4964 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4966 * Gets the current size of the image.
4968 * @param obj The image object.
4969 * @param w Pointer to store width, or NULL.
4970 * @param h Pointer to store height, or NULL.
4972 * This is the real size of the image, not the size of the object.
4974 * On error, neither w or h will be written.
4978 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4980 * Disable scaling of this object.
4982 * @param obj The image object.
4983 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4984 * otherwise. Default is @c EINA_FALSE.
4986 * This function disables scaling of the elm_image widget through the
4987 * function elm_object_scale_set(). However, this does not affect the widget
4988 * size/resize in any way. For that effect, take a look at
4989 * elm_image_scale_set().
4991 * @see elm_image_no_scale_get()
4992 * @see elm_image_scale_set()
4993 * @see elm_object_scale_set()
4997 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4999 * Get whether scaling is disabled on the object.
5001 * @param obj The image object
5002 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5004 * @see elm_image_no_scale_set()
5008 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5010 * Set if the object is (up/down) resizable.
5012 * @param obj The image object
5013 * @param scale_up A bool to set if the object is resizable up. Default is
5015 * @param scale_down A bool to set if the object is resizable down. Default
5018 * This function limits the image resize ability. If @p scale_up is set to
5019 * @c EINA_FALSE, the object can't have its height or width resized to a value
5020 * higher than the original image size. Same is valid for @p scale_down.
5022 * @see elm_image_scale_get()
5026 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5028 * Get if the object is (up/down) resizable.
5030 * @param obj The image object
5031 * @param scale_up A bool to set if the object is resizable up
5032 * @param scale_down A bool to set if the object is resizable down
5034 * @see elm_image_scale_set()
5038 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5040 * Set if the image fill the entire object area when keeping the aspect ratio.
5042 * @param obj The image object
5043 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5044 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5046 * When the image should keep its aspect ratio even if resized to another
5047 * aspect ratio, there are two possibilities to resize it: keep the entire
5048 * image inside the limits of height and width of the object (@p fill_outside
5049 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5050 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5052 * @note This option will have no effect if
5053 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5055 * @see elm_image_fill_outside_get()
5056 * @see elm_image_aspect_ratio_retained_set()
5060 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5062 * Get if the object is filled outside
5064 * @param obj The image object
5065 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5067 * @see elm_image_fill_outside_set()
5071 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5073 * Set the prescale size for the image
5075 * @param obj The image object
5076 * @param size The prescale size. This value is used for both width and
5079 * This function sets a new size for pixmap representation of the given
5080 * image. It allows the image to be loaded already in the specified size,
5081 * reducing the memory usage and load time when loading a big image with load
5082 * size set to a smaller size.
5084 * It's equivalent to the elm_bg_load_size_set() function for bg.
5086 * @note this is just a hint, the real size of the pixmap may differ
5087 * depending on the type of image being loaded, being bigger than requested.
5089 * @see elm_image_prescale_get()
5090 * @see elm_bg_load_size_set()
5094 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5096 * Get the prescale size for the image
5098 * @param obj The image object
5099 * @return The prescale size
5101 * @see elm_image_prescale_set()
5105 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5107 * Set the image orientation.
5109 * @param obj The image object
5110 * @param orient The image orientation
5111 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5112 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5113 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5114 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5115 * Default is #ELM_IMAGE_ORIENT_NONE.
5117 * This function allows to rotate or flip the given image.
5119 * @see elm_image_orient_get()
5120 * @see @ref Elm_Image_Orient
5124 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5126 * Get the image orientation.
5128 * @param obj The image object
5129 * @return The image orientation
5130 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5131 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5132 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5133 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5135 * @see elm_image_orient_set()
5136 * @see @ref Elm_Image_Orient
5140 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5142 * Make the image 'editable'.
5144 * @param obj Image object.
5145 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5147 * This means the image is a valid drag target for drag and drop, and can be
5148 * cut or pasted too.
5152 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5154 * Make the image 'editable'.
5156 * @param obj Image object.
5157 * @return Editability.
5159 * This means the image is a valid drag target for drag and drop, and can be
5160 * cut or pasted too.
5164 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5166 * Get the basic Evas_Image object from this object (widget).
5168 * @param obj The image object to get the inlined image from
5169 * @return The inlined image object, or NULL if none exists
5171 * This function allows one to get the underlying @c Evas_Object of type
5172 * Image from this elementary widget. It can be useful to do things like get
5173 * the pixel data, save the image to a file, etc.
5175 * @note Be careful to not manipulate it, as it is under control of
5180 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5182 * Set whether the original aspect ratio of the image should be kept on resize.
5184 * @param obj The image object.
5185 * @param retained @c EINA_TRUE if the image should retain the aspect,
5186 * @c EINA_FALSE otherwise.
5188 * The original aspect ratio (width / height) of the image is usually
5189 * distorted to match the object's size. Enabling this option will retain
5190 * this original aspect, and the way that the image is fit into the object's
5191 * area depends on the option set by elm_image_fill_outside_set().
5193 * @see elm_image_aspect_ratio_retained_get()
5194 * @see elm_image_fill_outside_set()
5198 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5200 * Get if the object retains the original aspect ratio.
5202 * @param obj The image object.
5203 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5208 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5210 /* smart callbacks called:
5211 * "clicked" - the user clicked the image
5219 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5221 typedef enum _Elm_GLView_Mode
5223 ELM_GLVIEW_ALPHA = 1,
5224 ELM_GLVIEW_DEPTH = 2,
5225 ELM_GLVIEW_STENCIL = 4
5229 * Defines a policy for the glview resizing.
5231 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5233 typedef enum _Elm_GLView_Resize_Policy
5235 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5236 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5237 } Elm_GLView_Resize_Policy;
5239 typedef enum _Elm_GLView_Render_Policy
5241 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5242 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5243 } Elm_GLView_Render_Policy;
5248 * A simple GLView widget that allows GL rendering.
5250 * Signals that you can add callbacks for are:
5256 * Add a new glview to the parent
5258 * @param parent The parent object
5259 * @return The new object or NULL if it cannot be created
5263 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5266 * Sets the size of the glview
5268 * @param obj The glview object
5269 * @param width width of the glview object
5270 * @param height height of the glview object
5274 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5277 * Gets the size of the glview.
5279 * @param obj The glview object
5280 * @param width width of the glview object
5281 * @param height height of the glview object
5283 * Note that this function returns the actual image size of the
5284 * glview. This means that when the scale policy is set to
5285 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5290 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5293 * Gets the gl api struct for gl rendering
5295 * @param obj The glview object
5296 * @return The api object or NULL if it cannot be created
5300 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5303 * Set the mode of the GLView. Supports Three simple modes.
5305 * @param obj The glview object
5306 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5307 * @return True if set properly.
5311 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5314 * Set the resize policy for the glview object.
5316 * @param obj The glview object.
5317 * @param policy The scaling policy.
5319 * By default, the resize policy is set to
5320 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5321 * destroys the previous surface and recreates the newly specified
5322 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5323 * however, glview only scales the image object and not the underlying
5328 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5331 * Set the render policy for the glview object.
5333 * @param obj The glview object.
5334 * @param policy The render policy.
5336 * By default, the render policy is set to
5337 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5338 * that during the render loop, glview is only redrawn if it needs
5339 * to be redrawn. (i.e. When it is visible) If the policy is set to
5340 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5341 * whether it is visible/need redrawing or not.
5345 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5348 * Set the init function that runs once in the main loop.
5350 * @param obj The glview object.
5351 * @param func The init function to be registered.
5353 * The registered init function gets called once during the render loop.
5357 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5360 * Set the render function that runs in the main loop.
5362 * @param obj The glview object.
5363 * @param func The delete function to be registered.
5365 * The registered del function gets called when GLView object is deleted.
5369 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5372 * Set the resize function that gets called when resize happens.
5374 * @param obj The glview object.
5375 * @param func The resize function to be registered.
5379 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5382 * Set the render function that runs in the main loop.
5384 * @param obj The glview object.
5385 * @param func The render function to be registered.
5389 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5392 * Notifies that there has been changes in the GLView.
5394 * @param obj The glview object.
5398 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5408 * @image html img/widget/box/preview-00.png
5409 * @image latex img/widget/box/preview-00.eps width=\textwidth
5411 * @image html img/box.png
5412 * @image latex img/box.eps width=\textwidth
5414 * A box arranges objects in a linear fashion, governed by a layout function
5415 * that defines the details of this arrangement.
5417 * By default, the box will use an internal function to set the layout to
5418 * a single row, either vertical or horizontal. This layout is affected
5419 * by a number of parameters, such as the homogeneous flag set by
5420 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5421 * elm_box_align_set() and the hints set to each object in the box.
5423 * For this default layout, it's possible to change the orientation with
5424 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5425 * placing its elements ordered from top to bottom. When horizontal is set,
5426 * the order will go from left to right. If the box is set to be
5427 * homogeneous, every object in it will be assigned the same space, that
5428 * of the largest object. Padding can be used to set some spacing between
5429 * the cell given to each object. The alignment of the box, set with
5430 * elm_box_align_set(), determines how the bounding box of all the elements
5431 * will be placed within the space given to the box widget itself.
5433 * The size hints of each object also affect how they are placed and sized
5434 * within the box. evas_object_size_hint_min_set() will give the minimum
5435 * size the object can have, and the box will use it as the basis for all
5436 * latter calculations. Elementary widgets set their own minimum size as
5437 * needed, so there's rarely any need to use it manually.
5439 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5440 * used to tell whether the object will be allocated the minimum size it
5441 * needs or if the space given to it should be expanded. It's important
5442 * to realize that expanding the size given to the object is not the same
5443 * thing as resizing the object. It could very well end being a small
5444 * widget floating in a much larger empty space. If not set, the weight
5445 * for objects will normally be 0.0 for both axis, meaning the widget will
5446 * not be expanded. To take as much space possible, set the weight to
5447 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5449 * Besides how much space each object is allocated, it's possible to control
5450 * how the widget will be placed within that space using
5451 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5452 * for both axis, meaning the object will be centered, but any value from
5453 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5454 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5455 * is -1.0, means the object will be resized to fill the entire space it
5458 * In addition, customized functions to define the layout can be set, which
5459 * allow the application developer to organize the objects within the box
5460 * in any number of ways.
5462 * The special elm_box_layout_transition() function can be used
5463 * to switch from one layout to another, animating the motion of the
5464 * children of the box.
5466 * @note Objects should not be added to box objects using _add() calls.
5468 * Some examples on how to use boxes follow:
5469 * @li @ref box_example_01
5470 * @li @ref box_example_02
5475 * @typedef Elm_Box_Transition
5477 * Opaque handler containing the parameters to perform an animated
5478 * transition of the layout the box uses.
5480 * @see elm_box_transition_new()
5481 * @see elm_box_layout_set()
5482 * @see elm_box_layout_transition()
5484 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5487 * Add a new box to the parent
5489 * By default, the box will be in vertical mode and non-homogeneous.
5491 * @param parent The parent object
5492 * @return The new object or NULL if it cannot be created
5494 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5496 * Set the horizontal orientation
5498 * By default, box object arranges their contents vertically from top to
5500 * By calling this function with @p horizontal as EINA_TRUE, the box will
5501 * become horizontal, arranging contents from left to right.
5503 * @note This flag is ignored if a custom layout function is set.
5505 * @param obj The box object
5506 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5507 * EINA_FALSE = vertical)
5509 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5511 * Get the horizontal orientation
5513 * @param obj The box object
5514 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5516 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5518 * Set the box to arrange its children homogeneously
5520 * If enabled, homogeneous layout makes all items the same size, according
5521 * to the size of the largest of its children.
5523 * @note This flag is ignored if a custom layout function is set.
5525 * @param obj The box object
5526 * @param homogeneous The homogeneous flag
5528 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5530 * Get whether the box is using homogeneous mode or not
5532 * @param obj The box object
5533 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5535 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5536 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5537 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5539 * Add an object to the beginning of the pack list
5541 * Pack @p subobj into the box @p obj, placing it first in the list of
5542 * children objects. The actual position the object will get on screen
5543 * depends on the layout used. If no custom layout is set, it will be at
5544 * the top or left, depending if the box is vertical or horizontal,
5547 * @param obj The box object
5548 * @param subobj The object to add to the box
5550 * @see elm_box_pack_end()
5551 * @see elm_box_pack_before()
5552 * @see elm_box_pack_after()
5553 * @see elm_box_unpack()
5554 * @see elm_box_unpack_all()
5555 * @see elm_box_clear()
5557 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5559 * Add an object at the end of the pack list
5561 * Pack @p subobj into the box @p obj, placing it last in the list of
5562 * children objects. The actual position the object will get on screen
5563 * depends on the layout used. If no custom layout is set, it will be at
5564 * the bottom or right, depending if the box is vertical or horizontal,
5567 * @param obj The box object
5568 * @param subobj The object to add to the box
5570 * @see elm_box_pack_start()
5571 * @see elm_box_pack_before()
5572 * @see elm_box_pack_after()
5573 * @see elm_box_unpack()
5574 * @see elm_box_unpack_all()
5575 * @see elm_box_clear()
5577 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5579 * Adds an object to the box before the indicated object
5581 * This will add the @p subobj to the box indicated before the object
5582 * indicated with @p before. If @p before is not already in the box, results
5583 * are undefined. Before means either to the left of the indicated object or
5584 * above it depending on orientation.
5586 * @param obj The box object
5587 * @param subobj The object to add to the box
5588 * @param before The object before which to add it
5590 * @see elm_box_pack_start()
5591 * @see elm_box_pack_end()
5592 * @see elm_box_pack_after()
5593 * @see elm_box_unpack()
5594 * @see elm_box_unpack_all()
5595 * @see elm_box_clear()
5597 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5599 * Adds an object to the box after the indicated object
5601 * This will add the @p subobj to the box indicated after the object
5602 * indicated with @p after. If @p after is not already in the box, results
5603 * are undefined. After means either to the right of the indicated object or
5604 * below it depending on orientation.
5606 * @param obj The box object
5607 * @param subobj The object to add to the box
5608 * @param after The object after which to add it
5610 * @see elm_box_pack_start()
5611 * @see elm_box_pack_end()
5612 * @see elm_box_pack_before()
5613 * @see elm_box_unpack()
5614 * @see elm_box_unpack_all()
5615 * @see elm_box_clear()
5617 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5619 * Clear the box of all children
5621 * Remove all the elements contained by the box, deleting the respective
5624 * @param obj The box object
5626 * @see elm_box_unpack()
5627 * @see elm_box_unpack_all()
5629 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5633 * Remove the object given by @p subobj from the box @p obj without
5636 * @param obj The box object
5638 * @see elm_box_unpack_all()
5639 * @see elm_box_clear()
5641 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5643 * Remove all items from the box, without deleting them
5645 * Clear the box from all children, but don't delete the respective objects.
5646 * If no other references of the box children exist, the objects will never
5647 * be deleted, and thus the application will leak the memory. Make sure
5648 * when using this function that you hold a reference to all the objects
5649 * in the box @p obj.
5651 * @param obj The box object
5653 * @see elm_box_clear()
5654 * @see elm_box_unpack()
5656 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5658 * Retrieve a list of the objects packed into the box
5660 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5661 * The order of the list corresponds to the packing order the box uses.
5663 * You must free this list with eina_list_free() once you are done with it.
5665 * @param obj The box object
5667 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5669 * Set the space (padding) between the box's elements.
5671 * Extra space in pixels that will be added between a box child and its
5672 * neighbors after its containing cell has been calculated. This padding
5673 * is set for all elements in the box, besides any possible padding that
5674 * individual elements may have through their size hints.
5676 * @param obj The box object
5677 * @param horizontal The horizontal space between elements
5678 * @param vertical The vertical space between elements
5680 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5682 * Get the space (padding) between the box's elements.
5684 * @param obj The box object
5685 * @param horizontal The horizontal space between elements
5686 * @param vertical The vertical space between elements
5688 * @see elm_box_padding_set()
5690 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5692 * Set the alignment of the whole bouding box of contents.
5694 * Sets how the bounding box containing all the elements of the box, after
5695 * their sizes and position has been calculated, will be aligned within
5696 * the space given for the whole box widget.
5698 * @param obj The box object
5699 * @param horizontal The horizontal alignment of elements
5700 * @param vertical The vertical alignment of elements
5702 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5704 * Get the alignment of the whole bouding box of contents.
5706 * @param obj The box object
5707 * @param horizontal The horizontal alignment of elements
5708 * @param vertical The vertical alignment of elements
5710 * @see elm_box_align_set()
5712 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5715 * Set the layout defining function to be used by the box
5717 * Whenever anything changes that requires the box in @p obj to recalculate
5718 * the size and position of its elements, the function @p cb will be called
5719 * to determine what the layout of the children will be.
5721 * Once a custom function is set, everything about the children layout
5722 * is defined by it. The flags set by elm_box_horizontal_set() and
5723 * elm_box_homogeneous_set() no longer have any meaning, and the values
5724 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5725 * layout function to decide if they are used and how. These last two
5726 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5727 * passed to @p cb. The @c Evas_Object the function receives is not the
5728 * Elementary widget, but the internal Evas Box it uses, so none of the
5729 * functions described here can be used on it.
5731 * Any of the layout functions in @c Evas can be used here, as well as the
5732 * special elm_box_layout_transition().
5734 * The final @p data argument received by @p cb is the same @p data passed
5735 * here, and the @p free_data function will be called to free it
5736 * whenever the box is destroyed or another layout function is set.
5738 * Setting @p cb to NULL will revert back to the default layout function.
5740 * @param obj The box object
5741 * @param cb The callback function used for layout
5742 * @param data Data that will be passed to layout function
5743 * @param free_data Function called to free @p data
5745 * @see elm_box_layout_transition()
5747 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);
5749 * Special layout function that animates the transition from one layout to another
5751 * Normally, when switching the layout function for a box, this will be
5752 * reflected immediately on screen on the next render, but it's also
5753 * possible to do this through an animated transition.
5755 * This is done by creating an ::Elm_Box_Transition and setting the box
5756 * layout to this function.
5760 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5761 * evas_object_box_layout_vertical, // start
5762 * NULL, // data for initial layout
5763 * NULL, // free function for initial data
5764 * evas_object_box_layout_horizontal, // end
5765 * NULL, // data for final layout
5766 * NULL, // free function for final data
5767 * anim_end, // will be called when animation ends
5768 * NULL); // data for anim_end function\
5769 * elm_box_layout_set(box, elm_box_layout_transition, t,
5770 * elm_box_transition_free);
5773 * @note This function can only be used with elm_box_layout_set(). Calling
5774 * it directly will not have the expected results.
5776 * @see elm_box_transition_new
5777 * @see elm_box_transition_free
5778 * @see elm_box_layout_set
5780 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5782 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5784 * If you want to animate the change from one layout to another, you need
5785 * to set the layout function of the box to elm_box_layout_transition(),
5786 * passing as user data to it an instance of ::Elm_Box_Transition with the
5787 * necessary information to perform this animation. The free function to
5788 * set for the layout is elm_box_transition_free().
5790 * The parameters to create an ::Elm_Box_Transition sum up to how long
5791 * will it be, in seconds, a layout function to describe the initial point,
5792 * another for the final position of the children and one function to be
5793 * called when the whole animation ends. This last function is useful to
5794 * set the definitive layout for the box, usually the same as the end
5795 * layout for the animation, but could be used to start another transition.
5797 * @param start_layout The layout function that will be used to start the animation
5798 * @param start_layout_data The data to be passed the @p start_layout function
5799 * @param start_layout_free_data Function to free @p start_layout_data
5800 * @param end_layout The layout function that will be used to end the animation
5801 * @param end_layout_free_data The data to be passed the @p end_layout function
5802 * @param end_layout_free_data Function to free @p end_layout_data
5803 * @param transition_end_cb Callback function called when animation ends
5804 * @param transition_end_data Data to be passed to @p transition_end_cb
5805 * @return An instance of ::Elm_Box_Transition
5807 * @see elm_box_transition_new
5808 * @see elm_box_layout_transition
5810 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);
5812 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5814 * This function is mostly useful as the @c free_data parameter in
5815 * elm_box_layout_set() when elm_box_layout_transition().
5817 * @param data The Elm_Box_Transition instance to be freed.
5819 * @see elm_box_transition_new
5820 * @see elm_box_layout_transition
5822 EAPI void elm_box_transition_free(void *data);
5829 * @defgroup Button Button
5831 * @image html img/widget/button/preview-00.png
5832 * @image latex img/widget/button/preview-00.eps
5833 * @image html img/widget/button/preview-01.png
5834 * @image latex img/widget/button/preview-01.eps
5835 * @image html img/widget/button/preview-02.png
5836 * @image latex img/widget/button/preview-02.eps
5838 * This is a push-button. Press it and run some function. It can contain
5839 * a simple label and icon object and it also has an autorepeat feature.
5841 * This widgets emits the following signals:
5842 * @li "clicked": the user clicked the button (press/release).
5843 * @li "repeated": the user pressed the button without releasing it.
5844 * @li "pressed": button was pressed.
5845 * @li "unpressed": button was released after being pressed.
5846 * In all three cases, the @c event parameter of the callback will be
5849 * Also, defined in the default theme, the button has the following styles
5851 * @li default: a normal button.
5852 * @li anchor: Like default, but the button fades away when the mouse is not
5853 * over it, leaving only the text or icon.
5854 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5855 * continuous look across its options.
5856 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5858 * Follow through a complete example @ref button_example_01 "here".
5862 * Add a new button to the parent's canvas
5864 * @param parent The parent object
5865 * @return The new object or NULL if it cannot be created
5867 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5869 * Set the label used in the button
5871 * The passed @p label can be NULL to clean any existing text in it and
5872 * leave the button as an icon only object.
5874 * @param obj The button object
5875 * @param label The text will be written on the button
5876 * @deprecated use elm_object_text_set() instead.
5878 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5880 * Get the label set for the button
5882 * The string returned is an internal pointer and should not be freed or
5883 * altered. It will also become invalid when the button is destroyed.
5884 * The string returned, if not NULL, is a stringshare, so if you need to
5885 * keep it around even after the button is destroyed, you can use
5886 * eina_stringshare_ref().
5888 * @param obj The button object
5889 * @return The text set to the label, or NULL if nothing is set
5890 * @deprecated use elm_object_text_set() instead.
5892 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5894 * Set the icon used for the button
5896 * Setting a new icon will delete any other that was previously set, making
5897 * any reference to them invalid. If you need to maintain the previous
5898 * object alive, unset it first with elm_button_icon_unset().
5900 * @param obj The button object
5901 * @param icon The icon object for the button
5903 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5905 * Get the icon used for the button
5907 * Return the icon object which is set for this widget. If the button is
5908 * destroyed or another icon is set, the returned object will be deleted
5909 * and any reference to it will be invalid.
5911 * @param obj The button object
5912 * @return The icon object that is being used
5914 * @see elm_button_icon_unset()
5916 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5918 * Remove the icon set without deleting it and return the object
5920 * This function drops the reference the button holds of the icon object
5921 * and returns this last object. It is used in case you want to remove any
5922 * icon, or set another one, without deleting the actual object. The button
5923 * will be left without an icon set.
5925 * @param obj The button object
5926 * @return The icon object that was being used
5928 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5930 * Turn on/off the autorepeat event generated when the button is kept pressed
5932 * When off, no autorepeat is performed and buttons emit a normal @c clicked
5933 * signal when they are clicked.
5935 * When on, keeping a button pressed will continuously emit a @c repeated
5936 * signal until the button is released. The time it takes until it starts
5937 * emitting the signal is given by
5938 * elm_button_autorepeat_initial_timeout_set(), and the time between each
5939 * new emission by elm_button_autorepeat_gap_timeout_set().
5941 * @param obj The button object
5942 * @param on A bool to turn on/off the event
5944 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5946 * Get whether the autorepeat feature is enabled
5948 * @param obj The button object
5949 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5951 * @see elm_button_autorepeat_set()
5953 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5955 * Set the initial timeout before the autorepeat event is generated
5957 * Sets the timeout, in seconds, since the button is pressed until the
5958 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5959 * won't be any delay and the even will be fired the moment the button is
5962 * @param obj The button object
5963 * @param t Timeout in seconds
5965 * @see elm_button_autorepeat_set()
5966 * @see elm_button_autorepeat_gap_timeout_set()
5968 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5970 * Get the initial timeout before the autorepeat event is generated
5972 * @param obj The button object
5973 * @return Timeout in seconds
5975 * @see elm_button_autorepeat_initial_timeout_set()
5977 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5979 * Set the interval between each generated autorepeat event
5981 * After the first @c repeated event is fired, all subsequent ones will
5982 * follow after a delay of @p t seconds for each.
5984 * @param obj The button object
5985 * @param t Interval in seconds
5987 * @see elm_button_autorepeat_initial_timeout_set()
5989 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5991 * Get the interval between each generated autorepeat event
5993 * @param obj The button object
5994 * @return Interval in seconds
5996 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6002 * @defgroup File_Selector_Button File Selector Button
6004 * @image html img/widget/fileselector_button/preview-00.png
6005 * @image latex img/widget/fileselector_button/preview-00.eps
6006 * @image html img/widget/fileselector_button/preview-01.png
6007 * @image latex img/widget/fileselector_button/preview-01.eps
6008 * @image html img/widget/fileselector_button/preview-02.png
6009 * @image latex img/widget/fileselector_button/preview-02.eps
6011 * This is a button that, when clicked, creates an Elementary
6012 * window (or inner window) <b> with a @ref Fileselector "file
6013 * selector widget" within</b>. When a file is chosen, the (inner)
6014 * window is closed and the button emits a signal having the
6015 * selected file as it's @c event_info.
6017 * This widget encapsulates operations on its internal file
6018 * selector on its own API. There is less control over its file
6019 * selector than that one would have instatiating one directly.
6021 * The following styles are available for this button:
6024 * @li @c "hoversel_vertical"
6025 * @li @c "hoversel_vertical_entry"
6027 * Smart callbacks one can register to:
6028 * - @c "file,chosen" - the user has selected a path, whose string
6029 * pointer comes as the @c event_info data (a stringshared
6032 * Here is an example on its usage:
6033 * @li @ref fileselector_button_example
6035 * @see @ref File_Selector_Entry for a similar widget.
6040 * Add a new file selector button widget to the given parent
6041 * Elementary (container) object
6043 * @param parent The parent object
6044 * @return a new file selector button widget handle or @c NULL, on
6047 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6050 * Set the label for a given file selector button widget
6052 * @param obj The file selector button widget
6053 * @param label The text label to be displayed on @p obj
6055 * @deprecated use elm_object_text_set() instead.
6057 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6060 * Get the label set for a given file selector button widget
6062 * @param obj The file selector button widget
6063 * @return The button label
6065 * @deprecated use elm_object_text_set() instead.
6067 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6070 * Set the icon on a given file selector button widget
6072 * @param obj The file selector button widget
6073 * @param icon The icon object for the button
6075 * Once the icon object is set, a previously set one will be
6076 * deleted. If you want to keep the latter, use the
6077 * elm_fileselector_button_icon_unset() function.
6079 * @see elm_fileselector_button_icon_get()
6081 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6084 * Get the icon set for a given file selector button widget
6086 * @param obj The file selector button widget
6087 * @return The icon object currently set on @p obj or @c NULL, if
6090 * @see elm_fileselector_button_icon_set()
6092 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6095 * Unset the icon used in a given file selector button widget
6097 * @param obj The file selector button widget
6098 * @return The icon object that was being used on @p obj or @c
6101 * Unparent and return the icon object which was set for this
6104 * @see elm_fileselector_button_icon_set()
6106 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6109 * Set the title for a given file selector button widget's window
6111 * @param obj The file selector button widget
6112 * @param title The title string
6114 * This will change the window's title, when the file selector pops
6115 * out after a click on the button. Those windows have the default
6116 * (unlocalized) value of @c "Select a file" as titles.
6118 * @note It will only take any effect if the file selector
6119 * button widget is @b not under "inwin mode".
6121 * @see elm_fileselector_button_window_title_get()
6123 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6126 * Get the title set for a given file selector button widget's
6129 * @param obj The file selector button widget
6130 * @return Title of the file selector button's window
6132 * @see elm_fileselector_button_window_title_get() for more details
6134 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6137 * Set the size of a given file selector button widget's window,
6138 * holding the file selector itself.
6140 * @param obj The file selector button widget
6141 * @param width The window's width
6142 * @param height The window's height
6144 * @note it will only take any effect if the file selector button
6145 * widget is @b not under "inwin mode". The default size for the
6146 * window (when applicable) is 400x400 pixels.
6148 * @see elm_fileselector_button_window_size_get()
6150 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6153 * Get the size of a given file selector button widget's window,
6154 * holding the file selector itself.
6156 * @param obj The file selector button widget
6157 * @param width Pointer into which to store the width value
6158 * @param height Pointer into which to store the height value
6160 * @note Use @c NULL pointers on the size values you're not
6161 * interested in: they'll be ignored by the function.
6163 * @see elm_fileselector_button_window_size_set(), for more details
6165 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6168 * Set the initial file system path for a given file selector
6171 * @param obj The file selector button widget
6172 * @param path The path string
6174 * It must be a <b>directory</b> path, which will have the contents
6175 * displayed initially in the file selector's view, when invoked
6176 * from @p obj. The default initial path is the @c "HOME"
6177 * environment variable's value.
6179 * @see elm_fileselector_button_path_get()
6181 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6184 * Get the initial file system path set for a given file selector
6187 * @param obj The file selector button widget
6188 * @return path The path string
6190 * @see elm_fileselector_button_path_set() for more details
6192 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6195 * Enable/disable a tree view in the given file selector button
6196 * widget's internal file selector
6198 * @param obj The file selector button widget
6199 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6202 * This has the same effect as elm_fileselector_expandable_set(),
6203 * but now applied to a file selector button's internal file
6206 * @note There's no way to put a file selector button's internal
6207 * file selector in "grid mode", as one may do with "pure" file
6210 * @see elm_fileselector_expandable_get()
6212 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6215 * Get whether tree view is enabled for the given file selector
6216 * button widget's internal file selector
6218 * @param obj The file selector button widget
6219 * @return @c EINA_TRUE if @p obj widget's internal file selector
6220 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6222 * @see elm_fileselector_expandable_set() for more details
6224 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6227 * Set whether a given file selector button widget's internal file
6228 * selector is to display folders only or the directory contents,
6231 * @param obj The file selector button widget
6232 * @param only @c EINA_TRUE to make @p obj widget's internal file
6233 * selector only display directories, @c EINA_FALSE to make files
6234 * to be displayed in it too
6236 * This has the same effect as elm_fileselector_folder_only_set(),
6237 * but now applied to a file selector button's internal file
6240 * @see elm_fileselector_folder_only_get()
6242 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6245 * Get whether a given file selector button widget's internal file
6246 * selector is displaying folders only or the directory contents,
6249 * @param obj The file selector button widget
6250 * @return @c EINA_TRUE if @p obj widget's internal file
6251 * selector is only displaying directories, @c EINA_FALSE if files
6252 * are being displayed in it too (and on errors)
6254 * @see elm_fileselector_button_folder_only_set() for more details
6256 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6259 * Enable/disable the file name entry box where the user can type
6260 * in a name for a file, in a given file selector button widget's
6261 * internal file selector.
6263 * @param obj The file selector button widget
6264 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6265 * file selector a "saving dialog", @c EINA_FALSE otherwise
6267 * This has the same effect as elm_fileselector_is_save_set(),
6268 * but now applied to a file selector button's internal file
6271 * @see elm_fileselector_is_save_get()
6273 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6276 * Get whether the given file selector button widget's internal
6277 * file selector is in "saving dialog" mode
6279 * @param obj The file selector button widget
6280 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6281 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6284 * @see elm_fileselector_button_is_save_set() for more details
6286 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6289 * Set whether a given file selector button widget's internal file
6290 * selector will raise an Elementary "inner window", instead of a
6291 * dedicated Elementary window. By default, it won't.
6293 * @param obj The file selector button widget
6294 * @param value @c EINA_TRUE to make it use an inner window, @c
6295 * EINA_TRUE to make it use a dedicated window
6297 * @see elm_win_inwin_add() for more information on inner windows
6298 * @see elm_fileselector_button_inwin_mode_get()
6300 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6303 * Get whether a given file selector button widget's internal file
6304 * selector will raise an Elementary "inner window", instead of a
6305 * dedicated Elementary window.
6307 * @param obj The file selector button widget
6308 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6309 * if it will use a dedicated window
6311 * @see elm_fileselector_button_inwin_mode_set() for more details
6313 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6320 * @defgroup File_Selector_Entry File Selector Entry
6322 * @image html img/widget/fileselector_entry/preview-00.png
6323 * @image latex img/widget/fileselector_entry/preview-00.eps
6325 * This is an entry made to be filled with or display a <b>file
6326 * system path string</b>. Besides the entry itself, the widget has
6327 * a @ref File_Selector_Button "file selector button" on its side,
6328 * which will raise an internal @ref Fileselector "file selector widget",
6329 * when clicked, for path selection aided by file system
6332 * This file selector may appear in an Elementary window or in an
6333 * inner window. When a file is chosen from it, the (inner) window
6334 * is closed and the selected file's path string is exposed both as
6335 * an smart event and as the new text on the entry.
6337 * This widget encapsulates operations on its internal file
6338 * selector on its own API. There is less control over its file
6339 * selector than that one would have instatiating one directly.
6341 * Smart callbacks one can register to:
6342 * - @c "changed" - The text within the entry was changed
6343 * - @c "activated" - The entry has had editing finished and
6344 * changes are to be "committed"
6345 * - @c "press" - The entry has been clicked
6346 * - @c "longpressed" - The entry has been clicked (and held) for a
6348 * - @c "clicked" - The entry has been clicked
6349 * - @c "clicked,double" - The entry has been double clicked
6350 * - @c "focused" - The entry has received focus
6351 * - @c "unfocused" - The entry has lost focus
6352 * - @c "selection,paste" - A paste action has occurred on the
6354 * - @c "selection,copy" - A copy action has occurred on the entry
6355 * - @c "selection,cut" - A cut action has occurred on the entry
6356 * - @c "unpressed" - The file selector entry's button was released
6357 * after being pressed.
6358 * - @c "file,chosen" - The user has selected a path via the file
6359 * selector entry's internal file selector, whose string pointer
6360 * comes as the @c event_info data (a stringshared string)
6362 * Here is an example on its usage:
6363 * @li @ref fileselector_entry_example
6365 * @see @ref File_Selector_Button for a similar widget.
6370 * Add a new file selector entry widget to the given parent
6371 * Elementary (container) object
6373 * @param parent The parent object
6374 * @return a new file selector entry widget handle or @c NULL, on
6377 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6380 * Set the label for a given file selector entry widget's button
6382 * @param obj The file selector entry widget
6383 * @param label The text label to be displayed on @p obj widget's
6386 * @deprecated use elm_object_text_set() instead.
6388 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6391 * Get the label set for a given file selector entry widget's button
6393 * @param obj The file selector entry widget
6394 * @return The widget button's label
6396 * @deprecated use elm_object_text_set() instead.
6398 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6401 * Set the icon on a given file selector entry widget's button
6403 * @param obj The file selector entry widget
6404 * @param icon The icon object for the entry's button
6406 * Once the icon object is set, a previously set one will be
6407 * deleted. If you want to keep the latter, use the
6408 * elm_fileselector_entry_button_icon_unset() function.
6410 * @see elm_fileselector_entry_button_icon_get()
6412 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6415 * Get the icon set for a given file selector entry widget's button
6417 * @param obj The file selector entry widget
6418 * @return The icon object currently set on @p obj widget's button
6419 * or @c NULL, if none is
6421 * @see elm_fileselector_entry_button_icon_set()
6423 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6426 * Unset the icon used in a given file selector entry widget's
6429 * @param obj The file selector entry widget
6430 * @return The icon object that was being used on @p obj widget's
6431 * button or @c NULL, on errors
6433 * Unparent and return the icon object which was set for this
6436 * @see elm_fileselector_entry_button_icon_set()
6438 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6441 * Set the title for a given file selector entry widget's window
6443 * @param obj The file selector entry widget
6444 * @param title The title string
6446 * This will change the window's title, when the file selector pops
6447 * out after a click on the entry's button. Those windows have the
6448 * default (unlocalized) value of @c "Select a file" as titles.
6450 * @note It will only take any effect if the file selector
6451 * entry widget is @b not under "inwin mode".
6453 * @see elm_fileselector_entry_window_title_get()
6455 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6458 * Get the title set for a given file selector entry widget's
6461 * @param obj The file selector entry widget
6462 * @return Title of the file selector entry's window
6464 * @see elm_fileselector_entry_window_title_get() for more details
6466 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6469 * Set the size of a given file selector entry widget's window,
6470 * holding the file selector itself.
6472 * @param obj The file selector entry widget
6473 * @param width The window's width
6474 * @param height The window's height
6476 * @note it will only take any effect if the file selector entry
6477 * widget is @b not under "inwin mode". The default size for the
6478 * window (when applicable) is 400x400 pixels.
6480 * @see elm_fileselector_entry_window_size_get()
6482 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6485 * Get the size of a given file selector entry widget's window,
6486 * holding the file selector itself.
6488 * @param obj The file selector entry widget
6489 * @param width Pointer into which to store the width value
6490 * @param height Pointer into which to store the height value
6492 * @note Use @c NULL pointers on the size values you're not
6493 * interested in: they'll be ignored by the function.
6495 * @see elm_fileselector_entry_window_size_set(), for more details
6497 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6500 * Set the initial file system path and the entry's path string for
6501 * a given file selector entry widget
6503 * @param obj The file selector entry widget
6504 * @param path The path string
6506 * It must be a <b>directory</b> path, which will have the contents
6507 * displayed initially in the file selector's view, when invoked
6508 * from @p obj. The default initial path is the @c "HOME"
6509 * environment variable's value.
6511 * @see elm_fileselector_entry_path_get()
6513 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6516 * Get the entry's path string for a given file selector entry
6519 * @param obj The file selector entry widget
6520 * @return path The path string
6522 * @see elm_fileselector_entry_path_set() for more details
6524 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6527 * Enable/disable a tree view in the given file selector entry
6528 * widget's internal file selector
6530 * @param obj The file selector entry widget
6531 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6534 * This has the same effect as elm_fileselector_expandable_set(),
6535 * but now applied to a file selector entry's internal file
6538 * @note There's no way to put a file selector entry's internal
6539 * file selector in "grid mode", as one may do with "pure" file
6542 * @see elm_fileselector_expandable_get()
6544 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6547 * Get whether tree view is enabled for the given file selector
6548 * entry widget's internal file selector
6550 * @param obj The file selector entry widget
6551 * @return @c EINA_TRUE if @p obj widget's internal file selector
6552 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6554 * @see elm_fileselector_expandable_set() for more details
6556 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559 * Set whether a given file selector entry widget's internal file
6560 * selector is to display folders only or the directory contents,
6563 * @param obj The file selector entry widget
6564 * @param only @c EINA_TRUE to make @p obj widget's internal file
6565 * selector only display directories, @c EINA_FALSE to make files
6566 * to be displayed in it too
6568 * This has the same effect as elm_fileselector_folder_only_set(),
6569 * but now applied to a file selector entry's internal file
6572 * @see elm_fileselector_folder_only_get()
6574 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6577 * Get whether a given file selector entry widget's internal file
6578 * selector is displaying folders only or the directory contents,
6581 * @param obj The file selector entry widget
6582 * @return @c EINA_TRUE if @p obj widget's internal file
6583 * selector is only displaying directories, @c EINA_FALSE if files
6584 * are being displayed in it too (and on errors)
6586 * @see elm_fileselector_entry_folder_only_set() for more details
6588 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6591 * Enable/disable the file name entry box where the user can type
6592 * in a name for a file, in a given file selector entry widget's
6593 * internal file selector.
6595 * @param obj The file selector entry widget
6596 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6597 * file selector a "saving dialog", @c EINA_FALSE otherwise
6599 * This has the same effect as elm_fileselector_is_save_set(),
6600 * but now applied to a file selector entry's internal file
6603 * @see elm_fileselector_is_save_get()
6605 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6608 * Get whether the given file selector entry widget's internal
6609 * file selector is in "saving dialog" mode
6611 * @param obj The file selector entry widget
6612 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6613 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6616 * @see elm_fileselector_entry_is_save_set() for more details
6618 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6621 * Set whether a given file selector entry widget's internal file
6622 * selector will raise an Elementary "inner window", instead of a
6623 * dedicated Elementary window. By default, it won't.
6625 * @param obj The file selector entry widget
6626 * @param value @c EINA_TRUE to make it use an inner window, @c
6627 * EINA_TRUE to make it use a dedicated window
6629 * @see elm_win_inwin_add() for more information on inner windows
6630 * @see elm_fileselector_entry_inwin_mode_get()
6632 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6635 * Get whether a given file selector entry widget's internal file
6636 * selector will raise an Elementary "inner window", instead of a
6637 * dedicated Elementary window.
6639 * @param obj The file selector entry widget
6640 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6641 * if it will use a dedicated window
6643 * @see elm_fileselector_entry_inwin_mode_set() for more details
6645 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6648 * Set the initial file system path for a given file selector entry
6651 * @param obj The file selector entry widget
6652 * @param path The path string
6654 * It must be a <b>directory</b> path, which will have the contents
6655 * displayed initially in the file selector's view, when invoked
6656 * from @p obj. The default initial path is the @c "HOME"
6657 * environment variable's value.
6659 * @see elm_fileselector_entry_path_get()
6661 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6664 * Get the parent directory's path to the latest file selection on
6665 * a given filer selector entry widget
6667 * @param obj The file selector object
6668 * @return The (full) path of the directory of the last selection
6669 * on @p obj widget, a @b stringshared string
6671 * @see elm_fileselector_entry_path_set()
6673 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6680 * @defgroup Scroller Scroller
6682 * A scroller holds a single object and "scrolls it around". This means that
6683 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6684 * region around, allowing to move through a much larger object that is
6685 * contained in the scroller. The scroiller will always have a small minimum
6686 * size by default as it won't be limited by the contents of the scroller.
6688 * Signals that you can add callbacks for are:
6689 * @li "edge,left" - the left edge of the content has been reached
6690 * @li "edge,right" - the right edge of the content has been reached
6691 * @li "edge,top" - the top edge of the content has been reached
6692 * @li "edge,bottom" - the bottom edge of the content has been reached
6693 * @li "scroll" - the content has been scrolled (moved)
6694 * @li "scroll,anim,start" - scrolling animation has started
6695 * @li "scroll,anim,stop" - scrolling animation has stopped
6696 * @li "scroll,drag,start" - dragging the contents around has started
6697 * @li "scroll,drag,stop" - dragging the contents around has stopped
6698 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6701 * @note When Elemementary is in embedded mode the scrollbars will not be
6702 * dragable, they appear merely as indicators of how much has been scrolled.
6703 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6704 * fingerscroll) won't work.
6706 * In @ref tutorial_scroller you'll find an example of how to use most of
6711 * @brief Type that controls when scrollbars should appear.
6713 * @see elm_scroller_policy_set()
6715 typedef enum _Elm_Scroller_Policy
6717 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6718 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6719 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6720 ELM_SCROLLER_POLICY_LAST
6721 } Elm_Scroller_Policy;
6723 * @brief Add a new scroller to the parent
6725 * @param parent The parent object
6726 * @return The new object or NULL if it cannot be created
6728 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6730 * @brief Set the content of the scroller widget (the object to be scrolled around).
6732 * @param obj The scroller object
6733 * @param content The new content object
6735 * Once the content object is set, a previously set one will be deleted.
6736 * If you want to keep that old content object, use the
6737 * elm_scroller_content_unset() function.
6739 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6741 * @brief Get the content of the scroller widget
6743 * @param obj The slider object
6744 * @return The content that is being used
6746 * Return the content object which is set for this widget
6748 * @see elm_scroller_content_set()
6750 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6752 * @brief Unset the content of the scroller widget
6754 * @param obj The slider object
6755 * @return The content that was being used
6757 * Unparent and return the content object which was set for this widget
6759 * @see elm_scroller_content_set()
6761 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6763 * @brief Set custom theme elements for the scroller
6765 * @param obj The scroller object
6766 * @param widget The widget name to use (default is "scroller")
6767 * @param base The base name to use (default is "base")
6769 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6771 * @brief Make the scroller minimum size limited to the minimum size of the content
6773 * @param obj The scroller object
6774 * @param w Enable limiting minimum size horizontally
6775 * @param h Enable limiting minimum size vertically
6777 * By default the scroller will be as small as its design allows,
6778 * irrespective of its content. This will make the scroller minimum size the
6779 * right size horizontally and/or vertically to perfectly fit its content in
6782 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6784 * @brief Show a specific virtual region within the scroller content object
6786 * @param obj The scroller object
6787 * @param x X coordinate of the region
6788 * @param y Y coordinate of the region
6789 * @param w Width of the region
6790 * @param h Height of the region
6792 * This will ensure all (or part if it does not fit) of the designated
6793 * region in the virtual content object (0, 0 starting at the top-left of the
6794 * virtual content object) is shown within the scroller.
6796 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);
6798 * @brief Set the scrollbar visibility policy
6800 * @param obj The scroller object
6801 * @param policy_h Horizontal scrollbar policy
6802 * @param policy_v Vertical scrollbar policy
6804 * This sets the scrollbar visibility policy for the given scroller.
6805 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6806 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6807 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6808 * respectively for the horizontal and vertical scrollbars.
6810 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6812 * @brief Gets scrollbar visibility policy
6814 * @param obj The scroller object
6815 * @param policy_h Horizontal scrollbar policy
6816 * @param policy_v Vertical scrollbar policy
6818 * @see elm_scroller_policy_set()
6820 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6822 * @brief Get the currently visible content region
6824 * @param obj The scroller object
6825 * @param x X coordinate of the region
6826 * @param y Y coordinate of the region
6827 * @param w Width of the region
6828 * @param h Height of the region
6830 * This gets the current region in the content object that is visible through
6831 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6832 * w, @p h values pointed to.
6834 * @note All coordinates are relative to the content.
6836 * @see elm_scroller_region_show()
6838 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);
6840 * @brief Get the size of the content object
6842 * @param obj The scroller object
6843 * @param w Width return
6844 * @param h Height return
6846 * This gets the size of the content object of the scroller.
6848 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6850 * @brief Set bouncing behavior
6852 * @param obj The scroller object
6853 * @param h_bounce Will the scroller bounce horizontally or not
6854 * @param v_bounce Will the scroller bounce vertically or not
6856 * When scrolling, the scroller may "bounce" when reaching an edge of the
6857 * content object. This is a visual way to indicate the end has been reached.
6858 * This is enabled by default for both axis. This will set if it is enabled
6859 * for that axis with the boolean parameters for each axis.
6861 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6863 * @brief Get the bounce mode
6865 * @param obj The Scroller object
6866 * @param h_bounce Allow bounce horizontally
6867 * @param v_bounce Allow bounce vertically
6869 * @see elm_scroller_bounce_set()
6871 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6873 * @brief Set scroll page size relative to viewport size.
6875 * @param obj The scroller object
6876 * @param h_pagerel The horizontal page relative size
6877 * @param v_pagerel The vertical page relative size
6879 * The scroller is capable of limiting scrolling by the user to "pages". That
6880 * is to jump by and only show a "whole page" at a time as if the continuous
6881 * area of the scroller content is split into page sized pieces. This sets
6882 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6883 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6884 * axis. This is mutually exclusive with page size
6885 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6886 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6887 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6890 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6892 * @brief Set scroll page size.
6894 * @param obj The scroller object
6895 * @param h_pagesize The horizontal page size
6896 * @param v_pagesize The vertical page size
6898 * This sets the page size to an absolute fixed value, with 0 turning it off
6901 * @see elm_scroller_page_relative_set()
6903 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6905 * @brief Show a specific virtual region within the scroller content object.
6907 * @param obj The scroller object
6908 * @param x X coordinate of the region
6909 * @param y Y coordinate of the region
6910 * @param w Width of the region
6911 * @param h Height of the region
6913 * This will ensure all (or part if it does not fit) of the designated
6914 * region in the virtual content object (0, 0 starting at the top-left of the
6915 * virtual content object) is shown within the scroller. Unlike
6916 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
6917 * to this location (if configuration in general calls for transitions). It
6918 * may not jump immediately to the new location and make take a while and
6919 * show other content along the way.
6921 * @see elm_scroller_region_show()
6923 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);
6925 * @brief Set event propagation on a scroller
6927 * @param obj The scroller object
6928 * @param propagation If propagation is enabled or not
6930 * This enables or disabled event propagation from the scroller content to
6931 * the scroller and its parent. By default event propagation is disabled.
6933 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
6935 * @brief Get event propagation for a scroller
6937 * @param obj The scroller object
6938 * @return The propagation state
6940 * This gets the event propagation for a scroller.
6942 * @see elm_scroller_propagate_events_set()
6944 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
6950 * @defgroup Label Label
6952 * @image html img/widget/label/preview-00.png
6953 * @image latex img/widget/label/preview-00.eps
6955 * @brief Widget to display text, with simple html-like markup.
6957 * The Label widget @b doesn't allow text to overflow its boundaries, if the
6958 * text doesn't fit the geometry of the label it will be ellipsized or be
6959 * cut. Elementary provides several themes for this widget:
6960 * @li default - No animation
6961 * @li marker - Centers the text in the label and make it bold by default
6962 * @li slide_long - The entire text appears from the right of the screen and
6963 * slides until it disappears in the left of the screen(reappering on the
6965 * @li slide_short - The text appears in the left of the label and slides to
6966 * the right to show the overflow. When all of the text has been shown the
6967 * position is reset.
6968 * @li slide_bounce - The text appears in the left of the label and slides to
6969 * the right to show the overflow. When all of the text has been shown the
6970 * animation reverses, moving the text to the left.
6972 * Custom themes can of course invent new markup tags and style them any way
6975 * See @ref tutorial_label for a demonstration of how to use a label widget.
6979 * @brief Add a new label to the parent
6981 * @param parent The parent object
6982 * @return The new object or NULL if it cannot be created
6984 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6986 * @brief Set the label on the label object
6988 * @param obj The label object
6989 * @param label The label will be used on the label object
6990 * @deprecated See elm_object_text_set()
6992 EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
6994 * @brief Get the label used on the label object
6996 * @param obj The label object
6997 * @return The string inside the label
6998 * @deprecated See elm_object_text_get()
7000 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7002 * @brief Set the wrapping behavior of the label
7004 * @param obj The label object
7005 * @param wrap To wrap text or not
7007 * By default no wrapping is done. Possible values for @p wrap are:
7008 * @li ELM_WRAP_NONE - No wrapping
7009 * @li ELM_WRAP_CHAR - wrap between characters
7010 * @li ELM_WRAP_WORD - wrap between words
7011 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7013 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7015 * @brief Get the wrapping behavior of the label
7017 * @param obj The label object
7020 * @see elm_label_line_wrap_set()
7022 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7024 * @brief Set wrap width of the label
7026 * @param obj The label object
7027 * @param w The wrap width in pixels at a minimum where words need to wrap
7029 * This function sets the maximum width size hint of the label.
7031 * @warning This is only relevant if the label is inside a container.
7033 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7035 * @brief Get wrap width of the label
7037 * @param obj The label object
7038 * @return The wrap width in pixels at a minimum where words need to wrap
7040 * @see elm_label_wrap_width_set()
7042 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7044 * @brief Set wrap height of the label
7046 * @param obj The label object
7047 * @param h The wrap height in pixels at a minimum where words need to wrap
7049 * This function sets the maximum height size hint of the label.
7051 * @warning This is only relevant if the label is inside a container.
7053 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7055 * @brief get wrap width of the label
7057 * @param obj The label object
7058 * @return The wrap height in pixels at a minimum where words need to wrap
7060 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7062 * @brief Set the font size on the label object.
7064 * @param obj The label object
7065 * @param size font size
7067 * @warning NEVER use this. It is for hyper-special cases only. use styles
7068 * instead. e.g. "big", "medium", "small" - or better name them by use:
7069 * "title", "footnote", "quote" etc.
7071 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7073 * @brief Set the text color on the label object
7075 * @param obj The label object
7076 * @param r Red property background color of The label object
7077 * @param g Green property background color of The label object
7078 * @param b Blue property background color of The label object
7079 * @param a Alpha property background color of The label object
7081 * @warning NEVER use this. It is for hyper-special cases only. use styles
7082 * instead. e.g. "big", "medium", "small" - or better name them by use:
7083 * "title", "footnote", "quote" etc.
7085 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);
7087 * @brief Set the text align on the label object
7089 * @param obj The label object
7090 * @param align align mode ("left", "center", "right")
7092 * @warning NEVER use this. It is for hyper-special cases only. use styles
7093 * instead. e.g. "big", "medium", "small" - or better name them by use:
7094 * "title", "footnote", "quote" etc.
7096 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7098 * @brief Set background color of the label
7100 * @param obj The label object
7101 * @param r Red property background color of The label object
7102 * @param g Green property background color of The label object
7103 * @param b Blue property background color of The label object
7104 * @param a Alpha property background alpha of The label object
7106 * @warning NEVER use this. It is for hyper-special cases only. use styles
7107 * instead. e.g. "big", "medium", "small" - or better name them by use:
7108 * "title", "footnote", "quote" etc.
7110 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);
7112 * @brief Set the ellipsis behavior of the label
7114 * @param obj The label object
7115 * @param ellipsis To ellipsis text or not
7117 * If set to true and the text doesn't fit in the label an ellipsis("...")
7118 * will be shown at the end of the widget.
7120 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7121 * choosen wrap method was ELM_WRAP_WORD.
7123 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7125 * @brief Set the text slide of the label
7127 * @param obj The label object
7128 * @param slide To start slide or stop
7130 * If set to true the text of the label will slide throught the length of
7133 * @warning This only work with the themes "slide_short", "slide_long" and
7136 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7138 * @brief Get the text slide mode of the label
7140 * @param obj The label object
7141 * @return slide slide mode value
7143 * @see elm_label_slide_set()
7145 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7147 * @brief Set the slide duration(speed) of the label
7149 * @param obj The label object
7150 * @return The duration in seconds in moving text from slide begin position
7151 * to slide end position
7153 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7155 * @brief Get the slide duration(speed) of the label
7157 * @param obj The label object
7158 * @return The duration time in moving text from slide begin position to slide end position
7160 * @see elm_label_slide_duration_set()
7162 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7168 * @defgroup Toggle Toggle
7170 * @image html img/widget/toggle/preview-00.png
7171 * @image latex img/widget/toggle/preview-00.eps
7173 * @brief A toggle is a slider which can be used to toggle between
7174 * two values. It has two states: on and off.
7176 * Signals that you can add callbacks for are:
7177 * @li "changed" - Whenever the toggle value has been changed. Is not called
7178 * until the toggle is released by the cursor (assuming it
7179 * has been triggered by the cursor in the first place).
7181 * @ref tutorial_toggle show how to use a toggle.
7185 * @brief Add a toggle to @p parent.
7187 * @param parent The parent object
7189 * @return The toggle object
7191 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7193 * @brief Sets the label to be displayed with the toggle.
7195 * @param obj The toggle object
7196 * @param label The label to be displayed
7198 * @deprecated use elm_object_text_set() instead.
7200 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7202 * @brief Gets the label of the toggle
7204 * @param obj toggle object
7205 * @return The label of the toggle
7207 * @deprecated use elm_object_text_get() instead.
7209 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7211 * @brief Set the icon used for the toggle
7213 * @param obj The toggle object
7214 * @param icon The icon object for the button
7216 * Once the icon object is set, a previously set one will be deleted
7217 * If you want to keep that old content object, use the
7218 * elm_toggle_icon_unset() function.
7220 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7222 * @brief Get the icon used for the toggle
7224 * @param obj The toggle object
7225 * @return The icon object that is being used
7227 * Return the icon object which is set for this widget.
7229 * @see elm_toggle_icon_set()
7231 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7233 * @brief Unset the icon used for the toggle
7235 * @param obj The toggle object
7236 * @return The icon object that was being used
7238 * Unparent and return the icon object which was set for this widget.
7240 * @see elm_toggle_icon_set()
7242 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7244 * @brief Sets the labels to be associated with the on and off states of the toggle.
7246 * @param obj The toggle object
7247 * @param onlabel The label displayed when the toggle is in the "on" state
7248 * @param offlabel The label displayed when the toggle is in the "off" state
7250 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7252 * @brief Gets the labels associated with the on and off states of the toggle.
7254 * @param obj The toggle object
7255 * @param onlabel A char** to place the onlabel of @p obj into
7256 * @param offlabel A char** to place the offlabel of @p obj into
7258 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7260 * @brief Sets the state of the toggle to @p state.
7262 * @param obj The toggle object
7263 * @param state The state of @p obj
7265 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7267 * @brief Gets the state of the toggle to @p state.
7269 * @param obj The toggle object
7270 * @return The state of @p obj
7272 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7274 * @brief Sets the state pointer of the toggle to @p statep.
7276 * @param obj The toggle object
7277 * @param statep The state pointer of @p obj
7279 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7285 * @defgroup Frame Frame
7287 * @image html img/widget/frame/preview-00.png
7288 * @image latex img/widget/frame/preview-00.eps
7290 * @brief Frame is a widget that holds some content and has a title.
7292 * The default look is a frame with a title, but Frame supports multple
7300 * @li outdent_bottom
7302 * Of all this styles only default shows the title. Frame emits no signals.
7304 * For a detailed example see the @ref tutorial_frame.
7309 * @brief Add a new frame to the parent
7311 * @param parent The parent object
7312 * @return The new object or NULL if it cannot be created
7314 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7316 * @brief Set the frame label
7318 * @param obj The frame object
7319 * @param label The label of this frame object
7321 * @deprecated use elm_object_text_set() instead.
7323 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7325 * @brief Get the frame label
7327 * @param obj The frame object
7329 * @return The label of this frame objet or NULL if unable to get frame
7331 * @deprecated use elm_object_text_get() instead.
7333 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7335 * @brief Set the content of the frame widget
7337 * Once the content object is set, a previously set one will be deleted.
7338 * If you want to keep that old content object, use the
7339 * elm_frame_content_unset() function.
7341 * @param obj The frame object
7342 * @param content The content will be filled in this frame object
7344 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7346 * @brief Get the content of the frame widget
7348 * Return the content object which is set for this widget
7350 * @param obj The frame object
7351 * @return The content that is being used
7353 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7355 * @brief Unset the content of the frame widget
7357 * Unparent and return the content object which was set for this widget
7359 * @param obj The frame object
7360 * @return The content that was being used
7362 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7368 * @defgroup Table Table
7370 * A container widget to arrange other widgets in a table where items can
7371 * also span multiple columns or rows - even overlap (and then be raised or
7372 * lowered accordingly to adjust stacking if they do overlap).
7374 * The followin are examples of how to use a table:
7375 * @li @ref tutorial_table_01
7376 * @li @ref tutorial_table_02
7381 * @brief Add a new table to the parent
7383 * @param parent The parent object
7384 * @return The new object or NULL if it cannot be created
7386 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7388 * @brief Set the homogeneous layout in the table
7390 * @param obj The layout object
7391 * @param homogeneous A boolean to set if the layout is homogeneous in the
7392 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7394 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7396 * @brief Get the current table homogeneous mode.
7398 * @param obj The table object
7399 * @return A boolean to indicating if the layout is homogeneous in the table
7400 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7402 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7404 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7406 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7408 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7410 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7412 * @brief Set padding between cells.
7414 * @param obj The layout object.
7415 * @param horizontal set the horizontal padding.
7416 * @param vertical set the vertical padding.
7418 * Default value is 0.
7420 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7422 * @brief Get padding between cells.
7424 * @param obj The layout object.
7425 * @param horizontal set the horizontal padding.
7426 * @param vertical set the vertical padding.
7428 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7430 * @brief Add a subobject on the table with the coordinates passed
7432 * @param obj The table object
7433 * @param subobj The subobject to be added to the table
7434 * @param x Row number
7435 * @param y Column number
7439 * @note All positioning inside the table is relative to rows and columns, so
7440 * a value of 0 for x and y, means the top left cell of the table, and a
7441 * value of 1 for w and h means @p subobj only takes that 1 cell.
7443 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7445 * @brief Remove child from table.
7447 * @param obj The table object
7448 * @param subobj The subobject
7450 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7452 * @brief Faster way to remove all child objects from a table object.
7454 * @param obj The table object
7455 * @param clear If true, will delete children, else just remove from table.
7457 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7459 * @brief Set the packing location of an existing child of the table
7461 * @param subobj The subobject to be modified in the table
7462 * @param x Row number
7463 * @param y Column number
7467 * Modifies the position of an object already in the table.
7469 * @note All positioning inside the table is relative to rows and columns, so
7470 * a value of 0 for x and y, means the top left cell of the table, and a
7471 * value of 1 for w and h means @p subobj only takes that 1 cell.
7473 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7475 * @brief Get the packing location of an existing child of the table
7477 * @param subobj The subobject to be modified in the table
7478 * @param x Row number
7479 * @param y Column number
7483 * @see elm_table_pack_set()
7485 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7491 * @defgroup Gengrid Gengrid (Generic grid)
7493 * This widget aims to position objects in a grid layout while
7494 * actually creating and rendering only the visible ones, using the
7495 * same idea as the @ref Genlist "genlist": the user defines a @b
7496 * class for each item, specifying functions that will be called at
7497 * object creation, deletion, etc. When those items are selected by
7498 * the user, a callback function is issued. Users may interact with
7499 * a gengrid via the mouse (by clicking on items to select them and
7500 * clicking on the grid's viewport and swiping to pan the whole
7501 * view) or via the keyboard, navigating through item with the
7504 * @section Gengrid_Layouts Gengrid layouts
7506 * Gengrids may layout its items in one of two possible layouts:
7510 * When in "horizontal mode", items will be placed in @b columns,
7511 * from top to bottom and, when the space for a column is filled,
7512 * another one is started on the right, thus expanding the grid
7513 * horizontally, making for horizontal scrolling. When in "vertical
7514 * mode" , though, items will be placed in @b rows, from left to
7515 * right and, when the space for a row is filled, another one is
7516 * started below, thus expanding the grid vertically (and making
7517 * for vertical scrolling).
7519 * @section Gengrid_Items Gengrid items
7521 * An item in a gengrid can have 0 or more text labels (they can be
7522 * regular text or textblock Evas objects - that's up to the style
7523 * to determine), 0 or more icons (which are simply objects
7524 * swallowed into the gengrid item's theming Edje object) and 0 or
7525 * more <b>boolean states</b>, which have the behavior left to the
7526 * user to define. The Edje part names for each of these properties
7527 * will be looked up, in the theme file for the gengrid, under the
7528 * Edje (string) data items named @c "labels", @c "icons" and @c
7529 * "states", respectively. For each of those properties, if more
7530 * than one part is provided, they must have names listed separated
7531 * by spaces in the data fields. For the default gengrid item
7532 * theme, we have @b one label part (@c "elm.text"), @b two icon
7533 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7536 * A gengrid item may be at one of several styles. Elementary
7537 * provides one by default - "default", but this can be extended by
7538 * system or application custom themes/overlays/extensions (see
7539 * @ref Theme "themes" for more details).
7541 * @section Gengrid_Item_Class Gengrid item classes
7543 * In order to have the ability to add and delete items on the fly,
7544 * gengrid implements a class (callback) system where the
7545 * application provides a structure with information about that
7546 * type of item (gengrid may contain multiple different items with
7547 * different classes, states and styles). Gengrid will call the
7548 * functions in this struct (methods) when an item is "realized"
7549 * (i.e., created dynamically, while the user is scrolling the
7550 * grid). All objects will simply be deleted when no longer needed
7551 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7552 * contains the following members:
7553 * - @c item_style - This is a constant string and simply defines
7554 * the name of the item style. It @b must be specified and the
7555 * default should be @c "default".
7556 * - @c func.label_get - This function is called when an item
7557 * object is actually created. The @c data parameter will point to
7558 * the same data passed to elm_gengrid_item_append() and related
7559 * item creation functions. The @c obj parameter is the gengrid
7560 * object itself, while the @c part one is the name string of one
7561 * of the existing text parts in the Edje group implementing the
7562 * item's theme. This function @b must return a strdup'()ed string,
7563 * as the caller will free() it when done. See
7564 * #Elm_Gengrid_Item_Label_Get_Cb.
7565 * - @c func.icon_get - This function is called when an item object
7566 * is actually created. The @c data parameter will point to the
7567 * same data passed to elm_gengrid_item_append() and related item
7568 * creation functions. The @c obj parameter is the gengrid object
7569 * itself, while the @c part one is the name string of one of the
7570 * existing (icon) swallow parts in the Edje group implementing the
7571 * item's theme. It must return @c NULL, when no icon is desired,
7572 * or a valid object handle, otherwise. The object will be deleted
7573 * by the gengrid on its deletion or when the item is "unrealized".
7574 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7575 * - @c func.state_get - This function is called when an item
7576 * object is actually created. The @c data parameter will point to
7577 * the same data passed to elm_gengrid_item_append() and related
7578 * item creation functions. The @c obj parameter is the gengrid
7579 * object itself, while the @c part one is the name string of one
7580 * of the state parts in the Edje group implementing the item's
7581 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7582 * true/on. Gengrids will emit a signal to its theming Edje object
7583 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7584 * "source" arguments, respectively, when the state is true (the
7585 * default is false), where @c XXX is the name of the (state) part.
7586 * See #Elm_Gengrid_Item_State_Get_Cb.
7587 * - @c func.del - This is called when elm_gengrid_item_del() is
7588 * called on an item or elm_gengrid_clear() is called on the
7589 * gengrid. This is intended for use when gengrid items are
7590 * deleted, so any data attached to the item (e.g. its data
7591 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7593 * @section Gengrid_Usage_Hints Usage hints
7595 * If the user wants to have multiple items selected at the same
7596 * time, elm_gengrid_multi_select_set() will permit it. If the
7597 * gengrid is single-selection only (the default), then
7598 * elm_gengrid_select_item_get() will return the selected item or
7599 * @c NULL, if none is selected. If the gengrid is under
7600 * multi-selection, then elm_gengrid_selected_items_get() will
7601 * return a list (that is only valid as long as no items are
7602 * modified (added, deleted, selected or unselected) of child items
7605 * If an item changes (internal (boolean) state, label or icon
7606 * changes), then use elm_gengrid_item_update() to have gengrid
7607 * update the item with the new state. A gengrid will re-"realize"
7608 * the item, thus calling the functions in the
7609 * #Elm_Gengrid_Item_Class set for that item.
7611 * To programmatically (un)select an item, use
7612 * elm_gengrid_item_selected_set(). To get its selected state use
7613 * elm_gengrid_item_selected_get(). To make an item disabled
7614 * (unable to be selected and appear differently) use
7615 * elm_gengrid_item_disabled_set() to set this and
7616 * elm_gengrid_item_disabled_get() to get the disabled state.
7618 * Grid cells will only have their selection smart callbacks called
7619 * when firstly getting selected. Any further clicks will do
7620 * nothing, unless you enable the "always select mode", with
7621 * elm_gengrid_always_select_mode_set(), thus making every click to
7622 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7623 * turn off the ability to select items entirely in the widget and
7624 * they will neither appear selected nor call the selection smart
7627 * Remember that you can create new styles and add your own theme
7628 * augmentation per application with elm_theme_extension_add(). If
7629 * you absolutely must have a specific style that overrides any
7630 * theme the user or system sets up you can use
7631 * elm_theme_overlay_add() to add such a file.
7633 * @section Gengrid_Smart_Events Gengrid smart events
7635 * Smart events that you can add callbacks for are:
7636 * - @c "activated" - The user has double-clicked or pressed
7637 * (enter|return|spacebar) on an item. The @c event_info parameter
7638 * is the gengrid item that was activated.
7639 * - @c "clicked,double" - The user has double-clicked an item.
7640 * The @c event_info parameter is the gengrid item that was double-clicked.
7641 * - @c "selected" - The user has made an item selected. The
7642 * @c event_info parameter is the gengrid item that was selected.
7643 * - @c "unselected" - The user has made an item unselected. The
7644 * @c event_info parameter is the gengrid item that was unselected.
7645 * - @c "realized" - This is called when the item in the gengrid
7646 * has its implementing Evas object instantiated, de facto. @c
7647 * event_info is the gengrid item that was created. The object
7648 * may be deleted at any time, so it is highly advised to the
7649 * caller @b not to use the object pointer returned from
7650 * elm_gengrid_item_object_get(), because it may point to freed
7652 * - @c "unrealized" - This is called when the implementing Evas
7653 * object for this item is deleted. @c event_info is the gengrid
7654 * item that was deleted.
7655 * - @c "changed" - Called when an item is added, removed, resized
7656 * or moved and when the gengrid is resized or gets "horizontal"
7658 * - @c "drag,start,up" - Called when the item in the gengrid has
7659 * been dragged (not scrolled) up.
7660 * - @c "drag,start,down" - Called when the item in the gengrid has
7661 * been dragged (not scrolled) down.
7662 * - @c "drag,start,left" - Called when the item in the gengrid has
7663 * been dragged (not scrolled) left.
7664 * - @c "drag,start,right" - Called when the item in the gengrid has
7665 * been dragged (not scrolled) right.
7666 * - @c "drag,stop" - Called when the item in the gengrid has
7667 * stopped being dragged.
7668 * - @c "drag" - Called when the item in the gengrid is being
7670 * - @c "scroll" - called when the content has been scrolled
7672 * - @c "scroll,drag,start" - called when dragging the content has
7674 * - @c "scroll,drag,stop" - called when dragging the content has
7677 * List of gendrid examples:
7678 * @li @ref gengrid_example
7682 * @addtogroup Gengrid
7686 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7687 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7688 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7689 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7690 typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
7691 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
7692 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7694 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7695 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7696 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7697 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7700 * @struct _Elm_Gengrid_Item_Class
7702 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7705 struct _Elm_Gengrid_Item_Class
7707 const char *item_style;
7708 struct _Elm_Gengrid_Item_Class_Func
7710 Elm_Gengrid_Item_Label_Get_Cb label_get;
7711 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7712 Elm_Gengrid_Item_State_Get_Cb state_get;
7713 Elm_Gengrid_Item_Del_Cb del;
7715 }; /**< #Elm_Gengrid_Item_Class member definitions */
7718 * Add a new gengrid widget to the given parent Elementary
7719 * (container) object
7721 * @param parent The parent object
7722 * @return a new gengrid widget handle or @c NULL, on errors
7724 * This function inserts a new gengrid widget on the canvas.
7726 * @see elm_gengrid_item_size_set()
7727 * @see elm_gengrid_horizontal_set()
7728 * @see elm_gengrid_item_append()
7729 * @see elm_gengrid_item_del()
7730 * @see elm_gengrid_clear()
7734 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7737 * Set the size for the items of a given gengrid widget
7739 * @param obj The gengrid object.
7740 * @param w The items' width.
7741 * @param h The items' height;
7743 * A gengrid, after creation, has still no information on the size
7744 * to give to each of its cells. So, you most probably will end up
7745 * with squares one @ref Fingers "finger" wide, the default
7746 * size. Use this function to force a custom size for you items,
7747 * making them as big as you wish.
7749 * @see elm_gengrid_item_size_get()
7753 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7756 * Get the size set for the items of a given gengrid widget
7758 * @param obj The gengrid object.
7759 * @param w Pointer to a variable where to store the items' width.
7760 * @param h Pointer to a variable where to store the items' height.
7762 * @note Use @c NULL pointers on the size values you're not
7763 * interested in: they'll be ignored by the function.
7765 * @see elm_gengrid_item_size_get() for more details
7769 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7772 * Set the items grid's alignment within a given gengrid widget
7774 * @param obj The gengrid object.
7775 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7776 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7778 * This sets the alignment of the whole grid of items of a gengrid
7779 * within its given viewport. By default, those values are both
7780 * 0.5, meaning that the gengrid will have its items grid placed
7781 * exactly in the middle of its viewport.
7783 * @note If given alignment values are out of the cited ranges,
7784 * they'll be changed to the nearest boundary values on the valid
7787 * @see elm_gengrid_align_get()
7791 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7794 * Get the items grid's alignment values within a given gengrid
7797 * @param obj The gengrid object.
7798 * @param align_x Pointer to a variable where to store the
7799 * horizontal alignment.
7800 * @param align_y Pointer to a variable where to store the vertical
7803 * @note Use @c NULL pointers on the alignment values you're not
7804 * interested in: they'll be ignored by the function.
7806 * @see elm_gengrid_align_set() for more details
7810 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7813 * Set whether a given gengrid widget is or not able have items
7816 * @param obj The gengrid object
7817 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7818 * @c EINA_FALSE to turn it off
7820 * If a gengrid is set to allow reordering, a click held for more
7821 * than 0.5 over a given item will highlight it specially,
7822 * signalling the gengrid has entered the reordering state. From
7823 * that time on, the user will be able to, while still holding the
7824 * mouse button down, move the item freely in the gengrid's
7825 * viewport, replacing to said item to the locations it goes to.
7826 * The replacements will be animated and, whenever the user
7827 * releases the mouse button, the item being replaced gets a new
7828 * definitive place in the grid.
7830 * @see elm_gengrid_reorder_mode_get()
7834 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7837 * Get whether a given gengrid widget is or not able have items
7840 * @param obj The gengrid object
7841 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7844 * @see elm_gengrid_reorder_mode_set() for more details
7848 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7851 * Append a new item in a given gengrid widget.
7853 * @param obj The gengrid object.
7854 * @param gic The item class for the item.
7855 * @param data The item data.
7856 * @param func Convenience function called when the item is
7858 * @param func_data Data to be passed to @p func.
7859 * @return A handle to the item added or @c NULL, on errors.
7861 * This adds an item to the beginning of the gengrid.
7863 * @see elm_gengrid_item_prepend()
7864 * @see elm_gengrid_item_insert_before()
7865 * @see elm_gengrid_item_insert_after()
7866 * @see elm_gengrid_item_del()
7870 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);
7873 * Prepend a new item in a given gengrid widget.
7875 * @param obj The gengrid object.
7876 * @param gic The item class for the item.
7877 * @param data The item data.
7878 * @param func Convenience function called when the item is
7880 * @param func_data Data to be passed to @p func.
7881 * @return A handle to the item added or @c NULL, on errors.
7883 * This adds an item to the end of the gengrid.
7885 * @see elm_gengrid_item_append()
7886 * @see elm_gengrid_item_insert_before()
7887 * @see elm_gengrid_item_insert_after()
7888 * @see elm_gengrid_item_del()
7892 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);
7895 * Insert an item before another in a gengrid widget
7897 * @param obj The gengrid object.
7898 * @param gic The item class for the item.
7899 * @param data The item data.
7900 * @param relative The item to place this new one before.
7901 * @param func Convenience function called when the item is
7903 * @param func_data Data to be passed to @p func.
7904 * @return A handle to the item added or @c NULL, on errors.
7906 * This inserts an item before another in the gengrid.
7908 * @see elm_gengrid_item_append()
7909 * @see elm_gengrid_item_prepend()
7910 * @see elm_gengrid_item_insert_after()
7911 * @see elm_gengrid_item_del()
7915 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);
7918 * Insert an item after another in a gengrid widget
7920 * @param obj The gengrid object.
7921 * @param gic The item class for the item.
7922 * @param data The item data.
7923 * @param relative The item to place this new one after.
7924 * @param func Convenience function called when the item is
7926 * @param func_data Data to be passed to @p func.
7927 * @return A handle to the item added or @c NULL, on errors.
7929 * This inserts an item after another in the gengrid.
7931 * @see elm_gengrid_item_append()
7932 * @see elm_gengrid_item_prepend()
7933 * @see elm_gengrid_item_insert_after()
7934 * @see elm_gengrid_item_del()
7938 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);
7940 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);
7942 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);
7945 * Set whether items on a given gengrid widget are to get their
7946 * selection callbacks issued for @b every subsequent selection
7947 * click on them or just for the first click.
7949 * @param obj The gengrid object
7950 * @param always_select @c EINA_TRUE to make items "always
7951 * selected", @c EINA_FALSE, otherwise
7953 * By default, grid items will only call their selection callback
7954 * function when firstly getting selected, any subsequent further
7955 * clicks will do nothing. With this call, you make those
7956 * subsequent clicks also to issue the selection callbacks.
7958 * @note <b>Double clicks</b> will @b always be reported on items.
7960 * @see elm_gengrid_always_select_mode_get()
7964 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7967 * Get whether items on a given gengrid widget have their selection
7968 * callbacks issued for @b every subsequent selection click on them
7969 * or just for the first click.
7971 * @param obj The gengrid object.
7972 * @return @c EINA_TRUE if the gengrid items are "always selected",
7973 * @c EINA_FALSE, otherwise
7975 * @see elm_gengrid_always_select_mode_set() for more details
7979 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7982 * Set whether items on a given gengrid widget can be selected or not.
7984 * @param obj The gengrid object
7985 * @param no_select @c EINA_TRUE to make items selectable,
7986 * @c EINA_FALSE otherwise
7988 * This will make items in @p obj selectable or not. In the latter
7989 * case, any user interacion on the gendrid items will neither make
7990 * them appear selected nor them call their selection callback
7993 * @see elm_gengrid_no_select_mode_get()
7997 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8000 * Get whether items on a given gengrid widget can be selected or
8003 * @param obj The gengrid object
8004 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8007 * @see elm_gengrid_no_select_mode_set() for more details
8011 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8014 * Enable or disable multi-selection in a given gengrid widget
8016 * @param obj The gengrid object.
8017 * @param multi @c EINA_TRUE, to enable multi-selection,
8018 * @c EINA_FALSE to disable it.
8020 * Multi-selection is the ability for one to have @b more than one
8021 * item selected, on a given gengrid, simultaneously. When it is
8022 * enabled, a sequence of clicks on different items will make them
8023 * all selected, progressively. A click on an already selected item
8024 * will unselect it. If interecting via the keyboard,
8025 * multi-selection is enabled while holding the "Shift" key.
8027 * @note By default, multi-selection is @b disabled on gengrids
8029 * @see elm_gengrid_multi_select_get()
8033 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8036 * Get whether multi-selection is enabled or disabled for a given
8039 * @param obj The gengrid object.
8040 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8041 * EINA_FALSE otherwise
8043 * @see elm_gengrid_multi_select_set() for more details
8047 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8050 * Enable or disable bouncing effect for a given gengrid widget
8052 * @param obj The gengrid object
8053 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8054 * @c EINA_FALSE to disable it
8055 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8056 * @c EINA_FALSE to disable it
8058 * The bouncing effect occurs whenever one reaches the gengrid's
8059 * edge's while panning it -- it will scroll past its limits a
8060 * little bit and return to the edge again, in a animated for,
8063 * @note By default, gengrids have bouncing enabled on both axis
8065 * @see elm_gengrid_bounce_get()
8069 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8072 * Get whether bouncing effects are enabled or disabled, for a
8073 * given gengrid widget, on each axis
8075 * @param obj The gengrid object
8076 * @param h_bounce Pointer to a variable where to store the
8077 * horizontal bouncing flag.
8078 * @param v_bounce Pointer to a variable where to store the
8079 * vertical bouncing flag.
8081 * @see elm_gengrid_bounce_set() for more details
8085 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8088 * Set a given gengrid widget's scrolling page size, relative to
8089 * its viewport size.
8091 * @param obj The gengrid object
8092 * @param h_pagerel The horizontal page (relative) size
8093 * @param v_pagerel The vertical page (relative) size
8095 * The gengrid's scroller is capable of binding scrolling by the
8096 * user to "pages". It means that, while scrolling and, specially
8097 * after releasing the mouse button, the grid will @b snap to the
8098 * nearest displaying page's area. When page sizes are set, the
8099 * grid's continuous content area is split into (equal) page sized
8102 * This function sets the size of a page <b>relatively to the
8103 * viewport dimensions</b> of the gengrid, for each axis. A value
8104 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8105 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8106 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8107 * 1.0. Values beyond those will make it behave behave
8108 * inconsistently. If you only want one axis to snap to pages, use
8109 * the value @c 0.0 for the other one.
8111 * There is a function setting page size values in @b absolute
8112 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8113 * is mutually exclusive to this one.
8115 * @see elm_gengrid_page_relative_get()
8119 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8122 * Get a given gengrid widget's scrolling page size, relative to
8123 * its viewport size.
8125 * @param obj The gengrid object
8126 * @param h_pagerel Pointer to a variable where to store the
8127 * horizontal page (relative) size
8128 * @param v_pagerel Pointer to a variable where to store the
8129 * vertical page (relative) size
8131 * @see elm_gengrid_page_relative_set() for more details
8135 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8138 * Set a given gengrid widget's scrolling page size
8140 * @param obj The gengrid object
8141 * @param h_pagerel The horizontal page size, in pixels
8142 * @param v_pagerel The vertical page size, in pixels
8144 * The gengrid's scroller is capable of binding scrolling by the
8145 * user to "pages". It means that, while scrolling and, specially
8146 * after releasing the mouse button, the grid will @b snap to the
8147 * nearest displaying page's area. When page sizes are set, the
8148 * grid's continuous content area is split into (equal) page sized
8151 * This function sets the size of a page of the gengrid, in pixels,
8152 * for each axis. Sane usable values are, between @c 0 and the
8153 * dimensions of @p obj, for each axis. Values beyond those will
8154 * make it behave behave inconsistently. If you only want one axis
8155 * to snap to pages, use the value @c 0 for the other one.
8157 * There is a function setting page size values in @b relative
8158 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8159 * use is mutually exclusive to this one.
8163 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8166 * Set for what direction a given gengrid widget will expand while
8167 * placing its items.
8169 * @param obj The gengrid object.
8170 * @param setting @c EINA_TRUE to make the gengrid expand
8171 * horizontally, @c EINA_FALSE to expand vertically.
8173 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8174 * in @b columns, from top to bottom and, when the space for a
8175 * column is filled, another one is started on the right, thus
8176 * expanding the grid horizontally. When in "vertical mode"
8177 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8178 * to right and, when the space for a row is filled, another one is
8179 * started below, thus expanding the grid vertically.
8181 * @see elm_gengrid_horizontal_get()
8185 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8188 * Get for what direction a given gengrid widget will expand while
8189 * placing its items.
8191 * @param obj The gengrid object.
8192 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8193 * @c EINA_FALSE if it's set to expand vertically.
8195 * @see elm_gengrid_horizontal_set() for more detais
8199 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8202 * Get the first item in a given gengrid widget
8204 * @param obj The gengrid object
8205 * @return The first item's handle or @c NULL, if there are no
8206 * items in @p obj (and on errors)
8208 * This returns the first item in the @p obj's internal list of
8211 * @see elm_gengrid_last_item_get()
8215 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8218 * Get the last item in a given gengrid widget
8220 * @param obj The gengrid object
8221 * @return The last item's handle or @c NULL, if there are no
8222 * items in @p obj (and on errors)
8224 * This returns the last item in the @p obj's internal list of
8227 * @see elm_gengrid_first_item_get()
8231 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8234 * Get the @b next item in a gengrid widget's internal list of items,
8235 * given a handle to one of those items.
8237 * @param item The gengrid item to fetch next from
8238 * @return The item after @p item, or @c NULL if there's none (and
8241 * This returns the item placed after the @p item, on the container
8244 * @see elm_gengrid_item_prev_get()
8248 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8251 * Get the @b previous item in a gengrid widget's internal list of items,
8252 * given a handle to one of those items.
8254 * @param item The gengrid item to fetch previous from
8255 * @return The item before @p item, or @c NULL if there's none (and
8258 * This returns the item placed before the @p item, on the container
8261 * @see elm_gengrid_item_next_get()
8265 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8268 * Get the gengrid object's handle which contains a given gengrid
8271 * @param item The item to fetch the container from
8272 * @return The gengrid (parent) object
8274 * This returns the gengrid object itself that an item belongs to.
8278 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8281 * Remove a gengrid item from the its parent, deleting it.
8283 * @param item The item to be removed.
8284 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8286 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8291 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8294 * Update the contents of a given gengrid item
8296 * @param item The gengrid item
8298 * This updates an item by calling all the item class functions
8299 * again to get the icons, labels and states. Use this when the
8300 * original item data has changed and you want thta changes to be
8305 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8306 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8307 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8310 * Return the data associated to a given gengrid item
8312 * @param item The gengrid item.
8313 * @return the data associated to this item.
8315 * This returns the @c data value passed on the
8316 * elm_gengrid_item_append() and related item addition calls.
8318 * @see elm_gengrid_item_append()
8319 * @see elm_gengrid_item_data_set()
8323 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8326 * Set the data associated to a given gengrid item
8328 * @param item The gengrid item
8329 * @param data The new data pointer to set on it
8331 * This @b overrides the @c data value passed on the
8332 * elm_gengrid_item_append() and related item addition calls. This
8333 * function @b won't call elm_gengrid_item_update() automatically,
8334 * so you'd issue it afterwards if you want to hove the item
8335 * updated to reflect the that new data.
8337 * @see elm_gengrid_item_data_get()
8341 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8344 * Get a given gengrid item's position, relative to the whole
8345 * gengrid's grid area.
8347 * @param item The Gengrid item.
8348 * @param x Pointer to variable where to store the item's <b>row
8350 * @param y Pointer to variable where to store the item's <b>column
8353 * This returns the "logical" position of the item whithin the
8354 * gengrid. For example, @c (0, 1) would stand for first row,
8359 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8362 * Set whether a given gengrid item is selected or not
8364 * @param item The gengrid item
8365 * @param selected Use @c EINA_TRUE, to make it selected, @c
8366 * EINA_FALSE to make it unselected
8368 * This sets the selected state of an item. If multi selection is
8369 * not enabled on the containing gengrid and @p selected is @c
8370 * EINA_TRUE, any other previously selected items will get
8371 * unselected in favor of this new one.
8373 * @see elm_gengrid_item_selected_get()
8377 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8380 * Get whether a given gengrid item is selected or not
8382 * @param item The gengrid item
8383 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8385 * @see elm_gengrid_item_selected_set() for more details
8389 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8392 * Get the real Evas object created to implement the view of a
8393 * given gengrid item
8395 * @param item The gengrid item.
8396 * @return the Evas object implementing this item's view.
8398 * This returns the actual Evas object used to implement the
8399 * specified gengrid item's view. This may be @c NULL, as it may
8400 * not have been created or may have been deleted, at any time, by
8401 * the gengrid. <b>Do not modify this object</b> (move, resize,
8402 * show, hide, etc.), as the gengrid is controlling it. This
8403 * function is for querying, emitting custom signals or hooking
8404 * lower level callbacks for events on that object. Do not delete
8405 * this object under any circumstances.
8407 * @see elm_gengrid_item_data_get()
8411 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8414 * Show the portion of a gengrid's internal grid containing a given
8415 * item, @b immediately.
8417 * @param item The item to display
8419 * This causes gengrid to @b redraw its viewport's contents to the
8420 * region contining the given @p item item, if it is not fully
8423 * @see elm_gengrid_item_bring_in()
8427 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8430 * Animatedly bring in, to the visible are of a gengrid, a given
8433 * @param item The gengrid item to display
8435 * This causes gengrig to jump to the given @p item item and show
8436 * it (by scrolling), if it is not fully visible. This will use
8437 * animation to do so and take a period of time to complete.
8439 * @see elm_gengrid_item_show()
8443 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8446 * Set whether a given gengrid item is disabled or not.
8448 * @param item The gengrid item
8449 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8450 * to enable it back.
8452 * A disabled item cannot be selected or unselected. It will also
8453 * change its appearance, to signal the user it's disabled.
8455 * @see elm_gengrid_item_disabled_get()
8459 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8462 * Get whether a given gengrid item is disabled or not.
8464 * @param item The gengrid item
8465 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8468 * @see elm_gengrid_item_disabled_set() for more details
8472 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8475 * Set the text to be shown in a given gengrid item's tooltips.
8477 * @param item The gengrid item
8478 * @param text The text to set in the content
8480 * This call will setup the text to be used as tooltip to that item
8481 * (analogous to elm_object_tooltip_text_set(), but being item
8482 * tooltips with higher precedence than object tooltips). It can
8483 * have only one tooltip at a time, so any previous tooltip data
8488 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8491 * Set the content to be shown in a given gengrid item's tooltips
8493 * @param item The gengrid item.
8494 * @param func The function returning the tooltip contents.
8495 * @param data What to provide to @a func as callback data/context.
8496 * @param del_cb Called when data is not needed anymore, either when
8497 * another callback replaces @p func, the tooltip is unset with
8498 * elm_gengrid_item_tooltip_unset() or the owner @p item
8499 * dies. This callback receives as its first parameter the
8500 * given @p data, being @c event_info the item handle.
8502 * This call will setup the tooltip's contents to @p item
8503 * (analogous to elm_object_tooltip_content_cb_set(), but being
8504 * item tooltips with higher precedence than object tooltips). It
8505 * can have only one tooltip at a time, so any previous tooltip
8506 * content will get removed. @p func (with @p data) will be called
8507 * every time Elementary needs to show the tooltip and it should
8508 * return a valid Evas object, which will be fully managed by the
8509 * tooltip system, getting deleted when the tooltip is gone.
8513 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);
8516 * Unset a tooltip from a given gengrid item
8518 * @param item gengrid item to remove a previously set tooltip from.
8520 * This call removes any tooltip set on @p item. The callback
8521 * provided as @c del_cb to
8522 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8523 * notify it is not used anymore (and have resources cleaned, if
8526 * @see elm_gengrid_item_tooltip_content_cb_set()
8530 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8533 * Set a different @b style for a given gengrid item's tooltip.
8535 * @param item gengrid item with tooltip set
8536 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8537 * "default", @c "transparent", etc)
8539 * Tooltips can have <b>alternate styles</b> to be displayed on,
8540 * which are defined by the theme set on Elementary. This function
8541 * works analogously as elm_object_tooltip_style_set(), but here
8542 * applied only to gengrid item objects. The default style for
8543 * tooltips is @c "default".
8545 * @note before you set a style you should define a tooltip with
8546 * elm_gengrid_item_tooltip_content_cb_set() or
8547 * elm_gengrid_item_tooltip_text_set()
8549 * @see elm_gengrid_item_tooltip_style_get()
8553 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8556 * Get the style set a given gengrid item's tooltip.
8558 * @param item gengrid item with tooltip already set on.
8559 * @return style the theme style in use, which defaults to
8560 * "default". If the object does not have a tooltip set,
8561 * then @c NULL is returned.
8563 * @see elm_gengrid_item_tooltip_style_set() for more details
8567 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8569 * @brief Disable size restrictions on an object's tooltip
8570 * @param item The tooltip's anchor object
8571 * @param disable If EINA_TRUE, size restrictions are disabled
8572 * @return EINA_FALSE on failure, EINA_TRUE on success
8574 * This function allows a tooltip to expand beyond its parant window's canvas.
8575 * It will instead be limited only by the size of the display.
8577 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8579 * @brief Retrieve size restriction state of an object's tooltip
8580 * @param item The tooltip's anchor object
8581 * @return If EINA_TRUE, size restrictions are disabled
8583 * This function returns whether a tooltip is allowed to expand beyond
8584 * its parant window's canvas.
8585 * It will instead be limited only by the size of the display.
8587 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8589 * Set the type of mouse pointer/cursor decoration to be shown,
8590 * when the mouse pointer is over the given gengrid widget item
8592 * @param item gengrid item to customize cursor on
8593 * @param cursor the cursor type's name
8595 * This function works analogously as elm_object_cursor_set(), but
8596 * here the cursor's changing area is restricted to the item's
8597 * area, and not the whole widget's. Note that that item cursors
8598 * have precedence over widget cursors, so that a mouse over @p
8599 * item will always show cursor @p type.
8601 * If this function is called twice for an object, a previously set
8602 * cursor will be unset on the second call.
8604 * @see elm_object_cursor_set()
8605 * @see elm_gengrid_item_cursor_get()
8606 * @see elm_gengrid_item_cursor_unset()
8610 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8613 * Get the type of mouse pointer/cursor decoration set to be shown,
8614 * when the mouse pointer is over the given gengrid widget item
8616 * @param item gengrid item with custom cursor set
8617 * @return the cursor type's name or @c NULL, if no custom cursors
8618 * were set to @p item (and on errors)
8620 * @see elm_object_cursor_get()
8621 * @see elm_gengrid_item_cursor_set() for more details
8622 * @see elm_gengrid_item_cursor_unset()
8626 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8629 * Unset any custom mouse pointer/cursor decoration set to be
8630 * shown, when the mouse pointer is over the given gengrid widget
8631 * item, thus making it show the @b default cursor again.
8633 * @param item a gengrid item
8635 * Use this call to undo any custom settings on this item's cursor
8636 * decoration, bringing it back to defaults (no custom style set).
8638 * @see elm_object_cursor_unset()
8639 * @see elm_gengrid_item_cursor_set() for more details
8643 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8646 * Set a different @b style for a given custom cursor set for a
8649 * @param item gengrid item with custom cursor set
8650 * @param style the <b>theme style</b> to use (e.g. @c "default",
8651 * @c "transparent", etc)
8653 * This function only makes sense when one is using custom mouse
8654 * cursor decorations <b>defined in a theme file</b> , which can
8655 * have, given a cursor name/type, <b>alternate styles</b> on
8656 * it. It works analogously as elm_object_cursor_style_set(), but
8657 * here applied only to gengrid item objects.
8659 * @warning Before you set a cursor style you should have defined a
8660 * custom cursor previously on the item, with
8661 * elm_gengrid_item_cursor_set()
8663 * @see elm_gengrid_item_cursor_engine_only_set()
8664 * @see elm_gengrid_item_cursor_style_get()
8668 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8671 * Get the current @b style set for a given gengrid item's custom
8674 * @param item gengrid item with custom cursor set.
8675 * @return style the cursor style in use. If the object does not
8676 * have a cursor set, then @c NULL is returned.
8678 * @see elm_gengrid_item_cursor_style_set() for more details
8682 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8685 * Set if the (custom) cursor for a given gengrid item should be
8686 * searched in its theme, also, or should only rely on the
8689 * @param item item with custom (custom) cursor already set on
8690 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8691 * only on those provided by the rendering engine, @c EINA_FALSE to
8692 * have them searched on the widget's theme, as well.
8694 * @note This call is of use only if you've set a custom cursor
8695 * for gengrid items, with elm_gengrid_item_cursor_set().
8697 * @note By default, cursors will only be looked for between those
8698 * provided by the rendering engine.
8702 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8705 * Get if the (custom) cursor for a given gengrid item is being
8706 * searched in its theme, also, or is only relying on the rendering
8709 * @param item a gengrid item
8710 * @return @c EINA_TRUE, if cursors are being looked for only on
8711 * those provided by the rendering engine, @c EINA_FALSE if they
8712 * are being searched on the widget's theme, as well.
8714 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8718 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8721 * Remove all items from a given gengrid widget
8723 * @param obj The gengrid object.
8725 * This removes (and deletes) all items in @p obj, leaving it
8728 * @see elm_gengrid_item_del(), to remove just one item.
8732 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8735 * Get the selected item in a given gengrid widget
8737 * @param obj The gengrid object.
8738 * @return The selected item's handleor @c NULL, if none is
8739 * selected at the moment (and on errors)
8741 * This returns the selected item in @p obj. If multi selection is
8742 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8743 * the first item in the list is selected, which might not be very
8744 * useful. For that case, see elm_gengrid_selected_items_get().
8748 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8751 * Get <b>a list</b> of selected items in a given gengrid
8753 * @param obj The gengrid object.
8754 * @return The list of selected items or @c NULL, if none is
8755 * selected at the moment (and on errors)
8757 * This returns a list of the selected items, in the order that
8758 * they appear in the grid. This list is only valid as long as no
8759 * more items are selected or unselected (or unselected implictly
8760 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8763 * @see elm_gengrid_selected_item_get()
8767 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8774 * @defgroup Clock Clock
8776 * @image html img/widget/clock/preview-00.png
8777 * @image latex img/widget/clock/preview-00.eps
8779 * This is a @b digital clock widget. In its default theme, it has a
8780 * vintage "flipping numbers clock" appearance, which will animate
8781 * sheets of individual algarisms individually as time goes by.
8783 * A newly created clock will fetch system's time (already
8784 * considering local time adjustments) to start with, and will tick
8785 * accondingly. It may or may not show seconds.
8787 * Clocks have an @b edition mode. When in it, the sheets will
8788 * display extra arrow indications on the top and bottom and the
8789 * user may click on them to raise or lower the time values. After
8790 * it's told to exit edition mode, it will keep ticking with that
8791 * new time set (it keeps the difference from local time).
8793 * Also, when under edition mode, user clicks on the cited arrows
8794 * which are @b held for some time will make the clock to flip the
8795 * sheet, thus editing the time, continuosly and automatically for
8796 * the user. The interval between sheet flips will keep growing in
8797 * time, so that it helps the user to reach a time which is distant
8800 * The time display is, by default, in military mode (24h), but an
8801 * am/pm indicator may be optionally shown, too, when it will
8804 * Smart callbacks one can register to:
8805 * - "changed" - the clock's user changed the time
8807 * Here is an example on its usage:
8808 * @li @ref clock_example
8817 * Identifiers for which clock digits should be editable, when a
8818 * clock widget is in edition mode. Values may be ORed together to
8819 * make a mask, naturally.
8821 * @see elm_clock_edit_set()
8822 * @see elm_clock_digit_edit_set()
8824 typedef enum _Elm_Clock_Digedit
8826 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8827 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8828 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
8829 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8830 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
8831 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8832 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
8833 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
8834 } Elm_Clock_Digedit;
8837 * Add a new clock widget to the given parent Elementary
8838 * (container) object
8840 * @param parent The parent object
8841 * @return a new clock widget handle or @c NULL, on errors
8843 * This function inserts a new clock widget on the canvas.
8847 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8850 * Set a clock widget's time, programmatically
8852 * @param obj The clock widget object
8853 * @param hrs The hours to set
8854 * @param min The minutes to set
8855 * @param sec The secondes to set
8857 * This function updates the time that is showed by the clock
8860 * Values @b must be set within the following ranges:
8861 * - 0 - 23, for hours
8862 * - 0 - 59, for minutes
8863 * - 0 - 59, for seconds,
8865 * even if the clock is not in "military" mode.
8867 * @warning The behavior for values set out of those ranges is @b
8872 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8875 * Get a clock widget's time values
8877 * @param obj The clock object
8878 * @param[out] hrs Pointer to the variable to get the hours value
8879 * @param[out] min Pointer to the variable to get the minutes value
8880 * @param[out] sec Pointer to the variable to get the seconds value
8882 * This function gets the time set for @p obj, returning
8883 * it on the variables passed as the arguments to function
8885 * @note Use @c NULL pointers on the time values you're not
8886 * interested in: they'll be ignored by the function.
8890 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8893 * Set whether a given clock widget is under <b>edition mode</b> or
8894 * under (default) displaying-only mode.
8896 * @param obj The clock object
8897 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8898 * put it back to "displaying only" mode
8900 * This function makes a clock's time to be editable or not <b>by
8901 * user interaction</b>. When in edition mode, clocks @b stop
8902 * ticking, until one brings them back to canonical mode. The
8903 * elm_clock_digit_edit_set() function will influence which digits
8904 * of the clock will be editable. By default, all of them will be
8905 * (#ELM_CLOCK_NONE).
8907 * @note am/pm sheets, if being shown, will @b always be editable
8908 * under edition mode.
8910 * @see elm_clock_edit_get()
8914 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8917 * Retrieve whether a given clock widget is under <b>edition
8918 * mode</b> or under (default) displaying-only mode.
8920 * @param obj The clock object
8921 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
8924 * This function retrieves whether the clock's time can be edited
8925 * or not by user interaction.
8927 * @see elm_clock_edit_set() for more details
8931 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8934 * Set what digits of the given clock widget should be editable
8935 * when in edition mode.
8937 * @param obj The clock object
8938 * @param digedit Bit mask indicating the digits to be editable
8939 * (values in #Elm_Clock_Digedit).
8941 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
8942 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
8945 * @see elm_clock_digit_edit_get()
8949 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
8952 * Retrieve what digits of the given clock widget should be
8953 * editable when in edition mode.
8955 * @param obj The clock object
8956 * @return Bit mask indicating the digits to be editable
8957 * (values in #Elm_Clock_Digedit).
8959 * @see elm_clock_digit_edit_set() for more details
8963 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8966 * Set if the given clock widget must show hours in military or
8969 * @param obj The clock object
8970 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
8973 * This function sets if the clock must show hours in military or
8974 * am/pm mode. In some countries like Brazil the military mode
8975 * (00-24h-format) is used, in opposition to the USA, where the
8976 * am/pm mode is more commonly used.
8978 * @see elm_clock_show_am_pm_get()
8982 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
8985 * Get if the given clock widget shows hours in military or am/pm
8988 * @param obj The clock object
8989 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
8992 * This function gets if the clock shows hours in military or am/pm
8995 * @see elm_clock_show_am_pm_set() for more details
8999 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9002 * Set if the given clock widget must show time with seconds or not
9004 * @param obj The clock object
9005 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9007 * This function sets if the given clock must show or not elapsed
9008 * seconds. By default, they are @b not shown.
9010 * @see elm_clock_show_seconds_get()
9014 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9017 * Get whether the given clock widget is showing time with seconds
9020 * @param obj The clock object
9021 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9023 * This function gets whether @p obj is showing or not the elapsed
9026 * @see elm_clock_show_seconds_set()
9030 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9033 * Set the interval on time updates for an user mouse button hold
9034 * on clock widgets' time edition.
9036 * @param obj The clock object
9037 * @param interval The (first) interval value in seconds
9039 * This interval value is @b decreased while the user holds the
9040 * mouse pointer either incrementing or decrementing a given the
9041 * clock digit's value.
9043 * This helps the user to get to a given time distant from the
9044 * current one easier/faster, as it will start to flip quicker and
9045 * quicker on mouse button holds.
9047 * The calculation for the next flip interval value, starting from
9048 * the one set with this call, is the previous interval divided by
9049 * 1.05, so it decreases a little bit.
9051 * The default starting interval value for automatic flips is
9054 * @see elm_clock_interval_get()
9058 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9061 * Get the interval on time updates for an user mouse button hold
9062 * on clock widgets' time edition.
9064 * @param obj The clock object
9065 * @return The (first) interval value, in seconds, set on it
9067 * @see elm_clock_interval_set() for more details
9071 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9078 * @defgroup Layout Layout
9080 * @image html img/widget/layout/preview-00.png
9081 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9083 * @image html img/layout-predefined.png
9084 * @image latex img/layout-predefined.eps width=\textwidth
9086 * This is a container widget that takes a standard Edje design file and
9087 * wraps it very thinly in a widget.
9089 * An Edje design (theme) file has a very wide range of possibilities to
9090 * describe the behavior of elements added to the Layout. Check out the Edje
9091 * documentation and the EDC reference to get more information about what can
9092 * be done with Edje.
9094 * Just like @ref List, @ref Box, and other container widgets, any
9095 * object added to the Layout will become its child, meaning that it will be
9096 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9098 * The Layout widget can contain as many Contents, Boxes or Tables as
9099 * described in its theme file. For instance, objects can be added to
9100 * different Tables by specifying the respective Table part names. The same
9101 * is valid for Content and Box.
9103 * The objects added as child of the Layout will behave as described in the
9104 * part description where they were added. There are 3 possible types of
9105 * parts where a child can be added:
9107 * @section secContent Content (SWALLOW part)
9109 * Only one object can be added to the @c SWALLOW part (but you still can
9110 * have many @c SWALLOW parts and one object on each of them). Use the @c
9111 * elm_layout_content_* set of functions to set, retrieve and unset objects
9112 * as content of the @c SWALLOW. After being set to this part, the object
9113 * size, position, visibility, clipping and other description properties
9114 * will be totally controled by the description of the given part (inside
9115 * the Edje theme file).
9117 * One can use @c evas_object_size_hint_* functions on the child to have some
9118 * kind of control over its behavior, but the resulting behavior will still
9119 * depend heavily on the @c SWALLOW part description.
9121 * The Edje theme also can change the part description, based on signals or
9122 * scripts running inside the theme. This change can also be animated. All of
9123 * this will affect the child object set as content accordingly. The object
9124 * size will be changed if the part size is changed, it will animate move if
9125 * the part is moving, and so on.
9127 * The following picture demonstrates a Layout widget with a child object
9128 * added to its @c SWALLOW:
9130 * @image html layout_swallow.png
9131 * @image latex layout_swallow.eps width=\textwidth
9133 * @section secBox Box (BOX part)
9135 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9136 * allows one to add objects to the box and have them distributed along its
9137 * area, accordingly to the specified @a layout property (now by @a layout we
9138 * mean the chosen layouting design of the Box, not the Layout widget
9141 * A similar effect for having a box with its position, size and other things
9142 * controled by the Layout theme would be to create an Elementary @ref Box
9143 * widget and add it as a Content in the @c SWALLOW part.
9145 * The main difference of using the Layout Box is that its behavior, the box
9146 * properties like layouting format, padding, align, etc. will be all
9147 * controled by the theme. This means, for example, that a signal could be
9148 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9149 * handled the signal by changing the box padding, or align, or both. Using
9150 * the Elementary @ref Box widget is not necessarily harder or easier, it
9151 * just depends on the circunstances and requirements.
9153 * The Layout Box can be used through the @c elm_layout_box_* set of
9156 * The following picture demonstrates a Layout widget with many child objects
9157 * added to its @c BOX part:
9159 * @image html layout_box.png
9160 * @image latex layout_box.eps width=\textwidth
9162 * @section secTable Table (TABLE part)
9164 * Just like the @ref secBox, the Layout Table is very similar to the
9165 * Elementary @ref Table widget. It allows one to add objects to the Table
9166 * specifying the row and column where the object should be added, and any
9167 * column or row span if necessary.
9169 * Again, we could have this design by adding a @ref Table widget to the @c
9170 * SWALLOW part using elm_layout_content_set(). The same difference happens
9171 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9172 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9174 * The Layout Table can be used through the @c elm_layout_table_* set of
9177 * The following picture demonstrates a Layout widget with many child objects
9178 * added to its @c TABLE part:
9180 * @image html layout_table.png
9181 * @image latex layout_table.eps width=\textwidth
9183 * @section secPredef Predefined Layouts
9185 * Another interesting thing about the Layout widget is that it offers some
9186 * predefined themes that come with the default Elementary theme. These
9187 * themes can be set by the call elm_layout_theme_set(), and provide some
9188 * basic functionality depending on the theme used.
9190 * Most of them already send some signals, some already provide a toolbar or
9191 * back and next buttons.
9193 * These are available predefined theme layouts. All of them have class = @c
9194 * layout, group = @c application, and style = one of the following options:
9196 * @li @c toolbar-content - application with toolbar and main content area
9197 * @li @c toolbar-content-back - application with toolbar and main content
9198 * area with a back button and title area
9199 * @li @c toolbar-content-back-next - application with toolbar and main
9200 * content area with a back and next buttons and title area
9201 * @li @c content-back - application with a main content area with a back
9202 * button and title area
9203 * @li @c content-back-next - application with a main content area with a
9204 * back and next buttons and title area
9205 * @li @c toolbar-vbox - application with toolbar and main content area as a
9207 * @li @c toolbar-table - application with toolbar and main content area as a
9210 * @section secExamples Examples
9212 * Some examples of the Layout widget can be found here:
9213 * @li @ref layout_example_01
9214 * @li @ref layout_example_02
9215 * @li @ref layout_example_03
9216 * @li @ref layout_example_edc
9221 * Add a new layout to the parent
9223 * @param parent The parent object
9224 * @return The new object or NULL if it cannot be created
9226 * @see elm_layout_file_set()
9227 * @see elm_layout_theme_set()
9231 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9233 * Set the file that will be used as layout
9235 * @param obj The layout object
9236 * @param file The path to file (edj) that will be used as layout
9237 * @param group The group that the layout belongs in edje file
9239 * @return (1 = success, 0 = error)
9243 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9245 * Set the edje group from the elementary theme that will be used as layout
9247 * @param obj The layout object
9248 * @param clas the clas of the group
9249 * @param group the group
9250 * @param style the style to used
9252 * @return (1 = success, 0 = error)
9256 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9258 * Set the layout content.
9260 * @param obj The layout object
9261 * @param swallow The swallow part name in the edje file
9262 * @param content The child that will be added in this layout object
9264 * Once the content object is set, a previously set one will be deleted.
9265 * If you want to keep that old content object, use the
9266 * elm_layout_content_unset() function.
9268 * @note In an Edje theme, the part used as a content container is called @c
9269 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9270 * expected to be a part name just like the second parameter of
9271 * elm_layout_box_append().
9273 * @see elm_layout_box_append()
9274 * @see elm_layout_content_get()
9275 * @see elm_layout_content_unset()
9280 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9282 * Get the child object in the given content part.
9284 * @param obj The layout object
9285 * @param swallow The SWALLOW part to get its content
9287 * @return The swallowed object or NULL if none or an error occurred
9289 * @see elm_layout_content_set()
9293 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9295 * Unset the layout content.
9297 * @param obj The layout object
9298 * @param swallow The swallow part name in the edje file
9299 * @return The content that was being used
9301 * Unparent and return the content object which was set for this part.
9303 * @see elm_layout_content_set()
9307 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9309 * Set the text of the given part
9311 * @param obj The layout object
9312 * @param part The TEXT part where to set the text
9313 * @param text The text to set
9316 * @deprecated use elm_object_text_* instead.
9318 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9320 * Get the text set in the given part
9322 * @param obj The layout object
9323 * @param part The TEXT part to retrieve the text off
9325 * @return The text set in @p part
9328 * @deprecated use elm_object_text_* instead.
9330 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9332 * Append child to layout box part.
9334 * @param obj the layout object
9335 * @param part the box part to which the object will be appended.
9336 * @param child the child object to append to box.
9338 * Once the object is appended, it will become child of the layout. Its
9339 * lifetime will be bound to the layout, whenever the layout dies the child
9340 * will be deleted automatically. One should use elm_layout_box_remove() to
9341 * make this layout forget about the object.
9343 * @see elm_layout_box_prepend()
9344 * @see elm_layout_box_insert_before()
9345 * @see elm_layout_box_insert_at()
9346 * @see elm_layout_box_remove()
9350 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9352 * Prepend child to layout box part.
9354 * @param obj the layout object
9355 * @param part the box part to prepend.
9356 * @param child the child object to prepend to box.
9358 * Once the object is prepended, it will become child of the layout. Its
9359 * lifetime will be bound to the layout, whenever the layout dies the child
9360 * will be deleted automatically. One should use elm_layout_box_remove() to
9361 * make this layout forget about the object.
9363 * @see elm_layout_box_append()
9364 * @see elm_layout_box_insert_before()
9365 * @see elm_layout_box_insert_at()
9366 * @see elm_layout_box_remove()
9370 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9372 * Insert child to layout box part before a reference object.
9374 * @param obj the layout object
9375 * @param part the box part to insert.
9376 * @param child the child object to insert into box.
9377 * @param reference another reference object to insert before in box.
9379 * Once the object is inserted, it will become child of the layout. Its
9380 * lifetime will be bound to the layout, whenever the layout dies the child
9381 * will be deleted automatically. One should use elm_layout_box_remove() to
9382 * make this layout forget about the object.
9384 * @see elm_layout_box_append()
9385 * @see elm_layout_box_prepend()
9386 * @see elm_layout_box_insert_before()
9387 * @see elm_layout_box_remove()
9391 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9393 * Insert child to layout box part at a given position.
9395 * @param obj the layout object
9396 * @param part the box part to insert.
9397 * @param child the child object to insert into box.
9398 * @param pos the numeric position >=0 to insert the child.
9400 * Once the object is inserted, it will become child of the layout. Its
9401 * lifetime will be bound to the layout, whenever the layout dies the child
9402 * will be deleted automatically. One should use elm_layout_box_remove() to
9403 * make this layout forget about the object.
9405 * @see elm_layout_box_append()
9406 * @see elm_layout_box_prepend()
9407 * @see elm_layout_box_insert_before()
9408 * @see elm_layout_box_remove()
9412 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9414 * Remove a child of the given part box.
9416 * @param obj The layout object
9417 * @param part The box part name to remove child.
9418 * @param child The object to remove from box.
9419 * @return The object that was being used, or NULL if not found.
9421 * The object will be removed from the box part and its lifetime will
9422 * not be handled by the layout anymore. This is equivalent to
9423 * elm_layout_content_unset() for box.
9425 * @see elm_layout_box_append()
9426 * @see elm_layout_box_remove_all()
9430 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9432 * Remove all child of the given part box.
9434 * @param obj The layout object
9435 * @param part The box part name to remove child.
9436 * @param clear If EINA_TRUE, then all objects will be deleted as
9437 * well, otherwise they will just be removed and will be
9438 * dangling on the canvas.
9440 * The objects will be removed from the box part and their lifetime will
9441 * not be handled by the layout anymore. This is equivalent to
9442 * elm_layout_box_remove() for all box children.
9444 * @see elm_layout_box_append()
9445 * @see elm_layout_box_remove()
9449 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9451 * Insert child to layout table part.
9453 * @param obj the layout object
9454 * @param part the box part to pack child.
9455 * @param child_obj the child object to pack into table.
9456 * @param col the column to which the child should be added. (>= 0)
9457 * @param row the row to which the child should be added. (>= 0)
9458 * @param colspan how many columns should be used to store this object. (>=
9460 * @param rowspan how many rows should be used to store this object. (>= 1)
9462 * Once the object is inserted, it will become child of the table. Its
9463 * lifetime will be bound to the layout, and whenever the layout dies the
9464 * child will be deleted automatically. One should use
9465 * elm_layout_table_remove() to make this layout forget about the object.
9467 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9468 * more space than a single cell. For instance, the following code:
9470 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9473 * Would result in an object being added like the following picture:
9475 * @image html layout_colspan.png
9476 * @image latex layout_colspan.eps width=\textwidth
9478 * @see elm_layout_table_unpack()
9479 * @see elm_layout_table_clear()
9483 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);
9485 * Unpack (remove) a child of the given part table.
9487 * @param obj The layout object
9488 * @param part The table part name to remove child.
9489 * @param child_obj The object to remove from table.
9490 * @return The object that was being used, or NULL if not found.
9492 * The object will be unpacked from the table part and its lifetime
9493 * will not be handled by the layout anymore. This is equivalent to
9494 * elm_layout_content_unset() for table.
9496 * @see elm_layout_table_pack()
9497 * @see elm_layout_table_clear()
9501 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9503 * Remove all child of the given part table.
9505 * @param obj The layout object
9506 * @param part The table part name to remove child.
9507 * @param clear If EINA_TRUE, then all objects will be deleted as
9508 * well, otherwise they will just be removed and will be
9509 * dangling on the canvas.
9511 * The objects will be removed from the table part and their lifetime will
9512 * not be handled by the layout anymore. This is equivalent to
9513 * elm_layout_table_unpack() for all table children.
9515 * @see elm_layout_table_pack()
9516 * @see elm_layout_table_unpack()
9520 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9522 * Get the edje layout
9524 * @param obj The layout object
9526 * @return A Evas_Object with the edje layout settings loaded
9527 * with function elm_layout_file_set
9529 * This returns the edje object. It is not expected to be used to then
9530 * swallow objects via edje_object_part_swallow() for example. Use
9531 * elm_layout_content_set() instead so child object handling and sizing is
9534 * @note This function should only be used if you really need to call some
9535 * low level Edje function on this edje object. All the common stuff (setting
9536 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9537 * with proper elementary functions.
9539 * @see elm_object_signal_callback_add()
9540 * @see elm_object_signal_emit()
9541 * @see elm_object_text_part_set()
9542 * @see elm_layout_content_set()
9543 * @see elm_layout_box_append()
9544 * @see elm_layout_table_pack()
9545 * @see elm_layout_data_get()
9549 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9551 * Get the edje data from the given layout
9553 * @param obj The layout object
9554 * @param key The data key
9556 * @return The edje data string
9558 * This function fetches data specified inside the edje theme of this layout.
9559 * This function return NULL if data is not found.
9561 * In EDC this comes from a data block within the group block that @p
9562 * obj was loaded from. E.g.
9569 * item: "key1" "value1";
9570 * item: "key2" "value2";
9578 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9582 * @param obj The layout object
9584 * Manually forces a sizing re-evaluation. This is useful when the minimum
9585 * size required by the edje theme of this layout has changed. The change on
9586 * the minimum size required by the edje theme is not immediately reported to
9587 * the elementary layout, so one needs to call this function in order to tell
9588 * the widget (layout) that it needs to reevaluate its own size.
9590 * The minimum size of the theme is calculated based on minimum size of
9591 * parts, the size of elements inside containers like box and table, etc. All
9592 * of this can change due to state changes, and that's when this function
9595 * Also note that a standard signal of "size,eval" "elm" emitted from the
9596 * edje object will cause this to happen too.
9600 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9603 * Sets a specific cursor for an edje part.
9605 * @param obj The layout object.
9606 * @param part_name a part from loaded edje group.
9607 * @param cursor cursor name to use, see Elementary_Cursor.h
9609 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9610 * part not exists or it has "mouse_events: 0".
9614 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9617 * Get the cursor to be shown when mouse is over an edje part
9619 * @param obj The layout object.
9620 * @param part_name a part from loaded edje group.
9621 * @return the cursor name.
9625 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9628 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9630 * @param obj The layout object.
9631 * @param part_name a part from loaded edje group, that had a cursor set
9632 * with elm_layout_part_cursor_set().
9636 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9639 * Sets a specific cursor style for an edje part.
9641 * @param obj The layout object.
9642 * @param part_name a part from loaded edje group.
9643 * @param style the theme style to use (default, transparent, ...)
9645 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9646 * part not exists or it did not had a cursor set.
9650 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9653 * Gets a specific cursor style for an edje part.
9655 * @param obj The layout object.
9656 * @param part_name a part from loaded edje group.
9658 * @return the theme style in use, defaults to "default". If the
9659 * object does not have a cursor set, then NULL is returned.
9663 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9666 * Sets if the cursor set should be searched on the theme or should use
9667 * the provided by the engine, only.
9669 * @note before you set if should look on theme you should define a
9670 * cursor with elm_layout_part_cursor_set(). By default it will only
9671 * look for cursors provided by the engine.
9673 * @param obj The layout object.
9674 * @param part_name a part from loaded edje group.
9675 * @param engine_only if cursors should be just provided by the engine
9676 * or should also search on widget's theme as well
9678 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9679 * part not exists or it did not had a cursor set.
9683 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);
9686 * Gets a specific cursor engine_only for an edje part.
9688 * @param obj The layout object.
9689 * @param part_name a part from loaded edje group.
9691 * @return whenever the cursor is just provided by engine or also from theme.
9695 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9698 * @def elm_layout_icon_set
9699 * Convienience macro to set the icon object in a layout that follows the
9700 * Elementary naming convention for its parts.
9704 #define elm_layout_icon_set(_ly, _obj) \
9707 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9708 if ((_obj)) sig = "elm,state,icon,visible"; \
9709 else sig = "elm,state,icon,hidden"; \
9710 elm_object_signal_emit((_ly), sig, "elm"); \
9714 * @def elm_layout_icon_get
9715 * Convienience macro to get the icon object from a layout that follows the
9716 * Elementary naming convention for its parts.
9720 #define elm_layout_icon_get(_ly) \
9721 elm_layout_content_get((_ly), "elm.swallow.icon")
9724 * @def elm_layout_end_set
9725 * Convienience macro to set the end object in a layout that follows the
9726 * Elementary naming convention for its parts.
9730 #define elm_layout_end_set(_ly, _obj) \
9733 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9734 if ((_obj)) sig = "elm,state,end,visible"; \
9735 else sig = "elm,state,end,hidden"; \
9736 elm_object_signal_emit((_ly), sig, "elm"); \
9740 * @def elm_layout_end_get
9741 * Convienience macro to get the end object in a layout that follows the
9742 * Elementary naming convention for its parts.
9746 #define elm_layout_end_get(_ly) \
9747 elm_layout_content_get((_ly), "elm.swallow.end")
9750 * @def elm_layout_label_set
9751 * Convienience macro to set the label in a layout that follows the
9752 * Elementary naming convention for its parts.
9755 * @deprecated use elm_object_text_* instead.
9757 #define elm_layout_label_set(_ly, _txt) \
9758 elm_layout_text_set((_ly), "elm.text", (_txt))
9761 * @def elm_layout_label_get
9762 * Convienience macro to get the label in a layout that follows the
9763 * Elementary naming convention for its parts.
9766 * @deprecated use elm_object_text_* instead.
9768 #define elm_layout_label_get(_ly) \
9769 elm_layout_text_get((_ly), "elm.text")
9771 /* smart callbacks called:
9772 * "theme,changed" - when elm theme is changed.
9776 * @defgroup Notify Notify
9778 * @image html img/widget/notify/preview-00.png
9779 * @image latex img/widget/notify/preview-00.eps
9781 * Display a container in a particular region of the parent(top, bottom,
9782 * etc. A timeout can be set to automatically hide the notify. This is so
9783 * that, after an evas_object_show() on a notify object, if a timeout was set
9784 * on it, it will @b automatically get hidden after that time.
9786 * Signals that you can add callbacks for are:
9787 * @li "timeout" - when timeout happens on notify and it's hidden
9788 * @li "block,clicked" - when a click outside of the notify happens
9790 * @ref tutorial_notify show usage of the API.
9795 * @brief Possible orient values for notify.
9797 * This values should be used in conjunction to elm_notify_orient_set() to
9798 * set the position in which the notify should appear(relative to its parent)
9799 * and in conjunction with elm_notify_orient_get() to know where the notify
9802 typedef enum _Elm_Notify_Orient
9804 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9805 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9806 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9807 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9808 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9809 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9810 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9811 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9812 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9813 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9814 } Elm_Notify_Orient;
9816 * @brief Add a new notify to the parent
9818 * @param parent The parent object
9819 * @return The new object or NULL if it cannot be created
9821 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9823 * @brief Set the content of the notify widget
9825 * @param obj The notify object
9826 * @param content The content will be filled in this notify object
9828 * Once the content object is set, a previously set one will be deleted. If
9829 * you want to keep that old content object, use the
9830 * elm_notify_content_unset() function.
9832 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9834 * @brief Unset the content of the notify widget
9836 * @param obj The notify object
9837 * @return The content that was being used
9839 * Unparent and return the content object which was set for this widget
9841 * @see elm_notify_content_set()
9843 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9845 * @brief Return the content of the notify widget
9847 * @param obj The notify object
9848 * @return The content that is being used
9850 * @see elm_notify_content_set()
9852 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9854 * @brief Set the notify parent
9856 * @param obj The notify object
9857 * @param content The new parent
9859 * Once the parent object is set, a previously set one will be disconnected
9862 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9864 * @brief Get the notify parent
9866 * @param obj The notify object
9867 * @return The parent
9869 * @see elm_notify_parent_set()
9871 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9873 * @brief Set the orientation
9875 * @param obj The notify object
9876 * @param orient The new orientation
9878 * Sets the position in which the notify will appear in its parent.
9880 * @see @ref Elm_Notify_Orient for possible values.
9882 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9884 * @brief Return the orientation
9885 * @param obj The notify object
9886 * @return The orientation of the notification
9888 * @see elm_notify_orient_set()
9889 * @see Elm_Notify_Orient
9891 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9893 * @brief Set the time interval after which the notify window is going to be
9896 * @param obj The notify object
9897 * @param time The timeout in seconds
9899 * This function sets a timeout and starts the timer controlling when the
9900 * notify is hidden. Since calling evas_object_show() on a notify restarts
9901 * the timer controlling when the notify is hidden, setting this before the
9902 * notify is shown will in effect mean starting the timer when the notify is
9905 * @note Set a value <= 0.0 to disable a running timer.
9907 * @note If the value > 0.0 and the notify is previously visible, the
9908 * timer will be started with this value, canceling any running timer.
9910 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
9912 * @brief Return the timeout value (in seconds)
9913 * @param obj the notify object
9915 * @see elm_notify_timeout_set()
9917 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9919 * @brief Sets whether events should be passed to by a click outside
9922 * @param obj The notify object
9923 * @param repeats EINA_TRUE Events are repeats, else no
9925 * When true if the user clicks outside the window the events will be caught
9926 * by the others widgets, else the events are blocked.
9928 * @note The default value is EINA_TRUE.
9930 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
9932 * @brief Return true if events are repeat below the notify object
9933 * @param obj the notify object
9935 * @see elm_notify_repeat_events_set()
9937 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9943 * @defgroup Hover Hover
9945 * @image html img/widget/hover/preview-00.png
9946 * @image latex img/widget/hover/preview-00.eps
9948 * A Hover object will hover over its @p parent object at the @p target
9949 * location. Anything in the background will be given a darker coloring to
9950 * indicate that the hover object is on top (at the default theme). When the
9951 * hover is clicked it is dismissed(hidden), if the contents of the hover are
9952 * clicked that @b doesn't cause the hover to be dismissed.
9954 * @note The hover object will take up the entire space of @p target
9957 * Elementary has the following styles for the hover widget:
9961 * @li hoversel_vertical
9963 * The following are the available position for content:
9975 * Signals that you can add callbacks for are:
9976 * @li "clicked" - the user clicked the empty space in the hover to dismiss
9977 * @li "smart,changed" - a content object placed under the "smart"
9978 * policy was replaced to a new slot direction.
9980 * See @ref tutorial_hover for more information.
9984 typedef enum _Elm_Hover_Axis
9986 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
9987 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
9988 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
9989 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
9992 * @brief Adds a hover object to @p parent
9994 * @param parent The parent object
9995 * @return The hover object or NULL if one could not be created
9997 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9999 * @brief Sets the target object for the hover.
10001 * @param obj The hover object
10002 * @param target The object to center the hover onto. The hover
10004 * This function will cause the hover to be centered on the target object.
10006 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10008 * @brief Gets the target object for the hover.
10010 * @param obj The hover object
10011 * @param parent The object to locate the hover over.
10013 * @see elm_hover_target_set()
10015 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10017 * @brief Sets the parent object for the hover.
10019 * @param obj The hover object
10020 * @param parent The object to locate the hover over.
10022 * This function will cause the hover to take up the entire space that the
10023 * parent object fills.
10025 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10027 * @brief Gets the parent object for the hover.
10029 * @param obj The hover object
10030 * @return The parent object to locate the hover over.
10032 * @see elm_hover_parent_set()
10034 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10036 * @brief Sets the content of the hover object and the direction in which it
10039 * @param obj The hover object
10040 * @param swallow The direction that the object will be displayed
10041 * at. Accepted values are "left", "top-left", "top", "top-right",
10042 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10044 * @param content The content to place at @p swallow
10046 * Once the content object is set for a given direction, a previously
10047 * set one (on the same direction) will be deleted. If you want to
10048 * keep that old content object, use the elm_hover_content_unset()
10051 * All directions may have contents at the same time, except for
10052 * "smart". This is a special placement hint and its use case
10053 * independs of the calculations coming from
10054 * elm_hover_best_content_location_get(). Its use is for cases when
10055 * one desires only one hover content, but with a dinamic special
10056 * placement within the hover area. The content's geometry, whenever
10057 * it changes, will be used to decide on a best location not
10058 * extrapolating the hover's parent object view to show it in (still
10059 * being the hover's target determinant of its medium part -- move and
10060 * resize it to simulate finger sizes, for example). If one of the
10061 * directions other than "smart" are used, a previously content set
10062 * using it will be deleted, and vice-versa.
10064 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10066 * @brief Get the content of the hover object, in a given direction.
10068 * Return the content object which was set for this widget in the
10069 * @p swallow direction.
10071 * @param obj The hover object
10072 * @param swallow The direction that the object was display at.
10073 * @return The content that was being used
10075 * @see elm_hover_content_set()
10077 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10079 * @brief Unset the content of the hover object, in a given direction.
10081 * Unparent and return the content object set at @p swallow direction.
10083 * @param obj The hover object
10084 * @param swallow The direction that the object was display at.
10085 * @return The content that was being used.
10087 * @see elm_hover_content_set()
10089 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10091 * @brief Returns the best swallow location for content in the hover.
10093 * @param obj The hover object
10094 * @param pref_axis The preferred orientation axis for the hover object to use
10095 * @return The edje location to place content into the hover or @c
10098 * Best is defined here as the location at which there is the most available
10101 * @p pref_axis may be one of
10102 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10103 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10104 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10105 * - @c ELM_HOVER_AXIS_BOTH -- both
10107 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10108 * nescessarily be along the horizontal axis("left" or "right"). If
10109 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10110 * be along the vertical axis("top" or "bottom"). Chossing
10111 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10112 * returned position may be in either axis.
10114 * @see elm_hover_content_set()
10116 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10123 * @defgroup Entry Entry
10125 * @image html img/widget/entry/preview-00.png
10126 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10127 * @image html img/widget/entry/preview-01.png
10128 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10129 * @image html img/widget/entry/preview-02.png
10130 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10131 * @image html img/widget/entry/preview-03.png
10132 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10134 * An entry is a convenience widget which shows a box that the user can
10135 * enter text into. Entries by default don't scroll, so they grow to
10136 * accomodate the entire text, resizing the parent window as needed. This
10137 * can be changed with the elm_entry_scrollable_set() function.
10139 * They can also be single line or multi line (the default) and when set
10140 * to multi line mode they support text wrapping in any of the modes
10141 * indicated by #Elm_Wrap_Type.
10143 * Other features include password mode, filtering of inserted text with
10144 * elm_entry_text_filter_append() and related functions, inline "items" and
10145 * formatted markup text.
10147 * @section entry-markup Formatted text
10149 * The markup tags supported by the Entry are defined by the theme, but
10150 * even when writing new themes or extensions it's a good idea to stick to
10151 * a sane default, to maintain coherency and avoid application breakages.
10152 * Currently defined by the default theme are the following tags:
10153 * @li \<br\>: Inserts a line break.
10154 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10156 * @li \<tab\>: Inserts a tab.
10157 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10159 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10160 * @li \<link\>...\</link\>: Underlines the enclosed text.
10161 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10163 * @section entry-special Special markups
10165 * Besides those used to format text, entries support two special markup
10166 * tags used to insert clickable portions of text or items inlined within
10169 * @subsection entry-anchors Anchors
10171 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10172 * \</a\> tags and an event will be generated when this text is clicked,
10176 * This text is outside <a href=anc-01>but this one is an anchor</a>
10179 * The @c href attribute in the opening tag gives the name that will be
10180 * used to identify the anchor and it can be any valid utf8 string.
10182 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10183 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10184 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10185 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10188 * @subsection entry-items Items
10190 * Inlined in the text, any other @c Evas_Object can be inserted by using
10191 * \<item\> tags this way:
10194 * <item size=16x16 vsize=full href=emoticon/haha></item>
10197 * Just like with anchors, the @c href identifies each item, but these need,
10198 * in addition, to indicate their size, which is done using any one of
10199 * @c size, @c absize or @c relsize attributes. These attributes take their
10200 * value in the WxH format, where W is the width and H the height of the
10203 * @li absize: Absolute pixel size for the item. Whatever value is set will
10204 * be the item's size regardless of any scale value the object may have
10205 * been set to. The final line height will be adjusted to fit larger items.
10206 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10208 * @li relsize: Size is adjusted for the item to fit within the current
10211 * Besides their size, items are specificed a @c vsize value that affects
10212 * how their final size and position are calculated. The possible values
10214 * @li ascent: Item will be placed within the line's baseline and its
10215 * ascent. That is, the height between the line where all characters are
10216 * positioned and the highest point in the line. For @c size and @c absize
10217 * items, the descent value will be added to the total line height to make
10218 * them fit. @c relsize items will be adjusted to fit within this space.
10219 * @li full: Items will be placed between the descent and ascent, or the
10220 * lowest point in the line and its highest.
10222 * The next image shows different configurations of items and how they
10223 * are the previously mentioned options affect their sizes. In all cases,
10224 * the green line indicates the ascent, blue for the baseline and red for
10227 * @image html entry_item.png
10228 * @image latex entry_item.eps width=\textwidth
10230 * And another one to show how size differs from absize. In the first one,
10231 * the scale value is set to 1.0, while the second one is using one of 2.0.
10233 * @image html entry_item_scale.png
10234 * @image latex entry_item_scale.eps width=\textwidth
10236 * After the size for an item is calculated, the entry will request an
10237 * object to place in its space. For this, the functions set with
10238 * elm_entry_item_provider_append() and related functions will be called
10239 * in order until one of them returns a @c non-NULL value. If no providers
10240 * are available, or all of them return @c NULL, then the entry falls back
10241 * to one of the internal defaults, provided the name matches with one of
10244 * All of the following are currently supported:
10247 * - emoticon/angry-shout
10248 * - emoticon/crazy-laugh
10249 * - emoticon/evil-laugh
10251 * - emoticon/goggle-smile
10252 * - emoticon/grumpy
10253 * - emoticon/grumpy-smile
10254 * - emoticon/guilty
10255 * - emoticon/guilty-smile
10257 * - emoticon/half-smile
10258 * - emoticon/happy-panting
10260 * - emoticon/indifferent
10262 * - emoticon/knowing-grin
10264 * - emoticon/little-bit-sorry
10265 * - emoticon/love-lots
10267 * - emoticon/minimal-smile
10268 * - emoticon/not-happy
10269 * - emoticon/not-impressed
10271 * - emoticon/opensmile
10274 * - emoticon/squint-laugh
10275 * - emoticon/surprised
10276 * - emoticon/suspicious
10277 * - emoticon/tongue-dangling
10278 * - emoticon/tongue-poke
10280 * - emoticon/unhappy
10281 * - emoticon/very-sorry
10284 * - emoticon/worried
10287 * Alternatively, an item may reference an image by its path, using
10288 * the URI form @c file:///path/to/an/image.png and the entry will then
10289 * use that image for the item.
10291 * @section entry-files Loading and saving files
10293 * Entries have convinience functions to load text from a file and save
10294 * changes back to it after a short delay. The automatic saving is enabled
10295 * by default, but can be disabled with elm_entry_autosave_set() and files
10296 * can be loaded directly as plain text or have any markup in them
10297 * recognized. See elm_entry_file_set() for more details.
10299 * @section entry-signals Emitted signals
10301 * This widget emits the following signals:
10303 * @li "changed": The text within the entry was changed.
10304 * @li "changed,user": The text within the entry was changed because of user interaction.
10305 * @li "activated": The enter key was pressed on a single line entry.
10306 * @li "press": A mouse button has been pressed on the entry.
10307 * @li "longpressed": A mouse button has been pressed and held for a couple
10309 * @li "clicked": The entry has been clicked (mouse press and release).
10310 * @li "clicked,double": The entry has been double clicked.
10311 * @li "clicked,triple": The entry has been triple clicked.
10312 * @li "focused": The entry has received focus.
10313 * @li "unfocused": The entry has lost focus.
10314 * @li "selection,paste": A paste of the clipboard contents was requested.
10315 * @li "selection,copy": A copy of the selected text into the clipboard was
10317 * @li "selection,cut": A cut of the selected text into the clipboard was
10319 * @li "selection,start": A selection has begun and no previous selection
10321 * @li "selection,changed": The current selection has changed.
10322 * @li "selection,cleared": The current selection has been cleared.
10323 * @li "cursor,changed": The cursor has changed position.
10324 * @li "anchor,clicked": An anchor has been clicked. The event_info
10325 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10326 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10327 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10328 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10329 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10330 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10331 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10332 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10333 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10334 * @li "preedit,changed": The preedit string has changed.
10336 * @section entry-examples
10338 * An overview of the Entry API can be seen in @ref entry_example_01
10343 * @typedef Elm_Entry_Anchor_Info
10345 * The info sent in the callback for the "anchor,clicked" signals emitted
10348 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10350 * @struct _Elm_Entry_Anchor_Info
10352 * The info sent in the callback for the "anchor,clicked" signals emitted
10355 struct _Elm_Entry_Anchor_Info
10357 const char *name; /**< The name of the anchor, as stated in its href */
10358 int button; /**< The mouse button used to click on it */
10359 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10360 y, /**< Anchor geometry, relative to canvas */
10361 w, /**< Anchor geometry, relative to canvas */
10362 h; /**< Anchor geometry, relative to canvas */
10365 * @typedef Elm_Entry_Filter_Cb
10366 * This callback type is used by entry filters to modify text.
10367 * @param data The data specified as the last param when adding the filter
10368 * @param entry The entry object
10369 * @param text A pointer to the location of the text being filtered. This data can be modified,
10370 * but any additional allocations must be managed by the user.
10371 * @see elm_entry_text_filter_append
10372 * @see elm_entry_text_filter_prepend
10374 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10377 * This adds an entry to @p parent object.
10379 * By default, entries are:
10383 * @li autosave is enabled
10385 * @param parent The parent object
10386 * @return The new object or NULL if it cannot be created
10388 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10390 * Sets the entry to single line mode.
10392 * In single line mode, entries don't ever wrap when the text reaches the
10393 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10394 * key will generate an @c "activate" event instead of adding a new line.
10396 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10397 * and pressing enter will break the text into a different line
10398 * without generating any events.
10400 * @param obj The entry object
10401 * @param single_line If true, the text in the entry
10402 * will be on a single line.
10404 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10406 * Gets whether the entry is set to be single line.
10408 * @param obj The entry object
10409 * @return single_line If true, the text in the entry is set to display
10410 * on a single line.
10412 * @see elm_entry_single_line_set()
10414 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10416 * Sets the entry to password mode.
10418 * In password mode, entries are implicitly single line and the display of
10419 * any text in them is replaced with asterisks (*).
10421 * @param obj The entry object
10422 * @param password If true, password mode is enabled.
10424 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10426 * Gets whether the entry is set to password mode.
10428 * @param obj The entry object
10429 * @return If true, the entry is set to display all characters
10430 * as asterisks (*).
10432 * @see elm_entry_password_set()
10434 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10436 * This sets the text displayed within the entry to @p entry.
10438 * @param obj The entry object
10439 * @param entry The text to be displayed
10441 * @deprecated Use elm_object_text_set() instead.
10443 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10445 * This returns the text currently shown in object @p entry.
10446 * See also elm_entry_entry_set().
10448 * @param obj The entry object
10449 * @return The currently displayed text or NULL on failure
10451 * @deprecated Use elm_object_text_get() instead.
10453 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10455 * Appends @p entry to the text of the entry.
10457 * Adds the text in @p entry to the end of any text already present in the
10460 * The appended text is subject to any filters set for the widget.
10462 * @param obj The entry object
10463 * @param entry The text to be displayed
10465 * @see elm_entry_text_filter_append()
10467 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10469 * Gets whether the entry is empty.
10471 * Empty means no text at all. If there are any markup tags, like an item
10472 * tag for which no provider finds anything, and no text is displayed, this
10473 * function still returns EINA_FALSE.
10475 * @param obj The entry object
10476 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10478 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10480 * Gets any selected text within the entry.
10482 * If there's any selected text in the entry, this function returns it as
10483 * a string in markup format. NULL is returned if no selection exists or
10484 * if an error occurred.
10486 * The returned value points to an internal string and should not be freed
10487 * or modified in any way. If the @p entry object is deleted or its
10488 * contents are changed, the returned pointer should be considered invalid.
10490 * @param obj The entry object
10491 * @return The selected text within the entry or NULL on failure
10493 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10495 * Inserts the given text into the entry at the current cursor position.
10497 * This inserts text at the cursor position as if it was typed
10498 * by the user (note that this also allows markup which a user
10499 * can't just "type" as it would be converted to escaped text, so this
10500 * call can be used to insert things like emoticon items or bold push/pop
10501 * tags, other font and color change tags etc.)
10503 * If any selection exists, it will be replaced by the inserted text.
10505 * The inserted text is subject to any filters set for the widget.
10507 * @param obj The entry object
10508 * @param entry The text to insert
10510 * @see elm_entry_text_filter_append()
10512 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10514 * Set the line wrap type to use on multi-line entries.
10516 * Sets the wrap type used by the entry to any of the specified in
10517 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10518 * line (without inserting a line break or paragraph separator) when it
10519 * reaches the far edge of the widget.
10521 * Note that this only makes sense for multi-line entries. A widget set
10522 * to be single line will never wrap.
10524 * @param obj The entry object
10525 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10527 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10529 * Gets the wrap mode the entry was set to use.
10531 * @param obj The entry object
10532 * @return Wrap type
10534 * @see also elm_entry_line_wrap_set()
10536 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10538 * Sets if the entry is to be editable or not.
10540 * By default, entries are editable and when focused, any text input by the
10541 * user will be inserted at the current cursor position. But calling this
10542 * function with @p editable as EINA_FALSE will prevent the user from
10543 * inputting text into the entry.
10545 * The only way to change the text of a non-editable entry is to use
10546 * elm_object_text_set(), elm_entry_entry_insert() and other related
10549 * @param obj The entry object
10550 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10551 * if not, the entry is read-only and no user input is allowed.
10553 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10555 * Gets whether the entry is editable or not.
10557 * @param obj The entry object
10558 * @return If true, the entry is editable by the user.
10559 * If false, it is not editable by the user
10561 * @see elm_entry_editable_set()
10563 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10565 * This drops any existing text selection within the entry.
10567 * @param obj The entry object
10569 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10571 * This selects all text within the entry.
10573 * @param obj The entry object
10575 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10577 * This moves the cursor one place to the right within the entry.
10579 * @param obj The entry object
10580 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10582 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10584 * This moves the cursor one place to the left within the entry.
10586 * @param obj The entry object
10587 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10589 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10591 * This moves the cursor one line up within the entry.
10593 * @param obj The entry object
10594 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10596 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10598 * This moves the cursor one line down within the entry.
10600 * @param obj The entry object
10601 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10603 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10605 * This moves the cursor to the beginning of the entry.
10607 * @param obj The entry object
10609 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10611 * This moves the cursor to the end of the entry.
10613 * @param obj The entry object
10615 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10617 * This moves the cursor to the beginning of the current line.
10619 * @param obj The entry object
10621 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10623 * This moves the cursor to the end of the current line.
10625 * @param obj The entry object
10627 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10629 * This begins a selection within the entry as though
10630 * the user were holding down the mouse button to make a selection.
10632 * @param obj The entry object
10634 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10636 * This ends a selection within the entry as though
10637 * the user had just released the mouse button while making a selection.
10639 * @param obj The entry object
10641 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10643 * Gets whether a format node exists at the current cursor position.
10645 * A format node is anything that defines how the text is rendered. It can
10646 * be a visible format node, such as a line break or a paragraph separator,
10647 * or an invisible one, such as bold begin or end tag.
10648 * This function returns whether any format node exists at the current
10651 * @param obj The entry object
10652 * @return EINA_TRUE if the current cursor position contains a format node,
10653 * EINA_FALSE otherwise.
10655 * @see elm_entry_cursor_is_visible_format_get()
10657 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10659 * Gets if the current cursor position holds a visible format node.
10661 * @param obj The entry object
10662 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10663 * if it's an invisible one or no format exists.
10665 * @see elm_entry_cursor_is_format_get()
10667 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10669 * Gets the character pointed by the cursor at its current position.
10671 * This function returns a string with the utf8 character stored at the
10672 * current cursor position.
10673 * Only the text is returned, any format that may exist will not be part
10674 * of the return value.
10676 * @param obj The entry object
10677 * @return The text pointed by the cursors.
10679 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10681 * This function returns the geometry of the cursor.
10683 * It's useful if you want to draw something on the cursor (or where it is),
10684 * or for example in the case of scrolled entry where you want to show the
10687 * @param obj The entry object
10688 * @param x returned geometry
10689 * @param y returned geometry
10690 * @param w returned geometry
10691 * @param h returned geometry
10692 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10694 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);
10696 * Sets the cursor position in the entry to the given value
10698 * The value in @p pos is the index of the character position within the
10699 * contents of the string as returned by elm_entry_cursor_pos_get().
10701 * @param obj The entry object
10702 * @param pos The position of the cursor
10704 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10706 * Retrieves the current position of the cursor in the entry
10708 * @param obj The entry object
10709 * @return The cursor position
10711 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10713 * This executes a "cut" action on the selected text in the entry.
10715 * @param obj The entry object
10717 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10719 * This executes a "copy" action on the selected text in the entry.
10721 * @param obj The entry object
10723 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10725 * This executes a "paste" action in the entry.
10727 * @param obj The entry object
10729 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10731 * This clears and frees the items in a entry's contextual (longpress)
10734 * @param obj The entry object
10736 * @see elm_entry_context_menu_item_add()
10738 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10740 * This adds an item to the entry's contextual menu.
10742 * A longpress on an entry will make the contextual menu show up, if this
10743 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10744 * By default, this menu provides a few options like enabling selection mode,
10745 * which is useful on embedded devices that need to be explicit about it,
10746 * and when a selection exists it also shows the copy and cut actions.
10748 * With this function, developers can add other options to this menu to
10749 * perform any action they deem necessary.
10751 * @param obj The entry object
10752 * @param label The item's text label
10753 * @param icon_file The item's icon file
10754 * @param icon_type The item's icon type
10755 * @param func The callback to execute when the item is clicked
10756 * @param data The data to associate with the item for related functions
10758 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);
10760 * This disables the entry's contextual (longpress) menu.
10762 * @param obj The entry object
10763 * @param disabled If true, the menu is disabled
10765 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10767 * This returns whether the entry's contextual (longpress) menu is
10770 * @param obj The entry object
10771 * @return If true, the menu is disabled
10773 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10775 * This appends a custom item provider to the list for that entry
10777 * This appends the given callback. The list is walked from beginning to end
10778 * with each function called given the item href string in the text. If the
10779 * function returns an object handle other than NULL (it should create an
10780 * object to do this), then this object is used to replace that item. If
10781 * not the next provider is called until one provides an item object, or the
10782 * default provider in entry does.
10784 * @param obj The entry object
10785 * @param func The function called to provide the item object
10786 * @param data The data passed to @p func
10788 * @see @ref entry-items
10790 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);
10792 * This prepends a custom item provider to the list for that entry
10794 * This prepends the given callback. See elm_entry_item_provider_append() for
10797 * @param obj The entry object
10798 * @param func The function called to provide the item object
10799 * @param data The data passed to @p func
10801 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);
10803 * This removes a custom item provider to the list for that entry
10805 * This removes the given callback. See elm_entry_item_provider_append() for
10808 * @param obj The entry object
10809 * @param func The function called to provide the item object
10810 * @param data The data passed to @p func
10812 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);
10814 * Append a filter function for text inserted in the entry
10816 * Append the given callback to the list. This functions will be called
10817 * whenever any text is inserted into the entry, with the text to be inserted
10818 * as a parameter. The callback function is free to alter the text in any way
10819 * it wants, but it must remember to free the given pointer and update it.
10820 * If the new text is to be discarded, the function can free it and set its
10821 * text parameter to NULL. This will also prevent any following filters from
10824 * @param obj The entry object
10825 * @param func The function to use as text filter
10826 * @param data User data to pass to @p func
10828 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10830 * Prepend a filter function for text insdrted in the entry
10832 * Prepend the given callback to the list. See elm_entry_text_filter_append()
10833 * for more information
10835 * @param obj The entry object
10836 * @param func The function to use as text filter
10837 * @param data User data to pass to @p func
10839 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10841 * Remove a filter from the list
10843 * Removes the given callback from the filter list. See
10844 * elm_entry_text_filter_append() for more information.
10846 * @param obj The entry object
10847 * @param func The filter function to remove
10848 * @param data The user data passed when adding the function
10850 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10852 * This converts a markup (HTML-like) string into UTF-8.
10854 * The returned string is a malloc'ed buffer and it should be freed when
10855 * not needed anymore.
10857 * @param s The string (in markup) to be converted
10858 * @return The converted string (in UTF-8). It should be freed.
10860 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10862 * This converts a UTF-8 string into markup (HTML-like).
10864 * The returned string is a malloc'ed buffer and it should be freed when
10865 * not needed anymore.
10867 * @param s The string (in UTF-8) to be converted
10868 * @return The converted string (in markup). It should be freed.
10870 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10872 * This sets the file (and implicitly loads it) for the text to display and
10873 * then edit. All changes are written back to the file after a short delay if
10874 * the entry object is set to autosave (which is the default).
10876 * If the entry had any other file set previously, any changes made to it
10877 * will be saved if the autosave feature is enabled, otherwise, the file
10878 * will be silently discarded and any non-saved changes will be lost.
10880 * @param obj The entry object
10881 * @param file The path to the file to load and save
10882 * @param format The file format
10884 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10886 * Gets the file being edited by the entry.
10888 * This function can be used to retrieve any file set on the entry for
10889 * edition, along with the format used to load and save it.
10891 * @param obj The entry object
10892 * @param file The path to the file to load and save
10893 * @param format The file format
10895 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10897 * This function writes any changes made to the file set with
10898 * elm_entry_file_set()
10900 * @param obj The entry object
10902 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10904 * This sets the entry object to 'autosave' the loaded text file or not.
10906 * @param obj The entry object
10907 * @param autosave Autosave the loaded file or not
10909 * @see elm_entry_file_set()
10911 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
10913 * This gets the entry object's 'autosave' status.
10915 * @param obj The entry object
10916 * @return Autosave the loaded file or not
10918 * @see elm_entry_file_set()
10920 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10922 * Control pasting of text and images for the widget.
10924 * Normally the entry allows both text and images to be pasted. By setting
10925 * textonly to be true, this prevents images from being pasted.
10927 * Note this only changes the behaviour of text.
10929 * @param obj The entry object
10930 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
10931 * text+image+other.
10933 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
10935 * Getting elm_entry text paste/drop mode.
10937 * In textonly mode, only text may be pasted or dropped into the widget.
10939 * @param obj The entry object
10940 * @return If the widget only accepts text from pastes.
10942 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10944 * Enable or disable scrolling in entry
10946 * Normally the entry is not scrollable unless you enable it with this call.
10948 * @param obj The entry object
10949 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
10951 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
10953 * Get the scrollable state of the entry
10955 * Normally the entry is not scrollable. This gets the scrollable state
10956 * of the entry. See elm_entry_scrollable_set() for more information.
10958 * @param obj The entry object
10959 * @return The scrollable state
10961 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
10963 * This sets a widget to be displayed to the left of a scrolled entry.
10965 * @param obj The scrolled entry object
10966 * @param icon The widget to display on the left side of the scrolled
10969 * @note A previously set widget will be destroyed.
10970 * @note If the object being set does not have minimum size hints set,
10971 * it won't get properly displayed.
10973 * @see elm_entry_end_set()
10975 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
10977 * Gets the leftmost widget of the scrolled entry. This object is
10978 * owned by the scrolled entry and should not be modified.
10980 * @param obj The scrolled entry object
10981 * @return the left widget inside the scroller
10983 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
10985 * Unset the leftmost widget of the scrolled entry, unparenting and
10988 * @param obj The scrolled entry object
10989 * @return the previously set icon sub-object of this entry, on
10992 * @see elm_entry_icon_set()
10994 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
10996 * Sets the visibility of the left-side widget of the scrolled entry,
10997 * set by elm_entry_icon_set().
10999 * @param obj The scrolled entry object
11000 * @param setting EINA_TRUE if the object should be displayed,
11001 * EINA_FALSE if not.
11003 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11005 * This sets a widget to be displayed to the end of a scrolled entry.
11007 * @param obj The scrolled entry object
11008 * @param end The widget to display on the right side of the scrolled
11011 * @note A previously set widget will be destroyed.
11012 * @note If the object being set does not have minimum size hints set,
11013 * it won't get properly displayed.
11015 * @see elm_entry_icon_set
11017 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11019 * Gets the endmost widget of the scrolled entry. This object is owned
11020 * by the scrolled entry and should not be modified.
11022 * @param obj The scrolled entry object
11023 * @return the right widget inside the scroller
11025 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11027 * Unset the endmost widget of the scrolled entry, unparenting and
11030 * @param obj The scrolled entry object
11031 * @return the previously set icon sub-object of this entry, on
11034 * @see elm_entry_icon_set()
11036 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11038 * Sets the visibility of the end widget of the scrolled entry, set by
11039 * elm_entry_end_set().
11041 * @param obj The scrolled entry object
11042 * @param setting EINA_TRUE if the object should be displayed,
11043 * EINA_FALSE if not.
11045 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11047 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11050 * Setting an entry to single-line mode with elm_entry_single_line_set()
11051 * will automatically disable the display of scrollbars when the entry
11052 * moves inside its scroller.
11054 * @param obj The scrolled entry object
11055 * @param h The horizontal scrollbar policy to apply
11056 * @param v The vertical scrollbar policy to apply
11058 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11060 * This enables/disables bouncing within the entry.
11062 * This function sets whether the entry will bounce when scrolling reaches
11063 * the end of the contained entry.
11065 * @param obj The scrolled entry object
11066 * @param h The horizontal bounce state
11067 * @param v The vertical bounce state
11069 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11071 * Get the bounce mode
11073 * @param obj The Entry object
11074 * @param h_bounce Allow bounce horizontally
11075 * @param v_bounce Allow bounce vertically
11077 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11079 /* pre-made filters for entries */
11081 * @typedef Elm_Entry_Filter_Limit_Size
11083 * Data for the elm_entry_filter_limit_size() entry filter.
11085 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11087 * @struct _Elm_Entry_Filter_Limit_Size
11089 * Data for the elm_entry_filter_limit_size() entry filter.
11091 struct _Elm_Entry_Filter_Limit_Size
11093 int max_char_count; /**< The maximum number of characters allowed. */
11094 int max_byte_count; /**< The maximum number of bytes allowed*/
11097 * Filter inserted text based on user defined character and byte limits
11099 * Add this filter to an entry to limit the characters that it will accept
11100 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11101 * The funtion works on the UTF-8 representation of the string, converting
11102 * it from the set markup, thus not accounting for any format in it.
11104 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11105 * it as data when setting the filter. In it, it's possible to set limits
11106 * by character count or bytes (any of them is disabled if 0), and both can
11107 * be set at the same time. In that case, it first checks for characters,
11110 * The function will cut the inserted text in order to allow only the first
11111 * number of characters that are still allowed. The cut is made in
11112 * characters, even when limiting by bytes, in order to always contain
11113 * valid ones and avoid half unicode characters making it in.
11115 * This filter, like any others, does not apply when setting the entry text
11116 * directly with elm_object_text_set() (or the deprecated
11117 * elm_entry_entry_set()).
11119 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11121 * @typedef Elm_Entry_Filter_Accept_Set
11123 * Data for the elm_entry_filter_accept_set() entry filter.
11125 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11127 * @struct _Elm_Entry_Filter_Accept_Set
11129 * Data for the elm_entry_filter_accept_set() entry filter.
11131 struct _Elm_Entry_Filter_Accept_Set
11133 const char *accepted; /**< Set of characters accepted in the entry. */
11134 const char *rejected; /**< Set of characters rejected from the entry. */
11137 * Filter inserted text based on accepted or rejected sets of characters
11139 * Add this filter to an entry to restrict the set of accepted characters
11140 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11141 * This structure contains both accepted and rejected sets, but they are
11142 * mutually exclusive.
11144 * The @c accepted set takes preference, so if it is set, the filter will
11145 * only work based on the accepted characters, ignoring anything in the
11146 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11148 * In both cases, the function filters by matching utf8 characters to the
11149 * raw markup text, so it can be used to remove formatting tags.
11151 * This filter, like any others, does not apply when setting the entry text
11152 * directly with elm_object_text_set() (or the deprecated
11153 * elm_entry_entry_set()).
11155 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11160 /* composite widgets - these basically put together basic widgets above
11161 * in convenient packages that do more than basic stuff */
11165 * @defgroup Anchorview Anchorview
11167 * @image html img/widget/anchorview/preview-00.png
11168 * @image latex img/widget/anchorview/preview-00.eps
11170 * Anchorview is for displaying text that contains markup with anchors
11171 * like <c>\<a href=1234\>something\</\></c> in it.
11173 * Besides being styled differently, the anchorview widget provides the
11174 * necessary functionality so that clicking on these anchors brings up a
11175 * popup with user defined content such as "call", "add to contacts" or
11176 * "open web page". This popup is provided using the @ref Hover widget.
11178 * This widget is very similar to @ref Anchorblock, so refer to that
11179 * widget for an example. The only difference Anchorview has is that the
11180 * widget is already provided with scrolling functionality, so if the
11181 * text set to it is too large to fit in the given space, it will scroll,
11182 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11183 * text can be displayed.
11185 * This widget emits the following signals:
11186 * @li "anchor,clicked": will be called when an anchor is clicked. The
11187 * @p event_info parameter on the callback will be a pointer of type
11188 * ::Elm_Entry_Anchorview_Info.
11190 * See @ref Anchorblock for an example on how to use both of them.
11199 * @typedef Elm_Entry_Anchorview_Info
11201 * The info sent in the callback for "anchor,clicked" signals emitted by
11202 * the Anchorview widget.
11204 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11206 * @struct _Elm_Entry_Anchorview_Info
11208 * The info sent in the callback for "anchor,clicked" signals emitted by
11209 * the Anchorview widget.
11211 struct _Elm_Entry_Anchorview_Info
11213 const char *name; /**< Name of the anchor, as indicated in its href
11215 int button; /**< The mouse button used to click on it */
11216 Evas_Object *hover; /**< The hover object to use for the popup */
11218 Evas_Coord x, y, w, h;
11219 } anchor, /**< Geometry selection of text used as anchor */
11220 hover_parent; /**< Geometry of the object used as parent by the
11222 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11223 for content on the left side of
11224 the hover. Before calling the
11225 callback, the widget will make the
11226 necessary calculations to check
11227 which sides are fit to be set with
11228 content, based on the position the
11229 hover is activated and its distance
11230 to the edges of its parent object
11232 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11233 the right side of the hover.
11234 See @ref hover_left */
11235 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11236 of the hover. See @ref hover_left */
11237 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11238 below the hover. See @ref
11242 * Add a new Anchorview object
11244 * @param parent The parent object
11245 * @return The new object or NULL if it cannot be created
11247 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11249 * Set the text to show in the anchorview
11251 * Sets the text of the anchorview to @p text. This text can include markup
11252 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11253 * text that will be specially styled and react to click events, ended with
11254 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11255 * "anchor,clicked" signal that you can attach a callback to with
11256 * evas_object_smart_callback_add(). The name of the anchor given in the
11257 * event info struct will be the one set in the href attribute, in this
11258 * case, anchorname.
11260 * Other markup can be used to style the text in different ways, but it's
11261 * up to the style defined in the theme which tags do what.
11262 * @deprecated use elm_object_text_set() instead.
11264 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11266 * Get the markup text set for the anchorview
11268 * Retrieves the text set on the anchorview, with markup tags included.
11270 * @param obj The anchorview object
11271 * @return The markup text set or @c NULL if nothing was set or an error
11273 * @deprecated use elm_object_text_set() instead.
11275 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11277 * Set the parent of the hover popup
11279 * Sets the parent object to use by the hover created by the anchorview
11280 * when an anchor is clicked. See @ref Hover for more details on this.
11281 * If no parent is set, the same anchorview object will be used.
11283 * @param obj The anchorview object
11284 * @param parent The object to use as parent for the hover
11286 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11288 * Get the parent of the hover popup
11290 * Get the object used as parent for the hover created by the anchorview
11291 * widget. See @ref Hover for more details on this.
11293 * @param obj The anchorview object
11294 * @return The object used as parent for the hover, NULL if none is set.
11296 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11298 * Set the style that the hover should use
11300 * When creating the popup hover, anchorview will request that it's
11301 * themed according to @p style.
11303 * @param obj The anchorview object
11304 * @param style The style to use for the underlying hover
11306 * @see elm_object_style_set()
11308 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11310 * Get the style that the hover should use
11312 * Get the style the hover created by anchorview will use.
11314 * @param obj The anchorview object
11315 * @return The style to use by the hover. NULL means the default is used.
11317 * @see elm_object_style_set()
11319 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11321 * Ends the hover popup in the anchorview
11323 * When an anchor is clicked, the anchorview widget will create a hover
11324 * object to use as a popup with user provided content. This function
11325 * terminates this popup, returning the anchorview to its normal state.
11327 * @param obj The anchorview object
11329 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11331 * Set bouncing behaviour when the scrolled content reaches an edge
11333 * Tell the internal scroller object whether it should bounce or not
11334 * when it reaches the respective edges for each axis.
11336 * @param obj The anchorview object
11337 * @param h_bounce Whether to bounce or not in the horizontal axis
11338 * @param v_bounce Whether to bounce or not in the vertical axis
11340 * @see elm_scroller_bounce_set()
11342 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11344 * Get the set bouncing behaviour of the internal scroller
11346 * Get whether the internal scroller should bounce when the edge of each
11347 * axis is reached scrolling.
11349 * @param obj The anchorview object
11350 * @param h_bounce Pointer where to store the bounce state of the horizontal
11352 * @param v_bounce Pointer where to store the bounce state of the vertical
11355 * @see elm_scroller_bounce_get()
11357 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11359 * Appends a custom item provider to the given anchorview
11361 * Appends the given function to the list of items providers. This list is
11362 * called, one function at a time, with the given @p data pointer, the
11363 * anchorview object and, in the @p item parameter, the item name as
11364 * referenced in its href string. Following functions in the list will be
11365 * called in order until one of them returns something different to NULL,
11366 * which should be an Evas_Object which will be used in place of the item
11369 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11370 * href=item/name\>\</item\>
11372 * @param obj The anchorview object
11373 * @param func The function to add to the list of providers
11374 * @param data User data that will be passed to the callback function
11376 * @see elm_entry_item_provider_append()
11378 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);
11380 * Prepend a custom item provider to the given anchorview
11382 * Like elm_anchorview_item_provider_append(), but it adds the function
11383 * @p func to the beginning of the list, instead of the end.
11385 * @param obj The anchorview object
11386 * @param func The function to add to the list of providers
11387 * @param data User data that will be passed to the callback function
11389 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);
11391 * Remove a custom item provider from the list of the given anchorview
11393 * Removes the function and data pairing that matches @p func and @p data.
11394 * That is, unless the same function and same user data are given, the
11395 * function will not be removed from the list. This allows us to add the
11396 * same callback several times, with different @p data pointers and be
11397 * able to remove them later without conflicts.
11399 * @param obj The anchorview object
11400 * @param func The function to remove from the list
11401 * @param data The data matching the function to remove from the list
11403 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);
11410 * @defgroup Anchorblock Anchorblock
11412 * @image html img/widget/anchorblock/preview-00.png
11413 * @image latex img/widget/anchorblock/preview-00.eps
11415 * Anchorblock is for displaying text that contains markup with anchors
11416 * like <c>\<a href=1234\>something\</\></c> in it.
11418 * Besides being styled differently, the anchorblock widget provides the
11419 * necessary functionality so that clicking on these anchors brings up a
11420 * popup with user defined content such as "call", "add to contacts" or
11421 * "open web page". This popup is provided using the @ref Hover widget.
11423 * This widget emits the following signals:
11424 * @li "anchor,clicked": will be called when an anchor is clicked. The
11425 * @p event_info parameter on the callback will be a pointer of type
11426 * ::Elm_Entry_Anchorblock_Info.
11432 * Since examples are usually better than plain words, we might as well
11433 * try @ref tutorial_anchorblock_example "one".
11436 * @addtogroup Anchorblock
11440 * @typedef Elm_Entry_Anchorblock_Info
11442 * The info sent in the callback for "anchor,clicked" signals emitted by
11443 * the Anchorblock widget.
11445 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11447 * @struct _Elm_Entry_Anchorblock_Info
11449 * The info sent in the callback for "anchor,clicked" signals emitted by
11450 * the Anchorblock widget.
11452 struct _Elm_Entry_Anchorblock_Info
11454 const char *name; /**< Name of the anchor, as indicated in its href
11456 int button; /**< The mouse button used to click on it */
11457 Evas_Object *hover; /**< The hover object to use for the popup */
11459 Evas_Coord x, y, w, h;
11460 } anchor, /**< Geometry selection of text used as anchor */
11461 hover_parent; /**< Geometry of the object used as parent by the
11463 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11464 for content on the left side of
11465 the hover. Before calling the
11466 callback, the widget will make the
11467 necessary calculations to check
11468 which sides are fit to be set with
11469 content, based on the position the
11470 hover is activated and its distance
11471 to the edges of its parent object
11473 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11474 the right side of the hover.
11475 See @ref hover_left */
11476 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11477 of the hover. See @ref hover_left */
11478 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11479 below the hover. See @ref
11483 * Add a new Anchorblock object
11485 * @param parent The parent object
11486 * @return The new object or NULL if it cannot be created
11488 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11490 * Set the text to show in the anchorblock
11492 * Sets the text of the anchorblock to @p text. This text can include markup
11493 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11494 * of text that will be specially styled and react to click events, ended
11495 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11496 * "anchor,clicked" signal that you can attach a callback to with
11497 * evas_object_smart_callback_add(). The name of the anchor given in the
11498 * event info struct will be the one set in the href attribute, in this
11499 * case, anchorname.
11501 * Other markup can be used to style the text in different ways, but it's
11502 * up to the style defined in the theme which tags do what.
11503 * @deprecated use elm_object_text_set() instead.
11505 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11507 * Get the markup text set for the anchorblock
11509 * Retrieves the text set on the anchorblock, with markup tags included.
11511 * @param obj The anchorblock object
11512 * @return The markup text set or @c NULL if nothing was set or an error
11514 * @deprecated use elm_object_text_set() instead.
11516 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11518 * Set the parent of the hover popup
11520 * Sets the parent object to use by the hover created by the anchorblock
11521 * when an anchor is clicked. See @ref Hover for more details on this.
11523 * @param obj The anchorblock object
11524 * @param parent The object to use as parent for the hover
11526 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11528 * Get the parent of the hover popup
11530 * Get the object used as parent for the hover created by the anchorblock
11531 * widget. See @ref Hover for more details on this.
11532 * If no parent is set, the same anchorblock object will be used.
11534 * @param obj The anchorblock object
11535 * @return The object used as parent for the hover, NULL if none is set.
11537 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11539 * Set the style that the hover should use
11541 * When creating the popup hover, anchorblock will request that it's
11542 * themed according to @p style.
11544 * @param obj The anchorblock object
11545 * @param style The style to use for the underlying hover
11547 * @see elm_object_style_set()
11549 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11551 * Get the style that the hover should use
11553 * Get the style the hover created by anchorblock will use.
11555 * @param obj The anchorblock object
11556 * @return The style to use by the hover. NULL means the default is used.
11558 * @see elm_object_style_set()
11560 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11562 * Ends the hover popup in the anchorblock
11564 * When an anchor is clicked, the anchorblock widget will create a hover
11565 * object to use as a popup with user provided content. This function
11566 * terminates this popup, returning the anchorblock to its normal state.
11568 * @param obj The anchorblock object
11570 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11572 * Appends a custom item provider to the given anchorblock
11574 * Appends the given function to the list of items providers. This list is
11575 * called, one function at a time, with the given @p data pointer, the
11576 * anchorblock object and, in the @p item parameter, the item name as
11577 * referenced in its href string. Following functions in the list will be
11578 * called in order until one of them returns something different to NULL,
11579 * which should be an Evas_Object which will be used in place of the item
11582 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11583 * href=item/name\>\</item\>
11585 * @param obj The anchorblock object
11586 * @param func The function to add to the list of providers
11587 * @param data User data that will be passed to the callback function
11589 * @see elm_entry_item_provider_append()
11591 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);
11593 * Prepend a custom item provider to the given anchorblock
11595 * Like elm_anchorblock_item_provider_append(), but it adds the function
11596 * @p func to the beginning of the list, instead of the end.
11598 * @param obj The anchorblock object
11599 * @param func The function to add to the list of providers
11600 * @param data User data that will be passed to the callback function
11602 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);
11604 * Remove a custom item provider from the list of the given anchorblock
11606 * Removes the function and data pairing that matches @p func and @p data.
11607 * That is, unless the same function and same user data are given, the
11608 * function will not be removed from the list. This allows us to add the
11609 * same callback several times, with different @p data pointers and be
11610 * able to remove them later without conflicts.
11612 * @param obj The anchorblock object
11613 * @param func The function to remove from the list
11614 * @param data The data matching the function to remove from the list
11616 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);
11622 * @defgroup Bubble Bubble
11624 * @image html img/widget/bubble/preview-00.png
11625 * @image latex img/widget/bubble/preview-00.eps
11626 * @image html img/widget/bubble/preview-01.png
11627 * @image latex img/widget/bubble/preview-01.eps
11628 * @image html img/widget/bubble/preview-02.png
11629 * @image latex img/widget/bubble/preview-02.eps
11631 * @brief The Bubble is a widget to show text similarly to how speech is
11632 * represented in comics.
11634 * The bubble widget contains 5 important visual elements:
11635 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11636 * @li The @p icon is an image to which the frame's arrow points to.
11637 * @li The @p label is a text which appears to the right of the icon if the
11638 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11640 * @li The @p info is a text which appears to the right of the label. Info's
11641 * font is of a ligther color than label.
11642 * @li The @p content is an evas object that is shown inside the frame.
11644 * The position of the arrow, icon, label and info depends on which corner is
11645 * selected. The four available corners are:
11646 * @li "top_left" - Default
11648 * @li "bottom_left"
11649 * @li "bottom_right"
11651 * Signals that you can add callbacks for are:
11652 * @li "clicked" - This is called when a user has clicked the bubble.
11654 * For an example of using a buble see @ref bubble_01_example_page "this".
11659 * Add a new bubble to the parent
11661 * @param parent The parent object
11662 * @return The new object or NULL if it cannot be created
11664 * This function adds a text bubble to the given parent evas object.
11666 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11668 * Set the label of the bubble
11670 * @param obj The bubble object
11671 * @param label The string to set in the label
11673 * This function sets the title of the bubble. Where this appears depends on
11674 * the selected corner.
11675 * @deprecated use elm_object_text_set() instead.
11677 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11679 * Get the label of the bubble
11681 * @param obj The bubble object
11682 * @return The string of set in the label
11684 * This function gets the title of the bubble.
11685 * @deprecated use elm_object_text_get() instead.
11687 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11689 * Set the info of the bubble
11691 * @param obj The bubble object
11692 * @param info The given info about the bubble
11694 * This function sets the info of the bubble. Where this appears depends on
11695 * the selected corner.
11696 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11698 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11700 * Get the info of the bubble
11702 * @param obj The bubble object
11704 * @return The "info" string of the bubble
11706 * This function gets the info text.
11707 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11709 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11711 * Set the content to be shown in the bubble
11713 * Once the content object is set, a previously set one will be deleted.
11714 * If you want to keep the old content object, use the
11715 * elm_bubble_content_unset() function.
11717 * @param obj The bubble object
11718 * @param content The given content of the bubble
11720 * This function sets the content shown on the middle of the bubble.
11722 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11724 * Get the content shown in the bubble
11726 * Return the content object which is set for this widget.
11728 * @param obj The bubble object
11729 * @return The content that is being used
11731 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11733 * Unset the content shown in the bubble
11735 * Unparent and return the content object which was set for this widget.
11737 * @param obj The bubble object
11738 * @return The content that was being used
11740 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11742 * Set the icon of the bubble
11744 * Once the icon object is set, a previously set one will be deleted.
11745 * If you want to keep the old content object, use the
11746 * elm_icon_content_unset() function.
11748 * @param obj The bubble object
11749 * @param icon The given icon for the bubble
11751 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11753 * Get the icon of the bubble
11755 * @param obj The bubble object
11756 * @return The icon for the bubble
11758 * This function gets the icon shown on the top left of bubble.
11760 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11762 * Unset the icon of the bubble
11764 * Unparent and return the icon object which was set for this widget.
11766 * @param obj The bubble object
11767 * @return The icon that was being used
11769 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11771 * Set the corner of the bubble
11773 * @param obj The bubble object.
11774 * @param corner The given corner for the bubble.
11776 * This function sets the corner of the bubble. The corner will be used to
11777 * determine where the arrow in the frame points to and where label, icon and
11780 * Possible values for corner are:
11781 * @li "top_left" - Default
11783 * @li "bottom_left"
11784 * @li "bottom_right"
11786 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11788 * Get the corner of the bubble
11790 * @param obj The bubble object.
11791 * @return The given corner for the bubble.
11793 * This function gets the selected corner of the bubble.
11795 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11801 * @defgroup Photo Photo
11803 * For displaying the photo of a person (contact). Simple yet
11804 * with a very specific purpose.
11806 * Signals that you can add callbacks for are:
11808 * "clicked" - This is called when a user has clicked the photo
11809 * "drag,start" - Someone started dragging the image out of the object
11810 * "drag,end" - Dragged item was dropped (somewhere)
11816 * Add a new photo to the parent
11818 * @param parent The parent object
11819 * @return The new object or NULL if it cannot be created
11823 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11826 * Set the file that will be used as photo
11828 * @param obj The photo object
11829 * @param file The path to file that will be used as photo
11831 * @return (1 = success, 0 = error)
11835 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11838 * Set the size that will be used on the photo
11840 * @param obj The photo object
11841 * @param size The size that the photo will be
11845 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11848 * Set if the photo should be completely visible or not.
11850 * @param obj The photo object
11851 * @param fill if true the photo will be completely visible
11855 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11858 * Set editability of the photo.
11860 * An editable photo can be dragged to or from, and can be cut or
11861 * pasted too. Note that pasting an image or dropping an item on
11862 * the image will delete the existing content.
11864 * @param obj The photo object.
11865 * @param set To set of clear editablity.
11867 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11873 /* gesture layer */
11875 * @defgroup Elm_Gesture_Layer Gesture Layer
11876 * Gesture Layer Usage:
11878 * Use Gesture Layer to detect gestures.
11879 * The advantage is that you don't have to implement
11880 * gesture detection, just set callbacks of gesture state.
11881 * By using gesture layer we make standard interface.
11883 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11884 * with a parent object parameter.
11885 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11886 * call. Usually with same object as target (2nd parameter).
11888 * Now you need to tell gesture layer what gestures you follow.
11889 * This is done with @ref elm_gesture_layer_cb_set call.
11890 * By setting the callback you actually saying to gesture layer:
11891 * I would like to know when the gesture @ref Elm_Gesture_Types
11892 * switches to state @ref Elm_Gesture_State.
11894 * Next, you need to implement the actual action that follows the input
11895 * in your callback.
11897 * Note that if you like to stop being reported about a gesture, just set
11898 * all callbacks referring this gesture to NULL.
11899 * (again with @ref elm_gesture_layer_cb_set)
11901 * The information reported by gesture layer to your callback is depending
11902 * on @ref Elm_Gesture_Types:
11903 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
11904 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
11905 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
11907 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
11908 * @ref ELM_GESTURE_MOMENTUM.
11910 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
11911 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
11912 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
11913 * Note that we consider a flick as a line-gesture that should be completed
11914 * in flick-time-limit as defined in @ref Config.
11916 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
11918 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
11922 * @enum _Elm_Gesture_Types
11923 * Enum of supported gesture types.
11924 * @ingroup Elm_Gesture_Layer
11926 enum _Elm_Gesture_Types
11928 ELM_GESTURE_FIRST = 0,
11930 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
11931 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
11932 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
11933 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
11935 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
11937 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
11938 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
11940 ELM_GESTURE_ZOOM, /**< Zoom */
11941 ELM_GESTURE_ROTATE, /**< Rotate */
11947 * @typedef Elm_Gesture_Types
11948 * gesture types enum
11949 * @ingroup Elm_Gesture_Layer
11951 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
11954 * @enum _Elm_Gesture_State
11955 * Enum of gesture states.
11956 * @ingroup Elm_Gesture_Layer
11958 enum _Elm_Gesture_State
11960 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
11961 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
11962 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
11963 ELM_GESTURE_STATE_END, /**< Gesture completed */
11964 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
11968 * @typedef Elm_Gesture_State
11969 * gesture states enum
11970 * @ingroup Elm_Gesture_Layer
11972 typedef enum _Elm_Gesture_State Elm_Gesture_State;
11975 * @struct _Elm_Gesture_Taps_Info
11976 * Struct holds taps info for user
11977 * @ingroup Elm_Gesture_Layer
11979 struct _Elm_Gesture_Taps_Info
11981 Evas_Coord x, y; /**< Holds center point between fingers */
11982 unsigned int n; /**< Number of fingers tapped */
11983 unsigned int timestamp; /**< event timestamp */
11987 * @typedef Elm_Gesture_Taps_Info
11988 * holds taps info for user
11989 * @ingroup Elm_Gesture_Layer
11991 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
11994 * @struct _Elm_Gesture_Momentum_Info
11995 * Struct holds momentum info for user
11996 * x1 and y1 are not necessarily in sync
11997 * x1 holds x value of x direction starting point
11998 * and same holds for y1.
11999 * This is noticeable when doing V-shape movement
12000 * @ingroup Elm_Gesture_Layer
12002 struct _Elm_Gesture_Momentum_Info
12003 { /* Report line ends, timestamps, and momentum computed */
12004 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12005 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12006 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12007 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12009 unsigned int tx; /**< Timestamp of start of final x-swipe */
12010 unsigned int ty; /**< Timestamp of start of final y-swipe */
12012 Evas_Coord mx; /**< Momentum on X */
12013 Evas_Coord my; /**< Momentum on Y */
12017 * @typedef Elm_Gesture_Momentum_Info
12018 * holds momentum info for user
12019 * @ingroup Elm_Gesture_Layer
12021 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12024 * @struct _Elm_Gesture_Line_Info
12025 * Struct holds line info for user
12026 * @ingroup Elm_Gesture_Layer
12028 struct _Elm_Gesture_Line_Info
12029 { /* Report line ends, timestamps, and momentum computed */
12030 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12031 unsigned int n; /**< Number of fingers (lines) */
12032 /* FIXME should be radians, bot degrees */
12033 double angle; /**< Angle (direction) of lines */
12037 * @typedef Elm_Gesture_Line_Info
12038 * Holds line info for user
12039 * @ingroup Elm_Gesture_Layer
12041 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12044 * @struct _Elm_Gesture_Zoom_Info
12045 * Struct holds zoom info for user
12046 * @ingroup Elm_Gesture_Layer
12048 struct _Elm_Gesture_Zoom_Info
12050 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12051 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12052 double zoom; /**< Zoom value: 1.0 means no zoom */
12053 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12057 * @typedef Elm_Gesture_Zoom_Info
12058 * Holds zoom info for user
12059 * @ingroup Elm_Gesture_Layer
12061 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12064 * @struct _Elm_Gesture_Rotate_Info
12065 * Struct holds rotation info for user
12066 * @ingroup Elm_Gesture_Layer
12068 struct _Elm_Gesture_Rotate_Info
12070 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12071 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12072 double base_angle; /**< Holds start-angle */
12073 double angle; /**< Rotation value: 0.0 means no rotation */
12074 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12078 * @typedef Elm_Gesture_Rotate_Info
12079 * Holds rotation info for user
12080 * @ingroup Elm_Gesture_Layer
12082 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12085 * @typedef Elm_Gesture_Event_Cb
12086 * User callback used to stream gesture info from gesture layer
12087 * @param data user data
12088 * @param event_info gesture report info
12089 * Returns a flag field to be applied on the causing event.
12090 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12091 * upon the event, in an irreversible way.
12093 * @ingroup Elm_Gesture_Layer
12095 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12098 * Use function to set callbacks to be notified about
12099 * change of state of gesture.
12100 * When a user registers a callback with this function
12101 * this means this gesture has to be tested.
12103 * When ALL callbacks for a gesture are set to NULL
12104 * it means user isn't interested in gesture-state
12105 * and it will not be tested.
12107 * @param obj Pointer to gesture-layer.
12108 * @param idx The gesture you would like to track its state.
12109 * @param cb callback function pointer.
12110 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12111 * @param data user info to be sent to callback (usually, Smart Data)
12113 * @ingroup Elm_Gesture_Layer
12115 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);
12118 * Call this function to get repeat-events settings.
12120 * @param obj Pointer to gesture-layer.
12122 * @return repeat events settings.
12123 * @see elm_gesture_layer_hold_events_set()
12124 * @ingroup Elm_Gesture_Layer
12126 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12129 * This function called in order to make gesture-layer repeat events.
12130 * Set this of you like to get the raw events only if gestures were not detected.
12131 * Clear this if you like gesture layer to fwd events as testing gestures.
12133 * @param obj Pointer to gesture-layer.
12134 * @param r Repeat: TRUE/FALSE
12136 * @ingroup Elm_Gesture_Layer
12138 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12141 * This function sets step-value for zoom action.
12142 * Set step to any positive value.
12143 * Cancel step setting by setting to 0.0
12145 * @param obj Pointer to gesture-layer.
12146 * @param s new zoom step value.
12148 * @ingroup Elm_Gesture_Layer
12150 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12153 * This function sets step-value for rotate action.
12154 * Set step to any positive value.
12155 * Cancel step setting by setting to 0.0
12157 * @param obj Pointer to gesture-layer.
12158 * @param s new roatate step value.
12160 * @ingroup Elm_Gesture_Layer
12162 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12165 * This function called to attach gesture-layer to an Evas_Object.
12166 * @param obj Pointer to gesture-layer.
12167 * @param t Pointer to underlying object (AKA Target)
12169 * @return TRUE, FALSE on success, failure.
12171 * @ingroup Elm_Gesture_Layer
12173 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12176 * Call this function to construct a new gesture-layer object.
12177 * This does not activate the gesture layer. You have to
12178 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12180 * @param parent the parent object.
12182 * @return Pointer to new gesture-layer object.
12184 * @ingroup Elm_Gesture_Layer
12186 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12189 * @defgroup Thumb Thumb
12191 * @image html img/widget/thumb/preview-00.png
12192 * @image latex img/widget/thumb/preview-00.eps
12194 * A thumb object is used for displaying the thumbnail of an image or video.
12195 * You must have compiled Elementary with Ethumb_Client support and the DBus
12196 * service must be present and auto-activated in order to have thumbnails to
12199 * Once the thumbnail object becomes visible, it will check if there is a
12200 * previously generated thumbnail image for the file set on it. If not, it
12201 * will start generating this thumbnail.
12203 * Different config settings will cause different thumbnails to be generated
12204 * even on the same file.
12206 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12207 * Ethumb documentation to change this path, and to see other configuration
12210 * Signals that you can add callbacks for are:
12212 * - "clicked" - This is called when a user has clicked the thumb without dragging
12214 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12215 * - "press" - This is called when a user has pressed down the thumb.
12216 * - "generate,start" - The thumbnail generation started.
12217 * - "generate,stop" - The generation process stopped.
12218 * - "generate,error" - The generation failed.
12219 * - "load,error" - The thumbnail image loading failed.
12221 * available styles:
12225 * An example of use of thumbnail:
12227 * - @ref thumb_example_01
12231 * @addtogroup Thumb
12236 * @enum _Elm_Thumb_Animation_Setting
12237 * @typedef Elm_Thumb_Animation_Setting
12239 * Used to set if a video thumbnail is animating or not.
12243 typedef enum _Elm_Thumb_Animation_Setting
12245 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12246 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12247 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12248 ELM_THUMB_ANIMATION_LAST
12249 } Elm_Thumb_Animation_Setting;
12252 * Add a new thumb object to the parent.
12254 * @param parent The parent object.
12255 * @return The new object or NULL if it cannot be created.
12257 * @see elm_thumb_file_set()
12258 * @see elm_thumb_ethumb_client_get()
12262 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12264 * Reload thumbnail if it was generated before.
12266 * @param obj The thumb object to reload
12268 * This is useful if the ethumb client configuration changed, like its
12269 * size, aspect or any other property one set in the handle returned
12270 * by elm_thumb_ethumb_client_get().
12272 * If the options didn't change, the thumbnail won't be generated again, but
12273 * the old one will still be used.
12275 * @see elm_thumb_file_set()
12279 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12281 * Set the file that will be used as thumbnail.
12283 * @param obj The thumb object.
12284 * @param file The path to file that will be used as thumb.
12285 * @param key The key used in case of an EET file.
12287 * The file can be an image or a video (in that case, acceptable extensions are:
12288 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12289 * function elm_thumb_animate().
12291 * @see elm_thumb_file_get()
12292 * @see elm_thumb_reload()
12293 * @see elm_thumb_animate()
12297 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12299 * Get the image or video path and key used to generate the thumbnail.
12301 * @param obj The thumb object.
12302 * @param file Pointer to filename.
12303 * @param key Pointer to key.
12305 * @see elm_thumb_file_set()
12306 * @see elm_thumb_path_get()
12310 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12312 * Get the path and key to the image or video generated by ethumb.
12314 * One just need to make sure that the thumbnail was generated before getting
12315 * its path; otherwise, the path will be NULL. One way to do that is by asking
12316 * for the path when/after the "generate,stop" smart callback is called.
12318 * @param obj The thumb object.
12319 * @param file Pointer to thumb path.
12320 * @param key Pointer to thumb key.
12322 * @see elm_thumb_file_get()
12326 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12328 * Set the animation state for the thumb object. If its content is an animated
12329 * video, you may start/stop the animation or tell it to play continuously and
12332 * @param obj The thumb object.
12333 * @param setting The animation setting.
12335 * @see elm_thumb_file_set()
12339 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12341 * Get the animation state for the thumb object.
12343 * @param obj The thumb object.
12344 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12347 * @see elm_thumb_animate_set()
12351 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12353 * Get the ethumb_client handle so custom configuration can be made.
12355 * @return Ethumb_Client instance or NULL.
12357 * This must be called before the objects are created to be sure no object is
12358 * visible and no generation started.
12360 * Example of usage:
12363 * #include <Elementary.h>
12364 * #ifndef ELM_LIB_QUICKLAUNCH
12366 * elm_main(int argc, char **argv)
12368 * Ethumb_Client *client;
12370 * elm_need_ethumb();
12374 * client = elm_thumb_ethumb_client_get();
12377 * ERR("could not get ethumb_client");
12380 * ethumb_client_size_set(client, 100, 100);
12381 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12384 * // Create elm_thumb objects here
12394 * @note There's only one client handle for Ethumb, so once a configuration
12395 * change is done to it, any other request for thumbnails (for any thumbnail
12396 * object) will use that configuration. Thus, this configuration is global.
12400 EAPI void *elm_thumb_ethumb_client_get(void);
12402 * Get the ethumb_client connection state.
12404 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12407 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12409 * Make the thumbnail 'editable'.
12411 * @param obj Thumb object.
12412 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12414 * This means the thumbnail is a valid drag target for drag and drop, and can be
12415 * cut or pasted too.
12417 * @see elm_thumb_editable_get()
12421 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12423 * Make the thumbnail 'editable'.
12425 * @param obj Thumb object.
12426 * @return Editability.
12428 * This means the thumbnail is a valid drag target for drag and drop, and can be
12429 * cut or pasted too.
12431 * @see elm_thumb_editable_set()
12435 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12442 * @defgroup Hoversel Hoversel
12444 * @image html img/widget/hoversel/preview-00.png
12445 * @image latex img/widget/hoversel/preview-00.eps
12447 * A hoversel is a button that pops up a list of items (automatically
12448 * choosing the direction to display) that have a label and, optionally, an
12449 * icon to select from. It is a convenience widget to avoid the need to do
12450 * all the piecing together yourself. It is intended for a small number of
12451 * items in the hoversel menu (no more than 8), though is capable of many
12454 * Signals that you can add callbacks for are:
12455 * "clicked" - the user clicked the hoversel button and popped up the sel
12456 * "selected" - an item in the hoversel list is selected. event_info is the item
12457 * "dismissed" - the hover is dismissed
12459 * See @ref tutorial_hoversel for an example.
12462 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12464 * @brief Add a new Hoversel object
12466 * @param parent The parent object
12467 * @return The new object or NULL if it cannot be created
12469 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12471 * @brief This sets the hoversel to expand horizontally.
12473 * @param obj The hoversel object
12474 * @param horizontal If true, the hover will expand horizontally to the
12477 * @note The initial button will display horizontally regardless of this
12480 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12482 * @brief This returns whether the hoversel is set to expand horizontally.
12484 * @param obj The hoversel object
12485 * @return If true, the hover will expand horizontally to the right.
12487 * @see elm_hoversel_horizontal_set()
12489 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12491 * @brief Set the Hover parent
12493 * @param obj The hoversel object
12494 * @param parent The parent to use
12496 * Sets the hover parent object, the area that will be darkened when the
12497 * hoversel is clicked. Should probably be the window that the hoversel is
12498 * in. See @ref Hover objects for more information.
12500 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12502 * @brief Get the Hover parent
12504 * @param obj The hoversel object
12505 * @return The used parent
12507 * Gets the hover parent object.
12509 * @see elm_hoversel_hover_parent_set()
12511 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12513 * @brief Set the hoversel button label
12515 * @param obj The hoversel object
12516 * @param label The label text.
12518 * This sets the label of the button that is always visible (before it is
12519 * clicked and expanded).
12521 * @deprecated elm_object_text_set()
12523 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12525 * @brief Get the hoversel button label
12527 * @param obj The hoversel object
12528 * @return The label text.
12530 * @deprecated elm_object_text_get()
12532 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12534 * @brief Set the icon of the hoversel button
12536 * @param obj The hoversel object
12537 * @param icon The icon object
12539 * Sets the icon of the button that is always visible (before it is clicked
12540 * and expanded). Once the icon object is set, a previously set one will be
12541 * deleted, if you want to keep that old content object, use the
12542 * elm_hoversel_icon_unset() function.
12544 * @see elm_button_icon_set()
12546 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12548 * @brief Get the icon of the hoversel button
12550 * @param obj The hoversel object
12551 * @return The icon object
12553 * Get the icon of the button that is always visible (before it is clicked
12554 * and expanded). Also see elm_button_icon_get().
12556 * @see elm_hoversel_icon_set()
12558 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12560 * @brief Get and unparent the icon of the hoversel button
12562 * @param obj The hoversel object
12563 * @return The icon object that was being used
12565 * Unparent and return the icon of the button that is always visible
12566 * (before it is clicked and expanded).
12568 * @see elm_hoversel_icon_set()
12569 * @see elm_button_icon_unset()
12571 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12573 * @brief This triggers the hoversel popup from code, the same as if the user
12574 * had clicked the button.
12576 * @param obj The hoversel object
12578 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12580 * @brief This dismisses the hoversel popup as if the user had clicked
12581 * outside the hover.
12583 * @param obj The hoversel object
12585 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12587 * @brief Returns whether the hoversel is expanded.
12589 * @param obj The hoversel object
12590 * @return This will return EINA_TRUE if the hoversel is expanded or
12591 * EINA_FALSE if it is not expanded.
12593 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12595 * @brief This will remove all the children items from the hoversel.
12597 * @param obj The hoversel object
12599 * @warning Should @b not be called while the hoversel is active; use
12600 * elm_hoversel_expanded_get() to check first.
12602 * @see elm_hoversel_item_del_cb_set()
12603 * @see elm_hoversel_item_del()
12605 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12607 * @brief Get the list of items within the given hoversel.
12609 * @param obj The hoversel object
12610 * @return Returns a list of Elm_Hoversel_Item*
12612 * @see elm_hoversel_item_add()
12614 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12616 * @brief Add an item to the hoversel button
12618 * @param obj The hoversel object
12619 * @param label The text label to use for the item (NULL if not desired)
12620 * @param icon_file An image file path on disk to use for the icon or standard
12621 * icon name (NULL if not desired)
12622 * @param icon_type The icon type if relevant
12623 * @param func Convenience function to call when this item is selected
12624 * @param data Data to pass to item-related functions
12625 * @return A handle to the item added.
12627 * This adds an item to the hoversel to show when it is clicked. Note: if you
12628 * need to use an icon from an edje file then use
12629 * elm_hoversel_item_icon_set() right after the this function, and set
12630 * icon_file to NULL here.
12632 * For more information on what @p icon_file and @p icon_type are see the
12633 * @ref Icon "icon documentation".
12635 EAPI Elm_Hoversel_Item *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
12637 * @brief Delete an item from the hoversel
12639 * @param item The item to delete
12641 * This deletes the item from the hoversel (should not be called while the
12642 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12644 * @see elm_hoversel_item_add()
12645 * @see elm_hoversel_item_del_cb_set()
12647 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12649 * @brief Set the function to be called when an item from the hoversel is
12652 * @param item The item to set the callback on
12653 * @param func The function called
12655 * That function will receive these parameters:
12656 * @li void *item_data
12657 * @li Evas_Object *the_item_object
12658 * @li Elm_Hoversel_Item *the_object_struct
12660 * @see elm_hoversel_item_add()
12662 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12664 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12665 * that will be passed to associated function callbacks.
12667 * @param item The item to get the data from
12668 * @return The data pointer set with elm_hoversel_item_add()
12670 * @see elm_hoversel_item_add()
12672 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12674 * @brief This returns the label text of the given hoversel item.
12676 * @param item The item to get the label
12677 * @return The label text of the hoversel item
12679 * @see elm_hoversel_item_add()
12681 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12683 * @brief This sets the icon for the given hoversel item.
12685 * @param item The item to set the icon
12686 * @param icon_file An image file path on disk to use for the icon or standard
12688 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12689 * to NULL if the icon is not an edje file
12690 * @param icon_type The icon type
12692 * The icon can be loaded from the standard set, from an image file, or from
12695 * @see elm_hoversel_item_add()
12697 EAPI void elm_hoversel_item_icon_set(Elm_Hoversel_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
12699 * @brief Get the icon object of the hoversel item
12701 * @param item The item to get the icon from
12702 * @param icon_file The image file path on disk used for the icon or standard
12704 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12705 * if the icon is not an edje file
12706 * @param icon_type The icon type
12708 * @see elm_hoversel_item_icon_set()
12709 * @see elm_hoversel_item_add()
12711 EAPI void elm_hoversel_item_icon_get(const Elm_Hoversel_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
12717 * @defgroup Toolbar Toolbar
12718 * @ingroup Elementary
12720 * @image html img/widget/toolbar/preview-00.png
12721 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12723 * @image html img/toolbar.png
12724 * @image latex img/toolbar.eps width=\textwidth
12726 * A toolbar is a widget that displays a list of items inside
12727 * a box. It can be scrollable, show a menu with items that don't fit
12728 * to toolbar size or even crop them.
12730 * Only one item can be selected at a time.
12732 * Items can have multiple states, or show menus when selected by the user.
12734 * Smart callbacks one can listen to:
12735 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12737 * Available styles for it:
12739 * - @c "transparent" - no background or shadow, just show the content
12741 * List of examples:
12742 * @li @ref toolbar_example_01
12743 * @li @ref toolbar_example_02
12744 * @li @ref toolbar_example_03
12748 * @addtogroup Toolbar
12753 * @enum _Elm_Toolbar_Shrink_Mode
12754 * @typedef Elm_Toolbar_Shrink_Mode
12756 * Set toolbar's items display behavior, it can be scrollabel,
12757 * show a menu with exceeding items, or simply hide them.
12759 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12762 * Values <b> don't </b> work as bitmask, only one can be choosen.
12764 * @see elm_toolbar_mode_shrink_set()
12765 * @see elm_toolbar_mode_shrink_get()
12769 typedef enum _Elm_Toolbar_Shrink_Mode
12771 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12772 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12773 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12774 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12775 } Elm_Toolbar_Shrink_Mode;
12777 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
12779 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(). */
12782 * Add a new toolbar widget to the given parent Elementary
12783 * (container) object.
12785 * @param parent The parent object.
12786 * @return a new toolbar widget handle or @c NULL, on errors.
12788 * This function inserts a new toolbar widget on the canvas.
12792 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12795 * Set the icon size, in pixels, to be used by toolbar items.
12797 * @param obj The toolbar object
12798 * @param icon_size The icon size in pixels
12800 * @note Default value is @c 32. It reads value from elm config.
12802 * @see elm_toolbar_icon_size_get()
12806 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12809 * Get the icon size, in pixels, to be used by toolbar items.
12811 * @param obj The toolbar object.
12812 * @return The icon size in pixels.
12814 * @see elm_toolbar_icon_size_set() for details.
12818 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12821 * Sets icon lookup order, for toolbar items' icons.
12823 * @param obj The toolbar object.
12824 * @param order The icon lookup order.
12826 * Icons added before calling this function will not be affected.
12827 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12829 * @see elm_toolbar_icon_order_lookup_get()
12833 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12836 * Gets the icon lookup order.
12838 * @param obj The toolbar object.
12839 * @return The icon lookup order.
12841 * @see elm_toolbar_icon_order_lookup_set() for details.
12845 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12848 * Set whether the toolbar items' should be selected by the user or not.
12850 * @param obj The toolbar object.
12851 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12854 * This will turn off the ability to select items entirely and they will
12855 * neither appear selected nor emit selected signals. The clicked
12856 * callback function will still be called.
12858 * Selection is enabled by default.
12860 * @see elm_toolbar_no_select_mode_get().
12864 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12867 * Set whether the toolbar items' should be selected by the user or not.
12869 * @param obj The toolbar object.
12870 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12871 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12873 * @see elm_toolbar_no_select_mode_set() for details.
12877 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12880 * Append item to the toolbar.
12882 * @param obj The toolbar object.
12883 * @param icon A string with icon name or the absolute path of an image file.
12884 * @param label The label of the item.
12885 * @param func The function to call when the item is clicked.
12886 * @param data The data to associate with the item for related callbacks.
12887 * @return The created item or @c NULL upon failure.
12889 * A new item will be created and appended to the toolbar, i.e., will
12890 * be set as @b last item.
12892 * Items created with this method can be deleted with
12893 * elm_toolbar_item_del().
12895 * Associated @p data can be properly freed when item is deleted if a
12896 * callback function is set with elm_toolbar_item_del_cb_set().
12898 * If a function is passed as argument, it will be called everytime this item
12899 * is selected, i.e., the user clicks over an unselected item.
12900 * If such function isn't needed, just passing
12901 * @c NULL as @p func is enough. The same should be done for @p data.
12903 * Toolbar will load icon image from fdo or current theme.
12904 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12905 * If an absolute path is provided it will load it direct from a file.
12907 * @see elm_toolbar_item_icon_set()
12908 * @see elm_toolbar_item_del()
12909 * @see elm_toolbar_item_del_cb_set()
12913 EAPI Elm_Toolbar_Item *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
12916 * Prepend item to the toolbar.
12918 * @param obj The toolbar object.
12919 * @param icon A string with icon name or the absolute path of an image file.
12920 * @param label The label of the item.
12921 * @param func The function to call when the item is clicked.
12922 * @param data The data to associate with the item for related callbacks.
12923 * @return The created item or @c NULL upon failure.
12925 * A new item will be created and prepended to the toolbar, i.e., will
12926 * be set as @b first item.
12928 * Items created with this method can be deleted with
12929 * elm_toolbar_item_del().
12931 * Associated @p data can be properly freed when item is deleted if a
12932 * callback function is set with elm_toolbar_item_del_cb_set().
12934 * If a function is passed as argument, it will be called everytime this item
12935 * is selected, i.e., the user clicks over an unselected item.
12936 * If such function isn't needed, just passing
12937 * @c NULL as @p func is enough. The same should be done for @p data.
12939 * Toolbar will load icon image from fdo or current theme.
12940 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12941 * If an absolute path is provided it will load it direct from a file.
12943 * @see elm_toolbar_item_icon_set()
12944 * @see elm_toolbar_item_del()
12945 * @see elm_toolbar_item_del_cb_set()
12949 EAPI Elm_Toolbar_Item *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
12952 * Insert a new item into the toolbar object before item @p before.
12954 * @param obj The toolbar object.
12955 * @param before The toolbar item to insert before.
12956 * @param icon A string with icon name or the absolute path of an image file.
12957 * @param label The label of the item.
12958 * @param func The function to call when the item is clicked.
12959 * @param data The data to associate with the item for related callbacks.
12960 * @return The created item or @c NULL upon failure.
12962 * A new item will be created and added to the toolbar. Its position in
12963 * this toolbar will be just before item @p before.
12965 * Items created with this method can be deleted with
12966 * elm_toolbar_item_del().
12968 * Associated @p data can be properly freed when item is deleted if a
12969 * callback function is set with elm_toolbar_item_del_cb_set().
12971 * If a function is passed as argument, it will be called everytime this item
12972 * is selected, i.e., the user clicks over an unselected item.
12973 * If such function isn't needed, just passing
12974 * @c NULL as @p func is enough. The same should be done for @p data.
12976 * Toolbar will load icon image from fdo or current theme.
12977 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12978 * If an absolute path is provided it will load it direct from a file.
12980 * @see elm_toolbar_item_icon_set()
12981 * @see elm_toolbar_item_del()
12982 * @see elm_toolbar_item_del_cb_set()
12986 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Toolbar_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
12989 * Insert a new item into the toolbar object after item @p after.
12991 * @param obj The toolbar object.
12992 * @param before The toolbar item to insert before.
12993 * @param icon A string with icon name or the absolute path of an image file.
12994 * @param label The label of the item.
12995 * @param func The function to call when the item is clicked.
12996 * @param data The data to associate with the item for related callbacks.
12997 * @return The created item or @c NULL upon failure.
12999 * A new item will be created and added to the toolbar. Its position in
13000 * this toolbar will be just after item @p after.
13002 * Items created with this method can be deleted with
13003 * elm_toolbar_item_del().
13005 * Associated @p data can be properly freed when item is deleted if a
13006 * callback function is set with elm_toolbar_item_del_cb_set().
13008 * If a function is passed as argument, it will be called everytime this item
13009 * is selected, i.e., the user clicks over an unselected item.
13010 * If such function isn't needed, just passing
13011 * @c NULL as @p func is enough. The same should be done for @p data.
13013 * Toolbar will load icon image from fdo or current theme.
13014 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13015 * If an absolute path is provided it will load it direct from a file.
13017 * @see elm_toolbar_item_icon_set()
13018 * @see elm_toolbar_item_del()
13019 * @see elm_toolbar_item_del_cb_set()
13023 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Toolbar_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13026 * Get the first item in the given toolbar widget's list of
13029 * @param obj The toolbar object
13030 * @return The first item or @c NULL, if it has no items (and on
13033 * @see elm_toolbar_item_append()
13034 * @see elm_toolbar_last_item_get()
13038 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13041 * Get the last item in the given toolbar widget's list of
13044 * @param obj The toolbar object
13045 * @return The last item or @c NULL, if it has no items (and on
13048 * @see elm_toolbar_item_prepend()
13049 * @see elm_toolbar_first_item_get()
13053 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13056 * Get the item after @p item in toolbar.
13058 * @param item The toolbar item.
13059 * @return The item after @p item, or @c NULL if none or on failure.
13061 * @note If it is the last item, @c NULL will be returned.
13063 * @see elm_toolbar_item_append()
13067 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13070 * Get the item before @p item in toolbar.
13072 * @param item The toolbar item.
13073 * @return The item before @p item, or @c NULL if none or on failure.
13075 * @note If it is the first item, @c NULL will be returned.
13077 * @see elm_toolbar_item_prepend()
13081 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13084 * Get the toolbar object from an item.
13086 * @param item The item.
13087 * @return The toolbar object.
13089 * This returns the toolbar object itself that an item belongs to.
13093 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13096 * Set the priority of a toolbar item.
13098 * @param item The toolbar item.
13099 * @param priority The item priority. The default is zero.
13101 * This is used only when the toolbar shrink mode is set to
13102 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13103 * When space is less than required, items with low priority
13104 * will be removed from the toolbar and added to a dynamically-created menu,
13105 * while items with higher priority will remain on the toolbar,
13106 * with the same order they were added.
13108 * @see elm_toolbar_item_priority_get()
13112 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13115 * Get the priority of a toolbar item.
13117 * @param item The toolbar item.
13118 * @return The @p item priority, or @c 0 on failure.
13120 * @see elm_toolbar_item_priority_set() for details.
13124 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13127 * Get the label of item.
13129 * @param item The item of toolbar.
13130 * @return The label of item.
13132 * The return value is a pointer to the label associated to @p item when
13133 * it was created, with function elm_toolbar_item_append() or similar,
13135 * with function elm_toolbar_item_label_set. If no label
13136 * was passed as argument, it will return @c NULL.
13138 * @see elm_toolbar_item_label_set() for more details.
13139 * @see elm_toolbar_item_append()
13143 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13146 * Set the label of item.
13148 * @param item The item of toolbar.
13149 * @param text The label of item.
13151 * The label to be displayed by the item.
13152 * Label will be placed at icons bottom (if set).
13154 * If a label was passed as argument on item creation, with function
13155 * elm_toolbar_item_append() or similar, it will be already
13156 * displayed by the item.
13158 * @see elm_toolbar_item_label_get()
13159 * @see elm_toolbar_item_append()
13163 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13166 * Return the data associated with a given toolbar widget item.
13168 * @param item The toolbar widget item handle.
13169 * @return The data associated with @p item.
13171 * @see elm_toolbar_item_data_set()
13175 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13178 * Set the data associated with a given toolbar widget item.
13180 * @param item The toolbar widget item handle.
13181 * @param data The new data pointer to set to @p item.
13183 * This sets new item data on @p item.
13185 * @warning The old data pointer won't be touched by this function, so
13186 * the user had better to free that old data himself/herself.
13190 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13193 * Returns a pointer to a toolbar item by its label.
13195 * @param obj The toolbar object.
13196 * @param label The label of the item to find.
13198 * @return The pointer to the toolbar item matching @p label or @c NULL
13203 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13206 * Get whether the @p item is selected or not.
13208 * @param item The toolbar item.
13209 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13210 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13212 * @see elm_toolbar_selected_item_set() for details.
13213 * @see elm_toolbar_item_selected_get()
13217 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13220 * Set the selected state of an item.
13222 * @param item The toolbar item
13223 * @param selected The selected state
13225 * This sets the selected state of the given item @p it.
13226 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13228 * If a new item is selected the previosly selected will be unselected.
13229 * Previoulsy selected item can be get with function
13230 * elm_toolbar_selected_item_get().
13232 * Selected items will be highlighted.
13234 * @see elm_toolbar_item_selected_get()
13235 * @see elm_toolbar_selected_item_get()
13239 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13242 * Get the selected item.
13244 * @param obj The toolbar object.
13245 * @return The selected toolbar item.
13247 * The selected item can be unselected with function
13248 * elm_toolbar_item_selected_set().
13250 * The selected item always will be highlighted on toolbar.
13252 * @see elm_toolbar_selected_items_get()
13256 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13259 * Set the icon associated with @p item.
13261 * @param obj The parent of this item.
13262 * @param item The toolbar item.
13263 * @param icon A string with icon name or the absolute path of an image file.
13265 * Toolbar will load icon image from fdo or current theme.
13266 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13267 * If an absolute path is provided it will load it direct from a file.
13269 * @see elm_toolbar_icon_order_lookup_set()
13270 * @see elm_toolbar_icon_order_lookup_get()
13274 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13277 * Get the string used to set the icon of @p item.
13279 * @param item The toolbar item.
13280 * @return The string associated with the icon object.
13282 * @see elm_toolbar_item_icon_set() for details.
13286 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13289 * Delete them item from the toolbar.
13291 * @param item The item of toolbar to be deleted.
13293 * @see elm_toolbar_item_append()
13294 * @see elm_toolbar_item_del_cb_set()
13298 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13301 * Set the function called when a toolbar item is freed.
13303 * @param item The item to set the callback on.
13304 * @param func The function called.
13306 * If there is a @p func, then it will be called prior item's memory release.
13307 * That will be called with the following arguments:
13309 * @li item's Evas object;
13312 * This way, a data associated to a toolbar item could be properly freed.
13316 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13319 * Get a value whether toolbar item is disabled or not.
13321 * @param item The item.
13322 * @return The disabled state.
13324 * @see elm_toolbar_item_disabled_set() for more details.
13328 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13331 * Sets the disabled/enabled state of a toolbar item.
13333 * @param item The item.
13334 * @param disabled The disabled state.
13336 * A disabled item cannot be selected or unselected. It will also
13337 * change its appearance (generally greyed out). This sets the
13338 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13343 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13346 * Set or unset item as a separator.
13348 * @param item The toolbar item.
13349 * @param setting @c EINA_TRUE to set item @p item as separator or
13350 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13352 * Items aren't set as separator by default.
13354 * If set as separator it will display separator theme, so won't display
13357 * @see elm_toolbar_item_separator_get()
13361 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13364 * Get a value whether item is a separator or not.
13366 * @param item The toolbar item.
13367 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13368 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13370 * @see elm_toolbar_item_separator_set() for details.
13374 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13377 * Set the shrink state of toolbar @p obj.
13379 * @param obj The toolbar object.
13380 * @param shrink_mode Toolbar's items display behavior.
13382 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13383 * but will enforce a minimun size so all the items will fit, won't scroll
13384 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13385 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13386 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13390 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13393 * Get the shrink mode of toolbar @p obj.
13395 * @param obj The toolbar object.
13396 * @return Toolbar's items display behavior.
13398 * @see elm_toolbar_mode_shrink_set() for details.
13402 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13405 * Enable/disable homogenous mode.
13407 * @param obj The toolbar object
13408 * @param homogeneous Assume the items within the toolbar are of the
13409 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13411 * This will enable the homogeneous mode where items are of the same size.
13412 * @see elm_toolbar_homogeneous_get()
13416 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13419 * Get whether the homogenous mode is enabled.
13421 * @param obj The toolbar object.
13422 * @return Assume the items within the toolbar are of the same height
13423 * and width (EINA_TRUE = on, EINA_FALSE = off).
13425 * @see elm_toolbar_homogeneous_set()
13429 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13432 * Enable/disable homogenous mode.
13434 * @param obj The toolbar object
13435 * @param homogeneous Assume the items within the toolbar are of the
13436 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13438 * This will enable the homogeneous mode where items are of the same size.
13439 * @see elm_toolbar_homogeneous_get()
13441 * @deprecated use elm_toolbar_homogeneous_set() instead.
13445 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13448 * Get whether the homogenous mode is enabled.
13450 * @param obj The toolbar object.
13451 * @return Assume the items within the toolbar are of the same height
13452 * and width (EINA_TRUE = on, EINA_FALSE = off).
13454 * @see elm_toolbar_homogeneous_set()
13455 * @deprecated use elm_toolbar_homogeneous_get() instead.
13459 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13462 * Set the parent object of the toolbar items' menus.
13464 * @param obj The toolbar object.
13465 * @param parent The parent of the menu objects.
13467 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13469 * For more details about setting the parent for toolbar menus, see
13470 * elm_menu_parent_set().
13472 * @see elm_menu_parent_set() for details.
13473 * @see elm_toolbar_item_menu_set() for details.
13477 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13480 * Get the parent object of the toolbar items' menus.
13482 * @param obj The toolbar object.
13483 * @return The parent of the menu objects.
13485 * @see elm_toolbar_menu_parent_set() for details.
13489 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13492 * Set the alignment of the items.
13494 * @param obj The toolbar object.
13495 * @param align The new alignment, a float between <tt> 0.0 </tt>
13496 * and <tt> 1.0 </tt>.
13498 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13499 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13502 * Centered items by default.
13504 * @see elm_toolbar_align_get()
13508 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13511 * Get the alignment of the items.
13513 * @param obj The toolbar object.
13514 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13517 * @see elm_toolbar_align_set() for details.
13521 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13524 * Set whether the toolbar item opens a menu.
13526 * @param item The toolbar item.
13527 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13529 * A toolbar item can be set to be a menu, using this function.
13531 * Once it is set to be a menu, it can be manipulated through the
13532 * menu-like function elm_toolbar_menu_parent_set() and the other
13533 * elm_menu functions, using the Evas_Object @c menu returned by
13534 * elm_toolbar_item_menu_get().
13536 * So, items to be displayed in this item's menu should be added with
13537 * elm_menu_item_add().
13539 * The following code exemplifies the most basic usage:
13541 * tb = elm_toolbar_add(win)
13542 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13543 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13544 * elm_toolbar_menu_parent_set(tb, win);
13545 * menu = elm_toolbar_item_menu_get(item);
13546 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13547 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13551 * @see elm_toolbar_item_menu_get()
13555 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13558 * Get toolbar item's menu.
13560 * @param item The toolbar item.
13561 * @return Item's menu object or @c NULL on failure.
13563 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13564 * this function will set it.
13566 * @see elm_toolbar_item_menu_set() for details.
13570 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13573 * Add a new state to @p item.
13575 * @param item The item.
13576 * @param icon A string with icon name or the absolute path of an image file.
13577 * @param label The label of the new state.
13578 * @param func The function to call when the item is clicked when this
13579 * state is selected.
13580 * @param data The data to associate with the state.
13581 * @return The toolbar item state, or @c NULL upon failure.
13583 * Toolbar will load icon image from fdo or current theme.
13584 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13585 * If an absolute path is provided it will load it direct from a file.
13587 * States created with this function can be removed with
13588 * elm_toolbar_item_state_del().
13590 * @see elm_toolbar_item_state_del()
13591 * @see elm_toolbar_item_state_sel()
13592 * @see elm_toolbar_item_state_get()
13596 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Toolbar_Item *item, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13599 * Delete a previoulsy added state to @p item.
13601 * @param item The toolbar item.
13602 * @param state The state to be deleted.
13603 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13605 * @see elm_toolbar_item_state_add()
13607 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13610 * Set @p state as the current state of @p it.
13612 * @param it The item.
13613 * @param state The state to use.
13614 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13616 * If @p state is @c NULL, it won't select any state and the default item's
13617 * icon and label will be used. It's the same behaviour than
13618 * elm_toolbar_item_state_unser().
13620 * @see elm_toolbar_item_state_unset()
13624 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13627 * Unset the state of @p it.
13629 * @param it The item.
13631 * The default icon and label from this item will be displayed.
13633 * @see elm_toolbar_item_state_set() for more details.
13637 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13640 * Get the current state of @p it.
13642 * @param item The item.
13643 * @return The selected state or @c NULL if none is selected or on failure.
13645 * @see elm_toolbar_item_state_set() for details.
13646 * @see elm_toolbar_item_state_unset()
13647 * @see elm_toolbar_item_state_add()
13651 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13654 * Get the state after selected state in toolbar's @p item.
13656 * @param it The toolbar item to change state.
13657 * @return The state after current state, or @c NULL on failure.
13659 * If last state is selected, this function will return first state.
13661 * @see elm_toolbar_item_state_set()
13662 * @see elm_toolbar_item_state_add()
13666 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13669 * Get the state before selected state in toolbar's @p item.
13671 * @param it The toolbar item to change state.
13672 * @return The state before current state, or @c NULL on failure.
13674 * If first state is selected, this function will return last state.
13676 * @see elm_toolbar_item_state_set()
13677 * @see elm_toolbar_item_state_add()
13681 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13684 * Set the text to be shown in a given toolbar item's tooltips.
13686 * @param item Target item.
13687 * @param text The text to set in the content.
13689 * Setup the text as tooltip to object. The item can have only one tooltip,
13690 * so any previous tooltip data - set with this function or
13691 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13693 * @see elm_object_tooltip_text_set() for more details.
13697 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13700 * Set the content to be shown in the tooltip item.
13702 * Setup the tooltip to item. The item can have only one tooltip,
13703 * so any previous tooltip data is removed. @p func(with @p data) will
13704 * be called every time that need show the tooltip and it should
13705 * return a valid Evas_Object. This object is then managed fully by
13706 * tooltip system and is deleted when the tooltip is gone.
13708 * @param item the toolbar item being attached a tooltip.
13709 * @param func the function used to create the tooltip contents.
13710 * @param data what to provide to @a func as callback data/context.
13711 * @param del_cb called when data is not needed anymore, either when
13712 * another callback replaces @a func, the tooltip is unset with
13713 * elm_toolbar_item_tooltip_unset() or the owner @a item
13714 * dies. This callback receives as the first parameter the
13715 * given @a data, and @c event_info is the item.
13717 * @see elm_object_tooltip_content_cb_set() for more details.
13721 EAPI void elm_toolbar_item_tooltip_content_cb_set(Elm_Toolbar_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
13724 * Unset tooltip from item.
13726 * @param item toolbar item to remove previously set tooltip.
13728 * Remove tooltip from item. The callback provided as del_cb to
13729 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13730 * it is not used anymore.
13732 * @see elm_object_tooltip_unset() for more details.
13733 * @see elm_toolbar_item_tooltip_content_cb_set()
13737 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13740 * Sets a different style for this item tooltip.
13742 * @note before you set a style you should define a tooltip with
13743 * elm_toolbar_item_tooltip_content_cb_set() or
13744 * elm_toolbar_item_tooltip_text_set()
13746 * @param item toolbar item with tooltip already set.
13747 * @param style the theme style to use (default, transparent, ...)
13749 * @see elm_object_tooltip_style_set() for more details.
13753 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13756 * Get the style for this item tooltip.
13758 * @param item toolbar item with tooltip already set.
13759 * @return style the theme style in use, defaults to "default". If the
13760 * object does not have a tooltip set, then NULL is returned.
13762 * @see elm_object_tooltip_style_get() for more details.
13763 * @see elm_toolbar_item_tooltip_style_set()
13767 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13770 * Set the type of mouse pointer/cursor decoration to be shown,
13771 * when the mouse pointer is over the given toolbar widget item
13773 * @param item toolbar item to customize cursor on
13774 * @param cursor the cursor type's name
13776 * This function works analogously as elm_object_cursor_set(), but
13777 * here the cursor's changing area is restricted to the item's
13778 * area, and not the whole widget's. Note that that item cursors
13779 * have precedence over widget cursors, so that a mouse over an
13780 * item with custom cursor set will always show @b that cursor.
13782 * If this function is called twice for an object, a previously set
13783 * cursor will be unset on the second call.
13785 * @see elm_object_cursor_set()
13786 * @see elm_toolbar_item_cursor_get()
13787 * @see elm_toolbar_item_cursor_unset()
13791 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13794 * Get the type of mouse pointer/cursor decoration set to be shown,
13795 * when the mouse pointer is over the given toolbar widget item
13797 * @param item toolbar item with custom cursor set
13798 * @return the cursor type's name or @c NULL, if no custom cursors
13799 * were set to @p item (and on errors)
13801 * @see elm_object_cursor_get()
13802 * @see elm_toolbar_item_cursor_set()
13803 * @see elm_toolbar_item_cursor_unset()
13807 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13810 * Unset any custom mouse pointer/cursor decoration set to be
13811 * shown, when the mouse pointer is over the given toolbar widget
13812 * item, thus making it show the @b default cursor again.
13814 * @param item a toolbar item
13816 * Use this call to undo any custom settings on this item's cursor
13817 * decoration, bringing it back to defaults (no custom style set).
13819 * @see elm_object_cursor_unset()
13820 * @see elm_toolbar_item_cursor_set()
13824 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13827 * Set a different @b style for a given custom cursor set for a
13830 * @param item toolbar item with custom cursor set
13831 * @param style the <b>theme style</b> to use (e.g. @c "default",
13832 * @c "transparent", etc)
13834 * This function only makes sense when one is using custom mouse
13835 * cursor decorations <b>defined in a theme file</b>, which can have,
13836 * given a cursor name/type, <b>alternate styles</b> on it. It
13837 * works analogously as elm_object_cursor_style_set(), but here
13838 * applyed only to toolbar item objects.
13840 * @warning Before you set a cursor style you should have definen a
13841 * custom cursor previously on the item, with
13842 * elm_toolbar_item_cursor_set()
13844 * @see elm_toolbar_item_cursor_engine_only_set()
13845 * @see elm_toolbar_item_cursor_style_get()
13849 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13852 * Get the current @b style set for a given toolbar item's custom
13855 * @param item toolbar item with custom cursor set.
13856 * @return style the cursor style in use. If the object does not
13857 * have a cursor set, then @c NULL is returned.
13859 * @see elm_toolbar_item_cursor_style_set() for more details
13863 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13866 * Set if the (custom)cursor for a given toolbar item should be
13867 * searched in its theme, also, or should only rely on the
13868 * rendering engine.
13870 * @param item item with custom (custom) cursor already set on
13871 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13872 * only on those provided by the rendering engine, @c EINA_FALSE to
13873 * have them searched on the widget's theme, as well.
13875 * @note This call is of use only if you've set a custom cursor
13876 * for toolbar items, with elm_toolbar_item_cursor_set().
13878 * @note By default, cursors will only be looked for between those
13879 * provided by the rendering engine.
13883 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13886 * Get if the (custom) cursor for a given toolbar item is being
13887 * searched in its theme, also, or is only relying on the rendering
13890 * @param item a toolbar item
13891 * @return @c EINA_TRUE, if cursors are being looked for only on
13892 * those provided by the rendering engine, @c EINA_FALSE if they
13893 * are being searched on the widget's theme, as well.
13895 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13899 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13902 * Change a toolbar's orientation
13903 * @param obj The toolbar object
13904 * @param vertical If @c EINA_TRUE, the toolbar is vertical
13905 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
13908 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
13911 * Get a toolbar's orientation
13912 * @param obj The toolbar object
13913 * @return If @c EINA_TRUE, the toolbar is vertical
13914 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
13917 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13924 * @defgroup Tooltips Tooltips
13926 * The Tooltip is an (internal, for now) smart object used to show a
13927 * content in a frame on mouse hover of objects(or widgets), with
13928 * tips/information about them.
13933 EAPI double elm_tooltip_delay_get(void);
13934 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
13935 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
13936 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
13937 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
13938 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);
13939 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13940 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13941 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13942 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
13943 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
13950 * @defgroup Cursors Cursors
13952 * The Elementary cursor is an internal smart object used to
13953 * customize the mouse cursor displayed over objects (or
13954 * widgets). In the most common scenario, the cursor decoration
13955 * comes from the graphical @b engine Elementary is running
13956 * on. Those engines may provide different decorations for cursors,
13957 * and Elementary provides functions to choose them (think of X11
13958 * cursors, as an example).
13960 * There's also the possibility of, besides using engine provided
13961 * cursors, also use ones coming from Edje theming files. Both
13962 * globally and per widget, Elementary makes it possible for one to
13963 * make the cursors lookup to be held on engines only or on
13964 * Elementary's theme file, too.
13970 * Set the cursor to be shown when mouse is over the object
13972 * Set the cursor that will be displayed when mouse is over the
13973 * object. The object can have only one cursor set to it, so if
13974 * this function is called twice for an object, the previous set
13976 * If using X cursors, a definition of all the valid cursor names
13977 * is listed on Elementary_Cursors.h. If an invalid name is set
13978 * the default cursor will be used.
13980 * @param obj the object being set a cursor.
13981 * @param cursor the cursor name to be used.
13985 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
13988 * Get the cursor to be shown when mouse is over the object
13990 * @param obj an object with cursor already set.
13991 * @return the cursor name.
13995 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13998 * Unset cursor for object
14000 * Unset cursor for object, and set the cursor to default if the mouse
14001 * was over this object.
14003 * @param obj Target object
14004 * @see elm_object_cursor_set()
14008 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14011 * Sets a different style for this object cursor.
14013 * @note before you set a style you should define a cursor with
14014 * elm_object_cursor_set()
14016 * @param obj an object with cursor already set.
14017 * @param style the theme style to use (default, transparent, ...)
14021 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14024 * Get the style for this object cursor.
14026 * @param obj an object with cursor already set.
14027 * @return style the theme style in use, defaults to "default". If the
14028 * object does not have a cursor set, then NULL is returned.
14032 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14035 * Set if the cursor set should be searched on the theme or should use
14036 * the provided by the engine, only.
14038 * @note before you set if should look on theme you should define a cursor
14039 * with elm_object_cursor_set(). By default it will only look for cursors
14040 * provided by the engine.
14042 * @param obj an object with cursor already set.
14043 * @param engine_only boolean to define it cursors should be looked only
14044 * between the provided by the engine or searched on widget's theme as well.
14048 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14051 * Get the cursor engine only usage for this object cursor.
14053 * @param obj an object with cursor already set.
14054 * @return engine_only boolean to define it cursors should be
14055 * looked only between the provided by the engine or searched on
14056 * widget's theme as well. If the object does not have a cursor
14057 * set, then EINA_FALSE is returned.
14061 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14064 * Get the configured cursor engine only usage
14066 * This gets the globally configured exclusive usage of engine cursors.
14068 * @return 1 if only engine cursors should be used
14071 EAPI int elm_cursor_engine_only_get(void);
14074 * Set the configured cursor engine only usage
14076 * This sets the globally configured exclusive usage of engine cursors.
14077 * It won't affect cursors set before changing this value.
14079 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14080 * look for them on theme before.
14081 * @return EINA_TRUE if value is valid and setted (0 or 1)
14084 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
14091 * @defgroup Menu Menu
14093 * @image html img/widget/menu/preview-00.png
14094 * @image latex img/widget/menu/preview-00.eps
14096 * A menu is a list of items displayed above its parent. When the menu is
14097 * showing its parent is darkened. Each item can have a sub-menu. The menu
14098 * object can be used to display a menu on a right click event, in a toolbar,
14101 * Signals that you can add callbacks for are:
14102 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14103 * event_info is NULL.
14105 * @see @ref tutorial_menu
14108 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14110 * @brief Add a new menu to the parent
14112 * @param parent The parent object.
14113 * @return The new object or NULL if it cannot be created.
14115 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14117 * @brief Set the parent for the given menu widget
14119 * @param obj The menu object.
14120 * @param parent The new parent.
14122 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14124 * @brief Get the parent for the given menu widget
14126 * @param obj The menu object.
14127 * @return The parent.
14129 * @see elm_menu_parent_set()
14131 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14133 * @brief Move the menu to a new position
14135 * @param obj The menu object.
14136 * @param x The new position.
14137 * @param y The new position.
14139 * Sets the top-left position of the menu to (@p x,@p y).
14141 * @note @p x and @p y coordinates are relative to parent.
14143 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14145 * @brief Close a opened menu
14147 * @param obj the menu object
14150 * Hides the menu and all it's sub-menus.
14152 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14154 * @brief Returns a list of @p item's items.
14156 * @param obj The menu object
14157 * @return An Eina_List* of @p item's items
14159 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14161 * @brief Get the Evas_Object of an Elm_Menu_Item
14163 * @param item The menu item object.
14164 * @return The edje object containing the swallowed content
14166 * @warning Don't manipulate this object!
14168 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14170 * @brief Add an item at the end of the given menu widget
14172 * @param obj The menu object.
14173 * @param parent The parent menu item (optional)
14174 * @param icon A icon display on the item. The icon will be destryed by the menu.
14175 * @param label The label of the item.
14176 * @param func Function called when the user select the item.
14177 * @param data Data sent by the callback.
14178 * @return Returns the new item.
14180 EAPI Elm_Menu_Item *elm_menu_item_add(Evas_Object *obj, Elm_Menu_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14182 * @brief Add an object swallowed in an item at the end of the given menu
14185 * @param obj The menu object.
14186 * @param parent The parent menu item (optional)
14187 * @param subobj The object to swallow
14188 * @param func Function called when the user select the item.
14189 * @param data Data sent by the callback.
14190 * @return Returns the new item.
14192 * Add an evas object as an item to the menu.
14194 EAPI Elm_Menu_Item *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14196 * @brief Set the label of a menu item
14198 * @param item The menu item object.
14199 * @param label The label to set for @p item
14201 * @warning Don't use this funcion on items created with
14202 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14204 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14206 * @brief Get the label of a menu item
14208 * @param item The menu item object.
14209 * @return The label of @p item
14211 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14213 * @brief Set the icon of a menu item to the standard icon with name @p icon
14215 * @param item The menu item object.
14216 * @param icon The icon object to set for the content of @p item
14218 * Once this icon is set, any previously set icon will be deleted.
14220 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14222 * @brief Get the string representation from the icon of a menu item
14224 * @param item The menu item object.
14225 * @return The string representation of @p item's icon or NULL
14227 * @see elm_menu_item_object_icon_name_set()
14229 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14231 * @brief Set the content object of a menu item
14233 * @param item The menu item object
14234 * @param The content object or NULL
14235 * @return EINA_TRUE on success, else EINA_FALSE
14237 * Use this function to change the object swallowed by a menu item, deleting
14238 * any previously swallowed object.
14240 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14242 * @brief Get the content object of a menu item
14244 * @param item The menu item object
14245 * @return The content object or NULL
14246 * @note If @p item was added with elm_menu_item_add_object, this
14247 * function will return the object passed, else it will return the
14250 * @see elm_menu_item_object_content_set()
14252 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14254 * @brief Set the selected state of @p item.
14256 * @param item The menu item object.
14257 * @param selected The selected/unselected state of the item
14259 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14261 * @brief Get the selected state of @p item.
14263 * @param item The menu item object.
14264 * @return The selected/unselected state of the item
14266 * @see elm_menu_item_selected_set()
14268 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14270 * @brief Set the disabled state of @p item.
14272 * @param item The menu item object.
14273 * @param disabled The enabled/disabled state of the item
14275 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14277 * @brief Get the disabled state of @p item.
14279 * @param item The menu item object.
14280 * @return The enabled/disabled state of the item
14282 * @see elm_menu_item_disabled_set()
14284 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14286 * @brief Add a separator item to menu @p obj under @p parent.
14288 * @param obj The menu object
14289 * @param parent The item to add the separator under
14290 * @return The created item or NULL on failure
14292 * This is item is a @ref Separator.
14294 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14296 * @brief Returns whether @p item is a separator.
14298 * @param item The item to check
14299 * @return If true, @p item is a separator
14301 * @see elm_menu_item_separator_add()
14303 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14305 * @brief Deletes an item from the menu.
14307 * @param item The item to delete.
14309 * @see elm_menu_item_add()
14311 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14313 * @brief Set the function called when a menu item is deleted.
14315 * @param item The item to set the callback on
14316 * @param func The function called
14318 * @see elm_menu_item_add()
14319 * @see elm_menu_item_del()
14321 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14323 * @brief Returns the data associated with menu item @p item.
14325 * @param item The item
14326 * @return The data associated with @p item or NULL if none was set.
14328 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14330 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14332 * @brief Sets the data to be associated with menu item @p item.
14334 * @param item The item
14335 * @param data The data to be associated with @p item
14337 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14339 * @brief Returns a list of @p item's subitems.
14341 * @param item The item
14342 * @return An Eina_List* of @p item's subitems
14344 * @see elm_menu_add()
14346 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14348 * @brief Get the position of a menu item
14350 * @param item The menu item
14351 * @return The item's index
14353 * This function returns the index position of a menu item in a menu.
14354 * For a sub-menu, this number is relative to the first item in the sub-menu.
14356 * @note Index values begin with 0
14358 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14360 * @brief @brief Return a menu item's owner menu
14362 * @param item The menu item
14363 * @return The menu object owning @p item, or NULL on failure
14365 * Use this function to get the menu object owning an item.
14367 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14369 * @brief Get the selected item in the menu
14371 * @param obj The menu object
14372 * @return The selected item, or NULL if none
14374 * @see elm_menu_item_selected_get()
14375 * @see elm_menu_item_selected_set()
14377 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14379 * @brief Get the last item in the menu
14381 * @param obj The menu object
14382 * @return The last item, or NULL if none
14384 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14386 * @brief Get the first item in the menu
14388 * @param obj The menu object
14389 * @return The first item, or NULL if none
14391 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14393 * @brief Get the next item in the menu.
14395 * @param item The menu item object.
14396 * @return The item after it, or NULL if none
14398 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14400 * @brief Get the previous item in the menu.
14402 * @param item The menu item object.
14403 * @return The item before it, or NULL if none
14405 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14411 * @defgroup List List
14412 * @ingroup Elementary
14414 * @image html img/widget/list/preview-00.png
14415 * @image latex img/widget/list/preview-00.eps width=\textwidth
14417 * @image html img/list.png
14418 * @image latex img/list.eps width=\textwidth
14420 * A list widget is a container whose children are displayed vertically or
14421 * horizontally, in order, and can be selected.
14422 * The list can accept only one or multiple items selection. Also has many
14423 * modes of items displaying.
14425 * A list is a very simple type of list widget. For more robust
14426 * lists, @ref Genlist should probably be used.
14428 * Smart callbacks one can listen to:
14429 * - @c "activated" - The user has double-clicked or pressed
14430 * (enter|return|spacebar) on an item. The @c event_info parameter
14431 * is the item that was activated.
14432 * - @c "clicked,double" - The user has double-clicked an item.
14433 * The @c event_info parameter is the item that was double-clicked.
14434 * - "selected" - when the user selected an item
14435 * - "unselected" - when the user unselected an item
14436 * - "longpressed" - an item in the list is long-pressed
14437 * - "scroll,edge,top" - the list is scrolled until the top edge
14438 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14439 * - "scroll,edge,left" - the list is scrolled until the left edge
14440 * - "scroll,edge,right" - the list is scrolled until the right edge
14442 * Available styles for it:
14445 * List of examples:
14446 * @li @ref list_example_01
14447 * @li @ref list_example_02
14448 * @li @ref list_example_03
14457 * @enum _Elm_List_Mode
14458 * @typedef Elm_List_Mode
14460 * Set list's resize behavior, transverse axis scroll and
14461 * items cropping. See each mode's description for more details.
14463 * @note Default value is #ELM_LIST_SCROLL.
14465 * Values <b> don't </b> work as bitmask, only one can be choosen.
14467 * @see elm_list_mode_set()
14468 * @see elm_list_mode_get()
14472 typedef enum _Elm_List_Mode
14474 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. */
14475 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). */
14476 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. */
14477 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. */
14478 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14481 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(). */
14484 * Add a new list widget to the given parent Elementary
14485 * (container) object.
14487 * @param parent The parent object.
14488 * @return a new list widget handle or @c NULL, on errors.
14490 * This function inserts a new list widget on the canvas.
14494 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14499 * @param obj The list object
14501 * @note Call before running show() on the list object.
14502 * @warning If not called, it won't display the list properly.
14505 * li = elm_list_add(win);
14506 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14507 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14509 * evas_object_show(li);
14514 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14517 * Enable or disable multiple items selection on the list object.
14519 * @param obj The list object
14520 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14523 * Disabled by default. If disabled, the user can select a single item of
14524 * the list each time. Selected items are highlighted on list.
14525 * If enabled, many items can be selected.
14527 * If a selected item is selected again, it will be unselected.
14529 * @see elm_list_multi_select_get()
14533 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14536 * Get a value whether multiple items selection is enabled or not.
14538 * @see elm_list_multi_select_set() for details.
14540 * @param obj The list object.
14541 * @return @c EINA_TRUE means multiple items selection is enabled.
14542 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14543 * @c EINA_FALSE is returned.
14547 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14550 * Set which mode to use for the list object.
14552 * @param obj The list object
14553 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14554 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14556 * Set list's resize behavior, transverse axis scroll and
14557 * items cropping. See each mode's description for more details.
14559 * @note Default value is #ELM_LIST_SCROLL.
14561 * Only one can be set, if a previous one was set, it will be changed
14562 * by the new mode set. Bitmask won't work as well.
14564 * @see elm_list_mode_get()
14568 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14571 * Get the mode the list is at.
14573 * @param obj The list object
14574 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14575 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14577 * @note see elm_list_mode_set() for more information.
14581 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14584 * Enable or disable horizontal mode on the list object.
14586 * @param obj The list object.
14587 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14588 * disable it, i.e., to enable vertical mode.
14590 * @note Vertical mode is set by default.
14592 * On horizontal mode items are displayed on list from left to right,
14593 * instead of from top to bottom. Also, the list will scroll horizontally.
14594 * Each item will presents left icon on top and right icon, or end, at
14597 * @see elm_list_horizontal_get()
14601 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14604 * Get a value whether horizontal mode is enabled or not.
14606 * @param obj The list object.
14607 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14608 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14609 * @c EINA_FALSE is returned.
14611 * @see elm_list_horizontal_set() for details.
14615 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14618 * Enable or disable always select mode on the list object.
14620 * @param obj The list object
14621 * @param always_select @c EINA_TRUE to enable always select mode or
14622 * @c EINA_FALSE to disable it.
14624 * @note Always select mode is disabled by default.
14626 * Default behavior of list items is to only call its callback function
14627 * the first time it's pressed, i.e., when it is selected. If a selected
14628 * item is pressed again, and multi-select is disabled, it won't call
14629 * this function (if multi-select is enabled it will unselect the item).
14631 * If always select is enabled, it will call the callback function
14632 * everytime a item is pressed, so it will call when the item is selected,
14633 * and again when a selected item is pressed.
14635 * @see elm_list_always_select_mode_get()
14636 * @see elm_list_multi_select_set()
14640 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14643 * Get a value whether always select mode is enabled or not, meaning that
14644 * an item will always call its callback function, even if already selected.
14646 * @param obj The list object
14647 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14648 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14649 * @c EINA_FALSE is returned.
14651 * @see elm_list_always_select_mode_set() for details.
14655 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14658 * Set bouncing behaviour when the scrolled content reaches an edge.
14660 * Tell the internal scroller object whether it should bounce or not
14661 * when it reaches the respective edges for each axis.
14663 * @param obj The list object
14664 * @param h_bounce Whether to bounce or not in the horizontal axis.
14665 * @param v_bounce Whether to bounce or not in the vertical axis.
14667 * @see elm_scroller_bounce_set()
14671 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14674 * Get the bouncing behaviour of the internal scroller.
14676 * Get whether the internal scroller should bounce when the edge of each
14677 * axis is reached scrolling.
14679 * @param obj The list object.
14680 * @param h_bounce Pointer where to store the bounce state of the horizontal
14682 * @param v_bounce Pointer where to store the bounce state of the vertical
14685 * @see elm_scroller_bounce_get()
14686 * @see elm_list_bounce_set()
14690 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14693 * Set the scrollbar policy.
14695 * @param obj The list object
14696 * @param policy_h Horizontal scrollbar policy.
14697 * @param policy_v Vertical scrollbar policy.
14699 * This sets the scrollbar visibility policy for the given scroller.
14700 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14701 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14702 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14703 * This applies respectively for the horizontal and vertical scrollbars.
14705 * The both are disabled by default, i.e., are set to
14706 * #ELM_SCROLLER_POLICY_OFF.
14710 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14713 * Get the scrollbar policy.
14715 * @see elm_list_scroller_policy_get() for details.
14717 * @param obj The list object.
14718 * @param policy_h Pointer where to store horizontal scrollbar policy.
14719 * @param policy_v Pointer where to store vertical scrollbar policy.
14723 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);
14726 * Append a new item to the list object.
14728 * @param obj The list object.
14729 * @param label The label of the list item.
14730 * @param icon The icon object to use for the left side of the item. An
14731 * icon can be any Evas object, but usually it is an icon created
14732 * with elm_icon_add().
14733 * @param end The icon object to use for the right side of the item. An
14734 * icon can be any Evas object.
14735 * @param func The function to call when the item is clicked.
14736 * @param data The data to associate with the item for related callbacks.
14738 * @return The created item or @c NULL upon failure.
14740 * A new item will be created and appended to the list, i.e., will
14741 * be set as @b last item.
14743 * Items created with this method can be deleted with
14744 * elm_list_item_del().
14746 * Associated @p data can be properly freed when item is deleted if a
14747 * callback function is set with elm_list_item_del_cb_set().
14749 * If a function is passed as argument, it will be called everytime this item
14750 * is selected, i.e., the user clicks over an unselected item.
14751 * If always select is enabled it will call this function every time
14752 * user clicks over an item (already selected or not).
14753 * If such function isn't needed, just passing
14754 * @c NULL as @p func is enough. The same should be done for @p data.
14756 * Simple example (with no function callback or data associated):
14758 * li = elm_list_add(win);
14759 * ic = elm_icon_add(win);
14760 * elm_icon_file_set(ic, "path/to/image", NULL);
14761 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14762 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14764 * evas_object_show(li);
14767 * @see elm_list_always_select_mode_set()
14768 * @see elm_list_item_del()
14769 * @see elm_list_item_del_cb_set()
14770 * @see elm_list_clear()
14771 * @see elm_icon_add()
14775 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);
14778 * Prepend a new item to the list object.
14780 * @param obj The list object.
14781 * @param label The label of the list item.
14782 * @param icon The icon object to use for the left side of the item. An
14783 * icon can be any Evas object, but usually it is an icon created
14784 * with elm_icon_add().
14785 * @param end The icon object to use for the right side of the item. An
14786 * icon can be any Evas object.
14787 * @param func The function to call when the item is clicked.
14788 * @param data The data to associate with the item for related callbacks.
14790 * @return The created item or @c NULL upon failure.
14792 * A new item will be created and prepended to the list, i.e., will
14793 * be set as @b first item.
14795 * Items created with this method can be deleted with
14796 * elm_list_item_del().
14798 * Associated @p data can be properly freed when item is deleted if a
14799 * callback function is set with elm_list_item_del_cb_set().
14801 * If a function is passed as argument, it will be called everytime this item
14802 * is selected, i.e., the user clicks over an unselected item.
14803 * If always select is enabled it will call this function every time
14804 * user clicks over an item (already selected or not).
14805 * If such function isn't needed, just passing
14806 * @c NULL as @p func is enough. The same should be done for @p data.
14808 * @see elm_list_item_append() for a simple code example.
14809 * @see elm_list_always_select_mode_set()
14810 * @see elm_list_item_del()
14811 * @see elm_list_item_del_cb_set()
14812 * @see elm_list_clear()
14813 * @see elm_icon_add()
14817 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);
14820 * Insert a new item into the list object before item @p before.
14822 * @param obj The list object.
14823 * @param before The list item to insert before.
14824 * @param label The label of the list item.
14825 * @param icon The icon object to use for the left side of the item. An
14826 * icon can be any Evas object, but usually it is an icon created
14827 * with elm_icon_add().
14828 * @param end The icon object to use for the right side of the item. An
14829 * icon can be any Evas object.
14830 * @param func The function to call when the item is clicked.
14831 * @param data The data to associate with the item for related callbacks.
14833 * @return The created item or @c NULL upon failure.
14835 * A new item will be created and added to the list. Its position in
14836 * this list will be just before item @p before.
14838 * Items created with this method can be deleted with
14839 * elm_list_item_del().
14841 * Associated @p data can be properly freed when item is deleted if a
14842 * callback function is set with elm_list_item_del_cb_set().
14844 * If a function is passed as argument, it will be called everytime this item
14845 * is selected, i.e., the user clicks over an unselected item.
14846 * If always select is enabled it will call this function every time
14847 * user clicks over an item (already selected or not).
14848 * If such function isn't needed, just passing
14849 * @c NULL as @p func is enough. The same should be done for @p data.
14851 * @see elm_list_item_append() for a simple code example.
14852 * @see elm_list_always_select_mode_set()
14853 * @see elm_list_item_del()
14854 * @see elm_list_item_del_cb_set()
14855 * @see elm_list_clear()
14856 * @see elm_icon_add()
14860 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);
14863 * Insert a new item into the list object after item @p after.
14865 * @param obj The list object.
14866 * @param after The list item to insert after.
14867 * @param label The label of the list item.
14868 * @param icon The icon object to use for the left side of the item. An
14869 * icon can be any Evas object, but usually it is an icon created
14870 * with elm_icon_add().
14871 * @param end The icon object to use for the right side of the item. An
14872 * icon can be any Evas object.
14873 * @param func The function to call when the item is clicked.
14874 * @param data The data to associate with the item for related callbacks.
14876 * @return The created item or @c NULL upon failure.
14878 * A new item will be created and added to the list. Its position in
14879 * this list will be just after item @p after.
14881 * Items created with this method can be deleted with
14882 * elm_list_item_del().
14884 * Associated @p data can be properly freed when item is deleted if a
14885 * callback function is set with elm_list_item_del_cb_set().
14887 * If a function is passed as argument, it will be called everytime this item
14888 * is selected, i.e., the user clicks over an unselected item.
14889 * If always select is enabled it will call this function every time
14890 * user clicks over an item (already selected or not).
14891 * If such function isn't needed, just passing
14892 * @c NULL as @p func is enough. The same should be done for @p data.
14894 * @see elm_list_item_append() for a simple code example.
14895 * @see elm_list_always_select_mode_set()
14896 * @see elm_list_item_del()
14897 * @see elm_list_item_del_cb_set()
14898 * @see elm_list_clear()
14899 * @see elm_icon_add()
14903 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);
14906 * Insert a new item into the sorted list object.
14908 * @param obj The list object.
14909 * @param label The label of the list item.
14910 * @param icon The icon object to use for the left side of the item. An
14911 * icon can be any Evas object, but usually it is an icon created
14912 * with elm_icon_add().
14913 * @param end The icon object to use for the right side of the item. An
14914 * icon can be any Evas object.
14915 * @param func The function to call when the item is clicked.
14916 * @param data The data to associate with the item for related callbacks.
14917 * @param cmp_func The comparing function to be used to sort list
14918 * items <b>by #Elm_List_Item item handles</b>. This function will
14919 * receive two items and compare them, returning a non-negative integer
14920 * if the second item should be place after the first, or negative value
14921 * if should be placed before.
14923 * @return The created item or @c NULL upon failure.
14925 * @note This function inserts values into a list object assuming it was
14926 * sorted and the result will be sorted.
14928 * A new item will be created and added to the list. Its position in
14929 * this list will be found comparing the new item with previously inserted
14930 * items using function @p cmp_func.
14932 * Items created with this method can be deleted with
14933 * elm_list_item_del().
14935 * Associated @p data can be properly freed when item is deleted if a
14936 * callback function is set with elm_list_item_del_cb_set().
14938 * If a function is passed as argument, it will be called everytime this item
14939 * is selected, i.e., the user clicks over an unselected item.
14940 * If always select is enabled it will call this function every time
14941 * user clicks over an item (already selected or not).
14942 * If such function isn't needed, just passing
14943 * @c NULL as @p func is enough. The same should be done for @p data.
14945 * @see elm_list_item_append() for a simple code example.
14946 * @see elm_list_always_select_mode_set()
14947 * @see elm_list_item_del()
14948 * @see elm_list_item_del_cb_set()
14949 * @see elm_list_clear()
14950 * @see elm_icon_add()
14954 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);
14957 * Remove all list's items.
14959 * @param obj The list object
14961 * @see elm_list_item_del()
14962 * @see elm_list_item_append()
14966 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14969 * Get a list of all the list items.
14971 * @param obj The list object
14972 * @return An @c Eina_List of list items, #Elm_List_Item,
14973 * or @c NULL on failure.
14975 * @see elm_list_item_append()
14976 * @see elm_list_item_del()
14977 * @see elm_list_clear()
14981 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14984 * Get the selected item.
14986 * @param obj The list object.
14987 * @return The selected list item.
14989 * The selected item can be unselected with function
14990 * elm_list_item_selected_set().
14992 * The selected item always will be highlighted on list.
14994 * @see elm_list_selected_items_get()
14998 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15001 * Return a list of the currently selected list items.
15003 * @param obj The list object.
15004 * @return An @c Eina_List of list items, #Elm_List_Item,
15005 * or @c NULL on failure.
15007 * Multiple items can be selected if multi select is enabled. It can be
15008 * done with elm_list_multi_select_set().
15010 * @see elm_list_selected_item_get()
15011 * @see elm_list_multi_select_set()
15015 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15018 * Set the selected state of an item.
15020 * @param item The list item
15021 * @param selected The selected state
15023 * This sets the selected state of the given item @p it.
15024 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15026 * If a new item is selected the previosly selected will be unselected,
15027 * unless multiple selection is enabled with elm_list_multi_select_set().
15028 * Previoulsy selected item can be get with function
15029 * elm_list_selected_item_get().
15031 * Selected items will be highlighted.
15033 * @see elm_list_item_selected_get()
15034 * @see elm_list_selected_item_get()
15035 * @see elm_list_multi_select_set()
15039 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15042 * Get whether the @p item is selected or not.
15044 * @param item The list item.
15045 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15046 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15048 * @see elm_list_selected_item_set() for details.
15049 * @see elm_list_item_selected_get()
15053 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15056 * Set or unset item as a separator.
15058 * @param it The list item.
15059 * @param setting @c EINA_TRUE to set item @p it as separator or
15060 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15062 * Items aren't set as separator by default.
15064 * If set as separator it will display separator theme, so won't display
15067 * @see elm_list_item_separator_get()
15071 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15074 * Get a value whether item is a separator or not.
15076 * @see elm_list_item_separator_set() for details.
15078 * @param it The list item.
15079 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15080 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15084 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15087 * Show @p item in the list view.
15089 * @param item The list item to be shown.
15091 * It won't animate list until item is visible. If such behavior is wanted,
15092 * use elm_list_bring_in() intead.
15096 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15099 * Bring in the given item to list view.
15101 * @param item The item.
15103 * This causes list to jump to the given item @p item and show it
15104 * (by scrolling), if it is not fully visible.
15106 * This may use animation to do so and take a period of time.
15108 * If animation isn't wanted, elm_list_item_show() can be used.
15112 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15115 * Delete them item from the list.
15117 * @param item The item of list to be deleted.
15119 * If deleting all list items is required, elm_list_clear()
15120 * should be used instead of getting items list and deleting each one.
15122 * @see elm_list_clear()
15123 * @see elm_list_item_append()
15124 * @see elm_list_item_del_cb_set()
15128 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15131 * Set the function called when a list item is freed.
15133 * @param item The item to set the callback on
15134 * @param func The function called
15136 * If there is a @p func, then it will be called prior item's memory release.
15137 * That will be called with the following arguments:
15139 * @li item's Evas object;
15142 * This way, a data associated to a list item could be properly freed.
15146 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15149 * Get the data associated to the item.
15151 * @param item The list item
15152 * @return The data associated to @p item
15154 * The return value is a pointer to data associated to @p item when it was
15155 * created, with function elm_list_item_append() or similar. If no data
15156 * was passed as argument, it will return @c NULL.
15158 * @see elm_list_item_append()
15162 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15165 * Get the left side icon associated to the item.
15167 * @param item The list item
15168 * @return The left side icon associated to @p item
15170 * The return value is a pointer to the icon associated to @p item when
15172 * created, with function elm_list_item_append() or similar, or later
15173 * with function elm_list_item_icon_set(). If no icon
15174 * was passed as argument, it will return @c NULL.
15176 * @see elm_list_item_append()
15177 * @see elm_list_item_icon_set()
15181 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15184 * Set the left side icon associated to the item.
15186 * @param item The list item
15187 * @param icon The left side icon object to associate with @p item
15189 * The icon object to use at left side of the item. An
15190 * icon can be any Evas object, but usually it is an icon created
15191 * with elm_icon_add().
15193 * Once the icon object is set, a previously set one will be deleted.
15194 * @warning Setting the same icon for two items will cause the icon to
15195 * dissapear from the first item.
15197 * If an icon was passed as argument on item creation, with function
15198 * elm_list_item_append() or similar, it will be already
15199 * associated to the item.
15201 * @see elm_list_item_append()
15202 * @see elm_list_item_icon_get()
15206 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15209 * Get the right side icon associated to the item.
15211 * @param item The list item
15212 * @return The right side icon associated to @p item
15214 * The return value is a pointer to the icon associated to @p item when
15216 * created, with function elm_list_item_append() or similar, or later
15217 * with function elm_list_item_icon_set(). If no icon
15218 * was passed as argument, it will return @c NULL.
15220 * @see elm_list_item_append()
15221 * @see elm_list_item_icon_set()
15225 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15228 * Set the right side icon associated to the item.
15230 * @param item The list item
15231 * @param end The right side icon object to associate with @p item
15233 * The icon object to use at right side of the item. An
15234 * icon can be any Evas object, but usually it is an icon created
15235 * with elm_icon_add().
15237 * Once the icon object is set, a previously set one will be deleted.
15238 * @warning Setting the same icon for two items will cause the icon to
15239 * dissapear from the first item.
15241 * If an icon was passed as argument on item creation, with function
15242 * elm_list_item_append() or similar, it will be already
15243 * associated to the item.
15245 * @see elm_list_item_append()
15246 * @see elm_list_item_end_get()
15250 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15253 * Gets the base object of the item.
15255 * @param item The list item
15256 * @return The base object associated with @p item
15258 * Base object is the @c Evas_Object that represents that item.
15262 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15265 * Get the label of item.
15267 * @param item The item of list.
15268 * @return The label of item.
15270 * The return value is a pointer to the label associated to @p item when
15271 * it was created, with function elm_list_item_append(), or later
15272 * with function elm_list_item_label_set. If no label
15273 * was passed as argument, it will return @c NULL.
15275 * @see elm_list_item_label_set() for more details.
15276 * @see elm_list_item_append()
15280 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15283 * Set the label of item.
15285 * @param item The item of list.
15286 * @param text The label of item.
15288 * The label to be displayed by the item.
15289 * Label will be placed between left and right side icons (if set).
15291 * If a label was passed as argument on item creation, with function
15292 * elm_list_item_append() or similar, it will be already
15293 * displayed by the item.
15295 * @see elm_list_item_label_get()
15296 * @see elm_list_item_append()
15300 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15304 * Get the item before @p it in list.
15306 * @param it The list item.
15307 * @return The item before @p it, or @c NULL if none or on failure.
15309 * @note If it is the first item, @c NULL will be returned.
15311 * @see elm_list_item_append()
15312 * @see elm_list_items_get()
15316 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15319 * Get the item after @p it in list.
15321 * @param it The list item.
15322 * @return The item after @p it, or @c NULL if none or on failure.
15324 * @note If it is the last item, @c NULL will be returned.
15326 * @see elm_list_item_append()
15327 * @see elm_list_items_get()
15331 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15334 * Sets the disabled/enabled state of a list item.
15336 * @param it The item.
15337 * @param disabled The disabled state.
15339 * A disabled item cannot be selected or unselected. It will also
15340 * change its appearance (generally greyed out). This sets the
15341 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15346 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15349 * Get a value whether list item is disabled or not.
15351 * @param it The item.
15352 * @return The disabled state.
15354 * @see elm_list_item_disabled_set() for more details.
15358 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15361 * Set the text to be shown in a given list item's tooltips.
15363 * @param item Target item.
15364 * @param text The text to set in the content.
15366 * Setup the text as tooltip to object. The item can have only one tooltip,
15367 * so any previous tooltip data - set with this function or
15368 * elm_list_item_tooltip_content_cb_set() - is removed.
15370 * @see elm_object_tooltip_text_set() for more details.
15374 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15378 * @brief Disable size restrictions on an object's tooltip
15379 * @param item The tooltip's anchor object
15380 * @param disable If EINA_TRUE, size restrictions are disabled
15381 * @return EINA_FALSE on failure, EINA_TRUE on success
15383 * This function allows a tooltip to expand beyond its parant window's canvas.
15384 * It will instead be limited only by the size of the display.
15386 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15388 * @brief Retrieve size restriction state of an object's tooltip
15389 * @param obj The tooltip's anchor object
15390 * @return If EINA_TRUE, size restrictions are disabled
15392 * This function returns whether a tooltip is allowed to expand beyond
15393 * its parant window's canvas.
15394 * It will instead be limited only by the size of the display.
15396 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15399 * Set the content to be shown in the tooltip item.
15401 * Setup the tooltip to item. The item can have only one tooltip,
15402 * so any previous tooltip data is removed. @p func(with @p data) will
15403 * be called every time that need show the tooltip and it should
15404 * return a valid Evas_Object. This object is then managed fully by
15405 * tooltip system and is deleted when the tooltip is gone.
15407 * @param item the list item being attached a tooltip.
15408 * @param func the function used to create the tooltip contents.
15409 * @param data what to provide to @a func as callback data/context.
15410 * @param del_cb called when data is not needed anymore, either when
15411 * another callback replaces @a func, the tooltip is unset with
15412 * elm_list_item_tooltip_unset() or the owner @a item
15413 * dies. This callback receives as the first parameter the
15414 * given @a data, and @c event_info is the item.
15416 * @see elm_object_tooltip_content_cb_set() for more details.
15420 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);
15423 * Unset tooltip from item.
15425 * @param item list item to remove previously set tooltip.
15427 * Remove tooltip from item. The callback provided as del_cb to
15428 * elm_list_item_tooltip_content_cb_set() will be called to notify
15429 * it is not used anymore.
15431 * @see elm_object_tooltip_unset() for more details.
15432 * @see elm_list_item_tooltip_content_cb_set()
15436 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15439 * Sets a different style for this item tooltip.
15441 * @note before you set a style you should define a tooltip with
15442 * elm_list_item_tooltip_content_cb_set() or
15443 * elm_list_item_tooltip_text_set()
15445 * @param item list item with tooltip already set.
15446 * @param style the theme style to use (default, transparent, ...)
15448 * @see elm_object_tooltip_style_set() for more details.
15452 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15455 * Get the style for this item tooltip.
15457 * @param item list item with tooltip already set.
15458 * @return style the theme style in use, defaults to "default". If the
15459 * object does not have a tooltip set, then NULL is returned.
15461 * @see elm_object_tooltip_style_get() for more details.
15462 * @see elm_list_item_tooltip_style_set()
15466 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15469 * Set the type of mouse pointer/cursor decoration to be shown,
15470 * when the mouse pointer is over the given list widget item
15472 * @param item list item to customize cursor on
15473 * @param cursor the cursor type's name
15475 * This function works analogously as elm_object_cursor_set(), but
15476 * here the cursor's changing area is restricted to the item's
15477 * area, and not the whole widget's. Note that that item cursors
15478 * have precedence over widget cursors, so that a mouse over an
15479 * item with custom cursor set will always show @b that cursor.
15481 * If this function is called twice for an object, a previously set
15482 * cursor will be unset on the second call.
15484 * @see elm_object_cursor_set()
15485 * @see elm_list_item_cursor_get()
15486 * @see elm_list_item_cursor_unset()
15490 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15493 * Get the type of mouse pointer/cursor decoration set to be shown,
15494 * when the mouse pointer is over the given list widget item
15496 * @param item list item with custom cursor set
15497 * @return the cursor type's name or @c NULL, if no custom cursors
15498 * were set to @p item (and on errors)
15500 * @see elm_object_cursor_get()
15501 * @see elm_list_item_cursor_set()
15502 * @see elm_list_item_cursor_unset()
15506 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15509 * Unset any custom mouse pointer/cursor decoration set to be
15510 * shown, when the mouse pointer is over the given list widget
15511 * item, thus making it show the @b default cursor again.
15513 * @param item a list item
15515 * Use this call to undo any custom settings on this item's cursor
15516 * decoration, bringing it back to defaults (no custom style set).
15518 * @see elm_object_cursor_unset()
15519 * @see elm_list_item_cursor_set()
15523 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15526 * Set a different @b style for a given custom cursor set for a
15529 * @param item list item with custom cursor set
15530 * @param style the <b>theme style</b> to use (e.g. @c "default",
15531 * @c "transparent", etc)
15533 * This function only makes sense when one is using custom mouse
15534 * cursor decorations <b>defined in a theme file</b>, which can have,
15535 * given a cursor name/type, <b>alternate styles</b> on it. It
15536 * works analogously as elm_object_cursor_style_set(), but here
15537 * applyed only to list item objects.
15539 * @warning Before you set a cursor style you should have definen a
15540 * custom cursor previously on the item, with
15541 * elm_list_item_cursor_set()
15543 * @see elm_list_item_cursor_engine_only_set()
15544 * @see elm_list_item_cursor_style_get()
15548 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15551 * Get the current @b style set for a given list item's custom
15554 * @param item list item with custom cursor set.
15555 * @return style the cursor style in use. If the object does not
15556 * have a cursor set, then @c NULL is returned.
15558 * @see elm_list_item_cursor_style_set() for more details
15562 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15565 * Set if the (custom)cursor for a given list item should be
15566 * searched in its theme, also, or should only rely on the
15567 * rendering engine.
15569 * @param item item with custom (custom) cursor already set on
15570 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15571 * only on those provided by the rendering engine, @c EINA_FALSE to
15572 * have them searched on the widget's theme, as well.
15574 * @note This call is of use only if you've set a custom cursor
15575 * for list items, with elm_list_item_cursor_set().
15577 * @note By default, cursors will only be looked for between those
15578 * provided by the rendering engine.
15582 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15585 * Get if the (custom) cursor for a given list item is being
15586 * searched in its theme, also, or is only relying on the rendering
15589 * @param item a list item
15590 * @return @c EINA_TRUE, if cursors are being looked for only on
15591 * those provided by the rendering engine, @c EINA_FALSE if they
15592 * are being searched on the widget's theme, as well.
15594 * @see elm_list_item_cursor_engine_only_set(), for more details
15598 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15605 * @defgroup Slider Slider
15606 * @ingroup Elementary
15608 * @image html img/widget/slider/preview-00.png
15609 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15611 * The slider adds a dragable “slider” widget for selecting the value of
15612 * something within a range.
15614 * A slider can be horizontal or vertical. It can contain an Icon and has a
15615 * primary label as well as a units label (that is formatted with floating
15616 * point values and thus accepts a printf-style format string, like
15617 * “%1.2f units”. There is also an indicator string that may be somewhere
15618 * else (like on the slider itself) that also accepts a format string like
15619 * units. Label, Icon Unit and Indicator strings/objects are optional.
15621 * A slider may be inverted which means values invert, with high vales being
15622 * on the left or top and low values on the right or bottom (as opposed to
15623 * normally being low on the left or top and high on the bottom and right).
15625 * The slider should have its minimum and maximum values set by the
15626 * application with elm_slider_min_max_set() and value should also be set by
15627 * the application before use with elm_slider_value_set(). The span of the
15628 * slider is its length (horizontally or vertically). This will be scaled by
15629 * the object or applications scaling factor. At any point code can query the
15630 * slider for its value with elm_slider_value_get().
15632 * Smart callbacks one can listen to:
15633 * - "changed" - Whenever the slider value is changed by the user.
15634 * - "slider,drag,start" - dragging the slider indicator around has started.
15635 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15636 * - "delay,changed" - A short time after the value is changed by the user.
15637 * This will be called only when the user stops dragging for
15638 * a very short period or when they release their
15639 * finger/mouse, so it avoids possibly expensive reactions to
15640 * the value change.
15642 * Available styles for it:
15645 * Here is an example on its usage:
15646 * @li @ref slider_example
15650 * @addtogroup Slider
15655 * Add a new slider widget to the given parent Elementary
15656 * (container) object.
15658 * @param parent The parent object.
15659 * @return a new slider widget handle or @c NULL, on errors.
15661 * This function inserts a new slider widget on the canvas.
15665 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15668 * Set the label of a given slider widget
15670 * @param obj The progress bar object
15671 * @param label The text label string, in UTF-8
15674 * @deprecated use elm_object_text_set() instead.
15676 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15679 * Get the label of a given slider widget
15681 * @param obj The progressbar object
15682 * @return The text label string, in UTF-8
15685 * @deprecated use elm_object_text_get() instead.
15687 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15690 * Set the icon object of the slider object.
15692 * @param obj The slider object.
15693 * @param icon The icon object.
15695 * On horizontal mode, icon is placed at left, and on vertical mode,
15698 * @note Once the icon object is set, a previously set one will be deleted.
15699 * If you want to keep that old content object, use the
15700 * elm_slider_icon_unset() function.
15702 * @warning If the object being set does not have minimum size hints set,
15703 * it won't get properly displayed.
15707 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15710 * Unset an icon set on a given slider widget.
15712 * @param obj The slider object.
15713 * @return The icon object that was being used, if any was set, or
15714 * @c NULL, otherwise (and on errors).
15716 * On horizontal mode, icon is placed at left, and on vertical mode,
15719 * This call will unparent and return the icon object which was set
15720 * for this widget, previously, on success.
15722 * @see elm_slider_icon_set() for more details
15723 * @see elm_slider_icon_get()
15727 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15730 * Retrieve the icon object set for a given slider widget.
15732 * @param obj The slider object.
15733 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15734 * otherwise (and on errors).
15736 * On horizontal mode, icon is placed at left, and on vertical mode,
15739 * @see elm_slider_icon_set() for more details
15740 * @see elm_slider_icon_unset()
15744 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15747 * Set the end object of the slider object.
15749 * @param obj The slider object.
15750 * @param end The end object.
15752 * On horizontal mode, end is placed at left, and on vertical mode,
15753 * placed at bottom.
15755 * @note Once the icon object is set, a previously set one will be deleted.
15756 * If you want to keep that old content object, use the
15757 * elm_slider_end_unset() function.
15759 * @warning If the object being set does not have minimum size hints set,
15760 * it won't get properly displayed.
15764 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15767 * Unset an end object set on a given slider widget.
15769 * @param obj The slider object.
15770 * @return The end object that was being used, if any was set, or
15771 * @c NULL, otherwise (and on errors).
15773 * On horizontal mode, end is placed at left, and on vertical mode,
15774 * placed at bottom.
15776 * This call will unparent and return the icon object which was set
15777 * for this widget, previously, on success.
15779 * @see elm_slider_end_set() for more details.
15780 * @see elm_slider_end_get()
15784 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15787 * Retrieve the end object set for a given slider widget.
15789 * @param obj The slider object.
15790 * @return The end object's handle, if @p obj had one set, or @c NULL,
15791 * otherwise (and on errors).
15793 * On horizontal mode, icon is placed at right, and on vertical mode,
15794 * placed at bottom.
15796 * @see elm_slider_end_set() for more details.
15797 * @see elm_slider_end_unset()
15801 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15804 * Set the (exact) length of the bar region of a given slider widget.
15806 * @param obj The slider object.
15807 * @param size The length of the slider's bar region.
15809 * This sets the minimum width (when in horizontal mode) or height
15810 * (when in vertical mode) of the actual bar area of the slider
15811 * @p obj. This in turn affects the object's minimum size. Use
15812 * this when you're not setting other size hints expanding on the
15813 * given direction (like weight and alignment hints) and you would
15814 * like it to have a specific size.
15816 * @note Icon, end, label, indicator and unit text around @p obj
15817 * will require their
15818 * own space, which will make @p obj to require more the @p size,
15821 * @see elm_slider_span_size_get()
15825 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15828 * Get the length set for the bar region of a given slider widget
15830 * @param obj The slider object.
15831 * @return The length of the slider's bar region.
15833 * If that size was not set previously, with
15834 * elm_slider_span_size_set(), this call will return @c 0.
15838 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15841 * Set the format string for the unit label.
15843 * @param obj The slider object.
15844 * @param format The format string for the unit display.
15846 * Unit label is displayed all the time, if set, after slider's bar.
15847 * In horizontal mode, at right and in vertical mode, at bottom.
15849 * If @c NULL, unit label won't be visible. If not it sets the format
15850 * string for the label text. To the label text is provided a floating point
15851 * value, so the label text can display up to 1 floating point value.
15852 * Note that this is optional.
15854 * Use a format string such as "%1.2f meters" for example, and it will
15855 * display values like: "3.14 meters" for a value equal to 3.14159.
15857 * Default is unit label disabled.
15859 * @see elm_slider_indicator_format_get()
15863 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15866 * Get the unit label format of the slider.
15868 * @param obj The slider object.
15869 * @return The unit label format string in UTF-8.
15871 * Unit label is displayed all the time, if set, after slider's bar.
15872 * In horizontal mode, at right and in vertical mode, at bottom.
15874 * @see elm_slider_unit_format_set() for more
15875 * information on how this works.
15879 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15882 * Set the format string for the indicator label.
15884 * @param obj The slider object.
15885 * @param indicator The format string for the indicator display.
15887 * The slider may display its value somewhere else then unit label,
15888 * for example, above the slider knob that is dragged around. This function
15889 * sets the format string used for this.
15891 * If @c NULL, indicator label won't be visible. If not it sets the format
15892 * string for the label text. To the label text is provided a floating point
15893 * value, so the label text can display up to 1 floating point value.
15894 * Note that this is optional.
15896 * Use a format string such as "%1.2f meters" for example, and it will
15897 * display values like: "3.14 meters" for a value equal to 3.14159.
15899 * Default is indicator label disabled.
15901 * @see elm_slider_indicator_format_get()
15905 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
15908 * Get the indicator label format of the slider.
15910 * @param obj The slider object.
15911 * @return The indicator label format string in UTF-8.
15913 * The slider may display its value somewhere else then unit label,
15914 * for example, above the slider knob that is dragged around. This function
15915 * gets the format string used for this.
15917 * @see elm_slider_indicator_format_set() for more
15918 * information on how this works.
15922 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15925 * Set the format function pointer for the indicator label
15927 * @param obj The slider object.
15928 * @param func The indicator format function.
15929 * @param free_func The freeing function for the format string.
15931 * Set the callback function to format the indicator string.
15933 * @see elm_slider_indicator_format_set() for more info on how this works.
15937 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);
15940 * Set the format function pointer for the units label
15942 * @param obj The slider object.
15943 * @param func The units format function.
15944 * @param free_func The freeing function for the format string.
15946 * Set the callback function to format the indicator string.
15948 * @see elm_slider_units_format_set() for more info on how this works.
15952 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);
15955 * Set the orientation of a given slider widget.
15957 * @param obj The slider object.
15958 * @param horizontal Use @c EINA_TRUE to make @p obj to be
15959 * @b horizontal, @c EINA_FALSE to make it @b vertical.
15961 * Use this function to change how your slider is to be
15962 * disposed: vertically or horizontally.
15964 * By default it's displayed horizontally.
15966 * @see elm_slider_horizontal_get()
15970 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15973 * Retrieve the orientation of a given slider widget
15975 * @param obj The slider object.
15976 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
15977 * @c EINA_FALSE if it's @b vertical (and on errors).
15979 * @see elm_slider_horizontal_set() for more details.
15983 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15986 * Set the minimum and maximum values for the slider.
15988 * @param obj The slider object.
15989 * @param min The minimum value.
15990 * @param max The maximum value.
15992 * Define the allowed range of values to be selected by the user.
15994 * If actual value is less than @p min, it will be updated to @p min. If it
15995 * is bigger then @p max, will be updated to @p max. Actual value can be
15996 * get with elm_slider_value_get().
15998 * By default, min is equal to 0.0, and max is equal to 1.0.
16000 * @warning Maximum must be greater than minimum, otherwise behavior
16003 * @see elm_slider_min_max_get()
16007 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16010 * Get the minimum and maximum values of the slider.
16012 * @param obj The slider object.
16013 * @param min Pointer where to store the minimum value.
16014 * @param max Pointer where to store the maximum value.
16016 * @note If only one value is needed, the other pointer can be passed
16019 * @see elm_slider_min_max_set() for details.
16023 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16026 * Set the value the slider displays.
16028 * @param obj The slider object.
16029 * @param val The value to be displayed.
16031 * Value will be presented on the unit label following format specified with
16032 * elm_slider_unit_format_set() and on indicator with
16033 * elm_slider_indicator_format_set().
16035 * @warning The value must to be between min and max values. This values
16036 * are set by elm_slider_min_max_set().
16038 * @see elm_slider_value_get()
16039 * @see elm_slider_unit_format_set()
16040 * @see elm_slider_indicator_format_set()
16041 * @see elm_slider_min_max_set()
16045 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16048 * Get the value displayed by the spinner.
16050 * @param obj The spinner object.
16051 * @return The value displayed.
16053 * @see elm_spinner_value_set() for details.
16057 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16060 * Invert a given slider widget's displaying values order
16062 * @param obj The slider object.
16063 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16064 * @c EINA_FALSE to bring it back to default, non-inverted values.
16066 * A slider may be @b inverted, in which state it gets its
16067 * values inverted, with high vales being on the left or top and
16068 * low values on the right or bottom, as opposed to normally have
16069 * the low values on the former and high values on the latter,
16070 * respectively, for horizontal and vertical modes.
16072 * @see elm_slider_inverted_get()
16076 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16079 * Get whether a given slider widget's displaying values are
16082 * @param obj The slider object.
16083 * @return @c EINA_TRUE, if @p obj has inverted values,
16084 * @c EINA_FALSE otherwise (and on errors).
16086 * @see elm_slider_inverted_set() for more details.
16090 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16093 * Set whether to enlarge slider indicator (augmented knob) or not.
16095 * @param obj The slider object.
16096 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16097 * let the knob always at default size.
16099 * By default, indicator will be bigger while dragged by the user.
16101 * @warning It won't display values set with
16102 * elm_slider_indicator_format_set() if you disable indicator.
16106 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16109 * Get whether a given slider widget's enlarging indicator or not.
16111 * @param obj The slider object.
16112 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16113 * @c EINA_FALSE otherwise (and on errors).
16115 * @see elm_slider_indicator_show_set() for details.
16119 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16126 * @addtogroup Actionslider Actionslider
16128 * @image html img/widget/actionslider/preview-00.png
16129 * @image latex img/widget/actionslider/preview-00.eps
16131 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16132 * properties. The indicator is the element the user drags to choose a label.
16133 * When the position is set with magnet, when released the indicator will be
16134 * moved to it if it's nearest the magnetized position.
16136 * @note By default all positions are set as enabled.
16138 * Signals that you can add callbacks for are:
16140 * "selected" - when user selects an enabled position (the label is passed
16143 * "pos_changed" - when the indicator reaches any of the positions("left",
16144 * "right" or "center").
16146 * See an example of actionslider usage @ref actionslider_example_page "here"
16149 typedef enum _Elm_Actionslider_Pos
16151 ELM_ACTIONSLIDER_NONE = 0,
16152 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16153 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16154 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16155 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16156 } Elm_Actionslider_Pos;
16159 * Add a new actionslider to the parent.
16161 * @param parent The parent object
16162 * @return The new actionslider object or NULL if it cannot be created
16164 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16166 * Set actionslider labels.
16168 * @param obj The actionslider object
16169 * @param left_label The label to be set on the left.
16170 * @param center_label The label to be set on the center.
16171 * @param right_label The label to be set on the right.
16172 * @deprecated use elm_object_text_set() instead.
16174 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);
16176 * Get actionslider labels.
16178 * @param obj The actionslider object
16179 * @param left_label A char** to place the left_label of @p obj into.
16180 * @param center_label A char** to place the center_label of @p obj into.
16181 * @param right_label A char** to place the right_label of @p obj into.
16182 * @deprecated use elm_object_text_set() instead.
16184 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);
16186 * Get actionslider selected label.
16188 * @param obj The actionslider object
16189 * @return The selected label
16191 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16193 * Set actionslider indicator position.
16195 * @param obj The actionslider object.
16196 * @param pos The position of the indicator.
16198 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16200 * Get actionslider indicator position.
16202 * @param obj The actionslider object.
16203 * @return The position of the indicator.
16205 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16207 * Set actionslider magnet position. To make multiple positions magnets @c or
16208 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16210 * @param obj The actionslider object.
16211 * @param pos Bit mask indicating the magnet positions.
16213 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16215 * Get actionslider magnet position.
16217 * @param obj The actionslider object.
16218 * @return The positions with magnet property.
16220 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16222 * Set actionslider enabled position. To set multiple positions as enabled @c or
16223 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16225 * @note All the positions are enabled by default.
16227 * @param obj The actionslider object.
16228 * @param pos Bit mask indicating the enabled positions.
16230 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16232 * Get actionslider enabled position.
16234 * @param obj The actionslider object.
16235 * @return The enabled positions.
16237 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16239 * Set the label used on the indicator.
16241 * @param obj The actionslider object
16242 * @param label The label to be set on the indicator.
16243 * @deprecated use elm_object_text_set() instead.
16245 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16247 * Get the label used on the indicator object.
16249 * @param obj The actionslider object
16250 * @return The indicator label
16251 * @deprecated use elm_object_text_get() instead.
16253 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16259 * @defgroup Genlist Genlist
16261 * @image html img/widget/genlist/preview-00.png
16262 * @image latex img/widget/genlist/preview-00.eps
16263 * @image html img/genlist.png
16264 * @image latex img/genlist.eps
16266 * This widget aims to have more expansive list than the simple list in
16267 * Elementary that could have more flexible items and allow many more entries
16268 * while still being fast and low on memory usage. At the same time it was
16269 * also made to be able to do tree structures. But the price to pay is more
16270 * complexity when it comes to usage. If all you want is a simple list with
16271 * icons and a single label, use the normal @ref List object.
16273 * Genlist has a fairly large API, mostly because it's relatively complex,
16274 * trying to be both expansive, powerful and efficient. First we will begin
16275 * an overview on the theory behind genlist.
16277 * @section Genlist_Item_Class Genlist item classes - creating items
16279 * In order to have the ability to add and delete items on the fly, genlist
16280 * implements a class (callback) system where the application provides a
16281 * structure with information about that type of item (genlist may contain
16282 * multiple different items with different classes, states and styles).
16283 * Genlist will call the functions in this struct (methods) when an item is
16284 * "realized" (i.e., created dynamically, while the user is scrolling the
16285 * grid). All objects will simply be deleted when no longer needed with
16286 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16287 * following members:
16288 * - @c item_style - This is a constant string and simply defines the name
16289 * of the item style. It @b must be specified and the default should be @c
16291 * - @c mode_item_style - This is a constant string and simply defines the
16292 * name of the style that will be used for mode animations. It can be left
16293 * as @c NULL if you don't plan to use Genlist mode. See
16294 * elm_genlist_item_mode_set() for more info.
16296 * - @c func - A struct with pointers to functions that will be called when
16297 * an item is going to be actually created. All of them receive a @c data
16298 * parameter that will point to the same data passed to
16299 * elm_genlist_item_append() and related item creation functions, and a @c
16300 * obj parameter that points to the genlist object itself.
16302 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16303 * state_get and @c del. The 3 first functions also receive a @c part
16304 * parameter described below. A brief description of these functions follows:
16306 * - @c label_get - The @c part parameter is the name string of one of the
16307 * existing text parts in the Edje group implementing the item's theme.
16308 * This function @b must return a strdup'()ed string, as the caller will
16309 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16310 * - @c icon_get - The @c part parameter is the name string of one of the
16311 * existing (icon) swallow parts in the Edje group implementing the item's
16312 * theme. It must return @c NULL, when no icon is desired, or a valid
16313 * object handle, otherwise. The object will be deleted by the genlist on
16314 * its deletion or when the item is "unrealized". See
16315 * #Elm_Genlist_Item_Icon_Get_Cb.
16316 * - @c func.state_get - The @c part parameter is the name string of one of
16317 * the state parts in the Edje group implementing the item's theme. Return
16318 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16319 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16320 * and @c "elm" as "emission" and "source" arguments, respectively, when
16321 * the state is true (the default is false), where @c XXX is the name of
16322 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16323 * - @c func.del - This is intended for use when genlist items are deleted,
16324 * so any data attached to the item (e.g. its data parameter on creation)
16325 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16327 * available item styles:
16329 * - default_style - The text part is a textblock
16331 * @image html img/widget/genlist/preview-04.png
16332 * @image latex img/widget/genlist/preview-04.eps
16336 * @image html img/widget/genlist/preview-01.png
16337 * @image latex img/widget/genlist/preview-01.eps
16339 * - icon_top_text_bottom
16341 * @image html img/widget/genlist/preview-02.png
16342 * @image latex img/widget/genlist/preview-02.eps
16346 * @image html img/widget/genlist/preview-03.png
16347 * @image latex img/widget/genlist/preview-03.eps
16349 * @section Genlist_Items Structure of items
16351 * An item in a genlist can have 0 or more text labels (they can be regular
16352 * text or textblock Evas objects - that's up to the style to determine), 0
16353 * or more icons (which are simply objects swallowed into the genlist item's
16354 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16355 * behavior left to the user to define. The Edje part names for each of
16356 * these properties will be looked up, in the theme file for the genlist,
16357 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16358 * "states", respectively. For each of those properties, if more than one
16359 * part is provided, they must have names listed separated by spaces in the
16360 * data fields. For the default genlist item theme, we have @b one label
16361 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16362 * "elm.swallow.end") and @b no state parts.
16364 * A genlist item may be at one of several styles. Elementary provides one
16365 * by default - "default", but this can be extended by system or application
16366 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16369 * @section Genlist_Manipulation Editing and Navigating
16371 * Items can be added by several calls. All of them return a @ref
16372 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16373 * They all take a data parameter that is meant to be used for a handle to
16374 * the applications internal data (eg the struct with the original item
16375 * data). The parent parameter is the parent genlist item this belongs to if
16376 * it is a tree or an indexed group, and NULL if there is no parent. The
16377 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16378 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16379 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16380 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16381 * is set then this item is group index item that is displayed at the top
16382 * until the next group comes. The func parameter is a convenience callback
16383 * that is called when the item is selected and the data parameter will be
16384 * the func_data parameter, obj be the genlist object and event_info will be
16385 * the genlist item.
16387 * elm_genlist_item_append() adds an item to the end of the list, or if
16388 * there is a parent, to the end of all the child items of the parent.
16389 * elm_genlist_item_prepend() is the same but adds to the beginning of
16390 * the list or children list. elm_genlist_item_insert_before() inserts at
16391 * item before another item and elm_genlist_item_insert_after() inserts after
16392 * the indicated item.
16394 * The application can clear the list with elm_genlist_clear() which deletes
16395 * all the items in the list and elm_genlist_item_del() will delete a specific
16396 * item. elm_genlist_item_subitems_clear() will clear all items that are
16397 * children of the indicated parent item.
16399 * To help inspect list items you can jump to the item at the top of the list
16400 * with elm_genlist_first_item_get() which will return the item pointer, and
16401 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16402 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16403 * and previous items respectively relative to the indicated item. Using
16404 * these calls you can walk the entire item list/tree. Note that as a tree
16405 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16406 * let you know which item is the parent (and thus know how to skip them if
16409 * @section Genlist_Muti_Selection Multi-selection
16411 * If the application wants multiple items to be able to be selected,
16412 * elm_genlist_multi_select_set() can enable this. If the list is
16413 * single-selection only (the default), then elm_genlist_selected_item_get()
16414 * will return the selected item, if any, or NULL I none is selected. If the
16415 * list is multi-select then elm_genlist_selected_items_get() will return a
16416 * list (that is only valid as long as no items are modified (added, deleted,
16417 * selected or unselected)).
16419 * @section Genlist_Usage_Hints Usage hints
16421 * There are also convenience functions. elm_genlist_item_genlist_get() will
16422 * return the genlist object the item belongs to. elm_genlist_item_show()
16423 * will make the scroller scroll to show that specific item so its visible.
16424 * elm_genlist_item_data_get() returns the data pointer set by the item
16425 * creation functions.
16427 * If an item changes (state of boolean changes, label or icons change),
16428 * then use elm_genlist_item_update() to have genlist update the item with
16429 * the new state. Genlist will re-realize the item thus call the functions
16430 * in the _Elm_Genlist_Item_Class for that item.
16432 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16433 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16434 * to expand/contract an item and get its expanded state, use
16435 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16436 * again to make an item disabled (unable to be selected and appear
16437 * differently) use elm_genlist_item_disabled_set() to set this and
16438 * elm_genlist_item_disabled_get() to get the disabled state.
16440 * In general to indicate how the genlist should expand items horizontally to
16441 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16442 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16443 * mode means that if items are too wide to fit, the scroller will scroll
16444 * horizontally. Otherwise items are expanded to fill the width of the
16445 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16446 * to the viewport width and limited to that size. This can be combined with
16447 * a different style that uses edjes' ellipsis feature (cutting text off like
16450 * Items will only call their selection func and callback when first becoming
16451 * selected. Any further clicks will do nothing, unless you enable always
16452 * select with elm_genlist_always_select_mode_set(). This means even if
16453 * selected, every click will make the selected callbacks be called.
16454 * elm_genlist_no_select_mode_set() will turn off the ability to select
16455 * items entirely and they will neither appear selected nor call selected
16456 * callback functions.
16458 * Remember that you can create new styles and add your own theme augmentation
16459 * per application with elm_theme_extension_add(). If you absolutely must
16460 * have a specific style that overrides any theme the user or system sets up
16461 * you can use elm_theme_overlay_add() to add such a file.
16463 * @section Genlist_Implementation Implementation
16465 * Evas tracks every object you create. Every time it processes an event
16466 * (mouse move, down, up etc.) it needs to walk through objects and find out
16467 * what event that affects. Even worse every time it renders display updates,
16468 * in order to just calculate what to re-draw, it needs to walk through many
16469 * many many objects. Thus, the more objects you keep active, the more
16470 * overhead Evas has in just doing its work. It is advisable to keep your
16471 * active objects to the minimum working set you need. Also remember that
16472 * object creation and deletion carries an overhead, so there is a
16473 * middle-ground, which is not easily determined. But don't keep massive lists
16474 * of objects you can't see or use. Genlist does this with list objects. It
16475 * creates and destroys them dynamically as you scroll around. It groups them
16476 * into blocks so it can determine the visibility etc. of a whole block at
16477 * once as opposed to having to walk the whole list. This 2-level list allows
16478 * for very large numbers of items to be in the list (tests have used up to
16479 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16480 * may be different sizes, every item added needs to be calculated as to its
16481 * size and thus this presents a lot of overhead on populating the list, this
16482 * genlist employs a queue. Any item added is queued and spooled off over
16483 * time, actually appearing some time later, so if your list has many members
16484 * you may find it takes a while for them to all appear, with your process
16485 * consuming a lot of CPU while it is busy spooling.
16487 * Genlist also implements a tree structure, but it does so with callbacks to
16488 * the application, with the application filling in tree structures when
16489 * requested (allowing for efficient building of a very deep tree that could
16490 * even be used for file-management). See the above smart signal callbacks for
16493 * @section Genlist_Smart_Events Genlist smart events
16495 * Signals that you can add callbacks for are:
16496 * - @c "activated" - The user has double-clicked or pressed
16497 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16498 * item that was activated.
16499 * - @c "clicked,double" - The user has double-clicked an item. The @c
16500 * event_info parameter is the item that was double-clicked.
16501 * - @c "selected" - This is called when a user has made an item selected.
16502 * The event_info parameter is the genlist item that was selected.
16503 * - @c "unselected" - This is called when a user has made an item
16504 * unselected. The event_info parameter is the genlist item that was
16506 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16507 * called and the item is now meant to be expanded. The event_info
16508 * parameter is the genlist item that was indicated to expand. It is the
16509 * job of this callback to then fill in the child items.
16510 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16511 * called and the item is now meant to be contracted. The event_info
16512 * parameter is the genlist item that was indicated to contract. It is the
16513 * job of this callback to then delete the child items.
16514 * - @c "expand,request" - This is called when a user has indicated they want
16515 * to expand a tree branch item. The callback should decide if the item can
16516 * expand (has any children) and then call elm_genlist_item_expanded_set()
16517 * appropriately to set the state. The event_info parameter is the genlist
16518 * item that was indicated to expand.
16519 * - @c "contract,request" - This is called when a user has indicated they
16520 * want to contract a tree branch item. The callback should decide if the
16521 * item can contract (has any children) and then call
16522 * elm_genlist_item_expanded_set() appropriately to set the state. The
16523 * event_info parameter is the genlist item that was indicated to contract.
16524 * - @c "realized" - This is called when the item in the list is created as a
16525 * real evas object. event_info parameter is the genlist item that was
16526 * created. The object may be deleted at any time, so it is up to the
16527 * caller to not use the object pointer from elm_genlist_item_object_get()
16528 * in a way where it may point to freed objects.
16529 * - @c "unrealized" - This is called just before an item is unrealized.
16530 * After this call icon objects provided will be deleted and the item
16531 * object itself delete or be put into a floating cache.
16532 * - @c "drag,start,up" - This is called when the item in the list has been
16533 * dragged (not scrolled) up.
16534 * - @c "drag,start,down" - This is called when the item in the list has been
16535 * dragged (not scrolled) down.
16536 * - @c "drag,start,left" - This is called when the item in the list has been
16537 * dragged (not scrolled) left.
16538 * - @c "drag,start,right" - This is called when the item in the list has
16539 * been dragged (not scrolled) right.
16540 * - @c "drag,stop" - This is called when the item in the list has stopped
16542 * - @c "drag" - This is called when the item in the list is being dragged.
16543 * - @c "longpressed" - This is called when the item is pressed for a certain
16544 * amount of time. By default it's 1 second.
16545 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16547 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16548 * until the bottom edge.
16549 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16550 * until the left edge.
16551 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16552 * until the right edge.
16553 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16555 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16557 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16559 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16561 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16562 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16563 * multi-touch pinched in.
16564 * - @c "swipe" - This is called when the genlist is swiped.
16566 * @section Genlist_Examples Examples
16568 * Here is a list of examples that use the genlist, trying to show some of
16569 * its capabilities:
16570 * - @ref genlist_example_01
16571 * - @ref genlist_example_02
16572 * - @ref genlist_example_03
16573 * - @ref genlist_example_04
16574 * - @ref genlist_example_05
16578 * @addtogroup Genlist
16583 * @enum _Elm_Genlist_Item_Flags
16584 * @typedef Elm_Genlist_Item_Flags
16586 * Defines if the item is of any special type (has subitems or it's the
16587 * index of a group), or is just a simple item.
16591 typedef enum _Elm_Genlist_Item_Flags
16593 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16594 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16595 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16596 } Elm_Genlist_Item_Flags;
16597 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16598 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16599 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16600 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16601 typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
16602 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
16603 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16604 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16606 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16607 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16608 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16609 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16612 * @struct _Elm_Genlist_Item_Class
16614 * Genlist item class definition structs.
16616 * This struct contains the style and fetching functions that will define the
16617 * contents of each item.
16619 * @see @ref Genlist_Item_Class
16621 struct _Elm_Genlist_Item_Class
16623 const char *item_style; /**< style of this class. */
16626 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16627 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16628 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16629 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16630 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16632 const char *mode_item_style;
16636 * Add a new genlist widget to the given parent Elementary
16637 * (container) object
16639 * @param parent The parent object
16640 * @return a new genlist widget handle or @c NULL, on errors
16642 * This function inserts a new genlist widget on the canvas.
16644 * @see elm_genlist_item_append()
16645 * @see elm_genlist_item_del()
16646 * @see elm_genlist_clear()
16650 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16652 * Remove all items from a given genlist widget.
16654 * @param obj The genlist object
16656 * This removes (and deletes) all items in @p obj, leaving it empty.
16658 * @see elm_genlist_item_del(), to remove just one item.
16662 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16664 * Enable or disable multi-selection in the genlist
16666 * @param obj The genlist object
16667 * @param multi Multi-select enable/disable. Default is disabled.
16669 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16670 * the list. This allows more than 1 item to be selected. To retrieve the list
16671 * of selected items, use elm_genlist_selected_items_get().
16673 * @see elm_genlist_selected_items_get()
16674 * @see elm_genlist_multi_select_get()
16678 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16680 * Gets if multi-selection in genlist is enabled or disabled.
16682 * @param obj The genlist object
16683 * @return Multi-select enabled/disabled
16684 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16686 * @see elm_genlist_multi_select_set()
16690 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16692 * This sets the horizontal stretching mode.
16694 * @param obj The genlist object
16695 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16697 * This sets the mode used for sizing items horizontally. Valid modes
16698 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16699 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16700 * the scroller will scroll horizontally. Otherwise items are expanded
16701 * to fill the width of the viewport of the scroller. If it is
16702 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16703 * limited to that size.
16705 * @see elm_genlist_horizontal_get()
16709 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16710 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16712 * Gets the horizontal stretching mode.
16714 * @param obj The genlist object
16715 * @return The mode to use
16716 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16718 * @see elm_genlist_horizontal_set()
16722 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16723 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16725 * Set the always select mode.
16727 * @param obj The genlist object
16728 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16729 * EINA_FALSE = off). Default is @c EINA_FALSE.
16731 * Items will only call their selection func and callback when first
16732 * becoming selected. Any further clicks will do nothing, unless you
16733 * enable always select with elm_genlist_always_select_mode_set().
16734 * This means that, even if selected, every click will make the selected
16735 * callbacks be called.
16737 * @see elm_genlist_always_select_mode_get()
16741 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16743 * Get the always select mode.
16745 * @param obj The genlist object
16746 * @return The always select mode
16747 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16749 * @see elm_genlist_always_select_mode_set()
16753 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16755 * Enable/disable the no select mode.
16757 * @param obj The genlist object
16758 * @param no_select The no select mode
16759 * (EINA_TRUE = on, EINA_FALSE = off)
16761 * This will turn off the ability to select items entirely and they
16762 * will neither appear selected nor call selected callback functions.
16764 * @see elm_genlist_no_select_mode_get()
16768 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16770 * Gets whether the no select mode is enabled.
16772 * @param obj The genlist object
16773 * @return The no select mode
16774 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16776 * @see elm_genlist_no_select_mode_set()
16780 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16782 * Enable/disable compress mode.
16784 * @param obj The genlist object
16785 * @param compress The compress mode
16786 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16788 * This will enable the compress mode where items are "compressed"
16789 * horizontally to fit the genlist scrollable viewport width. This is
16790 * special for genlist. Do not rely on
16791 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16792 * work as genlist needs to handle it specially.
16794 * @see elm_genlist_compress_mode_get()
16798 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16800 * Get whether the compress mode is enabled.
16802 * @param obj The genlist object
16803 * @return The compress mode
16804 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16806 * @see elm_genlist_compress_mode_set()
16810 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16812 * Enable/disable height-for-width mode.
16814 * @param obj The genlist object
16815 * @param setting The height-for-width mode (@c EINA_TRUE = on,
16816 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16818 * With height-for-width mode the item width will be fixed (restricted
16819 * to a minimum of) to the list width when calculating its size in
16820 * order to allow the height to be calculated based on it. This allows,
16821 * for instance, text block to wrap lines if the Edje part is
16822 * configured with "text.min: 0 1".
16824 * @note This mode will make list resize slower as it will have to
16825 * recalculate every item height again whenever the list width
16828 * @note When height-for-width mode is enabled, it also enables
16829 * compress mode (see elm_genlist_compress_mode_set()) and
16830 * disables homogeneous (see elm_genlist_homogeneous_set()).
16834 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16836 * Get whether the height-for-width mode is enabled.
16838 * @param obj The genlist object
16839 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16844 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16846 * Enable/disable horizontal and vertical bouncing effect.
16848 * @param obj The genlist object
16849 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16850 * EINA_FALSE = off). Default is @c EINA_FALSE.
16851 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16852 * EINA_FALSE = off). Default is @c EINA_TRUE.
16854 * This will enable or disable the scroller bouncing effect for the
16855 * genlist. See elm_scroller_bounce_set() for details.
16857 * @see elm_scroller_bounce_set()
16858 * @see elm_genlist_bounce_get()
16862 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16864 * Get whether the horizontal and vertical bouncing effect is enabled.
16866 * @param obj The genlist object
16867 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16869 * @param v_bounce Pointer to a bool to receive if the bounce vertically
16872 * @see elm_genlist_bounce_set()
16876 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16878 * Enable/disable homogenous mode.
16880 * @param obj The genlist object
16881 * @param homogeneous Assume the items within the genlist are of the
16882 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16885 * This will enable the homogeneous mode where items are of the same
16886 * height and width so that genlist may do the lazy-loading at its
16887 * maximum (which increases the performance for scrolling the list). This
16888 * implies 'compressed' mode.
16890 * @see elm_genlist_compress_mode_set()
16891 * @see elm_genlist_homogeneous_get()
16895 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16897 * Get whether the homogenous mode is enabled.
16899 * @param obj The genlist object
16900 * @return Assume the items within the genlist are of the same height
16901 * and width (EINA_TRUE = on, EINA_FALSE = off)
16903 * @see elm_genlist_homogeneous_set()
16907 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16909 * Set the maximum number of items within an item block
16911 * @param obj The genlist object
16912 * @param n Maximum number of items within an item block. Default is 32.
16914 * This will configure the block count to tune to the target with
16915 * particular performance matrix.
16917 * A block of objects will be used to reduce the number of operations due to
16918 * many objects in the screen. It can determine the visibility, or if the
16919 * object has changed, it theme needs to be updated, etc. doing this kind of
16920 * calculation to the entire block, instead of per object.
16922 * The default value for the block count is enough for most lists, so unless
16923 * you know you will have a lot of objects visible in the screen at the same
16924 * time, don't try to change this.
16926 * @see elm_genlist_block_count_get()
16927 * @see @ref Genlist_Implementation
16931 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
16933 * Get the maximum number of items within an item block
16935 * @param obj The genlist object
16936 * @return Maximum number of items within an item block
16938 * @see elm_genlist_block_count_set()
16942 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16944 * Set the timeout in seconds for the longpress event.
16946 * @param obj The genlist object
16947 * @param timeout timeout in seconds. Default is 1.
16949 * This option will change how long it takes to send an event "longpressed"
16950 * after the mouse down signal is sent to the list. If this event occurs, no
16951 * "clicked" event will be sent.
16953 * @see elm_genlist_longpress_timeout_set()
16957 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16959 * Get the timeout in seconds for the longpress event.
16961 * @param obj The genlist object
16962 * @return timeout in seconds
16964 * @see elm_genlist_longpress_timeout_get()
16968 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16970 * Append a new item in a given genlist widget.
16972 * @param obj The genlist object
16973 * @param itc The item class for the item
16974 * @param data The item data
16975 * @param parent The parent item, or NULL if none
16976 * @param flags Item flags
16977 * @param func Convenience function called when the item is selected
16978 * @param func_data Data passed to @p func above.
16979 * @return A handle to the item added or @c NULL if not possible
16981 * This adds the given item to the end of the list or the end of
16982 * the children list if the @p parent is given.
16984 * @see elm_genlist_item_prepend()
16985 * @see elm_genlist_item_insert_before()
16986 * @see elm_genlist_item_insert_after()
16987 * @see elm_genlist_item_del()
16991 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);
16993 * Prepend a new item in a given genlist widget.
16995 * @param obj The genlist object
16996 * @param itc The item class for the item
16997 * @param data The item data
16998 * @param parent The parent item, or NULL if none
16999 * @param flags Item flags
17000 * @param func Convenience function called when the item is selected
17001 * @param func_data Data passed to @p func above.
17002 * @return A handle to the item added or NULL if not possible
17004 * This adds an item to the beginning of the list or beginning of the
17005 * children of the parent if given.
17007 * @see elm_genlist_item_append()
17008 * @see elm_genlist_item_insert_before()
17009 * @see elm_genlist_item_insert_after()
17010 * @see elm_genlist_item_del()
17014 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);
17016 * Insert an item before another in a genlist widget
17018 * @param obj The genlist object
17019 * @param itc The item class for the item
17020 * @param data The item data
17021 * @param before The item to place this new one before.
17022 * @param flags Item flags
17023 * @param func Convenience function called when the item is selected
17024 * @param func_data Data passed to @p func above.
17025 * @return A handle to the item added or @c NULL if not possible
17027 * This inserts an item before another in the list. It will be in the
17028 * same tree level or group as the item it is inserted before.
17030 * @see elm_genlist_item_append()
17031 * @see elm_genlist_item_prepend()
17032 * @see elm_genlist_item_insert_after()
17033 * @see elm_genlist_item_del()
17037 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);
17039 * Insert an item after another in a genlist widget
17041 * @param obj The genlist object
17042 * @param itc The item class for the item
17043 * @param data The item data
17044 * @param after The item to place this new one after.
17045 * @param flags Item flags
17046 * @param func Convenience function called when the item is selected
17047 * @param func_data Data passed to @p func above.
17048 * @return A handle to the item added or @c NULL if not possible
17050 * This inserts an item after another in the list. It will be in the
17051 * same tree level or group as the item it is inserted after.
17053 * @see elm_genlist_item_append()
17054 * @see elm_genlist_item_prepend()
17055 * @see elm_genlist_item_insert_before()
17056 * @see elm_genlist_item_del()
17060 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);
17062 * Insert a new item into the sorted genlist object
17064 * @param obj The genlist object
17065 * @param itc The item class for the item
17066 * @param data The item data
17067 * @param parent The parent item, or NULL if none
17068 * @param flags Item flags
17069 * @param comp The function called for the sort
17070 * @param func Convenience function called when item selected
17071 * @param func_data Data passed to @p func above.
17072 * @return A handle to the item added or NULL if not possible
17076 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);
17077 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);
17078 /* operations to retrieve existing items */
17080 * Get the selectd item in the genlist.
17082 * @param obj The genlist object
17083 * @return The selected item, or NULL if none is selected.
17085 * This gets the selected item in the list (if multi-selection is enabled, only
17086 * the item that was first selected in the list is returned - which is not very
17087 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17090 * If no item is selected, NULL is returned.
17092 * @see elm_genlist_selected_items_get()
17096 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17098 * Get a list of selected items in the genlist.
17100 * @param obj The genlist object
17101 * @return The list of selected items, or NULL if none are selected.
17103 * It returns a list of the selected items. This list pointer is only valid so
17104 * long as the selection doesn't change (no items are selected or unselected, or
17105 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17106 * pointers. The order of the items in this list is the order which they were
17107 * selected, i.e. the first item in this list is the first item that was
17108 * selected, and so on.
17110 * @note If not in multi-select mode, consider using function
17111 * elm_genlist_selected_item_get() instead.
17113 * @see elm_genlist_multi_select_set()
17114 * @see elm_genlist_selected_item_get()
17118 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17120 * Get a list of realized items in genlist
17122 * @param obj The genlist object
17123 * @return The list of realized items, nor NULL if none are realized.
17125 * This returns a list of the realized items in the genlist. The list
17126 * contains Elm_Genlist_Item pointers. The list must be freed by the
17127 * caller when done with eina_list_free(). The item pointers in the
17128 * list are only valid so long as those items are not deleted or the
17129 * genlist is not deleted.
17131 * @see elm_genlist_realized_items_update()
17135 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17137 * Get the item that is at the x, y canvas coords.
17139 * @param obj The gelinst object.
17140 * @param x The input x coordinate
17141 * @param y The input y coordinate
17142 * @param posret The position relative to the item returned here
17143 * @return The item at the coordinates or NULL if none
17145 * This returns the item at the given coordinates (which are canvas
17146 * relative, not object-relative). If an item is at that coordinate,
17147 * that item handle is returned, and if @p posret is not NULL, the
17148 * integer pointed to is set to a value of -1, 0 or 1, depending if
17149 * the coordinate is on the upper portion of that item (-1), on the
17150 * middle section (0) or on the lower part (1). If NULL is returned as
17151 * an item (no item found there), then posret may indicate -1 or 1
17152 * based if the coordinate is above or below all items respectively in
17157 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);
17159 * Get the first item in the genlist
17161 * This returns the first item in the list.
17163 * @param obj The genlist object
17164 * @return The first item, or NULL if none
17168 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17170 * Get the last item in the genlist
17172 * This returns the last item in the list.
17174 * @return The last item, or NULL if none
17178 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17180 * Set the scrollbar policy
17182 * @param obj The genlist object
17183 * @param policy_h Horizontal scrollbar policy.
17184 * @param policy_v Vertical scrollbar policy.
17186 * This sets the scrollbar visibility policy for the given genlist
17187 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17188 * made visible if it is needed, and otherwise kept hidden.
17189 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17190 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17191 * respectively for the horizontal and vertical scrollbars. Default is
17192 * #ELM_SMART_SCROLLER_POLICY_AUTO
17194 * @see elm_genlist_scroller_policy_get()
17198 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17200 * Get the scrollbar policy
17202 * @param obj The genlist object
17203 * @param policy_h Pointer to store the horizontal scrollbar policy.
17204 * @param policy_v Pointer to store the vertical scrollbar policy.
17206 * @see elm_genlist_scroller_policy_set()
17210 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);
17212 * Get the @b next item in a genlist widget's internal list of items,
17213 * given a handle to one of those items.
17215 * @param item The genlist item to fetch next from
17216 * @return The item after @p item, or @c NULL if there's none (and
17219 * This returns the item placed after the @p item, on the container
17222 * @see elm_genlist_item_prev_get()
17226 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17228 * Get the @b previous item in a genlist widget's internal list of items,
17229 * given a handle to one of those items.
17231 * @param item The genlist item to fetch previous from
17232 * @return The item before @p item, or @c NULL if there's none (and
17235 * This returns the item placed before the @p item, on the container
17238 * @see elm_genlist_item_next_get()
17242 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17244 * Get the genlist object's handle which contains a given genlist
17247 * @param item The item to fetch the container from
17248 * @return The genlist (parent) object
17250 * This returns the genlist object itself that an item belongs to.
17254 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17256 * Get the parent item of the given item
17258 * @param it The item
17259 * @return The parent of the item or @c NULL if it has no parent.
17261 * This returns the item that was specified as parent of the item @p it on
17262 * elm_genlist_item_append() and insertion related functions.
17266 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17268 * Remove all sub-items (children) of the given item
17270 * @param it The item
17272 * This removes all items that are children (and their descendants) of the
17273 * given item @p it.
17275 * @see elm_genlist_clear()
17276 * @see elm_genlist_item_del()
17280 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17282 * Set whether a given genlist item is selected or not
17284 * @param it The item
17285 * @param selected Use @c EINA_TRUE, to make it selected, @c
17286 * EINA_FALSE to make it unselected
17288 * This sets the selected state of an item. If multi selection is
17289 * not enabled on the containing genlist and @p selected is @c
17290 * EINA_TRUE, any other previously selected items will get
17291 * unselected in favor of this new one.
17293 * @see elm_genlist_item_selected_get()
17297 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17299 * Get whether a given genlist item is selected or not
17301 * @param it The item
17302 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17304 * @see elm_genlist_item_selected_set() for more details
17308 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17310 * Sets the expanded state of an item.
17312 * @param it The item
17313 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17315 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17318 * The theme will respond to this change visually, and a signal "expanded" or
17319 * "contracted" will be sent from the genlist with a pointer to the item that
17320 * has been expanded/contracted.
17322 * Calling this function won't show or hide any child of this item (if it is
17323 * a parent). You must manually delete and create them on the callbacks fo
17324 * the "expanded" or "contracted" signals.
17326 * @see elm_genlist_item_expanded_get()
17330 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17332 * Get the expanded state of an item
17334 * @param it The item
17335 * @return The expanded state
17337 * This gets the expanded state of an item.
17339 * @see elm_genlist_item_expanded_set()
17343 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17345 * Get the depth of expanded item
17347 * @param it The genlist item object
17348 * @return The depth of expanded item
17352 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17354 * Set whether a given genlist item is disabled or not.
17356 * @param it The item
17357 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17358 * to enable it back.
17360 * A disabled item cannot be selected or unselected. It will also
17361 * change its appearance, to signal the user it's disabled.
17363 * @see elm_genlist_item_disabled_get()
17367 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17369 * Get whether a given genlist item is disabled or not.
17371 * @param it The item
17372 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17375 * @see elm_genlist_item_disabled_set() for more details
17379 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17381 * Sets the display only state of an item.
17383 * @param it The item
17384 * @param display_only @c EINA_TRUE if the item is display only, @c
17385 * EINA_FALSE otherwise.
17387 * A display only item cannot be selected or unselected. It is for
17388 * display only and not selecting or otherwise clicking, dragging
17389 * etc. by the user, thus finger size rules will not be applied to
17392 * It's good to set group index items to display only state.
17394 * @see elm_genlist_item_display_only_get()
17398 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17400 * Get the display only state of an item
17402 * @param it The item
17403 * @return @c EINA_TRUE if the item is display only, @c
17404 * EINA_FALSE otherwise.
17406 * @see elm_genlist_item_display_only_set()
17410 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17412 * Show the portion of a genlist's internal list containing a given
17413 * item, immediately.
17415 * @param it The item to display
17417 * This causes genlist to jump to the given item @p it and show it (by
17418 * immediately scrolling to that position), if it is not fully visible.
17420 * @see elm_genlist_item_bring_in()
17421 * @see elm_genlist_item_top_show()
17422 * @see elm_genlist_item_middle_show()
17426 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17428 * Animatedly bring in, to the visible are of a genlist, a given
17431 * @param it The item to display
17433 * This causes genlist to jump to the given item @p it and show it (by
17434 * animatedly scrolling), if it is not fully visible. This may use animation
17435 * to do so and take a period of time
17437 * @see elm_genlist_item_show()
17438 * @see elm_genlist_item_top_bring_in()
17439 * @see elm_genlist_item_middle_bring_in()
17443 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17445 * Show the portion of a genlist's internal list containing a given
17446 * item, immediately.
17448 * @param it The item to display
17450 * This causes genlist to jump to the given item @p it and show it (by
17451 * immediately scrolling to that position), if it is not fully visible.
17453 * The item will be positioned at the top of the genlist viewport.
17455 * @see elm_genlist_item_show()
17456 * @see elm_genlist_item_top_bring_in()
17460 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17462 * Animatedly bring in, to the visible are of a genlist, a given
17465 * @param it The item
17467 * This causes genlist to jump to the given item @p it and show it (by
17468 * animatedly scrolling), if it is not fully visible. This may use animation
17469 * to do so and take a period of time
17471 * The item will be positioned at the top of the genlist viewport.
17473 * @see elm_genlist_item_bring_in()
17474 * @see elm_genlist_item_top_show()
17478 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17480 * Show the portion of a genlist's internal list containing a given
17481 * item, immediately.
17483 * @param it The item to display
17485 * This causes genlist to jump to the given item @p it and show it (by
17486 * immediately scrolling to that position), if it is not fully visible.
17488 * The item will be positioned at the middle of the genlist viewport.
17490 * @see elm_genlist_item_show()
17491 * @see elm_genlist_item_middle_bring_in()
17495 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17497 * Animatedly bring in, to the visible are of a genlist, a given
17500 * @param it The item
17502 * This causes genlist to jump to the given item @p it and show it (by
17503 * animatedly scrolling), if it is not fully visible. This may use animation
17504 * to do so and take a period of time
17506 * The item will be positioned at the middle of the genlist viewport.
17508 * @see elm_genlist_item_bring_in()
17509 * @see elm_genlist_item_middle_show()
17513 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17515 * Remove a genlist item from the its parent, deleting it.
17517 * @param item The item to be removed.
17518 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17520 * @see elm_genlist_clear(), to remove all items in a genlist at
17525 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17527 * Return the data associated to a given genlist item
17529 * @param item The genlist item.
17530 * @return the data associated to this item.
17532 * This returns the @c data value passed on the
17533 * elm_genlist_item_append() and related item addition calls.
17535 * @see elm_genlist_item_append()
17536 * @see elm_genlist_item_data_set()
17540 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17542 * Set the data associated to a given genlist item
17544 * @param item The genlist item
17545 * @param data The new data pointer to set on it
17547 * This @b overrides the @c data value passed on the
17548 * elm_genlist_item_append() and related item addition calls. This
17549 * function @b won't call elm_genlist_item_update() automatically,
17550 * so you'd issue it afterwards if you want to hove the item
17551 * updated to reflect the that new data.
17553 * @see elm_genlist_item_data_get()
17557 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17559 * Tells genlist to "orphan" icons fetchs by the item class
17561 * @param it The item
17563 * This instructs genlist to release references to icons in the item,
17564 * meaning that they will no longer be managed by genlist and are
17565 * floating "orphans" that can be re-used elsewhere if the user wants
17570 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17572 * Get the real Evas object created to implement the view of a
17573 * given genlist item
17575 * @param item The genlist item.
17576 * @return the Evas object implementing this item's view.
17578 * This returns the actual Evas object used to implement the
17579 * specified genlist item's view. This may be @c NULL, as it may
17580 * not have been created or may have been deleted, at any time, by
17581 * the genlist. <b>Do not modify this object</b> (move, resize,
17582 * show, hide, etc.), as the genlist is controlling it. This
17583 * function is for querying, emitting custom signals or hooking
17584 * lower level callbacks for events on that object. Do not delete
17585 * this object under any circumstances.
17587 * @see elm_genlist_item_data_get()
17591 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17593 * Update the contents of an item
17595 * @param it The item
17597 * This updates an item by calling all the item class functions again
17598 * to get the icons, labels and states. Use this when the original
17599 * item data has changed and the changes are desired to be reflected.
17601 * Use elm_genlist_realized_items_update() to update all already realized
17604 * @see elm_genlist_realized_items_update()
17608 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17610 * Update the item class of an item
17612 * @param it The item
17613 * @param itc The item class for the item
17615 * This sets another class fo the item, changing the way that it is
17616 * displayed. After changing the item class, elm_genlist_item_update() is
17617 * called on the item @p it.
17621 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17622 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17624 * Set the text to be shown in a given genlist item's tooltips.
17626 * @param item The genlist item
17627 * @param text The text to set in the content
17629 * This call will setup the text to be used as tooltip to that item
17630 * (analogous to elm_object_tooltip_text_set(), but being item
17631 * tooltips with higher precedence than object tooltips). It can
17632 * have only one tooltip at a time, so any previous tooltip data
17633 * will get removed.
17635 * In order to set an icon or something else as a tooltip, look at
17636 * elm_genlist_item_tooltip_content_cb_set().
17640 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17642 * Set the content to be shown in a given genlist item's tooltips
17644 * @param item The genlist item.
17645 * @param func The function returning the tooltip contents.
17646 * @param data What to provide to @a func as callback data/context.
17647 * @param del_cb Called when data is not needed anymore, either when
17648 * another callback replaces @p func, the tooltip is unset with
17649 * elm_genlist_item_tooltip_unset() or the owner @p item
17650 * dies. This callback receives as its first parameter the
17651 * given @p data, being @c event_info the item handle.
17653 * This call will setup the tooltip's contents to @p item
17654 * (analogous to elm_object_tooltip_content_cb_set(), but being
17655 * item tooltips with higher precedence than object tooltips). It
17656 * can have only one tooltip at a time, so any previous tooltip
17657 * content will get removed. @p func (with @p data) will be called
17658 * every time Elementary needs to show the tooltip and it should
17659 * return a valid Evas object, which will be fully managed by the
17660 * tooltip system, getting deleted when the tooltip is gone.
17662 * In order to set just a text as a tooltip, look at
17663 * elm_genlist_item_tooltip_text_set().
17667 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);
17669 * Unset a tooltip from a given genlist item
17671 * @param item genlist item to remove a previously set tooltip from.
17673 * This call removes any tooltip set on @p item. The callback
17674 * provided as @c del_cb to
17675 * elm_genlist_item_tooltip_content_cb_set() will be called to
17676 * notify it is not used anymore (and have resources cleaned, if
17679 * @see elm_genlist_item_tooltip_content_cb_set()
17683 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17685 * Set a different @b style for a given genlist item's tooltip.
17687 * @param item genlist item with tooltip set
17688 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17689 * "default", @c "transparent", etc)
17691 * Tooltips can have <b>alternate styles</b> to be displayed on,
17692 * which are defined by the theme set on Elementary. This function
17693 * works analogously as elm_object_tooltip_style_set(), but here
17694 * applied only to genlist item objects. The default style for
17695 * tooltips is @c "default".
17697 * @note before you set a style you should define a tooltip with
17698 * elm_genlist_item_tooltip_content_cb_set() or
17699 * elm_genlist_item_tooltip_text_set()
17701 * @see elm_genlist_item_tooltip_style_get()
17705 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17707 * Get the style set a given genlist item's tooltip.
17709 * @param item genlist item with tooltip already set on.
17710 * @return style the theme style in use, which defaults to
17711 * "default". If the object does not have a tooltip set,
17712 * then @c NULL is returned.
17714 * @see elm_genlist_item_tooltip_style_set() for more details
17718 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17720 * @brief Disable size restrictions on an object's tooltip
17721 * @param item The tooltip's anchor object
17722 * @param disable If EINA_TRUE, size restrictions are disabled
17723 * @return EINA_FALSE on failure, EINA_TRUE on success
17725 * This function allows a tooltip to expand beyond its parant window's canvas.
17726 * It will instead be limited only by the size of the display.
17728 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17730 * @brief Retrieve size restriction state of an object's tooltip
17731 * @param item The tooltip's anchor object
17732 * @return If EINA_TRUE, size restrictions are disabled
17734 * This function returns whether a tooltip is allowed to expand beyond
17735 * its parant window's canvas.
17736 * It will instead be limited only by the size of the display.
17738 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17740 * Set the type of mouse pointer/cursor decoration to be shown,
17741 * when the mouse pointer is over the given genlist widget item
17743 * @param item genlist item to customize cursor on
17744 * @param cursor the cursor type's name
17746 * This function works analogously as elm_object_cursor_set(), but
17747 * here the cursor's changing area is restricted to the item's
17748 * area, and not the whole widget's. Note that that item cursors
17749 * have precedence over widget cursors, so that a mouse over @p
17750 * item will always show cursor @p type.
17752 * If this function is called twice for an object, a previously set
17753 * cursor will be unset on the second call.
17755 * @see elm_object_cursor_set()
17756 * @see elm_genlist_item_cursor_get()
17757 * @see elm_genlist_item_cursor_unset()
17761 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17763 * Get the type of mouse pointer/cursor decoration set to be shown,
17764 * when the mouse pointer is over the given genlist widget item
17766 * @param item genlist item with custom cursor set
17767 * @return the cursor type's name or @c NULL, if no custom cursors
17768 * were set to @p item (and on errors)
17770 * @see elm_object_cursor_get()
17771 * @see elm_genlist_item_cursor_set() for more details
17772 * @see elm_genlist_item_cursor_unset()
17776 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17778 * Unset any custom mouse pointer/cursor decoration set to be
17779 * shown, when the mouse pointer is over the given genlist widget
17780 * item, thus making it show the @b default cursor again.
17782 * @param item a genlist item
17784 * Use this call to undo any custom settings on this item's cursor
17785 * decoration, bringing it back to defaults (no custom style set).
17787 * @see elm_object_cursor_unset()
17788 * @see elm_genlist_item_cursor_set() for more details
17792 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17794 * Set a different @b style for a given custom cursor set for a
17797 * @param item genlist item with custom cursor set
17798 * @param style the <b>theme style</b> to use (e.g. @c "default",
17799 * @c "transparent", etc)
17801 * This function only makes sense when one is using custom mouse
17802 * cursor decorations <b>defined in a theme file</b> , which can
17803 * have, given a cursor name/type, <b>alternate styles</b> on
17804 * it. It works analogously as elm_object_cursor_style_set(), but
17805 * here applied only to genlist item objects.
17807 * @warning Before you set a cursor style you should have defined a
17808 * custom cursor previously on the item, with
17809 * elm_genlist_item_cursor_set()
17811 * @see elm_genlist_item_cursor_engine_only_set()
17812 * @see elm_genlist_item_cursor_style_get()
17816 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17818 * Get the current @b style set for a given genlist item's custom
17821 * @param item genlist item with custom cursor set.
17822 * @return style the cursor style in use. If the object does not
17823 * have a cursor set, then @c NULL is returned.
17825 * @see elm_genlist_item_cursor_style_set() for more details
17829 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17831 * Set if the (custom) cursor for a given genlist item should be
17832 * searched in its theme, also, or should only rely on the
17833 * rendering engine.
17835 * @param item item with custom (custom) cursor already set on
17836 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17837 * only on those provided by the rendering engine, @c EINA_FALSE to
17838 * have them searched on the widget's theme, as well.
17840 * @note This call is of use only if you've set a custom cursor
17841 * for genlist items, with elm_genlist_item_cursor_set().
17843 * @note By default, cursors will only be looked for between those
17844 * provided by the rendering engine.
17848 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17850 * Get if the (custom) cursor for a given genlist item is being
17851 * searched in its theme, also, or is only relying on the rendering
17854 * @param item a genlist item
17855 * @return @c EINA_TRUE, if cursors are being looked for only on
17856 * those provided by the rendering engine, @c EINA_FALSE if they
17857 * are being searched on the widget's theme, as well.
17859 * @see elm_genlist_item_cursor_engine_only_set(), for more details
17863 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17865 * Update the contents of all realized items.
17867 * @param obj The genlist object.
17869 * This updates all realized items by calling all the item class functions again
17870 * to get the icons, labels and states. Use this when the original
17871 * item data has changed and the changes are desired to be reflected.
17873 * To update just one item, use elm_genlist_item_update().
17875 * @see elm_genlist_realized_items_get()
17876 * @see elm_genlist_item_update()
17880 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17882 * Activate a genlist mode on an item
17884 * @param item The genlist item
17885 * @param mode Mode name
17886 * @param mode_set Boolean to define set or unset mode.
17888 * A genlist mode is a different way of selecting an item. Once a mode is
17889 * activated on an item, any other selected item is immediately unselected.
17890 * This feature provides an easy way of implementing a new kind of animation
17891 * for selecting an item, without having to entirely rewrite the item style
17892 * theme. However, the elm_genlist_selected_* API can't be used to get what
17893 * item is activate for a mode.
17895 * The current item style will still be used, but applying a genlist mode to
17896 * an item will select it using a different kind of animation.
17898 * The current active item for a mode can be found by
17899 * elm_genlist_mode_item_get().
17901 * The characteristics of genlist mode are:
17902 * - Only one mode can be active at any time, and for only one item.
17903 * - Genlist handles deactivating other items when one item is activated.
17904 * - A mode is defined in the genlist theme (edc), and more modes can easily
17906 * - A mode style and the genlist item style are different things. They
17907 * can be combined to provide a default style to the item, with some kind
17908 * of animation for that item when the mode is activated.
17910 * When a mode is activated on an item, a new view for that item is created.
17911 * The theme of this mode defines the animation that will be used to transit
17912 * the item from the old view to the new view. This second (new) view will be
17913 * active for that item while the mode is active on the item, and will be
17914 * destroyed after the mode is totally deactivated from that item.
17916 * @see elm_genlist_mode_get()
17917 * @see elm_genlist_mode_item_get()
17921 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
17923 * Get the last (or current) genlist mode used.
17925 * @param obj The genlist object
17927 * This function just returns the name of the last used genlist mode. It will
17928 * be the current mode if it's still active.
17930 * @see elm_genlist_item_mode_set()
17931 * @see elm_genlist_mode_item_get()
17935 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17937 * Get active genlist mode item
17939 * @param obj The genlist object
17940 * @return The active item for that current mode. Or @c NULL if no item is
17941 * activated with any mode.
17943 * This function returns the item that was activated with a mode, by the
17944 * function elm_genlist_item_mode_set().
17946 * @see elm_genlist_item_mode_set()
17947 * @see elm_genlist_mode_get()
17951 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17956 * @param obj The genlist object
17957 * @param reorder_mode The reorder mode
17958 * (EINA_TRUE = on, EINA_FALSE = off)
17962 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
17965 * Get the reorder mode
17967 * @param obj The genlist object
17968 * @return The reorder mode
17969 * (EINA_TRUE = on, EINA_FALSE = off)
17973 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17980 * @defgroup Check Check
17982 * @image html img/widget/check/preview-00.png
17983 * @image latex img/widget/check/preview-00.eps
17984 * @image html img/widget/check/preview-01.png
17985 * @image latex img/widget/check/preview-01.eps
17986 * @image html img/widget/check/preview-02.png
17987 * @image latex img/widget/check/preview-02.eps
17989 * @brief The check widget allows for toggling a value between true and
17992 * Check objects are a lot like radio objects in layout and functionality
17993 * except they do not work as a group, but independently and only toggle the
17994 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
17995 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
17996 * returns the current state. For convenience, like the radio objects, you
17997 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
17998 * for it to modify.
18000 * Signals that you can add callbacks for are:
18001 * "changed" - This is called whenever the user changes the state of one of
18002 * the check object(event_info is NULL).
18004 * @ref tutorial_check should give you a firm grasp of how to use this widget.
18008 * @brief Add a new Check object
18010 * @param parent The parent object
18011 * @return The new object or NULL if it cannot be created
18013 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18015 * @brief Set the text label of the check object
18017 * @param obj The check object
18018 * @param label The text label string in UTF-8
18020 * @deprecated use elm_object_text_set() instead.
18022 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18024 * @brief Get the text label of the check object
18026 * @param obj The check object
18027 * @return The text label string in UTF-8
18029 * @deprecated use elm_object_text_get() instead.
18031 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18033 * @brief Set the icon object of the check object
18035 * @param obj The check object
18036 * @param icon The icon object
18038 * Once the icon object is set, a previously set one will be deleted.
18039 * If you want to keep that old content object, use the
18040 * elm_check_icon_unset() function.
18042 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18044 * @brief Get the icon object of the check object
18046 * @param obj The check object
18047 * @return The icon object
18049 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18051 * @brief Unset the icon used for the check object
18053 * @param obj The check object
18054 * @return The icon object that was being used
18056 * Unparent and return the icon object which was set for this widget.
18058 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18060 * @brief Set the on/off state of the check object
18062 * @param obj The check object
18063 * @param state The state to use (1 == on, 0 == off)
18065 * This sets the state of the check. If set
18066 * with elm_check_state_pointer_set() the state of that variable is also
18067 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18069 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18071 * @brief Get the state of the check object
18073 * @param obj The check object
18074 * @return The boolean state
18076 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18078 * @brief Set a convenience pointer to a boolean to change
18080 * @param obj The check object
18081 * @param statep Pointer to the boolean to modify
18083 * This sets a pointer to a boolean, that, in addition to the check objects
18084 * state will also be modified directly. To stop setting the object pointed
18085 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18086 * then when this is called, the check objects state will also be modified to
18087 * reflect the value of the boolean @p statep points to, just like calling
18088 * elm_check_state_set().
18090 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18096 * @defgroup Radio Radio
18098 * @image html img/widget/radio/preview-00.png
18099 * @image latex img/widget/radio/preview-00.eps
18101 * @brief Radio is a widget that allows for 1 or more options to be displayed
18102 * and have the user choose only 1 of them.
18104 * A radio object contains an indicator, an optional Label and an optional
18105 * icon object. While it's possible to have a group of only one radio they,
18106 * are normally used in groups of 2 or more. To add a radio to a group use
18107 * elm_radio_group_add(). The radio object(s) will select from one of a set
18108 * of integer values, so any value they are configuring needs to be mapped to
18109 * a set of integers. To configure what value that radio object represents,
18110 * use elm_radio_state_value_set() to set the integer it represents. To set
18111 * the value the whole group(which one is currently selected) is to indicate
18112 * use elm_radio_value_set() on any group member, and to get the groups value
18113 * use elm_radio_value_get(). For convenience the radio objects are also able
18114 * to directly set an integer(int) to the value that is selected. To specify
18115 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18116 * The radio objects will modify this directly. That implies the pointer must
18117 * point to valid memory for as long as the radio objects exist.
18119 * Signals that you can add callbacks for are:
18120 * @li changed - This is called whenever the user changes the state of one of
18121 * the radio objects within the group of radio objects that work together.
18123 * @ref tutorial_radio show most of this API in action.
18127 * @brief Add a new radio to the parent
18129 * @param parent The parent object
18130 * @return The new object or NULL if it cannot be created
18132 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18134 * @brief Set the text label of the radio object
18136 * @param obj The radio object
18137 * @param label The text label string in UTF-8
18139 * @deprecated use elm_object_text_set() instead.
18141 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18143 * @brief Get the text label of the radio object
18145 * @param obj The radio object
18146 * @return The text label string in UTF-8
18148 * @deprecated use elm_object_text_set() instead.
18150 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18152 * @brief Set the icon object of the radio object
18154 * @param obj The radio object
18155 * @param icon The icon object
18157 * Once the icon object is set, a previously set one will be deleted. If you
18158 * want to keep that old content object, use the elm_radio_icon_unset()
18161 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18163 * @brief Get the icon object of the radio object
18165 * @param obj The radio object
18166 * @return The icon object
18168 * @see elm_radio_icon_set()
18170 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18172 * @brief Unset the icon used for the radio object
18174 * @param obj The radio object
18175 * @return The icon object that was being used
18177 * Unparent and return the icon object which was set for this widget.
18179 * @see elm_radio_icon_set()
18181 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18183 * @brief Add this radio to a group of other radio objects
18185 * @param obj The radio object
18186 * @param group Any object whose group the @p obj is to join.
18188 * Radio objects work in groups. Each member should have a different integer
18189 * value assigned. In order to have them work as a group, they need to know
18190 * about each other. This adds the given radio object to the group of which
18191 * the group object indicated is a member.
18193 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18195 * @brief Set the integer value that this radio object represents
18197 * @param obj The radio object
18198 * @param value The value to use if this radio object is selected
18200 * This sets the value of the radio.
18202 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18204 * @brief Get the integer value that this radio object represents
18206 * @param obj The radio object
18207 * @return The value used if this radio object is selected
18209 * This gets the value of the radio.
18211 * @see elm_radio_value_set()
18213 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18215 * @brief Set the value of the radio.
18217 * @param obj The radio object
18218 * @param value The value to use for the group
18220 * This sets the value of the radio group and will also set the value if
18221 * pointed to, to the value supplied, but will not call any callbacks.
18223 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18225 * @brief Get the state of the radio object
18227 * @param obj The radio object
18228 * @return The integer state
18230 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18232 * @brief Set a convenience pointer to a integer to change
18234 * @param obj The radio object
18235 * @param valuep Pointer to the integer to modify
18237 * This sets a pointer to a integer, that, in addition to the radio objects
18238 * state will also be modified directly. To stop setting the object pointed
18239 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18240 * when this is called, the radio objects state will also be modified to
18241 * reflect the value of the integer valuep points to, just like calling
18242 * elm_radio_value_set().
18244 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18250 * @defgroup Pager Pager
18252 * @image html img/widget/pager/preview-00.png
18253 * @image latex img/widget/pager/preview-00.eps
18255 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18257 * The flipping between “pages” of objects is animated. All content in pager
18258 * is kept in a stack, the last content to be added will be on the top of the
18259 * stack(be visible).
18261 * Objects can be pushed or popped from the stack or deleted as normal.
18262 * Pushes and pops will animate (and a pop will delete the object once the
18263 * animation is finished). Any object already in the pager can be promoted to
18264 * the top(from its current stacking position) through the use of
18265 * elm_pager_content_promote(). Objects are pushed to the top with
18266 * elm_pager_content_push() and when the top item is no longer wanted, simply
18267 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18268 * object is no longer needed and is not the top item, just delete it as
18269 * normal. You can query which objects are the top and bottom with
18270 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18272 * Signals that you can add callbacks for are:
18273 * "hide,finished" - when the previous page is hided
18275 * This widget has the following styles available:
18278 * @li fade_translucide
18279 * @li fade_invisible
18280 * @note This styles affect only the flipping animations, the appearance when
18281 * not animating is unaffected by styles.
18283 * @ref tutorial_pager gives a good overview of the usage of the API.
18287 * Add a new pager to the parent
18289 * @param parent The parent object
18290 * @return The new object or NULL if it cannot be created
18294 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18296 * @brief Push an object to the top of the pager stack (and show it).
18298 * @param obj The pager object
18299 * @param content The object to push
18301 * The object pushed becomes a child of the pager, it will be controlled and
18302 * deleted when the pager is deleted.
18304 * @note If the content is already in the stack use
18305 * elm_pager_content_promote().
18306 * @warning Using this function on @p content already in the stack results in
18307 * undefined behavior.
18309 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18311 * @brief Pop the object that is on top of the stack
18313 * @param obj The pager object
18315 * This pops the object that is on the top(visible) of the pager, makes it
18316 * disappear, then deletes the object. The object that was underneath it on
18317 * the stack will become visible.
18319 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18321 * @brief Moves an object already in the pager stack to the top of the stack.
18323 * @param obj The pager object
18324 * @param content The object to promote
18326 * This will take the @p content and move it to the top of the stack as
18327 * if it had been pushed there.
18329 * @note If the content isn't already in the stack use
18330 * elm_pager_content_push().
18331 * @warning Using this function on @p content not already in the stack
18332 * results in undefined behavior.
18334 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18336 * @brief Return the object at the bottom of the pager stack
18338 * @param obj The pager object
18339 * @return The bottom object or NULL if none
18341 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18343 * @brief Return the object at the top of the pager stack
18345 * @param obj The pager object
18346 * @return The top object or NULL if none
18348 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18354 * @defgroup Slideshow Slideshow
18356 * @image html img/widget/slideshow/preview-00.png
18357 * @image latex img/widget/slideshow/preview-00.eps
18359 * This widget, as the name indicates, is a pre-made image
18360 * slideshow panel, with API functions acting on (child) image
18361 * items presentation. Between those actions, are:
18362 * - advance to next/previous image
18363 * - select the style of image transition animation
18364 * - set the exhibition time for each image
18365 * - start/stop the slideshow
18367 * The transition animations are defined in the widget's theme,
18368 * consequently new animations can be added without having to
18369 * update the widget's code.
18371 * @section Slideshow_Items Slideshow items
18373 * For slideshow items, just like for @ref Genlist "genlist" ones,
18374 * the user defines a @b classes, specifying functions that will be
18375 * called on the item's creation and deletion times.
18377 * The #Elm_Slideshow_Item_Class structure contains the following
18380 * - @c func.get - When an item is displayed, this function is
18381 * called, and it's where one should create the item object, de
18382 * facto. For example, the object can be a pure Evas image object
18383 * or an Elementary @ref Photocam "photocam" widget. See
18384 * #SlideshowItemGetFunc.
18385 * - @c func.del - When an item is no more displayed, this function
18386 * is called, where the user must delete any data associated to
18387 * the item. See #SlideshowItemDelFunc.
18389 * @section Slideshow_Caching Slideshow caching
18391 * The slideshow provides facilities to have items adjacent to the
18392 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18393 * you, so that the system does not have to decode image data
18394 * anymore at the time it has to actually switch images on its
18395 * viewport. The user is able to set the numbers of items to be
18396 * cached @b before and @b after the current item, in the widget's
18399 * Smart events one can add callbacks for are:
18401 * - @c "changed" - when the slideshow switches its view to a new
18404 * List of examples for the slideshow widget:
18405 * @li @ref slideshow_example
18409 * @addtogroup Slideshow
18413 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18414 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18415 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18416 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18417 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18420 * @struct _Elm_Slideshow_Item_Class
18422 * Slideshow item class definition. See @ref Slideshow_Items for
18425 struct _Elm_Slideshow_Item_Class
18427 struct _Elm_Slideshow_Item_Class_Func
18429 SlideshowItemGetFunc get;
18430 SlideshowItemDelFunc del;
18432 }; /**< #Elm_Slideshow_Item_Class member definitions */
18435 * Add a new slideshow widget to the given parent Elementary
18436 * (container) object
18438 * @param parent The parent object
18439 * @return A new slideshow widget handle or @c NULL, on errors
18441 * This function inserts a new slideshow widget on the canvas.
18443 * @ingroup Slideshow
18445 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18448 * Add (append) a new item in a given slideshow widget.
18450 * @param obj The slideshow object
18451 * @param itc The item class for the item
18452 * @param data The item's data
18453 * @return A handle to the item added or @c NULL, on errors
18455 * Add a new item to @p obj's internal list of items, appending it.
18456 * The item's class must contain the function really fetching the
18457 * image object to show for this item, which could be an Evas image
18458 * object or an Elementary photo, for example. The @p data
18459 * parameter is going to be passed to both class functions of the
18462 * @see #Elm_Slideshow_Item_Class
18463 * @see elm_slideshow_item_sorted_insert()
18465 * @ingroup Slideshow
18467 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18470 * Insert a new item into the given slideshow widget, using the @p func
18471 * function to sort items (by item handles).
18473 * @param obj The slideshow object
18474 * @param itc The item class for the item
18475 * @param data The item's data
18476 * @param func The comparing function to be used to sort slideshow
18477 * items <b>by #Elm_Slideshow_Item item handles</b>
18478 * @return Returns The slideshow item handle, on success, or
18479 * @c NULL, on errors
18481 * Add a new item to @p obj's internal list of items, in a position
18482 * determined by the @p func comparing function. The item's class
18483 * must contain the function really fetching the image object to
18484 * show for this item, which could be an Evas image object or an
18485 * Elementary photo, for example. The @p data parameter is going to
18486 * be passed to both class functions of the item.
18488 * @see #Elm_Slideshow_Item_Class
18489 * @see elm_slideshow_item_add()
18491 * @ingroup Slideshow
18493 EAPI Elm_Slideshow_Item *elm_slideshow_item_sorted_insert(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) EINA_ARG_NONNULL(1);
18496 * Display a given slideshow widget's item, programmatically.
18498 * @param obj The slideshow object
18499 * @param item The item to display on @p obj's viewport
18501 * The change between the current item and @p item will use the
18502 * transition @p obj is set to use (@see
18503 * elm_slideshow_transition_set()).
18505 * @ingroup Slideshow
18507 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18510 * Slide to the @b next item, in a given slideshow widget
18512 * @param obj The slideshow object
18514 * The sliding animation @p obj is set to use will be the
18515 * transition effect used, after this call is issued.
18517 * @note If the end of the slideshow's internal list of items is
18518 * reached, it'll wrap around to the list's beginning, again.
18520 * @ingroup Slideshow
18522 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18525 * Slide to the @b previous item, in a given slideshow widget
18527 * @param obj The slideshow object
18529 * The sliding animation @p obj is set to use will be the
18530 * transition effect used, after this call is issued.
18532 * @note If the beginning of the slideshow's internal list of items
18533 * is reached, it'll wrap around to the list's end, again.
18535 * @ingroup Slideshow
18537 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18540 * Returns the list of sliding transition/effect names available, for a
18541 * given slideshow widget.
18543 * @param obj The slideshow object
18544 * @return The list of transitions (list of @b stringshared strings
18547 * The transitions, which come from @p obj's theme, must be an EDC
18548 * data item named @c "transitions" on the theme file, with (prefix)
18549 * names of EDC programs actually implementing them.
18551 * The available transitions for slideshows on the default theme are:
18552 * - @c "fade" - the current item fades out, while the new one
18553 * fades in to the slideshow's viewport.
18554 * - @c "black_fade" - the current item fades to black, and just
18555 * then, the new item will fade in.
18556 * - @c "horizontal" - the current item slides horizontally, until
18557 * it gets out of the slideshow's viewport, while the new item
18558 * comes from the left to take its place.
18559 * - @c "vertical" - the current item slides vertically, until it
18560 * gets out of the slideshow's viewport, while the new item comes
18561 * from the bottom to take its place.
18562 * - @c "square" - the new item starts to appear from the middle of
18563 * the current one, but with a tiny size, growing until its
18564 * target (full) size and covering the old one.
18566 * @warning The stringshared strings get no new references
18567 * exclusive to the user grabbing the list, here, so if you'd like
18568 * to use them out of this call's context, you'd better @c
18569 * eina_stringshare_ref() them.
18571 * @see elm_slideshow_transition_set()
18573 * @ingroup Slideshow
18575 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18578 * Set the current slide transition/effect in use for a given
18581 * @param obj The slideshow object
18582 * @param transition The new transition's name string
18584 * If @p transition is implemented in @p obj's theme (i.e., is
18585 * contained in the list returned by
18586 * elm_slideshow_transitions_get()), this new sliding effect will
18587 * be used on the widget.
18589 * @see elm_slideshow_transitions_get() for more details
18591 * @ingroup Slideshow
18593 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18596 * Get the current slide transition/effect in use for a given
18599 * @param obj The slideshow object
18600 * @return The current transition's name
18602 * @see elm_slideshow_transition_set() for more details
18604 * @ingroup Slideshow
18606 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18609 * Set the interval between each image transition on a given
18610 * slideshow widget, <b>and start the slideshow, itself</b>
18612 * @param obj The slideshow object
18613 * @param timeout The new displaying timeout for images
18615 * After this call, the slideshow widget will start cycling its
18616 * view, sequentially and automatically, with the images of the
18617 * items it has. The time between each new image displayed is going
18618 * to be @p timeout, in @b seconds. If a different timeout was set
18619 * previously and an slideshow was in progress, it will continue
18620 * with the new time between transitions, after this call.
18622 * @note A value less than or equal to 0 on @p timeout will disable
18623 * the widget's internal timer, thus halting any slideshow which
18624 * could be happening on @p obj.
18626 * @see elm_slideshow_timeout_get()
18628 * @ingroup Slideshow
18630 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18633 * Get the interval set for image transitions on a given slideshow
18636 * @param obj The slideshow object
18637 * @return Returns the timeout set on it
18639 * @see elm_slideshow_timeout_set() for more details
18641 * @ingroup Slideshow
18643 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18646 * Set if, after a slideshow is started, for a given slideshow
18647 * widget, its items should be displayed cyclically or not.
18649 * @param obj The slideshow object
18650 * @param loop Use @c EINA_TRUE to make it cycle through items or
18651 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18654 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18655 * ignore what is set by this functions, i.e., they'll @b always
18656 * cycle through items. This affects only the "automatic"
18657 * slideshow, as set by elm_slideshow_timeout_set().
18659 * @see elm_slideshow_loop_get()
18661 * @ingroup Slideshow
18663 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18666 * Get if, after a slideshow is started, for a given slideshow
18667 * widget, its items are to be displayed cyclically or not.
18669 * @param obj The slideshow object
18670 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18671 * through or @c EINA_FALSE, otherwise
18673 * @see elm_slideshow_loop_set() for more details
18675 * @ingroup Slideshow
18677 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18680 * Remove all items from a given slideshow widget
18682 * @param obj The slideshow object
18684 * This removes (and deletes) all items in @p obj, leaving it
18687 * @see elm_slideshow_item_del(), to remove just one item.
18689 * @ingroup Slideshow
18691 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18694 * Get the internal list of items in a given slideshow widget.
18696 * @param obj The slideshow object
18697 * @return The list of items (#Elm_Slideshow_Item as data) or
18698 * @c NULL on errors.
18700 * This list is @b not to be modified in any way and must not be
18701 * freed. Use the list members with functions like
18702 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18704 * @warning This list is only valid until @p obj object's internal
18705 * items list is changed. It should be fetched again with another
18706 * call to this function when changes happen.
18708 * @ingroup Slideshow
18710 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18713 * Delete a given item from a slideshow widget.
18715 * @param item The slideshow item
18717 * @ingroup Slideshow
18719 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18722 * Return the data associated with a given slideshow item
18724 * @param item The slideshow item
18725 * @return Returns the data associated to this item
18727 * @ingroup Slideshow
18729 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18732 * Returns the currently displayed item, in a given slideshow widget
18734 * @param obj The slideshow object
18735 * @return A handle to the item being displayed in @p obj or
18736 * @c NULL, if none is (and on errors)
18738 * @ingroup Slideshow
18740 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18743 * Get the real Evas object created to implement the view of a
18744 * given slideshow item
18746 * @param item The slideshow item.
18747 * @return the Evas object implementing this item's view.
18749 * This returns the actual Evas object used to implement the
18750 * specified slideshow item's view. This may be @c NULL, as it may
18751 * not have been created or may have been deleted, at any time, by
18752 * the slideshow. <b>Do not modify this object</b> (move, resize,
18753 * show, hide, etc.), as the slideshow is controlling it. This
18754 * function is for querying, emitting custom signals or hooking
18755 * lower level callbacks for events on that object. Do not delete
18756 * this object under any circumstances.
18758 * @see elm_slideshow_item_data_get()
18760 * @ingroup Slideshow
18762 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18765 * Get the the item, in a given slideshow widget, placed at
18766 * position @p nth, in its internal items list
18768 * @param obj The slideshow object
18769 * @param nth The number of the item to grab a handle to (0 being
18771 * @return The item stored in @p obj at position @p nth or @c NULL,
18772 * if there's no item with that index (and on errors)
18774 * @ingroup Slideshow
18776 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18779 * Set the current slide layout in use for a given slideshow widget
18781 * @param obj The slideshow object
18782 * @param layout The new layout's name string
18784 * If @p layout is implemented in @p obj's theme (i.e., is contained
18785 * in the list returned by elm_slideshow_layouts_get()), this new
18786 * images layout will be used on the widget.
18788 * @see elm_slideshow_layouts_get() for more details
18790 * @ingroup Slideshow
18792 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18795 * Get the current slide layout in use for a given slideshow widget
18797 * @param obj The slideshow object
18798 * @return The current layout's name
18800 * @see elm_slideshow_layout_set() for more details
18802 * @ingroup Slideshow
18804 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18807 * Returns the list of @b layout names available, for a given
18808 * slideshow widget.
18810 * @param obj The slideshow object
18811 * @return The list of layouts (list of @b stringshared strings
18814 * Slideshow layouts will change how the widget is to dispose each
18815 * image item in its viewport, with regard to cropping, scaling,
18818 * The layouts, which come from @p obj's theme, must be an EDC
18819 * data item name @c "layouts" on the theme file, with (prefix)
18820 * names of EDC programs actually implementing them.
18822 * The available layouts for slideshows on the default theme are:
18823 * - @c "fullscreen" - item images with original aspect, scaled to
18824 * touch top and down slideshow borders or, if the image's heigh
18825 * is not enough, left and right slideshow borders.
18826 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18827 * one, but always leaving 10% of the slideshow's dimensions of
18828 * distance between the item image's borders and the slideshow
18829 * borders, for each axis.
18831 * @warning The stringshared strings get no new references
18832 * exclusive to the user grabbing the list, here, so if you'd like
18833 * to use them out of this call's context, you'd better @c
18834 * eina_stringshare_ref() them.
18836 * @see elm_slideshow_layout_set()
18838 * @ingroup Slideshow
18840 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18843 * Set the number of items to cache, on a given slideshow widget,
18844 * <b>before the current item</b>
18846 * @param obj The slideshow object
18847 * @param count Number of items to cache before the current one
18849 * The default value for this property is @c 2. See
18850 * @ref Slideshow_Caching "slideshow caching" for more details.
18852 * @see elm_slideshow_cache_before_get()
18854 * @ingroup Slideshow
18856 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18859 * Retrieve the number of items to cache, on a given slideshow widget,
18860 * <b>before the current item</b>
18862 * @param obj The slideshow object
18863 * @return The number of items set to be cached before the current one
18865 * @see elm_slideshow_cache_before_set() for more details
18867 * @ingroup Slideshow
18869 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18872 * Set the number of items to cache, on a given slideshow widget,
18873 * <b>after the current item</b>
18875 * @param obj The slideshow object
18876 * @param count Number of items to cache after the current one
18878 * The default value for this property is @c 2. See
18879 * @ref Slideshow_Caching "slideshow caching" for more details.
18881 * @see elm_slideshow_cache_after_get()
18883 * @ingroup Slideshow
18885 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18888 * Retrieve the number of items to cache, on a given slideshow widget,
18889 * <b>after the current item</b>
18891 * @param obj The slideshow object
18892 * @return The number of items set to be cached after the current one
18894 * @see elm_slideshow_cache_after_set() for more details
18896 * @ingroup Slideshow
18898 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18901 * Get the number of items stored in a given slideshow widget
18903 * @param obj The slideshow object
18904 * @return The number of items on @p obj, at the moment of this call
18906 * @ingroup Slideshow
18908 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18915 * @defgroup Fileselector File Selector
18917 * @image html img/widget/fileselector/preview-00.png
18918 * @image latex img/widget/fileselector/preview-00.eps
18920 * A file selector is a widget that allows a user to navigate
18921 * through a file system, reporting file selections back via its
18924 * It contains shortcut buttons for home directory (@c ~) and to
18925 * jump one directory upwards (..), as well as cancel/ok buttons to
18926 * confirm/cancel a given selection. After either one of those two
18927 * former actions, the file selector will issue its @c "done" smart
18930 * There's a text entry on it, too, showing the name of the current
18931 * selection. There's the possibility of making it editable, so it
18932 * is useful on file saving dialogs on applications, where one
18933 * gives a file name to save contents to, in a given directory in
18934 * the system. This custom file name will be reported on the @c
18935 * "done" smart callback (explained in sequence).
18937 * Finally, it has a view to display file system items into in two
18942 * If Elementary is built with support of the Ethumb thumbnailing
18943 * library, the second form of view will display preview thumbnails
18944 * of files which it supports.
18946 * Smart callbacks one can register to:
18948 * - @c "selected" - the user has clicked on a file (when not in
18949 * folders-only mode) or directory (when in folders-only mode)
18950 * - @c "directory,open" - the list has been populated with new
18951 * content (@c event_info is a pointer to the directory's
18952 * path, a @b stringshared string)
18953 * - @c "done" - the user has clicked on the "ok" or "cancel"
18954 * buttons (@c event_info is a pointer to the selection's
18955 * path, a @b stringshared string)
18957 * Here is an example on its usage:
18958 * @li @ref fileselector_example
18962 * @addtogroup Fileselector
18967 * Defines how a file selector widget is to layout its contents
18968 * (file system entries).
18970 typedef enum _Elm_Fileselector_Mode
18972 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
18973 ELM_FILESELECTOR_GRID, /**< layout as a grid */
18974 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
18975 } Elm_Fileselector_Mode;
18978 * Add a new file selector widget to the given parent Elementary
18979 * (container) object
18981 * @param parent The parent object
18982 * @return a new file selector widget handle or @c NULL, on errors
18984 * This function inserts a new file selector widget on the canvas.
18986 * @ingroup Fileselector
18988 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18991 * Enable/disable the file name entry box where the user can type
18992 * in a name for a file, in a given file selector widget
18994 * @param obj The file selector object
18995 * @param is_save @c EINA_TRUE to make the file selector a "saving
18996 * dialog", @c EINA_FALSE otherwise
18998 * Having the entry editable is useful on file saving dialogs on
18999 * applications, where one gives a file name to save contents to,
19000 * in a given directory in the system. This custom file name will
19001 * be reported on the @c "done" smart callback.
19003 * @see elm_fileselector_is_save_get()
19005 * @ingroup Fileselector
19007 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19010 * Get whether the given file selector is in "saving dialog" mode
19012 * @param obj The file selector object
19013 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19014 * mode, @c EINA_FALSE otherwise (and on errors)
19016 * @see elm_fileselector_is_save_set() for more details
19018 * @ingroup Fileselector
19020 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19023 * Enable/disable folder-only view for a given file selector widget
19025 * @param obj The file selector object
19026 * @param only @c EINA_TRUE to make @p obj only display
19027 * directories, @c EINA_FALSE to make files to be displayed in it
19030 * If enabled, the widget's view will only display folder items,
19033 * @see elm_fileselector_folder_only_get()
19035 * @ingroup Fileselector
19037 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19040 * Get whether folder-only view is set for a given file selector
19043 * @param obj The file selector object
19044 * @return only @c EINA_TRUE if @p obj is only displaying
19045 * directories, @c EINA_FALSE if files are being displayed in it
19046 * too (and on errors)
19048 * @see elm_fileselector_folder_only_get()
19050 * @ingroup Fileselector
19052 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19055 * Enable/disable the "ok" and "cancel" buttons on a given file
19058 * @param obj The file selector object
19059 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19061 * @note A file selector without those buttons will never emit the
19062 * @c "done" smart event, and is only usable if one is just hooking
19063 * to the other two events.
19065 * @see elm_fileselector_buttons_ok_cancel_get()
19067 * @ingroup Fileselector
19069 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19072 * Get whether the "ok" and "cancel" buttons on a given file
19073 * selector widget are being shown.
19075 * @param obj The file selector object
19076 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19077 * otherwise (and on errors)
19079 * @see elm_fileselector_buttons_ok_cancel_set() for more details
19081 * @ingroup Fileselector
19083 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19086 * Enable/disable a tree view in the given file selector widget,
19087 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19089 * @param obj The file selector object
19090 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19093 * In a tree view, arrows are created on the sides of directories,
19094 * allowing them to expand in place.
19096 * @note If it's in other mode, the changes made by this function
19097 * will only be visible when one switches back to "list" mode.
19099 * @see elm_fileselector_expandable_get()
19101 * @ingroup Fileselector
19103 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19106 * Get whether tree view is enabled for the given file selector
19109 * @param obj The file selector object
19110 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19111 * otherwise (and or errors)
19113 * @see elm_fileselector_expandable_set() for more details
19115 * @ingroup Fileselector
19117 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19120 * Set, programmatically, the @b directory that a given file
19121 * selector widget will display contents from
19123 * @param obj The file selector object
19124 * @param path The path to display in @p obj
19126 * This will change the @b directory that @p obj is displaying. It
19127 * will also clear the text entry area on the @p obj object, which
19128 * displays select files' names.
19130 * @see elm_fileselector_path_get()
19132 * @ingroup Fileselector
19134 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19137 * Get the parent directory's path that a given file selector
19138 * widget is displaying
19140 * @param obj The file selector object
19141 * @return The (full) path of the directory the file selector is
19142 * displaying, a @b stringshared string
19144 * @see elm_fileselector_path_set()
19146 * @ingroup Fileselector
19148 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19151 * Set, programmatically, the currently selected file/directory in
19152 * the given file selector widget
19154 * @param obj The file selector object
19155 * @param path The (full) path to a file or directory
19156 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19157 * latter case occurs if the directory or file pointed to do not
19160 * @see elm_fileselector_selected_get()
19162 * @ingroup Fileselector
19164 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19167 * Get the currently selected item's (full) path, in the given file
19170 * @param obj The file selector object
19171 * @return The absolute path of the selected item, a @b
19172 * stringshared string
19174 * @note Custom editions on @p obj object's text entry, if made,
19175 * will appear on the return string of this function, naturally.
19177 * @see elm_fileselector_selected_set() for more details
19179 * @ingroup Fileselector
19181 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19184 * Set the mode in which a given file selector widget will display
19185 * (layout) file system entries in its view
19187 * @param obj The file selector object
19188 * @param mode The mode of the fileselector, being it one of
19189 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19190 * first one, naturally, will display the files in a list. The
19191 * latter will make the widget to display its entries in a grid
19194 * @note By using elm_fileselector_expandable_set(), the user may
19195 * trigger a tree view for that list.
19197 * @note If Elementary is built with support of the Ethumb
19198 * thumbnailing library, the second form of view will display
19199 * preview thumbnails of files which it supports. You must have
19200 * elm_need_ethumb() called in your Elementary for thumbnailing to
19203 * @see elm_fileselector_expandable_set().
19204 * @see elm_fileselector_mode_get().
19206 * @ingroup Fileselector
19208 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19211 * Get the mode in which a given file selector widget is displaying
19212 * (layouting) file system entries in its view
19214 * @param obj The fileselector object
19215 * @return The mode in which the fileselector is at
19217 * @see elm_fileselector_mode_set() for more details
19219 * @ingroup Fileselector
19221 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19228 * @defgroup Progressbar Progress bar
19230 * The progress bar is a widget for visually representing the
19231 * progress status of a given job/task.
19233 * A progress bar may be horizontal or vertical. It may display an
19234 * icon besides it, as well as primary and @b units labels. The
19235 * former is meant to label the widget as a whole, while the
19236 * latter, which is formatted with floating point values (and thus
19237 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19238 * units"</c>), is meant to label the widget's <b>progress
19239 * value</b>. Label, icon and unit strings/objects are @b optional
19240 * for progress bars.
19242 * A progress bar may be @b inverted, in which state it gets its
19243 * values inverted, with high values being on the left or top and
19244 * low values on the right or bottom, as opposed to normally have
19245 * the low values on the former and high values on the latter,
19246 * respectively, for horizontal and vertical modes.
19248 * The @b span of the progress, as set by
19249 * elm_progressbar_span_size_set(), is its length (horizontally or
19250 * vertically), unless one puts size hints on the widget to expand
19251 * on desired directions, by any container. That length will be
19252 * scaled by the object or applications scaling factor. At any
19253 * point code can query the progress bar for its value with
19254 * elm_progressbar_value_get().
19256 * Available widget styles for progress bars:
19258 * - @c "wheel" (simple style, no text, no progression, only
19259 * "pulse" effect is available)
19261 * Here is an example on its usage:
19262 * @li @ref progressbar_example
19266 * Add a new progress bar widget to the given parent Elementary
19267 * (container) object
19269 * @param parent The parent object
19270 * @return a new progress bar widget handle or @c NULL, on errors
19272 * This function inserts a new progress bar widget on the canvas.
19274 * @ingroup Progressbar
19276 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19279 * Set whether a given progress bar widget is at "pulsing mode" or
19282 * @param obj The progress bar object
19283 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19284 * @c EINA_FALSE to put it back to its default one
19286 * By default, progress bars will display values from the low to
19287 * high value boundaries. There are, though, contexts in which the
19288 * state of progression of a given task is @b unknown. For those,
19289 * one can set a progress bar widget to a "pulsing state", to give
19290 * the user an idea that some computation is being held, but
19291 * without exact progress values. In the default theme it will
19292 * animate its bar with the contents filling in constantly and back
19293 * to non-filled, in a loop. To start and stop this pulsing
19294 * animation, one has to explicitly call elm_progressbar_pulse().
19296 * @see elm_progressbar_pulse_get()
19297 * @see elm_progressbar_pulse()
19299 * @ingroup Progressbar
19301 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19304 * Get whether a given progress bar widget is at "pulsing mode" or
19307 * @param obj The progress bar object
19308 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19309 * if it's in the default one (and on errors)
19311 * @ingroup Progressbar
19313 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19316 * Start/stop a given progress bar "pulsing" animation, if its
19319 * @param obj The progress bar object
19320 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19321 * @c EINA_FALSE to @b stop it
19323 * @note This call won't do anything if @p obj is not under "pulsing mode".
19325 * @see elm_progressbar_pulse_set() for more details.
19327 * @ingroup Progressbar
19329 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19332 * Set the progress value (in percentage) on a given progress bar
19335 * @param obj The progress bar object
19336 * @param val The progress value (@b must be between @c 0.0 and @c
19339 * Use this call to set progress bar levels.
19341 * @note If you passes a value out of the specified range for @p
19342 * val, it will be interpreted as the @b closest of the @b boundary
19343 * values in the range.
19345 * @ingroup Progressbar
19347 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19350 * Get the progress value (in percentage) on a given progress bar
19353 * @param obj The progress bar object
19354 * @return The value of the progressbar
19356 * @see elm_progressbar_value_set() for more details
19358 * @ingroup Progressbar
19360 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19363 * Set the label of a given progress bar widget
19365 * @param obj The progress bar object
19366 * @param label The text label string, in UTF-8
19368 * @ingroup Progressbar
19369 * @deprecated use elm_object_text_set() instead.
19371 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19374 * Get the label of a given progress bar widget
19376 * @param obj The progressbar object
19377 * @return The text label string, in UTF-8
19379 * @ingroup Progressbar
19380 * @deprecated use elm_object_text_set() instead.
19382 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19385 * Set the icon object of a given progress bar widget
19387 * @param obj The progress bar object
19388 * @param icon The icon object
19390 * Use this call to decorate @p obj with an icon next to it.
19392 * @note Once the icon object is set, a previously set one will be
19393 * deleted. If you want to keep that old content object, use the
19394 * elm_progressbar_icon_unset() function.
19396 * @see elm_progressbar_icon_get()
19398 * @ingroup Progressbar
19400 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19403 * Retrieve the icon object set for a given progress bar widget
19405 * @param obj The progress bar object
19406 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19407 * otherwise (and on errors)
19409 * @see elm_progressbar_icon_set() for more details
19411 * @ingroup Progressbar
19413 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19416 * Unset an icon set on a given progress bar widget
19418 * @param obj The progress bar object
19419 * @return The icon object that was being used, if any was set, or
19420 * @c NULL, otherwise (and on errors)
19422 * This call will unparent and return the icon object which was set
19423 * for this widget, previously, on success.
19425 * @see elm_progressbar_icon_set() for more details
19427 * @ingroup Progressbar
19429 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19432 * Set the (exact) length of the bar region of a given progress bar
19435 * @param obj The progress bar object
19436 * @param size The length of the progress bar's bar region
19438 * This sets the minimum width (when in horizontal mode) or height
19439 * (when in vertical mode) of the actual bar area of the progress
19440 * bar @p obj. This in turn affects the object's minimum size. Use
19441 * this when you're not setting other size hints expanding on the
19442 * given direction (like weight and alignment hints) and you would
19443 * like it to have a specific size.
19445 * @note Icon, label and unit text around @p obj will require their
19446 * own space, which will make @p obj to require more the @p size,
19449 * @see elm_progressbar_span_size_get()
19451 * @ingroup Progressbar
19453 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19456 * Get the length set for the bar region of a given progress bar
19459 * @param obj The progress bar object
19460 * @return The length of the progress bar's bar region
19462 * If that size was not set previously, with
19463 * elm_progressbar_span_size_set(), this call will return @c 0.
19465 * @ingroup Progressbar
19467 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19470 * Set the format string for a given progress bar widget's units
19473 * @param obj The progress bar object
19474 * @param format The format string for @p obj's units label
19476 * If @c NULL is passed on @p format, it will make @p obj's units
19477 * area to be hidden completely. If not, it'll set the <b>format
19478 * string</b> for the units label's @b text. The units label is
19479 * provided a floating point value, so the units text is up display
19480 * at most one floating point falue. Note that the units label is
19481 * optional. Use a format string such as "%1.2f meters" for
19484 * @note The default format string for a progress bar is an integer
19485 * percentage, as in @c "%.0f %%".
19487 * @see elm_progressbar_unit_format_get()
19489 * @ingroup Progressbar
19491 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19494 * Retrieve the format string set for a given progress bar widget's
19497 * @param obj The progress bar object
19498 * @return The format set string for @p obj's units label or
19499 * @c NULL, if none was set (and on errors)
19501 * @see elm_progressbar_unit_format_set() for more details
19503 * @ingroup Progressbar
19505 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19508 * Set the orientation of a given progress bar widget
19510 * @param obj The progress bar object
19511 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19512 * @b horizontal, @c EINA_FALSE to make it @b vertical
19514 * Use this function to change how your progress bar is to be
19515 * disposed: vertically or horizontally.
19517 * @see elm_progressbar_horizontal_get()
19519 * @ingroup Progressbar
19521 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19524 * Retrieve the orientation of a given progress bar widget
19526 * @param obj The progress bar object
19527 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19528 * @c EINA_FALSE if it's @b vertical (and on errors)
19530 * @see elm_progressbar_horizontal_set() for more details
19532 * @ingroup Progressbar
19534 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19537 * Invert a given progress bar widget's displaying values order
19539 * @param obj The progress bar object
19540 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19541 * @c EINA_FALSE to bring it back to default, non-inverted values.
19543 * A progress bar may be @b inverted, in which state it gets its
19544 * values inverted, with high values being on the left or top and
19545 * low values on the right or bottom, as opposed to normally have
19546 * the low values on the former and high values on the latter,
19547 * respectively, for horizontal and vertical modes.
19549 * @see elm_progressbar_inverted_get()
19551 * @ingroup Progressbar
19553 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19556 * Get whether a given progress bar widget's displaying values are
19559 * @param obj The progress bar object
19560 * @return @c EINA_TRUE, if @p obj has inverted values,
19561 * @c EINA_FALSE otherwise (and on errors)
19563 * @see elm_progressbar_inverted_set() for more details
19565 * @ingroup Progressbar
19567 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19570 * @defgroup Separator Separator
19572 * @brief Separator is a very thin object used to separate other objects.
19574 * A separator can be vertical or horizontal.
19576 * @ref tutorial_separator is a good example of how to use a separator.
19580 * @brief Add a separator object to @p parent
19582 * @param parent The parent object
19584 * @return The separator object, or NULL upon failure
19586 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19588 * @brief Set the horizontal mode of a separator object
19590 * @param obj The separator object
19591 * @param horizontal If true, the separator is horizontal
19593 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19595 * @brief Get the horizontal mode of a separator object
19597 * @param obj The separator object
19598 * @return If true, the separator is horizontal
19600 * @see elm_separator_horizontal_set()
19602 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19608 * @defgroup Spinner Spinner
19609 * @ingroup Elementary
19611 * @image html img/widget/spinner/preview-00.png
19612 * @image latex img/widget/spinner/preview-00.eps
19614 * A spinner is a widget which allows the user to increase or decrease
19615 * numeric values using arrow buttons, or edit values directly, clicking
19616 * over it and typing the new value.
19618 * By default the spinner will not wrap and has a label
19619 * of "%.0f" (just showing the integer value of the double).
19621 * A spinner has a label that is formatted with floating
19622 * point values and thus accepts a printf-style format string, like
19625 * It also allows specific values to be replaced by pre-defined labels.
19627 * Smart callbacks one can register to:
19629 * - "changed" - Whenever the spinner value is changed.
19630 * - "delay,changed" - A short time after the value is changed by the user.
19631 * This will be called only when the user stops dragging for a very short
19632 * period or when they release their finger/mouse, so it avoids possibly
19633 * expensive reactions to the value change.
19635 * Available styles for it:
19637 * - @c "vertical": up/down buttons at the right side and text left aligned.
19639 * Here is an example on its usage:
19640 * @ref spinner_example
19644 * @addtogroup Spinner
19649 * Add a new spinner widget to the given parent Elementary
19650 * (container) object.
19652 * @param parent The parent object.
19653 * @return a new spinner widget handle or @c NULL, on errors.
19655 * This function inserts a new spinner widget on the canvas.
19660 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19663 * Set the format string of the displayed label.
19665 * @param obj The spinner object.
19666 * @param fmt The format string for the label display.
19668 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19669 * string for the label text. The label text is provided a floating point
19670 * value, so the label text can display up to 1 floating point value.
19671 * Note that this is optional.
19673 * Use a format string such as "%1.2f meters" for example, and it will
19674 * display values like: "3.14 meters" for a value equal to 3.14159.
19676 * Default is "%0.f".
19678 * @see elm_spinner_label_format_get()
19682 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19685 * Get the label format of the spinner.
19687 * @param obj The spinner object.
19688 * @return The text label format string in UTF-8.
19690 * @see elm_spinner_label_format_set() for details.
19694 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19697 * Set the minimum and maximum values for the spinner.
19699 * @param obj The spinner object.
19700 * @param min The minimum value.
19701 * @param max The maximum value.
19703 * Define the allowed range of values to be selected by the user.
19705 * If actual value is less than @p min, it will be updated to @p min. If it
19706 * is bigger then @p max, will be updated to @p max. Actual value can be
19707 * get with elm_spinner_value_get().
19709 * By default, min is equal to 0, and max is equal to 100.
19711 * @warning Maximum must be greater than minimum.
19713 * @see elm_spinner_min_max_get()
19717 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19720 * Get the minimum and maximum values of the spinner.
19722 * @param obj The spinner object.
19723 * @param min Pointer where to store the minimum value.
19724 * @param max Pointer where to store the maximum value.
19726 * @note If only one value is needed, the other pointer can be passed
19729 * @see elm_spinner_min_max_set() for details.
19733 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19736 * Set the step used to increment or decrement the spinner value.
19738 * @param obj The spinner object.
19739 * @param step The step value.
19741 * This value will be incremented or decremented to the displayed value.
19742 * It will be incremented while the user keep right or top arrow pressed,
19743 * and will be decremented while the user keep left or bottom arrow pressed.
19745 * The interval to increment / decrement can be set with
19746 * elm_spinner_interval_set().
19748 * By default step value is equal to 1.
19750 * @see elm_spinner_step_get()
19754 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19757 * Get the step used to increment or decrement the spinner value.
19759 * @param obj The spinner object.
19760 * @return The step value.
19762 * @see elm_spinner_step_get() for more details.
19766 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19769 * Set the value the spinner displays.
19771 * @param obj The spinner object.
19772 * @param val The value to be displayed.
19774 * Value will be presented on the label following format specified with
19775 * elm_spinner_format_set().
19777 * @warning The value must to be between min and max values. This values
19778 * are set by elm_spinner_min_max_set().
19780 * @see elm_spinner_value_get().
19781 * @see elm_spinner_format_set().
19782 * @see elm_spinner_min_max_set().
19786 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19789 * Get the value displayed by the spinner.
19791 * @param obj The spinner object.
19792 * @return The value displayed.
19794 * @see elm_spinner_value_set() for details.
19798 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19801 * Set whether the spinner should wrap when it reaches its
19802 * minimum or maximum value.
19804 * @param obj The spinner object.
19805 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19808 * Disabled by default. If disabled, when the user tries to increment the
19810 * but displayed value plus step value is bigger than maximum value,
19812 * won't allow it. The same happens when the user tries to decrement it,
19813 * but the value less step is less than minimum value.
19815 * When wrap is enabled, in such situations it will allow these changes,
19816 * but will get the value that would be less than minimum and subtracts
19817 * from maximum. Or add the value that would be more than maximum to
19821 * @li min value = 10
19822 * @li max value = 50
19823 * @li step value = 20
19824 * @li displayed value = 20
19826 * When the user decrement value (using left or bottom arrow), it will
19827 * displays @c 40, because max - (min - (displayed - step)) is
19828 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19830 * @see elm_spinner_wrap_get().
19834 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19837 * Get whether the spinner should wrap when it reaches its
19838 * minimum or maximum value.
19840 * @param obj The spinner object
19841 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19842 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19844 * @see elm_spinner_wrap_set() for details.
19848 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19851 * Set whether the spinner can be directly edited by the user or not.
19853 * @param obj The spinner object.
19854 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19855 * don't allow users to edit it directly.
19857 * Spinner objects can have edition @b disabled, in which state they will
19858 * be changed only by arrows.
19859 * Useful for contexts
19860 * where you don't want your users to interact with it writting the value.
19862 * when using special values, the user can see real value instead
19863 * of special label on edition.
19865 * It's enabled by default.
19867 * @see elm_spinner_editable_get()
19871 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19874 * Get whether the spinner can be directly edited by the user or not.
19876 * @param obj The spinner object.
19877 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19878 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19880 * @see elm_spinner_editable_set() for details.
19884 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19887 * Set a special string to display in the place of the numerical value.
19889 * @param obj The spinner object.
19890 * @param value The value to be replaced.
19891 * @param label The label to be used.
19893 * It's useful for cases when a user should select an item that is
19894 * better indicated by a label than a value. For example, weekdays or months.
19898 * sp = elm_spinner_add(win);
19899 * elm_spinner_min_max_set(sp, 1, 3);
19900 * elm_spinner_special_value_add(sp, 1, "January");
19901 * elm_spinner_special_value_add(sp, 2, "February");
19902 * elm_spinner_special_value_add(sp, 3, "March");
19903 * evas_object_show(sp);
19908 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
19911 * Set the interval on time updates for an user mouse button hold
19912 * on spinner widgets' arrows.
19914 * @param obj The spinner object.
19915 * @param interval The (first) interval value in seconds.
19917 * This interval value is @b decreased while the user holds the
19918 * mouse pointer either incrementing or decrementing spinner's value.
19920 * This helps the user to get to a given value distant from the
19921 * current one easier/faster, as it will start to change quicker and
19922 * quicker on mouse button holds.
19924 * The calculation for the next change interval value, starting from
19925 * the one set with this call, is the previous interval divided by
19926 * @c 1.05, so it decreases a little bit.
19928 * The default starting interval value for automatic changes is
19931 * @see elm_spinner_interval_get()
19935 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
19938 * Get the interval on time updates for an user mouse button hold
19939 * on spinner widgets' arrows.
19941 * @param obj The spinner object.
19942 * @return The (first) interval value, in seconds, set on it.
19944 * @see elm_spinner_interval_set() for more details.
19948 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19955 * @defgroup Index Index
19957 * @image html img/widget/index/preview-00.png
19958 * @image latex img/widget/index/preview-00.eps
19960 * An index widget gives you an index for fast access to whichever
19961 * group of other UI items one might have. It's a list of text
19962 * items (usually letters, for alphabetically ordered access).
19964 * Index widgets are by default hidden and just appear when the
19965 * user clicks over it's reserved area in the canvas. In its
19966 * default theme, it's an area one @ref Fingers "finger" wide on
19967 * the right side of the index widget's container.
19969 * When items on the index are selected, smart callbacks get
19970 * called, so that its user can make other container objects to
19971 * show a given area or child object depending on the index item
19972 * selected. You'd probably be using an index together with @ref
19973 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
19976 * Smart events one can add callbacks for are:
19977 * - @c "changed" - When the selected index item changes. @c
19978 * event_info is the selected item's data pointer.
19979 * - @c "delay,changed" - When the selected index item changes, but
19980 * after a small idling period. @c event_info is the selected
19981 * item's data pointer.
19982 * - @c "selected" - When the user releases a mouse button and
19983 * selects an item. @c event_info is the selected item's data
19985 * - @c "level,up" - when the user moves a finger from the first
19986 * level to the second level
19987 * - @c "level,down" - when the user moves a finger from the second
19988 * level to the first level
19990 * The @c "delay,changed" event is so that it'll wait a small time
19991 * before actually reporting those events and, moreover, just the
19992 * last event happening on those time frames will actually be
19995 * Here are some examples on its usage:
19996 * @li @ref index_example_01
19997 * @li @ref index_example_02
20001 * @addtogroup Index
20005 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20008 * Add a new index widget to the given parent Elementary
20009 * (container) object
20011 * @param parent The parent object
20012 * @return a new index widget handle or @c NULL, on errors
20014 * This function inserts a new index widget on the canvas.
20018 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20021 * Set whether a given index widget is or not visible,
20024 * @param obj The index object
20025 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20027 * Not to be confused with visible as in @c evas_object_show() --
20028 * visible with regard to the widget's auto hiding feature.
20030 * @see elm_index_active_get()
20034 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20037 * Get whether a given index widget is currently visible or not.
20039 * @param obj The index object
20040 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20042 * @see elm_index_active_set() for more details
20046 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20049 * Set the items level for a given index widget.
20051 * @param obj The index object.
20052 * @param level @c 0 or @c 1, the currently implemented levels.
20054 * @see elm_index_item_level_get()
20058 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20061 * Get the items level set for a given index widget.
20063 * @param obj The index object.
20064 * @return @c 0 or @c 1, which are the levels @p obj might be at.
20066 * @see elm_index_item_level_set() for more information
20070 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20073 * Returns the last selected item's data, for a given index widget.
20075 * @param obj The index object.
20076 * @return The item @b data associated to the last selected item on
20077 * @p obj (or @c NULL, on errors).
20079 * @warning The returned value is @b not an #Elm_Index_Item item
20080 * handle, but the data associated to it (see the @c item parameter
20081 * in elm_index_item_append(), as an example).
20085 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20088 * Append a new item on a given index widget.
20090 * @param obj The index object.
20091 * @param letter Letter under which the item should be indexed
20092 * @param item The item data to set for the index's item
20094 * Despite the most common usage of the @p letter argument is for
20095 * single char strings, one could use arbitrary strings as index
20098 * @c item will be the pointer returned back on @c "changed", @c
20099 * "delay,changed" and @c "selected" smart events.
20103 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20106 * Prepend a new item on a given index widget.
20108 * @param obj The index object.
20109 * @param letter Letter under which the item should be indexed
20110 * @param item The item data to set for the index's item
20112 * Despite the most common usage of the @p letter argument is for
20113 * single char strings, one could use arbitrary strings as index
20116 * @c item will be the pointer returned back on @c "changed", @c
20117 * "delay,changed" and @c "selected" smart events.
20121 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20124 * Append a new item, on a given index widget, <b>after the item
20125 * having @p relative as data</b>.
20127 * @param obj The index object.
20128 * @param letter Letter under which the item should be indexed
20129 * @param item The item data to set for the index's item
20130 * @param relative The item data of the index item to be the
20131 * predecessor of this new one
20133 * Despite the most common usage of the @p letter argument is for
20134 * single char strings, one could use arbitrary strings as index
20137 * @c item will be the pointer returned back on @c "changed", @c
20138 * "delay,changed" and @c "selected" smart events.
20140 * @note If @p relative is @c NULL or if it's not found to be data
20141 * set on any previous item on @p obj, this function will behave as
20142 * elm_index_item_append().
20146 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20149 * Prepend a new item, on a given index widget, <b>after the item
20150 * having @p relative as data</b>.
20152 * @param obj The index object.
20153 * @param letter Letter under which the item should be indexed
20154 * @param item The item data to set for the index's item
20155 * @param relative The item data of the index item to be the
20156 * successor of this new one
20158 * Despite the most common usage of the @p letter argument is for
20159 * single char strings, one could use arbitrary strings as index
20162 * @c item will be the pointer returned back on @c "changed", @c
20163 * "delay,changed" and @c "selected" smart events.
20165 * @note If @p relative is @c NULL or if it's not found to be data
20166 * set on any previous item on @p obj, this function will behave as
20167 * elm_index_item_prepend().
20171 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20174 * Insert a new item into the given index widget, using @p cmp_func
20175 * function to sort items (by item handles).
20177 * @param obj The index object.
20178 * @param letter Letter under which the item should be indexed
20179 * @param item The item data to set for the index's item
20180 * @param cmp_func The comparing function to be used to sort index
20181 * items <b>by #Elm_Index_Item item handles</b>
20182 * @param cmp_data_func A @b fallback function to be called for the
20183 * sorting of index items <b>by item data</b>). It will be used
20184 * when @p cmp_func returns @c 0 (equality), which means an index
20185 * item with provided item data already exists. To decide which
20186 * data item should be pointed to by the index item in question, @p
20187 * cmp_data_func will be used. If @p cmp_data_func returns a
20188 * non-negative value, the previous index item data will be
20189 * replaced by the given @p item pointer. If the previous data need
20190 * to be freed, it should be done by the @p cmp_data_func function,
20191 * because all references to it will be lost. If this function is
20192 * not provided (@c NULL is given), index items will be @b
20193 * duplicated, if @p cmp_func returns @c 0.
20195 * Despite the most common usage of the @p letter argument is for
20196 * single char strings, one could use arbitrary strings as index
20199 * @c item will be the pointer returned back on @c "changed", @c
20200 * "delay,changed" and @c "selected" smart events.
20204 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);
20207 * Remove an item from a given index widget, <b>to be referenced by
20208 * it's data value</b>.
20210 * @param obj The index object
20211 * @param item The item's data pointer for the item to be removed
20214 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20215 * that callback function will be called by this one.
20217 * @warning The item to be removed from @p obj will be found via
20218 * its item data pointer, and not by an #Elm_Index_Item handle.
20222 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20225 * Find a given index widget's item, <b>using item data</b>.
20227 * @param obj The index object
20228 * @param item The item data pointed to by the desired index item
20229 * @return The index item handle, if found, or @c NULL otherwise
20233 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20236 * Removes @b all items from a given index widget.
20238 * @param obj The index object.
20240 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20241 * that callback function will be called for each item in @p obj.
20245 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20248 * Go to a given items level on a index widget
20250 * @param obj The index object
20251 * @param level The index level (one of @c 0 or @c 1)
20255 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20258 * Return the data associated with a given index widget item
20260 * @param it The index widget item handle
20261 * @return The data associated with @p it
20263 * @see elm_index_item_data_set()
20267 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20270 * Set the data associated with a given index widget item
20272 * @param it The index widget item handle
20273 * @param data The new data pointer to set to @p it
20275 * This sets new item data on @p it.
20277 * @warning The old data pointer won't be touched by this function, so
20278 * the user had better to free that old data himself/herself.
20282 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20285 * Set the function to be called when a given index widget item is freed.
20287 * @param it The item to set the callback on
20288 * @param func The function to call on the item's deletion
20290 * When called, @p func will have both @c data and @c event_info
20291 * arguments with the @p it item's data value and, naturally, the
20292 * @c obj argument with a handle to the parent index widget.
20296 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20299 * Get the letter (string) set on a given index widget item.
20301 * @param it The index item handle
20302 * @return The letter string set on @p it
20306 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20313 * @defgroup Photocam Photocam
20315 * @image html img/widget/photocam/preview-00.png
20316 * @image latex img/widget/photocam/preview-00.eps
20318 * This is a widget specifically for displaying high-resolution digital
20319 * camera photos giving speedy feedback (fast load), low memory footprint
20320 * and zooming and panning as well as fitting logic. It is entirely focused
20321 * on jpeg images, and takes advantage of properties of the jpeg format (via
20322 * evas loader features in the jpeg loader).
20324 * Signals that you can add callbacks for are:
20325 * @li "clicked" - This is called when a user has clicked the photo without
20327 * @li "press" - This is called when a user has pressed down on the photo.
20328 * @li "longpressed" - This is called when a user has pressed down on the
20329 * photo for a long time without dragging around.
20330 * @li "clicked,double" - This is called when a user has double-clicked the
20332 * @li "load" - Photo load begins.
20333 * @li "loaded" - This is called when the image file load is complete for the
20334 * first view (low resolution blurry version).
20335 * @li "load,detail" - Photo detailed data load begins.
20336 * @li "loaded,detail" - This is called when the image file load is complete
20337 * for the detailed image data (full resolution needed).
20338 * @li "zoom,start" - Zoom animation started.
20339 * @li "zoom,stop" - Zoom animation stopped.
20340 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20341 * @li "scroll" - the content has been scrolled (moved)
20342 * @li "scroll,anim,start" - scrolling animation has started
20343 * @li "scroll,anim,stop" - scrolling animation has stopped
20344 * @li "scroll,drag,start" - dragging the contents around has started
20345 * @li "scroll,drag,stop" - dragging the contents around has stopped
20347 * @ref tutorial_photocam shows the API in action.
20351 * @brief Types of zoom available.
20353 typedef enum _Elm_Photocam_Zoom_Mode
20355 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20356 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20357 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20358 ELM_PHOTOCAM_ZOOM_MODE_LAST
20359 } Elm_Photocam_Zoom_Mode;
20361 * @brief Add a new Photocam object
20363 * @param parent The parent object
20364 * @return The new object or NULL if it cannot be created
20366 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20368 * @brief Set the photo file to be shown
20370 * @param obj The photocam object
20371 * @param file The photo file
20372 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20374 * This sets (and shows) the specified file (with a relative or absolute
20375 * path) and will return a load error (same error that
20376 * evas_object_image_load_error_get() will return). The image will change and
20377 * adjust its size at this point and begin a background load process for this
20378 * photo that at some time in the future will be displayed at the full
20381 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20383 * @brief Returns the path of the current image file
20385 * @param obj The photocam object
20386 * @return Returns the path
20388 * @see elm_photocam_file_set()
20390 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20392 * @brief Set the zoom level of the photo
20394 * @param obj The photocam object
20395 * @param zoom The zoom level to set
20397 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20398 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20399 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20400 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20403 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20405 * @brief Get the zoom level of the photo
20407 * @param obj The photocam object
20408 * @return The current zoom level
20410 * This returns the current zoom level of the photocam object. Note that if
20411 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20412 * (which is the default), the zoom level may be changed at any time by the
20413 * photocam object itself to account for photo size and photocam viewpoer
20416 * @see elm_photocam_zoom_set()
20417 * @see elm_photocam_zoom_mode_set()
20419 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20421 * @brief Set the zoom mode
20423 * @param obj The photocam object
20424 * @param mode The desired mode
20426 * This sets the zoom mode to manual or one of several automatic levels.
20427 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20428 * elm_photocam_zoom_set() and will stay at that level until changed by code
20429 * or until zoom mode is changed. This is the default mode. The Automatic
20430 * modes will allow the photocam object to automatically adjust zoom mode
20431 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20432 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20433 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20434 * pixels within the frame are left unfilled.
20436 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20438 * @brief Get the zoom mode
20440 * @param obj The photocam object
20441 * @return The current zoom mode
20443 * This gets the current zoom mode of the photocam object.
20445 * @see elm_photocam_zoom_mode_set()
20447 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20449 * @brief Get the current image pixel width and height
20451 * @param obj The photocam object
20452 * @param w A pointer to the width return
20453 * @param h A pointer to the height return
20455 * This gets the current photo pixel width and height (for the original).
20456 * The size will be returned in the integers @p w and @p h that are pointed
20459 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20461 * @brief Get the area of the image that is currently shown
20464 * @param x A pointer to the X-coordinate of region
20465 * @param y A pointer to the Y-coordinate of region
20466 * @param w A pointer to the width
20467 * @param h A pointer to the height
20469 * @see elm_photocam_image_region_show()
20470 * @see elm_photocam_image_region_bring_in()
20472 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20474 * @brief Set the viewed portion of the image
20476 * @param obj The photocam object
20477 * @param x X-coordinate of region in image original pixels
20478 * @param y Y-coordinate of region in image original pixels
20479 * @param w Width of region in image original pixels
20480 * @param h Height of region in image original pixels
20482 * This shows the region of the image without using animation.
20484 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20486 * @brief Bring in the viewed portion of the image
20488 * @param obj The photocam object
20489 * @param x X-coordinate of region in image original pixels
20490 * @param y Y-coordinate of region in image original pixels
20491 * @param w Width of region in image original pixels
20492 * @param h Height of region in image original pixels
20494 * This shows the region of the image using animation.
20496 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20498 * @brief Set the paused state for photocam
20500 * @param obj The photocam object
20501 * @param paused The pause state to set
20503 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20504 * photocam. The default is off. This will stop zooming using animation on
20505 * zoom levels changes and change instantly. This will stop any existing
20506 * animations that are running.
20508 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20510 * @brief Get the paused state for photocam
20512 * @param obj The photocam object
20513 * @return The current paused state
20515 * This gets the current paused state for the photocam object.
20517 * @see elm_photocam_paused_set()
20519 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20521 * @brief Get the internal low-res image used for photocam
20523 * @param obj The photocam object
20524 * @return The internal image object handle, or NULL if none exists
20526 * This gets the internal image object inside photocam. Do not modify it. It
20527 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20528 * deleted at any time as well.
20530 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20532 * @brief Set the photocam scrolling bouncing.
20534 * @param obj The photocam object
20535 * @param h_bounce bouncing for horizontal
20536 * @param v_bounce bouncing for vertical
20538 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20540 * @brief Get the photocam scrolling bouncing.
20542 * @param obj The photocam object
20543 * @param h_bounce bouncing for horizontal
20544 * @param v_bounce bouncing for vertical
20546 * @see elm_photocam_bounce_set()
20548 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20554 * @defgroup Map Map
20555 * @ingroup Elementary
20557 * @image html img/widget/map/preview-00.png
20558 * @image latex img/widget/map/preview-00.eps
20560 * This is a widget specifically for displaying a map. It uses basically
20561 * OpenStreetMap provider http://www.openstreetmap.org/,
20562 * but custom providers can be added.
20564 * It supports some basic but yet nice features:
20565 * @li zoom and scroll
20566 * @li markers with content to be displayed when user clicks over it
20567 * @li group of markers
20570 * Smart callbacks one can listen to:
20572 * - "clicked" - This is called when a user has clicked the map without
20574 * - "press" - This is called when a user has pressed down on the map.
20575 * - "longpressed" - This is called when a user has pressed down on the map
20576 * for a long time without dragging around.
20577 * - "clicked,double" - This is called when a user has double-clicked
20579 * - "load,detail" - Map detailed data load begins.
20580 * - "loaded,detail" - This is called when all currently visible parts of
20581 * the map are loaded.
20582 * - "zoom,start" - Zoom animation started.
20583 * - "zoom,stop" - Zoom animation stopped.
20584 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20585 * - "scroll" - the content has been scrolled (moved).
20586 * - "scroll,anim,start" - scrolling animation has started.
20587 * - "scroll,anim,stop" - scrolling animation has stopped.
20588 * - "scroll,drag,start" - dragging the contents around has started.
20589 * - "scroll,drag,stop" - dragging the contents around has stopped.
20590 * - "downloaded" - This is called when all currently required map images
20592 * - "route,load" - This is called when route request begins.
20593 * - "route,loaded" - This is called when route request ends.
20594 * - "name,load" - This is called when name request begins.
20595 * - "name,loaded- This is called when name request ends.
20597 * Available style for map widget:
20600 * Available style for markers:
20605 * Available style for marker bubble:
20608 * List of examples:
20609 * @li @ref map_example_01
20610 * @li @ref map_example_02
20611 * @li @ref map_example_03
20620 * @enum _Elm_Map_Zoom_Mode
20621 * @typedef Elm_Map_Zoom_Mode
20623 * Set map's zoom behavior. It can be set to manual or automatic.
20625 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20627 * Values <b> don't </b> work as bitmask, only one can be choosen.
20629 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20630 * than the scroller view.
20632 * @see elm_map_zoom_mode_set()
20633 * @see elm_map_zoom_mode_get()
20637 typedef enum _Elm_Map_Zoom_Mode
20639 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20640 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20641 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20642 ELM_MAP_ZOOM_MODE_LAST
20643 } Elm_Map_Zoom_Mode;
20646 * @enum _Elm_Map_Route_Sources
20647 * @typedef Elm_Map_Route_Sources
20649 * Set route service to be used. By default used source is
20650 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20652 * @see elm_map_route_source_set()
20653 * @see elm_map_route_source_get()
20657 typedef enum _Elm_Map_Route_Sources
20659 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20660 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. */
20661 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20662 ELM_MAP_ROUTE_SOURCE_LAST
20663 } Elm_Map_Route_Sources;
20665 typedef enum _Elm_Map_Name_Sources
20667 ELM_MAP_NAME_SOURCE_NOMINATIM,
20668 ELM_MAP_NAME_SOURCE_LAST
20669 } Elm_Map_Name_Sources;
20672 * @enum _Elm_Map_Route_Type
20673 * @typedef Elm_Map_Route_Type
20675 * Set type of transport used on route.
20677 * @see elm_map_route_add()
20681 typedef enum _Elm_Map_Route_Type
20683 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20684 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20685 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20686 ELM_MAP_ROUTE_TYPE_LAST
20687 } Elm_Map_Route_Type;
20690 * @enum _Elm_Map_Route_Method
20691 * @typedef Elm_Map_Route_Method
20693 * Set the routing method, what should be priorized, time or distance.
20695 * @see elm_map_route_add()
20699 typedef enum _Elm_Map_Route_Method
20701 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20702 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20703 ELM_MAP_ROUTE_METHOD_LAST
20704 } Elm_Map_Route_Method;
20706 typedef enum _Elm_Map_Name_Method
20708 ELM_MAP_NAME_METHOD_SEARCH,
20709 ELM_MAP_NAME_METHOD_REVERSE,
20710 ELM_MAP_NAME_METHOD_LAST
20711 } Elm_Map_Name_Method;
20713 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(). */
20714 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(). */
20715 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(). */
20716 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(). */
20717 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20718 typedef struct _Elm_Map_Track Elm_Map_Track;
20720 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. */
20721 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20722 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20723 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20725 typedef char *(*ElmMapModuleSourceFunc) (void);
20726 typedef int (*ElmMapModuleZoomMinFunc) (void);
20727 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20728 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20729 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20730 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20731 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20732 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20733 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20736 * Add a new map widget to the given parent Elementary (container) object.
20738 * @param parent The parent object.
20739 * @return a new map widget handle or @c NULL, on errors.
20741 * This function inserts a new map widget on the canvas.
20745 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20748 * Set the zoom level of the map.
20750 * @param obj The map object.
20751 * @param zoom The zoom level to set.
20753 * This sets the zoom level.
20755 * It will respect limits defined by elm_map_source_zoom_min_set() and
20756 * elm_map_source_zoom_max_set().
20758 * By default these values are 0 (world map) and 18 (maximum zoom).
20760 * This function should be used when zoom mode is set to
20761 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20762 * with elm_map_zoom_mode_set().
20764 * @see elm_map_zoom_mode_set().
20765 * @see elm_map_zoom_get().
20769 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20772 * Get the zoom level of the map.
20774 * @param obj The map object.
20775 * @return The current zoom level.
20777 * This returns the current zoom level of the map object.
20779 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20780 * (which is the default), the zoom level may be changed at any time by the
20781 * map object itself to account for map size and map viewport size.
20783 * @see elm_map_zoom_set() for details.
20787 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20790 * Set the zoom mode used by the map object.
20792 * @param obj The map object.
20793 * @param mode The zoom mode of the map, being it one of
20794 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20795 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20797 * This sets the zoom mode to manual or one of the automatic levels.
20798 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20799 * elm_map_zoom_set() and will stay at that level until changed by code
20800 * or until zoom mode is changed. This is the default mode.
20802 * The Automatic modes will allow the map object to automatically
20803 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20804 * adjust zoom so the map fits inside the scroll frame with no pixels
20805 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20806 * ensure no pixels within the frame are left unfilled. Do not forget that
20807 * the valid sizes are 2^zoom, consequently the map may be smaller than
20808 * the scroller view.
20810 * @see elm_map_zoom_set()
20814 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20817 * Get the zoom mode used by the map object.
20819 * @param obj The map object.
20820 * @return The zoom mode of the map, being it one of
20821 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20822 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20824 * This function returns the current zoom mode used by the map object.
20826 * @see elm_map_zoom_mode_set() for more details.
20830 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20833 * Get the current coordinates of the map.
20835 * @param obj The map object.
20836 * @param lon Pointer where to store longitude.
20837 * @param lat Pointer where to store latitude.
20839 * This gets the current center coordinates of the map object. It can be
20840 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20842 * @see elm_map_geo_region_bring_in()
20843 * @see elm_map_geo_region_show()
20847 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20850 * Animatedly bring in given coordinates to the center of the map.
20852 * @param obj The map object.
20853 * @param lon Longitude to center at.
20854 * @param lat Latitude to center at.
20856 * This causes map to jump to the given @p lat and @p lon coordinates
20857 * and show it (by scrolling) in the center of the viewport, if it is not
20858 * already centered. This will use animation to do so and take a period
20859 * of time to complete.
20861 * @see elm_map_geo_region_show() for a function to avoid animation.
20862 * @see elm_map_geo_region_get()
20866 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20869 * Show the given coordinates at the center of the map, @b immediately.
20871 * @param obj The map object.
20872 * @param lon Longitude to center at.
20873 * @param lat Latitude to center at.
20875 * This causes map to @b redraw its viewport's contents to the
20876 * region contining the given @p lat and @p lon, that will be moved to the
20877 * center of the map.
20879 * @see elm_map_geo_region_bring_in() for a function to move with animation.
20880 * @see elm_map_geo_region_get()
20884 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20887 * Pause or unpause the map.
20889 * @param obj The map object.
20890 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20893 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20896 * The default is off.
20898 * This will stop zooming using animation, changing zoom levels will
20899 * change instantly. This will stop any existing animations that are running.
20901 * @see elm_map_paused_get()
20905 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20908 * Get a value whether map is paused or not.
20910 * @param obj The map object.
20911 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
20912 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
20914 * This gets the current paused state for the map object.
20916 * @see elm_map_paused_set() for details.
20920 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20923 * Set to show markers during zoom level changes or not.
20925 * @param obj The map object.
20926 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
20929 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20932 * The default is off.
20934 * This will stop zooming using animation, changing zoom levels will
20935 * change instantly. This will stop any existing animations that are running.
20937 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20940 * The default is off.
20942 * Enabling it will force the map to stop displaying the markers during
20943 * zoom level changes. Set to on if you have a large number of markers.
20945 * @see elm_map_paused_markers_get()
20949 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20952 * Get a value whether markers will be displayed on zoom level changes or not
20954 * @param obj The map object.
20955 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
20956 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
20958 * This gets the current markers paused state for the map object.
20960 * @see elm_map_paused_markers_set() for details.
20964 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20967 * Get the information of downloading status.
20969 * @param obj The map object.
20970 * @param try_num Pointer where to store number of tiles being downloaded.
20971 * @param finish_num Pointer where to store number of tiles successfully
20974 * This gets the current downloading status for the map object, the number
20975 * of tiles being downloaded and the number of tiles already downloaded.
20979 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
20982 * Convert a pixel coordinate (x,y) into a geographic coordinate
20983 * (longitude, latitude).
20985 * @param obj The map object.
20986 * @param x the coordinate.
20987 * @param y the coordinate.
20988 * @param size the size in pixels of the map.
20989 * The map is a square and generally his size is : pow(2.0, zoom)*256.
20990 * @param lon Pointer where to store the longitude that correspond to x.
20991 * @param lat Pointer where to store the latitude that correspond to y.
20993 * @note Origin pixel point is the top left corner of the viewport.
20994 * Map zoom and size are taken on account.
20996 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21000 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);
21003 * Convert a geographic coordinate (longitude, latitude) into a pixel
21004 * coordinate (x, y).
21006 * @param obj The map object.
21007 * @param lon the longitude.
21008 * @param lat the latitude.
21009 * @param size the size in pixels of the map. The map is a square
21010 * and generally his size is : pow(2.0, zoom)*256.
21011 * @param x Pointer where to store the horizontal pixel coordinate that
21012 * correspond to the longitude.
21013 * @param y Pointer where to store the vertical pixel coordinate that
21014 * correspond to the latitude.
21016 * @note Origin pixel point is the top left corner of the viewport.
21017 * Map zoom and size are taken on account.
21019 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21023 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);
21026 * Convert a geographic coordinate (longitude, latitude) into a name
21029 * @param obj The map object.
21030 * @param lon the longitude.
21031 * @param lat the latitude.
21032 * @return name A #Elm_Map_Name handle for this coordinate.
21034 * To get the string for this address, elm_map_name_address_get()
21037 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21041 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21044 * Convert a name (address) into a geographic coordinate
21045 * (longitude, latitude).
21047 * @param obj The map object.
21048 * @param name The address.
21049 * @return name A #Elm_Map_Name handle for this address.
21051 * To get the longitude and latitude, elm_map_name_region_get()
21054 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21058 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21061 * Convert a pixel coordinate into a rotated pixel coordinate.
21063 * @param obj The map object.
21064 * @param x horizontal coordinate of the point to rotate.
21065 * @param y vertical coordinate of the point to rotate.
21066 * @param cx rotation's center horizontal position.
21067 * @param cy rotation's center vertical position.
21068 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21069 * @param xx Pointer where to store rotated x.
21070 * @param yy Pointer where to store rotated y.
21074 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);
21077 * Add a new marker to the map object.
21079 * @param obj The map object.
21080 * @param lon The longitude of the marker.
21081 * @param lat The latitude of the marker.
21082 * @param clas The class, to use when marker @b isn't grouped to others.
21083 * @param clas_group The class group, to use when marker is grouped to others
21084 * @param data The data passed to the callbacks.
21086 * @return The created marker or @c NULL upon failure.
21088 * A marker will be created and shown in a specific point of the map, defined
21089 * by @p lon and @p lat.
21091 * It will be displayed using style defined by @p class when this marker
21092 * is displayed alone (not grouped). A new class can be created with
21093 * elm_map_marker_class_new().
21095 * If the marker is grouped to other markers, it will be displayed with
21096 * style defined by @p class_group. Markers with the same group are grouped
21097 * if they are close. A new group class can be created with
21098 * elm_map_marker_group_class_new().
21100 * Markers created with this method can be deleted with
21101 * elm_map_marker_remove().
21103 * A marker can have associated content to be displayed by a bubble,
21104 * when a user click over it, as well as an icon. These objects will
21105 * be fetch using class' callback functions.
21107 * @see elm_map_marker_class_new()
21108 * @see elm_map_marker_group_class_new()
21109 * @see elm_map_marker_remove()
21113 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);
21116 * Set the maximum numbers of markers' content to be displayed in a group.
21118 * @param obj The map object.
21119 * @param max The maximum numbers of items displayed in a bubble.
21121 * A bubble will be displayed when the user clicks over the group,
21122 * and will place the content of markers that belong to this group
21125 * A group can have a long list of markers, consequently the creation
21126 * of the content of the bubble can be very slow.
21128 * In order to avoid this, a maximum number of items is displayed
21131 * By default this number is 30.
21133 * Marker with the same group class are grouped if they are close.
21135 * @see elm_map_marker_add()
21139 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21142 * Remove a marker from the map.
21144 * @param marker The marker to remove.
21146 * @see elm_map_marker_add()
21150 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21153 * Get the current coordinates of the marker.
21155 * @param marker marker.
21156 * @param lat Pointer where to store the marker's latitude.
21157 * @param lon Pointer where to store the marker's longitude.
21159 * These values are set when adding markers, with function
21160 * elm_map_marker_add().
21162 * @see elm_map_marker_add()
21166 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21169 * Animatedly bring in given marker to the center of the map.
21171 * @param marker The marker to center at.
21173 * This causes map to jump to the given @p marker's coordinates
21174 * and show it (by scrolling) in the center of the viewport, if it is not
21175 * already centered. This will use animation to do so and take a period
21176 * of time to complete.
21178 * @see elm_map_marker_show() for a function to avoid animation.
21179 * @see elm_map_marker_region_get()
21183 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21186 * Show the given marker at the center of the map, @b immediately.
21188 * @param marker The marker to center at.
21190 * This causes map to @b redraw its viewport's contents to the
21191 * region contining the given @p marker's coordinates, that will be
21192 * moved to the center of the map.
21194 * @see elm_map_marker_bring_in() for a function to move with animation.
21195 * @see elm_map_markers_list_show() if more than one marker need to be
21197 * @see elm_map_marker_region_get()
21201 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21204 * Move and zoom the map to display a list of markers.
21206 * @param markers A list of #Elm_Map_Marker handles.
21208 * The map will be centered on the center point of the markers in the list.
21209 * Then the map will be zoomed in order to fit the markers using the maximum
21210 * zoom which allows display of all the markers.
21212 * @warning All the markers should belong to the same map object.
21214 * @see elm_map_marker_show() to show a single marker.
21215 * @see elm_map_marker_bring_in()
21219 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21222 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21224 * @param marker The marker wich content should be returned.
21225 * @return Return the evas object if it exists, else @c NULL.
21227 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21228 * elm_map_marker_class_get_cb_set() should be used.
21230 * This content is what will be inside the bubble that will be displayed
21231 * when an user clicks over the marker.
21233 * This returns the actual Evas object used to be placed inside
21234 * the bubble. This may be @c NULL, as it may
21235 * not have been created or may have been deleted, at any time, by
21236 * the map. <b>Do not modify this object</b> (move, resize,
21237 * show, hide, etc.), as the map is controlling it. This
21238 * function is for querying, emitting custom signals or hooking
21239 * lower level callbacks for events on that object. Do not delete
21240 * this object under any circumstances.
21244 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21247 * Update the marker
21249 * @param marker The marker to be updated.
21251 * If a content is set to this marker, it will call function to delete it,
21252 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21253 * #ElmMapMarkerGetFunc.
21255 * These functions are set for the marker class with
21256 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21260 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21263 * Close all the bubbles opened by the user.
21265 * @param obj The map object.
21267 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21268 * when the user clicks on a marker.
21270 * This functions is set for the marker class with
21271 * elm_map_marker_class_get_cb_set().
21275 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21278 * Create a new group class.
21280 * @param obj The map object.
21281 * @return Returns the new group class.
21283 * Each marker must be associated to a group class. Markers in the same
21284 * group are grouped if they are close.
21286 * The group class defines the style of the marker when a marker is grouped
21287 * to others markers. When it is alone, another class will be used.
21289 * A group class will need to be provided when creating a marker with
21290 * elm_map_marker_add().
21292 * Some properties and functions can be set by class, as:
21293 * - style, with elm_map_group_class_style_set()
21294 * - data - to be associated to the group class. It can be set using
21295 * elm_map_group_class_data_set().
21296 * - min zoom to display markers, set with
21297 * elm_map_group_class_zoom_displayed_set().
21298 * - max zoom to group markers, set using
21299 * elm_map_group_class_zoom_grouped_set().
21300 * - visibility - set if markers will be visible or not, set with
21301 * elm_map_group_class_hide_set().
21302 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21303 * It can be set using elm_map_group_class_icon_cb_set().
21305 * @see elm_map_marker_add()
21306 * @see elm_map_group_class_style_set()
21307 * @see elm_map_group_class_data_set()
21308 * @see elm_map_group_class_zoom_displayed_set()
21309 * @see elm_map_group_class_zoom_grouped_set()
21310 * @see elm_map_group_class_hide_set()
21311 * @see elm_map_group_class_icon_cb_set()
21315 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21318 * Set the marker's style of a group class.
21320 * @param clas The group class.
21321 * @param style The style to be used by markers.
21323 * Each marker must be associated to a group class, and will use the style
21324 * defined by such class when grouped to other markers.
21326 * The following styles are provided by default theme:
21327 * @li @c radio - blue circle
21328 * @li @c radio2 - green circle
21331 * @see elm_map_group_class_new() for more details.
21332 * @see elm_map_marker_add()
21336 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21339 * Set the icon callback function of a group class.
21341 * @param clas The group class.
21342 * @param icon_get The callback function that will return the icon.
21344 * Each marker must be associated to a group class, and it can display a
21345 * custom icon. The function @p icon_get must return this icon.
21347 * @see elm_map_group_class_new() for more details.
21348 * @see elm_map_marker_add()
21352 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21355 * Set the data associated to the group class.
21357 * @param clas The group class.
21358 * @param data The new user data.
21360 * This data will be passed for callback functions, like icon get callback,
21361 * that can be set with elm_map_group_class_icon_cb_set().
21363 * If a data was previously set, the object will lose the pointer for it,
21364 * so if needs to be freed, you must do it yourself.
21366 * @see elm_map_group_class_new() for more details.
21367 * @see elm_map_group_class_icon_cb_set()
21368 * @see elm_map_marker_add()
21372 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21375 * Set the minimum zoom from where the markers are displayed.
21377 * @param clas The group class.
21378 * @param zoom The minimum zoom.
21380 * Markers only will be displayed when the map is displayed at @p zoom
21383 * @see elm_map_group_class_new() for more details.
21384 * @see elm_map_marker_add()
21388 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21391 * Set the zoom from where the markers are no more grouped.
21393 * @param clas The group class.
21394 * @param zoom The maximum zoom.
21396 * Markers only will be grouped when the map is displayed at
21397 * less than @p zoom.
21399 * @see elm_map_group_class_new() for more details.
21400 * @see elm_map_marker_add()
21404 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21407 * Set if the markers associated to the group class @clas are hidden or not.
21409 * @param clas The group class.
21410 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21413 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21418 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21421 * Create a new marker class.
21423 * @param obj The map object.
21424 * @return Returns the new group class.
21426 * Each marker must be associated to a class.
21428 * The marker class defines the style of the marker when a marker is
21429 * displayed alone, i.e., not grouped to to others markers. When grouped
21430 * it will use group class style.
21432 * A marker class will need to be provided when creating a marker with
21433 * elm_map_marker_add().
21435 * Some properties and functions can be set by class, as:
21436 * - style, with elm_map_marker_class_style_set()
21437 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21438 * It can be set using elm_map_marker_class_icon_cb_set().
21439 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21440 * Set using elm_map_marker_class_get_cb_set().
21441 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21442 * Set using elm_map_marker_class_del_cb_set().
21444 * @see elm_map_marker_add()
21445 * @see elm_map_marker_class_style_set()
21446 * @see elm_map_marker_class_icon_cb_set()
21447 * @see elm_map_marker_class_get_cb_set()
21448 * @see elm_map_marker_class_del_cb_set()
21452 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21455 * Set the marker's style of a marker class.
21457 * @param clas The marker class.
21458 * @param style The style to be used by markers.
21460 * Each marker must be associated to a marker class, and will use the style
21461 * defined by such class when alone, i.e., @b not grouped to other markers.
21463 * The following styles are provided by default theme:
21468 * @see elm_map_marker_class_new() for more details.
21469 * @see elm_map_marker_add()
21473 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21476 * Set the icon callback function of a marker class.
21478 * @param clas The marker class.
21479 * @param icon_get The callback function that will return the icon.
21481 * Each marker must be associated to a marker class, and it can display a
21482 * custom icon. The function @p icon_get must return this icon.
21484 * @see elm_map_marker_class_new() for more details.
21485 * @see elm_map_marker_add()
21489 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21492 * Set the bubble content callback function of a marker class.
21494 * @param clas The marker class.
21495 * @param get The callback function that will return the content.
21497 * Each marker must be associated to a marker class, and it can display a
21498 * a content on a bubble that opens when the user click over the marker.
21499 * The function @p get must return this content object.
21501 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21504 * @see elm_map_marker_class_new() for more details.
21505 * @see elm_map_marker_class_del_cb_set()
21506 * @see elm_map_marker_add()
21510 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21513 * Set the callback function used to delete bubble content of a marker class.
21515 * @param clas The marker class.
21516 * @param del The callback function that will delete the content.
21518 * Each marker must be associated to a marker class, and it can display a
21519 * a content on a bubble that opens when the user click over the marker.
21520 * The function to return such content can be set with
21521 * elm_map_marker_class_get_cb_set().
21523 * If this content must be freed, a callback function need to be
21524 * set for that task with this function.
21526 * If this callback is defined it will have to delete (or not) the
21527 * object inside, but if the callback is not defined the object will be
21528 * destroyed with evas_object_del().
21530 * @see elm_map_marker_class_new() for more details.
21531 * @see elm_map_marker_class_get_cb_set()
21532 * @see elm_map_marker_add()
21536 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21539 * Get the list of available sources.
21541 * @param obj The map object.
21542 * @return The source names list.
21544 * It will provide a list with all available sources, that can be set as
21545 * current source with elm_map_source_name_set(), or get with
21546 * elm_map_source_name_get().
21548 * Available sources:
21554 * @see elm_map_source_name_set() for more details.
21555 * @see elm_map_source_name_get()
21559 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21562 * Set the source of the map.
21564 * @param obj The map object.
21565 * @param source The source to be used.
21567 * Map widget retrieves images that composes the map from a web service.
21568 * This web service can be set with this method.
21570 * A different service can return a different maps with different
21571 * information and it can use different zoom values.
21573 * The @p source_name need to match one of the names provided by
21574 * elm_map_source_names_get().
21576 * The current source can be get using elm_map_source_name_get().
21578 * @see elm_map_source_names_get()
21579 * @see elm_map_source_name_get()
21584 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21587 * Get the name of currently used source.
21589 * @param obj The map object.
21590 * @return Returns the name of the source in use.
21592 * @see elm_map_source_name_set() for more details.
21596 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21599 * Set the source of the route service to be used by the map.
21601 * @param obj The map object.
21602 * @param source The route service to be used, being it one of
21603 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21604 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21606 * Each one has its own algorithm, so the route retrieved may
21607 * differ depending on the source route. Now, only the default is working.
21609 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21610 * http://www.yournavigation.org/.
21612 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21613 * assumptions. Its routing core is based on Contraction Hierarchies.
21615 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21617 * @see elm_map_route_source_get().
21621 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21624 * Get the current route source.
21626 * @param obj The map object.
21627 * @return The source of the route service used by the map.
21629 * @see elm_map_route_source_set() for details.
21633 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21636 * Set the minimum zoom of the source.
21638 * @param obj The map object.
21639 * @param zoom New minimum zoom value to be used.
21641 * By default, it's 0.
21645 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21648 * Get the minimum zoom of the source.
21650 * @param obj The map object.
21651 * @return Returns the minimum zoom of the source.
21653 * @see elm_map_source_zoom_min_set() for details.
21657 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21660 * Set the maximum zoom of the source.
21662 * @param obj The map object.
21663 * @param zoom New maximum zoom value to be used.
21665 * By default, it's 18.
21669 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21672 * Get the maximum zoom of the source.
21674 * @param obj The map object.
21675 * @return Returns the maximum zoom of the source.
21677 * @see elm_map_source_zoom_min_set() for details.
21681 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21684 * Set the user agent used by the map object to access routing services.
21686 * @param obj The map object.
21687 * @param user_agent The user agent to be used by the map.
21689 * User agent is a client application implementing a network protocol used
21690 * in communications within a client–server distributed computing system
21692 * The @p user_agent identification string will transmitted in a header
21693 * field @c User-Agent.
21695 * @see elm_map_user_agent_get()
21699 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21702 * Get the user agent used by the map object.
21704 * @param obj The map object.
21705 * @return The user agent identification string used by the map.
21707 * @see elm_map_user_agent_set() for details.
21711 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21714 * Add a new route to the map object.
21716 * @param obj The map object.
21717 * @param type The type of transport to be considered when tracing a route.
21718 * @param method The routing method, what should be priorized.
21719 * @param flon The start longitude.
21720 * @param flat The start latitude.
21721 * @param tlon The destination longitude.
21722 * @param tlat The destination latitude.
21724 * @return The created route or @c NULL upon failure.
21726 * A route will be traced by point on coordinates (@p flat, @p flon)
21727 * to point on coordinates (@p tlat, @p tlon), using the route service
21728 * set with elm_map_route_source_set().
21730 * It will take @p type on consideration to define the route,
21731 * depending if the user will be walking or driving, the route may vary.
21732 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21733 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21735 * Another parameter is what the route should priorize, the minor distance
21736 * or the less time to be spend on the route. So @p method should be one
21737 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21739 * Routes created with this method can be deleted with
21740 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21741 * and distance can be get with elm_map_route_distance_get().
21743 * @see elm_map_route_remove()
21744 * @see elm_map_route_color_set()
21745 * @see elm_map_route_distance_get()
21746 * @see elm_map_route_source_set()
21750 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);
21753 * Remove a route from the map.
21755 * @param route The route to remove.
21757 * @see elm_map_route_add()
21761 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21764 * Set the route color.
21766 * @param route The route object.
21767 * @param r Red channel value, from 0 to 255.
21768 * @param g Green channel value, from 0 to 255.
21769 * @param b Blue channel value, from 0 to 255.
21770 * @param a Alpha channel value, from 0 to 255.
21772 * It uses an additive color model, so each color channel represents
21773 * how much of each primary colors must to be used. 0 represents
21774 * ausence of this color, so if all of the three are set to 0,
21775 * the color will be black.
21777 * These component values should be integers in the range 0 to 255,
21778 * (single 8-bit byte).
21780 * This sets the color used for the route. By default, it is set to
21781 * solid red (r = 255, g = 0, b = 0, a = 255).
21783 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21785 * @see elm_map_route_color_get()
21789 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21792 * Get the route color.
21794 * @param route The route object.
21795 * @param r Pointer where to store the red channel value.
21796 * @param g Pointer where to store the green channel value.
21797 * @param b Pointer where to store the blue channel value.
21798 * @param a Pointer where to store the alpha channel value.
21800 * @see elm_map_route_color_set() for details.
21804 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21807 * Get the route distance in kilometers.
21809 * @param route The route object.
21810 * @return The distance of route (unit : km).
21814 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21817 * Get the information of route nodes.
21819 * @param route The route object.
21820 * @return Returns a string with the nodes of route.
21824 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21827 * Get the information of route waypoint.
21829 * @param route the route object.
21830 * @return Returns a string with information about waypoint of route.
21834 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21837 * Get the address of the name.
21839 * @param name The name handle.
21840 * @return Returns the address string of @p name.
21842 * This gets the coordinates of the @p name, created with one of the
21843 * conversion functions.
21845 * @see elm_map_utils_convert_name_into_coord()
21846 * @see elm_map_utils_convert_coord_into_name()
21850 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21853 * Get the current coordinates of the name.
21855 * @param name The name handle.
21856 * @param lat Pointer where to store the latitude.
21857 * @param lon Pointer where to store The longitude.
21859 * This gets the coordinates of the @p name, created with one of the
21860 * conversion functions.
21862 * @see elm_map_utils_convert_name_into_coord()
21863 * @see elm_map_utils_convert_coord_into_name()
21867 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21870 * Remove a name from the map.
21872 * @param name The name to remove.
21874 * Basically the struct handled by @p name will be freed, so convertions
21875 * between address and coordinates will be lost.
21877 * @see elm_map_utils_convert_name_into_coord()
21878 * @see elm_map_utils_convert_coord_into_name()
21882 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21887 * @param obj The map object.
21888 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21889 * @param cx Rotation's center horizontal position.
21890 * @param cy Rotation's center vertical position.
21892 * @see elm_map_rotate_get()
21896 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
21899 * Get the rotate degree of the map
21901 * @param obj The map object
21902 * @param degree Pointer where to store degrees from 0.0 to 360.0
21903 * to rotate arount Z axis.
21904 * @param cx Pointer where to store rotation's center horizontal position.
21905 * @param cy Pointer where to store rotation's center vertical position.
21907 * @see elm_map_rotate_set() to set map rotation.
21911 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);
21914 * Enable or disable mouse wheel to be used to zoom in / out the map.
21916 * @param obj The map object.
21917 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
21920 * Mouse wheel can be used for the user to zoom in or zoom out the map.
21922 * It's disabled by default.
21924 * @see elm_map_wheel_disabled_get()
21928 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
21931 * Get a value whether mouse wheel is enabled or not.
21933 * @param obj The map object.
21934 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
21935 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21937 * Mouse wheel can be used for the user to zoom in or zoom out the map.
21939 * @see elm_map_wheel_disabled_set() for details.
21943 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21947 * Add a track on the map
21949 * @param obj The map object.
21950 * @param emap The emap route object.
21951 * @return The route object. This is an elm object of type Route.
21953 * @see elm_route_add() for details.
21957 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
21961 * Remove a track from the map
21963 * @param obj The map object.
21964 * @param route The track to remove.
21968 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
21975 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
21977 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
21979 EAPI double elm_route_lon_min_get(Evas_Object *obj);
21980 EAPI double elm_route_lat_min_get(Evas_Object *obj);
21981 EAPI double elm_route_lon_max_get(Evas_Object *obj);
21982 EAPI double elm_route_lat_max_get(Evas_Object *obj);
21986 * @defgroup Panel Panel
21988 * @image html img/widget/panel/preview-00.png
21989 * @image latex img/widget/panel/preview-00.eps
21991 * @brief A panel is a type of animated container that contains subobjects.
21992 * It can be expanded or contracted by clicking the button on it's edge.
21994 * Orientations are as follows:
21995 * @li ELM_PANEL_ORIENT_TOP
21996 * @li ELM_PANEL_ORIENT_LEFT
21997 * @li ELM_PANEL_ORIENT_RIGHT
21999 * @ref tutorial_panel shows one way to use this widget.
22002 typedef enum _Elm_Panel_Orient
22004 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22005 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22006 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22007 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22008 } Elm_Panel_Orient;
22010 * @brief Adds a panel object
22012 * @param parent The parent object
22014 * @return The panel object, or NULL on failure
22016 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22018 * @brief Sets the orientation of the panel
22020 * @param parent The parent object
22021 * @param orient The panel orientation. Can be one of the following:
22022 * @li ELM_PANEL_ORIENT_TOP
22023 * @li ELM_PANEL_ORIENT_LEFT
22024 * @li ELM_PANEL_ORIENT_RIGHT
22026 * Sets from where the panel will (dis)appear.
22028 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22030 * @brief Get the orientation of the panel.
22032 * @param obj The panel object
22033 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22035 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22037 * @brief Set the content of the panel.
22039 * @param obj The panel object
22040 * @param content The panel content
22042 * Once the content object is set, a previously set one will be deleted.
22043 * If you want to keep that old content object, use the
22044 * elm_panel_content_unset() function.
22046 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22048 * @brief Get the content of the panel.
22050 * @param obj The panel object
22051 * @return The content that is being used
22053 * Return the content object which is set for this widget.
22055 * @see elm_panel_content_set()
22057 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22059 * @brief Unset the content of the panel.
22061 * @param obj The panel object
22062 * @return The content that was being used
22064 * Unparent and return the content object which was set for this widget.
22066 * @see elm_panel_content_set()
22068 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22070 * @brief Set the state of the panel.
22072 * @param obj The panel object
22073 * @param hidden If true, the panel will run the animation to contract
22075 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22077 * @brief Get the state of the panel.
22079 * @param obj The panel object
22080 * @param hidden If true, the panel is in the "hide" state
22082 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22084 * @brief Toggle the hidden state of the panel from code
22086 * @param obj The panel object
22088 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22094 * @defgroup Panes Panes
22095 * @ingroup Elementary
22097 * @image html img/widget/panes/preview-00.png
22098 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22100 * @image html img/panes.png
22101 * @image latex img/panes.eps width=\textwidth
22103 * The panes adds a dragable bar between two contents. When dragged
22104 * this bar will resize contents size.
22106 * Panes can be displayed vertically or horizontally, and contents
22107 * size proportion can be customized (homogeneous by default).
22109 * Smart callbacks one can listen to:
22110 * - "press" - The panes has been pressed (button wasn't released yet).
22111 * - "unpressed" - The panes was released after being pressed.
22112 * - "clicked" - The panes has been clicked>
22113 * - "clicked,double" - The panes has been double clicked
22115 * Available styles for it:
22118 * Here is an example on its usage:
22119 * @li @ref panes_example
22123 * @addtogroup Panes
22128 * Add a new panes widget to the given parent Elementary
22129 * (container) object.
22131 * @param parent The parent object.
22132 * @return a new panes widget handle or @c NULL, on errors.
22134 * This function inserts a new panes widget on the canvas.
22138 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22141 * Set the left content of the panes widget.
22143 * @param obj The panes object.
22144 * @param content The new left content object.
22146 * Once the content object is set, a previously set one will be deleted.
22147 * If you want to keep that old content object, use the
22148 * elm_panes_content_left_unset() function.
22150 * If panes is displayed vertically, left content will be displayed at
22153 * @see elm_panes_content_left_get()
22154 * @see elm_panes_content_right_set() to set content on the other side.
22158 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22161 * Set the right content of the panes widget.
22163 * @param obj The panes object.
22164 * @param content The new right content object.
22166 * Once the content object is set, a previously set one will be deleted.
22167 * If you want to keep that old content object, use the
22168 * elm_panes_content_right_unset() function.
22170 * If panes is displayed vertically, left content will be displayed at
22173 * @see elm_panes_content_right_get()
22174 * @see elm_panes_content_left_set() to set content on the other side.
22178 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22181 * Get the left content of the panes.
22183 * @param obj The panes object.
22184 * @return The left content object that is being used.
22186 * Return the left content object which is set for this widget.
22188 * @see elm_panes_content_left_set() for details.
22192 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22195 * Get the right content of the panes.
22197 * @param obj The panes object
22198 * @return The right content object that is being used
22200 * Return the right content object which is set for this widget.
22202 * @see elm_panes_content_right_set() for details.
22206 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22209 * Unset the left content used for the panes.
22211 * @param obj The panes object.
22212 * @return The left content object that was being used.
22214 * Unparent and return the left content object which was set for this widget.
22216 * @see elm_panes_content_left_set() for details.
22217 * @see elm_panes_content_left_get().
22221 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22224 * Unset the right content used for the panes.
22226 * @param obj The panes object.
22227 * @return The right content object that was being used.
22229 * Unparent and return the right content object which was set for this
22232 * @see elm_panes_content_right_set() for details.
22233 * @see elm_panes_content_right_get().
22237 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22240 * Get the size proportion of panes widget's left side.
22242 * @param obj The panes object.
22243 * @return float value between 0.0 and 1.0 representing size proportion
22246 * @see elm_panes_content_left_size_set() for more details.
22250 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22253 * Set the size proportion of panes widget's left side.
22255 * @param obj The panes object.
22256 * @param size Value between 0.0 and 1.0 representing size proportion
22259 * By default it's homogeneous, i.e., both sides have the same size.
22261 * If something different is required, it can be set with this function.
22262 * For example, if the left content should be displayed over
22263 * 75% of the panes size, @p size should be passed as @c 0.75.
22264 * This way, right content will be resized to 25% of panes size.
22266 * If displayed vertically, left content is displayed at top, and
22267 * right content at bottom.
22269 * @note This proportion will change when user drags the panes bar.
22271 * @see elm_panes_content_left_size_get()
22275 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22278 * Set the orientation of a given panes widget.
22280 * @param obj The panes object.
22281 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22282 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22284 * Use this function to change how your panes is to be
22285 * disposed: vertically or horizontally.
22287 * By default it's displayed horizontally.
22289 * @see elm_panes_horizontal_get()
22293 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22296 * Retrieve the orientation of a given panes widget.
22298 * @param obj The panes object.
22299 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22300 * @c EINA_FALSE if it's @b vertical (and on errors).
22302 * @see elm_panes_horizontal_set() for more details.
22306 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22313 * @defgroup Flip Flip
22315 * @image html img/widget/flip/preview-00.png
22316 * @image latex img/widget/flip/preview-00.eps
22318 * This widget holds 2 content objects(Evas_Object): one on the front and one
22319 * on the back. It allows you to flip from front to back and vice-versa using
22320 * various animations.
22322 * If either the front or back contents are not set the flip will treat that
22323 * as transparent. So if you wore to set the front content but not the back,
22324 * and then call elm_flip_go() you would see whatever is below the flip.
22326 * For a list of supported animations see elm_flip_go().
22328 * Signals that you can add callbacks for are:
22329 * "animate,begin" - when a flip animation was started
22330 * "animate,done" - when a flip animation is finished
22332 * @ref tutorial_flip show how to use most of the API.
22336 typedef enum _Elm_Flip_Mode
22338 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22339 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22340 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22341 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22342 ELM_FLIP_CUBE_LEFT,
22343 ELM_FLIP_CUBE_RIGHT,
22345 ELM_FLIP_CUBE_DOWN,
22346 ELM_FLIP_PAGE_LEFT,
22347 ELM_FLIP_PAGE_RIGHT,
22351 typedef enum _Elm_Flip_Interaction
22353 ELM_FLIP_INTERACTION_NONE,
22354 ELM_FLIP_INTERACTION_ROTATE,
22355 ELM_FLIP_INTERACTION_CUBE,
22356 ELM_FLIP_INTERACTION_PAGE
22357 } Elm_Flip_Interaction;
22358 typedef enum _Elm_Flip_Direction
22360 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22361 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22362 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22363 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22364 } Elm_Flip_Direction;
22366 * @brief Add a new flip to the parent
22368 * @param parent The parent object
22369 * @return The new object or NULL if it cannot be created
22371 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22373 * @brief Set the front content of the flip widget.
22375 * @param obj The flip object
22376 * @param content The new front content object
22378 * Once the content object is set, a previously set one will be deleted.
22379 * If you want to keep that old content object, use the
22380 * elm_flip_content_front_unset() function.
22382 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22384 * @brief Set the back content of the flip widget.
22386 * @param obj The flip object
22387 * @param content The new back content object
22389 * Once the content object is set, a previously set one will be deleted.
22390 * If you want to keep that old content object, use the
22391 * elm_flip_content_back_unset() function.
22393 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22395 * @brief Get the front content used for the flip
22397 * @param obj The flip object
22398 * @return The front content object that is being used
22400 * Return the front content object which is set for this widget.
22402 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22404 * @brief Get the back content used for the flip
22406 * @param obj The flip object
22407 * @return The back content object that is being used
22409 * Return the back content object which is set for this widget.
22411 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22413 * @brief Unset the front content used for the flip
22415 * @param obj The flip object
22416 * @return The front content object that was being used
22418 * Unparent and return the front content object which was set for this widget.
22420 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22422 * @brief Unset the back content used for the flip
22424 * @param obj The flip object
22425 * @return The back content object that was being used
22427 * Unparent and return the back content object which was set for this widget.
22429 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22431 * @brief Get flip front visibility state
22433 * @param obj The flip objct
22434 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22437 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22439 * @brief Set flip perspective
22441 * @param obj The flip object
22442 * @param foc The coordinate to set the focus on
22443 * @param x The X coordinate
22444 * @param y The Y coordinate
22446 * @warning This function currently does nothing.
22448 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22450 * @brief Runs the flip animation
22452 * @param obj The flip object
22453 * @param mode The mode type
22455 * Flips the front and back contents using the @p mode animation. This
22456 * efectively hides the currently visible content and shows the hidden one.
22458 * There a number of possible animations to use for the flipping:
22459 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22460 * around a horizontal axis in the middle of its height, the other content
22461 * is shown as the other side of the flip.
22462 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22463 * around a vertical axis in the middle of its width, the other content is
22464 * shown as the other side of the flip.
22465 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22466 * around a diagonal axis in the middle of its width, the other content is
22467 * shown as the other side of the flip.
22468 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22469 * around a diagonal axis in the middle of its height, the other content is
22470 * shown as the other side of the flip.
22471 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22472 * as if the flip was a cube, the other content is show as the right face of
22474 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22475 * right as if the flip was a cube, the other content is show as the left
22476 * face of the cube.
22477 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22478 * flip was a cube, the other content is show as the bottom face of the cube.
22479 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22480 * the flip was a cube, the other content is show as the upper face of the
22482 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22483 * if the flip was a book, the other content is shown as the page below that.
22484 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22485 * as if the flip was a book, the other content is shown as the page below
22487 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22488 * flip was a book, the other content is shown as the page below that.
22489 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22490 * flip was a book, the other content is shown as the page below that.
22492 * @image html elm_flip.png
22493 * @image latex elm_flip.eps width=\textwidth
22495 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22497 * @brief Set the interactive flip mode
22499 * @param obj The flip object
22500 * @param mode The interactive flip mode to use
22502 * This sets if the flip should be interactive (allow user to click and
22503 * drag a side of the flip to reveal the back page and cause it to flip).
22504 * By default a flip is not interactive. You may also need to set which
22505 * sides of the flip are "active" for flipping and how much space they use
22506 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22507 * and elm_flip_interacton_direction_hitsize_set()
22509 * The four avilable mode of interaction are:
22510 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22511 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22512 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22513 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22515 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22516 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22517 * happen, those can only be acheived with elm_flip_go();
22519 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22521 * @brief Get the interactive flip mode
22523 * @param obj The flip object
22524 * @return The interactive flip mode
22526 * Returns the interactive flip mode set by elm_flip_interaction_set()
22528 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22530 * @brief Set which directions of the flip respond to interactive flip
22532 * @param obj The flip object
22533 * @param dir The direction to change
22534 * @param enabled If that direction is enabled or not
22536 * By default all directions are disabled, so you may want to enable the
22537 * desired directions for flipping if you need interactive flipping. You must
22538 * call this function once for each direction that should be enabled.
22540 * @see elm_flip_interaction_set()
22542 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22544 * @brief Get the enabled state of that flip direction
22546 * @param obj The flip object
22547 * @param dir The direction to check
22548 * @return If that direction is enabled or not
22550 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22552 * @see elm_flip_interaction_set()
22554 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22556 * @brief Set the amount of the flip that is sensitive to interactive flip
22558 * @param obj The flip object
22559 * @param dir The direction to modify
22560 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22562 * Set the amount of the flip that is sensitive to interactive flip, with 0
22563 * representing no area in the flip and 1 representing the entire flip. There
22564 * is however a consideration to be made in that the area will never be
22565 * smaller than the finger size set(as set in your Elementary configuration).
22567 * @see elm_flip_interaction_set()
22569 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22571 * @brief Get the amount of the flip that is sensitive to interactive flip
22573 * @param obj The flip object
22574 * @param dir The direction to check
22575 * @return The size set for that direction
22577 * Returns the amount os sensitive area set by
22578 * elm_flip_interacton_direction_hitsize_set().
22580 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22585 /* scrolledentry */
22586 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22587 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22588 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22589 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22590 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22591 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22592 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22593 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22594 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22595 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22596 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22597 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22598 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22599 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22600 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22601 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22602 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22603 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22604 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22605 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22606 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22607 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22608 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22609 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22610 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22611 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22612 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22613 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22614 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22615 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22616 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22617 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22618 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22619 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22620 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22621 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);
22622 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22623 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22624 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);
22625 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22626 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);
22627 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22628 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22629 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22630 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22631 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22632 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22633 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22634 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22635 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);
22636 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);
22637 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);
22638 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);
22639 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);
22640 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);
22641 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22642 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22643 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22644 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22645 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22646 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22647 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22650 * @defgroup Conformant Conformant
22651 * @ingroup Elementary
22653 * @image html img/widget/conformant/preview-00.png
22654 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22656 * @image html img/conformant.png
22657 * @image latex img/conformant.eps width=\textwidth
22659 * The aim is to provide a widget that can be used in elementary apps to
22660 * account for space taken up by the indicator, virtual keypad & softkey
22661 * windows when running the illume2 module of E17.
22663 * So conformant content will be sized and positioned considering the
22664 * space required for such stuff, and when they popup, as a keyboard
22665 * shows when an entry is selected, conformant content won't change.
22667 * Available styles for it:
22670 * See how to use this widget in this example:
22671 * @ref conformant_example
22675 * @addtogroup Conformant
22680 * Add a new conformant widget to the given parent Elementary
22681 * (container) object.
22683 * @param parent The parent object.
22684 * @return A new conformant widget handle or @c NULL, on errors.
22686 * This function inserts a new conformant widget on the canvas.
22688 * @ingroup Conformant
22690 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22693 * Set the content of the conformant widget.
22695 * @param obj The conformant object.
22696 * @param content The content to be displayed by the conformant.
22698 * Content will be sized and positioned considering the space required
22699 * to display a virtual keyboard. So it won't fill all the conformant
22700 * size. This way is possible to be sure that content won't resize
22701 * or be re-positioned after the keyboard is displayed.
22703 * Once the content object is set, a previously set one will be deleted.
22704 * If you want to keep that old content object, use the
22705 * elm_conformat_content_unset() function.
22707 * @see elm_conformant_content_unset()
22708 * @see elm_conformant_content_get()
22710 * @ingroup Conformant
22712 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22715 * Get the content of the conformant widget.
22717 * @param obj The conformant object.
22718 * @return The content that is being used.
22720 * Return the content object which is set for this widget.
22721 * It won't be unparent from conformant. For that, use
22722 * elm_conformant_content_unset().
22724 * @see elm_conformant_content_set() for more details.
22725 * @see elm_conformant_content_unset()
22727 * @ingroup Conformant
22729 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22732 * Unset the content of the conformant widget.
22734 * @param obj The conformant object.
22735 * @return The content that was being used.
22737 * Unparent and return the content object which was set for this widget.
22739 * @see elm_conformant_content_set() for more details.
22741 * @ingroup Conformant
22743 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22746 * Returns the Evas_Object that represents the content area.
22748 * @param obj The conformant object.
22749 * @return The content area of the widget.
22751 * @ingroup Conformant
22753 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22760 * @defgroup Mapbuf Mapbuf
22761 * @ingroup Elementary
22763 * @image html img/widget/mapbuf/preview-00.png
22764 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22766 * This holds one content object and uses an Evas Map of transformation
22767 * points to be later used with this content. So the content will be
22768 * moved, resized, etc as a single image. So it will improve performance
22769 * when you have a complex interafce, with a lot of elements, and will
22770 * need to resize or move it frequently (the content object and its
22773 * See how to use this widget in this example:
22774 * @ref mapbuf_example
22778 * @addtogroup Mapbuf
22783 * Add a new mapbuf widget to the given parent Elementary
22784 * (container) object.
22786 * @param parent The parent object.
22787 * @return A new mapbuf widget handle or @c NULL, on errors.
22789 * This function inserts a new mapbuf widget on the canvas.
22793 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22796 * Set the content of the mapbuf.
22798 * @param obj The mapbuf object.
22799 * @param content The content that will be filled in this mapbuf object.
22801 * Once the content object is set, a previously set one will be deleted.
22802 * If you want to keep that old content object, use the
22803 * elm_mapbuf_content_unset() function.
22805 * To enable map, elm_mapbuf_enabled_set() should be used.
22809 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22812 * Get the content of the mapbuf.
22814 * @param obj The mapbuf object.
22815 * @return The content that is being used.
22817 * Return the content object which is set for this widget.
22819 * @see elm_mapbuf_content_set() for details.
22823 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22826 * Unset the content of the mapbuf.
22828 * @param obj The mapbuf object.
22829 * @return The content that was being used.
22831 * Unparent and return the content object which was set for this widget.
22833 * @see elm_mapbuf_content_set() for details.
22837 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22840 * Enable or disable the map.
22842 * @param obj The mapbuf object.
22843 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22845 * This enables the map that is set or disables it. On enable, the object
22846 * geometry will be saved, and the new geometry will change (position and
22847 * size) to reflect the map geometry set.
22849 * Also, when enabled, alpha and smooth states will be used, so if the
22850 * content isn't solid, alpha should be enabled, for example, otherwise
22851 * a black retangle will fill the content.
22853 * When disabled, the stored map will be freed and geometry prior to
22854 * enabling the map will be restored.
22856 * It's disabled by default.
22858 * @see elm_mapbuf_alpha_set()
22859 * @see elm_mapbuf_smooth_set()
22863 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22866 * Get a value whether map is enabled or not.
22868 * @param obj The mapbuf object.
22869 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22870 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22872 * @see elm_mapbuf_enabled_set() for details.
22876 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22879 * Enable or disable smooth map rendering.
22881 * @param obj The mapbuf object.
22882 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22885 * This sets smoothing for map rendering. If the object is a type that has
22886 * its own smoothing settings, then both the smooth settings for this object
22887 * and the map must be turned off.
22889 * By default smooth maps are enabled.
22893 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22896 * Get a value whether smooth map rendering is enabled or not.
22898 * @param obj The mapbuf object.
22899 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
22900 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22902 * @see elm_mapbuf_smooth_set() for details.
22906 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22909 * Set or unset alpha flag for map rendering.
22911 * @param obj The mapbuf object.
22912 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
22915 * This sets alpha flag for map rendering. If the object is a type that has
22916 * its own alpha settings, then this will take precedence. Only image objects
22917 * have this currently. It stops alpha blending of the map area, and is
22918 * useful if you know the object and/or all sub-objects is 100% solid.
22920 * Alpha is enabled by default.
22924 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
22927 * Get a value whether alpha blending is enabled or not.
22929 * @param obj The mapbuf object.
22930 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
22931 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22933 * @see elm_mapbuf_alpha_set() for details.
22937 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22944 * @defgroup Flipselector Flip Selector
22946 * @image html img/widget/flipselector/preview-00.png
22947 * @image latex img/widget/flipselector/preview-00.eps
22949 * A flip selector is a widget to show a set of @b text items, one
22950 * at a time, with the same sheet switching style as the @ref Clock
22951 * "clock" widget, when one changes the current displaying sheet
22952 * (thus, the "flip" in the name).
22954 * User clicks to flip sheets which are @b held for some time will
22955 * make the flip selector to flip continuosly and automatically for
22956 * the user. The interval between flips will keep growing in time,
22957 * so that it helps the user to reach an item which is distant from
22958 * the current selection.
22960 * Smart callbacks one can register to:
22961 * - @c "selected" - when the widget's selected text item is changed
22962 * - @c "overflowed" - when the widget's current selection is changed
22963 * from the first item in its list to the last
22964 * - @c "underflowed" - when the widget's current selection is changed
22965 * from the last item in its list to the first
22967 * Available styles for it:
22970 * Here is an example on its usage:
22971 * @li @ref flipselector_example
22975 * @addtogroup Flipselector
22979 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
22982 * Add a new flip selector widget to the given parent Elementary
22983 * (container) widget
22985 * @param parent The parent object
22986 * @return a new flip selector widget handle or @c NULL, on errors
22988 * This function inserts a new flip selector widget on the canvas.
22990 * @ingroup Flipselector
22992 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22995 * Programmatically select the next item of a flip selector widget
22997 * @param obj The flipselector object
22999 * @note The selection will be animated. Also, if it reaches the
23000 * end of its list of member items, it will continue with the first
23003 * @ingroup Flipselector
23005 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23008 * Programmatically select the previous item of a flip selector
23011 * @param obj The flipselector object
23013 * @note The selection will be animated. Also, if it reaches the
23014 * beginning of its list of member items, it will continue with the
23015 * last one backwards.
23017 * @ingroup Flipselector
23019 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23022 * Append a (text) item to a flip selector widget
23024 * @param obj The flipselector object
23025 * @param label The (text) label of the new item
23026 * @param func Convenience callback function to take place when
23028 * @param data Data passed to @p func, above
23029 * @return A handle to the item added or @c NULL, on errors
23031 * The widget's list of labels to show will be appended with the
23032 * given value. If the user wishes so, a callback function pointer
23033 * can be passed, which will get called when this same item is
23036 * @note The current selection @b won't be modified by appending an
23037 * element to the list.
23039 * @note The maximum length of the text label is going to be
23040 * determined <b>by the widget's theme</b>. Strings larger than
23041 * that value are going to be @b truncated.
23043 * @ingroup Flipselector
23045 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23048 * Prepend a (text) item to a flip selector widget
23050 * @param obj The flipselector object
23051 * @param label The (text) label of the new item
23052 * @param func Convenience callback function to take place when
23054 * @param data Data passed to @p func, above
23055 * @return A handle to the item added or @c NULL, on errors
23057 * The widget's list of labels to show will be prepended with the
23058 * given value. If the user wishes so, a callback function pointer
23059 * can be passed, which will get called when this same item is
23062 * @note The current selection @b won't be modified by prepending
23063 * an element to the list.
23065 * @note The maximum length of the text label is going to be
23066 * determined <b>by the widget's theme</b>. Strings larger than
23067 * that value are going to be @b truncated.
23069 * @ingroup Flipselector
23071 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23074 * Get the internal list of items in a given flip selector widget.
23076 * @param obj The flipselector object
23077 * @return The list of items (#Elm_Flipselector_Item as data) or
23078 * @c NULL on errors.
23080 * This list is @b not to be modified in any way and must not be
23081 * freed. Use the list members with functions like
23082 * elm_flipselector_item_label_set(),
23083 * elm_flipselector_item_label_get(),
23084 * elm_flipselector_item_del(),
23085 * elm_flipselector_item_selected_get(),
23086 * elm_flipselector_item_selected_set().
23088 * @warning This list is only valid until @p obj object's internal
23089 * items list is changed. It should be fetched again with another
23090 * call to this function when changes happen.
23092 * @ingroup Flipselector
23094 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23097 * Get the first item in the given flip selector widget's list of
23100 * @param obj The flipselector object
23101 * @return The first item or @c NULL, if it has no items (and on
23104 * @see elm_flipselector_item_append()
23105 * @see elm_flipselector_last_item_get()
23107 * @ingroup Flipselector
23109 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23112 * Get the last item in the given flip selector widget's list of
23115 * @param obj The flipselector object
23116 * @return The last item or @c NULL, if it has no items (and on
23119 * @see elm_flipselector_item_prepend()
23120 * @see elm_flipselector_first_item_get()
23122 * @ingroup Flipselector
23124 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23127 * Get the currently selected item in a flip selector widget.
23129 * @param obj The flipselector object
23130 * @return The selected item or @c NULL, if the widget has no items
23133 * @ingroup Flipselector
23135 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23138 * Set whether a given flip selector widget's item should be the
23139 * currently selected one.
23141 * @param item The flip selector item
23142 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23144 * This sets whether @p item is or not the selected (thus, under
23145 * display) one. If @p item is different than one under display,
23146 * the latter will be unselected. If the @p item is set to be
23147 * unselected, on the other hand, the @b first item in the widget's
23148 * internal members list will be the new selected one.
23150 * @see elm_flipselector_item_selected_get()
23152 * @ingroup Flipselector
23154 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23157 * Get whether a given flip selector widget's item is the currently
23160 * @param item The flip selector item
23161 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23164 * @see elm_flipselector_item_selected_set()
23166 * @ingroup Flipselector
23168 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23171 * Delete a given item from a flip selector widget.
23173 * @param item The item to delete
23175 * @ingroup Flipselector
23177 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23180 * Get the label of a given flip selector widget's item.
23182 * @param item The item to get label from
23183 * @return The text label of @p item or @c NULL, on errors
23185 * @see elm_flipselector_item_label_set()
23187 * @ingroup Flipselector
23189 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23192 * Set the label of a given flip selector widget's item.
23194 * @param item The item to set label on
23195 * @param label The text label string, in UTF-8 encoding
23197 * @see elm_flipselector_item_label_get()
23199 * @ingroup Flipselector
23201 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23204 * Gets the item before @p item in a flip selector widget's
23205 * internal list of items.
23207 * @param item The item to fetch previous from
23208 * @return The item before the @p item, in its parent's list. If
23209 * there is no previous item for @p item or there's an
23210 * error, @c NULL is returned.
23212 * @see elm_flipselector_item_next_get()
23214 * @ingroup Flipselector
23216 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23219 * Gets the item after @p item in a flip selector widget's
23220 * internal list of items.
23222 * @param item The item to fetch next from
23223 * @return The item after the @p item, in its parent's list. If
23224 * there is no next item for @p item or there's an
23225 * error, @c NULL is returned.
23227 * @see elm_flipselector_item_next_get()
23229 * @ingroup Flipselector
23231 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23234 * Set the interval on time updates for an user mouse button hold
23235 * on a flip selector widget.
23237 * @param obj The flip selector object
23238 * @param interval The (first) interval value in seconds
23240 * This interval value is @b decreased while the user holds the
23241 * mouse pointer either flipping up or flipping doww a given flip
23244 * This helps the user to get to a given item distant from the
23245 * current one easier/faster, as it will start to flip quicker and
23246 * quicker on mouse button holds.
23248 * The calculation for the next flip interval value, starting from
23249 * the one set with this call, is the previous interval divided by
23250 * 1.05, so it decreases a little bit.
23252 * The default starting interval value for automatic flips is
23255 * @see elm_flipselector_interval_get()
23257 * @ingroup Flipselector
23259 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23262 * Get the interval on time updates for an user mouse button hold
23263 * on a flip selector widget.
23265 * @param obj The flip selector object
23266 * @return The (first) interval value, in seconds, set on it
23268 * @see elm_flipselector_interval_set() for more details
23270 * @ingroup Flipselector
23272 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23278 * @addtogroup Calendar
23283 * @enum _Elm_Calendar_Mark_Repeat
23284 * @typedef Elm_Calendar_Mark_Repeat
23286 * Event periodicity, used to define if a mark should be repeated
23287 * @b beyond event's day. It's set when a mark is added.
23289 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23290 * there will be marks every week after this date. Marks will be displayed
23291 * at 13th, 20th, 27th, 3rd June ...
23293 * Values don't work as bitmask, only one can be choosen.
23295 * @see elm_calendar_mark_add()
23297 * @ingroup Calendar
23299 typedef enum _Elm_Calendar_Mark_Repeat
23301 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23302 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23303 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23304 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*/
23305 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. */
23306 } Elm_Calendar_Mark_Repeat;
23308 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(). */
23311 * Add a new calendar widget to the given parent Elementary
23312 * (container) object.
23314 * @param parent The parent object.
23315 * @return a new calendar widget handle or @c NULL, on errors.
23317 * This function inserts a new calendar widget on the canvas.
23319 * @ref calendar_example_01
23321 * @ingroup Calendar
23323 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23326 * Get weekdays names displayed by the calendar.
23328 * @param obj The calendar object.
23329 * @return Array of seven strings to be used as weekday names.
23331 * By default, weekdays abbreviations get from system are displayed:
23332 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23333 * The first string is related to Sunday, the second to Monday...
23335 * @see elm_calendar_weekdays_name_set()
23337 * @ref calendar_example_05
23339 * @ingroup Calendar
23341 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23344 * Set weekdays names to be displayed by the calendar.
23346 * @param obj The calendar object.
23347 * @param weekdays Array of seven strings to be used as weekday names.
23348 * @warning It must have 7 elements, or it will access invalid memory.
23349 * @warning The strings must be NULL terminated ('@\0').
23351 * By default, weekdays abbreviations get from system are displayed:
23352 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23354 * The first string should be related to Sunday, the second to Monday...
23356 * The usage should be like this:
23358 * const char *weekdays[] =
23360 * "Sunday", "Monday", "Tuesday", "Wednesday",
23361 * "Thursday", "Friday", "Saturday"
23363 * elm_calendar_weekdays_names_set(calendar, weekdays);
23366 * @see elm_calendar_weekdays_name_get()
23368 * @ref calendar_example_02
23370 * @ingroup Calendar
23372 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23375 * Set the minimum and maximum values for the year
23377 * @param obj The calendar object
23378 * @param min The minimum year, greater than 1901;
23379 * @param max The maximum year;
23381 * Maximum must be greater than minimum, except if you don't wan't to set
23383 * Default values are 1902 and -1.
23385 * If the maximum year is a negative value, it will be limited depending
23386 * on the platform architecture (year 2037 for 32 bits);
23388 * @see elm_calendar_min_max_year_get()
23390 * @ref calendar_example_03
23392 * @ingroup Calendar
23394 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23397 * Get the minimum and maximum values for the year
23399 * @param obj The calendar object.
23400 * @param min The minimum year.
23401 * @param max The maximum year.
23403 * Default values are 1902 and -1.
23405 * @see elm_calendar_min_max_year_get() for more details.
23407 * @ref calendar_example_05
23409 * @ingroup Calendar
23411 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23414 * Enable or disable day selection
23416 * @param obj The calendar object.
23417 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23420 * Enabled by default. If disabled, the user still can select months,
23421 * but not days. Selected days are highlighted on calendar.
23422 * It should be used if you won't need such selection for the widget usage.
23424 * When a day is selected, or month is changed, smart callbacks for
23425 * signal "changed" will be called.
23427 * @see elm_calendar_day_selection_enable_get()
23429 * @ref calendar_example_04
23431 * @ingroup Calendar
23433 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23436 * Get a value whether day selection is enabled or not.
23438 * @see elm_calendar_day_selection_enable_set() for details.
23440 * @param obj The calendar object.
23441 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23442 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23444 * @ref calendar_example_05
23446 * @ingroup Calendar
23448 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23452 * Set selected date to be highlighted on calendar.
23454 * @param obj The calendar object.
23455 * @param selected_time A @b tm struct to represent the selected date.
23457 * Set the selected date, changing the displayed month if needed.
23458 * Selected date changes when the user goes to next/previous month or
23459 * select a day pressing over it on calendar.
23461 * @see elm_calendar_selected_time_get()
23463 * @ref calendar_example_04
23465 * @ingroup Calendar
23467 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23470 * Get selected date.
23472 * @param obj The calendar object
23473 * @param selected_time A @b tm struct to point to selected date
23474 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23477 * Get date selected by the user or set by function
23478 * elm_calendar_selected_time_set().
23479 * Selected date changes when the user goes to next/previous month or
23480 * select a day pressing over it on calendar.
23482 * @see elm_calendar_selected_time_get()
23484 * @ref calendar_example_05
23486 * @ingroup Calendar
23488 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23491 * Set a function to format the string that will be used to display
23494 * @param obj The calendar object
23495 * @param format_function Function to set the month-year string given
23496 * the selected date
23498 * By default it uses strftime with "%B %Y" format string.
23499 * It should allocate the memory that will be used by the string,
23500 * that will be freed by the widget after usage.
23501 * A pointer to the string and a pointer to the time struct will be provided.
23506 * _format_month_year(struct tm *selected_time)
23509 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23510 * return strdup(buf);
23513 * elm_calendar_format_function_set(calendar, _format_month_year);
23516 * @ref calendar_example_02
23518 * @ingroup Calendar
23520 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23523 * Add a new mark to the calendar
23525 * @param obj The calendar object
23526 * @param mark_type A string used to define the type of mark. It will be
23527 * emitted to the theme, that should display a related modification on these
23528 * days representation.
23529 * @param mark_time A time struct to represent the date of inclusion of the
23530 * mark. For marks that repeats it will just be displayed after the inclusion
23531 * date in the calendar.
23532 * @param repeat Repeat the event following this periodicity. Can be a unique
23533 * mark (that don't repeat), daily, weekly, monthly or annually.
23534 * @return The created mark or @p NULL upon failure.
23536 * Add a mark that will be drawn in the calendar respecting the insertion
23537 * time and periodicity. It will emit the type as signal to the widget theme.
23538 * Default theme supports "holiday" and "checked", but it can be extended.
23540 * It won't immediately update the calendar, drawing the marks.
23541 * For this, call elm_calendar_marks_draw(). However, when user selects
23542 * next or previous month calendar forces marks drawn.
23544 * Marks created with this method can be deleted with
23545 * elm_calendar_mark_del().
23549 * struct tm selected_time;
23550 * time_t current_time;
23552 * current_time = time(NULL) + 5 * 84600;
23553 * localtime_r(¤t_time, &selected_time);
23554 * elm_calendar_mark_add(cal, "holiday", selected_time,
23555 * ELM_CALENDAR_ANNUALLY);
23557 * current_time = time(NULL) + 1 * 84600;
23558 * localtime_r(¤t_time, &selected_time);
23559 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23561 * elm_calendar_marks_draw(cal);
23564 * @see elm_calendar_marks_draw()
23565 * @see elm_calendar_mark_del()
23567 * @ref calendar_example_06
23569 * @ingroup Calendar
23571 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);
23574 * Delete mark from the calendar.
23576 * @param mark The mark to be deleted.
23578 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23579 * should be used instead of getting marks list and deleting each one.
23581 * @see elm_calendar_mark_add()
23583 * @ref calendar_example_06
23585 * @ingroup Calendar
23587 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23590 * Remove all calendar's marks
23592 * @param obj The calendar object.
23594 * @see elm_calendar_mark_add()
23595 * @see elm_calendar_mark_del()
23597 * @ingroup Calendar
23599 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23603 * Get a list of all the calendar marks.
23605 * @param obj The calendar object.
23606 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23608 * @see elm_calendar_mark_add()
23609 * @see elm_calendar_mark_del()
23610 * @see elm_calendar_marks_clear()
23612 * @ingroup Calendar
23614 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23617 * Draw calendar marks.
23619 * @param obj The calendar object.
23621 * Should be used after adding, removing or clearing marks.
23622 * It will go through the entire marks list updating the calendar.
23623 * If lots of marks will be added, add all the marks and then call
23626 * When the month is changed, i.e. user selects next or previous month,
23627 * marks will be drawed.
23629 * @see elm_calendar_mark_add()
23630 * @see elm_calendar_mark_del()
23631 * @see elm_calendar_marks_clear()
23633 * @ref calendar_example_06
23635 * @ingroup Calendar
23637 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23640 * Set a day text color to the same that represents Saturdays.
23642 * @param obj The calendar object.
23643 * @param pos The text position. Position is the cell counter, from left
23644 * to right, up to down. It starts on 0 and ends on 41.
23646 * @deprecated use elm_calendar_mark_add() instead like:
23649 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23650 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23653 * @see elm_calendar_mark_add()
23655 * @ingroup Calendar
23657 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23660 * Set a day text color to the same that represents Sundays.
23662 * @param obj The calendar object.
23663 * @param pos The text position. Position is the cell counter, from left
23664 * to right, up to down. It starts on 0 and ends on 41.
23666 * @deprecated use elm_calendar_mark_add() instead like:
23669 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23670 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23673 * @see elm_calendar_mark_add()
23675 * @ingroup Calendar
23677 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23680 * Set a day text color to the same that represents Weekdays.
23682 * @param obj The calendar object
23683 * @param pos The text position. Position is the cell counter, from left
23684 * to right, up to down. It starts on 0 and ends on 41.
23686 * @deprecated use elm_calendar_mark_add() instead like:
23689 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23691 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23692 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23693 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23694 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23695 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23696 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23697 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23698 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23699 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23702 * @see elm_calendar_mark_add()
23704 * @ingroup Calendar
23706 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23709 * Set the interval on time updates for an user mouse button hold
23710 * on calendar widgets' month selection.
23712 * @param obj The calendar object
23713 * @param interval The (first) interval value in seconds
23715 * This interval value is @b decreased while the user holds the
23716 * mouse pointer either selecting next or previous month.
23718 * This helps the user to get to a given month distant from the
23719 * current one easier/faster, as it will start to change quicker and
23720 * quicker on mouse button holds.
23722 * The calculation for the next change interval value, starting from
23723 * the one set with this call, is the previous interval divided by
23724 * 1.05, so it decreases a little bit.
23726 * The default starting interval value for automatic changes is
23729 * @see elm_calendar_interval_get()
23731 * @ingroup Calendar
23733 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23736 * Get the interval on time updates for an user mouse button hold
23737 * on calendar widgets' month selection.
23739 * @param obj The calendar object
23740 * @return The (first) interval value, in seconds, set on it
23742 * @see elm_calendar_interval_set() for more details
23744 * @ingroup Calendar
23746 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23753 * @defgroup Diskselector Diskselector
23754 * @ingroup Elementary
23756 * @image html img/widget/diskselector/preview-00.png
23757 * @image latex img/widget/diskselector/preview-00.eps
23759 * A diskselector is a kind of list widget. It scrolls horizontally,
23760 * and can contain label and icon objects. Three items are displayed
23761 * with the selected one in the middle.
23763 * It can act like a circular list with round mode and labels can be
23764 * reduced for a defined length for side items.
23766 * Smart callbacks one can listen to:
23767 * - "selected" - when item is selected, i.e. scroller stops.
23769 * Available styles for it:
23772 * List of examples:
23773 * @li @ref diskselector_example_01
23774 * @li @ref diskselector_example_02
23778 * @addtogroup Diskselector
23782 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(). */
23785 * Add a new diskselector widget to the given parent Elementary
23786 * (container) object.
23788 * @param parent The parent object.
23789 * @return a new diskselector widget handle or @c NULL, on errors.
23791 * This function inserts a new diskselector widget on the canvas.
23793 * @ingroup Diskselector
23795 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23798 * Enable or disable round mode.
23800 * @param obj The diskselector object.
23801 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23804 * Disabled by default. If round mode is enabled the items list will
23805 * work like a circle list, so when the user reaches the last item,
23806 * the first one will popup.
23808 * @see elm_diskselector_round_get()
23810 * @ingroup Diskselector
23812 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23815 * Get a value whether round mode is enabled or not.
23817 * @see elm_diskselector_round_set() for details.
23819 * @param obj The diskselector object.
23820 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23821 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23823 * @ingroup Diskselector
23825 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23828 * Get the side labels max length.
23830 * @deprecated use elm_diskselector_side_label_length_get() instead:
23832 * @param obj The diskselector object.
23833 * @return The max length defined for side labels, or 0 if not a valid
23836 * @ingroup Diskselector
23838 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23841 * Set the side labels max length.
23843 * @deprecated use elm_diskselector_side_label_length_set() instead:
23845 * @param obj The diskselector object.
23846 * @param len The max length defined for side labels.
23848 * @ingroup Diskselector
23850 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23853 * Get the side labels max length.
23855 * @see elm_diskselector_side_label_length_set() for details.
23857 * @param obj The diskselector object.
23858 * @return The max length defined for side labels, or 0 if not a valid
23861 * @ingroup Diskselector
23863 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23866 * Set the side labels max length.
23868 * @param obj The diskselector object.
23869 * @param len The max length defined for side labels.
23871 * Length is the number of characters of items' label that will be
23872 * visible when it's set on side positions. It will just crop
23873 * the string after defined size. E.g.:
23875 * An item with label "January" would be displayed on side position as
23876 * "Jan" if max length is set to 3, or "Janu", if this property
23879 * When it's selected, the entire label will be displayed, except for
23880 * width restrictions. In this case label will be cropped and "..."
23881 * will be concatenated.
23883 * Default side label max length is 3.
23885 * This property will be applyed over all items, included before or
23886 * later this function call.
23888 * @ingroup Diskselector
23890 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23893 * Set the number of items to be displayed.
23895 * @param obj The diskselector object.
23896 * @param num The number of items the diskselector will display.
23898 * Default value is 3, and also it's the minimun. If @p num is less
23899 * than 3, it will be set to 3.
23901 * Also, it can be set on theme, using data item @c display_item_num
23902 * on group "elm/diskselector/item/X", where X is style set.
23905 * group { name: "elm/diskselector/item/X";
23907 * item: "display_item_num" "5";
23910 * @ingroup Diskselector
23912 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
23915 * Set bouncing behaviour when the scrolled content reaches an edge.
23917 * Tell the internal scroller object whether it should bounce or not
23918 * when it reaches the respective edges for each axis.
23920 * @param obj The diskselector object.
23921 * @param h_bounce Whether to bounce or not in the horizontal axis.
23922 * @param v_bounce Whether to bounce or not in the vertical axis.
23924 * @see elm_scroller_bounce_set()
23926 * @ingroup Diskselector
23928 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23931 * Get the bouncing behaviour of the internal scroller.
23933 * Get whether the internal scroller should bounce when the edge of each
23934 * axis is reached scrolling.
23936 * @param obj The diskselector object.
23937 * @param h_bounce Pointer where to store the bounce state of the horizontal
23939 * @param v_bounce Pointer where to store the bounce state of the vertical
23942 * @see elm_scroller_bounce_get()
23943 * @see elm_diskselector_bounce_set()
23945 * @ingroup Diskselector
23947 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23950 * Get the scrollbar policy.
23952 * @see elm_diskselector_scroller_policy_get() for details.
23954 * @param obj The diskselector object.
23955 * @param policy_h Pointer where to store horizontal scrollbar policy.
23956 * @param policy_v Pointer where to store vertical scrollbar policy.
23958 * @ingroup Diskselector
23960 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);
23963 * Set the scrollbar policy.
23965 * @param obj The diskselector object.
23966 * @param policy_h Horizontal scrollbar policy.
23967 * @param policy_v Vertical scrollbar policy.
23969 * This sets the scrollbar visibility policy for the given scroller.
23970 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
23971 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
23972 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
23973 * This applies respectively for the horizontal and vertical scrollbars.
23975 * The both are disabled by default, i.e., are set to
23976 * #ELM_SCROLLER_POLICY_OFF.
23978 * @ingroup Diskselector
23980 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
23983 * Remove all diskselector's items.
23985 * @param obj The diskselector object.
23987 * @see elm_diskselector_item_del()
23988 * @see elm_diskselector_item_append()
23990 * @ingroup Diskselector
23992 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23995 * Get a list of all the diskselector items.
23997 * @param obj The diskselector object.
23998 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
23999 * or @c NULL on failure.
24001 * @see elm_diskselector_item_append()
24002 * @see elm_diskselector_item_del()
24003 * @see elm_diskselector_clear()
24005 * @ingroup Diskselector
24007 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24010 * Appends a new item to the diskselector object.
24012 * @param obj The diskselector object.
24013 * @param label The label of the diskselector item.
24014 * @param icon The icon object to use at left side of the item. An
24015 * icon can be any Evas object, but usually it is an icon created
24016 * with elm_icon_add().
24017 * @param func The function to call when the item is selected.
24018 * @param data The data to associate with the item for related callbacks.
24020 * @return The created item or @c NULL upon failure.
24022 * A new item will be created and appended to the diskselector, i.e., will
24023 * be set as last item. Also, if there is no selected item, it will
24024 * be selected. This will always happens for the first appended item.
24026 * If no icon is set, label will be centered on item position, otherwise
24027 * the icon will be placed at left of the label, that will be shifted
24030 * Items created with this method can be deleted with
24031 * elm_diskselector_item_del().
24033 * Associated @p data can be properly freed when item is deleted if a
24034 * callback function is set with elm_diskselector_item_del_cb_set().
24036 * If a function is passed as argument, it will be called everytime this item
24037 * is selected, i.e., the user stops the diskselector with this
24038 * item on center position. If such function isn't needed, just passing
24039 * @c NULL as @p func is enough. The same should be done for @p data.
24041 * Simple example (with no function callback or data associated):
24043 * disk = elm_diskselector_add(win);
24044 * ic = elm_icon_add(win);
24045 * elm_icon_file_set(ic, "path/to/image", NULL);
24046 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24047 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24050 * @see elm_diskselector_item_del()
24051 * @see elm_diskselector_item_del_cb_set()
24052 * @see elm_diskselector_clear()
24053 * @see elm_icon_add()
24055 * @ingroup Diskselector
24057 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);
24061 * Delete them item from the diskselector.
24063 * @param it The item of diskselector to be deleted.
24065 * If deleting all diskselector items is required, elm_diskselector_clear()
24066 * should be used instead of getting items list and deleting each one.
24068 * @see elm_diskselector_clear()
24069 * @see elm_diskselector_item_append()
24070 * @see elm_diskselector_item_del_cb_set()
24072 * @ingroup Diskselector
24074 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24077 * Set the function called when a diskselector item is freed.
24079 * @param it The item to set the callback on
24080 * @param func The function called
24082 * If there is a @p func, then it will be called prior item's memory release.
24083 * That will be called with the following arguments:
24085 * @li item's Evas object;
24088 * This way, a data associated to a diskselector item could be properly
24091 * @ingroup Diskselector
24093 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24096 * Get the data associated to the item.
24098 * @param it The diskselector item
24099 * @return The data associated to @p it
24101 * The return value is a pointer to data associated to @p item when it was
24102 * created, with function elm_diskselector_item_append(). If no data
24103 * was passed as argument, it will return @c NULL.
24105 * @see elm_diskselector_item_append()
24107 * @ingroup Diskselector
24109 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24112 * Set the icon associated to the item.
24114 * @param it The diskselector item
24115 * @param icon The icon object to associate with @p it
24117 * The icon object to use at left side of the item. An
24118 * icon can be any Evas object, but usually it is an icon created
24119 * with elm_icon_add().
24121 * Once the icon object is set, a previously set one will be deleted.
24122 * @warning Setting the same icon for two items will cause the icon to
24123 * dissapear from the first item.
24125 * If an icon was passed as argument on item creation, with function
24126 * elm_diskselector_item_append(), it will be already
24127 * associated to the item.
24129 * @see elm_diskselector_item_append()
24130 * @see elm_diskselector_item_icon_get()
24132 * @ingroup Diskselector
24134 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24137 * Get the icon associated to the item.
24139 * @param it The diskselector item
24140 * @return The icon associated to @p it
24142 * The return value is a pointer to the icon associated to @p item when it was
24143 * created, with function elm_diskselector_item_append(), or later
24144 * with function elm_diskselector_item_icon_set. If no icon
24145 * was passed as argument, it will return @c NULL.
24147 * @see elm_diskselector_item_append()
24148 * @see elm_diskselector_item_icon_set()
24150 * @ingroup Diskselector
24152 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24155 * Set the label of item.
24157 * @param it The item of diskselector.
24158 * @param label The label of item.
24160 * The label to be displayed by the item.
24162 * If no icon is set, label will be centered on item position, otherwise
24163 * the icon will be placed at left of the label, that will be shifted
24166 * An item with label "January" would be displayed on side position as
24167 * "Jan" if max length is set to 3 with function
24168 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24171 * When this @p item is selected, the entire label will be displayed,
24172 * except for width restrictions.
24173 * In this case label will be cropped and "..." will be concatenated,
24174 * but only for display purposes. It will keep the entire string, so
24175 * if diskselector is resized the remaining characters will be displayed.
24177 * If a label was passed as argument on item creation, with function
24178 * elm_diskselector_item_append(), it will be already
24179 * displayed by the item.
24181 * @see elm_diskselector_side_label_lenght_set()
24182 * @see elm_diskselector_item_label_get()
24183 * @see elm_diskselector_item_append()
24185 * @ingroup Diskselector
24187 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24190 * Get the label of item.
24192 * @param it The item of diskselector.
24193 * @return The label of item.
24195 * The return value is a pointer to the label associated to @p item when it was
24196 * created, with function elm_diskselector_item_append(), or later
24197 * with function elm_diskselector_item_label_set. If no label
24198 * was passed as argument, it will return @c NULL.
24200 * @see elm_diskselector_item_label_set() for more details.
24201 * @see elm_diskselector_item_append()
24203 * @ingroup Diskselector
24205 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24208 * Get the selected item.
24210 * @param obj The diskselector object.
24211 * @return The selected diskselector item.
24213 * The selected item can be unselected with function
24214 * elm_diskselector_item_selected_set(), and the first item of
24215 * diskselector will be selected.
24217 * The selected item always will be centered on diskselector, with
24218 * full label displayed, i.e., max lenght set to side labels won't
24219 * apply on the selected item. More details on
24220 * elm_diskselector_side_label_length_set().
24222 * @ingroup Diskselector
24224 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24227 * Set the selected state of an item.
24229 * @param it The diskselector item
24230 * @param selected The selected state
24232 * This sets the selected state of the given item @p it.
24233 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24235 * If a new item is selected the previosly selected will be unselected.
24236 * Previoulsy selected item can be get with function
24237 * elm_diskselector_selected_item_get().
24239 * If the item @p it is unselected, the first item of diskselector will
24242 * Selected items will be visible on center position of diskselector.
24243 * So if it was on another position before selected, or was invisible,
24244 * diskselector will animate items until the selected item reaches center
24247 * @see elm_diskselector_item_selected_get()
24248 * @see elm_diskselector_selected_item_get()
24250 * @ingroup Diskselector
24252 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24255 * Get whether the @p item is selected or not.
24257 * @param it The diskselector item.
24258 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24259 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24261 * @see elm_diskselector_selected_item_set() for details.
24262 * @see elm_diskselector_item_selected_get()
24264 * @ingroup Diskselector
24266 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24269 * Get the first item of the diskselector.
24271 * @param obj The diskselector object.
24272 * @return The first item, or @c NULL if none.
24274 * The list of items follows append order. So it will return the first
24275 * item appended to the widget that wasn't deleted.
24277 * @see elm_diskselector_item_append()
24278 * @see elm_diskselector_items_get()
24280 * @ingroup Diskselector
24282 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24285 * Get the last item of the diskselector.
24287 * @param obj The diskselector object.
24288 * @return The last item, or @c NULL if none.
24290 * The list of items follows append order. So it will return last first
24291 * item appended to the widget that wasn't deleted.
24293 * @see elm_diskselector_item_append()
24294 * @see elm_diskselector_items_get()
24296 * @ingroup Diskselector
24298 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24301 * Get the item before @p item in diskselector.
24303 * @param it The diskselector item.
24304 * @return The item before @p item, or @c NULL if none or on failure.
24306 * The list of items follows append order. So it will return item appended
24307 * just before @p item and that wasn't deleted.
24309 * If it is the first item, @c NULL will be returned.
24310 * First item can be get by elm_diskselector_first_item_get().
24312 * @see elm_diskselector_item_append()
24313 * @see elm_diskselector_items_get()
24315 * @ingroup Diskselector
24317 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24320 * Get the item after @p item in diskselector.
24322 * @param it The diskselector item.
24323 * @return The item after @p item, or @c NULL if none or on failure.
24325 * The list of items follows append order. So it will return item appended
24326 * just after @p item and that wasn't deleted.
24328 * If it is the last item, @c NULL will be returned.
24329 * Last item can be get by elm_diskselector_last_item_get().
24331 * @see elm_diskselector_item_append()
24332 * @see elm_diskselector_items_get()
24334 * @ingroup Diskselector
24336 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24339 * Set the text to be shown in the diskselector item.
24341 * @param item Target item
24342 * @param text The text to set in the content
24344 * Setup the text as tooltip to object. The item can have only one tooltip,
24345 * so any previous tooltip data is removed.
24347 * @see elm_object_tooltip_text_set() for more details.
24349 * @ingroup Diskselector
24351 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24354 * Set the content to be shown in the tooltip item.
24356 * Setup the tooltip to item. The item can have only one tooltip,
24357 * so any previous tooltip data is removed. @p func(with @p data) will
24358 * be called every time that need show the tooltip and it should
24359 * return a valid Evas_Object. This object is then managed fully by
24360 * tooltip system and is deleted when the tooltip is gone.
24362 * @param item the diskselector item being attached a tooltip.
24363 * @param func the function used to create the tooltip contents.
24364 * @param data what to provide to @a func as callback data/context.
24365 * @param del_cb called when data is not needed anymore, either when
24366 * another callback replaces @p func, the tooltip is unset with
24367 * elm_diskselector_item_tooltip_unset() or the owner @a item
24368 * dies. This callback receives as the first parameter the
24369 * given @a data, and @c event_info is the item.
24371 * @see elm_object_tooltip_content_cb_set() for more details.
24373 * @ingroup Diskselector
24375 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);
24378 * Unset tooltip from item.
24380 * @param item diskselector item to remove previously set tooltip.
24382 * Remove tooltip from item. The callback provided as del_cb to
24383 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24384 * it is not used anymore.
24386 * @see elm_object_tooltip_unset() for more details.
24387 * @see elm_diskselector_item_tooltip_content_cb_set()
24389 * @ingroup Diskselector
24391 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24395 * Sets a different style for this item tooltip.
24397 * @note before you set a style you should define a tooltip with
24398 * elm_diskselector_item_tooltip_content_cb_set() or
24399 * elm_diskselector_item_tooltip_text_set()
24401 * @param item diskselector item with tooltip already set.
24402 * @param style the theme style to use (default, transparent, ...)
24404 * @see elm_object_tooltip_style_set() for more details.
24406 * @ingroup Diskselector
24408 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24411 * Get the style for this item tooltip.
24413 * @param item diskselector item with tooltip already set.
24414 * @return style the theme style in use, defaults to "default". If the
24415 * object does not have a tooltip set, then NULL is returned.
24417 * @see elm_object_tooltip_style_get() for more details.
24418 * @see elm_diskselector_item_tooltip_style_set()
24420 * @ingroup Diskselector
24422 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24425 * Set the cursor to be shown when mouse is over the diskselector item
24427 * @param item Target item
24428 * @param cursor the cursor name to be used.
24430 * @see elm_object_cursor_set() for more details.
24432 * @ingroup Diskselector
24434 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24437 * Get the cursor to be shown when mouse is over the diskselector item
24439 * @param item diskselector item with cursor already set.
24440 * @return the cursor name.
24442 * @see elm_object_cursor_get() for more details.
24443 * @see elm_diskselector_cursor_set()
24445 * @ingroup Diskselector
24447 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24451 * Unset the cursor to be shown when mouse is over the diskselector item
24453 * @param item Target item
24455 * @see elm_object_cursor_unset() for more details.
24456 * @see elm_diskselector_cursor_set()
24458 * @ingroup Diskselector
24460 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24463 * Sets a different style for this item cursor.
24465 * @note before you set a style you should define a cursor with
24466 * elm_diskselector_item_cursor_set()
24468 * @param item diskselector item with cursor already set.
24469 * @param style the theme style to use (default, transparent, ...)
24471 * @see elm_object_cursor_style_set() for more details.
24473 * @ingroup Diskselector
24475 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24479 * Get the style for this item cursor.
24481 * @param item diskselector item with cursor already set.
24482 * @return style the theme style in use, defaults to "default". If the
24483 * object does not have a cursor set, then @c NULL is returned.
24485 * @see elm_object_cursor_style_get() for more details.
24486 * @see elm_diskselector_item_cursor_style_set()
24488 * @ingroup Diskselector
24490 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24494 * Set if the cursor set should be searched on the theme or should use
24495 * the provided by the engine, only.
24497 * @note before you set if should look on theme you should define a cursor
24498 * with elm_diskselector_item_cursor_set().
24499 * By default it will only look for cursors provided by the engine.
24501 * @param item widget item with cursor already set.
24502 * @param engine_only boolean to define if cursors set with
24503 * elm_diskselector_item_cursor_set() should be searched only
24504 * between cursors provided by the engine or searched on widget's
24507 * @see elm_object_cursor_engine_only_set() for more details.
24509 * @ingroup Diskselector
24511 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24514 * Get the cursor engine only usage for this item cursor.
24516 * @param item widget item with cursor already set.
24517 * @return engine_only boolean to define it cursors should be looked only
24518 * between the provided by the engine or searched on widget's theme as well.
24519 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24521 * @see elm_object_cursor_engine_only_get() for more details.
24522 * @see elm_diskselector_item_cursor_engine_only_set()
24524 * @ingroup Diskselector
24526 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24533 * @defgroup Colorselector Colorselector
24537 * @image html img/widget/colorselector/preview-00.png
24538 * @image latex img/widget/colorselector/preview-00.eps
24540 * @brief Widget for user to select a color.
24542 * Signals that you can add callbacks for are:
24543 * "changed" - When the color value changes(event_info is NULL).
24545 * See @ref tutorial_colorselector.
24548 * @brief Add a new colorselector to the parent
24550 * @param parent The parent object
24551 * @return The new object or NULL if it cannot be created
24553 * @ingroup Colorselector
24555 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24557 * Set a color for the colorselector
24559 * @param obj Colorselector object
24560 * @param r r-value of color
24561 * @param g g-value of color
24562 * @param b b-value of color
24563 * @param a a-value of color
24565 * @ingroup Colorselector
24567 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24569 * Get a color from the colorselector
24571 * @param obj Colorselector object
24572 * @param r integer pointer for r-value of color
24573 * @param g integer pointer for g-value of color
24574 * @param b integer pointer for b-value of color
24575 * @param a integer pointer for a-value of color
24577 * @ingroup Colorselector
24579 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24585 * @defgroup Ctxpopup Ctxpopup
24587 * @image html img/widget/ctxpopup/preview-00.png
24588 * @image latex img/widget/ctxpopup/preview-00.eps
24590 * @brief Context popup widet.
24592 * A ctxpopup is a widget that, when shown, pops up a list of items.
24593 * It automatically chooses an area inside its parent object's view
24594 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24595 * optimally fit into it. In the default theme, it will also point an
24596 * arrow to it's top left position at the time one shows it. Ctxpopup
24597 * items have a label and/or an icon. It is intended for a small
24598 * number of items (hence the use of list, not genlist).
24600 * @note Ctxpopup is a especialization of @ref Hover.
24602 * Signals that you can add callbacks for are:
24603 * "dismissed" - the ctxpopup was dismissed
24605 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24608 typedef enum _Elm_Ctxpopup_Direction
24610 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24612 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24613 the clicked area */
24614 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24615 the clicked area */
24616 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24618 } Elm_Ctxpopup_Direction;
24621 * @brief Add a new Ctxpopup object to the parent.
24623 * @param parent Parent object
24624 * @return New object or @c NULL, if it cannot be created
24626 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24628 * @brief Set the Ctxpopup's parent
24630 * @param obj The ctxpopup object
24631 * @param area The parent to use
24633 * Set the parent object.
24635 * @note elm_ctxpopup_add() will automatically call this function
24636 * with its @c parent argument.
24638 * @see elm_ctxpopup_add()
24639 * @see elm_hover_parent_set()
24641 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24643 * @brief Get the Ctxpopup's parent
24645 * @param obj The ctxpopup object
24647 * @see elm_ctxpopup_hover_parent_set() for more information
24649 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24651 * @brief Clear all items in the given ctxpopup object.
24653 * @param obj Ctxpopup object
24655 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24657 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24659 * @param obj Ctxpopup object
24660 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24662 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24664 * @brief Get the value of current ctxpopup object's orientation.
24666 * @param obj Ctxpopup object
24667 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24669 * @see elm_ctxpopup_horizontal_set()
24671 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24673 * @brief Add a new item to a ctxpopup object.
24675 * @param obj Ctxpopup object
24676 * @param icon Icon to be set on new item
24677 * @param label The Label of the new item
24678 * @param func Convenience function called when item selected
24679 * @param data Data passed to @p func
24680 * @return A handle to the item added or @c NULL, on errors
24682 * @warning Ctxpopup can't hold both an item list and a content at the same
24683 * time. When an item is added, any previous content will be removed.
24685 * @see elm_ctxpopup_content_set()
24687 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);
24689 * @brief Delete the given item in a ctxpopup object.
24691 * @param it Ctxpopup item to be deleted
24693 * @see elm_ctxpopup_item_append()
24695 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24697 * @brief Set the ctxpopup item's state as disabled or enabled.
24699 * @param it Ctxpopup item to be enabled/disabled
24700 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24702 * When disabled the item is greyed out to indicate it's state.
24704 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24706 * @brief Get the ctxpopup item's disabled/enabled state.
24708 * @param it Ctxpopup item to be enabled/disabled
24709 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24711 * @see elm_ctxpopup_item_disabled_set()
24713 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24715 * @brief Get the icon object for the given ctxpopup item.
24717 * @param it Ctxpopup item
24718 * @return icon object or @c NULL, if the item does not have icon or an error
24721 * @see elm_ctxpopup_item_append()
24722 * @see elm_ctxpopup_item_icon_set()
24724 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24726 * @brief Sets the side icon associated with the ctxpopup item
24728 * @param it Ctxpopup item
24729 * @param icon Icon object to be set
24731 * Once the icon object is set, a previously set one will be deleted.
24732 * @warning Setting the same icon for two items will cause the icon to
24733 * dissapear from the first item.
24735 * @see elm_ctxpopup_item_append()
24737 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24739 * @brief Get the label for the given ctxpopup item.
24741 * @param it Ctxpopup item
24742 * @return label string or @c NULL, if the item does not have label or an
24745 * @see elm_ctxpopup_item_append()
24746 * @see elm_ctxpopup_item_label_set()
24748 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24750 * @brief (Re)set the label on the given ctxpopup item.
24752 * @param it Ctxpopup item
24753 * @param label String to set as label
24755 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24757 * @brief Set an elm widget as the content of the ctxpopup.
24759 * @param obj Ctxpopup object
24760 * @param content Content to be swallowed
24762 * If the content object is already set, a previous one will bedeleted. If
24763 * you want to keep that old content object, use the
24764 * elm_ctxpopup_content_unset() function.
24766 * @deprecated use elm_object_content_set()
24768 * @warning Ctxpopup can't hold both a item list and a content at the same
24769 * time. When a content is set, any previous items will be removed.
24771 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24773 * @brief Unset the ctxpopup content
24775 * @param obj Ctxpopup object
24776 * @return The content that was being used
24778 * Unparent and return the content object which was set for this widget.
24780 * @deprecated use elm_object_content_unset()
24782 * @see elm_ctxpopup_content_set()
24784 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24786 * @brief Set the direction priority of a ctxpopup.
24788 * @param obj Ctxpopup object
24789 * @param first 1st priority of direction
24790 * @param second 2nd priority of direction
24791 * @param third 3th priority of direction
24792 * @param fourth 4th priority of direction
24794 * This functions gives a chance to user to set the priority of ctxpopup
24795 * showing direction. This doesn't guarantee the ctxpopup will appear in the
24796 * requested direction.
24798 * @see Elm_Ctxpopup_Direction
24800 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);
24802 * @brief Get the direction priority of a ctxpopup.
24804 * @param obj Ctxpopup object
24805 * @param first 1st priority of direction to be returned
24806 * @param second 2nd priority of direction to be returned
24807 * @param third 3th priority of direction to be returned
24808 * @param fourth 4th priority of direction to be returned
24810 * @see elm_ctxpopup_direction_priority_set() for more information.
24812 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);
24820 * @defgroup Transit Transit
24821 * @ingroup Elementary
24823 * Transit is designed to apply various animated transition effects to @c
24824 * Evas_Object, such like translation, rotation, etc. For using these
24825 * effects, create an @ref Elm_Transit and add the desired transition effects.
24827 * Once the effects are added into transit, they will be automatically
24828 * managed (their callback will be called until the duration is ended, and
24829 * they will be deleted on completion).
24833 * Elm_Transit *trans = elm_transit_add();
24834 * elm_transit_object_add(trans, obj);
24835 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24836 * elm_transit_duration_set(transit, 1);
24837 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24838 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24839 * elm_transit_repeat_times_set(transit, 3);
24842 * Some transition effects are used to change the properties of objects. They
24844 * @li @ref elm_transit_effect_translation_add
24845 * @li @ref elm_transit_effect_color_add
24846 * @li @ref elm_transit_effect_rotation_add
24847 * @li @ref elm_transit_effect_wipe_add
24848 * @li @ref elm_transit_effect_zoom_add
24849 * @li @ref elm_transit_effect_resizing_add
24851 * Other transition effects are used to make one object disappear and another
24852 * object appear on its old place. These effects are:
24854 * @li @ref elm_transit_effect_flip_add
24855 * @li @ref elm_transit_effect_resizable_flip_add
24856 * @li @ref elm_transit_effect_fade_add
24857 * @li @ref elm_transit_effect_blend_add
24859 * It's also possible to make a transition chain with @ref
24860 * elm_transit_chain_transit_add.
24862 * @warning We strongly recommend to use elm_transit just when edje can not do
24863 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24864 * animations can be manipulated inside the theme.
24866 * List of examples:
24867 * @li @ref transit_example_01_explained
24868 * @li @ref transit_example_02_explained
24869 * @li @ref transit_example_03_c
24870 * @li @ref transit_example_04_c
24876 * @enum Elm_Transit_Tween_Mode
24878 * The type of acceleration used in the transition.
24882 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24883 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24884 over time, then decrease again
24886 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24888 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24890 } Elm_Transit_Tween_Mode;
24893 * @enum Elm_Transit_Effect_Flip_Axis
24895 * The axis where flip effect should be applied.
24899 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
24900 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
24901 } Elm_Transit_Effect_Flip_Axis;
24903 * @enum Elm_Transit_Effect_Wipe_Dir
24905 * The direction where the wipe effect should occur.
24909 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
24910 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
24911 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
24912 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
24913 } Elm_Transit_Effect_Wipe_Dir;
24914 /** @enum Elm_Transit_Effect_Wipe_Type
24916 * Whether the wipe effect should show or hide the object.
24920 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
24922 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
24924 } Elm_Transit_Effect_Wipe_Type;
24927 * @typedef Elm_Transit
24929 * The Transit created with elm_transit_add(). This type has the information
24930 * about the objects which the transition will be applied, and the
24931 * transition effects that will be used. It also contains info about
24932 * duration, number of repetitions, auto-reverse, etc.
24934 typedef struct _Elm_Transit Elm_Transit;
24935 typedef void Elm_Transit_Effect;
24937 * @typedef Elm_Transit_Effect_Transition_Cb
24939 * Transition callback called for this effect on each transition iteration.
24941 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
24943 * Elm_Transit_Effect_End_Cb
24945 * Transition callback called for this effect when the transition is over.
24947 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
24950 * Elm_Transit_Del_Cb
24952 * A callback called when the transit is deleted.
24954 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
24959 * @note Is not necessary to delete the transit object, it will be deleted at
24960 * the end of its operation.
24961 * @note The transit will start playing when the program enter in the main loop, is not
24962 * necessary to give a start to the transit.
24964 * @return The transit object.
24968 EAPI Elm_Transit *elm_transit_add(void);
24971 * Stops the animation and delete the @p transit object.
24973 * Call this function if you wants to stop the animation before the duration
24974 * time. Make sure the @p transit object is still alive with
24975 * elm_transit_del_cb_set() function.
24976 * All added effects will be deleted, calling its repective data_free_cb
24977 * functions. The function setted by elm_transit_del_cb_set() will be called.
24979 * @see elm_transit_del_cb_set()
24981 * @param transit The transit object to be deleted.
24984 * @warning Just call this function if you are sure the transit is alive.
24986 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
24989 * Add a new effect to the transit.
24991 * @note The cb function and the data are the key to the effect. If you try to
24992 * add an already added effect, nothing is done.
24993 * @note After the first addition of an effect in @p transit, if its
24994 * effect list become empty again, the @p transit will be killed by
24995 * elm_transit_del(transit) function.
24999 * Elm_Transit *transit = elm_transit_add();
25000 * elm_transit_effect_add(transit,
25001 * elm_transit_effect_blend_op,
25002 * elm_transit_effect_blend_context_new(),
25003 * elm_transit_effect_blend_context_free);
25006 * @param transit The transit object.
25007 * @param transition_cb The operation function. It is called when the
25008 * animation begins, it is the function that actually performs the animation.
25009 * It is called with the @p data, @p transit and the time progression of the
25010 * animation (a double value between 0.0 and 1.0).
25011 * @param effect The context data of the effect.
25012 * @param end_cb The function to free the context data, it will be called
25013 * at the end of the effect, it must finalize the animation and free the
25017 * @warning The transit free the context data at the and of the transition with
25018 * the data_free_cb function, do not use the context data in another transit.
25020 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);
25023 * Delete an added effect.
25025 * This function will remove the effect from the @p transit, calling the
25026 * data_free_cb to free the @p data.
25028 * @see elm_transit_effect_add()
25030 * @note If the effect is not found, nothing is done.
25031 * @note If the effect list become empty, this function will call
25032 * elm_transit_del(transit), that is, it will kill the @p transit.
25034 * @param transit The transit object.
25035 * @param transition_cb The operation function.
25036 * @param effect The context data of the effect.
25040 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);
25043 * Add new object to apply the effects.
25045 * @note After the first addition of an object in @p transit, if its
25046 * object list become empty again, the @p transit will be killed by
25047 * elm_transit_del(transit) function.
25048 * @note If the @p obj belongs to another transit, the @p obj will be
25049 * removed from it and it will only belong to the @p transit. If the old
25050 * transit stays without objects, it will die.
25051 * @note When you add an object into the @p transit, its state from
25052 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25053 * transit ends, if you change this state whith evas_object_pass_events_set()
25054 * after add the object, this state will change again when @p transit stops to
25057 * @param transit The transit object.
25058 * @param obj Object to be animated.
25061 * @warning It is not allowed to add a new object after transit begins to go.
25063 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25066 * Removes an added object from the transit.
25068 * @note If the @p obj is not in the @p transit, nothing is done.
25069 * @note If the list become empty, this function will call
25070 * elm_transit_del(transit), that is, it will kill the @p transit.
25072 * @param transit The transit object.
25073 * @param obj Object to be removed from @p transit.
25076 * @warning It is not allowed to remove objects after transit begins to go.
25078 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25081 * Get the objects of the transit.
25083 * @param transit The transit object.
25084 * @return a Eina_List with the objects from the transit.
25088 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25091 * Enable/disable keeping up the objects states.
25092 * If it is not kept, the objects states will be reset when transition ends.
25094 * @note @p transit can not be NULL.
25095 * @note One state includes geometry, color, map data.
25097 * @param transit The transit object.
25098 * @param state_keep Keeping or Non Keeping.
25102 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25105 * Get a value whether the objects states will be reset or not.
25107 * @note @p transit can not be NULL
25109 * @see elm_transit_objects_final_state_keep_set()
25111 * @param transit The transit object.
25112 * @return EINA_TRUE means the states of the objects will be reset.
25113 * If @p transit is NULL, EINA_FALSE is returned
25117 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25120 * Set the event enabled when transit is operating.
25122 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25123 * events from mouse and keyboard during the animation.
25124 * @note When you add an object with elm_transit_object_add(), its state from
25125 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25126 * transit ends, if you change this state with evas_object_pass_events_set()
25127 * after adding the object, this state will change again when @p transit stops
25130 * @param transit The transit object.
25131 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25132 * ignored otherwise.
25136 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25139 * Get the value of event enabled status.
25141 * @see elm_transit_event_enabled_set()
25143 * @param transit The Transit object
25144 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25145 * EINA_FALSE is returned
25149 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25152 * Set the user-callback function when the transit is deleted.
25154 * @note Using this function twice will overwrite the first function setted.
25155 * @note the @p transit object will be deleted after call @p cb function.
25157 * @param transit The transit object.
25158 * @param cb Callback function pointer. This function will be called before
25159 * the deletion of the transit.
25160 * @param data Callback funtion user data. It is the @p op parameter.
25164 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25167 * Set reverse effect automatically.
25169 * If auto reverse is setted, after running the effects with the progress
25170 * parameter from 0 to 1, it will call the effecs again with the progress
25171 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25172 * where the duration was setted with the function elm_transit_add and
25173 * the repeat with the function elm_transit_repeat_times_set().
25175 * @param transit The transit object.
25176 * @param reverse EINA_TRUE means the auto_reverse is on.
25180 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25183 * Get if the auto reverse is on.
25185 * @see elm_transit_auto_reverse_set()
25187 * @param transit The transit object.
25188 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25189 * EINA_FALSE is returned
25193 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25196 * Set the transit repeat count. Effect will be repeated by repeat count.
25198 * This function sets the number of repetition the transit will run after
25199 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25200 * If the @p repeat is a negative number, it will repeat infinite times.
25202 * @note If this function is called during the transit execution, the transit
25203 * will run @p repeat times, ignoring the times it already performed.
25205 * @param transit The transit object
25206 * @param repeat Repeat count
25210 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25213 * Get the transit repeat count.
25215 * @see elm_transit_repeat_times_set()
25217 * @param transit The Transit object.
25218 * @return The repeat count. If @p transit is NULL
25223 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25226 * Set the transit animation acceleration type.
25228 * This function sets the tween mode of the transit that can be:
25229 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25230 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25231 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25232 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25234 * @param transit The transit object.
25235 * @param tween_mode The tween type.
25239 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25242 * Get the transit animation acceleration type.
25244 * @note @p transit can not be NULL
25246 * @param transit The transit object.
25247 * @return The tween type. If @p transit is NULL
25248 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25252 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25255 * Set the transit animation time
25257 * @note @p transit can not be NULL
25259 * @param transit The transit object.
25260 * @param duration The animation time.
25264 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25267 * Get the transit animation time
25269 * @note @p transit can not be NULL
25271 * @param transit The transit object.
25273 * @return The transit animation time.
25277 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25280 * Starts the transition.
25281 * Once this API is called, the transit begins to measure the time.
25283 * @note @p transit can not be NULL
25285 * @param transit The transit object.
25289 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25292 * Pause/Resume the transition.
25294 * If you call elm_transit_go again, the transit will be started from the
25295 * beginning, and will be unpaused.
25297 * @note @p transit can not be NULL
25299 * @param transit The transit object.
25300 * @param paused Whether the transition should be paused or not.
25304 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25307 * Get the value of paused status.
25309 * @see elm_transit_paused_set()
25311 * @note @p transit can not be NULL
25313 * @param transit The transit object.
25314 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25315 * EINA_FALSE is returned
25319 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25322 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25324 * The value returned is a fraction (current time / total time). It
25325 * represents the progression position relative to the total.
25327 * @note @p transit can not be NULL
25329 * @param transit The transit object.
25331 * @return The time progression value. If @p transit is NULL
25336 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25339 * Makes the chain relationship between two transits.
25341 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25342 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25344 * @param transit The transit object.
25345 * @param chain_transit The chain transit object. This transit will be operated
25346 * after transit is done.
25348 * This function adds @p chain_transit transition to a chain after the @p
25349 * transit, and will be started as soon as @p transit ends. See @ref
25350 * transit_example_02_explained for a full example.
25354 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25357 * Cut off the chain relationship between two transits.
25359 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25360 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25362 * @param transit The transit object.
25363 * @param chain_transit The chain transit object.
25365 * This function remove the @p chain_transit transition from the @p transit.
25369 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25372 * Get the current chain transit list.
25374 * @note @p transit can not be NULL.
25376 * @param transit The transit object.
25377 * @return chain transit list.
25381 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25384 * Add the Resizing Effect to Elm_Transit.
25386 * @note This API is one of the facades. It creates resizing effect context
25387 * and add it's required APIs to elm_transit_effect_add.
25389 * @see elm_transit_effect_add()
25391 * @param transit Transit object.
25392 * @param from_w Object width size when effect begins.
25393 * @param from_h Object height size when effect begins.
25394 * @param to_w Object width size when effect ends.
25395 * @param to_h Object height size when effect ends.
25396 * @return Resizing effect context data.
25400 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);
25403 * Add the Translation Effect to Elm_Transit.
25405 * @note This API is one of the facades. It creates translation effect context
25406 * and add it's required APIs to elm_transit_effect_add.
25408 * @see elm_transit_effect_add()
25410 * @param transit Transit object.
25411 * @param from_dx X Position variation when effect begins.
25412 * @param from_dy Y Position variation when effect begins.
25413 * @param to_dx X Position variation when effect ends.
25414 * @param to_dy Y Position variation when effect ends.
25415 * @return Translation effect context data.
25418 * @warning It is highly recommended just create a transit with this effect when
25419 * the window that the objects of the transit belongs has already been created.
25420 * This is because this effect needs the geometry information about the objects,
25421 * and if the window was not created yet, it can get a wrong information.
25423 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);
25426 * Add the Zoom Effect to Elm_Transit.
25428 * @note This API is one of the facades. It creates zoom effect context
25429 * and add it's required APIs to elm_transit_effect_add.
25431 * @see elm_transit_effect_add()
25433 * @param transit Transit object.
25434 * @param from_rate Scale rate when effect begins (1 is current rate).
25435 * @param to_rate Scale rate when effect ends.
25436 * @return Zoom effect context data.
25439 * @warning It is highly recommended just create a transit with this effect when
25440 * the window that the objects of the transit belongs has already been created.
25441 * This is because this effect needs the geometry information about the objects,
25442 * and if the window was not created yet, it can get a wrong information.
25444 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25447 * Add the Flip Effect to Elm_Transit.
25449 * @note This API is one of the facades. It creates flip effect context
25450 * and add it's required APIs to elm_transit_effect_add.
25451 * @note This effect is applied to each pair of objects in the order they are listed
25452 * in the transit list of objects. The first object in the pair will be the
25453 * "front" object and the second will be the "back" object.
25455 * @see elm_transit_effect_add()
25457 * @param transit Transit object.
25458 * @param axis Flipping Axis(X or Y).
25459 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25460 * @return Flip effect context data.
25463 * @warning It is highly recommended just create a transit with this effect when
25464 * the window that the objects of the transit belongs has already been created.
25465 * This is because this effect needs the geometry information about the objects,
25466 * and if the window was not created yet, it can get a wrong information.
25468 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25471 * Add the Resizable Flip Effect to Elm_Transit.
25473 * @note This API is one of the facades. It creates resizable flip effect context
25474 * and add it's required APIs to elm_transit_effect_add.
25475 * @note This effect is applied to each pair of objects in the order they are listed
25476 * in the transit list of objects. The first object in the pair will be the
25477 * "front" object and the second will be the "back" object.
25479 * @see elm_transit_effect_add()
25481 * @param transit Transit object.
25482 * @param axis Flipping Axis(X or Y).
25483 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25484 * @return Resizable flip effect context data.
25487 * @warning It is highly recommended just create a transit with this effect when
25488 * the window that the objects of the transit belongs has already been created.
25489 * This is because this effect needs the geometry information about the objects,
25490 * and if the window was not created yet, it can get a wrong information.
25492 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25495 * Add the Wipe Effect to Elm_Transit.
25497 * @note This API is one of the facades. It creates wipe effect context
25498 * and add it's required APIs to elm_transit_effect_add.
25500 * @see elm_transit_effect_add()
25502 * @param transit Transit object.
25503 * @param type Wipe type. Hide or show.
25504 * @param dir Wipe Direction.
25505 * @return Wipe effect context data.
25508 * @warning It is highly recommended just create a transit with this effect when
25509 * the window that the objects of the transit belongs has already been created.
25510 * This is because this effect needs the geometry information about the objects,
25511 * and if the window was not created yet, it can get a wrong information.
25513 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25516 * Add the Color Effect to Elm_Transit.
25518 * @note This API is one of the facades. It creates color effect context
25519 * and add it's required APIs to elm_transit_effect_add.
25521 * @see elm_transit_effect_add()
25523 * @param transit Transit object.
25524 * @param from_r RGB R when effect begins.
25525 * @param from_g RGB G when effect begins.
25526 * @param from_b RGB B when effect begins.
25527 * @param from_a RGB A when effect begins.
25528 * @param to_r RGB R when effect ends.
25529 * @param to_g RGB G when effect ends.
25530 * @param to_b RGB B when effect ends.
25531 * @param to_a RGB A when effect ends.
25532 * @return Color effect context data.
25536 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);
25539 * Add the Fade Effect to Elm_Transit.
25541 * @note This API is one of the facades. It creates fade effect context
25542 * and add it's required APIs to elm_transit_effect_add.
25543 * @note This effect is applied to each pair of objects in the order they are listed
25544 * in the transit list of objects. The first object in the pair will be the
25545 * "before" object and the second will be the "after" object.
25547 * @see elm_transit_effect_add()
25549 * @param transit Transit object.
25550 * @return Fade effect context data.
25553 * @warning It is highly recommended just create a transit with this effect when
25554 * the window that the objects of the transit belongs has already been created.
25555 * This is because this effect needs the color information about the objects,
25556 * and if the window was not created yet, it can get a wrong information.
25558 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25561 * Add the Blend Effect to Elm_Transit.
25563 * @note This API is one of the facades. It creates blend effect context
25564 * and add it's required APIs to elm_transit_effect_add.
25565 * @note This effect is applied to each pair of objects in the order they are listed
25566 * in the transit list of objects. The first object in the pair will be the
25567 * "before" object and the second will be the "after" object.
25569 * @see elm_transit_effect_add()
25571 * @param transit Transit object.
25572 * @return Blend effect context data.
25575 * @warning It is highly recommended just create a transit with this effect when
25576 * the window that the objects of the transit belongs has already been created.
25577 * This is because this effect needs the color information about the objects,
25578 * and if the window was not created yet, it can get a wrong information.
25580 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25583 * Add the Rotation Effect to Elm_Transit.
25585 * @note This API is one of the facades. It creates rotation effect context
25586 * and add it's required APIs to elm_transit_effect_add.
25588 * @see elm_transit_effect_add()
25590 * @param transit Transit object.
25591 * @param from_degree Degree when effect begins.
25592 * @param to_degree Degree when effect is ends.
25593 * @return Rotation effect context data.
25596 * @warning It is highly recommended just create a transit with this effect when
25597 * the window that the objects of the transit belongs has already been created.
25598 * This is because this effect needs the geometry information about the objects,
25599 * and if the window was not created yet, it can get a wrong information.
25601 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25604 * Add the ImageAnimation Effect to Elm_Transit.
25606 * @note This API is one of the facades. It creates image animation effect context
25607 * and add it's required APIs to elm_transit_effect_add.
25608 * The @p images parameter is a list images paths. This list and
25609 * its contents will be deleted at the end of the effect by
25610 * elm_transit_effect_image_animation_context_free() function.
25614 * char buf[PATH_MAX];
25615 * Eina_List *images = NULL;
25616 * Elm_Transit *transi = elm_transit_add();
25618 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25619 * images = eina_list_append(images, eina_stringshare_add(buf));
25621 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25622 * images = eina_list_append(images, eina_stringshare_add(buf));
25623 * elm_transit_effect_image_animation_add(transi, images);
25627 * @see elm_transit_effect_add()
25629 * @param transit Transit object.
25630 * @param images Eina_List of images file paths. This list and
25631 * its contents will be deleted at the end of the effect by
25632 * elm_transit_effect_image_animation_context_free() function.
25633 * @return Image Animation effect context data.
25637 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25642 typedef struct _Elm_Store Elm_Store;
25643 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25644 typedef struct _Elm_Store_Item Elm_Store_Item;
25645 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25646 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25647 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25648 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25649 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25650 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25651 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25652 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25654 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25655 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25656 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25657 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25661 ELM_STORE_ITEM_MAPPING_NONE = 0,
25662 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25663 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25664 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25665 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25666 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25667 // can add more here as needed by common apps
25668 ELM_STORE_ITEM_MAPPING_LAST
25669 } Elm_Store_Item_Mapping_Type;
25671 struct _Elm_Store_Item_Mapping_Icon
25673 // FIXME: allow edje file icons
25675 Elm_Icon_Lookup_Order lookup_order;
25676 Eina_Bool standard_name : 1;
25677 Eina_Bool no_scale : 1;
25678 Eina_Bool smooth : 1;
25679 Eina_Bool scale_up : 1;
25680 Eina_Bool scale_down : 1;
25683 struct _Elm_Store_Item_Mapping_Empty
25688 struct _Elm_Store_Item_Mapping_Photo
25693 struct _Elm_Store_Item_Mapping_Custom
25695 Elm_Store_Item_Mapping_Cb func;
25698 struct _Elm_Store_Item_Mapping
25700 Elm_Store_Item_Mapping_Type type;
25705 Elm_Store_Item_Mapping_Empty empty;
25706 Elm_Store_Item_Mapping_Icon icon;
25707 Elm_Store_Item_Mapping_Photo photo;
25708 Elm_Store_Item_Mapping_Custom custom;
25709 // add more types here
25713 struct _Elm_Store_Item_Info
25715 Elm_Genlist_Item_Class *item_class;
25716 const Elm_Store_Item_Mapping *mapping;
25721 struct _Elm_Store_Item_Info_Filesystem
25723 Elm_Store_Item_Info base;
25727 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25728 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25730 EAPI void elm_store_free(Elm_Store *st);
25732 EAPI Elm_Store *elm_store_filesystem_new(void);
25733 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25734 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25735 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25737 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25739 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25740 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25741 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25742 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25743 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25744 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25746 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25747 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25748 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25749 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25750 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25751 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25752 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25755 * @defgroup SegmentControl SegmentControl
25756 * @ingroup Elementary
25758 * @image html img/widget/segment_control/preview-00.png
25759 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25761 * @image html img/segment_control.png
25762 * @image latex img/segment_control.eps width=\textwidth
25764 * Segment control widget is a horizontal control made of multiple segment
25765 * items, each segment item functioning similar to discrete two state button.
25766 * A segment control groups the items together and provides compact
25767 * single button with multiple equal size segments.
25769 * Segment item size is determined by base widget
25770 * size and the number of items added.
25771 * Only one segment item can be at selected state. A segment item can display
25772 * combination of Text and any Evas_Object like Images or other widget.
25774 * Smart callbacks one can listen to:
25775 * - "changed" - When the user clicks on a segment item which is not
25776 * previously selected and get selected. The event_info parameter is the
25777 * segment item index.
25779 * Available styles for it:
25782 * Here is an example on its usage:
25783 * @li @ref segment_control_example
25787 * @addtogroup SegmentControl
25791 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25794 * Add a new segment control widget to the given parent Elementary
25795 * (container) object.
25797 * @param parent The parent object.
25798 * @return a new segment control widget handle or @c NULL, on errors.
25800 * This function inserts a new segment control widget on the canvas.
25802 * @ingroup SegmentControl
25804 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25807 * Append a new item to the segment control object.
25809 * @param obj The segment control object.
25810 * @param icon The icon object to use for the left side of the item. An
25811 * icon can be any Evas object, but usually it is an icon created
25812 * with elm_icon_add().
25813 * @param label The label of the item.
25814 * Note that, NULL is different from empty string "".
25815 * @return The created item or @c NULL upon failure.
25817 * A new item will be created and appended to the segment control, i.e., will
25818 * be set as @b last item.
25820 * If it should be inserted at another position,
25821 * elm_segment_control_item_insert_at() should be used instead.
25823 * Items created with this function can be deleted with function
25824 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25826 * @note @p label set to @c NULL is different from empty string "".
25828 * only has icon, it will be displayed bigger and centered. If it has
25829 * icon and label, even that an empty string, icon will be smaller and
25830 * positioned at left.
25834 * sc = elm_segment_control_add(win);
25835 * ic = elm_icon_add(win);
25836 * elm_icon_file_set(ic, "path/to/image", NULL);
25837 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25838 * elm_segment_control_item_add(sc, ic, "label");
25839 * evas_object_show(sc);
25842 * @see elm_segment_control_item_insert_at()
25843 * @see elm_segment_control_item_del()
25845 * @ingroup SegmentControl
25847 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25850 * Insert a new item to the segment control object at specified position.
25852 * @param obj The segment control object.
25853 * @param icon The icon object to use for the left side of the item. An
25854 * icon can be any Evas object, but usually it is an icon created
25855 * with elm_icon_add().
25856 * @param label The label of the item.
25857 * @param index Item position. Value should be between 0 and items count.
25858 * @return The created item or @c NULL upon failure.
25860 * Index values must be between @c 0, when item will be prepended to
25861 * segment control, and items count, that can be get with
25862 * elm_segment_control_item_count_get(), case when item will be appended
25863 * to segment control, just like elm_segment_control_item_add().
25865 * Items created with this function can be deleted with function
25866 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25868 * @note @p label set to @c NULL is different from empty string "".
25870 * only has icon, it will be displayed bigger and centered. If it has
25871 * icon and label, even that an empty string, icon will be smaller and
25872 * positioned at left.
25874 * @see elm_segment_control_item_add()
25875 * @see elm_segment_control_count_get()
25876 * @see elm_segment_control_item_del()
25878 * @ingroup SegmentControl
25880 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);
25883 * Remove a segment control item from its parent, deleting it.
25885 * @param it The item to be removed.
25887 * Items can be added with elm_segment_control_item_add() or
25888 * elm_segment_control_item_insert_at().
25890 * @ingroup SegmentControl
25892 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25895 * Remove a segment control item at given index from its parent,
25898 * @param obj The segment control object.
25899 * @param index The position of the segment control item to be deleted.
25901 * Items can be added with elm_segment_control_item_add() or
25902 * elm_segment_control_item_insert_at().
25904 * @ingroup SegmentControl
25906 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25909 * Get the Segment items count from segment control.
25911 * @param obj The segment control object.
25912 * @return Segment items count.
25914 * It will just return the number of items added to segment control @p obj.
25916 * @ingroup SegmentControl
25918 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25921 * Get the item placed at specified index.
25923 * @param obj The segment control object.
25924 * @param index The index of the segment item.
25925 * @return The segment control item or @c NULL on failure.
25927 * Index is the position of an item in segment control widget. Its
25928 * range is from @c 0 to <tt> count - 1 </tt>.
25929 * Count is the number of items, that can be get with
25930 * elm_segment_control_item_count_get().
25932 * @ingroup SegmentControl
25934 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25937 * Get the label of item.
25939 * @param obj The segment control object.
25940 * @param index The index of the segment item.
25941 * @return The label of the item at @p index.
25943 * The return value is a pointer to the label associated to the item when
25944 * it was created, with function elm_segment_control_item_add(), or later
25945 * with function elm_segment_control_item_label_set. If no label
25946 * was passed as argument, it will return @c NULL.
25948 * @see elm_segment_control_item_label_set() for more details.
25949 * @see elm_segment_control_item_add()
25951 * @ingroup SegmentControl
25953 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25956 * Set the label of item.
25958 * @param it The item of segment control.
25959 * @param text The label of item.
25961 * The label to be displayed by the item.
25962 * Label will be at right of the icon (if set).
25964 * If a label was passed as argument on item creation, with function
25965 * elm_control_segment_item_add(), it will be already
25966 * displayed by the item.
25968 * @see elm_segment_control_item_label_get()
25969 * @see elm_segment_control_item_add()
25971 * @ingroup SegmentControl
25973 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
25976 * Get the icon associated to the item.
25978 * @param obj The segment control object.
25979 * @param index The index of the segment item.
25980 * @return The left side icon associated to the item at @p index.
25982 * The return value is a pointer to the icon associated to the item when
25983 * it was created, with function elm_segment_control_item_add(), or later
25984 * with function elm_segment_control_item_icon_set(). If no icon
25985 * was passed as argument, it will return @c NULL.
25987 * @see elm_segment_control_item_add()
25988 * @see elm_segment_control_item_icon_set()
25990 * @ingroup SegmentControl
25992 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25995 * Set the icon associated to the item.
25997 * @param it The segment control item.
25998 * @param icon The icon object to associate with @p it.
26000 * The icon object to use at left side of the item. An
26001 * icon can be any Evas object, but usually it is an icon created
26002 * with elm_icon_add().
26004 * Once the icon object is set, a previously set one will be deleted.
26005 * @warning Setting the same icon for two items will cause the icon to
26006 * dissapear from the first item.
26008 * If an icon was passed as argument on item creation, with function
26009 * elm_segment_control_item_add(), it will be already
26010 * associated to the item.
26012 * @see elm_segment_control_item_add()
26013 * @see elm_segment_control_item_icon_get()
26015 * @ingroup SegmentControl
26017 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26020 * Get the index of an item.
26022 * @param it The segment control item.
26023 * @return The position of item in segment control widget.
26025 * Index is the position of an item in segment control widget. Its
26026 * range is from @c 0 to <tt> count - 1 </tt>.
26027 * Count is the number of items, that can be get with
26028 * elm_segment_control_item_count_get().
26030 * @ingroup SegmentControl
26032 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26035 * Get the base object of the item.
26037 * @param it The segment control item.
26038 * @return The base object associated with @p it.
26040 * Base object is the @c Evas_Object that represents that item.
26042 * @ingroup SegmentControl
26044 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26047 * Get the selected item.
26049 * @param obj The segment control object.
26050 * @return The selected item or @c NULL if none of segment items is
26053 * The selected item can be unselected with function
26054 * elm_segment_control_item_selected_set().
26056 * The selected item always will be highlighted on segment control.
26058 * @ingroup SegmentControl
26060 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26063 * Set the selected state of an item.
26065 * @param it The segment control item
26066 * @param select The selected state
26068 * This sets the selected state of the given item @p it.
26069 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26071 * If a new item is selected the previosly selected will be unselected.
26072 * Previoulsy selected item can be get with function
26073 * elm_segment_control_item_selected_get().
26075 * The selected item always will be highlighted on segment control.
26077 * @see elm_segment_control_item_selected_get()
26079 * @ingroup SegmentControl
26081 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26088 * @defgroup Grid Grid
26090 * The grid is a grid layout widget that lays out a series of children as a
26091 * fixed "grid" of widgets using a given percentage of the grid width and
26092 * height each using the child object.
26094 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26095 * widgets size itself. The default is 100 x 100, so that means the
26096 * position and sizes of children will effectively be percentages (0 to 100)
26097 * of the width or height of the grid widget
26103 * Add a new grid to the parent
26105 * @param parent The parent object
26106 * @return The new object or NULL if it cannot be created
26110 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26113 * Set the virtual size of the grid
26115 * @param obj The grid object
26116 * @param w The virtual width of the grid
26117 * @param h The virtual height of the grid
26121 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26124 * Get the virtual size of the grid
26126 * @param obj The grid object
26127 * @param w Pointer to integer to store the virtual width of the grid
26128 * @param h Pointer to integer to store the virtual height of the grid
26132 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26135 * Pack child at given position and size
26137 * @param obj The grid object
26138 * @param subobj The child to pack
26139 * @param x The virtual x coord at which to pack it
26140 * @param y The virtual y coord at which to pack it
26141 * @param w The virtual width at which to pack it
26142 * @param h The virtual height at which to pack it
26146 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26149 * Unpack a child from a grid object
26151 * @param obj The grid object
26152 * @param subobj The child to unpack
26156 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26159 * Faster way to remove all child objects from a grid object.
26161 * @param obj The grid object
26162 * @param clear If true, it will delete just removed children
26166 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26169 * Set packing of an existing child at to position and size
26171 * @param subobj The child to set packing of
26172 * @param x The virtual x coord at which to pack it
26173 * @param y The virtual y coord at which to pack it
26174 * @param w The virtual width at which to pack it
26175 * @param h The virtual height at which to pack it
26179 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26182 * get packing of a child
26184 * @param subobj The child to query
26185 * @param x Pointer to integer to store the virtual x coord
26186 * @param y Pointer to integer to store the virtual y coord
26187 * @param w Pointer to integer to store the virtual width
26188 * @param h Pointer to integer to store the virtual height
26192 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26198 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26199 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26200 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26203 * @defgroup Video Video
26205 * This object display an player that let you control an Elm_Video
26206 * object. It take care of updating it's content according to what is
26207 * going on inside the Emotion object. It does activate the remember
26208 * function on the linked Elm_Video object.
26210 * Signals that you cann add callback for are :
26212 * "forward,clicked" - the user clicked the forward button.
26213 * "info,clicked" - the user clicked the info button.
26214 * "next,clicked" - the user clicked the next button.
26215 * "pause,clicked" - the user clicked the pause button.
26216 * "play,clicked" - the user clicked the play button.
26217 * "prev,clicked" - the user clicked the prev button.
26218 * "rewind,clicked" - the user clicked the rewind button.
26219 * "stop,clicked" - the user clicked the stop button.
26221 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26222 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26223 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26224 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26225 EAPI void elm_video_play(Evas_Object *video);
26226 EAPI void elm_video_pause(Evas_Object *video);
26227 EAPI void elm_video_stop(Evas_Object *video);
26228 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26229 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26230 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26231 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26232 EAPI double elm_video_audio_level_get(Evas_Object *video);
26233 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26234 EAPI double elm_video_play_position_get(Evas_Object *video);
26235 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26236 EAPI double elm_video_play_length_get(Evas_Object *video);
26237 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26238 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26239 EAPI const char *elm_video_title_get(Evas_Object *video);
26241 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26242 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26245 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26246 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);
26247 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26248 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26249 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26250 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26251 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26252 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26253 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26254 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26255 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26256 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26257 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26258 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26259 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);