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);
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_part_text_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 * Flush all caches & dump all data that can be to lean down to use
1083 EAPI void elm_all_flush(void);
1086 * Get the configured cache flush interval time
1088 * This gets the globally configured cache flush interval time, in
1091 * @return The cache flush interval time
1094 * @see elm_all_flush()
1096 EAPI int elm_cache_flush_interval_get(void);
1099 * Set the configured cache flush interval time
1101 * This sets the globally configured cache flush interval time, in ticks
1103 * @param size The cache flush interval time
1106 * @see elm_all_flush()
1108 EAPI void elm_cache_flush_interval_set(int size);
1111 * Set the configured cache flush interval time for all applications on the
1114 * This sets the globally configured cache flush interval time -- in ticks
1115 * -- for all applications on the display.
1117 * @param size The cache flush interval time
1120 EAPI void elm_cache_flush_interval_all_set(int size);
1123 * Get the configured cache flush enabled state
1125 * This gets the globally configured cache flush state - if it is enabled
1126 * or not. When cache flushing is enabled, elementary will regularly
1127 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1128 * memory and allow usage to re-seed caches and data in memory where it
1129 * can do so. An idle application will thus minimise its memory usage as
1130 * data will be freed from memory and not be re-loaded as it is idle and
1131 * not rendering or doing anything graphically right now.
1133 * @return The cache flush state
1136 * @see elm_all_flush()
1138 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1141 * Set the configured cache flush enabled state
1143 * This sets the globally configured cache flush enabled state
1145 * @param size The cache flush enabled state
1148 * @see elm_all_flush()
1150 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1153 * Set the configured cache flush enabled state for all applications on the
1156 * This sets the globally configured cache flush enabled state for all
1157 * applications on the display.
1159 * @param size The cache flush enabled state
1162 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1165 * Get the configured font cache size
1167 * This gets the globally configured font cache size, in bytes
1169 * @return The font cache size
1172 EAPI int elm_font_cache_get(void);
1175 * Set the configured font cache size
1177 * This sets the globally configured font cache size, in bytes
1179 * @param size The font cache size
1182 EAPI void elm_font_cache_set(int size);
1185 * Set the configured font cache size for all applications on the
1188 * This sets the globally configured font cache size -- in bytes
1189 * -- for all applications on the display.
1191 * @param size The font cache size
1194 EAPI void elm_font_cache_all_set(int size);
1197 * Get the configured image cache size
1199 * This gets the globally configured image cache size, in bytes
1201 * @return The image cache size
1204 EAPI int elm_image_cache_get(void);
1207 * Set the configured image cache size
1209 * This sets the globally configured image cache size, in bytes
1211 * @param size The image cache size
1214 EAPI void elm_image_cache_set(int size);
1217 * Set the configured image cache size for all applications on the
1220 * This sets the globally configured image cache size -- in bytes
1221 * -- for all applications on the display.
1223 * @param size The image cache size
1226 EAPI void elm_image_cache_all_set(int size);
1229 * Get the configured edje file cache size.
1231 * This gets the globally configured edje file cache size, in number
1234 * @return The edje file cache size
1237 EAPI int elm_edje_file_cache_get(void);
1240 * Set the configured edje file cache size
1242 * This sets the globally configured edje file cache size, in number
1245 * @param size The edje file cache size
1248 EAPI void elm_edje_file_cache_set(int size);
1251 * Set the configured edje file cache size for all applications on the
1254 * This sets the globally configured edje file cache size -- in number
1255 * of files -- for all applications on the display.
1257 * @param size The edje file cache size
1260 EAPI void elm_edje_file_cache_all_set(int size);
1263 * Get the configured edje collections (groups) cache size.
1265 * This gets the globally configured edje collections cache size, in
1266 * number of collections.
1268 * @return The edje collections cache size
1271 EAPI int elm_edje_collection_cache_get(void);
1274 * Set the configured edje collections (groups) cache size
1276 * This sets the globally configured edje collections cache size, in
1277 * number of collections.
1279 * @param size The edje collections cache size
1282 EAPI void elm_edje_collection_cache_set(int size);
1285 * Set the configured edje collections (groups) cache size for all
1286 * applications on the display
1288 * This sets the globally configured edje collections cache size -- in
1289 * number of collections -- for all applications on the display.
1291 * @param size The edje collections cache size
1294 EAPI void elm_edje_collection_cache_all_set(int size);
1301 * @defgroup Scaling Widget Scaling
1303 * Different widgets can be scaled independently. These functions
1304 * allow you to manipulate this scaling on a per-widget basis. The
1305 * object and all its children get their scaling factors multiplied
1306 * by the scale factor set. This is multiplicative, in that if a
1307 * child also has a scale size set it is in turn multiplied by its
1308 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1309 * double size, @c 0.5 is half, etc.
1311 * @ref general_functions_example_page "This" example contemplates
1312 * some of these functions.
1316 * Get the global scaling factor
1318 * This gets the globally configured scaling factor that is applied to all
1321 * @return The scaling factor
1324 EAPI double elm_scale_get(void);
1327 * Set the global scaling factor
1329 * This sets the globally configured scaling factor that is applied to all
1332 * @param scale The scaling factor to set
1335 EAPI void elm_scale_set(double scale);
1338 * Set the global scaling factor for all applications on the display
1340 * This sets the globally configured scaling factor that is applied to all
1341 * objects for all applications.
1342 * @param scale The scaling factor to set
1345 EAPI void elm_scale_all_set(double scale);
1348 * Set the scaling factor for a given Elementary object
1350 * @param obj The Elementary to operate on
1351 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1356 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1359 * Get the scaling factor for a given Elementary object
1361 * @param obj The object
1362 * @return The scaling factor set by elm_object_scale_set()
1366 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1369 * @defgroup UI-Mirroring Selective Widget mirroring
1371 * These functions allow you to set ui-mirroring on specific
1372 * widgets or the whole interface. Widgets can be in one of two
1373 * modes, automatic and manual. Automatic means they'll be changed
1374 * according to the system mirroring mode and manual means only
1375 * explicit changes will matter. You are not supposed to change
1376 * mirroring state of a widget set to automatic, will mostly work,
1377 * but the behavior is not really defined.
1382 EAPI Eina_Bool elm_mirrored_get(void);
1383 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1386 * Get the system mirrored mode. This determines the default mirrored mode
1389 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1391 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1394 * Set the system mirrored mode. This determines the default mirrored mode
1397 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1399 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1402 * Returns the widget's mirrored mode setting.
1404 * @param obj The widget.
1405 * @return mirrored mode setting of the object.
1408 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1411 * Sets the widget's mirrored mode setting.
1412 * When widget in automatic mode, it follows the system mirrored mode set by
1413 * elm_mirrored_set().
1414 * @param obj The widget.
1415 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1417 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1424 * Set the style to use by a widget
1426 * Sets the style name that will define the appearance of a widget. Styles
1427 * vary from widget to widget and may also be defined by other themes
1428 * by means of extensions and overlays.
1430 * @param obj The Elementary widget to style
1431 * @param style The style name to use
1433 * @see elm_theme_extension_add()
1434 * @see elm_theme_extension_del()
1435 * @see elm_theme_overlay_add()
1436 * @see elm_theme_overlay_del()
1440 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1442 * Get the style used by the widget
1444 * This gets the style being used for that widget. Note that the string
1445 * pointer is only valid as longas the object is valid and the style doesn't
1448 * @param obj The Elementary widget to query for its style
1449 * @return The style name used
1451 * @see elm_object_style_set()
1455 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1458 * @defgroup Styles Styles
1460 * Widgets can have different styles of look. These generic API's
1461 * set styles of widgets, if they support them (and if the theme(s)
1464 * @ref general_functions_example_page "This" example contemplates
1465 * some of these functions.
1469 * Set the disabled state of an Elementary object.
1471 * @param obj The Elementary object to operate on
1472 * @param disabled The state to put in in: @c EINA_TRUE for
1473 * disabled, @c EINA_FALSE for enabled
1475 * Elementary objects can be @b disabled, in which state they won't
1476 * receive input and, in general, will be themed differently from
1477 * their normal state, usually greyed out. Useful for contexts
1478 * where you don't want your users to interact with some of the
1479 * parts of you interface.
1481 * This sets the state for the widget, either disabling it or
1486 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1489 * Get the disabled state of an Elementary object.
1491 * @param obj The Elementary object to operate on
1492 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1493 * if it's enabled (or on errors)
1495 * This gets the state of the widget, which might be enabled or disabled.
1499 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1502 * @defgroup WidgetNavigation Widget Tree Navigation.
1504 * How to check if an Evas Object is an Elementary widget? How to
1505 * get the first elementary widget that is parent of the given
1506 * object? These are all covered in widget tree navigation.
1508 * @ref general_functions_example_page "This" example contemplates
1509 * some of these functions.
1513 * Check if the given Evas Object is an Elementary widget.
1515 * @param obj the object to query.
1516 * @return @c EINA_TRUE if it is an elementary widget variant,
1517 * @c EINA_FALSE otherwise
1518 * @ingroup WidgetNavigation
1520 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1523 * Get the first parent of the given object that is an Elementary
1526 * @param obj the Elementary object to query parent from.
1527 * @return the parent object that is an Elementary widget, or @c
1528 * NULL, if it was not found.
1530 * Use this to query for an object's parent widget.
1532 * @note Most of Elementary users wouldn't be mixing non-Elementary
1533 * smart objects in the objects tree of an application, as this is
1534 * an advanced usage of Elementary with Evas. So, except for the
1535 * application's window, which is the root of that tree, all other
1536 * objects would have valid Elementary widget parents.
1538 * @ingroup WidgetNavigation
1540 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1543 * Get the top level parent of an Elementary widget.
1545 * @param obj The object to query.
1546 * @return The top level Elementary widget, or @c NULL if parent cannot be
1548 * @ingroup WidgetNavigation
1550 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1553 * Get the string that represents this Elementary widget.
1555 * @note Elementary is weird and exposes itself as a single
1556 * Evas_Object_Smart_Class of type "elm_widget", so
1557 * evas_object_type_get() always return that, making debug and
1558 * language bindings hard. This function tries to mitigate this
1559 * problem, but the solution is to change Elementary to use
1560 * proper inheritance.
1562 * @param obj the object to query.
1563 * @return Elementary widget name, or @c NULL if not a valid widget.
1564 * @ingroup WidgetNavigation
1566 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1569 * @defgroup Config Elementary Config
1571 * Elementary configuration is formed by a set options bounded to a
1572 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1573 * "finger size", etc. These are functions with which one syncronizes
1574 * changes made to those values to the configuration storing files, de
1575 * facto. You most probably don't want to use the functions in this
1576 * group unlees you're writing an elementary configuration manager.
1582 * Save back Elementary's configuration, so that it will persist on
1585 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1588 * This function will take effect -- thus, do I/O -- immediately. Use
1589 * it when you want to apply all configuration changes at once. The
1590 * current configuration set will get saved onto the current profile
1591 * configuration file.
1594 EAPI Eina_Bool elm_config_save(void);
1597 * Reload Elementary's configuration, bounded to current selected
1600 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1603 * Useful when you want to force reloading of configuration values for
1604 * a profile. If one removes user custom configuration directories,
1605 * for example, it will force a reload with system values insted.
1608 EAPI void elm_config_reload(void);
1615 * @defgroup Profile Elementary Profile
1617 * Profiles are pre-set options that affect the whole look-and-feel of
1618 * Elementary-based applications. There are, for example, profiles
1619 * aimed at desktop computer applications and others aimed at mobile,
1620 * touchscreen-based ones. You most probably don't want to use the
1621 * functions in this group unlees you're writing an elementary
1622 * configuration manager.
1628 * Get Elementary's profile in use.
1630 * This gets the global profile that is applied to all Elementary
1633 * @return The profile's name
1636 EAPI const char *elm_profile_current_get(void);
1639 * Get an Elementary's profile directory path in the filesystem. One
1640 * may want to fetch a system profile's dir or an user one (fetched
1643 * @param profile The profile's name
1644 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1645 * or a system one (@c EINA_FALSE)
1646 * @return The profile's directory path.
1649 * @note You must free it with elm_profile_dir_free().
1651 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1654 * Free an Elementary's profile directory path, as returned by
1655 * elm_profile_dir_get().
1657 * @param p_dir The profile's path
1661 EAPI void elm_profile_dir_free(const char *p_dir);
1664 * Get Elementary's list of available profiles.
1666 * @return The profiles list. List node data are the profile name
1670 * @note One must free this list, after usage, with the function
1671 * elm_profile_list_free().
1673 EAPI Eina_List *elm_profile_list_get(void);
1676 * Free Elementary's list of available profiles.
1678 * @param l The profiles list, as returned by elm_profile_list_get().
1682 EAPI void elm_profile_list_free(Eina_List *l);
1685 * Set Elementary's profile.
1687 * This sets the global profile that is applied to Elementary
1688 * applications. Just the process the call comes from will be
1691 * @param profile The profile's name
1695 EAPI void elm_profile_set(const char *profile);
1698 * Set Elementary's profile.
1700 * This sets the global profile that is applied to all Elementary
1701 * applications. All running Elementary windows will be affected.
1703 * @param profile The profile's name
1707 EAPI void elm_profile_all_set(const char *profile);
1714 * @defgroup Engine Elementary Engine
1716 * These are functions setting and querying which rendering engine
1717 * Elementary will use for drawing its windows' pixels.
1719 * The following are the available engines:
1720 * @li "software_x11"
1723 * @li "software_16_x11"
1724 * @li "software_8_x11"
1727 * @li "software_gdi"
1728 * @li "software_16_wince_gdi"
1730 * @li "software_16_sdl"
1738 * @brief Get Elementary's rendering engine in use.
1740 * @return The rendering engine's name
1741 * @note there's no need to free the returned string, here.
1743 * This gets the global rendering engine that is applied to all Elementary
1746 * @see elm_engine_set()
1748 EAPI const char *elm_engine_current_get(void);
1751 * @brief Set Elementary's rendering engine for use.
1753 * @param engine The rendering engine's name
1755 * This sets global rendering engine that is applied to all Elementary
1756 * applications. Note that it will take effect only to Elementary windows
1757 * created after this is called.
1759 * @see elm_win_add()
1761 EAPI void elm_engine_set(const char *engine);
1768 * @defgroup Fonts Elementary Fonts
1770 * These are functions dealing with font rendering, selection and the
1771 * like for Elementary applications. One might fetch which system
1772 * fonts are there to use and set custom fonts for individual classes
1773 * of UI items containing text (text classes).
1778 typedef struct _Elm_Text_Class
1784 typedef struct _Elm_Font_Overlay
1786 const char *text_class;
1788 Evas_Font_Size size;
1791 typedef struct _Elm_Font_Properties
1795 } Elm_Font_Properties;
1798 * Get Elementary's list of supported text classes.
1800 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1803 * Release the list with elm_text_classes_list_free().
1805 EAPI const Eina_List *elm_text_classes_list_get(void);
1808 * Free Elementary's list of supported text classes.
1812 * @see elm_text_classes_list_get().
1814 EAPI void elm_text_classes_list_free(const Eina_List *list);
1817 * Get Elementary's list of font overlays, set with
1818 * elm_font_overlay_set().
1820 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1825 * For each text class, one can set a <b>font overlay</b> for it,
1826 * overriding the default font properties for that class coming from
1827 * the theme in use. There is no need to free this list.
1829 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1831 EAPI const Eina_List *elm_font_overlay_list_get(void);
1834 * Set a font overlay for a given Elementary text class.
1836 * @param text_class Text class name
1837 * @param font Font name and style string
1838 * @param size Font size
1842 * @p font has to be in the format returned by
1843 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1844 * and elm_font_overlay_unset().
1846 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1849 * Unset a font overlay for a given Elementary text class.
1851 * @param text_class Text class name
1855 * This will bring back text elements belonging to text class
1856 * @p text_class back to their default font settings.
1858 EAPI void elm_font_overlay_unset(const char *text_class);
1861 * Apply the changes made with elm_font_overlay_set() and
1862 * elm_font_overlay_unset() on the current Elementary window.
1866 * This applies all font overlays set to all objects in the UI.
1868 EAPI void elm_font_overlay_apply(void);
1871 * Apply the changes made with elm_font_overlay_set() and
1872 * elm_font_overlay_unset() on all Elementary application windows.
1876 * This applies all font overlays set to all objects in the UI.
1878 EAPI void elm_font_overlay_all_apply(void);
1881 * Translate a font (family) name string in fontconfig's font names
1882 * syntax into an @c Elm_Font_Properties struct.
1884 * @param font The font name and styles string
1885 * @return the font properties struct
1889 * @note The reverse translation can be achived with
1890 * elm_font_fontconfig_name_get(), for one style only (single font
1891 * instance, not family).
1893 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1896 * Free font properties return by elm_font_properties_get().
1898 * @param efp the font properties struct
1902 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1905 * Translate a font name, bound to a style, into fontconfig's font names
1908 * @param name The font (family) name
1909 * @param style The given style (may be @c NULL)
1911 * @return the font name and style string
1915 * @note The reverse translation can be achived with
1916 * elm_font_properties_get(), for one style only (single font
1917 * instance, not family).
1919 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1922 * Free the font string return by elm_font_fontconfig_name_get().
1924 * @param efp the font properties struct
1928 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1931 * Create a font hash table of available system fonts.
1933 * One must call it with @p list being the return value of
1934 * evas_font_available_list(). The hash will be indexed by font
1935 * (family) names, being its values @c Elm_Font_Properties blobs.
1937 * @param list The list of available system fonts, as returned by
1938 * evas_font_available_list().
1939 * @return the font hash.
1943 * @note The user is supposed to get it populated at least with 3
1944 * default font families (Sans, Serif, Monospace), which should be
1945 * present on most systems.
1947 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1950 * Free the hash return by elm_font_available_hash_add().
1952 * @param hash the hash to be freed.
1956 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1963 * @defgroup Fingers Fingers
1965 * Elementary is designed to be finger-friendly for touchscreens,
1966 * and so in addition to scaling for display resolution, it can
1967 * also scale based on finger "resolution" (or size). You can then
1968 * customize the granularity of the areas meant to receive clicks
1971 * Different profiles may have pre-set values for finger sizes.
1973 * @ref general_functions_example_page "This" example contemplates
1974 * some of these functions.
1980 * Get the configured "finger size"
1982 * @return The finger size
1984 * This gets the globally configured finger size, <b>in pixels</b>
1988 EAPI Evas_Coord elm_finger_size_get(void);
1991 * Set the configured finger size
1993 * This sets the globally configured finger size in pixels
1995 * @param size The finger size
1998 EAPI void elm_finger_size_set(Evas_Coord size);
2001 * Set the configured finger size for all applications on the display
2003 * This sets the globally configured finger size in pixels for all
2004 * applications on the display
2006 * @param size The finger size
2009 EAPI void elm_finger_size_all_set(Evas_Coord size);
2016 * @defgroup Focus Focus
2018 * An Elementary application has, at all times, one (and only one)
2019 * @b focused object. This is what determines where the input
2020 * events go to within the application's window. Also, focused
2021 * objects can be decorated differently, in order to signal to the
2022 * user where the input is, at a given moment.
2024 * Elementary applications also have the concept of <b>focus
2025 * chain</b>: one can cycle through all the windows' focusable
2026 * objects by input (tab key) or programmatically. The default
2027 * focus chain for an application is the one define by the order in
2028 * which the widgets where added in code. One will cycle through
2029 * top level widgets, and, for each one containg sub-objects, cycle
2030 * through them all, before returning to the level
2031 * above. Elementary also allows one to set @b custom focus chains
2032 * for their applications.
2034 * Besides the focused decoration a widget may exhibit, when it
2035 * gets focus, Elementary has a @b global focus highlight object
2036 * that can be enabled for a window. If one chooses to do so, this
2037 * extra highlight effect will surround the current focused object,
2040 * @note Some Elementary widgets are @b unfocusable, after
2041 * creation, by their very nature: they are not meant to be
2042 * interacted with input events, but are there just for visual
2045 * @ref general_functions_example_page "This" example contemplates
2046 * some of these functions.
2050 * Get the enable status of the focus highlight
2052 * This gets whether the highlight on focused objects is enabled or not
2055 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2058 * Set the enable status of the focus highlight
2060 * Set whether to show or not the highlight on focused objects
2061 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2064 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2067 * Get the enable status of the highlight animation
2069 * Get whether the focus highlight, if enabled, will animate its switch from
2070 * one object to the next
2073 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2076 * Set the enable status of the highlight animation
2078 * Set whether the focus highlight, if enabled, will animate its switch from
2079 * one object to the next
2080 * @param animate Enable animation if EINA_TRUE, disable otherwise
2083 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2086 * Get the whether an Elementary object has the focus or not.
2088 * @param obj The Elementary object to get the information from
2089 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2090 * not (and on errors).
2092 * @see elm_object_focus_set()
2096 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2099 * Set/unset focus to a given Elementary object.
2101 * @param obj The Elementary object to operate on.
2102 * @param enable @c EINA_TRUE Set focus to a given object,
2103 * @c EINA_FALSE Unset focus to a given object.
2105 * @note When you set focus to this object, if it can handle focus, will
2106 * take the focus away from the one who had it previously and will, for
2107 * now on, be the one receiving input events. Unsetting focus will remove
2108 * the focus from @p obj, passing it back to the previous element in the
2111 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2115 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2118 * Make a given Elementary object the focused one.
2120 * @param obj The Elementary object to make focused.
2122 * @note This object, if it can handle focus, will take the focus
2123 * away from the one who had it previously and will, for now on, be
2124 * the one receiving input events.
2126 * @see elm_object_focus_get()
2127 * @deprecated use elm_object_focus_set() instead.
2131 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2134 * Remove the focus from an Elementary object
2136 * @param obj The Elementary to take focus from
2138 * This removes the focus from @p obj, passing it back to the
2139 * previous element in the focus chain list.
2141 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2142 * @deprecated use elm_object_focus_set() instead.
2146 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2149 * Set the ability for an Element object to be focused
2151 * @param obj The Elementary object to operate on
2152 * @param enable @c EINA_TRUE if the object can be focused, @c
2153 * EINA_FALSE if not (and on errors)
2155 * This sets whether the object @p obj is able to take focus or
2156 * not. Unfocusable objects do nothing when programmatically
2157 * focused, being the nearest focusable parent object the one
2158 * really getting focus. Also, when they receive mouse input, they
2159 * will get the event, but not take away the focus from where it
2164 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2167 * Get whether an Elementary object is focusable or not
2169 * @param obj The Elementary object to operate on
2170 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2171 * EINA_FALSE if not (and on errors)
2173 * @note Objects which are meant to be interacted with by input
2174 * events are created able to be focused, by default. All the
2179 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2182 * Set custom focus chain.
2184 * This function overwrites any previous custom focus chain within
2185 * the list of objects. The previous list will be deleted and this list
2186 * will be managed by elementary. After it is set, don't modify it.
2188 * @note On focus cycle, only will be evaluated children of this container.
2190 * @param obj The container object
2191 * @param objs Chain of objects to pass focus
2194 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2197 * Unset custom focus chain
2199 * @param obj The container object
2202 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2205 * Get custom focus chain
2207 * @param obj The container object
2210 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2213 * Append object to custom focus chain.
2215 * @note If relative_child equal to NULL or not in custom chain, the object
2216 * will be added in end.
2218 * @note On focus cycle, only will be evaluated children of this container.
2220 * @param obj The container object
2221 * @param child The child to be added in custom chain
2222 * @param relative_child The relative object to position the child
2225 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2228 * Prepend object to custom focus chain.
2230 * @note If relative_child equal to NULL or not in custom chain, the object
2231 * will be added in begin.
2233 * @note On focus cycle, only will be evaluated children of this container.
2235 * @param obj The container object
2236 * @param child The child to be added in custom chain
2237 * @param relative_child The relative object to position the child
2240 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2243 * Give focus to next object in object tree.
2245 * Give focus to next object in focus chain of one object sub-tree.
2246 * If the last object of chain already have focus, the focus will go to the
2247 * first object of chain.
2249 * @param obj The object root of sub-tree
2250 * @param dir Direction to cycle the focus
2254 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2257 * Give focus to near object in one direction.
2259 * Give focus to near object in direction of one object.
2260 * If none focusable object in given direction, the focus will not change.
2262 * @param obj The reference object
2263 * @param x Horizontal component of direction to focus
2264 * @param y Vertical component of direction to focus
2268 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2271 * Make the elementary object and its children to be unfocusable
2274 * @param obj The Elementary object to operate on
2275 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2276 * @c EINA_FALSE for focusable.
2278 * This sets whether the object @p obj and its children objects
2279 * are able to take focus or not. If the tree is set as unfocusable,
2280 * newest focused object which is not in this tree will get focus.
2281 * This API can be helpful for an object to be deleted.
2282 * When an object will be deleted soon, it and its children may not
2283 * want to get focus (by focus reverting or by other focus controls).
2284 * Then, just use this API before deleting.
2286 * @see elm_object_tree_unfocusable_get()
2290 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2293 * Get whether an Elementary object and its children are unfocusable or not.
2295 * @param obj The Elementary object to get the information from
2296 * @return @c EINA_TRUE, if the tree is unfocussable,
2297 * @c EINA_FALSE if not (and on errors).
2299 * @see elm_object_tree_unfocusable_set()
2303 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2306 * @defgroup Scrolling Scrolling
2308 * These are functions setting how scrollable views in Elementary
2309 * widgets should behave on user interaction.
2315 * Get whether scrollers should bounce when they reach their
2316 * viewport's edge during a scroll.
2318 * @return the thumb scroll bouncing state
2320 * This is the default behavior for touch screens, in general.
2321 * @ingroup Scrolling
2323 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2326 * Set whether scrollers should bounce when they reach their
2327 * viewport's edge during a scroll.
2329 * @param enabled the thumb scroll bouncing state
2331 * @see elm_thumbscroll_bounce_enabled_get()
2332 * @ingroup Scrolling
2334 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2337 * Set whether scrollers should bounce when they reach their
2338 * viewport's edge during a scroll, for all Elementary application
2341 * @param enabled the thumb scroll bouncing state
2343 * @see elm_thumbscroll_bounce_enabled_get()
2344 * @ingroup Scrolling
2346 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2349 * Get the amount of inertia a scroller will impose at bounce
2352 * @return the thumb scroll bounce friction
2354 * @ingroup Scrolling
2356 EAPI double elm_scroll_bounce_friction_get(void);
2359 * Set the amount of inertia a scroller will impose at bounce
2362 * @param friction the thumb scroll bounce friction
2364 * @see elm_thumbscroll_bounce_friction_get()
2365 * @ingroup Scrolling
2367 EAPI void elm_scroll_bounce_friction_set(double friction);
2370 * Set the amount of inertia a scroller will impose at bounce
2371 * animations, for all Elementary application windows.
2373 * @param friction the thumb scroll bounce friction
2375 * @see elm_thumbscroll_bounce_friction_get()
2376 * @ingroup Scrolling
2378 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2381 * Get the amount of inertia a <b>paged</b> scroller will impose at
2382 * page fitting animations.
2384 * @return the page scroll friction
2386 * @ingroup Scrolling
2388 EAPI double elm_scroll_page_scroll_friction_get(void);
2391 * Set the amount of inertia a <b>paged</b> scroller will impose at
2392 * page fitting animations.
2394 * @param friction the page scroll friction
2396 * @see elm_thumbscroll_page_scroll_friction_get()
2397 * @ingroup Scrolling
2399 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2402 * Set the amount of inertia a <b>paged</b> scroller will impose at
2403 * page fitting animations, for all Elementary application windows.
2405 * @param friction the page scroll friction
2407 * @see elm_thumbscroll_page_scroll_friction_get()
2408 * @ingroup Scrolling
2410 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2413 * Get the amount of inertia a scroller will impose at region bring
2416 * @return the bring in scroll friction
2418 * @ingroup Scrolling
2420 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2423 * Set the amount of inertia a scroller will impose at region bring
2426 * @param friction the bring in scroll friction
2428 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2429 * @ingroup Scrolling
2431 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2434 * Set the amount of inertia a scroller will impose at region bring
2435 * animations, for all Elementary application windows.
2437 * @param friction the bring in scroll friction
2439 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2440 * @ingroup Scrolling
2442 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2445 * Get the amount of inertia scrollers will impose at animations
2446 * triggered by Elementary widgets' zooming API.
2448 * @return the zoom friction
2450 * @ingroup Scrolling
2452 EAPI double elm_scroll_zoom_friction_get(void);
2455 * Set the amount of inertia scrollers will impose at animations
2456 * triggered by Elementary widgets' zooming API.
2458 * @param friction the zoom friction
2460 * @see elm_thumbscroll_zoom_friction_get()
2461 * @ingroup Scrolling
2463 EAPI void elm_scroll_zoom_friction_set(double friction);
2466 * Set the amount of inertia scrollers will impose at animations
2467 * triggered by Elementary widgets' zooming API, for all Elementary
2468 * application windows.
2470 * @param friction the zoom friction
2472 * @see elm_thumbscroll_zoom_friction_get()
2473 * @ingroup Scrolling
2475 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2478 * Get whether scrollers should be draggable from any point in their
2481 * @return the thumb scroll state
2483 * @note This is the default behavior for touch screens, in general.
2484 * @note All other functions namespaced with "thumbscroll" will only
2485 * have effect if this mode is enabled.
2487 * @ingroup Scrolling
2489 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2492 * Set whether scrollers should be draggable from any point in their
2495 * @param enabled the thumb scroll state
2497 * @see elm_thumbscroll_enabled_get()
2498 * @ingroup Scrolling
2500 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2503 * Set whether scrollers should be draggable from any point in their
2504 * views, for all Elementary application windows.
2506 * @param enabled the thumb scroll state
2508 * @see elm_thumbscroll_enabled_get()
2509 * @ingroup Scrolling
2511 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2514 * Get the number of pixels one should travel while dragging a
2515 * scroller's view to actually trigger scrolling.
2517 * @return the thumb scroll threshould
2519 * One would use higher values for touch screens, in general, because
2520 * of their inherent imprecision.
2521 * @ingroup Scrolling
2523 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2526 * Set the number of pixels one should travel while dragging a
2527 * scroller's view to actually trigger scrolling.
2529 * @param threshold the thumb scroll threshould
2531 * @see elm_thumbscroll_threshould_get()
2532 * @ingroup Scrolling
2534 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2537 * Set the number of pixels one should travel while dragging a
2538 * scroller's view to actually trigger scrolling, for all Elementary
2539 * application windows.
2541 * @param threshold the thumb scroll threshould
2543 * @see elm_thumbscroll_threshould_get()
2544 * @ingroup Scrolling
2546 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2549 * Get the minimum speed of mouse cursor movement which will trigger
2550 * list self scrolling animation after a mouse up event
2553 * @return the thumb scroll momentum threshould
2555 * @ingroup Scrolling
2557 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2560 * Set the minimum speed of mouse cursor movement which will trigger
2561 * list self scrolling animation after a mouse up event
2564 * @param threshold the thumb scroll momentum threshould
2566 * @see elm_thumbscroll_momentum_threshould_get()
2567 * @ingroup Scrolling
2569 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2572 * Set the minimum speed of mouse cursor movement which will trigger
2573 * list self scrolling animation after a mouse up event
2574 * (pixels/second), for all Elementary application windows.
2576 * @param threshold the thumb scroll momentum threshould
2578 * @see elm_thumbscroll_momentum_threshould_get()
2579 * @ingroup Scrolling
2581 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2584 * Get the amount of inertia a scroller will impose at self scrolling
2587 * @return the thumb scroll friction
2589 * @ingroup Scrolling
2591 EAPI double elm_scroll_thumbscroll_friction_get(void);
2594 * Set the amount of inertia a scroller will impose at self scrolling
2597 * @param friction the thumb scroll friction
2599 * @see elm_thumbscroll_friction_get()
2600 * @ingroup Scrolling
2602 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2605 * Set the amount of inertia a scroller will impose at self scrolling
2606 * animations, for all Elementary application windows.
2608 * @param friction the thumb scroll friction
2610 * @see elm_thumbscroll_friction_get()
2611 * @ingroup Scrolling
2613 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2616 * Get the amount of lag between your actual mouse cursor dragging
2617 * movement and a scroller's view movement itself, while pushing it
2618 * into bounce state manually.
2620 * @return the thumb scroll border friction
2622 * @ingroup Scrolling
2624 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2627 * Set the amount of lag between your actual mouse cursor dragging
2628 * movement and a scroller's view movement itself, while pushing it
2629 * into bounce state manually.
2631 * @param friction the thumb scroll border friction. @c 0.0 for
2632 * perfect synchrony between two movements, @c 1.0 for maximum
2635 * @see elm_thumbscroll_border_friction_get()
2636 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2638 * @ingroup Scrolling
2640 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2643 * Set the amount of lag between your actual mouse cursor dragging
2644 * movement and a scroller's view movement itself, while pushing it
2645 * into bounce state manually, for all Elementary application windows.
2647 * @param friction the thumb scroll border friction. @c 0.0 for
2648 * perfect synchrony between two movements, @c 1.0 for maximum
2651 * @see elm_thumbscroll_border_friction_get()
2652 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2654 * @ingroup Scrolling
2656 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2663 * @defgroup Scrollhints Scrollhints
2665 * Objects when inside a scroller can scroll, but this may not always be
2666 * desirable in certain situations. This allows an object to hint to itself
2667 * and parents to "not scroll" in one of 2 ways. If any chilkd object of a
2668 * scroller has pushed a scroll freeze or hold then it affects all parent
2669 * scrollers until all children have released them.
2671 * 1. To hold on scrolling. This means just flicking and dragging may no
2672 * longer scroll, but pressing/dragging near an edge of the scroller will
2673 * still scroll. This is automatically used by the entry object when
2676 * 2. To totally freeze scrolling. This means it stops. until
2683 * Push the scroll hold by 1
2685 * This increments the scroll hold count by one. If it is more than 0 it will
2686 * take effect on the parents of the indicated object.
2688 * @param obj The object
2689 * @ingroup Scrollhints
2691 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2694 * Pop the scroll hold by 1
2696 * This decrements the scroll hold count by one. If it is more than 0 it will
2697 * take effect on the parents of the indicated object.
2699 * @param obj The object
2700 * @ingroup Scrollhints
2702 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2705 * Push the scroll freeze by 1
2707 * This increments the scroll freeze count by one. If it is more
2708 * than 0 it will take effect on the parents of the indicated
2711 * @param obj The object
2712 * @ingroup Scrollhints
2714 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2717 * Pop the scroll freeze by 1
2719 * This decrements the scroll freeze count by one. If it is more
2720 * than 0 it will take effect on the parents of the indicated
2723 * @param obj The object
2724 * @ingroup Scrollhints
2726 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2729 * Lock the scrolling of the given widget (and thus all parents)
2731 * This locks the given object from scrolling in the X axis (and implicitly
2732 * also locks all parent scrollers too from doing the same).
2734 * @param obj The object
2735 * @param lock The lock state (1 == locked, 0 == unlocked)
2736 * @ingroup Scrollhints
2738 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2741 * Lock the scrolling of the given widget (and thus all parents)
2743 * This locks the given object from scrolling in the Y axis (and implicitly
2744 * also locks all parent scrollers too from doing the same).
2746 * @param obj The object
2747 * @param lock The lock state (1 == locked, 0 == unlocked)
2748 * @ingroup Scrollhints
2750 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2753 * Get the scrolling lock of the given widget
2755 * This gets the lock for X axis scrolling.
2757 * @param obj The object
2758 * @ingroup Scrollhints
2760 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2763 * Get the scrolling lock of the given widget
2765 * This gets the lock for X axis scrolling.
2767 * @param obj The object
2768 * @ingroup Scrollhints
2770 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2777 * Send a signal to the widget edje object.
2779 * This function sends a signal to the edje object of the obj. An
2780 * edje program can respond to a signal by specifying matching
2781 * 'signal' and 'source' fields.
2783 * @param obj The object
2784 * @param emission The signal's name.
2785 * @param source The signal's source.
2788 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2791 * Add a callback for a signal emitted by widget edje object.
2793 * This function connects a callback function to a signal emitted by the
2794 * edje object of the obj.
2795 * Globs can occur in either the emission or source name.
2797 * @param obj The object
2798 * @param emission The signal's name.
2799 * @param source The signal's source.
2800 * @param func The callback function to be executed when the signal is
2802 * @param data A pointer to data to pass in to the callback function.
2805 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);
2808 * Remove a signal-triggered callback from an widget edje object.
2810 * This function removes a callback, previoulsy attached to a
2811 * signal emitted by the edje object of the obj. The parameters
2812 * emission, source and func must match exactly those passed to a
2813 * previous call to elm_object_signal_callback_add(). The data
2814 * pointer that was passed to this call will be returned.
2816 * @param obj The object
2817 * @param emission The signal's name.
2818 * @param source The signal's source.
2819 * @param func The callback function to be executed when the signal is
2821 * @return The data pointer
2824 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);
2827 * Add a callback for a event emitted by widget or their children.
2829 * This function connects a callback function to any key_down key_up event
2830 * emitted by the @p obj or their children.
2831 * This only will be called if no other callback has consumed the event.
2832 * If you want consume the event, and no other get it, func should return
2833 * EINA_TRUE and put EVAS_EVENT_FLAG_ON_HOLD in event_flags.
2835 * @warning Accept duplicated callback addition.
2837 * @param obj The object
2838 * @param func The callback function to be executed when the event is
2840 * @param data Data to pass in to the callback function.
2843 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2846 * Remove a event callback from an widget.
2848 * This function removes a callback, previoulsy attached to event emission
2850 * The parameters func and data must match exactly those passed to
2851 * a previous call to elm_object_event_callback_add(). The data pointer that
2852 * was passed to this call will be returned.
2854 * @param obj The object
2855 * @param func The callback function to be executed when the event is
2857 * @param data Data to pass in to the callback function.
2858 * @return The data pointer
2861 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2864 * Adjust size of an element for finger usage.
2866 * @param times_w How many fingers should fit horizontally
2867 * @param w Pointer to the width size to adjust
2868 * @param times_h How many fingers should fit vertically
2869 * @param h Pointer to the height size to adjust
2871 * This takes width and height sizes (in pixels) as input and a
2872 * size multiple (which is how many fingers you want to place
2873 * within the area, being "finger" the size set by
2874 * elm_finger_size_set()), and adjusts the size to be large enough
2875 * to accommodate the resulting size -- if it doesn't already
2876 * accommodate it. On return the @p w and @p h sizes pointed to by
2877 * these parameters will be modified, on those conditions.
2879 * @note This is kind of a low level Elementary call, most useful
2880 * on size evaluation times for widgets. An external user wouldn't
2881 * be calling, most of the time.
2885 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2888 * Get the duration for occuring long press event.
2890 * @return Timeout for long press event
2891 * @ingroup Longpress
2893 EAPI double elm_longpress_timeout_get(void);
2896 * Set the duration for occuring long press event.
2898 * @param lonpress_timeout Timeout for long press event
2899 * @ingroup Longpress
2901 EAPI void elm_longpress_timeout_set(double longpress_timeout);
2904 * @defgroup Debug Debug
2905 * don't use it unless you are sure
2911 * Print Tree object hierarchy in stdout
2913 * @param obj The root object
2916 EAPI void elm_object_tree_dump(const Evas_Object *top);
2919 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2921 * @param obj The root object
2922 * @param file The path of output file
2925 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2932 * @defgroup Theme Theme
2934 * Elementary uses Edje to theme its widgets, naturally. But for the most
2935 * part this is hidden behind a simpler interface that lets the user set
2936 * extensions and choose the style of widgets in a much easier way.
2938 * Instead of thinking in terms of paths to Edje files and their groups
2939 * each time you want to change the appearance of a widget, Elementary
2940 * works so you can add any theme file with extensions or replace the
2941 * main theme at one point in the application, and then just set the style
2942 * of widgets with elm_object_style_set() and related functions. Elementary
2943 * will then look in its list of themes for a matching group and apply it,
2944 * and when the theme changes midway through the application, all widgets
2945 * will be updated accordingly.
2947 * There are three concepts you need to know to understand how Elementary
2948 * theming works: default theme, extensions and overlays.
2950 * Default theme, obviously enough, is the one that provides the default
2951 * look of all widgets. End users can change the theme used by Elementary
2952 * by setting the @c ELM_THEME environment variable before running an
2953 * application, or globally for all programs using the @c elementary_config
2954 * utility. Applications can change the default theme using elm_theme_set(),
2955 * but this can go against the user wishes, so it's not an adviced practice.
2957 * Ideally, applications should find everything they need in the already
2958 * provided theme, but there may be occasions when that's not enough and
2959 * custom styles are required to correctly express the idea. For this
2960 * cases, Elementary has extensions.
2962 * Extensions allow the application developer to write styles of its own
2963 * to apply to some widgets. This requires knowledge of how each widget
2964 * is themed, as extensions will always replace the entire group used by
2965 * the widget, so important signals and parts need to be there for the
2966 * object to behave properly (see documentation of Edje for details).
2967 * Once the theme for the extension is done, the application needs to add
2968 * it to the list of themes Elementary will look into, using
2969 * elm_theme_extension_add(), and set the style of the desired widgets as
2970 * he would normally with elm_object_style_set().
2972 * Overlays, on the other hand, can replace the look of all widgets by
2973 * overriding the default style. Like extensions, it's up to the application
2974 * developer to write the theme for the widgets it wants, the difference
2975 * being that when looking for the theme, Elementary will check first the
2976 * list of overlays, then the set theme and lastly the list of extensions,
2977 * so with overlays it's possible to replace the default view and every
2978 * widget will be affected. This is very much alike to setting the whole
2979 * theme for the application and will probably clash with the end user
2980 * options, not to mention the risk of ending up with not matching styles
2981 * across the program. Unless there's a very special reason to use them,
2982 * overlays should be avoided for the resons exposed before.
2984 * All these theme lists are handled by ::Elm_Theme instances. Elementary
2985 * keeps one default internally and every function that receives one of
2986 * these can be called with NULL to refer to this default (except for
2987 * elm_theme_free()). It's possible to create a new instance of a
2988 * ::Elm_Theme to set other theme for a specific widget (and all of its
2989 * children), but this is as discouraged, if not even more so, than using
2990 * overlays. Don't use this unless you really know what you are doing.
2992 * But to be less negative about things, you can look at the following
2994 * @li @ref theme_example_01 "Using extensions"
2995 * @li @ref theme_example_02 "Using overlays"
3000 * @typedef Elm_Theme
3002 * Opaque handler for the list of themes Elementary looks for when
3003 * rendering widgets.
3005 * Stay out of this unless you really know what you are doing. For most
3006 * cases, sticking to the default is all a developer needs.
3008 typedef struct _Elm_Theme Elm_Theme;
3011 * Create a new specific theme
3013 * This creates an empty specific theme that only uses the default theme. A
3014 * specific theme has its own private set of extensions and overlays too
3015 * (which are empty by default). Specific themes do not fall back to themes
3016 * of parent objects. They are not intended for this use. Use styles, overlays
3017 * and extensions when needed, but avoid specific themes unless there is no
3018 * other way (example: you want to have a preview of a new theme you are
3019 * selecting in a "theme selector" window. The preview is inside a scroller
3020 * and should display what the theme you selected will look like, but not
3021 * actually apply it yet. The child of the scroller will have a specific
3022 * theme set to show this preview before the user decides to apply it to all
3025 EAPI Elm_Theme *elm_theme_new(void);
3027 * Free a specific theme
3029 * @param th The theme to free
3031 * This frees a theme created with elm_theme_new().
3033 EAPI void elm_theme_free(Elm_Theme *th);
3035 * Copy the theme fom the source to the destination theme
3037 * @param th The source theme to copy from
3038 * @param thdst The destination theme to copy data to
3040 * This makes a one-time static copy of all the theme config, extensions
3041 * and overlays from @p th to @p thdst. If @p th references a theme, then
3042 * @p thdst is also set to reference it, with all the theme settings,
3043 * overlays and extensions that @p th had.
3045 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3047 * Tell the source theme to reference the ref theme
3049 * @param th The theme that will do the referencing
3050 * @param thref The theme that is the reference source
3052 * This clears @p th to be empty and then sets it to refer to @p thref
3053 * so @p th acts as an override to @p thref, but where its overrides
3054 * don't apply, it will fall through to @p thref for configuration.
3056 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3058 * Return the theme referred to
3060 * @param th The theme to get the reference from
3061 * @return The referenced theme handle
3063 * This gets the theme set as the reference theme by elm_theme_ref_set().
3064 * If no theme is set as a reference, NULL is returned.
3066 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3068 * Return the default theme
3070 * @return The default theme handle
3072 * This returns the internal default theme setup handle that all widgets
3073 * use implicitly unless a specific theme is set. This is also often use
3074 * as a shorthand of NULL.
3076 EAPI Elm_Theme *elm_theme_default_get(void);
3078 * Prepends a theme overlay to the list of overlays
3080 * @param th The theme to add to, or if NULL, the default theme
3081 * @param item The Edje file path to be used
3083 * Use this if your application needs to provide some custom overlay theme
3084 * (An Edje file that replaces some default styles of widgets) where adding
3085 * new styles, or changing system theme configuration is not possible. Do
3086 * NOT use this instead of a proper system theme configuration. Use proper
3087 * configuration files, profiles, environment variables etc. to set a theme
3088 * so that the theme can be altered by simple confiugration by a user. Using
3089 * this call to achieve that effect is abusing the API and will create lots
3092 * @see elm_theme_extension_add()
3094 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3096 * Delete a theme overlay from the list of overlays
3098 * @param th The theme to delete from, or if NULL, the default theme
3099 * @param item The name of the theme overlay
3101 * @see elm_theme_overlay_add()
3103 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3105 * Appends a theme extension to the list of extensions.
3107 * @param th The theme to add to, or if NULL, the default theme
3108 * @param item The Edje file path to be used
3110 * This is intended when an application needs more styles of widgets or new
3111 * widget themes that the default does not provide (or may not provide). The
3112 * application has "extended" usage by coming up with new custom style names
3113 * for widgets for specific uses, but as these are not "standard", they are
3114 * not guaranteed to be provided by a default theme. This means the
3115 * application is required to provide these extra elements itself in specific
3116 * Edje files. This call adds one of those Edje files to the theme search
3117 * path to be search after the default theme. The use of this call is
3118 * encouraged when default styles do not meet the needs of the application.
3119 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3121 * @see elm_object_style_set()
3123 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3125 * Deletes a theme extension from the list of extensions.
3127 * @param th The theme to delete from, or if NULL, the default theme
3128 * @param item The name of the theme extension
3130 * @see elm_theme_extension_add()
3132 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3134 * Set the theme search order for the given theme
3136 * @param th The theme to set the search order, or if NULL, the default theme
3137 * @param theme Theme search string
3139 * This sets the search string for the theme in path-notation from first
3140 * theme to search, to last, delimited by the : character. Example:
3142 * "shiny:/path/to/file.edj:default"
3144 * See the ELM_THEME environment variable for more information.
3146 * @see elm_theme_get()
3147 * @see elm_theme_list_get()
3149 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3151 * Return the theme search order
3153 * @param th The theme to get the search order, or if NULL, the default theme
3154 * @return The internal search order path
3156 * This function returns a colon separated string of theme elements as
3157 * returned by elm_theme_list_get().
3159 * @see elm_theme_set()
3160 * @see elm_theme_list_get()
3162 EAPI const char *elm_theme_get(Elm_Theme *th);
3164 * Return a list of theme elements to be used in a theme.
3166 * @param th Theme to get the list of theme elements from.
3167 * @return The internal list of theme elements
3169 * This returns the internal list of theme elements (will only be valid as
3170 * long as the theme is not modified by elm_theme_set() or theme is not
3171 * freed by elm_theme_free(). This is a list of strings which must not be
3172 * altered as they are also internal. If @p th is NULL, then the default
3173 * theme element list is returned.
3175 * A theme element can consist of a full or relative path to a .edj file,
3176 * or a name, without extension, for a theme to be searched in the known
3177 * theme paths for Elemementary.
3179 * @see elm_theme_set()
3180 * @see elm_theme_get()
3182 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3184 * Return the full patrh for a theme element
3186 * @param f The theme element name
3187 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3188 * @return The full path to the file found.
3190 * This returns a string you should free with free() on success, NULL on
3191 * failure. This will search for the given theme element, and if it is a
3192 * full or relative path element or a simple searchable name. The returned
3193 * path is the full path to the file, if searched, and the file exists, or it
3194 * is simply the full path given in the element or a resolved path if
3195 * relative to home. The @p in_search_path boolean pointed to is set to
3196 * EINA_TRUE if the file was a searchable file andis in the search path,
3197 * and EINA_FALSE otherwise.
3199 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3201 * Flush the current theme.
3203 * @param th Theme to flush
3205 * This flushes caches that let elementary know where to find theme elements
3206 * in the given theme. If @p th is NULL, then the default theme is flushed.
3207 * Call this function if source theme data has changed in such a way as to
3208 * make any caches Elementary kept invalid.
3210 EAPI void elm_theme_flush(Elm_Theme *th);
3212 * This flushes all themes (default and specific ones).
3214 * This will flush all themes in the current application context, by calling
3215 * elm_theme_flush() on each of them.
3217 EAPI void elm_theme_full_flush(void);
3219 * Set the theme for all elementary using applications on the current display
3221 * @param theme The name of the theme to use. Format same as the ELM_THEME
3222 * environment variable.
3224 EAPI void elm_theme_all_set(const char *theme);
3226 * Return a list of theme elements in the theme search path
3228 * @return A list of strings that are the theme element names.
3230 * This lists all available theme files in the standard Elementary search path
3231 * for theme elements, and returns them in alphabetical order as theme
3232 * element names in a list of strings. Free this with
3233 * elm_theme_name_available_list_free() when you are done with the list.
3235 EAPI Eina_List *elm_theme_name_available_list_new(void);
3237 * Free the list returned by elm_theme_name_available_list_new()
3239 * This frees the list of themes returned by
3240 * elm_theme_name_available_list_new(). Once freed the list should no longer
3241 * be used. a new list mys be created.
3243 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3245 * Set a specific theme to be used for this object and its children
3247 * @param obj The object to set the theme on
3248 * @param th The theme to set
3250 * This sets a specific theme that will be used for the given object and any
3251 * child objects it has. If @p th is NULL then the theme to be used is
3252 * cleared and the object will inherit its theme from its parent (which
3253 * ultimately will use the default theme if no specific themes are set).
3255 * Use special themes with great care as this will annoy users and make
3256 * configuration difficult. Avoid any custom themes at all if it can be
3259 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3261 * Get the specific theme to be used
3263 * @param obj The object to get the specific theme from
3264 * @return The specifc theme set.
3266 * This will return a specific theme set, or NULL if no specific theme is
3267 * set on that object. It will not return inherited themes from parents, only
3268 * the specific theme set for that specific object. See elm_object_theme_set()
3269 * for more information.
3271 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3277 /** @defgroup Win Win
3279 * @image html img/widget/win/preview-00.png
3280 * @image latex img/widget/win/preview-00.eps
3282 * The window class of Elementary. Contains functions to manipulate
3283 * windows. The Evas engine used to render the window contents is specified
3284 * in the system or user elementary config files (whichever is found last),
3285 * and can be overridden with the ELM_ENGINE environment variable for
3286 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3287 * compilation setup and modules actually installed at runtime) are (listed
3288 * in order of best supported and most likely to be complete and work to
3291 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3292 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3294 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3296 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3298 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3300 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3301 * rendering using SDL as the buffer)
3302 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3303 * GDI with software)
3304 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3305 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3306 * grayscale using dedicated 8bit software engine in X11)
3307 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3308 * X11 using 16bit software engine)
3309 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3310 * (Windows CE rendering via GDI with 16bit software renderer)
3311 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3312 * buffer with 16bit software renderer)
3314 * All engines use a simple string to select the engine to render, EXCEPT
3315 * the "shot" engine. This actually encodes the output of the virtual
3316 * screenshot and how long to delay in the engine string. The engine string
3317 * is encoded in the following way:
3319 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3321 * Where options are separated by a ":" char if more than one option is
3322 * given, with delay, if provided being the first option and file the last
3323 * (order is important). The delay specifies how long to wait after the
3324 * window is shown before doing the virtual "in memory" rendering and then
3325 * save the output to the file specified by the file option (and then exit).
3326 * If no delay is given, the default is 0.5 seconds. If no file is given the
3327 * default output file is "out.png". Repeat option is for continous
3328 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3329 * fixed to "out001.png" Some examples of using the shot engine:
3331 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3332 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3333 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3334 * ELM_ENGINE="shot:delay=2.0" elementary_test
3335 * ELM_ENGINE="shot:" elementary_test
3337 * Signals that you can add callbacks for are:
3339 * @li "delete,request": the user requested to close the window. See
3340 * elm_win_autodel_set().
3341 * @li "focus,in": window got focus
3342 * @li "focus,out": window lost focus
3343 * @li "moved": window that holds the canvas was moved
3346 * @li @ref win_example_01
3351 * Defines the types of window that can be created
3353 * These are hints set on the window so that a running Window Manager knows
3354 * how the window should be handled and/or what kind of decorations it
3357 * Currently, only the X11 backed engines use them.
3359 typedef enum _Elm_Win_Type
3361 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3362 window. Almost every window will be created with this
3364 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3365 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3366 window holding desktop icons. */
3367 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3368 be kept on top of any other window by the Window
3370 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3372 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3373 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3375 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3376 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3377 entry in a menubar is clicked. Typically used
3378 with elm_win_override_set(). This hint exists
3379 for completion only, as the EFL way of
3380 implementing a menu would not normally use a
3381 separate window for its contents. */
3382 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3383 triggered by right-clicking an object. */
3384 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3385 explanatory text that typically appear after the
3386 mouse cursor hovers over an object for a while.
3387 Typically used with elm_win_override_set() and also
3388 not very commonly used in the EFL. */
3389 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3390 battery life or a new E-Mail received. */
3391 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3392 usually used in the EFL. */
3393 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3394 object being dragged across different windows, or even
3395 applications. Typically used with
3396 elm_win_override_set(). */
3397 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3398 buffer. No actual window is created for this
3399 type, instead the window and all of its
3400 contents will be rendered to an image buffer.
3401 This allows to have children window inside a
3402 parent one just like any other object would
3403 be, and do other things like applying @c
3404 Evas_Map effects to it. This is the only type
3405 of window that requires the @c parent
3406 parameter of elm_win_add() to be a valid @c
3411 * The differents layouts that can be requested for the virtual keyboard.
3413 * When the application window is being managed by Illume, it may request
3414 * any of the following layouts for the virtual keyboard.
3416 typedef enum _Elm_Win_Keyboard_Mode
3418 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3419 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3420 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3421 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3422 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3423 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3424 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3425 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3426 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3427 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3428 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3429 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3430 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3431 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3432 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3433 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3434 } Elm_Win_Keyboard_Mode;
3437 * Available commands that can be sent to the Illume manager.
3439 * When running under an Illume session, a window may send commands to the
3440 * Illume manager to perform different actions.
3442 typedef enum _Elm_Illume_Command
3444 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3446 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3448 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3450 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3451 } Elm_Illume_Command;
3454 * Adds a window object. If this is the first window created, pass NULL as
3457 * @param parent Parent object to add the window to, or NULL
3458 * @param name The name of the window
3459 * @param type The window type, one of #Elm_Win_Type.
3461 * The @p parent paramter can be @c NULL for every window @p type except
3462 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3463 * which the image object will be created.
3465 * @return The created object, or NULL on failure
3467 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3469 * Add @p subobj as a resize object of window @p obj.
3472 * Setting an object as a resize object of the window means that the
3473 * @p subobj child's size and position will be controlled by the window
3474 * directly. That is, the object will be resized to match the window size
3475 * and should never be moved or resized manually by the developer.
3477 * In addition, resize objects of the window control what the minimum size
3478 * of it will be, as well as whether it can or not be resized by the user.
3480 * For the end user to be able to resize a window by dragging the handles
3481 * or borders provided by the Window Manager, or using any other similar
3482 * mechanism, all of the resize objects in the window should have their
3483 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3485 * @param obj The window object
3486 * @param subobj The resize object to add
3488 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3490 * Delete @p subobj as a resize object of window @p obj.
3492 * This function removes the object @p subobj from the resize objects of
3493 * the window @p obj. It will not delete the object itself, which will be
3494 * left unmanaged and should be deleted by the developer, manually handled
3495 * or set as child of some other container.
3497 * @param obj The window object
3498 * @param subobj The resize object to add
3500 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3502 * Set the title of the window
3504 * @param obj The window object
3505 * @param title The title to set
3507 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3509 * Get the title of the window
3511 * The returned string is an internal one and should not be freed or
3512 * modified. It will also be rendered invalid if a new title is set or if
3513 * the window is destroyed.
3515 * @param obj The window object
3518 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3520 * Set the window's autodel state.
3522 * When closing the window in any way outside of the program control, like
3523 * pressing the X button in the titlebar or using a command from the
3524 * Window Manager, a "delete,request" signal is emitted to indicate that
3525 * this event occurred and the developer can take any action, which may
3526 * include, or not, destroying the window object.
3528 * When the @p autodel parameter is set, the window will be automatically
3529 * destroyed when this event occurs, after the signal is emitted.
3530 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3531 * and is up to the program to do so when it's required.
3533 * @param obj The window object
3534 * @param autodel If true, the window will automatically delete itself when
3537 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3539 * Get the window's autodel state.
3541 * @param obj The window object
3542 * @return If the window will automatically delete itself when closed
3544 * @see elm_win_autodel_set()
3546 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3548 * Activate a window object.
3550 * This function sends a request to the Window Manager to activate the
3551 * window pointed by @p obj. If honored by the WM, the window will receive
3552 * the keyboard focus.
3554 * @note This is just a request that a Window Manager may ignore, so calling
3555 * this function does not ensure in any way that the window will be the
3556 * active one after it.
3558 * @param obj The window object
3560 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3562 * Lower a window object.
3564 * Places the window pointed by @p obj at the bottom of the stack, so that
3565 * no other window is covered by it.
3567 * If elm_win_override_set() is not set, the Window Manager may ignore this
3570 * @param obj The window object
3572 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3574 * Raise a window object.
3576 * Places the window pointed by @p obj at the top of the stack, so that it's
3577 * not covered by any other window.
3579 * If elm_win_override_set() is not set, the Window Manager may ignore this
3582 * @param obj The window object
3584 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3586 * Set the borderless state of a window.
3588 * This function requests the Window Manager to not draw any decoration
3589 * around the window.
3591 * @param obj The window object
3592 * @param borderless If true, the window is borderless
3594 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3596 * Get the borderless state of a window.
3598 * @param obj The window object
3599 * @return If true, the window is borderless
3601 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3603 * Set the shaped state of a window.
3605 * Shaped windows, when supported, will render the parts of the window that
3606 * has no content, transparent.
3608 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3609 * background object or cover the entire window in any other way, or the
3610 * parts of the canvas that have no data will show framebuffer artifacts.
3612 * @param obj The window object
3613 * @param shaped If true, the window is shaped
3615 * @see elm_win_alpha_set()
3617 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3619 * Get the shaped state of a window.
3621 * @param obj The window object
3622 * @return If true, the window is shaped
3624 * @see elm_win_shaped_set()
3626 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3628 * Set the alpha channel state of a window.
3630 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3631 * possibly making parts of the window completely or partially transparent.
3632 * This is also subject to the underlying system supporting it, like for
3633 * example, running under a compositing manager. If no compositing is
3634 * available, enabling this option will instead fallback to using shaped
3635 * windows, with elm_win_shaped_set().
3637 * @param obj The window object
3638 * @param alpha If true, the window has an alpha channel
3640 * @see elm_win_alpha_set()
3642 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3644 * Get the transparency state of a window.
3646 * @param obj The window object
3647 * @return If true, the window is transparent
3649 * @see elm_win_transparent_set()
3651 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3653 * Set the transparency state of a window.
3655 * Use elm_win_alpha_set() instead.
3657 * @param obj The window object
3658 * @param transparent If true, the window is transparent
3660 * @see elm_win_alpha_set()
3662 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3664 * Get the alpha channel state of a window.
3666 * @param obj The window object
3667 * @return If true, the window has an alpha channel
3669 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3671 * Set the override state of a window.
3673 * A window with @p override set to EINA_TRUE will not be managed by the
3674 * Window Manager. This means that no decorations of any kind will be shown
3675 * for it, moving and resizing must be handled by the application, as well
3676 * as the window visibility.
3678 * This should not be used for normal windows, and even for not so normal
3679 * ones, it should only be used when there's a good reason and with a lot
3680 * of care. Mishandling override windows may result situations that
3681 * disrupt the normal workflow of the end user.
3683 * @param obj The window object
3684 * @param override If true, the window is overridden
3686 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3688 * Get the override state of a window.
3690 * @param obj The window object
3691 * @return If true, the window is overridden
3693 * @see elm_win_override_set()
3695 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3697 * Set the fullscreen state of a window.
3699 * @param obj The window object
3700 * @param fullscreen If true, the window is fullscreen
3702 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3704 * Get the fullscreen state of a window.
3706 * @param obj The window object
3707 * @return If true, the window is fullscreen
3709 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3711 * Set the maximized state of a window.
3713 * @param obj The window object
3714 * @param maximized If true, the window is maximized
3716 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3718 * Get the maximized state of a window.
3720 * @param obj The window object
3721 * @return If true, the window is maximized
3723 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3725 * Set the iconified state of a window.
3727 * @param obj The window object
3728 * @param iconified If true, the window is iconified
3730 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3732 * Get the iconified state of a window.
3734 * @param obj The window object
3735 * @return If true, the window is iconified
3737 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3739 * Set the layer of the window.
3741 * What this means exactly will depend on the underlying engine used.
3743 * In the case of X11 backed engines, the value in @p layer has the
3744 * following meanings:
3745 * @li < 3: The window will be placed below all others.
3746 * @li > 5: The window will be placed above all others.
3747 * @li other: The window will be placed in the default layer.
3749 * @param obj The window object
3750 * @param layer The layer of the window
3752 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3754 * Get the layer of the window.
3756 * @param obj The window object
3757 * @return The layer of the window
3759 * @see elm_win_layer_set()
3761 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3763 * Set the rotation of the window.
3765 * Most engines only work with multiples of 90.
3767 * This function is used to set the orientation of the window @p obj to
3768 * match that of the screen. The window itself will be resized to adjust
3769 * to the new geometry of its contents. If you want to keep the window size,
3770 * see elm_win_rotation_with_resize_set().
3772 * @param obj The window object
3773 * @param rotation The rotation of the window, in degrees (0-360),
3774 * counter-clockwise.
3776 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3778 * Rotates the window and resizes it.
3780 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3781 * that they fit inside the current window geometry.
3783 * @param obj The window object
3784 * @param layer The rotation of the window in degrees (0-360),
3785 * counter-clockwise.
3787 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3789 * Get the rotation of the window.
3791 * @param obj The window object
3792 * @return The rotation of the window in degrees (0-360)
3794 * @see elm_win_rotation_set()
3795 * @see elm_win_rotation_with_resize_set()
3797 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3799 * Set the sticky state of the window.
3801 * Hints the Window Manager that the window in @p obj should be left fixed
3802 * at its position even when the virtual desktop it's on moves or changes.
3804 * @param obj The window object
3805 * @param sticky If true, the window's sticky state is enabled
3807 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3809 * Get the sticky state of the window.
3811 * @param obj The window object
3812 * @return If true, the window's sticky state is enabled
3814 * @see elm_win_sticky_set()
3816 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3818 * Set if this window is an illume conformant window
3820 * @param obj The window object
3821 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3823 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3825 * Get if this window is an illume conformant window
3827 * @param obj The window object
3828 * @return A boolean if this window is illume conformant or not
3830 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3832 * Set a window to be an illume quickpanel window
3834 * By default window objects are not quickpanel windows.
3836 * @param obj The window object
3837 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3839 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3841 * Get if this window is a quickpanel or not
3843 * @param obj The window object
3844 * @return A boolean if this window is a quickpanel or not
3846 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3848 * Set the major priority of a quickpanel window
3850 * @param obj The window object
3851 * @param priority The major priority for this quickpanel
3853 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3855 * Get the major priority of a quickpanel window
3857 * @param obj The window object
3858 * @return The major priority of this quickpanel
3860 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3862 * Set the minor priority of a quickpanel window
3864 * @param obj The window object
3865 * @param priority The minor priority for this quickpanel
3867 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3869 * Get the minor priority of a quickpanel window
3871 * @param obj The window object
3872 * @return The minor priority of this quickpanel
3874 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3876 * Set which zone this quickpanel should appear in
3878 * @param obj The window object
3879 * @param zone The requested zone for this quickpanel
3881 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3883 * Get which zone this quickpanel should appear in
3885 * @param obj The window object
3886 * @return The requested zone for this quickpanel
3888 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3890 * Set the window to be skipped by keyboard focus
3892 * This sets the window to be skipped by normal keyboard input. This means
3893 * a window manager will be asked to not focus this window as well as omit
3894 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3896 * Call this and enable it on a window BEFORE you show it for the first time,
3897 * otherwise it may have no effect.
3899 * Use this for windows that have only output information or might only be
3900 * interacted with by the mouse or fingers, and never for typing input.
3901 * Be careful that this may have side-effects like making the window
3902 * non-accessible in some cases unless the window is specially handled. Use
3905 * @param obj The window object
3906 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3908 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3910 * Send a command to the windowing environment
3912 * This is intended to work in touchscreen or small screen device
3913 * environments where there is a more simplistic window management policy in
3914 * place. This uses the window object indicated to select which part of the
3915 * environment to control (the part that this window lives in), and provides
3916 * a command and an optional parameter structure (use NULL for this if not
3919 * @param obj The window object that lives in the environment to control
3920 * @param command The command to send
3921 * @param params Optional parameters for the command
3923 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3925 * Get the inlined image object handle
3927 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3928 * then the window is in fact an evas image object inlined in the parent
3929 * canvas. You can get this object (be careful to not manipulate it as it
3930 * is under control of elementary), and use it to do things like get pixel
3931 * data, save the image to a file, etc.
3933 * @param obj The window object to get the inlined image from
3934 * @return The inlined image object, or NULL if none exists
3936 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3938 * Set the enabled status for the focus highlight in a window
3940 * This function will enable or disable the focus highlight only for the
3941 * given window, regardless of the global setting for it
3943 * @param obj The window where to enable the highlight
3944 * @param enabled The enabled value for the highlight
3946 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3948 * Get the enabled value of the focus highlight for this window
3950 * @param obj The window in which to check if the focus highlight is enabled
3952 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
3954 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3956 * Set the style for the focus highlight on this window
3958 * Sets the style to use for theming the highlight of focused objects on
3959 * the given window. If @p style is NULL, the default will be used.
3961 * @param obj The window where to set the style
3962 * @param style The style to set
3964 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3966 * Get the style set for the focus highlight object
3968 * Gets the style set for this windows highilght object, or NULL if none
3971 * @param obj The window to retrieve the highlights style from
3973 * @return The style set or NULL if none was. Default is used in that case.
3975 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3977 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
3978 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
3979 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
3980 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
3981 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
3982 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
3983 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
3985 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
3986 * (blank mouse, private mouse obj, defaultmouse)
3990 * Sets the keyboard mode of the window.
3992 * @param obj The window object
3993 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
3995 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
3997 * Gets the keyboard mode of the window.
3999 * @param obj The window object
4000 * @return The mode, one of #Elm_Win_Keyboard_Mode
4002 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4004 * Sets whether the window is a keyboard.
4006 * @param obj The window object
4007 * @param is_keyboard If true, the window is a virtual keyboard
4009 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4011 * Gets whether the window is a keyboard.
4013 * @param obj The window object
4014 * @return If the window is a virtual keyboard
4016 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4019 * Get the screen position of a window.
4021 * @param obj The window object
4022 * @param x The int to store the x coordinate to
4023 * @param y The int to store the y coordinate to
4025 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4031 * @defgroup Inwin Inwin
4033 * @image html img/widget/inwin/preview-00.png
4034 * @image latex img/widget/inwin/preview-00.eps
4035 * @image html img/widget/inwin/preview-01.png
4036 * @image latex img/widget/inwin/preview-01.eps
4037 * @image html img/widget/inwin/preview-02.png
4038 * @image latex img/widget/inwin/preview-02.eps
4040 * An inwin is a window inside a window that is useful for a quick popup.
4041 * It does not hover.
4043 * It works by creating an object that will occupy the entire window, so it
4044 * must be created using an @ref Win "elm_win" as parent only. The inwin
4045 * object can be hidden or restacked below every other object if it's
4046 * needed to show what's behind it without destroying it. If this is done,
4047 * the elm_win_inwin_activate() function can be used to bring it back to
4048 * full visibility again.
4050 * There are three styles available in the default theme. These are:
4051 * @li default: The inwin is sized to take over most of the window it's
4053 * @li minimal: The size of the inwin will be the minimum necessary to show
4055 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4056 * possible, but it's sized vertically the most it needs to fit its\
4059 * Some examples of Inwin can be found in the following:
4060 * @li @ref inwin_example_01
4065 * Adds an inwin to the current window
4067 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4068 * Never call this function with anything other than the top-most window
4069 * as its parameter, unless you are fond of undefined behavior.
4071 * After creating the object, the widget will set itself as resize object
4072 * for the window with elm_win_resize_object_add(), so when shown it will
4073 * appear to cover almost the entire window (how much of it depends on its
4074 * content and the style used). It must not be added into other container
4075 * objects and it needs not be moved or resized manually.
4077 * @param parent The parent object
4078 * @return The new object or NULL if it cannot be created
4080 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4082 * Activates an inwin object, ensuring its visibility
4084 * This function will make sure that the inwin @p obj is completely visible
4085 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4086 * to the front. It also sets the keyboard focus to it, which will be passed
4089 * The object's theme will also receive the signal "elm,action,show" with
4092 * @param obj The inwin to activate
4094 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4096 * Set the content of an inwin object.
4098 * Once the content object is set, a previously set one will be deleted.
4099 * If you want to keep that old content object, use the
4100 * elm_win_inwin_content_unset() function.
4102 * @param obj The inwin object
4103 * @param content The object to set as content
4105 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4107 * Get the content of an inwin object.
4109 * Return the content object which is set for this widget.
4111 * The returned object is valid as long as the inwin is still alive and no
4112 * other content is set on it. Deleting the object will notify the inwin
4113 * about it and this one will be left empty.
4115 * If you need to remove an inwin's content to be reused somewhere else,
4116 * see elm_win_inwin_content_unset().
4118 * @param obj The inwin object
4119 * @return The content that is being used
4121 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4123 * Unset the content of an inwin object.
4125 * Unparent and return the content object which was set for this widget.
4127 * @param obj The inwin object
4128 * @return The content that was being used
4130 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4134 /* X specific calls - won't work on non-x engines (return 0) */
4137 * Get the Ecore_X_Window of an Evas_Object
4139 * @param obj The object
4141 * @return The Ecore_X_Window of @p obj
4145 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4147 /* smart callbacks called:
4148 * "delete,request" - the user requested to delete the window
4149 * "focus,in" - window got focus
4150 * "focus,out" - window lost focus
4151 * "moved" - window that holds the canvas was moved
4157 * @image html img/widget/bg/preview-00.png
4158 * @image latex img/widget/bg/preview-00.eps
4160 * @brief Background object, used for setting a solid color, image or Edje
4161 * group as background to a window or any container object.
4163 * The bg object is used for setting a solid background to a window or
4164 * packing into any container object. It works just like an image, but has
4165 * some properties useful to a background, like setting it to tiled,
4166 * centered, scaled or stretched.
4168 * Here is some sample code using it:
4169 * @li @ref bg_01_example_page
4170 * @li @ref bg_02_example_page
4171 * @li @ref bg_03_example_page
4175 typedef enum _Elm_Bg_Option
4177 ELM_BG_OPTION_CENTER, /**< center the background */
4178 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4179 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4180 ELM_BG_OPTION_TILE /**< tile background at its original size */
4184 * Add a new background to the parent
4186 * @param parent The parent object
4187 * @return The new object or NULL if it cannot be created
4191 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4194 * Set the file (image or edje) used for the background
4196 * @param obj The bg object
4197 * @param file The file path
4198 * @param group Optional key (group in Edje) within the file
4200 * This sets the image file used in the background object. The image (or edje)
4201 * will be stretched (retaining aspect if its an image file) to completely fill
4202 * the bg object. This may mean some parts are not visible.
4204 * @note Once the image of @p obj is set, a previously set one will be deleted,
4205 * even if @p file is NULL.
4209 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4212 * Get the file (image or edje) used for the background
4214 * @param obj The bg object
4215 * @param file The file path
4216 * @param group Optional key (group in Edje) within the file
4220 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4223 * Set the option used for the background image
4225 * @param obj The bg object
4226 * @param option The desired background option (TILE, SCALE)
4228 * This sets the option used for manipulating the display of the background
4229 * image. The image can be tiled or scaled.
4233 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4236 * Get the option used for the background image
4238 * @param obj The bg object
4239 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4243 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4245 * Set the option used for the background color
4247 * @param obj The bg object
4252 * This sets the color used for the background rectangle. Its range goes
4257 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4259 * Get the option used for the background color
4261 * @param obj The bg object
4268 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4271 * Set the overlay object used for the background object.
4273 * @param obj The bg object
4274 * @param overlay The overlay object
4276 * This provides a way for elm_bg to have an 'overlay' that will be on top
4277 * of the bg. Once the over object is set, a previously set one will be
4278 * deleted, even if you set the new one to NULL. If you want to keep that
4279 * old content object, use the elm_bg_overlay_unset() function.
4284 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4287 * Get the overlay object used for the background object.
4289 * @param obj The bg object
4290 * @return The content that is being used
4292 * Return the content object which is set for this widget
4296 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4299 * Get the overlay object used for the background object.
4301 * @param obj The bg object
4302 * @return The content that was being used
4304 * Unparent and return the overlay object which was set for this widget
4308 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4311 * Set the size of the pixmap representation of the image.
4313 * This option just makes sense if an image is going to be set in the bg.
4315 * @param obj The bg object
4316 * @param w The new width of the image pixmap representation.
4317 * @param h The new height of the image pixmap representation.
4319 * This function sets a new size for pixmap representation of the given bg
4320 * image. It allows the image to be loaded already in the specified size,
4321 * reducing the memory usage and load time when loading a big image with load
4322 * size set to a smaller size.
4324 * NOTE: this is just a hint, the real size of the pixmap may differ
4325 * depending on the type of image being loaded, being bigger than requested.
4329 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4330 /* smart callbacks called:
4334 * @defgroup Icon Icon
4336 * @image html img/widget/icon/preview-00.png
4337 * @image latex img/widget/icon/preview-00.eps
4339 * An object that provides standard icon images (delete, edit, arrows, etc.)
4340 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4342 * The icon image requested can be in the elementary theme, or in the
4343 * freedesktop.org paths. It's possible to set the order of preference from
4344 * where the image will be used.
4346 * This API is very similar to @ref Image, but with ready to use images.
4348 * Default images provided by the theme are described below.
4350 * The first list contains icons that were first intended to be used in
4351 * toolbars, but can be used in many other places too:
4367 * Now some icons that were designed to be used in menus (but again, you can
4368 * use them anywhere else):
4373 * @li menu/arrow_down
4374 * @li menu/arrow_left
4375 * @li menu/arrow_right
4384 * And here we have some media player specific icons:
4385 * @li media_player/forward
4386 * @li media_player/info
4387 * @li media_player/next
4388 * @li media_player/pause
4389 * @li media_player/play
4390 * @li media_player/prev
4391 * @li media_player/rewind
4392 * @li media_player/stop
4394 * Signals that you can add callbacks for are:
4396 * "clicked" - This is called when a user has clicked the icon
4398 * An example of usage for this API follows:
4399 * @li @ref tutorial_icon
4407 typedef enum _Elm_Icon_Type
4414 * @enum _Elm_Icon_Lookup_Order
4415 * @typedef Elm_Icon_Lookup_Order
4417 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4418 * theme, FDO paths, or both?
4422 typedef enum _Elm_Icon_Lookup_Order
4424 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4425 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4426 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4427 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4428 } Elm_Icon_Lookup_Order;
4431 * Add a new icon object to the parent.
4433 * @param parent The parent object
4434 * @return The new object or NULL if it cannot be created
4436 * @see elm_icon_file_set()
4440 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4442 * Set the file that will be used as icon.
4444 * @param obj The icon object
4445 * @param file The path to file that will be used as icon image
4446 * @param group The group that the icon belongs to in edje file
4448 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4450 * @note The icon image set by this function can be changed by
4451 * elm_icon_standard_set().
4453 * @see elm_icon_file_get()
4457 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4459 * Set a location in memory to be used as an icon
4461 * @param obj The icon object
4462 * @param img The binary data that will be used as an image
4463 * @param size The size of binary data @p img
4464 * @param format Optional format of @p img to pass to the image loader
4465 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4467 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4469 * @note The icon image set by this function can be changed by
4470 * elm_icon_standard_set().
4474 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);
4476 * Get the file that will be used as icon.
4478 * @param obj The icon object
4479 * @param file The path to file that will be used as icon icon image
4480 * @param group The group that the icon belongs to in edje file
4482 * @see elm_icon_file_set()
4486 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4487 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4489 * Set the icon by icon standards names.
4491 * @param obj The icon object
4492 * @param name The icon name
4494 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4496 * For example, freedesktop.org defines standard icon names such as "home",
4497 * "network", etc. There can be different icon sets to match those icon
4498 * keys. The @p name given as parameter is one of these "keys", and will be
4499 * used to look in the freedesktop.org paths and elementary theme. One can
4500 * change the lookup order with elm_icon_order_lookup_set().
4502 * If name is not found in any of the expected locations and it is the
4503 * absolute path of an image file, this image will be used.
4505 * @note The icon image set by this function can be changed by
4506 * elm_icon_file_set().
4508 * @see elm_icon_standard_get()
4509 * @see elm_icon_file_set()
4513 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4515 * Get the icon name set by icon standard names.
4517 * @param obj The icon object
4518 * @return The icon name
4520 * If the icon image was set using elm_icon_file_set() instead of
4521 * elm_icon_standard_set(), then this function will return @c NULL.
4523 * @see elm_icon_standard_set()
4527 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4529 * Set the smooth effect for an icon object.
4531 * @param obj The icon object
4532 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4533 * otherwise. Default is @c EINA_TRUE.
4535 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4536 * scaling provides a better resulting image, but is slower.
4538 * The smooth scaling should be disabled when making animations that change
4539 * the icon size, since they will be faster. Animations that don't require
4540 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4541 * is already scaled, since the scaled icon image will be cached).
4543 * @see elm_icon_smooth_get()
4547 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4549 * Get the smooth effect for an icon object.
4551 * @param obj The icon object
4552 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4554 * @see elm_icon_smooth_set()
4558 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4560 * Disable scaling of this object.
4562 * @param obj The icon object.
4563 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4564 * otherwise. Default is @c EINA_FALSE.
4566 * This function disables scaling of the icon object through the function
4567 * elm_object_scale_set(). However, this does not affect the object
4568 * size/resize in any way. For that effect, take a look at
4569 * elm_icon_scale_set().
4571 * @see elm_icon_no_scale_get()
4572 * @see elm_icon_scale_set()
4573 * @see elm_object_scale_set()
4577 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4579 * Get whether scaling is disabled on the object.
4581 * @param obj The icon object
4582 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4584 * @see elm_icon_no_scale_set()
4588 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4590 * Set if the object is (up/down) resizeable.
4592 * @param obj The icon object
4593 * @param scale_up A bool to set if the object is resizeable up. Default is
4595 * @param scale_down A bool to set if the object is resizeable down. Default
4598 * This function limits the icon object resize ability. If @p scale_up is set to
4599 * @c EINA_FALSE, the object can't have its height or width resized to a value
4600 * higher than the original icon size. Same is valid for @p scale_down.
4602 * @see elm_icon_scale_get()
4606 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4608 * Get if the object is (up/down) resizeable.
4610 * @param obj The icon object
4611 * @param scale_up A bool to set if the object is resizeable up
4612 * @param scale_down A bool to set if the object is resizeable down
4614 * @see elm_icon_scale_set()
4618 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4620 * Get the object's image size
4622 * @param obj The icon object
4623 * @param w A pointer to store the width in
4624 * @param h A pointer to store the height in
4628 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4630 * Set if the icon fill the entire object area.
4632 * @param obj The icon object
4633 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4634 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4636 * When the icon object is resized to a different aspect ratio from the
4637 * original icon image, the icon image will still keep its aspect. This flag
4638 * tells how the image should fill the object's area. They are: keep the
4639 * entire icon inside the limits of height and width of the object (@p
4640 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4641 * of the object, and the icon will fill the entire object (@p fill_outside
4644 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4645 * retain property to false. Thus, the icon image will always keep its
4646 * original aspect ratio.
4648 * @see elm_icon_fill_outside_get()
4649 * @see elm_image_fill_outside_set()
4653 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4655 * Get if the object is filled outside.
4657 * @param obj The icon object
4658 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4660 * @see elm_icon_fill_outside_set()
4664 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4666 * Set the prescale size for the icon.
4668 * @param obj The icon object
4669 * @param size The prescale size. This value is used for both width and
4672 * This function sets a new size for pixmap representation of the given
4673 * icon. It allows the icon to be loaded already in the specified size,
4674 * reducing the memory usage and load time when loading a big icon with load
4675 * size set to a smaller size.
4677 * It's equivalent to the elm_bg_load_size_set() function for bg.
4679 * @note this is just a hint, the real size of the pixmap may differ
4680 * depending on the type of icon being loaded, being bigger than requested.
4682 * @see elm_icon_prescale_get()
4683 * @see elm_bg_load_size_set()
4687 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4689 * Get the prescale size for the icon.
4691 * @param obj The icon object
4692 * @return The prescale size
4694 * @see elm_icon_prescale_set()
4698 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4700 * Sets the icon lookup order used by elm_icon_standard_set().
4702 * @param obj The icon object
4703 * @param order The icon lookup order (can be one of
4704 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4705 * or ELM_ICON_LOOKUP_THEME)
4707 * @see elm_icon_order_lookup_get()
4708 * @see Elm_Icon_Lookup_Order
4712 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4714 * Gets the icon lookup order.
4716 * @param obj The icon object
4717 * @return The icon lookup order
4719 * @see elm_icon_order_lookup_set()
4720 * @see Elm_Icon_Lookup_Order
4724 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4731 * @defgroup Image Image
4733 * @image html img/widget/image/preview-00.png
4734 * @image latex img/widget/image/preview-00.eps
4736 * An object that allows one to load an image file to it. It can be used
4737 * anywhere like any other elementary widget.
4739 * This widget provides most of the functionality provided from @ref Bg or @ref
4740 * Icon, but with a slightly different API (use the one that fits better your
4743 * The features not provided by those two other image widgets are:
4744 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4745 * @li change the object orientation with elm_image_orient_set();
4746 * @li and turning the image editable with elm_image_editable_set().
4748 * Signals that you can add callbacks for are:
4750 * @li @c "clicked" - This is called when a user has clicked the image
4752 * An example of usage for this API follows:
4753 * @li @ref tutorial_image
4762 * @enum _Elm_Image_Orient
4763 * @typedef Elm_Image_Orient
4765 * Possible orientation options for elm_image_orient_set().
4767 * @image html elm_image_orient_set.png
4768 * @image latex elm_image_orient_set.eps width=\textwidth
4772 typedef enum _Elm_Image_Orient
4774 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4775 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4776 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4777 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4778 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4779 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4780 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4781 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4785 * Add a new image to the parent.
4787 * @param parent The parent object
4788 * @return The new object or NULL if it cannot be created
4790 * @see elm_image_file_set()
4794 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4796 * Set the file that will be used as image.
4798 * @param obj The image object
4799 * @param file The path to file that will be used as image
4800 * @param group The group that the image belongs in edje file (if it's an
4803 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4805 * @see elm_image_file_get()
4809 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4811 * Get the file that will be used as image.
4813 * @param obj The image object
4814 * @param file The path to file
4815 * @param group The group that the image belongs in edje file
4817 * @see elm_image_file_set()
4821 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4823 * Set the smooth effect for an image.
4825 * @param obj The image object
4826 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4827 * otherwise. Default is @c EINA_TRUE.
4829 * Set the scaling algorithm to be used when scaling the image. Smooth
4830 * scaling provides a better resulting image, but is slower.
4832 * The smooth scaling should be disabled when making animations that change
4833 * the image size, since it will be faster. Animations that don't require
4834 * resizing of the image can keep the smooth scaling enabled (even if the
4835 * image is already scaled, since the scaled image will be cached).
4837 * @see elm_image_smooth_get()
4841 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4843 * Get the smooth effect for an image.
4845 * @param obj The image object
4846 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4848 * @see elm_image_smooth_get()
4852 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4854 * Gets the current size of the image.
4856 * @param obj The image object.
4857 * @param w Pointer to store width, or NULL.
4858 * @param h Pointer to store height, or NULL.
4860 * This is the real size of the image, not the size of the object.
4862 * On error, neither w or h will be written.
4866 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4868 * Disable scaling of this object.
4870 * @param obj The image object.
4871 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4872 * otherwise. Default is @c EINA_FALSE.
4874 * This function disables scaling of the elm_image widget through the
4875 * function elm_object_scale_set(). However, this does not affect the widget
4876 * size/resize in any way. For that effect, take a look at
4877 * elm_image_scale_set().
4879 * @see elm_image_no_scale_get()
4880 * @see elm_image_scale_set()
4881 * @see elm_object_scale_set()
4885 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4887 * Get whether scaling is disabled on the object.
4889 * @param obj The image object
4890 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4892 * @see elm_image_no_scale_set()
4896 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4898 * Set if the object is (up/down) resizeable.
4900 * @param obj The image object
4901 * @param scale_up A bool to set if the object is resizeable up. Default is
4903 * @param scale_down A bool to set if the object is resizeable down. Default
4906 * This function limits the image resize ability. If @p scale_up is set to
4907 * @c EINA_FALSE, the object can't have its height or width resized to a value
4908 * higher than the original image size. Same is valid for @p scale_down.
4910 * @see elm_image_scale_get()
4914 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4916 * Get if the object is (up/down) resizeable.
4918 * @param obj The image object
4919 * @param scale_up A bool to set if the object is resizeable up
4920 * @param scale_down A bool to set if the object is resizeable down
4922 * @see elm_image_scale_set()
4926 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4928 * Set if the image fill the entire object area when keeping the aspect ratio.
4930 * @param obj The image object
4931 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4932 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4934 * When the image should keep its aspect ratio even if resized to another
4935 * aspect ratio, there are two possibilities to resize it: keep the entire
4936 * image inside the limits of height and width of the object (@p fill_outside
4937 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
4938 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
4940 * @note This option will have no effect if
4941 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
4943 * @see elm_image_fill_outside_get()
4944 * @see elm_image_aspect_ratio_retained_set()
4948 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4950 * Get if the object is filled outside
4952 * @param obj The image object
4953 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4955 * @see elm_image_fill_outside_set()
4959 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4961 * Set the prescale size for the image
4963 * @param obj The image object
4964 * @param size The prescale size. This value is used for both width and
4967 * This function sets a new size for pixmap representation of the given
4968 * image. It allows the image to be loaded already in the specified size,
4969 * reducing the memory usage and load time when loading a big image with load
4970 * size set to a smaller size.
4972 * It's equivalent to the elm_bg_load_size_set() function for bg.
4974 * @note this is just a hint, the real size of the pixmap may differ
4975 * depending on the type of image being loaded, being bigger than requested.
4977 * @see elm_image_prescale_get()
4978 * @see elm_bg_load_size_set()
4982 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4984 * Get the prescale size for the image
4986 * @param obj The image object
4987 * @return The prescale size
4989 * @see elm_image_prescale_set()
4993 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4995 * Set the image orientation.
4997 * @param obj The image object
4998 * @param orient The image orientation
4999 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5000 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5001 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5002 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5003 * Default is #ELM_IMAGE_ORIENT_NONE.
5005 * This function allows to rotate or flip the given image.
5007 * @see elm_image_orient_get()
5008 * @see @ref Elm_Image_Orient
5012 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5014 * Get the image orientation.
5016 * @param obj The image object
5017 * @return The image orientation
5018 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5019 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5020 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5021 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5023 * @see elm_image_orient_set()
5024 * @see @ref Elm_Image_Orient
5028 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5030 * Make the image 'editable'.
5032 * @param obj Image object.
5033 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5035 * This means the image is a valid drag target for drag and drop, and can be
5036 * cut or pasted too.
5040 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5042 * Make the image 'editable'.
5044 * @param obj Image object.
5045 * @return Editability.
5047 * This means the image is a valid drag target for drag and drop, and can be
5048 * cut or pasted too.
5052 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5054 * Get the basic Evas_Image object from this object (widget).
5056 * @param obj The image object to get the inlined image from
5057 * @return The inlined image object, or NULL if none exists
5059 * This function allows one to get the underlying @c Evas_Object of type
5060 * Image from this elementary widget. It can be useful to do things like get
5061 * the pixel data, save the image to a file, etc.
5063 * @note Be careful to not manipulate it, as it is under control of
5068 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5070 * Set whether the original aspect ratio of the image should be kept on resize.
5072 * @param obj The image object.
5073 * @param retained @c EINA_TRUE if the image should retain the aspect,
5074 * @c EINA_FALSE otherwise.
5076 * The original aspect ratio (width / height) of the image is usually
5077 * distorted to match the object's size. Enabling this option will retain
5078 * this original aspect, and the way that the image is fit into the object's
5079 * area depends on the option set by elm_image_fill_outside_set().
5081 * @see elm_image_aspect_ratio_retained_get()
5082 * @see elm_image_fill_outside_set()
5086 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5088 * Get if the object retains the original aspect ratio.
5090 * @param obj The image object.
5091 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5096 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5098 /* smart callbacks called:
5099 * "clicked" - the user clicked the image
5107 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5109 typedef enum _Elm_GLView_Mode
5111 ELM_GLVIEW_ALPHA = 1,
5112 ELM_GLVIEW_DEPTH = 2,
5113 ELM_GLVIEW_STENCIL = 4
5117 * Defines a policy for the glview resizing.
5119 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5121 typedef enum _Elm_GLView_Resize_Policy
5123 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5124 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5125 } Elm_GLView_Resize_Policy;
5127 typedef enum _Elm_GLView_Render_Policy
5129 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5130 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5131 } Elm_GLView_Render_Policy;
5136 * A simple GLView widget that allows GL rendering.
5138 * Signals that you can add callbacks for are:
5144 * Add a new glview to the parent
5146 * @param parent The parent object
5147 * @return The new object or NULL if it cannot be created
5151 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5154 * Sets the size of the glview
5156 * @param obj The glview object
5157 * @param width width of the glview object
5158 * @param height height of the glview object
5162 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5165 * Gets the size of the glview.
5167 * @param obj The glview object
5168 * @param width width of the glview object
5169 * @param height height of the glview object
5171 * Note that this function returns the actual image size of the
5172 * glview. This means that when the scale policy is set to
5173 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5178 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5181 * Gets the gl api struct for gl rendering
5183 * @param obj The glview object
5184 * @return The api object or NULL if it cannot be created
5188 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5191 * Set the mode of the GLView. Supports Three simple modes.
5193 * @param obj The glview object
5194 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5195 * @return True if set properly.
5199 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5202 * Set the resize policy for the glview object.
5204 * @param obj The glview object.
5205 * @param policy The scaling policy.
5207 * By default, the resize policy is set to
5208 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5209 * destroys the previous surface and recreates the newly specified
5210 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5211 * however, glview only scales the image object and not the underlying
5216 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5219 * Set the render policy for the glview object.
5221 * @param obj The glview object.
5222 * @param policy The render policy.
5224 * By default, the render policy is set to
5225 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5226 * that during the render loop, glview is only redrawn if it needs
5227 * to be redrawn. (i.e. When it is visible) If the policy is set to
5228 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5229 * whether it is visible/need redrawing or not.
5233 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5236 * Set the init function that runs once in the main loop.
5238 * @param obj The glview object.
5239 * @param func The init function to be registered.
5241 * The registered init function gets called once during the render loop.
5245 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5248 * Set the render function that runs in the main loop.
5250 * @param obj The glview object.
5251 * @param func The delete function to be registered.
5253 * The registered del function gets called when GLView object is deleted.
5257 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5260 * Set the resize function that gets called when resize happens.
5262 * @param obj The glview object.
5263 * @param func The resize function to be registered.
5267 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5270 * Set the render function that runs in the main loop.
5272 * @param obj The glview object.
5273 * @param func The render function to be registered.
5277 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5280 * Notifies that there has been changes in the GLView.
5282 * @param obj The glview object.
5286 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5296 * @image html img/widget/box/preview-00.png
5297 * @image latex img/widget/box/preview-00.eps width=\textwidth
5299 * @image html img/box.png
5300 * @image latex img/box.eps width=\textwidth
5302 * A box arranges objects in a linear fashion, governed by a layout function
5303 * that defines the details of this arrangement.
5305 * By default, the box will use an internal function to set the layout to
5306 * a single row, either vertical or horizontal. This layout is affected
5307 * by a number of parameters, such as the homogeneous flag set by
5308 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5309 * elm_box_align_set() and the hints set to each object in the box.
5311 * For this default layout, it's possible to change the orientation with
5312 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5313 * placing its elements ordered from top to bottom. When horizontal is set,
5314 * the order will go from left to right. If the box is set to be
5315 * homogeneous, every object in it will be assigned the same space, that
5316 * of the largest object. Padding can be used to set some spacing between
5317 * the cell given to each object. The alignment of the box, set with
5318 * elm_box_align_set(), determines how the bounding box of all the elements
5319 * will be placed within the space given to the box widget itself.
5321 * The size hints of each object also affect how they are placed and sized
5322 * within the box. evas_object_size_hint_min_set() will give the minimum
5323 * size the object can have, and the box will use it as the basis for all
5324 * latter calculations. Elementary widgets set their own minimum size as
5325 * needed, so there's rarely any need to use it manually.
5327 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5328 * used to tell whether the object will be allocated the minimum size it
5329 * needs or if the space given to it should be expanded. It's important
5330 * to realize that expanding the size given to the object is not the same
5331 * thing as resizing the object. It could very well end being a small
5332 * widget floating in a much larger empty space. If not set, the weight
5333 * for objects will normally be 0.0 for both axis, meaning the widget will
5334 * not be expanded. To take as much space possible, set the weight to
5335 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5337 * Besides how much space each object is allocated, it's possible to control
5338 * how the widget will be placed within that space using
5339 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5340 * for both axis, meaning the object will be centered, but any value from
5341 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5342 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5343 * is -1.0, means the object will be resized to fill the entire space it
5346 * In addition, customized functions to define the layout can be set, which
5347 * allow the application developer to organize the objects within the box
5348 * in any number of ways.
5350 * The special elm_box_layout_transition() function can be used
5351 * to switch from one layout to another, animating the motion of the
5352 * children of the box.
5354 * @note Objects should not be added to box objects using _add() calls.
5356 * Some examples on how to use boxes follow:
5357 * @li @ref box_example_01
5358 * @li @ref box_example_02
5363 * @typedef Elm_Box_Transition
5365 * Opaque handler containing the parameters to perform an animated
5366 * transition of the layout the box uses.
5368 * @see elm_box_transition_new()
5369 * @see elm_box_layout_set()
5370 * @see elm_box_layout_transition()
5372 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5375 * Add a new box to the parent
5377 * By default, the box will be in vertical mode and non-homogeneous.
5379 * @param parent The parent object
5380 * @return The new object or NULL if it cannot be created
5382 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5384 * Set the horizontal orientation
5386 * By default, box object arranges their contents vertically from top to
5388 * By calling this function with @p horizontal as EINA_TRUE, the box will
5389 * become horizontal, arranging contents from left to right.
5391 * @note This flag is ignored if a custom layout function is set.
5393 * @param obj The box object
5394 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5395 * EINA_FALSE = vertical)
5397 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5399 * Get the horizontal orientation
5401 * @param obj The box object
5402 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5404 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5406 * Set the box to arrange its children homogeneously
5408 * If enabled, homogeneous layout makes all items the same size, according
5409 * to the size of the largest of its children.
5411 * @note This flag is ignored if a custom layout function is set.
5413 * @param obj The box object
5414 * @param homogeneous The homogeneous flag
5416 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5418 * Get whether the box is using homogeneous mode or not
5420 * @param obj The box object
5421 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5423 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5424 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5425 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5427 * Add an object to the beginning of the pack list
5429 * Pack @p subobj into the box @p obj, placing it first in the list of
5430 * children objects. The actual position the object will get on screen
5431 * depends on the layout used. If no custom layout is set, it will be at
5432 * the top or left, depending if the box is vertical or horizontal,
5435 * @param obj The box object
5436 * @param subobj The object to add to the box
5438 * @see elm_box_pack_end()
5439 * @see elm_box_pack_before()
5440 * @see elm_box_pack_after()
5441 * @see elm_box_unpack()
5442 * @see elm_box_unpack_all()
5443 * @see elm_box_clear()
5445 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5447 * Add an object at the end of the pack list
5449 * Pack @p subobj into the box @p obj, placing it last in the list of
5450 * children objects. The actual position the object will get on screen
5451 * depends on the layout used. If no custom layout is set, it will be at
5452 * the bottom or right, depending if the box is vertical or horizontal,
5455 * @param obj The box object
5456 * @param subobj The object to add to the box
5458 * @see elm_box_pack_start()
5459 * @see elm_box_pack_before()
5460 * @see elm_box_pack_after()
5461 * @see elm_box_unpack()
5462 * @see elm_box_unpack_all()
5463 * @see elm_box_clear()
5465 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5467 * Adds an object to the box before the indicated object
5469 * This will add the @p subobj to the box indicated before the object
5470 * indicated with @p before. If @p before is not already in the box, results
5471 * are undefined. Before means either to the left of the indicated object or
5472 * above it depending on orientation.
5474 * @param obj The box object
5475 * @param subobj The object to add to the box
5476 * @param before The object before which to add it
5478 * @see elm_box_pack_start()
5479 * @see elm_box_pack_end()
5480 * @see elm_box_pack_after()
5481 * @see elm_box_unpack()
5482 * @see elm_box_unpack_all()
5483 * @see elm_box_clear()
5485 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5487 * Adds an object to the box after the indicated object
5489 * This will add the @p subobj to the box indicated after the object
5490 * indicated with @p after. If @p after is not already in the box, results
5491 * are undefined. After means either to the right of the indicated object or
5492 * below it depending on orientation.
5494 * @param obj The box object
5495 * @param subobj The object to add to the box
5496 * @param after The object after which to add it
5498 * @see elm_box_pack_start()
5499 * @see elm_box_pack_end()
5500 * @see elm_box_pack_before()
5501 * @see elm_box_unpack()
5502 * @see elm_box_unpack_all()
5503 * @see elm_box_clear()
5505 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5507 * Clear the box of all children
5509 * Remove all the elements contained by the box, deleting the respective
5512 * @param obj The box object
5514 * @see elm_box_unpack()
5515 * @see elm_box_unpack_all()
5517 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5521 * Remove the object given by @p subobj from the box @p obj without
5524 * @param obj The box object
5526 * @see elm_box_unpack_all()
5527 * @see elm_box_clear()
5529 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5531 * Remove all items from the box, without deleting them
5533 * Clear the box from all children, but don't delete the respective objects.
5534 * If no other references of the box children exist, the objects will never
5535 * be deleted, and thus the application will leak the memory. Make sure
5536 * when using this function that you hold a reference to all the objects
5537 * in the box @p obj.
5539 * @param obj The box object
5541 * @see elm_box_clear()
5542 * @see elm_box_unpack()
5544 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5546 * Retrieve a list of the objects packed into the box
5548 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5549 * The order of the list corresponds to the packing order the box uses.
5551 * You must free this list with eina_list_free() once you are done with it.
5553 * @param obj The box object
5555 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5557 * Set the space (padding) between the box's elements.
5559 * Extra space in pixels that will be added between a box child and its
5560 * neighbors after its containing cell has been calculated. This padding
5561 * is set for all elements in the box, besides any possible padding that
5562 * individual elements may have through their size hints.
5564 * @param obj The box object
5565 * @param horizontal The horizontal space between elements
5566 * @param vertical The vertical space between elements
5568 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5570 * Get the space (padding) between the box's elements.
5572 * @param obj The box object
5573 * @param horizontal The horizontal space between elements
5574 * @param vertical The vertical space between elements
5576 * @see elm_box_padding_set()
5578 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5580 * Set the alignment of the whole bouding box of contents.
5582 * Sets how the bounding box containing all the elements of the box, after
5583 * their sizes and position has been calculated, will be aligned within
5584 * the space given for the whole box widget.
5586 * @param obj The box object
5587 * @param horizontal The horizontal alignment of elements
5588 * @param vertical The vertical alignment of elements
5590 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5592 * Get the alignment of the whole bouding box of contents.
5594 * @param obj The box object
5595 * @param horizontal The horizontal alignment of elements
5596 * @param vertical The vertical alignment of elements
5598 * @see elm_box_align_set()
5600 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5603 * Set the layout defining function to be used by the box
5605 * Whenever anything changes that requires the box in @p obj to recalculate
5606 * the size and position of its elements, the function @p cb will be called
5607 * to determine what the layout of the children will be.
5609 * Once a custom function is set, everything about the children layout
5610 * is defined by it. The flags set by elm_box_horizontal_set() and
5611 * elm_box_homogeneous_set() no longer have any meaning, and the values
5612 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5613 * layout function to decide if they are used and how. These last two
5614 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5615 * passed to @p cb. The @c Evas_Object the function receives is not the
5616 * Elementary widget, but the internal Evas Box it uses, so none of the
5617 * functions described here can be used on it.
5619 * Any of the layout functions in @c Evas can be used here, as well as the
5620 * special elm_box_layout_transition().
5622 * The final @p data argument received by @p cb is the same @p data passed
5623 * here, and the @p free_data function will be called to free it
5624 * whenever the box is destroyed or another layout function is set.
5626 * Setting @p cb to NULL will revert back to the default layout function.
5628 * @param obj The box object
5629 * @param cb The callback function used for layout
5630 * @param data Data that will be passed to layout function
5631 * @param free_data Function called to free @p data
5633 * @see elm_box_layout_transition()
5635 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);
5637 * Special layout function that animates the transition from one layout to another
5639 * Normally, when switching the layout function for a box, this will be
5640 * reflected immediately on screen on the next render, but it's also
5641 * possible to do this through an animated transition.
5643 * This is done by creating an ::Elm_Box_Transition and setting the box
5644 * layout to this function.
5648 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5649 * evas_object_box_layout_vertical, // start
5650 * NULL, // data for initial layout
5651 * NULL, // free function for initial data
5652 * evas_object_box_layout_horizontal, // end
5653 * NULL, // data for final layout
5654 * NULL, // free function for final data
5655 * anim_end, // will be called when animation ends
5656 * NULL); // data for anim_end function\
5657 * elm_box_layout_set(box, elm_box_layout_transition, t,
5658 * elm_box_transition_free);
5661 * @note This function can only be used with elm_box_layout_set(). Calling
5662 * it directly will not have the expected results.
5664 * @see elm_box_transition_new
5665 * @see elm_box_transition_free
5666 * @see elm_box_layout_set
5668 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5670 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5672 * If you want to animate the change from one layout to another, you need
5673 * to set the layout function of the box to elm_box_layout_transition(),
5674 * passing as user data to it an instance of ::Elm_Box_Transition with the
5675 * necessary information to perform this animation. The free function to
5676 * set for the layout is elm_box_transition_free().
5678 * The parameters to create an ::Elm_Box_Transition sum up to how long
5679 * will it be, in seconds, a layout function to describe the initial point,
5680 * another for the final position of the children and one function to be
5681 * called when the whole animation ends. This last function is useful to
5682 * set the definitive layout for the box, usually the same as the end
5683 * layout for the animation, but could be used to start another transition.
5685 * @param start_layout The layout function that will be used to start the animation
5686 * @param start_layout_data The data to be passed the @p start_layout function
5687 * @param start_layout_free_data Function to free @p start_layout_data
5688 * @param end_layout The layout function that will be used to end the animation
5689 * @param end_layout_free_data The data to be passed the @p end_layout function
5690 * @param end_layout_free_data Function to free @p end_layout_data
5691 * @param transition_end_cb Callback function called when animation ends
5692 * @param transition_end_data Data to be passed to @p transition_end_cb
5693 * @return An instance of ::Elm_Box_Transition
5695 * @see elm_box_transition_new
5696 * @see elm_box_layout_transition
5698 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);
5700 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5702 * This function is mostly useful as the @c free_data parameter in
5703 * elm_box_layout_set() when elm_box_layout_transition().
5705 * @param data The Elm_Box_Transition instance to be freed.
5707 * @see elm_box_transition_new
5708 * @see elm_box_layout_transition
5710 EAPI void elm_box_transition_free(void *data);
5717 * @defgroup Button Button
5719 * @image html img/widget/button/preview-00.png
5720 * @image latex img/widget/button/preview-00.eps
5721 * @image html img/widget/button/preview-01.png
5722 * @image latex img/widget/button/preview-01.eps
5723 * @image html img/widget/button/preview-02.png
5724 * @image latex img/widget/button/preview-02.eps
5726 * This is a push-button. Press it and run some function. It can contain
5727 * a simple label and icon object and it also has an autorepeat feature.
5729 * This widgets emits the following signals:
5730 * @li "clicked": the user clicked the button (press/release).
5731 * @li "repeated": the user pressed the button without releasing it.
5732 * @li "pressed": button was pressed.
5733 * @li "unpressed": button was released after being pressed.
5734 * In all three cases, the @c event parameter of the callback will be
5737 * Also, defined in the default theme, the button has the following styles
5739 * @li default: a normal button.
5740 * @li anchor: Like default, but the button fades away when the mouse is not
5741 * over it, leaving only the text or icon.
5742 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5743 * continuous look across its options.
5744 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5746 * Follow through a complete example @ref button_example_01 "here".
5750 * Add a new button to the parent's canvas
5752 * @param parent The parent object
5753 * @return The new object or NULL if it cannot be created
5755 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5757 * Set the label used in the button
5759 * The passed @p label can be NULL to clean any existing text in it and
5760 * leave the button as an icon only object.
5762 * @param obj The button object
5763 * @param label The text will be written on the button
5764 * @deprecated use elm_object_text_set() instead.
5766 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5768 * Get the label set for the button
5770 * The string returned is an internal pointer and should not be freed or
5771 * altered. It will also become invalid when the button is destroyed.
5772 * The string returned, if not NULL, is a stringshare, so if you need to
5773 * keep it around even after the button is destroyed, you can use
5774 * eina_stringshare_ref().
5776 * @param obj The button object
5777 * @return The text set to the label, or NULL if nothing is set
5778 * @deprecated use elm_object_text_set() instead.
5780 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5782 * Set the icon used for the button
5784 * Setting a new icon will delete any other that was previously set, making
5785 * any reference to them invalid. If you need to maintain the previous
5786 * object alive, unset it first with elm_button_icon_unset().
5788 * @param obj The button object
5789 * @param icon The icon object for the button
5791 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5793 * Get the icon used for the button
5795 * Return the icon object which is set for this widget. If the button is
5796 * destroyed or another icon is set, the returned object will be deleted
5797 * and any reference to it will be invalid.
5799 * @param obj The button object
5800 * @return The icon object that is being used
5802 * @see elm_button_icon_unset()
5804 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5806 * Remove the icon set without deleting it and return the object
5808 * This function drops the reference the button holds of the icon object
5809 * and returns this last object. It is used in case you want to remove any
5810 * icon, or set another one, without deleting the actual object. The button
5811 * will be left without an icon set.
5813 * @param obj The button object
5814 * @return The icon object that was being used
5816 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5818 * Turn on/off the autorepeat event generated when the button is kept pressed
5820 * When off, no autorepeat is performed and buttons emit a normal @c clicked
5821 * signal when they are clicked.
5823 * When on, keeping a button pressed will continuously emit a @c repeated
5824 * signal until the button is released. The time it takes until it starts
5825 * emitting the signal is given by
5826 * elm_button_autorepeat_initial_timeout_set(), and the time between each
5827 * new emission by elm_button_autorepeat_gap_timeout_set().
5829 * @param obj The button object
5830 * @param on A bool to turn on/off the event
5832 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5834 * Get whether the autorepeat feature is enabled
5836 * @param obj The button object
5837 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5839 * @see elm_button_autorepeat_set()
5841 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5843 * Set the initial timeout before the autorepeat event is generated
5845 * Sets the timeout, in seconds, since the button is pressed until the
5846 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5847 * won't be any delay and the even will be fired the moment the button is
5850 * @param obj The button object
5851 * @param t Timeout in seconds
5853 * @see elm_button_autorepeat_set()
5854 * @see elm_button_autorepeat_gap_timeout_set()
5856 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5858 * Get the initial timeout before the autorepeat event is generated
5860 * @param obj The button object
5861 * @return Timeout in seconds
5863 * @see elm_button_autorepeat_initial_timeout_set()
5865 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5867 * Set the interval between each generated autorepeat event
5869 * After the first @c repeated event is fired, all subsequent ones will
5870 * follow after a delay of @p t seconds for each.
5872 * @param obj The button object
5873 * @param t Interval in seconds
5875 * @see elm_button_autorepeat_initial_timeout_set()
5877 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5879 * Get the interval between each generated autorepeat event
5881 * @param obj The button object
5882 * @return Interval in seconds
5884 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5890 * @defgroup File_Selector_Button File Selector Button
5892 * @image html img/widget/fileselector_button/preview-00.png
5893 * @image latex img/widget/fileselector_button/preview-00.eps
5894 * @image html img/widget/fileselector_button/preview-01.png
5895 * @image latex img/widget/fileselector_button/preview-01.eps
5896 * @image html img/widget/fileselector_button/preview-02.png
5897 * @image latex img/widget/fileselector_button/preview-02.eps
5899 * This is a button that, when clicked, creates an Elementary
5900 * window (or inner window) <b> with a @ref Fileselector "file
5901 * selector widget" within</b>. When a file is chosen, the (inner)
5902 * window is closed and the button emits a signal having the
5903 * selected file as it's @c event_info.
5905 * This widget encapsulates operations on its internal file
5906 * selector on its own API. There is less control over its file
5907 * selector than that one would have instatiating one directly.
5909 * The following styles are available for this button:
5912 * @li @c "hoversel_vertical"
5913 * @li @c "hoversel_vertical_entry"
5915 * Smart callbacks one can register to:
5916 * - @c "file,chosen" - the user has selected a path, whose string
5917 * pointer comes as the @c event_info data (a stringshared
5920 * Here is an example on its usage:
5921 * @li @ref fileselector_button_example
5923 * @see @ref File_Selector_Entry for a similar widget.
5928 * Add a new file selector button widget to the given parent
5929 * Elementary (container) object
5931 * @param parent The parent object
5932 * @return a new file selector button widget handle or @c NULL, on
5935 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5938 * Set the label for a given file selector button widget
5940 * @param obj The file selector button widget
5941 * @param label The text label to be displayed on @p obj
5943 * @deprecated use elm_object_text_set() instead.
5945 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5948 * Get the label set for a given file selector button widget
5950 * @param obj The file selector button widget
5951 * @return The button label
5953 * @deprecated use elm_object_text_set() instead.
5955 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5958 * Set the icon on a given file selector button widget
5960 * @param obj The file selector button widget
5961 * @param icon The icon object for the button
5963 * Once the icon object is set, a previously set one will be
5964 * deleted. If you want to keep the latter, use the
5965 * elm_fileselector_button_icon_unset() function.
5967 * @see elm_fileselector_button_icon_get()
5969 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5972 * Get the icon set for a given file selector button widget
5974 * @param obj The file selector button widget
5975 * @return The icon object currently set on @p obj or @c NULL, if
5978 * @see elm_fileselector_button_icon_set()
5980 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5983 * Unset the icon used in a given file selector button widget
5985 * @param obj The file selector button widget
5986 * @return The icon object that was being used on @p obj or @c
5989 * Unparent and return the icon object which was set for this
5992 * @see elm_fileselector_button_icon_set()
5994 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5997 * Set the title for a given file selector button widget's window
5999 * @param obj The file selector button widget
6000 * @param title The title string
6002 * This will change the window's title, when the file selector pops
6003 * out after a click on the button. Those windows have the default
6004 * (unlocalized) value of @c "Select a file" as titles.
6006 * @note It will only take any effect if the file selector
6007 * button widget is @b not under "inwin mode".
6009 * @see elm_fileselector_button_window_title_get()
6011 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6014 * Get the title set for a given file selector button widget's
6017 * @param obj The file selector button widget
6018 * @return Title of the file selector button's window
6020 * @see elm_fileselector_button_window_title_get() for more details
6022 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6025 * Set the size of a given file selector button widget's window,
6026 * holding the file selector itself.
6028 * @param obj The file selector button widget
6029 * @param width The window's width
6030 * @param height The window's height
6032 * @note it will only take any effect if the file selector button
6033 * widget is @b not under "inwin mode". The default size for the
6034 * window (when applicable) is 400x400 pixels.
6036 * @see elm_fileselector_button_window_size_get()
6038 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6041 * Get the size of a given file selector button widget's window,
6042 * holding the file selector itself.
6044 * @param obj The file selector button widget
6045 * @param width Pointer into which to store the width value
6046 * @param height Pointer into which to store the height value
6048 * @note Use @c NULL pointers on the size values you're not
6049 * interested in: they'll be ignored by the function.
6051 * @see elm_fileselector_button_window_size_set(), for more details
6053 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6056 * Set the initial file system path for a given file selector
6059 * @param obj The file selector button widget
6060 * @param path The path string
6062 * It must be a <b>directory</b> path, which will have the contents
6063 * displayed initially in the file selector's view, when invoked
6064 * from @p obj. The default initial path is the @c "HOME"
6065 * environment variable's value.
6067 * @see elm_fileselector_button_path_get()
6069 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6072 * Get the initial file system path set for a given file selector
6075 * @param obj The file selector button widget
6076 * @return path The path string
6078 * @see elm_fileselector_button_path_set() for more details
6080 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6083 * Enable/disable a tree view in the given file selector button
6084 * widget's internal file selector
6086 * @param obj The file selector button widget
6087 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6090 * This has the same effect as elm_fileselector_expandable_set(),
6091 * but now applied to a file selector button's internal file
6094 * @note There's no way to put a file selector button's internal
6095 * file selector in "grid mode", as one may do with "pure" file
6098 * @see elm_fileselector_expandable_get()
6100 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6103 * Get whether tree view is enabled for the given file selector
6104 * button widget's internal file selector
6106 * @param obj The file selector button widget
6107 * @return @c EINA_TRUE if @p obj widget's internal file selector
6108 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6110 * @see elm_fileselector_expandable_set() for more details
6112 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6115 * Set whether a given file selector button widget's internal file
6116 * selector is to display folders only or the directory contents,
6119 * @param obj The file selector button widget
6120 * @param only @c EINA_TRUE to make @p obj widget's internal file
6121 * selector only display directories, @c EINA_FALSE to make files
6122 * to be displayed in it too
6124 * This has the same effect as elm_fileselector_folder_only_set(),
6125 * but now applied to a file selector button's internal file
6128 * @see elm_fileselector_folder_only_get()
6130 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6133 * Get whether a given file selector button widget's internal file
6134 * selector is displaying folders only or the directory contents,
6137 * @param obj The file selector button widget
6138 * @return @c EINA_TRUE if @p obj widget's internal file
6139 * selector is only displaying directories, @c EINA_FALSE if files
6140 * are being displayed in it too (and on errors)
6142 * @see elm_fileselector_button_folder_only_set() for more details
6144 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6147 * Enable/disable the file name entry box where the user can type
6148 * in a name for a file, in a given file selector button widget's
6149 * internal file selector.
6151 * @param obj The file selector button widget
6152 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6153 * file selector a "saving dialog", @c EINA_FALSE otherwise
6155 * This has the same effect as elm_fileselector_is_save_set(),
6156 * but now applied to a file selector button's internal file
6159 * @see elm_fileselector_is_save_get()
6161 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6164 * Get whether the given file selector button widget's internal
6165 * file selector is in "saving dialog" mode
6167 * @param obj The file selector button widget
6168 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6169 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6172 * @see elm_fileselector_button_is_save_set() for more details
6174 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6177 * Set whether a given file selector button widget's internal file
6178 * selector will raise an Elementary "inner window", instead of a
6179 * dedicated Elementary window. By default, it won't.
6181 * @param obj The file selector button widget
6182 * @param value @c EINA_TRUE to make it use an inner window, @c
6183 * EINA_TRUE to make it use a dedicated window
6185 * @see elm_win_inwin_add() for more information on inner windows
6186 * @see elm_fileselector_button_inwin_mode_get()
6188 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6191 * Get whether a given file selector button widget's internal file
6192 * selector will raise an Elementary "inner window", instead of a
6193 * dedicated Elementary window.
6195 * @param obj The file selector button widget
6196 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6197 * if it will use a dedicated window
6199 * @see elm_fileselector_button_inwin_mode_set() for more details
6201 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6208 * @defgroup File_Selector_Entry File Selector Entry
6210 * @image html img/widget/fileselector_entry/preview-00.png
6211 * @image latex img/widget/fileselector_entry/preview-00.eps
6213 * This is an entry made to be filled with or display a <b>file
6214 * system path string</b>. Besides the entry itself, the widget has
6215 * a @ref File_Selector_Button "file selector button" on its side,
6216 * which will raise an internal @ref Fileselector "file selector widget",
6217 * when clicked, for path selection aided by file system
6220 * This file selector may appear in an Elementary window or in an
6221 * inner window. When a file is chosen from it, the (inner) window
6222 * is closed and the selected file's path string is exposed both as
6223 * an smart event and as the new text on the entry.
6225 * This widget encapsulates operations on its internal file
6226 * selector on its own API. There is less control over its file
6227 * selector than that one would have instatiating one directly.
6229 * Smart callbacks one can register to:
6230 * - @c "changed" - The text within the entry was changed
6231 * - @c "activated" - The entry has had editing finished and
6232 * changes are to be "committed"
6233 * - @c "press" - The entry has been clicked
6234 * - @c "longpressed" - The entry has been clicked (and held) for a
6236 * - @c "clicked" - The entry has been clicked
6237 * - @c "clicked,double" - The entry has been double clicked
6238 * - @c "focused" - The entry has received focus
6239 * - @c "unfocused" - The entry has lost focus
6240 * - @c "selection,paste" - A paste action has occurred on the
6242 * - @c "selection,copy" - A copy action has occurred on the entry
6243 * - @c "selection,cut" - A cut action has occurred on the entry
6244 * - @c "unpressed" - The file selector entry's button was released
6245 * after being pressed.
6246 * - @c "file,chosen" - The user has selected a path via the file
6247 * selector entry's internal file selector, whose string pointer
6248 * comes as the @c event_info data (a stringshared string)
6250 * Here is an example on its usage:
6251 * @li @ref fileselector_entry_example
6253 * @see @ref File_Selector_Button for a similar widget.
6258 * Add a new file selector entry widget to the given parent
6259 * Elementary (container) object
6261 * @param parent The parent object
6262 * @return a new file selector entry widget handle or @c NULL, on
6265 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6268 * Set the label for a given file selector entry widget's button
6270 * @param obj The file selector entry widget
6271 * @param label The text label to be displayed on @p obj widget's
6274 * @deprecated use elm_object_text_set() instead.
6276 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6279 * Get the label set for a given file selector entry widget's button
6281 * @param obj The file selector entry widget
6282 * @return The widget button's label
6284 * @deprecated use elm_object_text_set() instead.
6286 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6289 * Set the icon on a given file selector entry widget's button
6291 * @param obj The file selector entry widget
6292 * @param icon The icon object for the entry's button
6294 * Once the icon object is set, a previously set one will be
6295 * deleted. If you want to keep the latter, use the
6296 * elm_fileselector_entry_button_icon_unset() function.
6298 * @see elm_fileselector_entry_button_icon_get()
6300 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6303 * Get the icon set for a given file selector entry widget's button
6305 * @param obj The file selector entry widget
6306 * @return The icon object currently set on @p obj widget's button
6307 * or @c NULL, if none is
6309 * @see elm_fileselector_entry_button_icon_set()
6311 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6314 * Unset the icon used in a given file selector entry widget's
6317 * @param obj The file selector entry widget
6318 * @return The icon object that was being used on @p obj widget's
6319 * button or @c NULL, on errors
6321 * Unparent and return the icon object which was set for this
6324 * @see elm_fileselector_entry_button_icon_set()
6326 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6329 * Set the title for a given file selector entry widget's window
6331 * @param obj The file selector entry widget
6332 * @param title The title string
6334 * This will change the window's title, when the file selector pops
6335 * out after a click on the entry's button. Those windows have the
6336 * default (unlocalized) value of @c "Select a file" as titles.
6338 * @note It will only take any effect if the file selector
6339 * entry widget is @b not under "inwin mode".
6341 * @see elm_fileselector_entry_window_title_get()
6343 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6346 * Get the title set for a given file selector entry widget's
6349 * @param obj The file selector entry widget
6350 * @return Title of the file selector entry's window
6352 * @see elm_fileselector_entry_window_title_get() for more details
6354 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6357 * Set the size of a given file selector entry widget's window,
6358 * holding the file selector itself.
6360 * @param obj The file selector entry widget
6361 * @param width The window's width
6362 * @param height The window's height
6364 * @note it will only take any effect if the file selector entry
6365 * widget is @b not under "inwin mode". The default size for the
6366 * window (when applicable) is 400x400 pixels.
6368 * @see elm_fileselector_entry_window_size_get()
6370 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6373 * Get the size of a given file selector entry widget's window,
6374 * holding the file selector itself.
6376 * @param obj The file selector entry widget
6377 * @param width Pointer into which to store the width value
6378 * @param height Pointer into which to store the height value
6380 * @note Use @c NULL pointers on the size values you're not
6381 * interested in: they'll be ignored by the function.
6383 * @see elm_fileselector_entry_window_size_set(), for more details
6385 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6388 * Set the initial file system path and the entry's path string for
6389 * a given file selector entry widget
6391 * @param obj The file selector entry widget
6392 * @param path The path string
6394 * It must be a <b>directory</b> path, which will have the contents
6395 * displayed initially in the file selector's view, when invoked
6396 * from @p obj. The default initial path is the @c "HOME"
6397 * environment variable's value.
6399 * @see elm_fileselector_entry_path_get()
6401 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6404 * Get the entry's path string for a given file selector entry
6407 * @param obj The file selector entry widget
6408 * @return path The path string
6410 * @see elm_fileselector_entry_path_set() for more details
6412 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6415 * Enable/disable a tree view in the given file selector entry
6416 * widget's internal file selector
6418 * @param obj The file selector entry widget
6419 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6422 * This has the same effect as elm_fileselector_expandable_set(),
6423 * but now applied to a file selector entry's internal file
6426 * @note There's no way to put a file selector entry's internal
6427 * file selector in "grid mode", as one may do with "pure" file
6430 * @see elm_fileselector_expandable_get()
6432 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6435 * Get whether tree view is enabled for the given file selector
6436 * entry widget's internal file selector
6438 * @param obj The file selector entry widget
6439 * @return @c EINA_TRUE if @p obj widget's internal file selector
6440 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6442 * @see elm_fileselector_expandable_set() for more details
6444 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6447 * Set whether a given file selector entry widget's internal file
6448 * selector is to display folders only or the directory contents,
6451 * @param obj The file selector entry widget
6452 * @param only @c EINA_TRUE to make @p obj widget's internal file
6453 * selector only display directories, @c EINA_FALSE to make files
6454 * to be displayed in it too
6456 * This has the same effect as elm_fileselector_folder_only_set(),
6457 * but now applied to a file selector entry's internal file
6460 * @see elm_fileselector_folder_only_get()
6462 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6465 * Get whether a given file selector entry widget's internal file
6466 * selector is displaying folders only or the directory contents,
6469 * @param obj The file selector entry widget
6470 * @return @c EINA_TRUE if @p obj widget's internal file
6471 * selector is only displaying directories, @c EINA_FALSE if files
6472 * are being displayed in it too (and on errors)
6474 * @see elm_fileselector_entry_folder_only_set() for more details
6476 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6479 * Enable/disable the file name entry box where the user can type
6480 * in a name for a file, in a given file selector entry widget's
6481 * internal file selector.
6483 * @param obj The file selector entry widget
6484 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6485 * file selector a "saving dialog", @c EINA_FALSE otherwise
6487 * This has the same effect as elm_fileselector_is_save_set(),
6488 * but now applied to a file selector entry's internal file
6491 * @see elm_fileselector_is_save_get()
6493 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6496 * Get whether the given file selector entry widget's internal
6497 * file selector is in "saving dialog" mode
6499 * @param obj The file selector entry widget
6500 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6501 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6504 * @see elm_fileselector_entry_is_save_set() for more details
6506 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6509 * Set whether a given file selector entry widget's internal file
6510 * selector will raise an Elementary "inner window", instead of a
6511 * dedicated Elementary window. By default, it won't.
6513 * @param obj The file selector entry widget
6514 * @param value @c EINA_TRUE to make it use an inner window, @c
6515 * EINA_TRUE to make it use a dedicated window
6517 * @see elm_win_inwin_add() for more information on inner windows
6518 * @see elm_fileselector_entry_inwin_mode_get()
6520 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6523 * Get whether a given file selector entry widget's internal file
6524 * selector will raise an Elementary "inner window", instead of a
6525 * dedicated Elementary window.
6527 * @param obj The file selector entry widget
6528 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6529 * if it will use a dedicated window
6531 * @see elm_fileselector_entry_inwin_mode_set() for more details
6533 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6536 * Set the initial file system path for a given file selector entry
6539 * @param obj The file selector entry widget
6540 * @param path The path string
6542 * It must be a <b>directory</b> path, which will have the contents
6543 * displayed initially in the file selector's view, when invoked
6544 * from @p obj. The default initial path is the @c "HOME"
6545 * environment variable's value.
6547 * @see elm_fileselector_entry_path_get()
6549 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6552 * Get the parent directory's path to the latest file selection on
6553 * a given filer selector entry widget
6555 * @param obj The file selector object
6556 * @return The (full) path of the directory of the last selection
6557 * on @p obj widget, a @b stringshared string
6559 * @see elm_fileselector_entry_path_set()
6561 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6568 * @defgroup Scroller Scroller
6570 * A scroller holds a single object and "scrolls it around". This means that
6571 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6572 * region around, allowing to move through a much larger object that is
6573 * contained in the scroller. The scroiller will always have a small minimum
6574 * size by default as it won't be limited by the contents of the scroller.
6576 * Signals that you can add callbacks for are:
6577 * @li "edge,left" - the left edge of the content has been reached
6578 * @li "edge,right" - the right edge of the content has been reached
6579 * @li "edge,top" - the top edge of the content has been reached
6580 * @li "edge,bottom" - the bottom edge of the content has been reached
6581 * @li "scroll" - the content has been scrolled (moved)
6582 * @li "scroll,anim,start" - scrolling animation has started
6583 * @li "scroll,anim,stop" - scrolling animation has stopped
6584 * @li "scroll,drag,start" - dragging the contents around has started
6585 * @li "scroll,drag,stop" - dragging the contents around has stopped
6586 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6589 * @note When Elemementary is in embedded mode the scrollbars will not be
6590 * dragable, they appear merely as indicators of how much has been scrolled.
6591 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6592 * fingerscroll) won't work.
6594 * In @ref tutorial_scroller you'll find an example of how to use most of
6599 * @brief Type that controls when scrollbars should appear.
6601 * @see elm_scroller_policy_set()
6603 typedef enum _Elm_Scroller_Policy
6605 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6606 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6607 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6608 ELM_SCROLLER_POLICY_LAST
6609 } Elm_Scroller_Policy;
6611 * @brief Add a new scroller to the parent
6613 * @param parent The parent object
6614 * @return The new object or NULL if it cannot be created
6616 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6618 * @brief Set the content of the scroller widget (the object to be scrolled around).
6620 * @param obj The scroller object
6621 * @param content The new content object
6623 * Once the content object is set, a previously set one will be deleted.
6624 * If you want to keep that old content object, use the
6625 * elm_scroller_content_unset() function.
6627 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6629 * @brief Get the content of the scroller widget
6631 * @param obj The slider object
6632 * @return The content that is being used
6634 * Return the content object which is set for this widget
6636 * @see elm_scroller_content_set()
6638 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6640 * @brief Unset the content of the scroller widget
6642 * @param obj The slider object
6643 * @return The content that was being used
6645 * Unparent and return the content object which was set for this widget
6647 * @see elm_scroller_content_set()
6649 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6651 * @brief Set custom theme elements for the scroller
6653 * @param obj The scroller object
6654 * @param widget The widget name to use (default is "scroller")
6655 * @param base The base name to use (default is "base")
6657 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6659 * @brief Make the scroller minimum size limited to the minimum size of the content
6661 * @param obj The scroller object
6662 * @param w Enable limiting minimum size horizontally
6663 * @param h Enable limiting minimum size vertically
6665 * By default the scroller will be as small as its design allows,
6666 * irrespective of its content. This will make the scroller minimum size the
6667 * right size horizontally and/or vertically to perfectly fit its content in
6670 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6672 * @brief Show a specific virtual region within the scroller content object
6674 * @param obj The scroller object
6675 * @param x X coordinate of the region
6676 * @param y Y coordinate of the region
6677 * @param w Width of the region
6678 * @param h Height of the region
6680 * This will ensure all (or part if it does not fit) of the designated
6681 * region in the virtual content object (0, 0 starting at the top-left of the
6682 * virtual content object) is shown within the scroller.
6684 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);
6686 * @brief Set the scrollbar visibility policy
6688 * @param obj The scroller object
6689 * @param policy_h Horizontal scrollbar policy
6690 * @param policy_v Vertical scrollbar policy
6692 * This sets the scrollbar visibility policy for the given scroller.
6693 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6694 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6695 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6696 * respectively for the horizontal and vertical scrollbars.
6698 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6700 * @brief Gets scrollbar visibility policy
6702 * @param obj The scroller object
6703 * @param policy_h Horizontal scrollbar policy
6704 * @param policy_v Vertical scrollbar policy
6706 * @see elm_scroller_policy_set()
6708 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6710 * @brief Get the currently visible content region
6712 * @param obj The scroller object
6713 * @param x X coordinate of the region
6714 * @param y Y coordinate of the region
6715 * @param w Width of the region
6716 * @param h Height of the region
6718 * This gets the current region in the content object that is visible through
6719 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6720 * w, @p h values pointed to.
6722 * @note All coordinates are relative to the content.
6724 * @see elm_scroller_region_show()
6726 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);
6728 * @brief Get the size of the content object
6730 * @param obj The scroller object
6731 * @param w Width return
6732 * @param h Height return
6734 * This gets the size of the content object of the scroller.
6736 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6738 * @brief Set bouncing behavior
6740 * @param obj The scroller object
6741 * @param h_bounce Will the scroller bounce horizontally or not
6742 * @param v_bounce Will the scroller bounce vertically or not
6744 * When scrolling, the scroller may "bounce" when reaching an edge of the
6745 * content object. This is a visual way to indicate the end has been reached.
6746 * This is enabled by default for both axis. This will set if it is enabled
6747 * for that axis with the boolean parameters for each axis.
6749 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6751 * @brief Get the bounce mode
6753 * @param obj The Scroller object
6754 * @param h_bounce Allow bounce horizontally
6755 * @param v_bounce Allow bounce vertically
6757 * @see elm_scroller_bounce_set()
6759 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6761 * @brief Set scroll page size relative to viewport size.
6763 * @param obj The scroller object
6764 * @param h_pagerel The horizontal page relative size
6765 * @param v_pagerel The vertical page relative size
6767 * The scroller is capable of limiting scrolling by the user to "pages". That
6768 * is to jump by and only show a "whole page" at a time as if the continuous
6769 * area of the scroller content is split into page sized pieces. This sets
6770 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6771 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6772 * axis. This is mutually exclusive with page size
6773 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6774 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6775 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6778 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6780 * @brief Set scroll page size.
6782 * @param obj The scroller object
6783 * @param h_pagesize The horizontal page size
6784 * @param v_pagesize The vertical page size
6786 * This sets the page size to an absolute fixed value, with 0 turning it off
6789 * @see elm_scroller_page_relative_set()
6791 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6793 * @brief Show a specific virtual region within the scroller content object.
6795 * @param obj The scroller object
6796 * @param x X coordinate of the region
6797 * @param y Y coordinate of the region
6798 * @param w Width of the region
6799 * @param h Height of the region
6801 * This will ensure all (or part if it does not fit) of the designated
6802 * region in the virtual content object (0, 0 starting at the top-left of the
6803 * virtual content object) is shown within the scroller. Unlike
6804 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
6805 * to this location (if configuration in general calls for transitions). It
6806 * may not jump immediately to the new location and make take a while and
6807 * show other content along the way.
6809 * @see elm_scroller_region_show()
6811 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);
6813 * @brief Set event propagation on a scroller
6815 * @param obj The scroller object
6816 * @param propagation If propagation is enabled or not
6818 * This enables or disabled event propagation from the scroller content to
6819 * the scroller and its parent. By default event propagation is disabled.
6821 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
6823 * @brief Get event propagation for a scroller
6825 * @param obj The scroller object
6826 * @return The propagation state
6828 * This gets the event propagation for a scroller.
6830 * @see elm_scroller_propagate_events_set()
6832 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
6838 * @defgroup Label Label
6840 * @image html img/widget/label/preview-00.png
6841 * @image latex img/widget/label/preview-00.eps
6843 * @brief Widget to display text, with simple html-like markup.
6845 * The Label widget @b doesn't allow text to overflow its boundaries, if the
6846 * text doesn't fit the geometry of the label it will be ellipsized or be
6847 * cut. Elementary provides several themes for this widget:
6848 * @li default - No animation
6849 * @li marker - Centers the text in the label and make it bold by default
6850 * @li slide_long - The entire text appears from the right of the screen and
6851 * slides until it disappears in the left of the screen(reappering on the
6853 * @li slide_short - The text appears in the left of the label and slides to
6854 * the right to show the overflow. When all of the text has been shown the
6855 * position is reset.
6856 * @li slide_bounce - The text appears in the left of the label and slides to
6857 * the right to show the overflow. When all of the text has been shown the
6858 * animation reverses, moving the text to the left.
6860 * Custom themes can of course invent new markup tags and style them any way
6863 * See @ref tutorial_label for a demonstration of how to use a label widget.
6867 * @brief Add a new label to the parent
6869 * @param parent The parent object
6870 * @return The new object or NULL if it cannot be created
6872 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6874 * @brief Set the label on the label object
6876 * @param obj The label object
6877 * @param label The label will be used on the label object
6878 * @deprecated See elm_object_text_set()
6880 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 */
6882 * @brief Get the label used on the label object
6884 * @param obj The label object
6885 * @return The string inside the label
6886 * @deprecated See elm_object_text_get()
6888 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
6890 * @brief Set the wrapping behavior of the label
6892 * @param obj The label object
6893 * @param wrap To wrap text or not
6895 * By default no wrapping is done. Possible values for @p wrap are:
6896 * @li ELM_WRAP_NONE - No wrapping
6897 * @li ELM_WRAP_CHAR - wrap between characters
6898 * @li ELM_WRAP_WORD - wrap between words
6899 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
6901 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6903 * @brief Get the wrapping behavior of the label
6905 * @param obj The label object
6908 * @see elm_label_line_wrap_set()
6910 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6912 * @brief Set wrap width of the label
6914 * @param obj The label object
6915 * @param w The wrap width in pixels at a minimum where words need to wrap
6917 * This function sets the maximum width size hint of the label.
6919 * @warning This is only relevant if the label is inside a container.
6921 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
6923 * @brief Get wrap width of the label
6925 * @param obj The label object
6926 * @return The wrap width in pixels at a minimum where words need to wrap
6928 * @see elm_label_wrap_width_set()
6930 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6932 * @brief Set wrap height of the label
6934 * @param obj The label object
6935 * @param h The wrap height in pixels at a minimum where words need to wrap
6937 * This function sets the maximum height size hint of the label.
6939 * @warning This is only relevant if the label is inside a container.
6941 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
6943 * @brief get wrap width of the label
6945 * @param obj The label object
6946 * @return The wrap height in pixels at a minimum where words need to wrap
6948 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6950 * @brief Set the font size on the label object.
6952 * @param obj The label object
6953 * @param size font size
6955 * @warning NEVER use this. It is for hyper-special cases only. use styles
6956 * instead. e.g. "big", "medium", "small" - or better name them by use:
6957 * "title", "footnote", "quote" etc.
6959 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
6961 * @brief Set the text color on the label object
6963 * @param obj The label object
6964 * @param r Red property background color of The label object
6965 * @param g Green property background color of The label object
6966 * @param b Blue property background color of The label object
6967 * @param a Alpha property background color of The label object
6969 * @warning NEVER use this. It is for hyper-special cases only. use styles
6970 * instead. e.g. "big", "medium", "small" - or better name them by use:
6971 * "title", "footnote", "quote" etc.
6973 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);
6975 * @brief Set the text align on the label object
6977 * @param obj The label object
6978 * @param align align mode ("left", "center", "right")
6980 * @warning NEVER use this. It is for hyper-special cases only. use styles
6981 * instead. e.g. "big", "medium", "small" - or better name them by use:
6982 * "title", "footnote", "quote" etc.
6984 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
6986 * @brief Set background color of the label
6988 * @param obj The label object
6989 * @param r Red property background color of The label object
6990 * @param g Green property background color of The label object
6991 * @param b Blue property background color of The label object
6992 * @param a Alpha property background alpha of The label object
6994 * @warning NEVER use this. It is for hyper-special cases only. use styles
6995 * instead. e.g. "big", "medium", "small" - or better name them by use:
6996 * "title", "footnote", "quote" etc.
6998 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);
7000 * @brief Set the ellipsis behavior of the label
7002 * @param obj The label object
7003 * @param ellipsis To ellipsis text or not
7005 * If set to true and the text doesn't fit in the label an ellipsis("...")
7006 * will be shown at the end of the widget.
7008 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7009 * choosen wrap method was ELM_WRAP_WORD.
7011 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7013 * @brief Set the text slide of the label
7015 * @param obj The label object
7016 * @param slide To start slide or stop
7018 * If set to true the text of the label will slide throught the length of
7021 * @warning This only work with the themes "slide_short", "slide_long" and
7024 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7026 * @brief Get the text slide mode of the label
7028 * @param obj The label object
7029 * @return slide slide mode value
7031 * @see elm_label_slide_set()
7033 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7035 * @brief Set the slide duration(speed) of the label
7037 * @param obj The label object
7038 * @return The duration in seconds in moving text from slide begin position
7039 * to slide end position
7041 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7043 * @brief Get the slide duration(speed) of the label
7045 * @param obj The label object
7046 * @return The duration time in moving text from slide begin position to slide end position
7048 * @see elm_label_slide_duration_set()
7050 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7056 * @defgroup Toggle Toggle
7058 * @image html img/widget/toggle/preview-00.png
7059 * @image latex img/widget/toggle/preview-00.eps
7061 * @brief A toggle is a slider which can be used to toggle between
7062 * two values. It has two states: on and off.
7064 * Signals that you can add callbacks for are:
7065 * @li "changed" - Whenever the toggle value has been changed. Is not called
7066 * until the toggle is released by the cursor (assuming it
7067 * has been triggered by the cursor in the first place).
7069 * @ref tutorial_toggle show how to use a toggle.
7073 * @brief Add a toggle to @p parent.
7075 * @param parent The parent object
7077 * @return The toggle object
7079 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7081 * @brief Sets the label to be displayed with the toggle.
7083 * @param obj The toggle object
7084 * @param label The label to be displayed
7086 * @deprecated use elm_object_text_set() instead.
7088 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7090 * @brief Gets the label of the toggle
7092 * @param obj toggle object
7093 * @return The label of the toggle
7095 * @deprecated use elm_object_text_get() instead.
7097 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7099 * @brief Set the icon used for the toggle
7101 * @param obj The toggle object
7102 * @param icon The icon object for the button
7104 * Once the icon object is set, a previously set one will be deleted
7105 * If you want to keep that old content object, use the
7106 * elm_toggle_icon_unset() function.
7108 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7110 * @brief Get the icon used for the toggle
7112 * @param obj The toggle object
7113 * @return The icon object that is being used
7115 * Return the icon object which is set for this widget.
7117 * @see elm_toggle_icon_set()
7119 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7121 * @brief Unset the icon used for the toggle
7123 * @param obj The toggle object
7124 * @return The icon object that was being used
7126 * Unparent and return the icon object which was set for this widget.
7128 * @see elm_toggle_icon_set()
7130 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7132 * @brief Sets the labels to be associated with the on and off states of the toggle.
7134 * @param obj The toggle object
7135 * @param onlabel The label displayed when the toggle is in the "on" state
7136 * @param offlabel The label displayed when the toggle is in the "off" state
7138 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7140 * @brief Gets the labels associated with the on and off states of the toggle.
7142 * @param obj The toggle object
7143 * @param onlabel A char** to place the onlabel of @p obj into
7144 * @param offlabel A char** to place the offlabel of @p obj into
7146 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7148 * @brief Sets the state of the toggle to @p state.
7150 * @param obj The toggle object
7151 * @param state The state of @p obj
7153 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7155 * @brief Gets the state of the toggle to @p state.
7157 * @param obj The toggle object
7158 * @return The state of @p obj
7160 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7162 * @brief Sets the state pointer of the toggle to @p statep.
7164 * @param obj The toggle object
7165 * @param statep The state pointer of @p obj
7167 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7173 * @defgroup Frame Frame
7175 * @image html img/widget/frame/preview-00.png
7176 * @image latex img/widget/frame/preview-00.eps
7178 * @brief Frame is a widget that holds some content and has a title.
7180 * The default look is a frame with a title, but Frame supports multple
7188 * @li outdent_bottom
7190 * Of all this styles only default shows the title. Frame emits no signals.
7192 * For a detailed example see the @ref tutorial_frame.
7197 * @brief Add a new frame to the parent
7199 * @param parent The parent object
7200 * @return The new object or NULL if it cannot be created
7202 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7204 * @brief Set the frame label
7206 * @param obj The frame object
7207 * @param label The label of this frame object
7209 * @deprecated use elm_object_text_set() instead.
7211 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7213 * @brief Get the frame label
7215 * @param obj The frame object
7217 * @return The label of this frame objet or NULL if unable to get frame
7219 * @deprecated use elm_object_text_get() instead.
7221 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7223 * @brief Set the content of the frame widget
7225 * Once the content object is set, a previously set one will be deleted.
7226 * If you want to keep that old content object, use the
7227 * elm_frame_content_unset() function.
7229 * @param obj The frame object
7230 * @param content The content will be filled in this frame object
7232 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7234 * @brief Get the content of the frame widget
7236 * Return the content object which is set for this widget
7238 * @param obj The frame object
7239 * @return The content that is being used
7241 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7243 * @brief Unset the content of the frame widget
7245 * Unparent and return the content object which was set for this widget
7247 * @param obj The frame object
7248 * @return The content that was being used
7250 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7256 * @defgroup Table Table
7258 * A container widget to arrange other widgets in a table where items can
7259 * also span multiple columns or rows - even overlap (and then be raised or
7260 * lowered accordingly to adjust stacking if they do overlap).
7262 * The followin are examples of how to use a table:
7263 * @li @ref tutorial_table_01
7264 * @li @ref tutorial_table_02
7269 * @brief Add a new table to the parent
7271 * @param parent The parent object
7272 * @return The new object or NULL if it cannot be created
7274 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7276 * @brief Set the homogeneous layout in the table
7278 * @param obj The layout object
7279 * @param homogeneous A boolean to set if the layout is homogeneous in the
7280 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7282 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7284 * @brief Get the current table homogeneous mode.
7286 * @param obj The table object
7287 * @return A boolean to indicating if the layout is homogeneous in the table
7288 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7290 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7292 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7294 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7296 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7298 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7300 * @brief Set padding between cells.
7302 * @param obj The layout object.
7303 * @param horizontal set the horizontal padding.
7304 * @param vertical set the vertical padding.
7306 * Default value is 0.
7308 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7310 * @brief Get padding between cells.
7312 * @param obj The layout object.
7313 * @param horizontal set the horizontal padding.
7314 * @param vertical set the vertical padding.
7316 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7318 * @brief Add a subobject on the table with the coordinates passed
7320 * @param obj The table object
7321 * @param subobj The subobject to be added to the table
7322 * @param x Row number
7323 * @param y Column number
7327 * @note All positioning inside the table is relative to rows and columns, so
7328 * a value of 0 for x and y, means the top left cell of the table, and a
7329 * value of 1 for w and h means @p subobj only takes that 1 cell.
7331 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7333 * @brief Remove child from table.
7335 * @param obj The table object
7336 * @param subobj The subobject
7338 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7340 * @brief Faster way to remove all child objects from a table object.
7342 * @param obj The table object
7343 * @param clear If true, will delete children, else just remove from table.
7345 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7347 * @brief Set the packing location of an existing child of the table
7349 * @param subobj The subobject to be modified in the table
7350 * @param x Row number
7351 * @param y Column number
7355 * Modifies the position of an object already in the table.
7357 * @note All positioning inside the table is relative to rows and columns, so
7358 * a value of 0 for x and y, means the top left cell of the table, and a
7359 * value of 1 for w and h means @p subobj only takes that 1 cell.
7361 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7363 * @brief Get the packing location of an existing child of the table
7365 * @param subobj The subobject to be modified in the table
7366 * @param x Row number
7367 * @param y Column number
7371 * @see elm_table_pack_set()
7373 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7379 * @defgroup Gengrid Gengrid (Generic grid)
7381 * This widget aims to position objects in a grid layout while
7382 * actually creating and rendering only the visible ones, using the
7383 * same idea as the @ref Genlist "genlist": the user defines a @b
7384 * class for each item, specifying functions that will be called at
7385 * object creation, deletion, etc. When those items are selected by
7386 * the user, a callback function is issued. Users may interact with
7387 * a gengrid via the mouse (by clicking on items to select them and
7388 * clicking on the grid's viewport and swiping to pan the whole
7389 * view) or via the keyboard, navigating through item with the
7392 * @section Gengrid_Layouts Gengrid layouts
7394 * Gengrids may layout its items in one of two possible layouts:
7398 * When in "horizontal mode", items will be placed in @b columns,
7399 * from top to bottom and, when the space for a column is filled,
7400 * another one is started on the right, thus expanding the grid
7401 * horizontally, making for horizontal scrolling. When in "vertical
7402 * mode" , though, items will be placed in @b rows, from left to
7403 * right and, when the space for a row is filled, another one is
7404 * started below, thus expanding the grid vertically (and making
7405 * for vertical scrolling).
7407 * @section Gengrid_Items Gengrid items
7409 * An item in a gengrid can have 0 or more text labels (they can be
7410 * regular text or textblock Evas objects - that's up to the style
7411 * to determine), 0 or more icons (which are simply objects
7412 * swallowed into the gengrid item's theming Edje object) and 0 or
7413 * more <b>boolean states</b>, which have the behavior left to the
7414 * user to define. The Edje part names for each of these properties
7415 * will be looked up, in the theme file for the gengrid, under the
7416 * Edje (string) data items named @c "labels", @c "icons" and @c
7417 * "states", respectively. For each of those properties, if more
7418 * than one part is provided, they must have names listed separated
7419 * by spaces in the data fields. For the default gengrid item
7420 * theme, we have @b one label part (@c "elm.text"), @b two icon
7421 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7424 * A gengrid item may be at one of several styles. Elementary
7425 * provides one by default - "default", but this can be extended by
7426 * system or application custom themes/overlays/extensions (see
7427 * @ref Theme "themes" for more details).
7429 * @section Gengrid_Item_Class Gengrid item classes
7431 * In order to have the ability to add and delete items on the fly,
7432 * gengrid implements a class (callback) system where the
7433 * application provides a structure with information about that
7434 * type of item (gengrid may contain multiple different items with
7435 * different classes, states and styles). Gengrid will call the
7436 * functions in this struct (methods) when an item is "realized"
7437 * (i.e., created dynamically, while the user is scrolling the
7438 * grid). All objects will simply be deleted when no longer needed
7439 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7440 * contains the following members:
7441 * - @c item_style - This is a constant string and simply defines
7442 * the name of the item style. It @b must be specified and the
7443 * default should be @c "default".
7444 * - @c func.label_get - This function is called when an item
7445 * object is actually created. The @c data parameter will point to
7446 * the same data passed to elm_gengrid_item_append() and related
7447 * item creation functions. The @c obj parameter is the gengrid
7448 * object itself, while the @c part one is the name string of one
7449 * of the existing text parts in the Edje group implementing the
7450 * item's theme. This function @b must return a strdup'()ed string,
7451 * as the caller will free() it when done. See
7452 * #Elm_Gengrid_Item_Label_Get_Cb.
7453 * - @c func.icon_get - This function is called when an item object
7454 * is actually created. The @c data parameter will point to the
7455 * same data passed to elm_gengrid_item_append() and related item
7456 * creation functions. The @c obj parameter is the gengrid object
7457 * itself, while the @c part one is the name string of one of the
7458 * existing (icon) swallow parts in the Edje group implementing the
7459 * item's theme. It must return @c NULL, when no icon is desired,
7460 * or a valid object handle, otherwise. The object will be deleted
7461 * by the gengrid on its deletion or when the item is "unrealized".
7462 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7463 * - @c func.state_get - This function is called when an item
7464 * object is actually created. The @c data parameter will point to
7465 * the same data passed to elm_gengrid_item_append() and related
7466 * item creation functions. The @c obj parameter is the gengrid
7467 * object itself, while the @c part one is the name string of one
7468 * of the state parts in the Edje group implementing the item's
7469 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7470 * true/on. Gengrids will emit a signal to its theming Edje object
7471 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7472 * "source" arguments, respectively, when the state is true (the
7473 * default is false), where @c XXX is the name of the (state) part.
7474 * See #Elm_Gengrid_Item_State_Get_Cb.
7475 * - @c func.del - This is called when elm_gengrid_item_del() is
7476 * called on an item or elm_gengrid_clear() is called on the
7477 * gengrid. This is intended for use when gengrid items are
7478 * deleted, so any data attached to the item (e.g. its data
7479 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7481 * @section Gengrid_Usage_Hints Usage hints
7483 * If the user wants to have multiple items selected at the same
7484 * time, elm_gengrid_multi_select_set() will permit it. If the
7485 * gengrid is single-selection only (the default), then
7486 * elm_gengrid_select_item_get() will return the selected item or
7487 * @c NULL, if none is selected. If the gengrid is under
7488 * multi-selection, then elm_gengrid_selected_items_get() will
7489 * return a list (that is only valid as long as no items are
7490 * modified (added, deleted, selected or unselected) of child items
7493 * If an item changes (internal (boolean) state, label or icon
7494 * changes), then use elm_gengrid_item_update() to have gengrid
7495 * update the item with the new state. A gengrid will re-"realize"
7496 * the item, thus calling the functions in the
7497 * #Elm_Gengrid_Item_Class set for that item.
7499 * To programmatically (un)select an item, use
7500 * elm_gengrid_item_selected_set(). To get its selected state use
7501 * elm_gengrid_item_selected_get(). To make an item disabled
7502 * (unable to be selected and appear differently) use
7503 * elm_gengrid_item_disabled_set() to set this and
7504 * elm_gengrid_item_disabled_get() to get the disabled state.
7506 * Grid cells will only have their selection smart callbacks called
7507 * when firstly getting selected. Any further clicks will do
7508 * nothing, unless you enable the "always select mode", with
7509 * elm_gengrid_always_select_mode_set(), thus making every click to
7510 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7511 * turn off the ability to select items entirely in the widget and
7512 * they will neither appear selected nor call the selection smart
7515 * Remember that you can create new styles and add your own theme
7516 * augmentation per application with elm_theme_extension_add(). If
7517 * you absolutely must have a specific style that overrides any
7518 * theme the user or system sets up you can use
7519 * elm_theme_overlay_add() to add such a file.
7521 * @section Gengrid_Smart_Events Gengrid smart events
7523 * Smart events that you can add callbacks for are:
7524 * - @c "activated" - The user has double-clicked or pressed
7525 * (enter|return|spacebar) on an item. The @c event_info parameter
7526 * is the gengrid item that was activated.
7527 * - @c "clicked,double" - The user has double-clicked an item.
7528 * The @c event_info parameter is the gengrid item that was double-clicked.
7529 * - @c "selected" - The user has made an item selected. The
7530 * @c event_info parameter is the gengrid item that was selected.
7531 * - @c "unselected" - The user has made an item unselected. The
7532 * @c event_info parameter is the gengrid item that was unselected.
7533 * - @c "realized" - This is called when the item in the gengrid
7534 * has its implementing Evas object instantiated, de facto. @c
7535 * event_info is the gengrid item that was created. The object
7536 * may be deleted at any time, so it is highly advised to the
7537 * caller @b not to use the object pointer returned from
7538 * elm_gengrid_item_object_get(), because it may point to freed
7540 * - @c "unrealized" - This is called when the implementing Evas
7541 * object for this item is deleted. @c event_info is the gengrid
7542 * item that was deleted.
7543 * - @c "changed" - Called when an item is added, removed, resized
7544 * or moved and when the gengrid is resized or gets "horizontal"
7546 * - @c "drag,start,up" - Called when the item in the gengrid has
7547 * been dragged (not scrolled) up.
7548 * - @c "drag,start,down" - Called when the item in the gengrid has
7549 * been dragged (not scrolled) down.
7550 * - @c "drag,start,left" - Called when the item in the gengrid has
7551 * been dragged (not scrolled) left.
7552 * - @c "drag,start,right" - Called when the item in the gengrid has
7553 * been dragged (not scrolled) right.
7554 * - @c "drag,stop" - Called when the item in the gengrid has
7555 * stopped being dragged.
7556 * - @c "drag" - Called when the item in the gengrid is being
7558 * - @c "scroll" - called when the content has been scrolled
7560 * - @c "scroll,drag,start" - called when dragging the content has
7562 * - @c "scroll,drag,stop" - called when dragging the content has
7565 * List of gendrid examples:
7566 * @li @ref gengrid_example
7570 * @addtogroup Gengrid
7574 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7575 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7576 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7577 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7578 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. */
7579 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. */
7580 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7582 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7583 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7584 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7585 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7588 * @struct _Elm_Gengrid_Item_Class
7590 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7593 struct _Elm_Gengrid_Item_Class
7595 const char *item_style;
7596 struct _Elm_Gengrid_Item_Class_Func
7598 Elm_Gengrid_Item_Label_Get_Cb label_get;
7599 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7600 Elm_Gengrid_Item_State_Get_Cb state_get;
7601 Elm_Gengrid_Item_Del_Cb del;
7603 }; /**< #Elm_Gengrid_Item_Class member definitions */
7606 * Add a new gengrid widget to the given parent Elementary
7607 * (container) object
7609 * @param parent The parent object
7610 * @return a new gengrid widget handle or @c NULL, on errors
7612 * This function inserts a new gengrid widget on the canvas.
7614 * @see elm_gengrid_item_size_set()
7615 * @see elm_gengrid_horizontal_set()
7616 * @see elm_gengrid_item_append()
7617 * @see elm_gengrid_item_del()
7618 * @see elm_gengrid_clear()
7622 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7625 * Set the size for the items of a given gengrid widget
7627 * @param obj The gengrid object.
7628 * @param w The items' width.
7629 * @param h The items' height;
7631 * A gengrid, after creation, has still no information on the size
7632 * to give to each of its cells. So, you most probably will end up
7633 * with squares one @ref Fingers "finger" wide, the default
7634 * size. Use this function to force a custom size for you items,
7635 * making them as big as you wish.
7637 * @see elm_gengrid_item_size_get()
7641 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7644 * Get the size set for the items of a given gengrid widget
7646 * @param obj The gengrid object.
7647 * @param w Pointer to a variable where to store the items' width.
7648 * @param h Pointer to a variable where to store the items' height.
7650 * @note Use @c NULL pointers on the size values you're not
7651 * interested in: they'll be ignored by the function.
7653 * @see elm_gengrid_item_size_get() for more details
7657 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7660 * Set the items grid's alignment within a given gengrid widget
7662 * @param obj The gengrid object.
7663 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7664 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7666 * This sets the alignment of the whole grid of items of a gengrid
7667 * within its given viewport. By default, those values are both
7668 * 0.5, meaning that the gengrid will have its items grid placed
7669 * exactly in the middle of its viewport.
7671 * @note If given alignment values are out of the cited ranges,
7672 * they'll be changed to the nearest boundary values on the valid
7675 * @see elm_gengrid_align_get()
7679 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7682 * Get the items grid's alignment values within a given gengrid
7685 * @param obj The gengrid object.
7686 * @param align_x Pointer to a variable where to store the
7687 * horizontal alignment.
7688 * @param align_y Pointer to a variable where to store the vertical
7691 * @note Use @c NULL pointers on the alignment values you're not
7692 * interested in: they'll be ignored by the function.
7694 * @see elm_gengrid_align_set() for more details
7698 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7701 * Set whether a given gengrid widget is or not able have items
7704 * @param obj The gengrid object
7705 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7706 * @c EINA_FALSE to turn it off
7708 * If a gengrid is set to allow reordering, a click held for more
7709 * than 0.5 over a given item will highlight it specially,
7710 * signalling the gengrid has entered the reordering state. From
7711 * that time on, the user will be able to, while still holding the
7712 * mouse button down, move the item freely in the gengrid's
7713 * viewport, replacing to said item to the locations it goes to.
7714 * The replacements will be animated and, whenever the user
7715 * releases the mouse button, the item being replaced gets a new
7716 * definitive place in the grid.
7718 * @see elm_gengrid_reorder_mode_get()
7722 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7725 * Get whether a given gengrid widget is or not able have items
7728 * @param obj The gengrid object
7729 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7732 * @see elm_gengrid_reorder_mode_set() for more details
7736 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7739 * Append a new item in a given gengrid widget.
7741 * @param obj The gengrid object.
7742 * @param gic The item class for the item.
7743 * @param data The item data.
7744 * @param func Convenience function called when the item is
7746 * @param func_data Data to be passed to @p func.
7747 * @return A handle to the item added or @c NULL, on errors.
7749 * This adds an item to the beginning of the gengrid.
7751 * @see elm_gengrid_item_prepend()
7752 * @see elm_gengrid_item_insert_before()
7753 * @see elm_gengrid_item_insert_after()
7754 * @see elm_gengrid_item_del()
7758 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);
7761 * Prepend a new item in a given gengrid widget.
7763 * @param obj The gengrid object.
7764 * @param gic The item class for the item.
7765 * @param data The item data.
7766 * @param func Convenience function called when the item is
7768 * @param func_data Data to be passed to @p func.
7769 * @return A handle to the item added or @c NULL, on errors.
7771 * This adds an item to the end of the gengrid.
7773 * @see elm_gengrid_item_append()
7774 * @see elm_gengrid_item_insert_before()
7775 * @see elm_gengrid_item_insert_after()
7776 * @see elm_gengrid_item_del()
7780 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);
7783 * Insert an item before another in a gengrid widget
7785 * @param obj The gengrid object.
7786 * @param gic The item class for the item.
7787 * @param data The item data.
7788 * @param relative The item to place this new one before.
7789 * @param func Convenience function called when the item is
7791 * @param func_data Data to be passed to @p func.
7792 * @return A handle to the item added or @c NULL, on errors.
7794 * This inserts an item before another in the gengrid.
7796 * @see elm_gengrid_item_append()
7797 * @see elm_gengrid_item_prepend()
7798 * @see elm_gengrid_item_insert_after()
7799 * @see elm_gengrid_item_del()
7803 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);
7806 * Insert an item after another in a gengrid widget
7808 * @param obj The gengrid object.
7809 * @param gic The item class for the item.
7810 * @param data The item data.
7811 * @param relative The item to place this new one after.
7812 * @param func Convenience function called when the item is
7814 * @param func_data Data to be passed to @p func.
7815 * @return A handle to the item added or @c NULL, on errors.
7817 * This inserts an item after another in the gengrid.
7819 * @see elm_gengrid_item_append()
7820 * @see elm_gengrid_item_prepend()
7821 * @see elm_gengrid_item_insert_after()
7822 * @see elm_gengrid_item_del()
7826 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);
7828 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);
7830 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);
7833 * Set whether items on a given gengrid widget are to get their
7834 * selection callbacks issued for @b every subsequent selection
7835 * click on them or just for the first click.
7837 * @param obj The gengrid object
7838 * @param always_select @c EINA_TRUE to make items "always
7839 * selected", @c EINA_FALSE, otherwise
7841 * By default, grid items will only call their selection callback
7842 * function when firstly getting selected, any subsequent further
7843 * clicks will do nothing. With this call, you make those
7844 * subsequent clicks also to issue the selection callbacks.
7846 * @note <b>Double clicks</b> will @b always be reported on items.
7848 * @see elm_gengrid_always_select_mode_get()
7852 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7855 * Get whether items on a given gengrid widget have their selection
7856 * callbacks issued for @b every subsequent selection click on them
7857 * or just for the first click.
7859 * @param obj The gengrid object.
7860 * @return @c EINA_TRUE if the gengrid items are "always selected",
7861 * @c EINA_FALSE, otherwise
7863 * @see elm_gengrid_always_select_mode_set() for more details
7867 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7870 * Set whether items on a given gengrid widget can be selected or not.
7872 * @param obj The gengrid object
7873 * @param no_select @c EINA_TRUE to make items selectable,
7874 * @c EINA_FALSE otherwise
7876 * This will make items in @p obj selectable or not. In the latter
7877 * case, any user interacion on the gendrid items will neither make
7878 * them appear selected nor them call their selection callback
7881 * @see elm_gengrid_no_select_mode_get()
7885 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
7888 * Get whether items on a given gengrid widget can be selected or
7891 * @param obj The gengrid object
7892 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
7895 * @see elm_gengrid_no_select_mode_set() for more details
7899 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7902 * Enable or disable multi-selection in a given gengrid widget
7904 * @param obj The gengrid object.
7905 * @param multi @c EINA_TRUE, to enable multi-selection,
7906 * @c EINA_FALSE to disable it.
7908 * Multi-selection is the ability for one to have @b more than one
7909 * item selected, on a given gengrid, simultaneously. When it is
7910 * enabled, a sequence of clicks on different items will make them
7911 * all selected, progressively. A click on an already selected item
7912 * will unselect it. If interecting via the keyboard,
7913 * multi-selection is enabled while holding the "Shift" key.
7915 * @note By default, multi-selection is @b disabled on gengrids
7917 * @see elm_gengrid_multi_select_get()
7921 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
7924 * Get whether multi-selection is enabled or disabled for a given
7927 * @param obj The gengrid object.
7928 * @return @c EINA_TRUE, if multi-selection is enabled, @c
7929 * EINA_FALSE otherwise
7931 * @see elm_gengrid_multi_select_set() for more details
7935 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7938 * Enable or disable bouncing effect for a given gengrid widget
7940 * @param obj The gengrid object
7941 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
7942 * @c EINA_FALSE to disable it
7943 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
7944 * @c EINA_FALSE to disable it
7946 * The bouncing effect occurs whenever one reaches the gengrid's
7947 * edge's while panning it -- it will scroll past its limits a
7948 * little bit and return to the edge again, in a animated for,
7951 * @note By default, gengrids have bouncing enabled on both axis
7953 * @see elm_gengrid_bounce_get()
7957 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7960 * Get whether bouncing effects are enabled or disabled, for a
7961 * given gengrid widget, on each axis
7963 * @param obj The gengrid object
7964 * @param h_bounce Pointer to a variable where to store the
7965 * horizontal bouncing flag.
7966 * @param v_bounce Pointer to a variable where to store the
7967 * vertical bouncing flag.
7969 * @see elm_gengrid_bounce_set() for more details
7973 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7976 * Set a given gengrid widget's scrolling page size, relative to
7977 * its viewport size.
7979 * @param obj The gengrid object
7980 * @param h_pagerel The horizontal page (relative) size
7981 * @param v_pagerel The vertical page (relative) size
7983 * The gengrid's scroller is capable of binding scrolling by the
7984 * user to "pages". It means that, while scrolling and, specially
7985 * after releasing the mouse button, the grid will @b snap to the
7986 * nearest displaying page's area. When page sizes are set, the
7987 * grid's continuous content area is split into (equal) page sized
7990 * This function sets the size of a page <b>relatively to the
7991 * viewport dimensions</b> of the gengrid, for each axis. A value
7992 * @c 1.0 means "the exact viewport's size", in that axis, while @c
7993 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
7994 * a viewport". Sane usable values are, than, between @c 0.0 and @c
7995 * 1.0. Values beyond those will make it behave behave
7996 * inconsistently. If you only want one axis to snap to pages, use
7997 * the value @c 0.0 for the other one.
7999 * There is a function setting page size values in @b absolute
8000 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8001 * is mutually exclusive to this one.
8003 * @see elm_gengrid_page_relative_get()
8007 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8010 * Get a given gengrid widget's scrolling page size, relative to
8011 * its viewport size.
8013 * @param obj The gengrid object
8014 * @param h_pagerel Pointer to a variable where to store the
8015 * horizontal page (relative) size
8016 * @param v_pagerel Pointer to a variable where to store the
8017 * vertical page (relative) size
8019 * @see elm_gengrid_page_relative_set() for more details
8023 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8026 * Set a given gengrid widget's scrolling page size
8028 * @param obj The gengrid object
8029 * @param h_pagerel The horizontal page size, in pixels
8030 * @param v_pagerel The vertical page size, in pixels
8032 * The gengrid's scroller is capable of binding scrolling by the
8033 * user to "pages". It means that, while scrolling and, specially
8034 * after releasing the mouse button, the grid will @b snap to the
8035 * nearest displaying page's area. When page sizes are set, the
8036 * grid's continuous content area is split into (equal) page sized
8039 * This function sets the size of a page of the gengrid, in pixels,
8040 * for each axis. Sane usable values are, between @c 0 and the
8041 * dimensions of @p obj, for each axis. Values beyond those will
8042 * make it behave behave inconsistently. If you only want one axis
8043 * to snap to pages, use the value @c 0 for the other one.
8045 * There is a function setting page size values in @b relative
8046 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8047 * use is mutually exclusive to this one.
8051 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8054 * Set for what direction a given gengrid widget will expand while
8055 * placing its items.
8057 * @param obj The gengrid object.
8058 * @param setting @c EINA_TRUE to make the gengrid expand
8059 * horizontally, @c EINA_FALSE to expand vertically.
8061 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8062 * in @b columns, from top to bottom and, when the space for a
8063 * column is filled, another one is started on the right, thus
8064 * expanding the grid horizontally. When in "vertical mode"
8065 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8066 * to right and, when the space for a row is filled, another one is
8067 * started below, thus expanding the grid vertically.
8069 * @see elm_gengrid_horizontal_get()
8073 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8076 * Get for what direction a given gengrid widget will expand while
8077 * placing its items.
8079 * @param obj The gengrid object.
8080 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8081 * @c EINA_FALSE if it's set to expand vertically.
8083 * @see elm_gengrid_horizontal_set() for more detais
8087 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8090 * Get the first item in a given gengrid widget
8092 * @param obj The gengrid object
8093 * @return The first item's handle or @c NULL, if there are no
8094 * items in @p obj (and on errors)
8096 * This returns the first item in the @p obj's internal list of
8099 * @see elm_gengrid_last_item_get()
8103 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8106 * Get the last item in a given gengrid widget
8108 * @param obj The gengrid object
8109 * @return The last item's handle or @c NULL, if there are no
8110 * items in @p obj (and on errors)
8112 * This returns the last item in the @p obj's internal list of
8115 * @see elm_gengrid_first_item_get()
8119 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8122 * Get the @b next item in a gengrid widget's internal list of items,
8123 * given a handle to one of those items.
8125 * @param item The gengrid item to fetch next from
8126 * @return The item after @p item, or @c NULL if there's none (and
8129 * This returns the item placed after the @p item, on the container
8132 * @see elm_gengrid_item_prev_get()
8136 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8139 * Get the @b previous item in a gengrid widget's internal list of items,
8140 * given a handle to one of those items.
8142 * @param item The gengrid item to fetch previous from
8143 * @return The item before @p item, or @c NULL if there's none (and
8146 * This returns the item placed before the @p item, on the container
8149 * @see elm_gengrid_item_next_get()
8153 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8156 * Get the gengrid object's handle which contains a given gengrid
8159 * @param item The item to fetch the container from
8160 * @return The gengrid (parent) object
8162 * This returns the gengrid object itself that an item belongs to.
8166 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8169 * Remove a gengrid item from the its parent, deleting it.
8171 * @param item The item to be removed.
8172 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8174 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8179 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8182 * Update the contents of a given gengrid item
8184 * @param item The gengrid item
8186 * This updates an item by calling all the item class functions
8187 * again to get the icons, labels and states. Use this when the
8188 * original item data has changed and you want thta changes to be
8193 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8194 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8195 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8198 * Return the data associated to a given gengrid item
8200 * @param item The gengrid item.
8201 * @return the data associated to this item.
8203 * This returns the @c data value passed on the
8204 * elm_gengrid_item_append() and related item addition calls.
8206 * @see elm_gengrid_item_append()
8207 * @see elm_gengrid_item_data_set()
8211 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8214 * Set the data associated to a given gengrid item
8216 * @param item The gengrid item
8217 * @param data The new data pointer to set on it
8219 * This @b overrides the @c data value passed on the
8220 * elm_gengrid_item_append() and related item addition calls. This
8221 * function @b won't call elm_gengrid_item_update() automatically,
8222 * so you'd issue it afterwards if you want to hove the item
8223 * updated to reflect the that new data.
8225 * @see elm_gengrid_item_data_get()
8229 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8232 * Get a given gengrid item's position, relative to the whole
8233 * gengrid's grid area.
8235 * @param item The Gengrid item.
8236 * @param x Pointer to variable where to store the item's <b>row
8238 * @param y Pointer to variable where to store the item's <b>column
8241 * This returns the "logical" position of the item whithin the
8242 * gengrid. For example, @c (0, 1) would stand for first row,
8247 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8250 * Set whether a given gengrid item is selected or not
8252 * @param item The gengrid item
8253 * @param selected Use @c EINA_TRUE, to make it selected, @c
8254 * EINA_FALSE to make it unselected
8256 * This sets the selected state of an item. If multi selection is
8257 * not enabled on the containing gengrid and @p selected is @c
8258 * EINA_TRUE, any other previously selected items will get
8259 * unselected in favor of this new one.
8261 * @see elm_gengrid_item_selected_get()
8265 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8268 * Get whether a given gengrid item is selected or not
8270 * @param item The gengrid item
8271 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8273 * @see elm_gengrid_item_selected_set() for more details
8277 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8280 * Get the real Evas object created to implement the view of a
8281 * given gengrid item
8283 * @param item The gengrid item.
8284 * @return the Evas object implementing this item's view.
8286 * This returns the actual Evas object used to implement the
8287 * specified gengrid item's view. This may be @c NULL, as it may
8288 * not have been created or may have been deleted, at any time, by
8289 * the gengrid. <b>Do not modify this object</b> (move, resize,
8290 * show, hide, etc.), as the gengrid is controlling it. This
8291 * function is for querying, emitting custom signals or hooking
8292 * lower level callbacks for events on that object. Do not delete
8293 * this object under any circumstances.
8295 * @see elm_gengrid_item_data_get()
8299 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8302 * Show the portion of a gengrid's internal grid containing a given
8303 * item, @b immediately.
8305 * @param item The item to display
8307 * This causes gengrid to @b redraw its viewport's contents to the
8308 * region contining the given @p item item, if it is not fully
8311 * @see elm_gengrid_item_bring_in()
8315 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8318 * Animatedly bring in, to the visible are of a gengrid, a given
8321 * @param item The gengrid item to display
8323 * This causes gengrig to jump to the given @p item item and show
8324 * it (by scrolling), if it is not fully visible. This will use
8325 * animation to do so and take a period of time to complete.
8327 * @see elm_gengrid_item_show()
8331 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8334 * Set whether a given gengrid item is disabled or not.
8336 * @param item The gengrid item
8337 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8338 * to enable it back.
8340 * A disabled item cannot be selected or unselected. It will also
8341 * change its appearance, to signal the user it's disabled.
8343 * @see elm_gengrid_item_disabled_get()
8347 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8350 * Get whether a given gengrid item is disabled or not.
8352 * @param item The gengrid item
8353 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8356 * @see elm_gengrid_item_disabled_set() for more details
8360 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8363 * Set the text to be shown in a given gengrid item's tooltips.
8365 * @param item The gengrid item
8366 * @param text The text to set in the content
8368 * This call will setup the text to be used as tooltip to that item
8369 * (analogous to elm_object_tooltip_text_set(), but being item
8370 * tooltips with higher precedence than object tooltips). It can
8371 * have only one tooltip at a time, so any previous tooltip data
8376 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8379 * Set the content to be shown in a given gengrid item's tooltips
8381 * @param item The gengrid item.
8382 * @param func The function returning the tooltip contents.
8383 * @param data What to provide to @a func as callback data/context.
8384 * @param del_cb Called when data is not needed anymore, either when
8385 * another callback replaces @p func, the tooltip is unset with
8386 * elm_gengrid_item_tooltip_unset() or the owner @p item
8387 * dies. This callback receives as its first parameter the
8388 * given @p data, being @c event_info the item handle.
8390 * This call will setup the tooltip's contents to @p item
8391 * (analogous to elm_object_tooltip_content_cb_set(), but being
8392 * item tooltips with higher precedence than object tooltips). It
8393 * can have only one tooltip at a time, so any previous tooltip
8394 * content will get removed. @p func (with @p data) will be called
8395 * every time Elementary needs to show the tooltip and it should
8396 * return a valid Evas object, which will be fully managed by the
8397 * tooltip system, getting deleted when the tooltip is gone.
8401 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);
8404 * Unset a tooltip from a given gengrid item
8406 * @param item gengrid item to remove a previously set tooltip from.
8408 * This call removes any tooltip set on @p item. The callback
8409 * provided as @c del_cb to
8410 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8411 * notify it is not used anymore (and have resources cleaned, if
8414 * @see elm_gengrid_item_tooltip_content_cb_set()
8418 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8421 * Set a different @b style for a given gengrid item's tooltip.
8423 * @param item gengrid item with tooltip set
8424 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8425 * "default", @c "transparent", etc)
8427 * Tooltips can have <b>alternate styles</b> to be displayed on,
8428 * which are defined by the theme set on Elementary. This function
8429 * works analogously as elm_object_tooltip_style_set(), but here
8430 * applied only to gengrid item objects. The default style for
8431 * tooltips is @c "default".
8433 * @note before you set a style you should define a tooltip with
8434 * elm_gengrid_item_tooltip_content_cb_set() or
8435 * elm_gengrid_item_tooltip_text_set()
8437 * @see elm_gengrid_item_tooltip_style_get()
8441 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8444 * Get the style set a given gengrid item's tooltip.
8446 * @param item gengrid item with tooltip already set on.
8447 * @return style the theme style in use, which defaults to
8448 * "default". If the object does not have a tooltip set,
8449 * then @c NULL is returned.
8451 * @see elm_gengrid_item_tooltip_style_set() for more details
8455 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8457 * @brief Disable size restrictions on an object's tooltip
8458 * @param item The tooltip's anchor object
8459 * @param disable If EINA_TRUE, size restrictions are disabled
8460 * @return EINA_FALSE on failure, EINA_TRUE on success
8462 * This function allows a tooltip to expand beyond its parant window's canvas.
8463 * It will instead be limited only by the size of the display.
8465 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8467 * @brief Retrieve size restriction state of an object's tooltip
8468 * @param item The tooltip's anchor object
8469 * @return If EINA_TRUE, size restrictions are disabled
8471 * This function returns whether a tooltip is allowed to expand beyond
8472 * its parant window's canvas.
8473 * It will instead be limited only by the size of the display.
8475 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8477 * Set the type of mouse pointer/cursor decoration to be shown,
8478 * when the mouse pointer is over the given gengrid widget item
8480 * @param item gengrid item to customize cursor on
8481 * @param cursor the cursor type's name
8483 * This function works analogously as elm_object_cursor_set(), but
8484 * here the cursor's changing area is restricted to the item's
8485 * area, and not the whole widget's. Note that that item cursors
8486 * have precedence over widget cursors, so that a mouse over @p
8487 * item will always show cursor @p type.
8489 * If this function is called twice for an object, a previously set
8490 * cursor will be unset on the second call.
8492 * @see elm_object_cursor_set()
8493 * @see elm_gengrid_item_cursor_get()
8494 * @see elm_gengrid_item_cursor_unset()
8498 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8501 * Get the type of mouse pointer/cursor decoration set to be shown,
8502 * when the mouse pointer is over the given gengrid widget item
8504 * @param item gengrid item with custom cursor set
8505 * @return the cursor type's name or @c NULL, if no custom cursors
8506 * were set to @p item (and on errors)
8508 * @see elm_object_cursor_get()
8509 * @see elm_gengrid_item_cursor_set() for more details
8510 * @see elm_gengrid_item_cursor_unset()
8514 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8517 * Unset any custom mouse pointer/cursor decoration set to be
8518 * shown, when the mouse pointer is over the given gengrid widget
8519 * item, thus making it show the @b default cursor again.
8521 * @param item a gengrid item
8523 * Use this call to undo any custom settings on this item's cursor
8524 * decoration, bringing it back to defaults (no custom style set).
8526 * @see elm_object_cursor_unset()
8527 * @see elm_gengrid_item_cursor_set() for more details
8531 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8534 * Set a different @b style for a given custom cursor set for a
8537 * @param item gengrid item with custom cursor set
8538 * @param style the <b>theme style</b> to use (e.g. @c "default",
8539 * @c "transparent", etc)
8541 * This function only makes sense when one is using custom mouse
8542 * cursor decorations <b>defined in a theme file</b> , which can
8543 * have, given a cursor name/type, <b>alternate styles</b> on
8544 * it. It works analogously as elm_object_cursor_style_set(), but
8545 * here applied only to gengrid item objects.
8547 * @warning Before you set a cursor style you should have defined a
8548 * custom cursor previously on the item, with
8549 * elm_gengrid_item_cursor_set()
8551 * @see elm_gengrid_item_cursor_engine_only_set()
8552 * @see elm_gengrid_item_cursor_style_get()
8556 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8559 * Get the current @b style set for a given gengrid item's custom
8562 * @param item gengrid item with custom cursor set.
8563 * @return style the cursor style in use. If the object does not
8564 * have a cursor set, then @c NULL is returned.
8566 * @see elm_gengrid_item_cursor_style_set() for more details
8570 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8573 * Set if the (custom) cursor for a given gengrid item should be
8574 * searched in its theme, also, or should only rely on the
8577 * @param item item with custom (custom) cursor already set on
8578 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8579 * only on those provided by the rendering engine, @c EINA_FALSE to
8580 * have them searched on the widget's theme, as well.
8582 * @note This call is of use only if you've set a custom cursor
8583 * for gengrid items, with elm_gengrid_item_cursor_set().
8585 * @note By default, cursors will only be looked for between those
8586 * provided by the rendering engine.
8590 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8593 * Get if the (custom) cursor for a given gengrid item is being
8594 * searched in its theme, also, or is only relying on the rendering
8597 * @param item a gengrid item
8598 * @return @c EINA_TRUE, if cursors are being looked for only on
8599 * those provided by the rendering engine, @c EINA_FALSE if they
8600 * are being searched on the widget's theme, as well.
8602 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8606 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8609 * Remove all items from a given gengrid widget
8611 * @param obj The gengrid object.
8613 * This removes (and deletes) all items in @p obj, leaving it
8616 * @see elm_gengrid_item_del(), to remove just one item.
8620 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8623 * Get the selected item in a given gengrid widget
8625 * @param obj The gengrid object.
8626 * @return The selected item's handleor @c NULL, if none is
8627 * selected at the moment (and on errors)
8629 * This returns the selected item in @p obj. If multi selection is
8630 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8631 * the first item in the list is selected, which might not be very
8632 * useful. For that case, see elm_gengrid_selected_items_get().
8636 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8639 * Get <b>a list</b> of selected items in a given gengrid
8641 * @param obj The gengrid object.
8642 * @return The list of selected items or @c NULL, if none is
8643 * selected at the moment (and on errors)
8645 * This returns a list of the selected items, in the order that
8646 * they appear in the grid. This list is only valid as long as no
8647 * more items are selected or unselected (or unselected implictly
8648 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8651 * @see elm_gengrid_selected_item_get()
8655 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8662 * @defgroup Clock Clock
8664 * @image html img/widget/clock/preview-00.png
8665 * @image latex img/widget/clock/preview-00.eps
8667 * This is a @b digital clock widget. In its default theme, it has a
8668 * vintage "flipping numbers clock" appearance, which will animate
8669 * sheets of individual algarisms individually as time goes by.
8671 * A newly created clock will fetch system's time (already
8672 * considering local time adjustments) to start with, and will tick
8673 * accondingly. It may or may not show seconds.
8675 * Clocks have an @b edition mode. When in it, the sheets will
8676 * display extra arrow indications on the top and bottom and the
8677 * user may click on them to raise or lower the time values. After
8678 * it's told to exit edition mode, it will keep ticking with that
8679 * new time set (it keeps the difference from local time).
8681 * Also, when under edition mode, user clicks on the cited arrows
8682 * which are @b held for some time will make the clock to flip the
8683 * sheet, thus editing the time, continuosly and automatically for
8684 * the user. The interval between sheet flips will keep growing in
8685 * time, so that it helps the user to reach a time which is distant
8688 * The time display is, by default, in military mode (24h), but an
8689 * am/pm indicator may be optionally shown, too, when it will
8692 * Smart callbacks one can register to:
8693 * - "changed" - the clock's user changed the time
8695 * Here is an example on its usage:
8696 * @li @ref clock_example
8705 * Identifiers for which clock digits should be editable, when a
8706 * clock widget is in edition mode. Values may be ORed together to
8707 * make a mask, naturally.
8709 * @see elm_clock_edit_set()
8710 * @see elm_clock_digit_edit_set()
8712 typedef enum _Elm_Clock_Digedit
8714 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8715 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8716 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
8717 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8718 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
8719 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8720 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
8721 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
8722 } Elm_Clock_Digedit;
8725 * Add a new clock widget to the given parent Elementary
8726 * (container) object
8728 * @param parent The parent object
8729 * @return a new clock widget handle or @c NULL, on errors
8731 * This function inserts a new clock widget on the canvas.
8735 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8738 * Set a clock widget's time, programmatically
8740 * @param obj The clock widget object
8741 * @param hrs The hours to set
8742 * @param min The minutes to set
8743 * @param sec The secondes to set
8745 * This function updates the time that is showed by the clock
8748 * Values @b must be set within the following ranges:
8749 * - 0 - 23, for hours
8750 * - 0 - 59, for minutes
8751 * - 0 - 59, for seconds,
8753 * even if the clock is not in "military" mode.
8755 * @warning The behavior for values set out of those ranges is @b
8760 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8763 * Get a clock widget's time values
8765 * @param obj The clock object
8766 * @param[out] hrs Pointer to the variable to get the hours value
8767 * @param[out] min Pointer to the variable to get the minutes value
8768 * @param[out] sec Pointer to the variable to get the seconds value
8770 * This function gets the time set for @p obj, returning
8771 * it on the variables passed as the arguments to function
8773 * @note Use @c NULL pointers on the time values you're not
8774 * interested in: they'll be ignored by the function.
8778 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8781 * Set whether a given clock widget is under <b>edition mode</b> or
8782 * under (default) displaying-only mode.
8784 * @param obj The clock object
8785 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8786 * put it back to "displaying only" mode
8788 * This function makes a clock's time to be editable or not <b>by
8789 * user interaction</b>. When in edition mode, clocks @b stop
8790 * ticking, until one brings them back to canonical mode. The
8791 * elm_clock_digit_edit_set() function will influence which digits
8792 * of the clock will be editable. By default, all of them will be
8793 * (#ELM_CLOCK_NONE).
8795 * @note am/pm sheets, if being shown, will @b always be editable
8796 * under edition mode.
8798 * @see elm_clock_edit_get()
8802 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8805 * Retrieve whether a given clock widget is under <b>edition
8806 * mode</b> or under (default) displaying-only mode.
8808 * @param obj The clock object
8809 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
8812 * This function retrieves whether the clock's time can be edited
8813 * or not by user interaction.
8815 * @see elm_clock_edit_set() for more details
8819 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8822 * Set what digits of the given clock widget should be editable
8823 * when in edition mode.
8825 * @param obj The clock object
8826 * @param digedit Bit mask indicating the digits to be editable
8827 * (values in #Elm_Clock_Digedit).
8829 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
8830 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
8833 * @see elm_clock_digit_edit_get()
8837 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
8840 * Retrieve what digits of the given clock widget should be
8841 * editable when in edition mode.
8843 * @param obj The clock object
8844 * @return Bit mask indicating the digits to be editable
8845 * (values in #Elm_Clock_Digedit).
8847 * @see elm_clock_digit_edit_set() for more details
8851 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8854 * Set if the given clock widget must show hours in military or
8857 * @param obj The clock object
8858 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
8861 * This function sets if the clock must show hours in military or
8862 * am/pm mode. In some countries like Brazil the military mode
8863 * (00-24h-format) is used, in opposition to the USA, where the
8864 * am/pm mode is more commonly used.
8866 * @see elm_clock_show_am_pm_get()
8870 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
8873 * Get if the given clock widget shows hours in military or am/pm
8876 * @param obj The clock object
8877 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
8880 * This function gets if the clock shows hours in military or am/pm
8883 * @see elm_clock_show_am_pm_set() for more details
8887 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8890 * Set if the given clock widget must show time with seconds or not
8892 * @param obj The clock object
8893 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
8895 * This function sets if the given clock must show or not elapsed
8896 * seconds. By default, they are @b not shown.
8898 * @see elm_clock_show_seconds_get()
8902 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
8905 * Get whether the given clock widget is showing time with seconds
8908 * @param obj The clock object
8909 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
8911 * This function gets whether @p obj is showing or not the elapsed
8914 * @see elm_clock_show_seconds_set()
8918 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8921 * Set the interval on time updates for an user mouse button hold
8922 * on clock widgets' time edition.
8924 * @param obj The clock object
8925 * @param interval The (first) interval value in seconds
8927 * This interval value is @b decreased while the user holds the
8928 * mouse pointer either incrementing or decrementing a given the
8929 * clock digit's value.
8931 * This helps the user to get to a given time distant from the
8932 * current one easier/faster, as it will start to flip quicker and
8933 * quicker on mouse button holds.
8935 * The calculation for the next flip interval value, starting from
8936 * the one set with this call, is the previous interval divided by
8937 * 1.05, so it decreases a little bit.
8939 * The default starting interval value for automatic flips is
8942 * @see elm_clock_interval_get()
8946 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
8949 * Get the interval on time updates for an user mouse button hold
8950 * on clock widgets' time edition.
8952 * @param obj The clock object
8953 * @return The (first) interval value, in seconds, set on it
8955 * @see elm_clock_interval_set() for more details
8959 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8966 * @defgroup Layout Layout
8968 * @image html img/widget/layout/preview-00.png
8969 * @image latex img/widget/layout/preview-00.eps width=\textwidth
8971 * @image html img/layout-predefined.png
8972 * @image latex img/layout-predefined.eps width=\textwidth
8974 * This is a container widget that takes a standard Edje design file and
8975 * wraps it very thinly in a widget.
8977 * An Edje design (theme) file has a very wide range of possibilities to
8978 * describe the behavior of elements added to the Layout. Check out the Edje
8979 * documentation and the EDC reference to get more information about what can
8980 * be done with Edje.
8982 * Just like @ref List, @ref Box, and other container widgets, any
8983 * object added to the Layout will become its child, meaning that it will be
8984 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
8986 * The Layout widget can contain as many Contents, Boxes or Tables as
8987 * described in its theme file. For instance, objects can be added to
8988 * different Tables by specifying the respective Table part names. The same
8989 * is valid for Content and Box.
8991 * The objects added as child of the Layout will behave as described in the
8992 * part description where they were added. There are 3 possible types of
8993 * parts where a child can be added:
8995 * @section secContent Content (SWALLOW part)
8997 * Only one object can be added to the @c SWALLOW part (but you still can
8998 * have many @c SWALLOW parts and one object on each of them). Use the @c
8999 * elm_layout_content_* set of functions to set, retrieve and unset objects
9000 * as content of the @c SWALLOW. After being set to this part, the object
9001 * size, position, visibility, clipping and other description properties
9002 * will be totally controled by the description of the given part (inside
9003 * the Edje theme file).
9005 * One can use @c evas_object_size_hint_* functions on the child to have some
9006 * kind of control over its behavior, but the resulting behavior will still
9007 * depend heavily on the @c SWALLOW part description.
9009 * The Edje theme also can change the part description, based on signals or
9010 * scripts running inside the theme. This change can also be animated. All of
9011 * this will affect the child object set as content accordingly. The object
9012 * size will be changed if the part size is changed, it will animate move if
9013 * the part is moving, and so on.
9015 * The following picture demonstrates a Layout widget with a child object
9016 * added to its @c SWALLOW:
9018 * @image html layout_swallow.png
9019 * @image latex layout_swallow.eps width=\textwidth
9021 * @section secBox Box (BOX part)
9023 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9024 * allows one to add objects to the box and have them distributed along its
9025 * area, accordingly to the specified @a layout property (now by @a layout we
9026 * mean the chosen layouting design of the Box, not the Layout widget
9029 * A similar effect for having a box with its position, size and other things
9030 * controled by the Layout theme would be to create an Elementary @ref Box
9031 * widget and add it as a Content in the @c SWALLOW part.
9033 * The main difference of using the Layout Box is that its behavior, the box
9034 * properties like layouting format, padding, align, etc. will be all
9035 * controled by the theme. This means, for example, that a signal could be
9036 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9037 * handled the signal by changing the box padding, or align, or both. Using
9038 * the Elementary @ref Box widget is not necessarily harder or easier, it
9039 * just depends on the circunstances and requirements.
9041 * The Layout Box can be used through the @c elm_layout_box_* set of
9044 * The following picture demonstrates a Layout widget with many child objects
9045 * added to its @c BOX part:
9047 * @image html layout_box.png
9048 * @image latex layout_box.eps width=\textwidth
9050 * @section secTable Table (TABLE part)
9052 * Just like the @ref secBox, the Layout Table is very similar to the
9053 * Elementary @ref Table widget. It allows one to add objects to the Table
9054 * specifying the row and column where the object should be added, and any
9055 * column or row span if necessary.
9057 * Again, we could have this design by adding a @ref Table widget to the @c
9058 * SWALLOW part using elm_layout_content_set(). The same difference happens
9059 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9060 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9062 * The Layout Table can be used through the @c elm_layout_table_* set of
9065 * The following picture demonstrates a Layout widget with many child objects
9066 * added to its @c TABLE part:
9068 * @image html layout_table.png
9069 * @image latex layout_table.eps width=\textwidth
9071 * @section secPredef Predefined Layouts
9073 * Another interesting thing about the Layout widget is that it offers some
9074 * predefined themes that come with the default Elementary theme. These
9075 * themes can be set by the call elm_layout_theme_set(), and provide some
9076 * basic functionality depending on the theme used.
9078 * Most of them already send some signals, some already provide a toolbar or
9079 * back and next buttons.
9081 * These are available predefined theme layouts. All of them have class = @c
9082 * layout, group = @c application, and style = one of the following options:
9084 * @li @c toolbar-content - application with toolbar and main content area
9085 * @li @c toolbar-content-back - application with toolbar and main content
9086 * area with a back button and title area
9087 * @li @c toolbar-content-back-next - application with toolbar and main
9088 * content area with a back and next buttons and title area
9089 * @li @c content-back - application with a main content area with a back
9090 * button and title area
9091 * @li @c content-back-next - application with a main content area with a
9092 * back and next buttons and title area
9093 * @li @c toolbar-vbox - application with toolbar and main content area as a
9095 * @li @c toolbar-table - application with toolbar and main content area as a
9098 * @section secExamples Examples
9100 * Some examples of the Layout widget can be found here:
9101 * @li @ref layout_example_01
9102 * @li @ref layout_example_02
9103 * @li @ref layout_example_03
9104 * @li @ref layout_example_edc
9109 * Add a new layout to the parent
9111 * @param parent The parent object
9112 * @return The new object or NULL if it cannot be created
9114 * @see elm_layout_file_set()
9115 * @see elm_layout_theme_set()
9119 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9121 * Set the file that will be used as layout
9123 * @param obj The layout object
9124 * @param file The path to file (edj) that will be used as layout
9125 * @param group The group that the layout belongs in edje file
9127 * @return (1 = success, 0 = error)
9131 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9133 * Set the edje group from the elementary theme that will be used as layout
9135 * @param obj The layout object
9136 * @param clas the clas of the group
9137 * @param group the group
9138 * @param style the style to used
9140 * @return (1 = success, 0 = error)
9144 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9146 * Set the layout content.
9148 * @param obj The layout object
9149 * @param swallow The swallow part name in the edje file
9150 * @param content The child that will be added in this layout object
9152 * Once the content object is set, a previously set one will be deleted.
9153 * If you want to keep that old content object, use the
9154 * elm_layout_content_unset() function.
9156 * @note In an Edje theme, the part used as a content container is called @c
9157 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9158 * expected to be a part name just like the second parameter of
9159 * elm_layout_box_append().
9161 * @see elm_layout_box_append()
9162 * @see elm_layout_content_get()
9163 * @see elm_layout_content_unset()
9168 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9170 * Get the child object in the given content part.
9172 * @param obj The layout object
9173 * @param swallow The SWALLOW part to get its content
9175 * @return The swallowed object or NULL if none or an error occurred
9177 * @see elm_layout_content_set()
9181 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9183 * Unset the layout content.
9185 * @param obj The layout object
9186 * @param swallow The swallow part name in the edje file
9187 * @return The content that was being used
9189 * Unparent and return the content object which was set for this part.
9191 * @see elm_layout_content_set()
9195 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9197 * Set the text of the given part
9199 * @param obj The layout object
9200 * @param part The TEXT part where to set the text
9201 * @param text The text to set
9204 * @deprecated use elm_object_text_* instead.
9206 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9208 * Get the text set in the given part
9210 * @param obj The layout object
9211 * @param part The TEXT part to retrieve the text off
9213 * @return The text set in @p part
9216 * @deprecated use elm_object_text_* instead.
9218 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9220 * Append child to layout box part.
9222 * @param obj the layout object
9223 * @param part the box part to which the object will be appended.
9224 * @param child the child object to append to box.
9226 * Once the object is appended, it will become child of the layout. Its
9227 * lifetime will be bound to the layout, whenever the layout dies the child
9228 * will be deleted automatically. One should use elm_layout_box_remove() to
9229 * make this layout forget about the object.
9231 * @see elm_layout_box_prepend()
9232 * @see elm_layout_box_insert_before()
9233 * @see elm_layout_box_insert_at()
9234 * @see elm_layout_box_remove()
9238 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9240 * Prepend child to layout box part.
9242 * @param obj the layout object
9243 * @param part the box part to prepend.
9244 * @param child the child object to prepend to box.
9246 * Once the object is prepended, it will become child of the layout. Its
9247 * lifetime will be bound to the layout, whenever the layout dies the child
9248 * will be deleted automatically. One should use elm_layout_box_remove() to
9249 * make this layout forget about the object.
9251 * @see elm_layout_box_append()
9252 * @see elm_layout_box_insert_before()
9253 * @see elm_layout_box_insert_at()
9254 * @see elm_layout_box_remove()
9258 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9260 * Insert child to layout box part before a reference object.
9262 * @param obj the layout object
9263 * @param part the box part to insert.
9264 * @param child the child object to insert into box.
9265 * @param reference another reference object to insert before in box.
9267 * Once the object is inserted, it will become child of the layout. Its
9268 * lifetime will be bound to the layout, whenever the layout dies the child
9269 * will be deleted automatically. One should use elm_layout_box_remove() to
9270 * make this layout forget about the object.
9272 * @see elm_layout_box_append()
9273 * @see elm_layout_box_prepend()
9274 * @see elm_layout_box_insert_before()
9275 * @see elm_layout_box_remove()
9279 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9281 * Insert child to layout box part at a given position.
9283 * @param obj the layout object
9284 * @param part the box part to insert.
9285 * @param child the child object to insert into box.
9286 * @param pos the numeric position >=0 to insert the child.
9288 * Once the object is inserted, it will become child of the layout. Its
9289 * lifetime will be bound to the layout, whenever the layout dies the child
9290 * will be deleted automatically. One should use elm_layout_box_remove() to
9291 * make this layout forget about the object.
9293 * @see elm_layout_box_append()
9294 * @see elm_layout_box_prepend()
9295 * @see elm_layout_box_insert_before()
9296 * @see elm_layout_box_remove()
9300 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9302 * Remove a child of the given part box.
9304 * @param obj The layout object
9305 * @param part The box part name to remove child.
9306 * @param child The object to remove from box.
9307 * @return The object that was being used, or NULL if not found.
9309 * The object will be removed from the box part and its lifetime will
9310 * not be handled by the layout anymore. This is equivalent to
9311 * elm_layout_content_unset() for box.
9313 * @see elm_layout_box_append()
9314 * @see elm_layout_box_remove_all()
9318 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9320 * Remove all child of the given part box.
9322 * @param obj The layout object
9323 * @param part The box part name to remove child.
9324 * @param clear If EINA_TRUE, then all objects will be deleted as
9325 * well, otherwise they will just be removed and will be
9326 * dangling on the canvas.
9328 * The objects will be removed from the box part and their lifetime will
9329 * not be handled by the layout anymore. This is equivalent to
9330 * elm_layout_box_remove() for all box children.
9332 * @see elm_layout_box_append()
9333 * @see elm_layout_box_remove()
9337 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9339 * Insert child to layout table part.
9341 * @param obj the layout object
9342 * @param part the box part to pack child.
9343 * @param child_obj the child object to pack into table.
9344 * @param col the column to which the child should be added. (>= 0)
9345 * @param row the row to which the child should be added. (>= 0)
9346 * @param colspan how many columns should be used to store this object. (>=
9348 * @param rowspan how many rows should be used to store this object. (>= 1)
9350 * Once the object is inserted, it will become child of the table. Its
9351 * lifetime will be bound to the layout, and whenever the layout dies the
9352 * child will be deleted automatically. One should use
9353 * elm_layout_table_remove() to make this layout forget about the object.
9355 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9356 * more space than a single cell. For instance, the following code:
9358 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9361 * Would result in an object being added like the following picture:
9363 * @image html layout_colspan.png
9364 * @image latex layout_colspan.eps width=\textwidth
9366 * @see elm_layout_table_unpack()
9367 * @see elm_layout_table_clear()
9371 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);
9373 * Unpack (remove) a child of the given part table.
9375 * @param obj The layout object
9376 * @param part The table part name to remove child.
9377 * @param child_obj The object to remove from table.
9378 * @return The object that was being used, or NULL if not found.
9380 * The object will be unpacked from the table part and its lifetime
9381 * will not be handled by the layout anymore. This is equivalent to
9382 * elm_layout_content_unset() for table.
9384 * @see elm_layout_table_pack()
9385 * @see elm_layout_table_clear()
9389 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9391 * Remove all child of the given part table.
9393 * @param obj The layout object
9394 * @param part The table part name to remove child.
9395 * @param clear If EINA_TRUE, then all objects will be deleted as
9396 * well, otherwise they will just be removed and will be
9397 * dangling on the canvas.
9399 * The objects will be removed from the table part and their lifetime will
9400 * not be handled by the layout anymore. This is equivalent to
9401 * elm_layout_table_unpack() for all table children.
9403 * @see elm_layout_table_pack()
9404 * @see elm_layout_table_unpack()
9408 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9410 * Get the edje layout
9412 * @param obj The layout object
9414 * @return A Evas_Object with the edje layout settings loaded
9415 * with function elm_layout_file_set
9417 * This returns the edje object. It is not expected to be used to then
9418 * swallow objects via edje_object_part_swallow() for example. Use
9419 * elm_layout_content_set() instead so child object handling and sizing is
9422 * @note This function should only be used if you really need to call some
9423 * low level Edje function on this edje object. All the common stuff (setting
9424 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9425 * with proper elementary functions.
9427 * @see elm_object_signal_callback_add()
9428 * @see elm_object_signal_emit()
9429 * @see elm_object_text_part_set()
9430 * @see elm_layout_content_set()
9431 * @see elm_layout_box_append()
9432 * @see elm_layout_table_pack()
9433 * @see elm_layout_data_get()
9437 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9439 * Get the edje data from the given layout
9441 * @param obj The layout object
9442 * @param key The data key
9444 * @return The edje data string
9446 * This function fetches data specified inside the edje theme of this layout.
9447 * This function return NULL if data is not found.
9449 * In EDC this comes from a data block within the group block that @p
9450 * obj was loaded from. E.g.
9457 * item: "key1" "value1";
9458 * item: "key2" "value2";
9466 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9470 * @param obj The layout object
9472 * Manually forces a sizing re-evaluation. This is useful when the minimum
9473 * size required by the edje theme of this layout has changed. The change on
9474 * the minimum size required by the edje theme is not immediately reported to
9475 * the elementary layout, so one needs to call this function in order to tell
9476 * the widget (layout) that it needs to reevaluate its own size.
9478 * The minimum size of the theme is calculated based on minimum size of
9479 * parts, the size of elements inside containers like box and table, etc. All
9480 * of this can change due to state changes, and that's when this function
9483 * Also note that a standard signal of "size,eval" "elm" emitted from the
9484 * edje object will cause this to happen too.
9488 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9491 * Sets a specific cursor for an edje part.
9493 * @param obj The layout object.
9494 * @param part_name a part from loaded edje group.
9495 * @param cursor cursor name to use, see Elementary_Cursor.h
9497 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9498 * part not exists or it has "mouse_events: 0".
9502 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9505 * Get the cursor to be shown when mouse is over an edje part
9507 * @param obj The layout object.
9508 * @param part_name a part from loaded edje group.
9509 * @return the cursor name.
9513 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9516 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9518 * @param obj The layout object.
9519 * @param part_name a part from loaded edje group, that had a cursor set
9520 * with elm_layout_part_cursor_set().
9524 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9527 * Sets a specific cursor style for an edje part.
9529 * @param obj The layout object.
9530 * @param part_name a part from loaded edje group.
9531 * @param style the theme style to use (default, transparent, ...)
9533 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9534 * part not exists or it did not had a cursor set.
9538 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9541 * Gets a specific cursor style for an edje part.
9543 * @param obj The layout object.
9544 * @param part_name a part from loaded edje group.
9546 * @return the theme style in use, defaults to "default". If the
9547 * object does not have a cursor set, then NULL is returned.
9551 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9554 * Sets if the cursor set should be searched on the theme or should use
9555 * the provided by the engine, only.
9557 * @note before you set if should look on theme you should define a
9558 * cursor with elm_layout_part_cursor_set(). By default it will only
9559 * look for cursors provided by the engine.
9561 * @param obj The layout object.
9562 * @param part_name a part from loaded edje group.
9563 * @param engine_only if cursors should be just provided by the engine
9564 * or should also search on widget's theme as well
9566 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9567 * part not exists or it did not had a cursor set.
9571 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);
9574 * Gets a specific cursor engine_only for an edje part.
9576 * @param obj The layout object.
9577 * @param part_name a part from loaded edje group.
9579 * @return whenever the cursor is just provided by engine or also from theme.
9583 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9586 * @def elm_layout_icon_set
9587 * Convienience macro to set the icon object in a layout that follows the
9588 * Elementary naming convention for its parts.
9592 #define elm_layout_icon_set(_ly, _obj) \
9595 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9596 if ((_obj)) sig = "elm,state,icon,visible"; \
9597 else sig = "elm,state,icon,hidden"; \
9598 elm_object_signal_emit((_ly), sig, "elm"); \
9602 * @def elm_layout_icon_get
9603 * Convienience macro to get the icon object from a layout that follows the
9604 * Elementary naming convention for its parts.
9608 #define elm_layout_icon_get(_ly) \
9609 elm_layout_content_get((_ly), "elm.swallow.icon")
9612 * @def elm_layout_end_set
9613 * Convienience macro to set the end object in a layout that follows the
9614 * Elementary naming convention for its parts.
9618 #define elm_layout_end_set(_ly, _obj) \
9621 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9622 if ((_obj)) sig = "elm,state,end,visible"; \
9623 else sig = "elm,state,end,hidden"; \
9624 elm_object_signal_emit((_ly), sig, "elm"); \
9628 * @def elm_layout_end_get
9629 * Convienience macro to get the end object in a layout that follows the
9630 * Elementary naming convention for its parts.
9634 #define elm_layout_end_get(_ly) \
9635 elm_layout_content_get((_ly), "elm.swallow.end")
9638 * @def elm_layout_label_set
9639 * Convienience macro to set the label in a layout that follows the
9640 * Elementary naming convention for its parts.
9643 * @deprecated use elm_object_text_* instead.
9645 #define elm_layout_label_set(_ly, _txt) \
9646 elm_layout_text_set((_ly), "elm.text", (_txt))
9649 * @def elm_layout_label_get
9650 * Convienience macro to get the label in a layout that follows the
9651 * Elementary naming convention for its parts.
9654 * @deprecated use elm_object_text_* instead.
9656 #define elm_layout_label_get(_ly) \
9657 elm_layout_text_get((_ly), "elm.text")
9659 /* smart callbacks called:
9660 * "theme,changed" - when elm theme is changed.
9664 * @defgroup Notify Notify
9666 * @image html img/widget/notify/preview-00.png
9667 * @image latex img/widget/notify/preview-00.eps
9669 * Display a container in a particular region of the parent(top, bottom,
9670 * etc. A timeout can be set to automatically hide the notify. This is so
9671 * that, after an evas_object_show() on a notify object, if a timeout was set
9672 * on it, it will @b automatically get hidden after that time.
9674 * Signals that you can add callbacks for are:
9675 * @li "timeout" - when timeout happens on notify and it's hidden
9676 * @li "block,clicked" - when a click outside of the notify happens
9678 * @ref tutorial_notify show usage of the API.
9683 * @brief Possible orient values for notify.
9685 * This values should be used in conjunction to elm_notify_orient_set() to
9686 * set the position in which the notify should appear(relative to its parent)
9687 * and in conjunction with elm_notify_orient_get() to know where the notify
9690 typedef enum _Elm_Notify_Orient
9692 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9693 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9694 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9695 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9696 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9697 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9698 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9699 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9700 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9701 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9702 } Elm_Notify_Orient;
9704 * @brief Add a new notify to the parent
9706 * @param parent The parent object
9707 * @return The new object or NULL if it cannot be created
9709 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9711 * @brief Set the content of the notify widget
9713 * @param obj The notify object
9714 * @param content The content will be filled in this notify object
9716 * Once the content object is set, a previously set one will be deleted. If
9717 * you want to keep that old content object, use the
9718 * elm_notify_content_unset() function.
9720 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9722 * @brief Unset the content of the notify widget
9724 * @param obj The notify object
9725 * @return The content that was being used
9727 * Unparent and return the content object which was set for this widget
9729 * @see elm_notify_content_set()
9731 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9733 * @brief Return the content of the notify widget
9735 * @param obj The notify object
9736 * @return The content that is being used
9738 * @see elm_notify_content_set()
9740 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9742 * @brief Set the notify parent
9744 * @param obj The notify object
9745 * @param content The new parent
9747 * Once the parent object is set, a previously set one will be disconnected
9750 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9752 * @brief Get the notify parent
9754 * @param obj The notify object
9755 * @return The parent
9757 * @see elm_notify_parent_set()
9759 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9761 * @brief Set the orientation
9763 * @param obj The notify object
9764 * @param orient The new orientation
9766 * Sets the position in which the notify will appear in its parent.
9768 * @see @ref Elm_Notify_Orient for possible values.
9770 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9772 * @brief Return the orientation
9773 * @param obj The notify object
9774 * @return The orientation of the notification
9776 * @see elm_notify_orient_set()
9777 * @see Elm_Notify_Orient
9779 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9781 * @brief Set the time interval after which the notify window is going to be
9784 * @param obj The notify object
9785 * @param time The timeout in seconds
9787 * This function sets a timeout and starts the timer controlling when the
9788 * notify is hidden. Since calling evas_object_show() on a notify restarts
9789 * the timer controlling when the notify is hidden, setting this before the
9790 * notify is shown will in effect mean starting the timer when the notify is
9793 * @note Set a value <= 0.0 to disable a running timer.
9795 * @note If the value > 0.0 and the notify is previously visible, the
9796 * timer will be started with this value, canceling any running timer.
9798 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
9800 * @brief Return the timeout value (in seconds)
9801 * @param obj the notify object
9803 * @see elm_notify_timeout_set()
9805 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9807 * @brief Sets whether events should be passed to by a click outside
9810 * @param obj The notify object
9811 * @param repeats EINA_TRUE Events are repeats, else no
9813 * When true if the user clicks outside the window the events will be caught
9814 * by the others widgets, else the events are blocked.
9816 * @note The default value is EINA_TRUE.
9818 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
9820 * @brief Return true if events are repeat below the notify object
9821 * @param obj the notify object
9823 * @see elm_notify_repeat_events_set()
9825 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9831 * @defgroup Hover Hover
9833 * @image html img/widget/hover/preview-00.png
9834 * @image latex img/widget/hover/preview-00.eps
9836 * A Hover object will hover over its @p parent object at the @p target
9837 * location. Anything in the background will be given a darker coloring to
9838 * indicate that the hover object is on top (at the default theme). When the
9839 * hover is clicked it is dismissed(hidden), if the contents of the hover are
9840 * clicked that @b doesn't cause the hover to be dismissed.
9842 * @note The hover object will take up the entire space of @p target
9845 * Elementary has the following styles for the hover widget:
9849 * @li hoversel_vertical
9851 * The following are the available position for content:
9863 * Signals that you can add callbacks for are:
9864 * @li "clicked" - the user clicked the empty space in the hover to dismiss
9865 * @li "smart,changed" - a content object placed under the "smart"
9866 * policy was replaced to a new slot direction.
9868 * See @ref tutorial_hover for more information.
9872 typedef enum _Elm_Hover_Axis
9874 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
9875 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
9876 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
9877 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
9880 * @brief Adds a hover object to @p parent
9882 * @param parent The parent object
9883 * @return The hover object or NULL if one could not be created
9885 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9887 * @brief Sets the target object for the hover.
9889 * @param obj The hover object
9890 * @param target The object to center the hover onto. The hover
9892 * This function will cause the hover to be centered on the target object.
9894 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
9896 * @brief Gets the target object for the hover.
9898 * @param obj The hover object
9899 * @param parent The object to locate the hover over.
9901 * @see elm_hover_target_set()
9903 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9905 * @brief Sets the parent object for the hover.
9907 * @param obj The hover object
9908 * @param parent The object to locate the hover over.
9910 * This function will cause the hover to take up the entire space that the
9911 * parent object fills.
9913 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9915 * @brief Gets the parent object for the hover.
9917 * @param obj The hover object
9918 * @return The parent object to locate the hover over.
9920 * @see elm_hover_parent_set()
9922 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9924 * @brief Sets the content of the hover object and the direction in which it
9927 * @param obj The hover object
9928 * @param swallow The direction that the object will be displayed
9929 * at. Accepted values are "left", "top-left", "top", "top-right",
9930 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
9932 * @param content The content to place at @p swallow
9934 * Once the content object is set for a given direction, a previously
9935 * set one (on the same direction) will be deleted. If you want to
9936 * keep that old content object, use the elm_hover_content_unset()
9939 * All directions may have contents at the same time, except for
9940 * "smart". This is a special placement hint and its use case
9941 * independs of the calculations coming from
9942 * elm_hover_best_content_location_get(). Its use is for cases when
9943 * one desires only one hover content, but with a dinamic special
9944 * placement within the hover area. The content's geometry, whenever
9945 * it changes, will be used to decide on a best location not
9946 * extrapolating the hover's parent object view to show it in (still
9947 * being the hover's target determinant of its medium part -- move and
9948 * resize it to simulate finger sizes, for example). If one of the
9949 * directions other than "smart" are used, a previously content set
9950 * using it will be deleted, and vice-versa.
9952 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9954 * @brief Get the content of the hover object, in a given direction.
9956 * Return the content object which was set for this widget in the
9957 * @p swallow direction.
9959 * @param obj The hover object
9960 * @param swallow The direction that the object was display at.
9961 * @return The content that was being used
9963 * @see elm_hover_content_set()
9965 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9967 * @brief Unset the content of the hover object, in a given direction.
9969 * Unparent and return the content object set at @p swallow direction.
9971 * @param obj The hover object
9972 * @param swallow The direction that the object was display at.
9973 * @return The content that was being used.
9975 * @see elm_hover_content_set()
9977 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9979 * @brief Returns the best swallow location for content in the hover.
9981 * @param obj The hover object
9982 * @param pref_axis The preferred orientation axis for the hover object to use
9983 * @return The edje location to place content into the hover or @c
9986 * Best is defined here as the location at which there is the most available
9989 * @p pref_axis may be one of
9990 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
9991 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
9992 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
9993 * - @c ELM_HOVER_AXIS_BOTH -- both
9995 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
9996 * nescessarily be along the horizontal axis("left" or "right"). If
9997 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
9998 * be along the vertical axis("top" or "bottom"). Chossing
9999 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10000 * returned position may be in either axis.
10002 * @see elm_hover_content_set()
10004 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10011 * @defgroup Entry Entry
10013 * @image html img/widget/entry/preview-00.png
10014 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10015 * @image html img/widget/entry/preview-01.png
10016 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10017 * @image html img/widget/entry/preview-02.png
10018 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10019 * @image html img/widget/entry/preview-03.png
10020 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10022 * An entry is a convenience widget which shows a box that the user can
10023 * enter text into. Entries by default don't scroll, so they grow to
10024 * accomodate the entire text, resizing the parent window as needed. This
10025 * can be changed with the elm_entry_scrollable_set() function.
10027 * They can also be single line or multi line (the default) and when set
10028 * to multi line mode they support text wrapping in any of the modes
10029 * indicated by #Elm_Wrap_Type.
10031 * Other features include password mode, filtering of inserted text with
10032 * elm_entry_text_filter_append() and related functions, inline "items" and
10033 * formatted markup text.
10035 * @section entry-markup Formatted text
10037 * The markup tags supported by the Entry are defined by the theme, but
10038 * even when writing new themes or extensions it's a good idea to stick to
10039 * a sane default, to maintain coherency and avoid application breakages.
10040 * Currently defined by the default theme are the following tags:
10041 * @li \<br\>: Inserts a line break.
10042 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10044 * @li \<tab\>: Inserts a tab.
10045 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10047 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10048 * @li \<link\>...\</link\>: Underlines the enclosed text.
10049 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10051 * @section entry-special Special markups
10053 * Besides those used to format text, entries support two special markup
10054 * tags used to insert clickable portions of text or items inlined within
10057 * @subsection entry-anchors Anchors
10059 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10060 * \</a\> tags and an event will be generated when this text is clicked,
10064 * This text is outside <a href=anc-01>but this one is an anchor</a>
10067 * The @c href attribute in the opening tag gives the name that will be
10068 * used to identify the anchor and it can be any valid utf8 string.
10070 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10071 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10072 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10073 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10076 * @subsection entry-items Items
10078 * Inlined in the text, any other @c Evas_Object can be inserted by using
10079 * \<item\> tags this way:
10082 * <item size=16x16 vsize=full href=emoticon/haha></item>
10085 * Just like with anchors, the @c href identifies each item, but these need,
10086 * in addition, to indicate their size, which is done using any one of
10087 * @c size, @c absize or @c relsize attributes. These attributes take their
10088 * value in the WxH format, where W is the width and H the height of the
10091 * @li absize: Absolute pixel size for the item. Whatever value is set will
10092 * be the item's size regardless of any scale value the object may have
10093 * been set to. The final line height will be adjusted to fit larger items.
10094 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10096 * @li relsize: Size is adjusted for the item to fit within the current
10099 * Besides their size, items are specificed a @c vsize value that affects
10100 * how their final size and position are calculated. The possible values
10102 * @li ascent: Item will be placed within the line's baseline and its
10103 * ascent. That is, the height between the line where all characters are
10104 * positioned and the highest point in the line. For @c size and @c absize
10105 * items, the descent value will be added to the total line height to make
10106 * them fit. @c relsize items will be adjusted to fit within this space.
10107 * @li full: Items will be placed between the descent and ascent, or the
10108 * lowest point in the line and its highest.
10110 * The next image shows different configurations of items and how they
10111 * are the previously mentioned options affect their sizes. In all cases,
10112 * the green line indicates the ascent, blue for the baseline and red for
10115 * @image html entry_item.png
10116 * @image latex entry_item.eps width=\textwidth
10118 * And another one to show how size differs from absize. In the first one,
10119 * the scale value is set to 1.0, while the second one is using one of 2.0.
10121 * @image html entry_item_scale.png
10122 * @image latex entry_item_scale.eps width=\textwidth
10124 * After the size for an item is calculated, the entry will request an
10125 * object to place in its space. For this, the functions set with
10126 * elm_entry_item_provider_append() and related functions will be called
10127 * in order until one of them returns a @c non-NULL value. If no providers
10128 * are available, or all of them return @c NULL, then the entry falls back
10129 * to one of the internal defaults, provided the name matches with one of
10132 * All of the following are currently supported:
10135 * - emoticon/angry-shout
10136 * - emoticon/crazy-laugh
10137 * - emoticon/evil-laugh
10139 * - emoticon/goggle-smile
10140 * - emoticon/grumpy
10141 * - emoticon/grumpy-smile
10142 * - emoticon/guilty
10143 * - emoticon/guilty-smile
10145 * - emoticon/half-smile
10146 * - emoticon/happy-panting
10148 * - emoticon/indifferent
10150 * - emoticon/knowing-grin
10152 * - emoticon/little-bit-sorry
10153 * - emoticon/love-lots
10155 * - emoticon/minimal-smile
10156 * - emoticon/not-happy
10157 * - emoticon/not-impressed
10159 * - emoticon/opensmile
10162 * - emoticon/squint-laugh
10163 * - emoticon/surprised
10164 * - emoticon/suspicious
10165 * - emoticon/tongue-dangling
10166 * - emoticon/tongue-poke
10168 * - emoticon/unhappy
10169 * - emoticon/very-sorry
10172 * - emoticon/worried
10175 * Alternatively, an item may reference an image by its path, using
10176 * the URI form @c file:///path/to/an/image.png and the entry will then
10177 * use that image for the item.
10179 * @section entry-files Loading and saving files
10181 * Entries have convinience functions to load text from a file and save
10182 * changes back to it after a short delay. The automatic saving is enabled
10183 * by default, but can be disabled with elm_entry_autosave_set() and files
10184 * can be loaded directly as plain text or have any markup in them
10185 * recognized. See elm_entry_file_set() for more details.
10187 * @section entry-signals Emitted signals
10189 * This widget emits the following signals:
10191 * @li "changed": The text within the entry was changed.
10192 * @li "changed,user": The text within the entry was changed because of user interaction.
10193 * @li "activated": The enter key was pressed on a single line entry.
10194 * @li "press": A mouse button has been pressed on the entry.
10195 * @li "longpressed": A mouse button has been pressed and held for a couple
10197 * @li "clicked": The entry has been clicked (mouse press and release).
10198 * @li "clicked,double": The entry has been double clicked.
10199 * @li "clicked,triple": The entry has been triple clicked.
10200 * @li "focused": The entry has received focus.
10201 * @li "unfocused": The entry has lost focus.
10202 * @li "selection,paste": A paste of the clipboard contents was requested.
10203 * @li "selection,copy": A copy of the selected text into the clipboard was
10205 * @li "selection,cut": A cut of the selected text into the clipboard was
10207 * @li "selection,start": A selection has begun and no previous selection
10209 * @li "selection,changed": The current selection has changed.
10210 * @li "selection,cleared": The current selection has been cleared.
10211 * @li "cursor,changed": The cursor has changed position.
10212 * @li "anchor,clicked": An anchor has been clicked. The event_info
10213 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10214 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10215 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10216 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10217 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10218 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10219 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10220 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10221 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10222 * @li "preedit,changed": The preedit string has changed.
10224 * @section entry-examples
10226 * An overview of the Entry API can be seen in @ref entry_example_01
10231 * @typedef Elm_Entry_Anchor_Info
10233 * The info sent in the callback for the "anchor,clicked" signals emitted
10236 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10238 * @struct _Elm_Entry_Anchor_Info
10240 * The info sent in the callback for the "anchor,clicked" signals emitted
10243 struct _Elm_Entry_Anchor_Info
10245 const char *name; /**< The name of the anchor, as stated in its href */
10246 int button; /**< The mouse button used to click on it */
10247 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10248 y, /**< Anchor geometry, relative to canvas */
10249 w, /**< Anchor geometry, relative to canvas */
10250 h; /**< Anchor geometry, relative to canvas */
10253 * @typedef Elm_Entry_Filter_Cb
10254 * This callback type is used by entry filters to modify text.
10255 * @param data The data specified as the last param when adding the filter
10256 * @param entry The entry object
10257 * @param text A pointer to the location of the text being filtered. This data can be modified,
10258 * but any additional allocations must be managed by the user.
10259 * @see elm_entry_text_filter_append
10260 * @see elm_entry_text_filter_prepend
10262 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10265 * This adds an entry to @p parent object.
10267 * By default, entries are:
10271 * @li autosave is enabled
10273 * @param parent The parent object
10274 * @return The new object or NULL if it cannot be created
10276 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10278 * Sets the entry to single line mode.
10280 * In single line mode, entries don't ever wrap when the text reaches the
10281 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10282 * key will generate an @c "activate" event instead of adding a new line.
10284 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10285 * and pressing enter will break the text into a different line
10286 * without generating any events.
10288 * @param obj The entry object
10289 * @param single_line If true, the text in the entry
10290 * will be on a single line.
10292 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10294 * Gets whether the entry is set to be single line.
10296 * @param obj The entry object
10297 * @return single_line If true, the text in the entry is set to display
10298 * on a single line.
10300 * @see elm_entry_single_line_set()
10302 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10304 * Sets the entry to password mode.
10306 * In password mode, entries are implicitly single line and the display of
10307 * any text in them is replaced with asterisks (*).
10309 * @param obj The entry object
10310 * @param password If true, password mode is enabled.
10312 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10314 * Gets whether the entry is set to password mode.
10316 * @param obj The entry object
10317 * @return If true, the entry is set to display all characters
10318 * as asterisks (*).
10320 * @see elm_entry_password_set()
10322 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10324 * This sets the text displayed within the entry to @p entry.
10326 * @param obj The entry object
10327 * @param entry The text to be displayed
10329 * @deprecated Use elm_object_text_set() instead.
10331 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10333 * This returns the text currently shown in object @p entry.
10334 * See also elm_entry_entry_set().
10336 * @param obj The entry object
10337 * @return The currently displayed text or NULL on failure
10339 * @deprecated Use elm_object_text_get() instead.
10341 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10343 * Appends @p entry to the text of the entry.
10345 * Adds the text in @p entry to the end of any text already present in the
10348 * The appended text is subject to any filters set for the widget.
10350 * @param obj The entry object
10351 * @param entry The text to be displayed
10353 * @see elm_entry_text_filter_append()
10355 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10357 * Gets whether the entry is empty.
10359 * Empty means no text at all. If there are any markup tags, like an item
10360 * tag for which no provider finds anything, and no text is displayed, this
10361 * function still returns EINA_FALSE.
10363 * @param obj The entry object
10364 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10366 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10368 * Gets any selected text within the entry.
10370 * If there's any selected text in the entry, this function returns it as
10371 * a string in markup format. NULL is returned if no selection exists or
10372 * if an error occurred.
10374 * The returned value points to an internal string and should not be freed
10375 * or modified in any way. If the @p entry object is deleted or its
10376 * contents are changed, the returned pointer should be considered invalid.
10378 * @param obj The entry object
10379 * @return The selected text within the entry or NULL on failure
10381 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10383 * Inserts the given text into the entry at the current cursor position.
10385 * This inserts text at the cursor position as if it was typed
10386 * by the user (note that this also allows markup which a user
10387 * can't just "type" as it would be converted to escaped text, so this
10388 * call can be used to insert things like emoticon items or bold push/pop
10389 * tags, other font and color change tags etc.)
10391 * If any selection exists, it will be replaced by the inserted text.
10393 * The inserted text is subject to any filters set for the widget.
10395 * @param obj The entry object
10396 * @param entry The text to insert
10398 * @see elm_entry_text_filter_append()
10400 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10402 * Set the line wrap type to use on multi-line entries.
10404 * Sets the wrap type used by the entry to any of the specified in
10405 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10406 * line (without inserting a line break or paragraph separator) when it
10407 * reaches the far edge of the widget.
10409 * Note that this only makes sense for multi-line entries. A widget set
10410 * to be single line will never wrap.
10412 * @param obj The entry object
10413 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10415 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10417 * Gets the wrap mode the entry was set to use.
10419 * @param obj The entry object
10420 * @return Wrap type
10422 * @see also elm_entry_line_wrap_set()
10424 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10426 * Sets if the entry is to be editable or not.
10428 * By default, entries are editable and when focused, any text input by the
10429 * user will be inserted at the current cursor position. But calling this
10430 * function with @p editable as EINA_FALSE will prevent the user from
10431 * inputting text into the entry.
10433 * The only way to change the text of a non-editable entry is to use
10434 * elm_object_text_set(), elm_entry_entry_insert() and other related
10437 * @param obj The entry object
10438 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10439 * if not, the entry is read-only and no user input is allowed.
10441 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10443 * Gets whether the entry is editable or not.
10445 * @param obj The entry object
10446 * @return If true, the entry is editable by the user.
10447 * If false, it is not editable by the user
10449 * @see elm_entry_editable_set()
10451 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10453 * This drops any existing text selection within the entry.
10455 * @param obj The entry object
10457 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10459 * This selects all text within the entry.
10461 * @param obj The entry object
10463 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10465 * This moves the cursor one place to the right within the entry.
10467 * @param obj The entry object
10468 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10470 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10472 * This moves the cursor one place to the left within the entry.
10474 * @param obj The entry object
10475 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10477 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10479 * This moves the cursor one line up within the entry.
10481 * @param obj The entry object
10482 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10484 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10486 * This moves the cursor one line down within the entry.
10488 * @param obj The entry object
10489 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10491 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10493 * This moves the cursor to the beginning of the entry.
10495 * @param obj The entry object
10497 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10499 * This moves the cursor to the end of the entry.
10501 * @param obj The entry object
10503 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10505 * This moves the cursor to the beginning of the current line.
10507 * @param obj The entry object
10509 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10511 * This moves the cursor to the end of the current line.
10513 * @param obj The entry object
10515 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10517 * This begins a selection within the entry as though
10518 * the user were holding down the mouse button to make a selection.
10520 * @param obj The entry object
10522 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10524 * This ends a selection within the entry as though
10525 * the user had just released the mouse button while making a selection.
10527 * @param obj The entry object
10529 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10531 * Gets whether a format node exists at the current cursor position.
10533 * A format node is anything that defines how the text is rendered. It can
10534 * be a visible format node, such as a line break or a paragraph separator,
10535 * or an invisible one, such as bold begin or end tag.
10536 * This function returns whether any format node exists at the current
10539 * @param obj The entry object
10540 * @return EINA_TRUE if the current cursor position contains a format node,
10541 * EINA_FALSE otherwise.
10543 * @see elm_entry_cursor_is_visible_format_get()
10545 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10547 * Gets if the current cursor position holds a visible format node.
10549 * @param obj The entry object
10550 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10551 * if it's an invisible one or no format exists.
10553 * @see elm_entry_cursor_is_format_get()
10555 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10557 * Gets the character pointed by the cursor at its current position.
10559 * This function returns a string with the utf8 character stored at the
10560 * current cursor position.
10561 * Only the text is returned, any format that may exist will not be part
10562 * of the return value.
10564 * @param obj The entry object
10565 * @return The text pointed by the cursors.
10567 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10569 * This function returns the geometry of the cursor.
10571 * It's useful if you want to draw something on the cursor (or where it is),
10572 * or for example in the case of scrolled entry where you want to show the
10575 * @param obj The entry object
10576 * @param x returned geometry
10577 * @param y returned geometry
10578 * @param w returned geometry
10579 * @param h returned geometry
10580 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10582 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);
10584 * Sets the cursor position in the entry to the given value
10586 * The value in @p pos is the index of the character position within the
10587 * contents of the string as returned by elm_entry_cursor_pos_get().
10589 * @param obj The entry object
10590 * @param pos The position of the cursor
10592 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10594 * Retrieves the current position of the cursor in the entry
10596 * @param obj The entry object
10597 * @return The cursor position
10599 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10601 * This executes a "cut" action on the selected text in the entry.
10603 * @param obj The entry object
10605 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10607 * This executes a "copy" action on the selected text in the entry.
10609 * @param obj The entry object
10611 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10613 * This executes a "paste" action in the entry.
10615 * @param obj The entry object
10617 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10619 * This clears and frees the items in a entry's contextual (longpress)
10622 * @param obj The entry object
10624 * @see elm_entry_context_menu_item_add()
10626 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10628 * This adds an item to the entry's contextual menu.
10630 * A longpress on an entry will make the contextual menu show up, if this
10631 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10632 * By default, this menu provides a few options like enabling selection mode,
10633 * which is useful on embedded devices that need to be explicit about it,
10634 * and when a selection exists it also shows the copy and cut actions.
10636 * With this function, developers can add other options to this menu to
10637 * perform any action they deem necessary.
10639 * @param obj The entry object
10640 * @param label The item's text label
10641 * @param icon_file The item's icon file
10642 * @param icon_type The item's icon type
10643 * @param func The callback to execute when the item is clicked
10644 * @param data The data to associate with the item for related functions
10646 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);
10648 * This disables the entry's contextual (longpress) menu.
10650 * @param obj The entry object
10651 * @param disabled If true, the menu is disabled
10653 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10655 * This returns whether the entry's contextual (longpress) menu is
10658 * @param obj The entry object
10659 * @return If true, the menu is disabled
10661 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10663 * This appends a custom item provider to the list for that entry
10665 * This appends the given callback. The list is walked from beginning to end
10666 * with each function called given the item href string in the text. If the
10667 * function returns an object handle other than NULL (it should create an
10668 * object to do this), then this object is used to replace that item. If
10669 * not the next provider is called until one provides an item object, or the
10670 * default provider in entry does.
10672 * @param obj The entry object
10673 * @param func The function called to provide the item object
10674 * @param data The data passed to @p func
10676 * @see @ref entry-items
10678 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);
10680 * This prepends a custom item provider to the list for that entry
10682 * This prepends the given callback. See elm_entry_item_provider_append() for
10685 * @param obj The entry object
10686 * @param func The function called to provide the item object
10687 * @param data The data passed to @p func
10689 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);
10691 * This removes a custom item provider to the list for that entry
10693 * This removes the given callback. See elm_entry_item_provider_append() for
10696 * @param obj The entry object
10697 * @param func The function called to provide the item object
10698 * @param data The data passed to @p func
10700 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);
10702 * Append a filter function for text inserted in the entry
10704 * Append the given callback to the list. This functions will be called
10705 * whenever any text is inserted into the entry, with the text to be inserted
10706 * as a parameter. The callback function is free to alter the text in any way
10707 * it wants, but it must remember to free the given pointer and update it.
10708 * If the new text is to be discarded, the function can free it and set its
10709 * text parameter to NULL. This will also prevent any following filters from
10712 * @param obj The entry object
10713 * @param func The function to use as text filter
10714 * @param data User data to pass to @p func
10716 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10718 * Prepend a filter function for text insdrted in the entry
10720 * Prepend the given callback to the list. See elm_entry_text_filter_append()
10721 * for more information
10723 * @param obj The entry object
10724 * @param func The function to use as text filter
10725 * @param data User data to pass to @p func
10727 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10729 * Remove a filter from the list
10731 * Removes the given callback from the filter list. See
10732 * elm_entry_text_filter_append() for more information.
10734 * @param obj The entry object
10735 * @param func The filter function to remove
10736 * @param data The user data passed when adding the function
10738 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10740 * This converts a markup (HTML-like) string into UTF-8.
10742 * The returned string is a malloc'ed buffer and it should be freed when
10743 * not needed anymore.
10745 * @param s The string (in markup) to be converted
10746 * @return The converted string (in UTF-8). It should be freed.
10748 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10750 * This converts a UTF-8 string into markup (HTML-like).
10752 * The returned string is a malloc'ed buffer and it should be freed when
10753 * not needed anymore.
10755 * @param s The string (in UTF-8) to be converted
10756 * @return The converted string (in markup). It should be freed.
10758 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10760 * This sets the file (and implicitly loads it) for the text to display and
10761 * then edit. All changes are written back to the file after a short delay if
10762 * the entry object is set to autosave (which is the default).
10764 * If the entry had any other file set previously, any changes made to it
10765 * will be saved if the autosave feature is enabled, otherwise, the file
10766 * will be silently discarded and any non-saved changes will be lost.
10768 * @param obj The entry object
10769 * @param file The path to the file to load and save
10770 * @param format The file format
10772 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10774 * Gets the file being edited by the entry.
10776 * This function can be used to retrieve any file set on the entry for
10777 * edition, along with the format used to load and save it.
10779 * @param obj The entry object
10780 * @param file The path to the file to load and save
10781 * @param format The file format
10783 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10785 * This function writes any changes made to the file set with
10786 * elm_entry_file_set()
10788 * @param obj The entry object
10790 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10792 * This sets the entry object to 'autosave' the loaded text file or not.
10794 * @param obj The entry object
10795 * @param autosave Autosave the loaded file or not
10797 * @see elm_entry_file_set()
10799 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
10801 * This gets the entry object's 'autosave' status.
10803 * @param obj The entry object
10804 * @return Autosave the loaded file or not
10806 * @see elm_entry_file_set()
10808 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10810 * Control pasting of text and images for the widget.
10812 * Normally the entry allows both text and images to be pasted. By setting
10813 * textonly to be true, this prevents images from being pasted.
10815 * Note this only changes the behaviour of text.
10817 * @param obj The entry object
10818 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
10819 * text+image+other.
10821 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
10823 * Getting elm_entry text paste/drop mode.
10825 * In textonly mode, only text may be pasted or dropped into the widget.
10827 * @param obj The entry object
10828 * @return If the widget only accepts text from pastes.
10830 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10832 * Enable or disable scrolling in entry
10834 * Normally the entry is not scrollable unless you enable it with this call.
10836 * @param obj The entry object
10837 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
10839 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
10841 * Get the scrollable state of the entry
10843 * Normally the entry is not scrollable. This gets the scrollable state
10844 * of the entry. See elm_entry_scrollable_set() for more information.
10846 * @param obj The entry object
10847 * @return The scrollable state
10849 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
10851 * This sets a widget to be displayed to the left of a scrolled entry.
10853 * @param obj The scrolled entry object
10854 * @param icon The widget to display on the left side of the scrolled
10857 * @note A previously set widget will be destroyed.
10858 * @note If the object being set does not have minimum size hints set,
10859 * it won't get properly displayed.
10861 * @see elm_entry_end_set()
10863 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
10865 * Gets the leftmost widget of the scrolled entry. This object is
10866 * owned by the scrolled entry and should not be modified.
10868 * @param obj The scrolled entry object
10869 * @return the left widget inside the scroller
10871 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
10873 * Unset the leftmost widget of the scrolled entry, unparenting and
10876 * @param obj The scrolled entry object
10877 * @return the previously set icon sub-object of this entry, on
10880 * @see elm_entry_icon_set()
10882 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
10884 * Sets the visibility of the left-side widget of the scrolled entry,
10885 * set by elm_entry_icon_set().
10887 * @param obj The scrolled entry object
10888 * @param setting EINA_TRUE if the object should be displayed,
10889 * EINA_FALSE if not.
10891 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
10893 * This sets a widget to be displayed to the end of a scrolled entry.
10895 * @param obj The scrolled entry object
10896 * @param end The widget to display on the right side of the scrolled
10899 * @note A previously set widget will be destroyed.
10900 * @note If the object being set does not have minimum size hints set,
10901 * it won't get properly displayed.
10903 * @see elm_entry_icon_set
10905 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
10907 * Gets the endmost widget of the scrolled entry. This object is owned
10908 * by the scrolled entry and should not be modified.
10910 * @param obj The scrolled entry object
10911 * @return the right widget inside the scroller
10913 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
10915 * Unset the endmost widget of the scrolled entry, unparenting and
10918 * @param obj The scrolled entry object
10919 * @return the previously set icon sub-object of this entry, on
10922 * @see elm_entry_icon_set()
10924 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
10926 * Sets the visibility of the end widget of the scrolled entry, set by
10927 * elm_entry_end_set().
10929 * @param obj The scrolled entry object
10930 * @param setting EINA_TRUE if the object should be displayed,
10931 * EINA_FALSE if not.
10933 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
10935 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
10938 * Setting an entry to single-line mode with elm_entry_single_line_set()
10939 * will automatically disable the display of scrollbars when the entry
10940 * moves inside its scroller.
10942 * @param obj The scrolled entry object
10943 * @param h The horizontal scrollbar policy to apply
10944 * @param v The vertical scrollbar policy to apply
10946 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
10948 * This enables/disables bouncing within the entry.
10950 * This function sets whether the entry will bounce when scrolling reaches
10951 * the end of the contained entry.
10953 * @param obj The scrolled entry object
10954 * @param h The horizontal bounce state
10955 * @param v The vertical bounce state
10957 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
10959 * Get the bounce mode
10961 * @param obj The Entry object
10962 * @param h_bounce Allow bounce horizontally
10963 * @param v_bounce Allow bounce vertically
10965 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
10967 /* pre-made filters for entries */
10969 * @typedef Elm_Entry_Filter_Limit_Size
10971 * Data for the elm_entry_filter_limit_size() entry filter.
10973 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
10975 * @struct _Elm_Entry_Filter_Limit_Size
10977 * Data for the elm_entry_filter_limit_size() entry filter.
10979 struct _Elm_Entry_Filter_Limit_Size
10981 int max_char_count; /**< The maximum number of characters allowed. */
10982 int max_byte_count; /**< The maximum number of bytes allowed*/
10985 * Filter inserted text based on user defined character and byte limits
10987 * Add this filter to an entry to limit the characters that it will accept
10988 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
10989 * The funtion works on the UTF-8 representation of the string, converting
10990 * it from the set markup, thus not accounting for any format in it.
10992 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
10993 * it as data when setting the filter. In it, it's possible to set limits
10994 * by character count or bytes (any of them is disabled if 0), and both can
10995 * be set at the same time. In that case, it first checks for characters,
10998 * The function will cut the inserted text in order to allow only the first
10999 * number of characters that are still allowed. The cut is made in
11000 * characters, even when limiting by bytes, in order to always contain
11001 * valid ones and avoid half unicode characters making it in.
11003 * This filter, like any others, does not apply when setting the entry text
11004 * directly with elm_object_text_set() (or the deprecated
11005 * elm_entry_entry_set()).
11007 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11009 * @typedef Elm_Entry_Filter_Accept_Set
11011 * Data for the elm_entry_filter_accept_set() entry filter.
11013 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11015 * @struct _Elm_Entry_Filter_Accept_Set
11017 * Data for the elm_entry_filter_accept_set() entry filter.
11019 struct _Elm_Entry_Filter_Accept_Set
11021 const char *accepted; /**< Set of characters accepted in the entry. */
11022 const char *rejected; /**< Set of characters rejected from the entry. */
11025 * Filter inserted text based on accepted or rejected sets of characters
11027 * Add this filter to an entry to restrict the set of accepted characters
11028 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11029 * This structure contains both accepted and rejected sets, but they are
11030 * mutually exclusive.
11032 * The @c accepted set takes preference, so if it is set, the filter will
11033 * only work based on the accepted characters, ignoring anything in the
11034 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11036 * In both cases, the function filters by matching utf8 characters to the
11037 * raw markup text, so it can be used to remove formatting tags.
11039 * This filter, like any others, does not apply when setting the entry text
11040 * directly with elm_object_text_set() (or the deprecated
11041 * elm_entry_entry_set()).
11043 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11048 /* composite widgets - these basically put together basic widgets above
11049 * in convenient packages that do more than basic stuff */
11053 * @defgroup Anchorview Anchorview
11055 * @image html img/widget/anchorview/preview-00.png
11056 * @image latex img/widget/anchorview/preview-00.eps
11058 * Anchorview is for displaying text that contains markup with anchors
11059 * like <c>\<a href=1234\>something\</\></c> in it.
11061 * Besides being styled differently, the anchorview widget provides the
11062 * necessary functionality so that clicking on these anchors brings up a
11063 * popup with user defined content such as "call", "add to contacts" or
11064 * "open web page". This popup is provided using the @ref Hover widget.
11066 * This widget is very similar to @ref Anchorblock, so refer to that
11067 * widget for an example. The only difference Anchorview has is that the
11068 * widget is already provided with scrolling functionality, so if the
11069 * text set to it is too large to fit in the given space, it will scroll,
11070 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11071 * text can be displayed.
11073 * This widget emits the following signals:
11074 * @li "anchor,clicked": will be called when an anchor is clicked. The
11075 * @p event_info parameter on the callback will be a pointer of type
11076 * ::Elm_Entry_Anchorview_Info.
11078 * See @ref Anchorblock for an example on how to use both of them.
11087 * @typedef Elm_Entry_Anchorview_Info
11089 * The info sent in the callback for "anchor,clicked" signals emitted by
11090 * the Anchorview widget.
11092 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11094 * @struct _Elm_Entry_Anchorview_Info
11096 * The info sent in the callback for "anchor,clicked" signals emitted by
11097 * the Anchorview widget.
11099 struct _Elm_Entry_Anchorview_Info
11101 const char *name; /**< Name of the anchor, as indicated in its href
11103 int button; /**< The mouse button used to click on it */
11104 Evas_Object *hover; /**< The hover object to use for the popup */
11106 Evas_Coord x, y, w, h;
11107 } anchor, /**< Geometry selection of text used as anchor */
11108 hover_parent; /**< Geometry of the object used as parent by the
11110 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11111 for content on the left side of
11112 the hover. Before calling the
11113 callback, the widget will make the
11114 necessary calculations to check
11115 which sides are fit to be set with
11116 content, based on the position the
11117 hover is activated and its distance
11118 to the edges of its parent object
11120 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11121 the right side of the hover.
11122 See @ref hover_left */
11123 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11124 of the hover. See @ref hover_left */
11125 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11126 below the hover. See @ref
11130 * Add a new Anchorview object
11132 * @param parent The parent object
11133 * @return The new object or NULL if it cannot be created
11135 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11137 * Set the text to show in the anchorview
11139 * Sets the text of the anchorview to @p text. This text can include markup
11140 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11141 * text that will be specially styled and react to click events, ended with
11142 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11143 * "anchor,clicked" signal that you can attach a callback to with
11144 * evas_object_smart_callback_add(). The name of the anchor given in the
11145 * event info struct will be the one set in the href attribute, in this
11146 * case, anchorname.
11148 * Other markup can be used to style the text in different ways, but it's
11149 * up to the style defined in the theme which tags do what.
11150 * @deprecated use elm_object_text_set() instead.
11152 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11154 * Get the markup text set for the anchorview
11156 * Retrieves the text set on the anchorview, with markup tags included.
11158 * @param obj The anchorview object
11159 * @return The markup text set or @c NULL if nothing was set or an error
11161 * @deprecated use elm_object_text_set() instead.
11163 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11165 * Set the parent of the hover popup
11167 * Sets the parent object to use by the hover created by the anchorview
11168 * when an anchor is clicked. See @ref Hover for more details on this.
11169 * If no parent is set, the same anchorview object will be used.
11171 * @param obj The anchorview object
11172 * @param parent The object to use as parent for the hover
11174 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11176 * Get the parent of the hover popup
11178 * Get the object used as parent for the hover created by the anchorview
11179 * widget. See @ref Hover for more details on this.
11181 * @param obj The anchorview object
11182 * @return The object used as parent for the hover, NULL if none is set.
11184 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11186 * Set the style that the hover should use
11188 * When creating the popup hover, anchorview will request that it's
11189 * themed according to @p style.
11191 * @param obj The anchorview object
11192 * @param style The style to use for the underlying hover
11194 * @see elm_object_style_set()
11196 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11198 * Get the style that the hover should use
11200 * Get the style the hover created by anchorview will use.
11202 * @param obj The anchorview object
11203 * @return The style to use by the hover. NULL means the default is used.
11205 * @see elm_object_style_set()
11207 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11209 * Ends the hover popup in the anchorview
11211 * When an anchor is clicked, the anchorview widget will create a hover
11212 * object to use as a popup with user provided content. This function
11213 * terminates this popup, returning the anchorview to its normal state.
11215 * @param obj The anchorview object
11217 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11219 * Set bouncing behaviour when the scrolled content reaches an edge
11221 * Tell the internal scroller object whether it should bounce or not
11222 * when it reaches the respective edges for each axis.
11224 * @param obj The anchorview object
11225 * @param h_bounce Whether to bounce or not in the horizontal axis
11226 * @param v_bounce Whether to bounce or not in the vertical axis
11228 * @see elm_scroller_bounce_set()
11230 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11232 * Get the set bouncing behaviour of the internal scroller
11234 * Get whether the internal scroller should bounce when the edge of each
11235 * axis is reached scrolling.
11237 * @param obj The anchorview object
11238 * @param h_bounce Pointer where to store the bounce state of the horizontal
11240 * @param v_bounce Pointer where to store the bounce state of the vertical
11243 * @see elm_scroller_bounce_get()
11245 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11247 * Appends a custom item provider to the given anchorview
11249 * Appends the given function to the list of items providers. This list is
11250 * called, one function at a time, with the given @p data pointer, the
11251 * anchorview object and, in the @p item parameter, the item name as
11252 * referenced in its href string. Following functions in the list will be
11253 * called in order until one of them returns something different to NULL,
11254 * which should be an Evas_Object which will be used in place of the item
11257 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11258 * href=item/name\>\</item\>
11260 * @param obj The anchorview object
11261 * @param func The function to add to the list of providers
11262 * @param data User data that will be passed to the callback function
11264 * @see elm_entry_item_provider_append()
11266 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);
11268 * Prepend a custom item provider to the given anchorview
11270 * Like elm_anchorview_item_provider_append(), but it adds the function
11271 * @p func to the beginning of the list, instead of the end.
11273 * @param obj The anchorview object
11274 * @param func The function to add to the list of providers
11275 * @param data User data that will be passed to the callback function
11277 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);
11279 * Remove a custom item provider from the list of the given anchorview
11281 * Removes the function and data pairing that matches @p func and @p data.
11282 * That is, unless the same function and same user data are given, the
11283 * function will not be removed from the list. This allows us to add the
11284 * same callback several times, with different @p data pointers and be
11285 * able to remove them later without conflicts.
11287 * @param obj The anchorview object
11288 * @param func The function to remove from the list
11289 * @param data The data matching the function to remove from the list
11291 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);
11298 * @defgroup Anchorblock Anchorblock
11300 * @image html img/widget/anchorblock/preview-00.png
11301 * @image latex img/widget/anchorblock/preview-00.eps
11303 * Anchorblock is for displaying text that contains markup with anchors
11304 * like <c>\<a href=1234\>something\</\></c> in it.
11306 * Besides being styled differently, the anchorblock widget provides the
11307 * necessary functionality so that clicking on these anchors brings up a
11308 * popup with user defined content such as "call", "add to contacts" or
11309 * "open web page". This popup is provided using the @ref Hover widget.
11311 * This widget emits the following signals:
11312 * @li "anchor,clicked": will be called when an anchor is clicked. The
11313 * @p event_info parameter on the callback will be a pointer of type
11314 * ::Elm_Entry_Anchorblock_Info.
11320 * Since examples are usually better than plain words, we might as well
11321 * try @ref tutorial_anchorblock_example "one".
11324 * @addtogroup Anchorblock
11328 * @typedef Elm_Entry_Anchorblock_Info
11330 * The info sent in the callback for "anchor,clicked" signals emitted by
11331 * the Anchorblock widget.
11333 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11335 * @struct _Elm_Entry_Anchorblock_Info
11337 * The info sent in the callback for "anchor,clicked" signals emitted by
11338 * the Anchorblock widget.
11340 struct _Elm_Entry_Anchorblock_Info
11342 const char *name; /**< Name of the anchor, as indicated in its href
11344 int button; /**< The mouse button used to click on it */
11345 Evas_Object *hover; /**< The hover object to use for the popup */
11347 Evas_Coord x, y, w, h;
11348 } anchor, /**< Geometry selection of text used as anchor */
11349 hover_parent; /**< Geometry of the object used as parent by the
11351 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11352 for content on the left side of
11353 the hover. Before calling the
11354 callback, the widget will make the
11355 necessary calculations to check
11356 which sides are fit to be set with
11357 content, based on the position the
11358 hover is activated and its distance
11359 to the edges of its parent object
11361 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11362 the right side of the hover.
11363 See @ref hover_left */
11364 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11365 of the hover. See @ref hover_left */
11366 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11367 below the hover. See @ref
11371 * Add a new Anchorblock object
11373 * @param parent The parent object
11374 * @return The new object or NULL if it cannot be created
11376 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11378 * Set the text to show in the anchorblock
11380 * Sets the text of the anchorblock to @p text. This text can include markup
11381 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11382 * of text that will be specially styled and react to click events, ended
11383 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11384 * "anchor,clicked" signal that you can attach a callback to with
11385 * evas_object_smart_callback_add(). The name of the anchor given in the
11386 * event info struct will be the one set in the href attribute, in this
11387 * case, anchorname.
11389 * Other markup can be used to style the text in different ways, but it's
11390 * up to the style defined in the theme which tags do what.
11391 * @deprecated use elm_object_text_set() instead.
11393 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11395 * Get the markup text set for the anchorblock
11397 * Retrieves the text set on the anchorblock, with markup tags included.
11399 * @param obj The anchorblock object
11400 * @return The markup text set or @c NULL if nothing was set or an error
11402 * @deprecated use elm_object_text_set() instead.
11404 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11406 * Set the parent of the hover popup
11408 * Sets the parent object to use by the hover created by the anchorblock
11409 * when an anchor is clicked. See @ref Hover for more details on this.
11411 * @param obj The anchorblock object
11412 * @param parent The object to use as parent for the hover
11414 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11416 * Get the parent of the hover popup
11418 * Get the object used as parent for the hover created by the anchorblock
11419 * widget. See @ref Hover for more details on this.
11420 * If no parent is set, the same anchorblock object will be used.
11422 * @param obj The anchorblock object
11423 * @return The object used as parent for the hover, NULL if none is set.
11425 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11427 * Set the style that the hover should use
11429 * When creating the popup hover, anchorblock will request that it's
11430 * themed according to @p style.
11432 * @param obj The anchorblock object
11433 * @param style The style to use for the underlying hover
11435 * @see elm_object_style_set()
11437 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11439 * Get the style that the hover should use
11441 * Get the style the hover created by anchorblock will use.
11443 * @param obj The anchorblock object
11444 * @return The style to use by the hover. NULL means the default is used.
11446 * @see elm_object_style_set()
11448 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11450 * Ends the hover popup in the anchorblock
11452 * When an anchor is clicked, the anchorblock widget will create a hover
11453 * object to use as a popup with user provided content. This function
11454 * terminates this popup, returning the anchorblock to its normal state.
11456 * @param obj The anchorblock object
11458 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11460 * Appends a custom item provider to the given anchorblock
11462 * Appends the given function to the list of items providers. This list is
11463 * called, one function at a time, with the given @p data pointer, the
11464 * anchorblock object and, in the @p item parameter, the item name as
11465 * referenced in its href string. Following functions in the list will be
11466 * called in order until one of them returns something different to NULL,
11467 * which should be an Evas_Object which will be used in place of the item
11470 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11471 * href=item/name\>\</item\>
11473 * @param obj The anchorblock object
11474 * @param func The function to add to the list of providers
11475 * @param data User data that will be passed to the callback function
11477 * @see elm_entry_item_provider_append()
11479 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);
11481 * Prepend a custom item provider to the given anchorblock
11483 * Like elm_anchorblock_item_provider_append(), but it adds the function
11484 * @p func to the beginning of the list, instead of the end.
11486 * @param obj The anchorblock object
11487 * @param func The function to add to the list of providers
11488 * @param data User data that will be passed to the callback function
11490 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);
11492 * Remove a custom item provider from the list of the given anchorblock
11494 * Removes the function and data pairing that matches @p func and @p data.
11495 * That is, unless the same function and same user data are given, the
11496 * function will not be removed from the list. This allows us to add the
11497 * same callback several times, with different @p data pointers and be
11498 * able to remove them later without conflicts.
11500 * @param obj The anchorblock object
11501 * @param func The function to remove from the list
11502 * @param data The data matching the function to remove from the list
11504 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);
11510 * @defgroup Bubble Bubble
11512 * @image html img/widget/bubble/preview-00.png
11513 * @image latex img/widget/bubble/preview-00.eps
11514 * @image html img/widget/bubble/preview-01.png
11515 * @image latex img/widget/bubble/preview-01.eps
11516 * @image html img/widget/bubble/preview-02.png
11517 * @image latex img/widget/bubble/preview-02.eps
11519 * @brief The Bubble is a widget to show text similarly to how speech is
11520 * represented in comics.
11522 * The bubble widget contains 5 important visual elements:
11523 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11524 * @li The @p icon is an image to which the frame's arrow points to.
11525 * @li The @p label is a text which appears to the right of the icon if the
11526 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11528 * @li The @p info is a text which appears to the right of the label. Info's
11529 * font is of a ligther color than label.
11530 * @li The @p content is an evas object that is shown inside the frame.
11532 * The position of the arrow, icon, label and info depends on which corner is
11533 * selected. The four available corners are:
11534 * @li "top_left" - Default
11536 * @li "bottom_left"
11537 * @li "bottom_right"
11539 * Signals that you can add callbacks for are:
11540 * @li "clicked" - This is called when a user has clicked the bubble.
11542 * For an example of using a buble see @ref bubble_01_example_page "this".
11547 * Add a new bubble to the parent
11549 * @param parent The parent object
11550 * @return The new object or NULL if it cannot be created
11552 * This function adds a text bubble to the given parent evas object.
11554 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11556 * Set the label of the bubble
11558 * @param obj The bubble object
11559 * @param label The string to set in the label
11561 * This function sets the title of the bubble. Where this appears depends on
11562 * the selected corner.
11563 * @deprecated use elm_object_text_set() instead.
11565 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11567 * Get the label of the bubble
11569 * @param obj The bubble object
11570 * @return The string of set in the label
11572 * This function gets the title of the bubble.
11573 * @deprecated use elm_object_text_get() instead.
11575 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11577 * Set the info of the bubble
11579 * @param obj The bubble object
11580 * @param info The given info about the bubble
11582 * This function sets the info of the bubble. Where this appears depends on
11583 * the selected corner.
11584 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11586 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11588 * Get the info of the bubble
11590 * @param obj The bubble object
11592 * @return The "info" string of the bubble
11594 * This function gets the info text.
11595 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11597 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11599 * Set the content to be shown in the bubble
11601 * Once the content object is set, a previously set one will be deleted.
11602 * If you want to keep the old content object, use the
11603 * elm_bubble_content_unset() function.
11605 * @param obj The bubble object
11606 * @param content The given content of the bubble
11608 * This function sets the content shown on the middle of the bubble.
11610 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11612 * Get the content shown in the bubble
11614 * Return the content object which is set for this widget.
11616 * @param obj The bubble object
11617 * @return The content that is being used
11619 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11621 * Unset the content shown in the bubble
11623 * Unparent and return the content object which was set for this widget.
11625 * @param obj The bubble object
11626 * @return The content that was being used
11628 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11630 * Set the icon of the bubble
11632 * Once the icon object is set, a previously set one will be deleted.
11633 * If you want to keep the old content object, use the
11634 * elm_icon_content_unset() function.
11636 * @param obj The bubble object
11637 * @param icon The given icon for the bubble
11639 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11641 * Get the icon of the bubble
11643 * @param obj The bubble object
11644 * @return The icon for the bubble
11646 * This function gets the icon shown on the top left of bubble.
11648 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11650 * Unset the icon of the bubble
11652 * Unparent and return the icon object which was set for this widget.
11654 * @param obj The bubble object
11655 * @return The icon that was being used
11657 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11659 * Set the corner of the bubble
11661 * @param obj The bubble object.
11662 * @param corner The given corner for the bubble.
11664 * This function sets the corner of the bubble. The corner will be used to
11665 * determine where the arrow in the frame points to and where label, icon and
11668 * Possible values for corner are:
11669 * @li "top_left" - Default
11671 * @li "bottom_left"
11672 * @li "bottom_right"
11674 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11676 * Get the corner of the bubble
11678 * @param obj The bubble object.
11679 * @return The given corner for the bubble.
11681 * This function gets the selected corner of the bubble.
11683 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11689 * @defgroup Photo Photo
11691 * For displaying the photo of a person (contact). Simple yet
11692 * with a very specific purpose.
11694 * Signals that you can add callbacks for are:
11696 * "clicked" - This is called when a user has clicked the photo
11697 * "drag,start" - Someone started dragging the image out of the object
11698 * "drag,end" - Dragged item was dropped (somewhere)
11704 * Add a new photo to the parent
11706 * @param parent The parent object
11707 * @return The new object or NULL if it cannot be created
11711 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11714 * Set the file that will be used as photo
11716 * @param obj The photo object
11717 * @param file The path to file that will be used as photo
11719 * @return (1 = success, 0 = error)
11723 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11726 * Set the size that will be used on the photo
11728 * @param obj The photo object
11729 * @param size The size that the photo will be
11733 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11736 * Set if the photo should be completely visible or not.
11738 * @param obj The photo object
11739 * @param fill if true the photo will be completely visible
11743 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11746 * Set editability of the photo.
11748 * An editable photo can be dragged to or from, and can be cut or
11749 * pasted too. Note that pasting an image or dropping an item on
11750 * the image will delete the existing content.
11752 * @param obj The photo object.
11753 * @param set To set of clear editablity.
11755 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11761 /* gesture layer */
11763 * @defgroup Elm_Gesture_Layer Gesture Layer
11764 * Gesture Layer Usage:
11766 * Use Gesture Layer to detect gestures.
11767 * The advantage is that you don't have to implement
11768 * gesture detection, just set callbacks of gesture state.
11769 * By using gesture layer we make standard interface.
11771 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11772 * with a parent object parameter.
11773 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11774 * call. Usually with same object as target (2nd parameter).
11776 * Now you need to tell gesture layer what gestures you follow.
11777 * This is done with @ref elm_gesture_layer_cb_set call.
11778 * By setting the callback you actually saying to gesture layer:
11779 * I would like to know when the gesture @ref Elm_Gesture_Types
11780 * switches to state @ref Elm_Gesture_State.
11782 * Next, you need to implement the actual action that follows the input
11783 * in your callback.
11785 * Note that if you like to stop being reported about a gesture, just set
11786 * all callbacks referring this gesture to NULL.
11787 * (again with @ref elm_gesture_layer_cb_set)
11789 * The information reported by gesture layer to your callback is depending
11790 * on @ref Elm_Gesture_Types:
11791 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
11792 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
11793 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
11795 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
11796 * @ref ELM_GESTURE_MOMENTUM.
11798 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
11799 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
11800 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
11801 * Note that we consider a flick as a line-gesture that should be completed
11802 * in flick-time-limit as defined in @ref Config.
11804 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
11806 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
11810 * @enum _Elm_Gesture_Types
11811 * Enum of supported gesture types.
11812 * @ingroup Elm_Gesture_Layer
11814 enum _Elm_Gesture_Types
11816 ELM_GESTURE_FIRST = 0,
11818 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
11819 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
11820 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
11821 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
11823 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
11825 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
11826 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
11828 ELM_GESTURE_ZOOM, /**< Zoom */
11829 ELM_GESTURE_ROTATE, /**< Rotate */
11835 * @typedef Elm_Gesture_Types
11836 * gesture types enum
11837 * @ingroup Elm_Gesture_Layer
11839 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
11842 * @enum _Elm_Gesture_State
11843 * Enum of gesture states.
11844 * @ingroup Elm_Gesture_Layer
11846 enum _Elm_Gesture_State
11848 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
11849 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
11850 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
11851 ELM_GESTURE_STATE_END, /**< Gesture completed */
11852 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
11856 * @typedef Elm_Gesture_State
11857 * gesture states enum
11858 * @ingroup Elm_Gesture_Layer
11860 typedef enum _Elm_Gesture_State Elm_Gesture_State;
11863 * @struct _Elm_Gesture_Taps_Info
11864 * Struct holds taps info for user
11865 * @ingroup Elm_Gesture_Layer
11867 struct _Elm_Gesture_Taps_Info
11869 Evas_Coord x, y; /**< Holds center point between fingers */
11870 unsigned int n; /**< Number of fingers tapped */
11871 unsigned int timestamp; /**< event timestamp */
11875 * @typedef Elm_Gesture_Taps_Info
11876 * holds taps info for user
11877 * @ingroup Elm_Gesture_Layer
11879 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
11882 * @struct _Elm_Gesture_Momentum_Info
11883 * Struct holds momentum info for user
11884 * x1 and y1 are not necessarily in sync
11885 * x1 holds x value of x direction starting point
11886 * and same holds for y1.
11887 * This is noticeable when doing V-shape movement
11888 * @ingroup Elm_Gesture_Layer
11890 struct _Elm_Gesture_Momentum_Info
11891 { /* Report line ends, timestamps, and momentum computed */
11892 Evas_Coord x1; /**< Final-swipe direction starting point on X */
11893 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
11894 Evas_Coord x2; /**< Final-swipe direction ending point on X */
11895 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
11897 unsigned int tx; /**< Timestamp of start of final x-swipe */
11898 unsigned int ty; /**< Timestamp of start of final y-swipe */
11900 Evas_Coord mx; /**< Momentum on X */
11901 Evas_Coord my; /**< Momentum on Y */
11905 * @typedef Elm_Gesture_Momentum_Info
11906 * holds momentum info for user
11907 * @ingroup Elm_Gesture_Layer
11909 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
11912 * @struct _Elm_Gesture_Line_Info
11913 * Struct holds line info for user
11914 * @ingroup Elm_Gesture_Layer
11916 struct _Elm_Gesture_Line_Info
11917 { /* Report line ends, timestamps, and momentum computed */
11918 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
11919 unsigned int n; /**< Number of fingers (lines) */
11920 /* FIXME should be radians, bot degrees */
11921 double angle; /**< Angle (direction) of lines */
11925 * @typedef Elm_Gesture_Line_Info
11926 * Holds line info for user
11927 * @ingroup Elm_Gesture_Layer
11929 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
11932 * @struct _Elm_Gesture_Zoom_Info
11933 * Struct holds zoom info for user
11934 * @ingroup Elm_Gesture_Layer
11936 struct _Elm_Gesture_Zoom_Info
11938 Evas_Coord x, y; /**< Holds zoom center point reported to user */
11939 Evas_Coord radius; /**< Holds radius between fingers reported to user */
11940 double zoom; /**< Zoom value: 1.0 means no zoom */
11941 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
11945 * @typedef Elm_Gesture_Zoom_Info
11946 * Holds zoom info for user
11947 * @ingroup Elm_Gesture_Layer
11949 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
11952 * @struct _Elm_Gesture_Rotate_Info
11953 * Struct holds rotation info for user
11954 * @ingroup Elm_Gesture_Layer
11956 struct _Elm_Gesture_Rotate_Info
11958 Evas_Coord x, y; /**< Holds zoom center point reported to user */
11959 Evas_Coord radius; /**< Holds radius between fingers reported to user */
11960 double base_angle; /**< Holds start-angle */
11961 double angle; /**< Rotation value: 0.0 means no rotation */
11962 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
11966 * @typedef Elm_Gesture_Rotate_Info
11967 * Holds rotation info for user
11968 * @ingroup Elm_Gesture_Layer
11970 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
11973 * @typedef Elm_Gesture_Event_Cb
11974 * User callback used to stream gesture info from gesture layer
11975 * @param data user data
11976 * @param event_info gesture report info
11977 * Returns a flag field to be applied on the causing event.
11978 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
11979 * upon the event, in an irreversible way.
11981 * @ingroup Elm_Gesture_Layer
11983 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
11986 * Use function to set callbacks to be notified about
11987 * change of state of gesture.
11988 * When a user registers a callback with this function
11989 * this means this gesture has to be tested.
11991 * When ALL callbacks for a gesture are set to NULL
11992 * it means user isn't interested in gesture-state
11993 * and it will not be tested.
11995 * @param obj Pointer to gesture-layer.
11996 * @param idx The gesture you would like to track its state.
11997 * @param cb callback function pointer.
11998 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
11999 * @param data user info to be sent to callback (usually, Smart Data)
12001 * @ingroup Elm_Gesture_Layer
12003 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);
12006 * Call this function to get repeat-events settings.
12008 * @param obj Pointer to gesture-layer.
12010 * @return repeat events settings.
12011 * @see elm_gesture_layer_hold_events_set()
12012 * @ingroup Elm_Gesture_Layer
12014 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12017 * This function called in order to make gesture-layer repeat events.
12018 * Set this of you like to get the raw events only if gestures were not detected.
12019 * Clear this if you like gesture layer to fwd events as testing gestures.
12021 * @param obj Pointer to gesture-layer.
12022 * @param r Repeat: TRUE/FALSE
12024 * @ingroup Elm_Gesture_Layer
12026 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12029 * This function sets step-value for zoom action.
12030 * Set step to any positive value.
12031 * Cancel step setting by setting to 0.0
12033 * @param obj Pointer to gesture-layer.
12034 * @param s new zoom step value.
12036 * @ingroup Elm_Gesture_Layer
12038 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12041 * This function sets step-value for rotate action.
12042 * Set step to any positive value.
12043 * Cancel step setting by setting to 0.0
12045 * @param obj Pointer to gesture-layer.
12046 * @param s new roatate step value.
12048 * @ingroup Elm_Gesture_Layer
12050 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12053 * This function called to attach gesture-layer to an Evas_Object.
12054 * @param obj Pointer to gesture-layer.
12055 * @param t Pointer to underlying object (AKA Target)
12057 * @return TRUE, FALSE on success, failure.
12059 * @ingroup Elm_Gesture_Layer
12061 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12064 * Call this function to construct a new gesture-layer object.
12065 * This does not activate the gesture layer. You have to
12066 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12068 * @param parent the parent object.
12070 * @return Pointer to new gesture-layer object.
12072 * @ingroup Elm_Gesture_Layer
12074 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12077 * @defgroup Thumb Thumb
12079 * @image html img/widget/thumb/preview-00.png
12080 * @image latex img/widget/thumb/preview-00.eps
12082 * A thumb object is used for displaying the thumbnail of an image or video.
12083 * You must have compiled Elementary with Ethumb_Client support and the DBus
12084 * service must be present and auto-activated in order to have thumbnails to
12087 * Once the thumbnail object becomes visible, it will check if there is a
12088 * previously generated thumbnail image for the file set on it. If not, it
12089 * will start generating this thumbnail.
12091 * Different config settings will cause different thumbnails to be generated
12092 * even on the same file.
12094 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12095 * Ethumb documentation to change this path, and to see other configuration
12098 * Signals that you can add callbacks for are:
12100 * - "clicked" - This is called when a user has clicked the thumb without dragging
12102 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12103 * - "press" - This is called when a user has pressed down the thumb.
12104 * - "generate,start" - The thumbnail generation started.
12105 * - "generate,stop" - The generation process stopped.
12106 * - "generate,error" - The generation failed.
12107 * - "load,error" - The thumbnail image loading failed.
12109 * available styles:
12113 * An example of use of thumbnail:
12115 * - @ref thumb_example_01
12119 * @addtogroup Thumb
12124 * @enum _Elm_Thumb_Animation_Setting
12125 * @typedef Elm_Thumb_Animation_Setting
12127 * Used to set if a video thumbnail is animating or not.
12131 typedef enum _Elm_Thumb_Animation_Setting
12133 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12134 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12135 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12136 ELM_THUMB_ANIMATION_LAST
12137 } Elm_Thumb_Animation_Setting;
12140 * Add a new thumb object to the parent.
12142 * @param parent The parent object.
12143 * @return The new object or NULL if it cannot be created.
12145 * @see elm_thumb_file_set()
12146 * @see elm_thumb_ethumb_client_get()
12150 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12152 * Reload thumbnail if it was generated before.
12154 * @param obj The thumb object to reload
12156 * This is useful if the ethumb client configuration changed, like its
12157 * size, aspect or any other property one set in the handle returned
12158 * by elm_thumb_ethumb_client_get().
12160 * If the options didn't change, the thumbnail won't be generated again, but
12161 * the old one will still be used.
12163 * @see elm_thumb_file_set()
12167 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12169 * Set the file that will be used as thumbnail.
12171 * @param obj The thumb object.
12172 * @param file The path to file that will be used as thumb.
12173 * @param key The key used in case of an EET file.
12175 * The file can be an image or a video (in that case, acceptable extensions are:
12176 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12177 * function elm_thumb_animate().
12179 * @see elm_thumb_file_get()
12180 * @see elm_thumb_reload()
12181 * @see elm_thumb_animate()
12185 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12187 * Get the image or video path and key used to generate the thumbnail.
12189 * @param obj The thumb object.
12190 * @param file Pointer to filename.
12191 * @param key Pointer to key.
12193 * @see elm_thumb_file_set()
12194 * @see elm_thumb_path_get()
12198 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12200 * Get the path and key to the image or video generated by ethumb.
12202 * One just need to make sure that the thumbnail was generated before getting
12203 * its path; otherwise, the path will be NULL. One way to do that is by asking
12204 * for the path when/after the "generate,stop" smart callback is called.
12206 * @param obj The thumb object.
12207 * @param file Pointer to thumb path.
12208 * @param key Pointer to thumb key.
12210 * @see elm_thumb_file_get()
12214 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12216 * Set the animation state for the thumb object. If its content is an animated
12217 * video, you may start/stop the animation or tell it to play continuously and
12220 * @param obj The thumb object.
12221 * @param setting The animation setting.
12223 * @see elm_thumb_file_set()
12227 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12229 * Get the animation state for the thumb object.
12231 * @param obj The thumb object.
12232 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12235 * @see elm_thumb_animate_set()
12239 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12241 * Get the ethumb_client handle so custom configuration can be made.
12243 * @return Ethumb_Client instance or NULL.
12245 * This must be called before the objects are created to be sure no object is
12246 * visible and no generation started.
12248 * Example of usage:
12251 * #include <Elementary.h>
12252 * #ifndef ELM_LIB_QUICKLAUNCH
12254 * elm_main(int argc, char **argv)
12256 * Ethumb_Client *client;
12258 * elm_need_ethumb();
12262 * client = elm_thumb_ethumb_client_get();
12265 * ERR("could not get ethumb_client");
12268 * ethumb_client_size_set(client, 100, 100);
12269 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12272 * // Create elm_thumb objects here
12282 * @note There's only one client handle for Ethumb, so once a configuration
12283 * change is done to it, any other request for thumbnails (for any thumbnail
12284 * object) will use that configuration. Thus, this configuration is global.
12288 EAPI void *elm_thumb_ethumb_client_get(void);
12290 * Get the ethumb_client connection state.
12292 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12295 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12297 * Make the thumbnail 'editable'.
12299 * @param obj Thumb object.
12300 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12302 * This means the thumbnail is a valid drag target for drag and drop, and can be
12303 * cut or pasted too.
12305 * @see elm_thumb_editable_get()
12309 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12311 * Make the thumbnail 'editable'.
12313 * @param obj Thumb object.
12314 * @return Editability.
12316 * This means the thumbnail is a valid drag target for drag and drop, and can be
12317 * cut or pasted too.
12319 * @see elm_thumb_editable_set()
12323 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12330 * @defgroup Hoversel Hoversel
12332 * @image html img/widget/hoversel/preview-00.png
12333 * @image latex img/widget/hoversel/preview-00.eps
12335 * A hoversel is a button that pops up a list of items (automatically
12336 * choosing the direction to display) that have a label and, optionally, an
12337 * icon to select from. It is a convenience widget to avoid the need to do
12338 * all the piecing together yourself. It is intended for a small number of
12339 * items in the hoversel menu (no more than 8), though is capable of many
12342 * Signals that you can add callbacks for are:
12343 * "clicked" - the user clicked the hoversel button and popped up the sel
12344 * "selected" - an item in the hoversel list is selected. event_info is the item
12345 * "dismissed" - the hover is dismissed
12347 * See @ref tutorial_hoversel for an example.
12350 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12352 * @brief Add a new Hoversel object
12354 * @param parent The parent object
12355 * @return The new object or NULL if it cannot be created
12357 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12359 * @brief This sets the hoversel to expand horizontally.
12361 * @param obj The hoversel object
12362 * @param horizontal If true, the hover will expand horizontally to the
12365 * @note The initial button will display horizontally regardless of this
12368 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12370 * @brief This returns whether the hoversel is set to expand horizontally.
12372 * @param obj The hoversel object
12373 * @return If true, the hover will expand horizontally to the right.
12375 * @see elm_hoversel_horizontal_set()
12377 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12379 * @brief Set the Hover parent
12381 * @param obj The hoversel object
12382 * @param parent The parent to use
12384 * Sets the hover parent object, the area that will be darkened when the
12385 * hoversel is clicked. Should probably be the window that the hoversel is
12386 * in. See @ref Hover objects for more information.
12388 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12390 * @brief Get the Hover parent
12392 * @param obj The hoversel object
12393 * @return The used parent
12395 * Gets the hover parent object.
12397 * @see elm_hoversel_hover_parent_set()
12399 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12401 * @brief Set the hoversel button label
12403 * @param obj The hoversel object
12404 * @param label The label text.
12406 * This sets the label of the button that is always visible (before it is
12407 * clicked and expanded).
12409 * @deprecated elm_object_text_set()
12411 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12413 * @brief Get the hoversel button label
12415 * @param obj The hoversel object
12416 * @return The label text.
12418 * @deprecated elm_object_text_get()
12420 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12422 * @brief Set the icon of the hoversel button
12424 * @param obj The hoversel object
12425 * @param icon The icon object
12427 * Sets the icon of the button that is always visible (before it is clicked
12428 * and expanded). Once the icon object is set, a previously set one will be
12429 * deleted, if you want to keep that old content object, use the
12430 * elm_hoversel_icon_unset() function.
12432 * @see elm_button_icon_set()
12434 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12436 * @brief Get the icon of the hoversel button
12438 * @param obj The hoversel object
12439 * @return The icon object
12441 * Get the icon of the button that is always visible (before it is clicked
12442 * and expanded). Also see elm_button_icon_get().
12444 * @see elm_hoversel_icon_set()
12446 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12448 * @brief Get and unparent the icon of the hoversel button
12450 * @param obj The hoversel object
12451 * @return The icon object that was being used
12453 * Unparent and return the icon of the button that is always visible
12454 * (before it is clicked and expanded).
12456 * @see elm_hoversel_icon_set()
12457 * @see elm_button_icon_unset()
12459 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12461 * @brief This triggers the hoversel popup from code, the same as if the user
12462 * had clicked the button.
12464 * @param obj The hoversel object
12466 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12468 * @brief This dismisses the hoversel popup as if the user had clicked
12469 * outside the hover.
12471 * @param obj The hoversel object
12473 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12475 * @brief Returns whether the hoversel is expanded.
12477 * @param obj The hoversel object
12478 * @return This will return EINA_TRUE if the hoversel is expanded or
12479 * EINA_FALSE if it is not expanded.
12481 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12483 * @brief This will remove all the children items from the hoversel.
12485 * @param obj The hoversel object
12487 * @warning Should @b not be called while the hoversel is active; use
12488 * elm_hoversel_expanded_get() to check first.
12490 * @see elm_hoversel_item_del_cb_set()
12491 * @see elm_hoversel_item_del()
12493 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12495 * @brief Get the list of items within the given hoversel.
12497 * @param obj The hoversel object
12498 * @return Returns a list of Elm_Hoversel_Item*
12500 * @see elm_hoversel_item_add()
12502 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12504 * @brief Add an item to the hoversel button
12506 * @param obj The hoversel object
12507 * @param label The text label to use for the item (NULL if not desired)
12508 * @param icon_file An image file path on disk to use for the icon or standard
12509 * icon name (NULL if not desired)
12510 * @param icon_type The icon type if relevant
12511 * @param func Convenience function to call when this item is selected
12512 * @param data Data to pass to item-related functions
12513 * @return A handle to the item added.
12515 * This adds an item to the hoversel to show when it is clicked. Note: if you
12516 * need to use an icon from an edje file then use
12517 * elm_hoversel_item_icon_set() right after the this function, and set
12518 * icon_file to NULL here.
12520 * For more information on what @p icon_file and @p icon_type are see the
12521 * @ref Icon "icon documentation".
12523 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);
12525 * @brief Delete an item from the hoversel
12527 * @param item The item to delete
12529 * This deletes the item from the hoversel (should not be called while the
12530 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12532 * @see elm_hoversel_item_add()
12533 * @see elm_hoversel_item_del_cb_set()
12535 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12537 * @brief Set the function to be called when an item from the hoversel is
12540 * @param item The item to set the callback on
12541 * @param func The function called
12543 * That function will receive these parameters:
12544 * @li void *item_data
12545 * @li Evas_Object *the_item_object
12546 * @li Elm_Hoversel_Item *the_object_struct
12548 * @see elm_hoversel_item_add()
12550 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12552 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12553 * that will be passed to associated function callbacks.
12555 * @param item The item to get the data from
12556 * @return The data pointer set with elm_hoversel_item_add()
12558 * @see elm_hoversel_item_add()
12560 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12562 * @brief This returns the label text of the given hoversel item.
12564 * @param item The item to get the label
12565 * @return The label text of the hoversel item
12567 * @see elm_hoversel_item_add()
12569 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12571 * @brief This sets the icon for the given hoversel item.
12573 * @param item The item to set the icon
12574 * @param icon_file An image file path on disk to use for the icon or standard
12576 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12577 * to NULL if the icon is not an edje file
12578 * @param icon_type The icon type
12580 * The icon can be loaded from the standard set, from an image file, or from
12583 * @see elm_hoversel_item_add()
12585 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);
12587 * @brief Get the icon object of the hoversel item
12589 * @param item The item to get the icon from
12590 * @param icon_file The image file path on disk used for the icon or standard
12592 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12593 * if the icon is not an edje file
12594 * @param icon_type The icon type
12596 * @see elm_hoversel_item_icon_set()
12597 * @see elm_hoversel_item_add()
12599 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);
12605 * @defgroup Toolbar Toolbar
12606 * @ingroup Elementary
12608 * @image html img/widget/toolbar/preview-00.png
12609 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12611 * @image html img/toolbar.png
12612 * @image latex img/toolbar.eps width=\textwidth
12614 * A toolbar is a widget that displays a list of items inside
12615 * a box. It can be scrollable, show a menu with items that don't fit
12616 * to toolbar size or even crop them.
12618 * Only one item can be selected at a time.
12620 * Items can have multiple states, or show menus when selected by the user.
12622 * Smart callbacks one can listen to:
12623 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12625 * Available styles for it:
12627 * - @c "transparent" - no background or shadow, just show the content
12629 * List of examples:
12630 * @li @ref toolbar_example_01
12631 * @li @ref toolbar_example_02
12632 * @li @ref toolbar_example_03
12636 * @addtogroup Toolbar
12641 * @enum _Elm_Toolbar_Shrink_Mode
12642 * @typedef Elm_Toolbar_Shrink_Mode
12644 * Set toolbar's items display behavior, it can be scrollabel,
12645 * show a menu with exceeding items, or simply hide them.
12647 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12650 * Values <b> don't </b> work as bitmask, only one can be choosen.
12652 * @see elm_toolbar_mode_shrink_set()
12653 * @see elm_toolbar_mode_shrink_get()
12657 typedef enum _Elm_Toolbar_Shrink_Mode
12659 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12660 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12661 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12662 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12663 } Elm_Toolbar_Shrink_Mode;
12665 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(). */
12667 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(). */
12670 * Add a new toolbar widget to the given parent Elementary
12671 * (container) object.
12673 * @param parent The parent object.
12674 * @return a new toolbar widget handle or @c NULL, on errors.
12676 * This function inserts a new toolbar widget on the canvas.
12680 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12683 * Set the icon size, in pixels, to be used by toolbar items.
12685 * @param obj The toolbar object
12686 * @param icon_size The icon size in pixels
12688 * @note Default value is @c 32. It reads value from elm config.
12690 * @see elm_toolbar_icon_size_get()
12694 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12697 * Get the icon size, in pixels, to be used by toolbar items.
12699 * @param obj The toolbar object.
12700 * @return The icon size in pixels.
12702 * @see elm_toolbar_icon_size_set() for details.
12706 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12709 * Sets icon lookup order, for toolbar items' icons.
12711 * @param obj The toolbar object.
12712 * @param order The icon lookup order.
12714 * Icons added before calling this function will not be affected.
12715 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12717 * @see elm_toolbar_icon_order_lookup_get()
12721 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12724 * Gets the icon lookup order.
12726 * @param obj The toolbar object.
12727 * @return The icon lookup order.
12729 * @see elm_toolbar_icon_order_lookup_set() for details.
12733 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12736 * Set whether the toolbar items' should be selected by the user or not.
12738 * @param obj The toolbar object.
12739 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12742 * This will turn off the ability to select items entirely and they will
12743 * neither appear selected nor emit selected signals. The clicked
12744 * callback function will still be called.
12746 * Selection is enabled by default.
12748 * @see elm_toolbar_no_select_mode_get().
12752 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12755 * Set whether the toolbar items' should be selected by the user or not.
12757 * @param obj The toolbar object.
12758 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12759 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12761 * @see elm_toolbar_no_select_mode_set() for details.
12765 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12768 * Append item to the toolbar.
12770 * @param obj The toolbar object.
12771 * @param icon A string with icon name or the absolute path of an image file.
12772 * @param label The label of the item.
12773 * @param func The function to call when the item is clicked.
12774 * @param data The data to associate with the item for related callbacks.
12775 * @return The created item or @c NULL upon failure.
12777 * A new item will be created and appended to the toolbar, i.e., will
12778 * be set as @b last item.
12780 * Items created with this method can be deleted with
12781 * elm_toolbar_item_del().
12783 * Associated @p data can be properly freed when item is deleted if a
12784 * callback function is set with elm_toolbar_item_del_cb_set().
12786 * If a function is passed as argument, it will be called everytime this item
12787 * is selected, i.e., the user clicks over an unselected item.
12788 * If such function isn't needed, just passing
12789 * @c NULL as @p func is enough. The same should be done for @p data.
12791 * Toolbar will load icon image from fdo or current theme.
12792 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12793 * If an absolute path is provided it will load it direct from a file.
12795 * @see elm_toolbar_item_icon_set()
12796 * @see elm_toolbar_item_del()
12797 * @see elm_toolbar_item_del_cb_set()
12801 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);
12804 * Prepend item to the toolbar.
12806 * @param obj The toolbar object.
12807 * @param icon A string with icon name or the absolute path of an image file.
12808 * @param label The label of the item.
12809 * @param func The function to call when the item is clicked.
12810 * @param data The data to associate with the item for related callbacks.
12811 * @return The created item or @c NULL upon failure.
12813 * A new item will be created and prepended to the toolbar, i.e., will
12814 * be set as @b first item.
12816 * Items created with this method can be deleted with
12817 * elm_toolbar_item_del().
12819 * Associated @p data can be properly freed when item is deleted if a
12820 * callback function is set with elm_toolbar_item_del_cb_set().
12822 * If a function is passed as argument, it will be called everytime this item
12823 * is selected, i.e., the user clicks over an unselected item.
12824 * If such function isn't needed, just passing
12825 * @c NULL as @p func is enough. The same should be done for @p data.
12827 * Toolbar will load icon image from fdo or current theme.
12828 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12829 * If an absolute path is provided it will load it direct from a file.
12831 * @see elm_toolbar_item_icon_set()
12832 * @see elm_toolbar_item_del()
12833 * @see elm_toolbar_item_del_cb_set()
12837 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);
12840 * Insert a new item into the toolbar object before item @p before.
12842 * @param obj The toolbar object.
12843 * @param before The toolbar item to insert before.
12844 * @param icon A string with icon name or the absolute path of an image file.
12845 * @param label The label of the item.
12846 * @param func The function to call when the item is clicked.
12847 * @param data The data to associate with the item for related callbacks.
12848 * @return The created item or @c NULL upon failure.
12850 * A new item will be created and added to the toolbar. Its position in
12851 * this toolbar will be just before item @p before.
12853 * Items created with this method can be deleted with
12854 * elm_toolbar_item_del().
12856 * Associated @p data can be properly freed when item is deleted if a
12857 * callback function is set with elm_toolbar_item_del_cb_set().
12859 * If a function is passed as argument, it will be called everytime this item
12860 * is selected, i.e., the user clicks over an unselected item.
12861 * If such function isn't needed, just passing
12862 * @c NULL as @p func is enough. The same should be done for @p data.
12864 * Toolbar will load icon image from fdo or current theme.
12865 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12866 * If an absolute path is provided it will load it direct from a file.
12868 * @see elm_toolbar_item_icon_set()
12869 * @see elm_toolbar_item_del()
12870 * @see elm_toolbar_item_del_cb_set()
12874 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);
12877 * Insert a new item into the toolbar object after item @p after.
12879 * @param obj The toolbar object.
12880 * @param before The toolbar item to insert before.
12881 * @param icon A string with icon name or the absolute path of an image file.
12882 * @param label The label of the item.
12883 * @param func The function to call when the item is clicked.
12884 * @param data The data to associate with the item for related callbacks.
12885 * @return The created item or @c NULL upon failure.
12887 * A new item will be created and added to the toolbar. Its position in
12888 * this toolbar will be just after item @p after.
12890 * Items created with this method can be deleted with
12891 * elm_toolbar_item_del().
12893 * Associated @p data can be properly freed when item is deleted if a
12894 * callback function is set with elm_toolbar_item_del_cb_set().
12896 * If a function is passed as argument, it will be called everytime this item
12897 * is selected, i.e., the user clicks over an unselected item.
12898 * If such function isn't needed, just passing
12899 * @c NULL as @p func is enough. The same should be done for @p data.
12901 * Toolbar will load icon image from fdo or current theme.
12902 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12903 * If an absolute path is provided it will load it direct from a file.
12905 * @see elm_toolbar_item_icon_set()
12906 * @see elm_toolbar_item_del()
12907 * @see elm_toolbar_item_del_cb_set()
12911 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);
12914 * Get the first item in the given toolbar widget's list of
12917 * @param obj The toolbar object
12918 * @return The first item or @c NULL, if it has no items (and on
12921 * @see elm_toolbar_item_append()
12922 * @see elm_toolbar_last_item_get()
12926 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12929 * Get the last item in the given toolbar widget's list of
12932 * @param obj The toolbar object
12933 * @return The last item or @c NULL, if it has no items (and on
12936 * @see elm_toolbar_item_prepend()
12937 * @see elm_toolbar_first_item_get()
12941 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12944 * Get the item after @p item in toolbar.
12946 * @param item The toolbar item.
12947 * @return The item after @p item, or @c NULL if none or on failure.
12949 * @note If it is the last item, @c NULL will be returned.
12951 * @see elm_toolbar_item_append()
12955 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12958 * Get the item before @p item in toolbar.
12960 * @param item The toolbar item.
12961 * @return The item before @p item, or @c NULL if none or on failure.
12963 * @note If it is the first item, @c NULL will be returned.
12965 * @see elm_toolbar_item_prepend()
12969 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12972 * Get the toolbar object from an item.
12974 * @param item The item.
12975 * @return The toolbar object.
12977 * This returns the toolbar object itself that an item belongs to.
12981 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12984 * Set the priority of a toolbar item.
12986 * @param item The toolbar item.
12987 * @param priority The item priority. The default is zero.
12989 * This is used only when the toolbar shrink mode is set to
12990 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
12991 * When space is less than required, items with low priority
12992 * will be removed from the toolbar and added to a dynamically-created menu,
12993 * while items with higher priority will remain on the toolbar,
12994 * with the same order they were added.
12996 * @see elm_toolbar_item_priority_get()
13000 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13003 * Get the priority of a toolbar item.
13005 * @param item The toolbar item.
13006 * @return The @p item priority, or @c 0 on failure.
13008 * @see elm_toolbar_item_priority_set() for details.
13012 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13015 * Get the label of item.
13017 * @param item The item of toolbar.
13018 * @return The label of item.
13020 * The return value is a pointer to the label associated to @p item when
13021 * it was created, with function elm_toolbar_item_append() or similar,
13023 * with function elm_toolbar_item_label_set. If no label
13024 * was passed as argument, it will return @c NULL.
13026 * @see elm_toolbar_item_label_set() for more details.
13027 * @see elm_toolbar_item_append()
13031 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13034 * Set the label of item.
13036 * @param item The item of toolbar.
13037 * @param text The label of item.
13039 * The label to be displayed by the item.
13040 * Label will be placed at icons bottom (if set).
13042 * If a label was passed as argument on item creation, with function
13043 * elm_toolbar_item_append() or similar, it will be already
13044 * displayed by the item.
13046 * @see elm_toolbar_item_label_get()
13047 * @see elm_toolbar_item_append()
13051 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13054 * Return the data associated with a given toolbar widget item.
13056 * @param item The toolbar widget item handle.
13057 * @return The data associated with @p item.
13059 * @see elm_toolbar_item_data_set()
13063 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13066 * Set the data associated with a given toolbar widget item.
13068 * @param item The toolbar widget item handle.
13069 * @param data The new data pointer to set to @p item.
13071 * This sets new item data on @p item.
13073 * @warning The old data pointer won't be touched by this function, so
13074 * the user had better to free that old data himself/herself.
13078 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13081 * Returns a pointer to a toolbar item by its label.
13083 * @param obj The toolbar object.
13084 * @param label The label of the item to find.
13086 * @return The pointer to the toolbar item matching @p label or @c NULL
13091 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13094 * Get whether the @p item is selected or not.
13096 * @param item The toolbar item.
13097 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13098 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13100 * @see elm_toolbar_selected_item_set() for details.
13101 * @see elm_toolbar_item_selected_get()
13105 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13108 * Set the selected state of an item.
13110 * @param item The toolbar item
13111 * @param selected The selected state
13113 * This sets the selected state of the given item @p it.
13114 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13116 * If a new item is selected the previosly selected will be unselected.
13117 * Previoulsy selected item can be get with function
13118 * elm_toolbar_selected_item_get().
13120 * Selected items will be highlighted.
13122 * @see elm_toolbar_item_selected_get()
13123 * @see elm_toolbar_selected_item_get()
13127 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13130 * Get the selected item.
13132 * @param obj The toolbar object.
13133 * @return The selected toolbar item.
13135 * The selected item can be unselected with function
13136 * elm_toolbar_item_selected_set().
13138 * The selected item always will be highlighted on toolbar.
13140 * @see elm_toolbar_selected_items_get()
13144 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13147 * Set the icon associated with @p item.
13149 * @param obj The parent of this item.
13150 * @param item The toolbar item.
13151 * @param icon A string with icon name or the absolute path of an image file.
13153 * Toolbar will load icon image from fdo or current theme.
13154 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13155 * If an absolute path is provided it will load it direct from a file.
13157 * @see elm_toolbar_icon_order_lookup_set()
13158 * @see elm_toolbar_icon_order_lookup_get()
13162 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13165 * Get the string used to set the icon of @p item.
13167 * @param item The toolbar item.
13168 * @return The string associated with the icon object.
13170 * @see elm_toolbar_item_icon_set() for details.
13174 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13177 * Delete them item from the toolbar.
13179 * @param item The item of toolbar to be deleted.
13181 * @see elm_toolbar_item_append()
13182 * @see elm_toolbar_item_del_cb_set()
13186 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13189 * Set the function called when a toolbar item is freed.
13191 * @param item The item to set the callback on.
13192 * @param func The function called.
13194 * If there is a @p func, then it will be called prior item's memory release.
13195 * That will be called with the following arguments:
13197 * @li item's Evas object;
13200 * This way, a data associated to a toolbar item could be properly freed.
13204 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13207 * Get a value whether toolbar item is disabled or not.
13209 * @param item The item.
13210 * @return The disabled state.
13212 * @see elm_toolbar_item_disabled_set() for more details.
13216 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13219 * Sets the disabled/enabled state of a toolbar item.
13221 * @param item The item.
13222 * @param disabled The disabled state.
13224 * A disabled item cannot be selected or unselected. It will also
13225 * change its appearance (generally greyed out). This sets the
13226 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13231 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13234 * Set or unset item as a separator.
13236 * @param item The toolbar item.
13237 * @param setting @c EINA_TRUE to set item @p item as separator or
13238 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13240 * Items aren't set as separator by default.
13242 * If set as separator it will display separator theme, so won't display
13245 * @see elm_toolbar_item_separator_get()
13249 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13252 * Get a value whether item is a separator or not.
13254 * @param item The toolbar item.
13255 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13256 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13258 * @see elm_toolbar_item_separator_set() for details.
13262 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13265 * Set the shrink state of toolbar @p obj.
13267 * @param obj The toolbar object.
13268 * @param shrink_mode Toolbar's items display behavior.
13270 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13271 * but will enforce a minimun size so all the items will fit, won't scroll
13272 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13273 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13274 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13278 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13281 * Get the shrink mode of toolbar @p obj.
13283 * @param obj The toolbar object.
13284 * @return Toolbar's items display behavior.
13286 * @see elm_toolbar_mode_shrink_set() for details.
13290 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13293 * Enable/disable homogenous mode.
13295 * @param obj The toolbar object
13296 * @param homogeneous Assume the items within the toolbar are of the
13297 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13299 * This will enable the homogeneous mode where items are of the same size.
13300 * @see elm_toolbar_homogeneous_get()
13304 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13307 * Get whether the homogenous mode is enabled.
13309 * @param obj The toolbar object.
13310 * @return Assume the items within the toolbar are of the same height
13311 * and width (EINA_TRUE = on, EINA_FALSE = off).
13313 * @see elm_toolbar_homogeneous_set()
13317 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13320 * Enable/disable homogenous mode.
13322 * @param obj The toolbar object
13323 * @param homogeneous Assume the items within the toolbar are of the
13324 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13326 * This will enable the homogeneous mode where items are of the same size.
13327 * @see elm_toolbar_homogeneous_get()
13329 * @deprecated use elm_toolbar_homogeneous_set() instead.
13333 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13336 * Get whether the homogenous mode is enabled.
13338 * @param obj The toolbar object.
13339 * @return Assume the items within the toolbar are of the same height
13340 * and width (EINA_TRUE = on, EINA_FALSE = off).
13342 * @see elm_toolbar_homogeneous_set()
13343 * @deprecated use elm_toolbar_homogeneous_get() instead.
13347 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13350 * Set the parent object of the toolbar items' menus.
13352 * @param obj The toolbar object.
13353 * @param parent The parent of the menu objects.
13355 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13357 * For more details about setting the parent for toolbar menus, see
13358 * elm_menu_parent_set().
13360 * @see elm_menu_parent_set() for details.
13361 * @see elm_toolbar_item_menu_set() for details.
13365 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13368 * Get the parent object of the toolbar items' menus.
13370 * @param obj The toolbar object.
13371 * @return The parent of the menu objects.
13373 * @see elm_toolbar_menu_parent_set() for details.
13377 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13380 * Set the alignment of the items.
13382 * @param obj The toolbar object.
13383 * @param align The new alignment, a float between <tt> 0.0 </tt>
13384 * and <tt> 1.0 </tt>.
13386 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13387 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13390 * Centered items by default.
13392 * @see elm_toolbar_align_get()
13396 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13399 * Get the alignment of the items.
13401 * @param obj The toolbar object.
13402 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13405 * @see elm_toolbar_align_set() for details.
13409 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13412 * Set whether the toolbar item opens a menu.
13414 * @param item The toolbar item.
13415 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13417 * A toolbar item can be set to be a menu, using this function.
13419 * Once it is set to be a menu, it can be manipulated through the
13420 * menu-like function elm_toolbar_menu_parent_set() and the other
13421 * elm_menu functions, using the Evas_Object @c menu returned by
13422 * elm_toolbar_item_menu_get().
13424 * So, items to be displayed in this item's menu should be added with
13425 * elm_menu_item_add().
13427 * The following code exemplifies the most basic usage:
13429 * tb = elm_toolbar_add(win)
13430 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13431 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13432 * elm_toolbar_menu_parent_set(tb, win);
13433 * menu = elm_toolbar_item_menu_get(item);
13434 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13435 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13439 * @see elm_toolbar_item_menu_get()
13443 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13446 * Get toolbar item's menu.
13448 * @param item The toolbar item.
13449 * @return Item's menu object or @c NULL on failure.
13451 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13452 * this function will set it.
13454 * @see elm_toolbar_item_menu_set() for details.
13458 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13461 * Add a new state to @p item.
13463 * @param item The item.
13464 * @param icon A string with icon name or the absolute path of an image file.
13465 * @param label The label of the new state.
13466 * @param func The function to call when the item is clicked when this
13467 * state is selected.
13468 * @param data The data to associate with the state.
13469 * @return The toolbar item state, or @c NULL upon failure.
13471 * Toolbar will load icon image from fdo or current theme.
13472 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13473 * If an absolute path is provided it will load it direct from a file.
13475 * States created with this function can be removed with
13476 * elm_toolbar_item_state_del().
13478 * @see elm_toolbar_item_state_del()
13479 * @see elm_toolbar_item_state_sel()
13480 * @see elm_toolbar_item_state_get()
13484 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);
13487 * Delete a previoulsy added state to @p item.
13489 * @param item The toolbar item.
13490 * @param state The state to be deleted.
13491 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13493 * @see elm_toolbar_item_state_add()
13495 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13498 * Set @p state as the current state of @p it.
13500 * @param it The item.
13501 * @param state The state to use.
13502 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13504 * If @p state is @c NULL, it won't select any state and the default item's
13505 * icon and label will be used. It's the same behaviour than
13506 * elm_toolbar_item_state_unser().
13508 * @see elm_toolbar_item_state_unset()
13512 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13515 * Unset the state of @p it.
13517 * @param it The item.
13519 * The default icon and label from this item will be displayed.
13521 * @see elm_toolbar_item_state_set() for more details.
13525 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13528 * Get the current state of @p it.
13530 * @param item The item.
13531 * @return The selected state or @c NULL if none is selected or on failure.
13533 * @see elm_toolbar_item_state_set() for details.
13534 * @see elm_toolbar_item_state_unset()
13535 * @see elm_toolbar_item_state_add()
13539 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13542 * Get the state after selected state in toolbar's @p item.
13544 * @param it The toolbar item to change state.
13545 * @return The state after current state, or @c NULL on failure.
13547 * If last state is selected, this function will return first state.
13549 * @see elm_toolbar_item_state_set()
13550 * @see elm_toolbar_item_state_add()
13554 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13557 * Get the state before selected state in toolbar's @p item.
13559 * @param it The toolbar item to change state.
13560 * @return The state before current state, or @c NULL on failure.
13562 * If first state is selected, this function will return last state.
13564 * @see elm_toolbar_item_state_set()
13565 * @see elm_toolbar_item_state_add()
13569 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13572 * Set the text to be shown in a given toolbar item's tooltips.
13574 * @param item Target item.
13575 * @param text The text to set in the content.
13577 * Setup the text as tooltip to object. The item can have only one tooltip,
13578 * so any previous tooltip data - set with this function or
13579 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13581 * @see elm_object_tooltip_text_set() for more details.
13585 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13588 * Set the content to be shown in the tooltip item.
13590 * Setup the tooltip to item. The item can have only one tooltip,
13591 * so any previous tooltip data is removed. @p func(with @p data) will
13592 * be called every time that need show the tooltip and it should
13593 * return a valid Evas_Object. This object is then managed fully by
13594 * tooltip system and is deleted when the tooltip is gone.
13596 * @param item the toolbar item being attached a tooltip.
13597 * @param func the function used to create the tooltip contents.
13598 * @param data what to provide to @a func as callback data/context.
13599 * @param del_cb called when data is not needed anymore, either when
13600 * another callback replaces @a func, the tooltip is unset with
13601 * elm_toolbar_item_tooltip_unset() or the owner @a item
13602 * dies. This callback receives as the first parameter the
13603 * given @a data, and @c event_info is the item.
13605 * @see elm_object_tooltip_content_cb_set() for more details.
13609 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);
13612 * Unset tooltip from item.
13614 * @param item toolbar item to remove previously set tooltip.
13616 * Remove tooltip from item. The callback provided as del_cb to
13617 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13618 * it is not used anymore.
13620 * @see elm_object_tooltip_unset() for more details.
13621 * @see elm_toolbar_item_tooltip_content_cb_set()
13625 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13628 * Sets a different style for this item tooltip.
13630 * @note before you set a style you should define a tooltip with
13631 * elm_toolbar_item_tooltip_content_cb_set() or
13632 * elm_toolbar_item_tooltip_text_set()
13634 * @param item toolbar item with tooltip already set.
13635 * @param style the theme style to use (default, transparent, ...)
13637 * @see elm_object_tooltip_style_set() for more details.
13641 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13644 * Get the style for this item tooltip.
13646 * @param item toolbar item with tooltip already set.
13647 * @return style the theme style in use, defaults to "default". If the
13648 * object does not have a tooltip set, then NULL is returned.
13650 * @see elm_object_tooltip_style_get() for more details.
13651 * @see elm_toolbar_item_tooltip_style_set()
13655 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13658 * Set the type of mouse pointer/cursor decoration to be shown,
13659 * when the mouse pointer is over the given toolbar widget item
13661 * @param item toolbar item to customize cursor on
13662 * @param cursor the cursor type's name
13664 * This function works analogously as elm_object_cursor_set(), but
13665 * here the cursor's changing area is restricted to the item's
13666 * area, and not the whole widget's. Note that that item cursors
13667 * have precedence over widget cursors, so that a mouse over an
13668 * item with custom cursor set will always show @b that cursor.
13670 * If this function is called twice for an object, a previously set
13671 * cursor will be unset on the second call.
13673 * @see elm_object_cursor_set()
13674 * @see elm_toolbar_item_cursor_get()
13675 * @see elm_toolbar_item_cursor_unset()
13679 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13682 * Get the type of mouse pointer/cursor decoration set to be shown,
13683 * when the mouse pointer is over the given toolbar widget item
13685 * @param item toolbar item with custom cursor set
13686 * @return the cursor type's name or @c NULL, if no custom cursors
13687 * were set to @p item (and on errors)
13689 * @see elm_object_cursor_get()
13690 * @see elm_toolbar_item_cursor_set()
13691 * @see elm_toolbar_item_cursor_unset()
13695 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13698 * Unset any custom mouse pointer/cursor decoration set to be
13699 * shown, when the mouse pointer is over the given toolbar widget
13700 * item, thus making it show the @b default cursor again.
13702 * @param item a toolbar item
13704 * Use this call to undo any custom settings on this item's cursor
13705 * decoration, bringing it back to defaults (no custom style set).
13707 * @see elm_object_cursor_unset()
13708 * @see elm_toolbar_item_cursor_set()
13712 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13715 * Set a different @b style for a given custom cursor set for a
13718 * @param item toolbar item with custom cursor set
13719 * @param style the <b>theme style</b> to use (e.g. @c "default",
13720 * @c "transparent", etc)
13722 * This function only makes sense when one is using custom mouse
13723 * cursor decorations <b>defined in a theme file</b>, which can have,
13724 * given a cursor name/type, <b>alternate styles</b> on it. It
13725 * works analogously as elm_object_cursor_style_set(), but here
13726 * applyed only to toolbar item objects.
13728 * @warning Before you set a cursor style you should have definen a
13729 * custom cursor previously on the item, with
13730 * elm_toolbar_item_cursor_set()
13732 * @see elm_toolbar_item_cursor_engine_only_set()
13733 * @see elm_toolbar_item_cursor_style_get()
13737 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13740 * Get the current @b style set for a given toolbar item's custom
13743 * @param item toolbar item with custom cursor set.
13744 * @return style the cursor style in use. If the object does not
13745 * have a cursor set, then @c NULL is returned.
13747 * @see elm_toolbar_item_cursor_style_set() for more details
13751 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13754 * Set if the (custom)cursor for a given toolbar item should be
13755 * searched in its theme, also, or should only rely on the
13756 * rendering engine.
13758 * @param item item with custom (custom) cursor already set on
13759 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13760 * only on those provided by the rendering engine, @c EINA_FALSE to
13761 * have them searched on the widget's theme, as well.
13763 * @note This call is of use only if you've set a custom cursor
13764 * for toolbar items, with elm_toolbar_item_cursor_set().
13766 * @note By default, cursors will only be looked for between those
13767 * provided by the rendering engine.
13771 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13774 * Get if the (custom) cursor for a given toolbar item is being
13775 * searched in its theme, also, or is only relying on the rendering
13778 * @param item a toolbar item
13779 * @return @c EINA_TRUE, if cursors are being looked for only on
13780 * those provided by the rendering engine, @c EINA_FALSE if they
13781 * are being searched on the widget's theme, as well.
13783 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13787 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13790 * Change a toolbar's orientation
13791 * @param obj The toolbar object
13792 * @param vertical If @c EINA_TRUE, the toolbar is vertical
13793 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
13796 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
13799 * Get a toolbar's orientation
13800 * @param obj The toolbar object
13801 * @return If @c EINA_TRUE, the toolbar is vertical
13802 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
13805 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13812 * @defgroup Tooltips Tooltips
13814 * The Tooltip is an (internal, for now) smart object used to show a
13815 * content in a frame on mouse hover of objects(or widgets), with
13816 * tips/information about them.
13821 EAPI double elm_tooltip_delay_get(void);
13822 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
13823 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
13824 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
13825 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
13826 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);
13827 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13828 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13829 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13830 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
13831 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
13838 * @defgroup Cursors Cursors
13840 * The Cursor is an internal smart object used to customize the
13841 * cursor displayed over objects (or widgets).
13842 * It can use default X cursors (if using X), or cursors from a
13849 * Set the cursor to be shown when mouse is over the object
13851 * Set the cursor that will be displayed when mouse is over the
13852 * object. The object can have only one cursor set to it, so if
13853 * this function is called twice for an object, the previous set
13855 * If using X cursors, a definition of all the valid cursor names
13856 * is listed on Elementary_Cursors.h. If an invalid name is set
13857 * the default cursor will be used.
13859 * @param obj the object being set a cursor.
13860 * @param cursor the cursor name to be used.
13864 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
13867 * Get the cursor to be shown when mouse is over the object
13869 * @param obj an object with cursor already set.
13870 * @return the cursor name.
13874 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13877 * Unset cursor for object
13879 * Unset cursor for object, and set the cursor to default if the mouse
13880 * was over this object.
13882 * @param obj Target object
13883 * @see elm_object_cursor_set()
13887 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13890 * Sets a different style for this object cursor.
13892 * @note before you set a style you should define a cursor with
13893 * elm_object_cursor_set()
13895 * @param obj an object with cursor already set.
13896 * @param style the theme style to use (default, transparent, ...)
13900 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13903 * Get the style for this object cursor.
13905 * @param obj an object with cursor already set.
13906 * @return style the theme style in use, defaults to "default". If the
13907 * object does not have a cursor set, then NULL is returned.
13911 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13914 * Set if the cursor set should be searched on the theme or should use
13915 * the provided by the engine, only.
13917 * @note before you set if should look on theme you should define a cursor
13918 * with elm_object_cursor_set(). By default it will only look for cursors
13919 * provided by the engine.
13921 * @param obj an object with cursor already set.
13922 * @param engine_only boolean to define it cursors should be looked only
13923 * between the provided by the engine or searched on widget's theme as well.
13927 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13930 * Get the cursor engine only usage for this object cursor.
13932 * @param obj an object with cursor already set.
13933 * @return engine_only boolean to define it cursors should be
13934 * looked only between the provided by the engine or searched on
13935 * widget's theme as well. If the object does not have a cursor
13936 * set, then EINA_FALSE is returned.
13940 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13943 * Get the configured cursor engine only usage
13945 * This gets the globally configured exclusive usage of engine cursors.
13947 * @return 1 if only engine cursors should be used
13950 EAPI int elm_cursor_engine_only_get(void);
13953 * Set the configured cursor engine only usage
13955 * This sets the globally configured exclusive usage of engine cursors.
13956 * It won't affect cursors set before changing this value.
13958 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
13959 * look for them on theme before.
13960 * @return EINA_TRUE if value is valid and setted (0 or 1)
13963 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
13970 * @defgroup Menu Menu
13972 * @image html img/widget/menu/preview-00.png
13973 * @image latex img/widget/menu/preview-00.eps
13975 * A menu is a list of items displayed above its parent. When the menu is
13976 * showing its parent is darkened. Each item can have a sub-menu. The menu
13977 * object can be used to display a menu on a right click event, in a toolbar,
13980 * Signals that you can add callbacks for are:
13981 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
13982 * event_info is NULL.
13984 * @see @ref tutorial_menu
13987 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
13989 * @brief Add a new menu to the parent
13991 * @param parent The parent object.
13992 * @return The new object or NULL if it cannot be created.
13994 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13996 * @brief Set the parent for the given menu widget
13998 * @param obj The menu object.
13999 * @param parent The new parent.
14001 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14003 * @brief Get the parent for the given menu widget
14005 * @param obj The menu object.
14006 * @return The parent.
14008 * @see elm_menu_parent_set()
14010 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14012 * @brief Move the menu to a new position
14014 * @param obj The menu object.
14015 * @param x The new position.
14016 * @param y The new position.
14018 * Sets the top-left position of the menu to (@p x,@p y).
14020 * @note @p x and @p y coordinates are relative to parent.
14022 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14024 * @brief Close a opened menu
14026 * @param obj the menu object
14029 * Hides the menu and all it's sub-menus.
14031 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14033 * @brief Returns a list of @p item's items.
14035 * @param obj The menu object
14036 * @return An Eina_List* of @p item's items
14038 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14040 * @brief Get the Evas_Object of an Elm_Menu_Item
14042 * @param item The menu item object.
14043 * @return The edje object containing the swallowed content
14045 * @warning Don't manipulate this object!
14047 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14049 * @brief Add an item at the end of the given menu widget
14051 * @param obj The menu object.
14052 * @param parent The parent menu item (optional)
14053 * @param icon A icon display on the item. The icon will be destryed by the menu.
14054 * @param label The label of the item.
14055 * @param func Function called when the user select the item.
14056 * @param data Data sent by the callback.
14057 * @return Returns the new item.
14059 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);
14061 * @brief Add an object swallowed in an item at the end of the given menu
14064 * @param obj The menu object.
14065 * @param parent The parent menu item (optional)
14066 * @param subobj The object to swallow
14067 * @param func Function called when the user select the item.
14068 * @param data Data sent by the callback.
14069 * @return Returns the new item.
14071 * Add an evas object as an item to the menu.
14073 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);
14075 * @brief Set the label of a menu item
14077 * @param item The menu item object.
14078 * @param label The label to set for @p item
14080 * @warning Don't use this funcion on items created with
14081 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14083 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14085 * @brief Get the label of a menu item
14087 * @param item The menu item object.
14088 * @return The label of @p item
14090 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14092 * @brief Set the icon of a menu item to the standard icon with name @p icon
14094 * @param item The menu item object.
14095 * @param icon The icon object to set for the content of @p item
14097 * Once this icon is set, any previously set icon will be deleted.
14099 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14101 * @brief Get the string representation from the icon of a menu item
14103 * @param item The menu item object.
14104 * @return The string representation of @p item's icon or NULL
14106 * @see elm_menu_item_object_icon_name_set()
14108 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14110 * @brief Set the content object of a menu item
14112 * @param item The menu item object
14113 * @param The content object or NULL
14114 * @return EINA_TRUE on success, else EINA_FALSE
14116 * Use this function to change the object swallowed by a menu item, deleting
14117 * any previously swallowed object.
14119 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14121 * @brief Get the content object of a menu item
14123 * @param item The menu item object
14124 * @return The content object or NULL
14125 * @note If @p item was added with elm_menu_item_add_object, this
14126 * function will return the object passed, else it will return the
14129 * @see elm_menu_item_object_content_set()
14131 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14133 * @brief Set the selected state of @p item.
14135 * @param item The menu item object.
14136 * @param selected The selected/unselected state of the item
14138 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14140 * @brief Get the selected state of @p item.
14142 * @param item The menu item object.
14143 * @return The selected/unselected state of the item
14145 * @see elm_menu_item_selected_set()
14147 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14149 * @brief Set the disabled state of @p item.
14151 * @param item The menu item object.
14152 * @param disabled The enabled/disabled state of the item
14154 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14156 * @brief Get the disabled state of @p item.
14158 * @param item The menu item object.
14159 * @return The enabled/disabled state of the item
14161 * @see elm_menu_item_disabled_set()
14163 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14165 * @brief Add a separator item to menu @p obj under @p parent.
14167 * @param obj The menu object
14168 * @param parent The item to add the separator under
14169 * @return The created item or NULL on failure
14171 * This is item is a @ref Separator.
14173 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14175 * @brief Returns whether @p item is a separator.
14177 * @param item The item to check
14178 * @return If true, @p item is a separator
14180 * @see elm_menu_item_separator_add()
14182 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14184 * @brief Deletes an item from the menu.
14186 * @param item The item to delete.
14188 * @see elm_menu_item_add()
14190 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14192 * @brief Set the function called when a menu item is deleted.
14194 * @param item The item to set the callback on
14195 * @param func The function called
14197 * @see elm_menu_item_add()
14198 * @see elm_menu_item_del()
14200 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14202 * @brief Returns the data associated with menu item @p item.
14204 * @param item The item
14205 * @return The data associated with @p item or NULL if none was set.
14207 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14209 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14211 * @brief Sets the data to be associated with menu item @p item.
14213 * @param item The item
14214 * @param data The data to be associated with @p item
14216 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14218 * @brief Returns a list of @p item's subitems.
14220 * @param item The item
14221 * @return An Eina_List* of @p item's subitems
14223 * @see elm_menu_add()
14225 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14227 * @brief Get the position of a menu item
14229 * @param item The menu item
14230 * @return The item's index
14232 * This function returns the index position of a menu item in a menu.
14233 * For a sub-menu, this number is relative to the first item in the sub-menu.
14235 * @note Index values begin with 0
14237 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14239 * @brief @brief Return a menu item's owner menu
14241 * @param item The menu item
14242 * @return The menu object owning @p item, or NULL on failure
14244 * Use this function to get the menu object owning an item.
14246 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14248 * @brief Get the selected item in the menu
14250 * @param obj The menu object
14251 * @return The selected item, or NULL if none
14253 * @see elm_menu_item_selected_get()
14254 * @see elm_menu_item_selected_set()
14256 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14258 * @brief Get the last item in the menu
14260 * @param obj The menu object
14261 * @return The last item, or NULL if none
14263 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14265 * @brief Get the first item in the menu
14267 * @param obj The menu object
14268 * @return The first item, or NULL if none
14270 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14272 * @brief Get the next item in the menu.
14274 * @param item The menu item object.
14275 * @return The item after it, or NULL if none
14277 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14279 * @brief Get the previous item in the menu.
14281 * @param item The menu item object.
14282 * @return The item before it, or NULL if none
14284 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14290 * @defgroup List List
14291 * @ingroup Elementary
14293 * @image html img/widget/list/preview-00.png
14294 * @image latex img/widget/list/preview-00.eps width=\textwidth
14296 * @image html img/list.png
14297 * @image latex img/list.eps width=\textwidth
14299 * A list widget is a container whose children are displayed vertically or
14300 * horizontally, in order, and can be selected.
14301 * The list can accept only one or multiple items selection. Also has many
14302 * modes of items displaying.
14304 * A list is a very simple type of list widget. For more robust
14305 * lists, @ref Genlist should probably be used.
14307 * Smart callbacks one can listen to:
14308 * - @c "activated" - The user has double-clicked or pressed
14309 * (enter|return|spacebar) on an item. The @c event_info parameter
14310 * is the item that was activated.
14311 * - @c "clicked,double" - The user has double-clicked an item.
14312 * The @c event_info parameter is the item that was double-clicked.
14313 * - "selected" - when the user selected an item
14314 * - "unselected" - when the user unselected an item
14315 * - "longpressed" - an item in the list is long-pressed
14316 * - "scroll,edge,top" - the list is scrolled until the top edge
14317 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14318 * - "scroll,edge,left" - the list is scrolled until the left edge
14319 * - "scroll,edge,right" - the list is scrolled until the right edge
14321 * Available styles for it:
14324 * List of examples:
14325 * @li @ref list_example_01
14326 * @li @ref list_example_02
14327 * @li @ref list_example_03
14336 * @enum _Elm_List_Mode
14337 * @typedef Elm_List_Mode
14339 * Set list's resize behavior, transverse axis scroll and
14340 * items cropping. See each mode's description for more details.
14342 * @note Default value is #ELM_LIST_SCROLL.
14344 * Values <b> don't </b> work as bitmask, only one can be choosen.
14346 * @see elm_list_mode_set()
14347 * @see elm_list_mode_get()
14351 typedef enum _Elm_List_Mode
14353 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. */
14354 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). */
14355 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. */
14356 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. */
14357 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14360 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(). */
14363 * Add a new list widget to the given parent Elementary
14364 * (container) object.
14366 * @param parent The parent object.
14367 * @return a new list widget handle or @c NULL, on errors.
14369 * This function inserts a new list widget on the canvas.
14373 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14378 * @param obj The list object
14380 * @note Call before running show() on the list object.
14381 * @warning If not called, it won't display the list properly.
14384 * li = elm_list_add(win);
14385 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14386 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14388 * evas_object_show(li);
14393 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14396 * Enable or disable multiple items selection on the list object.
14398 * @param obj The list object
14399 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14402 * Disabled by default. If disabled, the user can select a single item of
14403 * the list each time. Selected items are highlighted on list.
14404 * If enabled, many items can be selected.
14406 * If a selected item is selected again, it will be unselected.
14408 * @see elm_list_multi_select_get()
14412 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14415 * Get a value whether multiple items selection is enabled or not.
14417 * @see elm_list_multi_select_set() for details.
14419 * @param obj The list object.
14420 * @return @c EINA_TRUE means multiple items selection is enabled.
14421 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14422 * @c EINA_FALSE is returned.
14426 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14429 * Set which mode to use for the list object.
14431 * @param obj The list object
14432 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14433 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14435 * Set list's resize behavior, transverse axis scroll and
14436 * items cropping. See each mode's description for more details.
14438 * @note Default value is #ELM_LIST_SCROLL.
14440 * Only one can be set, if a previous one was set, it will be changed
14441 * by the new mode set. Bitmask won't work as well.
14443 * @see elm_list_mode_get()
14447 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14450 * Get the mode the list is at.
14452 * @param obj The list object
14453 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14454 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14456 * @note see elm_list_mode_set() for more information.
14460 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14463 * Enable or disable horizontal mode on the list object.
14465 * @param obj The list object.
14466 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14467 * disable it, i.e., to enable vertical mode.
14469 * @note Vertical mode is set by default.
14471 * On horizontal mode items are displayed on list from left to right,
14472 * instead of from top to bottom. Also, the list will scroll horizontally.
14473 * Each item will presents left icon on top and right icon, or end, at
14476 * @see elm_list_horizontal_get()
14480 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14483 * Get a value whether horizontal mode is enabled or not.
14485 * @param obj The list object.
14486 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14487 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14488 * @c EINA_FALSE is returned.
14490 * @see elm_list_horizontal_set() for details.
14494 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14497 * Enable or disable always select mode on the list object.
14499 * @param obj The list object
14500 * @param always_select @c EINA_TRUE to enable always select mode or
14501 * @c EINA_FALSE to disable it.
14503 * @note Always select mode is disabled by default.
14505 * Default behavior of list items is to only call its callback function
14506 * the first time it's pressed, i.e., when it is selected. If a selected
14507 * item is pressed again, and multi-select is disabled, it won't call
14508 * this function (if multi-select is enabled it will unselect the item).
14510 * If always select is enabled, it will call the callback function
14511 * everytime a item is pressed, so it will call when the item is selected,
14512 * and again when a selected item is pressed.
14514 * @see elm_list_always_select_mode_get()
14515 * @see elm_list_multi_select_set()
14519 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14522 * Get a value whether always select mode is enabled or not, meaning that
14523 * an item will always call its callback function, even if already selected.
14525 * @param obj The list object
14526 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14527 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14528 * @c EINA_FALSE is returned.
14530 * @see elm_list_always_select_mode_set() for details.
14534 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14537 * Set bouncing behaviour when the scrolled content reaches an edge.
14539 * Tell the internal scroller object whether it should bounce or not
14540 * when it reaches the respective edges for each axis.
14542 * @param obj The list object
14543 * @param h_bounce Whether to bounce or not in the horizontal axis.
14544 * @param v_bounce Whether to bounce or not in the vertical axis.
14546 * @see elm_scroller_bounce_set()
14550 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14553 * Get the bouncing behaviour of the internal scroller.
14555 * Get whether the internal scroller should bounce when the edge of each
14556 * axis is reached scrolling.
14558 * @param obj The list object.
14559 * @param h_bounce Pointer where to store the bounce state of the horizontal
14561 * @param v_bounce Pointer where to store the bounce state of the vertical
14564 * @see elm_scroller_bounce_get()
14565 * @see elm_list_bounce_set()
14569 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14572 * Set the scrollbar policy.
14574 * @param obj The list object
14575 * @param policy_h Horizontal scrollbar policy.
14576 * @param policy_v Vertical scrollbar policy.
14578 * This sets the scrollbar visibility policy for the given scroller.
14579 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14580 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14581 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14582 * This applies respectively for the horizontal and vertical scrollbars.
14584 * The both are disabled by default, i.e., are set to
14585 * #ELM_SCROLLER_POLICY_OFF.
14589 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14592 * Get the scrollbar policy.
14594 * @see elm_list_scroller_policy_get() for details.
14596 * @param obj The list object.
14597 * @param policy_h Pointer where to store horizontal scrollbar policy.
14598 * @param policy_v Pointer where to store vertical scrollbar policy.
14602 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);
14605 * Append a new item to the list object.
14607 * @param obj The list object.
14608 * @param label The label of the list item.
14609 * @param icon The icon object to use for the left side of the item. An
14610 * icon can be any Evas object, but usually it is an icon created
14611 * with elm_icon_add().
14612 * @param end The icon object to use for the right side of the item. An
14613 * icon can be any Evas object.
14614 * @param func The function to call when the item is clicked.
14615 * @param data The data to associate with the item for related callbacks.
14617 * @return The created item or @c NULL upon failure.
14619 * A new item will be created and appended to the list, i.e., will
14620 * be set as @b last item.
14622 * Items created with this method can be deleted with
14623 * elm_list_item_del().
14625 * Associated @p data can be properly freed when item is deleted if a
14626 * callback function is set with elm_list_item_del_cb_set().
14628 * If a function is passed as argument, it will be called everytime this item
14629 * is selected, i.e., the user clicks over an unselected item.
14630 * If always select is enabled it will call this function every time
14631 * user clicks over an item (already selected or not).
14632 * If such function isn't needed, just passing
14633 * @c NULL as @p func is enough. The same should be done for @p data.
14635 * Simple example (with no function callback or data associated):
14637 * li = elm_list_add(win);
14638 * ic = elm_icon_add(win);
14639 * elm_icon_file_set(ic, "path/to/image", NULL);
14640 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14641 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14643 * evas_object_show(li);
14646 * @see elm_list_always_select_mode_set()
14647 * @see elm_list_item_del()
14648 * @see elm_list_item_del_cb_set()
14649 * @see elm_list_clear()
14650 * @see elm_icon_add()
14654 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);
14657 * Prepend a new item to the list object.
14659 * @param obj The list object.
14660 * @param label The label of the list item.
14661 * @param icon The icon object to use for the left side of the item. An
14662 * icon can be any Evas object, but usually it is an icon created
14663 * with elm_icon_add().
14664 * @param end The icon object to use for the right side of the item. An
14665 * icon can be any Evas object.
14666 * @param func The function to call when the item is clicked.
14667 * @param data The data to associate with the item for related callbacks.
14669 * @return The created item or @c NULL upon failure.
14671 * A new item will be created and prepended to the list, i.e., will
14672 * be set as @b first item.
14674 * Items created with this method can be deleted with
14675 * elm_list_item_del().
14677 * Associated @p data can be properly freed when item is deleted if a
14678 * callback function is set with elm_list_item_del_cb_set().
14680 * If a function is passed as argument, it will be called everytime this item
14681 * is selected, i.e., the user clicks over an unselected item.
14682 * If always select is enabled it will call this function every time
14683 * user clicks over an item (already selected or not).
14684 * If such function isn't needed, just passing
14685 * @c NULL as @p func is enough. The same should be done for @p data.
14687 * @see elm_list_item_append() for a simple code example.
14688 * @see elm_list_always_select_mode_set()
14689 * @see elm_list_item_del()
14690 * @see elm_list_item_del_cb_set()
14691 * @see elm_list_clear()
14692 * @see elm_icon_add()
14696 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);
14699 * Insert a new item into the list object before item @p before.
14701 * @param obj The list object.
14702 * @param before The list item to insert before.
14703 * @param label The label of the list item.
14704 * @param icon The icon object to use for the left side of the item. An
14705 * icon can be any Evas object, but usually it is an icon created
14706 * with elm_icon_add().
14707 * @param end The icon object to use for the right side of the item. An
14708 * icon can be any Evas object.
14709 * @param func The function to call when the item is clicked.
14710 * @param data The data to associate with the item for related callbacks.
14712 * @return The created item or @c NULL upon failure.
14714 * A new item will be created and added to the list. Its position in
14715 * this list will be just before item @p before.
14717 * Items created with this method can be deleted with
14718 * elm_list_item_del().
14720 * Associated @p data can be properly freed when item is deleted if a
14721 * callback function is set with elm_list_item_del_cb_set().
14723 * If a function is passed as argument, it will be called everytime this item
14724 * is selected, i.e., the user clicks over an unselected item.
14725 * If always select is enabled it will call this function every time
14726 * user clicks over an item (already selected or not).
14727 * If such function isn't needed, just passing
14728 * @c NULL as @p func is enough. The same should be done for @p data.
14730 * @see elm_list_item_append() for a simple code example.
14731 * @see elm_list_always_select_mode_set()
14732 * @see elm_list_item_del()
14733 * @see elm_list_item_del_cb_set()
14734 * @see elm_list_clear()
14735 * @see elm_icon_add()
14739 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);
14742 * Insert a new item into the list object after item @p after.
14744 * @param obj The list object.
14745 * @param after The list item to insert after.
14746 * @param label The label of the list item.
14747 * @param icon The icon object to use for the left side of the item. An
14748 * icon can be any Evas object, but usually it is an icon created
14749 * with elm_icon_add().
14750 * @param end The icon object to use for the right side of the item. An
14751 * icon can be any Evas object.
14752 * @param func The function to call when the item is clicked.
14753 * @param data The data to associate with the item for related callbacks.
14755 * @return The created item or @c NULL upon failure.
14757 * A new item will be created and added to the list. Its position in
14758 * this list will be just after item @p after.
14760 * Items created with this method can be deleted with
14761 * elm_list_item_del().
14763 * Associated @p data can be properly freed when item is deleted if a
14764 * callback function is set with elm_list_item_del_cb_set().
14766 * If a function is passed as argument, it will be called everytime this item
14767 * is selected, i.e., the user clicks over an unselected item.
14768 * If always select is enabled it will call this function every time
14769 * user clicks over an item (already selected or not).
14770 * If such function isn't needed, just passing
14771 * @c NULL as @p func is enough. The same should be done for @p data.
14773 * @see elm_list_item_append() for a simple code example.
14774 * @see elm_list_always_select_mode_set()
14775 * @see elm_list_item_del()
14776 * @see elm_list_item_del_cb_set()
14777 * @see elm_list_clear()
14778 * @see elm_icon_add()
14782 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);
14785 * Insert a new item into the sorted list object.
14787 * @param obj The list object.
14788 * @param label The label of the list item.
14789 * @param icon The icon object to use for the left side of the item. An
14790 * icon can be any Evas object, but usually it is an icon created
14791 * with elm_icon_add().
14792 * @param end The icon object to use for the right side of the item. An
14793 * icon can be any Evas object.
14794 * @param func The function to call when the item is clicked.
14795 * @param data The data to associate with the item for related callbacks.
14796 * @param cmp_func The comparing function to be used to sort list
14797 * items <b>by #Elm_List_Item item handles</b>. This function will
14798 * receive two items and compare them, returning a non-negative integer
14799 * if the second item should be place after the first, or negative value
14800 * if should be placed before.
14802 * @return The created item or @c NULL upon failure.
14804 * @note This function inserts values into a list object assuming it was
14805 * sorted and the result will be sorted.
14807 * A new item will be created and added to the list. Its position in
14808 * this list will be found comparing the new item with previously inserted
14809 * items using function @p cmp_func.
14811 * Items created with this method can be deleted with
14812 * elm_list_item_del().
14814 * Associated @p data can be properly freed when item is deleted if a
14815 * callback function is set with elm_list_item_del_cb_set().
14817 * If a function is passed as argument, it will be called everytime this item
14818 * is selected, i.e., the user clicks over an unselected item.
14819 * If always select is enabled it will call this function every time
14820 * user clicks over an item (already selected or not).
14821 * If such function isn't needed, just passing
14822 * @c NULL as @p func is enough. The same should be done for @p data.
14824 * @see elm_list_item_append() for a simple code example.
14825 * @see elm_list_always_select_mode_set()
14826 * @see elm_list_item_del()
14827 * @see elm_list_item_del_cb_set()
14828 * @see elm_list_clear()
14829 * @see elm_icon_add()
14833 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);
14836 * Remove all list's items.
14838 * @param obj The list object
14840 * @see elm_list_item_del()
14841 * @see elm_list_item_append()
14845 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14848 * Get a list of all the list items.
14850 * @param obj The list object
14851 * @return An @c Eina_List of list items, #Elm_List_Item,
14852 * or @c NULL on failure.
14854 * @see elm_list_item_append()
14855 * @see elm_list_item_del()
14856 * @see elm_list_clear()
14860 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14863 * Get the selected item.
14865 * @param obj The list object.
14866 * @return The selected list item.
14868 * The selected item can be unselected with function
14869 * elm_list_item_selected_set().
14871 * The selected item always will be highlighted on list.
14873 * @see elm_list_selected_items_get()
14877 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14880 * Return a list of the currently selected list items.
14882 * @param obj The list object.
14883 * @return An @c Eina_List of list items, #Elm_List_Item,
14884 * or @c NULL on failure.
14886 * Multiple items can be selected if multi select is enabled. It can be
14887 * done with elm_list_multi_select_set().
14889 * @see elm_list_selected_item_get()
14890 * @see elm_list_multi_select_set()
14894 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14897 * Set the selected state of an item.
14899 * @param item The list item
14900 * @param selected The selected state
14902 * This sets the selected state of the given item @p it.
14903 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14905 * If a new item is selected the previosly selected will be unselected,
14906 * unless multiple selection is enabled with elm_list_multi_select_set().
14907 * Previoulsy selected item can be get with function
14908 * elm_list_selected_item_get().
14910 * Selected items will be highlighted.
14912 * @see elm_list_item_selected_get()
14913 * @see elm_list_selected_item_get()
14914 * @see elm_list_multi_select_set()
14918 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14921 * Get whether the @p item is selected or not.
14923 * @param item The list item.
14924 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14925 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14927 * @see elm_list_selected_item_set() for details.
14928 * @see elm_list_item_selected_get()
14932 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
14935 * Set or unset item as a separator.
14937 * @param it The list item.
14938 * @param setting @c EINA_TRUE to set item @p it as separator or
14939 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14941 * Items aren't set as separator by default.
14943 * If set as separator it will display separator theme, so won't display
14946 * @see elm_list_item_separator_get()
14950 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
14953 * Get a value whether item is a separator or not.
14955 * @see elm_list_item_separator_set() for details.
14957 * @param it The list item.
14958 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14959 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14963 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
14966 * Show @p item in the list view.
14968 * @param item The list item to be shown.
14970 * It won't animate list until item is visible. If such behavior is wanted,
14971 * use elm_list_bring_in() intead.
14975 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
14978 * Bring in the given item to list view.
14980 * @param item The item.
14982 * This causes list to jump to the given item @p item and show it
14983 * (by scrolling), if it is not fully visible.
14985 * This may use animation to do so and take a period of time.
14987 * If animation isn't wanted, elm_list_item_show() can be used.
14991 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
14994 * Delete them item from the list.
14996 * @param item The item of list to be deleted.
14998 * If deleting all list items is required, elm_list_clear()
14999 * should be used instead of getting items list and deleting each one.
15001 * @see elm_list_clear()
15002 * @see elm_list_item_append()
15003 * @see elm_list_item_del_cb_set()
15007 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15010 * Set the function called when a list item is freed.
15012 * @param item The item to set the callback on
15013 * @param func The function called
15015 * If there is a @p func, then it will be called prior item's memory release.
15016 * That will be called with the following arguments:
15018 * @li item's Evas object;
15021 * This way, a data associated to a list item could be properly freed.
15025 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15028 * Get the data associated to the item.
15030 * @param item The list item
15031 * @return The data associated to @p item
15033 * The return value is a pointer to data associated to @p item when it was
15034 * created, with function elm_list_item_append() or similar. If no data
15035 * was passed as argument, it will return @c NULL.
15037 * @see elm_list_item_append()
15041 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15044 * Get the left side icon associated to the item.
15046 * @param item The list item
15047 * @return The left side icon associated to @p item
15049 * The return value is a pointer to the icon associated to @p item when
15051 * created, with function elm_list_item_append() or similar, or later
15052 * with function elm_list_item_icon_set(). If no icon
15053 * was passed as argument, it will return @c NULL.
15055 * @see elm_list_item_append()
15056 * @see elm_list_item_icon_set()
15060 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15063 * Set the left side icon associated to the item.
15065 * @param item The list item
15066 * @param icon The left side icon object to associate with @p item
15068 * The icon object to use at left side of the item. An
15069 * icon can be any Evas object, but usually it is an icon created
15070 * with elm_icon_add().
15072 * Once the icon object is set, a previously set one will be deleted.
15073 * @warning Setting the same icon for two items will cause the icon to
15074 * dissapear from the first item.
15076 * If an icon was passed as argument on item creation, with function
15077 * elm_list_item_append() or similar, it will be already
15078 * associated to the item.
15080 * @see elm_list_item_append()
15081 * @see elm_list_item_icon_get()
15085 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15088 * Get the right side icon associated to the item.
15090 * @param item The list item
15091 * @return The right side icon associated to @p item
15093 * The return value is a pointer to the icon associated to @p item when
15095 * created, with function elm_list_item_append() or similar, or later
15096 * with function elm_list_item_icon_set(). If no icon
15097 * was passed as argument, it will return @c NULL.
15099 * @see elm_list_item_append()
15100 * @see elm_list_item_icon_set()
15104 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15107 * Set the right side icon associated to the item.
15109 * @param item The list item
15110 * @param end The right side icon object to associate with @p item
15112 * The icon object to use at right side of the item. An
15113 * icon can be any Evas object, but usually it is an icon created
15114 * with elm_icon_add().
15116 * Once the icon object is set, a previously set one will be deleted.
15117 * @warning Setting the same icon for two items will cause the icon to
15118 * dissapear from the first item.
15120 * If an icon was passed as argument on item creation, with function
15121 * elm_list_item_append() or similar, it will be already
15122 * associated to the item.
15124 * @see elm_list_item_append()
15125 * @see elm_list_item_end_get()
15129 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15132 * Gets the base object of the item.
15134 * @param item The list item
15135 * @return The base object associated with @p item
15137 * Base object is the @c Evas_Object that represents that item.
15141 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15144 * Get the label of item.
15146 * @param item The item of list.
15147 * @return The label of item.
15149 * The return value is a pointer to the label associated to @p item when
15150 * it was created, with function elm_list_item_append(), or later
15151 * with function elm_list_item_label_set. If no label
15152 * was passed as argument, it will return @c NULL.
15154 * @see elm_list_item_label_set() for more details.
15155 * @see elm_list_item_append()
15159 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15162 * Set the label of item.
15164 * @param item The item of list.
15165 * @param text The label of item.
15167 * The label to be displayed by the item.
15168 * Label will be placed between left and right side icons (if set).
15170 * If a label was passed as argument on item creation, with function
15171 * elm_list_item_append() or similar, it will be already
15172 * displayed by the item.
15174 * @see elm_list_item_label_get()
15175 * @see elm_list_item_append()
15179 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15183 * Get the item before @p it in list.
15185 * @param it The list item.
15186 * @return The item before @p it, or @c NULL if none or on failure.
15188 * @note If it is the first item, @c NULL will be returned.
15190 * @see elm_list_item_append()
15191 * @see elm_list_items_get()
15195 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15198 * Get the item after @p it in list.
15200 * @param it The list item.
15201 * @return The item after @p it, or @c NULL if none or on failure.
15203 * @note If it is the last item, @c NULL will be returned.
15205 * @see elm_list_item_append()
15206 * @see elm_list_items_get()
15210 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15213 * Sets the disabled/enabled state of a list item.
15215 * @param it The item.
15216 * @param disabled The disabled state.
15218 * A disabled item cannot be selected or unselected. It will also
15219 * change its appearance (generally greyed out). This sets the
15220 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15225 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15228 * Get a value whether list item is disabled or not.
15230 * @param it The item.
15231 * @return The disabled state.
15233 * @see elm_list_item_disabled_set() for more details.
15237 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15240 * Set the text to be shown in a given list item's tooltips.
15242 * @param item Target item.
15243 * @param text The text to set in the content.
15245 * Setup the text as tooltip to object. The item can have only one tooltip,
15246 * so any previous tooltip data - set with this function or
15247 * elm_list_item_tooltip_content_cb_set() - is removed.
15249 * @see elm_object_tooltip_text_set() for more details.
15253 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15257 * @brief Disable size restrictions on an object's tooltip
15258 * @param item The tooltip's anchor object
15259 * @param disable If EINA_TRUE, size restrictions are disabled
15260 * @return EINA_FALSE on failure, EINA_TRUE on success
15262 * This function allows a tooltip to expand beyond its parant window's canvas.
15263 * It will instead be limited only by the size of the display.
15265 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15267 * @brief Retrieve size restriction state of an object's tooltip
15268 * @param obj The tooltip's anchor object
15269 * @return If EINA_TRUE, size restrictions are disabled
15271 * This function returns whether a tooltip is allowed to expand beyond
15272 * its parant window's canvas.
15273 * It will instead be limited only by the size of the display.
15275 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15278 * Set the content to be shown in the tooltip item.
15280 * Setup the tooltip to item. The item can have only one tooltip,
15281 * so any previous tooltip data is removed. @p func(with @p data) will
15282 * be called every time that need show the tooltip and it should
15283 * return a valid Evas_Object. This object is then managed fully by
15284 * tooltip system and is deleted when the tooltip is gone.
15286 * @param item the list item being attached a tooltip.
15287 * @param func the function used to create the tooltip contents.
15288 * @param data what to provide to @a func as callback data/context.
15289 * @param del_cb called when data is not needed anymore, either when
15290 * another callback replaces @a func, the tooltip is unset with
15291 * elm_list_item_tooltip_unset() or the owner @a item
15292 * dies. This callback receives as the first parameter the
15293 * given @a data, and @c event_info is the item.
15295 * @see elm_object_tooltip_content_cb_set() for more details.
15299 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);
15302 * Unset tooltip from item.
15304 * @param item list item to remove previously set tooltip.
15306 * Remove tooltip from item. The callback provided as del_cb to
15307 * elm_list_item_tooltip_content_cb_set() will be called to notify
15308 * it is not used anymore.
15310 * @see elm_object_tooltip_unset() for more details.
15311 * @see elm_list_item_tooltip_content_cb_set()
15315 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15318 * Sets a different style for this item tooltip.
15320 * @note before you set a style you should define a tooltip with
15321 * elm_list_item_tooltip_content_cb_set() or
15322 * elm_list_item_tooltip_text_set()
15324 * @param item list item with tooltip already set.
15325 * @param style the theme style to use (default, transparent, ...)
15327 * @see elm_object_tooltip_style_set() for more details.
15331 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15334 * Get the style for this item tooltip.
15336 * @param item list item with tooltip already set.
15337 * @return style the theme style in use, defaults to "default". If the
15338 * object does not have a tooltip set, then NULL is returned.
15340 * @see elm_object_tooltip_style_get() for more details.
15341 * @see elm_list_item_tooltip_style_set()
15345 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15348 * Set the type of mouse pointer/cursor decoration to be shown,
15349 * when the mouse pointer is over the given list widget item
15351 * @param item list item to customize cursor on
15352 * @param cursor the cursor type's name
15354 * This function works analogously as elm_object_cursor_set(), but
15355 * here the cursor's changing area is restricted to the item's
15356 * area, and not the whole widget's. Note that that item cursors
15357 * have precedence over widget cursors, so that a mouse over an
15358 * item with custom cursor set will always show @b that cursor.
15360 * If this function is called twice for an object, a previously set
15361 * cursor will be unset on the second call.
15363 * @see elm_object_cursor_set()
15364 * @see elm_list_item_cursor_get()
15365 * @see elm_list_item_cursor_unset()
15369 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15372 * Get the type of mouse pointer/cursor decoration set to be shown,
15373 * when the mouse pointer is over the given list widget item
15375 * @param item list item with custom cursor set
15376 * @return the cursor type's name or @c NULL, if no custom cursors
15377 * were set to @p item (and on errors)
15379 * @see elm_object_cursor_get()
15380 * @see elm_list_item_cursor_set()
15381 * @see elm_list_item_cursor_unset()
15385 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15388 * Unset any custom mouse pointer/cursor decoration set to be
15389 * shown, when the mouse pointer is over the given list widget
15390 * item, thus making it show the @b default cursor again.
15392 * @param item a list item
15394 * Use this call to undo any custom settings on this item's cursor
15395 * decoration, bringing it back to defaults (no custom style set).
15397 * @see elm_object_cursor_unset()
15398 * @see elm_list_item_cursor_set()
15402 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15405 * Set a different @b style for a given custom cursor set for a
15408 * @param item list item with custom cursor set
15409 * @param style the <b>theme style</b> to use (e.g. @c "default",
15410 * @c "transparent", etc)
15412 * This function only makes sense when one is using custom mouse
15413 * cursor decorations <b>defined in a theme file</b>, which can have,
15414 * given a cursor name/type, <b>alternate styles</b> on it. It
15415 * works analogously as elm_object_cursor_style_set(), but here
15416 * applyed only to list item objects.
15418 * @warning Before you set a cursor style you should have definen a
15419 * custom cursor previously on the item, with
15420 * elm_list_item_cursor_set()
15422 * @see elm_list_item_cursor_engine_only_set()
15423 * @see elm_list_item_cursor_style_get()
15427 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15430 * Get the current @b style set for a given list item's custom
15433 * @param item list item with custom cursor set.
15434 * @return style the cursor style in use. If the object does not
15435 * have a cursor set, then @c NULL is returned.
15437 * @see elm_list_item_cursor_style_set() for more details
15441 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15444 * Set if the (custom)cursor for a given list item should be
15445 * searched in its theme, also, or should only rely on the
15446 * rendering engine.
15448 * @param item item with custom (custom) cursor already set on
15449 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15450 * only on those provided by the rendering engine, @c EINA_FALSE to
15451 * have them searched on the widget's theme, as well.
15453 * @note This call is of use only if you've set a custom cursor
15454 * for list items, with elm_list_item_cursor_set().
15456 * @note By default, cursors will only be looked for between those
15457 * provided by the rendering engine.
15461 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15464 * Get if the (custom) cursor for a given list item is being
15465 * searched in its theme, also, or is only relying on the rendering
15468 * @param item a list item
15469 * @return @c EINA_TRUE, if cursors are being looked for only on
15470 * those provided by the rendering engine, @c EINA_FALSE if they
15471 * are being searched on the widget's theme, as well.
15473 * @see elm_list_item_cursor_engine_only_set(), for more details
15477 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15484 * @defgroup Slider Slider
15485 * @ingroup Elementary
15487 * @image html img/widget/slider/preview-00.png
15488 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15490 * The slider adds a dragable “slider” widget for selecting the value of
15491 * something within a range.
15493 * A slider can be horizontal or vertical. It can contain an Icon and has a
15494 * primary label as well as a units label (that is formatted with floating
15495 * point values and thus accepts a printf-style format string, like
15496 * “%1.2f units”. There is also an indicator string that may be somewhere
15497 * else (like on the slider itself) that also accepts a format string like
15498 * units. Label, Icon Unit and Indicator strings/objects are optional.
15500 * A slider may be inverted which means values invert, with high vales being
15501 * on the left or top and low values on the right or bottom (as opposed to
15502 * normally being low on the left or top and high on the bottom and right).
15504 * The slider should have its minimum and maximum values set by the
15505 * application with elm_slider_min_max_set() and value should also be set by
15506 * the application before use with elm_slider_value_set(). The span of the
15507 * slider is its length (horizontally or vertically). This will be scaled by
15508 * the object or applications scaling factor. At any point code can query the
15509 * slider for its value with elm_slider_value_get().
15511 * Smart callbacks one can listen to:
15512 * - "changed" - Whenever the slider value is changed by the user.
15513 * - "slider,drag,start" - dragging the slider indicator around has started.
15514 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15515 * - "delay,changed" - A short time after the value is changed by the user.
15516 * This will be called only when the user stops dragging for
15517 * a very short period or when they release their
15518 * finger/mouse, so it avoids possibly expensive reactions to
15519 * the value change.
15521 * Available styles for it:
15524 * Here is an example on its usage:
15525 * @li @ref slider_example
15529 * @addtogroup Slider
15534 * Add a new slider widget to the given parent Elementary
15535 * (container) object.
15537 * @param parent The parent object.
15538 * @return a new slider widget handle or @c NULL, on errors.
15540 * This function inserts a new slider widget on the canvas.
15544 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15547 * Set the label of a given slider widget
15549 * @param obj The progress bar object
15550 * @param label The text label string, in UTF-8
15553 * @deprecated use elm_object_text_set() instead.
15555 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15558 * Get the label of a given slider widget
15560 * @param obj The progressbar object
15561 * @return The text label string, in UTF-8
15564 * @deprecated use elm_object_text_get() instead.
15566 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15569 * Set the icon object of the slider object.
15571 * @param obj The slider object.
15572 * @param icon The icon object.
15574 * On horizontal mode, icon is placed at left, and on vertical mode,
15577 * @note Once the icon object is set, a previously set one will be deleted.
15578 * If you want to keep that old content object, use the
15579 * elm_slider_icon_unset() function.
15581 * @warning If the object being set does not have minimum size hints set,
15582 * it won't get properly displayed.
15586 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15589 * Unset an icon set on a given slider widget.
15591 * @param obj The slider object.
15592 * @return The icon object that was being used, if any was set, or
15593 * @c NULL, otherwise (and on errors).
15595 * On horizontal mode, icon is placed at left, and on vertical mode,
15598 * This call will unparent and return the icon object which was set
15599 * for this widget, previously, on success.
15601 * @see elm_slider_icon_set() for more details
15602 * @see elm_slider_icon_get()
15606 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15609 * Retrieve the icon object set for a given slider widget.
15611 * @param obj The slider object.
15612 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15613 * otherwise (and on errors).
15615 * On horizontal mode, icon is placed at left, and on vertical mode,
15618 * @see elm_slider_icon_set() for more details
15619 * @see elm_slider_icon_unset()
15623 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15626 * Set the end object of the slider object.
15628 * @param obj The slider object.
15629 * @param end The end object.
15631 * On horizontal mode, end is placed at left, and on vertical mode,
15632 * placed at bottom.
15634 * @note Once the icon object is set, a previously set one will be deleted.
15635 * If you want to keep that old content object, use the
15636 * elm_slider_end_unset() function.
15638 * @warning If the object being set does not have minimum size hints set,
15639 * it won't get properly displayed.
15643 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15646 * Unset an end object set on a given slider widget.
15648 * @param obj The slider object.
15649 * @return The end object that was being used, if any was set, or
15650 * @c NULL, otherwise (and on errors).
15652 * On horizontal mode, end is placed at left, and on vertical mode,
15653 * placed at bottom.
15655 * This call will unparent and return the icon object which was set
15656 * for this widget, previously, on success.
15658 * @see elm_slider_end_set() for more details.
15659 * @see elm_slider_end_get()
15663 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15666 * Retrieve the end object set for a given slider widget.
15668 * @param obj The slider object.
15669 * @return The end object's handle, if @p obj had one set, or @c NULL,
15670 * otherwise (and on errors).
15672 * On horizontal mode, icon is placed at right, and on vertical mode,
15673 * placed at bottom.
15675 * @see elm_slider_end_set() for more details.
15676 * @see elm_slider_end_unset()
15680 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15683 * Set the (exact) length of the bar region of a given slider widget.
15685 * @param obj The slider object.
15686 * @param size The length of the slider's bar region.
15688 * This sets the minimum width (when in horizontal mode) or height
15689 * (when in vertical mode) of the actual bar area of the slider
15690 * @p obj. This in turn affects the object's minimum size. Use
15691 * this when you're not setting other size hints expanding on the
15692 * given direction (like weight and alignment hints) and you would
15693 * like it to have a specific size.
15695 * @note Icon, end, label, indicator and unit text around @p obj
15696 * will require their
15697 * own space, which will make @p obj to require more the @p size,
15700 * @see elm_slider_span_size_get()
15704 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15707 * Get the length set for the bar region of a given slider widget
15709 * @param obj The slider object.
15710 * @return The length of the slider's bar region.
15712 * If that size was not set previously, with
15713 * elm_slider_span_size_set(), this call will return @c 0.
15717 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15720 * Set the format string for the unit label.
15722 * @param obj The slider object.
15723 * @param format The format string for the unit display.
15725 * Unit label is displayed all the time, if set, after slider's bar.
15726 * In horizontal mode, at right and in vertical mode, at bottom.
15728 * If @c NULL, unit label won't be visible. If not it sets the format
15729 * string for the label text. To the label text is provided a floating point
15730 * value, so the label text can display up to 1 floating point value.
15731 * Note that this is optional.
15733 * Use a format string such as "%1.2f meters" for example, and it will
15734 * display values like: "3.14 meters" for a value equal to 3.14159.
15736 * Default is unit label disabled.
15738 * @see elm_slider_indicator_format_get()
15742 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15745 * Get the unit label format of the slider.
15747 * @param obj The slider object.
15748 * @return The unit label format string in UTF-8.
15750 * Unit label is displayed all the time, if set, after slider's bar.
15751 * In horizontal mode, at right and in vertical mode, at bottom.
15753 * @see elm_slider_unit_format_set() for more
15754 * information on how this works.
15758 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15761 * Set the format string for the indicator label.
15763 * @param obj The slider object.
15764 * @param indicator The format string for the indicator display.
15766 * The slider may display its value somewhere else then unit label,
15767 * for example, above the slider knob that is dragged around. This function
15768 * sets the format string used for this.
15770 * If @c NULL, indicator label won't be visible. If not it sets the format
15771 * string for the label text. To the label text is provided a floating point
15772 * value, so the label text can display up to 1 floating point value.
15773 * Note that this is optional.
15775 * Use a format string such as "%1.2f meters" for example, and it will
15776 * display values like: "3.14 meters" for a value equal to 3.14159.
15778 * Default is indicator label disabled.
15780 * @see elm_slider_indicator_format_get()
15784 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
15787 * Get the indicator label format of the slider.
15789 * @param obj The slider object.
15790 * @return The indicator label format string in UTF-8.
15792 * The slider may display its value somewhere else then unit label,
15793 * for example, above the slider knob that is dragged around. This function
15794 * gets the format string used for this.
15796 * @see elm_slider_indicator_format_set() for more
15797 * information on how this works.
15801 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15804 * Set the format function pointer for the indicator label
15806 * @param obj The slider object.
15807 * @param func The indicator format function.
15808 * @param free_func The freeing function for the format string.
15810 * Set the callback function to format the indicator string.
15812 * @see elm_slider_indicator_format_set() for more info on how this works.
15816 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);
15819 * Set the format function pointer for the units label
15821 * @param obj The slider object.
15822 * @param func The units format function.
15823 * @param free_func The freeing function for the format string.
15825 * Set the callback function to format the indicator string.
15827 * @see elm_slider_units_format_set() for more info on how this works.
15831 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);
15834 * Set the orientation of a given slider widget.
15836 * @param obj The slider object.
15837 * @param horizontal Use @c EINA_TRUE to make @p obj to be
15838 * @b horizontal, @c EINA_FALSE to make it @b vertical.
15840 * Use this function to change how your slider is to be
15841 * disposed: vertically or horizontally.
15843 * By default it's displayed horizontally.
15845 * @see elm_slider_horizontal_get()
15849 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15852 * Retrieve the orientation of a given slider widget
15854 * @param obj The slider object.
15855 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
15856 * @c EINA_FALSE if it's @b vertical (and on errors).
15858 * @see elm_slider_horizontal_set() for more details.
15862 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15865 * Set the minimum and maximum values for the slider.
15867 * @param obj The slider object.
15868 * @param min The minimum value.
15869 * @param max The maximum value.
15871 * Define the allowed range of values to be selected by the user.
15873 * If actual value is less than @p min, it will be updated to @p min. If it
15874 * is bigger then @p max, will be updated to @p max. Actual value can be
15875 * get with elm_slider_value_get().
15877 * By default, min is equal to 0.0, and max is equal to 1.0.
15879 * @warning Maximum must be greater than minimum, otherwise behavior
15882 * @see elm_slider_min_max_get()
15886 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
15889 * Get the minimum and maximum values of the slider.
15891 * @param obj The slider object.
15892 * @param min Pointer where to store the minimum value.
15893 * @param max Pointer where to store the maximum value.
15895 * @note If only one value is needed, the other pointer can be passed
15898 * @see elm_slider_min_max_set() for details.
15902 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
15905 * Set the value the slider displays.
15907 * @param obj The slider object.
15908 * @param val The value to be displayed.
15910 * Value will be presented on the unit label following format specified with
15911 * elm_slider_unit_format_set() and on indicator with
15912 * elm_slider_indicator_format_set().
15914 * @warning The value must to be between min and max values. This values
15915 * are set by elm_slider_min_max_set().
15917 * @see elm_slider_value_get()
15918 * @see elm_slider_unit_format_set()
15919 * @see elm_slider_indicator_format_set()
15920 * @see elm_slider_min_max_set()
15924 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
15927 * Get the value displayed by the spinner.
15929 * @param obj The spinner object.
15930 * @return The value displayed.
15932 * @see elm_spinner_value_set() for details.
15936 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15939 * Invert a given slider widget's displaying values order
15941 * @param obj The slider object.
15942 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
15943 * @c EINA_FALSE to bring it back to default, non-inverted values.
15945 * A slider may be @b inverted, in which state it gets its
15946 * values inverted, with high vales being on the left or top and
15947 * low values on the right or bottom, as opposed to normally have
15948 * the low values on the former and high values on the latter,
15949 * respectively, for horizontal and vertical modes.
15951 * @see elm_slider_inverted_get()
15955 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
15958 * Get whether a given slider widget's displaying values are
15961 * @param obj The slider object.
15962 * @return @c EINA_TRUE, if @p obj has inverted values,
15963 * @c EINA_FALSE otherwise (and on errors).
15965 * @see elm_slider_inverted_set() for more details.
15969 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15972 * Set whether to enlarge slider indicator (augmented knob) or not.
15974 * @param obj The slider object.
15975 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
15976 * let the knob always at default size.
15978 * By default, indicator will be bigger while dragged by the user.
15980 * @warning It won't display values set with
15981 * elm_slider_indicator_format_set() if you disable indicator.
15985 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
15988 * Get whether a given slider widget's enlarging indicator or not.
15990 * @param obj The slider object.
15991 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
15992 * @c EINA_FALSE otherwise (and on errors).
15994 * @see elm_slider_indicator_show_set() for details.
15998 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16005 * @addtogroup Actionslider Actionslider
16007 * @image html img/widget/actionslider/preview-00.png
16008 * @image latex img/widget/actionslider/preview-00.eps
16010 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16011 * properties. The indicator is the element the user drags to choose a label.
16012 * When the position is set with magnet, when released the indicator will be
16013 * moved to it if it's nearest the magnetized position.
16015 * @note By default all positions are set as enabled.
16017 * Signals that you can add callbacks for are:
16019 * "selected" - when user selects an enabled position (the label is passed
16022 * "pos_changed" - when the indicator reaches any of the positions("left",
16023 * "right" or "center").
16025 * See an example of actionslider usage @ref actionslider_example_page "here"
16028 typedef enum _Elm_Actionslider_Pos
16030 ELM_ACTIONSLIDER_NONE = 0,
16031 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16032 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16033 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16034 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16035 } Elm_Actionslider_Pos;
16038 * Add a new actionslider to the parent.
16040 * @param parent The parent object
16041 * @return The new actionslider object or NULL if it cannot be created
16043 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16045 * Set actionslider labels.
16047 * @param obj The actionslider object
16048 * @param left_label The label to be set on the left.
16049 * @param center_label The label to be set on the center.
16050 * @param right_label The label to be set on the right.
16051 * @deprecated use elm_object_text_set() instead.
16053 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);
16055 * Get actionslider labels.
16057 * @param obj The actionslider object
16058 * @param left_label A char** to place the left_label of @p obj into.
16059 * @param center_label A char** to place the center_label of @p obj into.
16060 * @param right_label A char** to place the right_label of @p obj into.
16061 * @deprecated use elm_object_text_set() instead.
16063 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);
16065 * Get actionslider selected label.
16067 * @param obj The actionslider object
16068 * @return The selected label
16070 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16072 * Set actionslider indicator position.
16074 * @param obj The actionslider object.
16075 * @param pos The position of the indicator.
16077 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16079 * Get actionslider indicator position.
16081 * @param obj The actionslider object.
16082 * @return The position of the indicator.
16084 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16086 * Set actionslider magnet position. To make multiple positions magnets @c or
16087 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16089 * @param obj The actionslider object.
16090 * @param pos Bit mask indicating the magnet positions.
16092 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16094 * Get actionslider magnet position.
16096 * @param obj The actionslider object.
16097 * @return The positions with magnet property.
16099 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16101 * Set actionslider enabled position. To set multiple positions as enabled @c or
16102 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16104 * @note All the positions are enabled by default.
16106 * @param obj The actionslider object.
16107 * @param pos Bit mask indicating the enabled positions.
16109 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16111 * Get actionslider enabled position.
16113 * @param obj The actionslider object.
16114 * @return The enabled positions.
16116 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16118 * Set the label used on the indicator.
16120 * @param obj The actionslider object
16121 * @param label The label to be set on the indicator.
16122 * @deprecated use elm_object_text_set() instead.
16124 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16126 * Get the label used on the indicator object.
16128 * @param obj The actionslider object
16129 * @return The indicator label
16130 * @deprecated use elm_object_text_get() instead.
16132 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16138 * @defgroup Genlist Genlist
16140 * @image html img/widget/genlist/preview-00.png
16141 * @image latex img/widget/genlist/preview-00.eps
16142 * @image html img/genlist.png
16143 * @image latex img/genlist.eps
16145 * This widget aims to have more expansive list than the simple list in
16146 * Elementary that could have more flexible items and allow many more entries
16147 * while still being fast and low on memory usage. At the same time it was
16148 * also made to be able to do tree structures. But the price to pay is more
16149 * complexity when it comes to usage. If all you want is a simple list with
16150 * icons and a single label, use the normal @ref List object.
16152 * Genlist has a fairly large API, mostly because it's relatively complex,
16153 * trying to be both expansive, powerful and efficient. First we will begin
16154 * an overview on the theory behind genlist.
16156 * @section Genlist_Item_Class Genlist item classes - creating items
16158 * In order to have the ability to add and delete items on the fly, genlist
16159 * implements a class (callback) system where the application provides a
16160 * structure with information about that type of item (genlist may contain
16161 * multiple different items with different classes, states and styles).
16162 * Genlist will call the functions in this struct (methods) when an item is
16163 * "realized" (i.e., created dynamically, while the user is scrolling the
16164 * grid). All objects will simply be deleted when no longer needed with
16165 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16166 * following members:
16167 * - @c item_style - This is a constant string and simply defines the name
16168 * of the item style. It @b must be specified and the default should be @c
16170 * - @c mode_item_style - This is a constant string and simply defines the
16171 * name of the style that will be used for mode animations. It can be left
16172 * as @c NULL if you don't plan to use Genlist mode. See
16173 * elm_genlist_item_mode_set() for more info.
16175 * - @c func - A struct with pointers to functions that will be called when
16176 * an item is going to be actually created. All of them receive a @c data
16177 * parameter that will point to the same data passed to
16178 * elm_genlist_item_append() and related item creation functions, and a @c
16179 * obj parameter that points to the genlist object itself.
16181 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16182 * state_get and @c del. The 3 first functions also receive a @c part
16183 * parameter described below. A brief description of these functions follows:
16185 * - @c label_get - The @c part parameter is the name string of one of the
16186 * existing text parts in the Edje group implementing the item's theme.
16187 * This function @b must return a strdup'()ed string, as the caller will
16188 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16189 * - @c icon_get - The @c part parameter is the name string of one of the
16190 * existing (icon) swallow parts in the Edje group implementing the item's
16191 * theme. It must return @c NULL, when no icon is desired, or a valid
16192 * object handle, otherwise. The object will be deleted by the genlist on
16193 * its deletion or when the item is "unrealized". See
16194 * #Elm_Genlist_Item_Icon_Get_Cb.
16195 * - @c func.state_get - The @c part parameter is the name string of one of
16196 * the state parts in the Edje group implementing the item's theme. Return
16197 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16198 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16199 * and @c "elm" as "emission" and "source" arguments, respectively, when
16200 * the state is true (the default is false), where @c XXX is the name of
16201 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16202 * - @c func.del - This is intended for use when genlist items are deleted,
16203 * so any data attached to the item (e.g. its data parameter on creation)
16204 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16206 * available item styles:
16208 * - default_style - The text part is a textblock
16210 * @image html img/widget/genlist/preview-04.png
16211 * @image latex img/widget/genlist/preview-04.eps
16215 * @image html img/widget/genlist/preview-01.png
16216 * @image latex img/widget/genlist/preview-01.eps
16218 * - icon_top_text_bottom
16220 * @image html img/widget/genlist/preview-02.png
16221 * @image latex img/widget/genlist/preview-02.eps
16225 * @image html img/widget/genlist/preview-03.png
16226 * @image latex img/widget/genlist/preview-03.eps
16228 * @section Genlist_Items Structure of items
16230 * An item in a genlist can have 0 or more text labels (they can be regular
16231 * text or textblock Evas objects - that's up to the style to determine), 0
16232 * or more icons (which are simply objects swallowed into the genlist item's
16233 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16234 * behavior left to the user to define. The Edje part names for each of
16235 * these properties will be looked up, in the theme file for the genlist,
16236 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16237 * "states", respectively. For each of those properties, if more than one
16238 * part is provided, they must have names listed separated by spaces in the
16239 * data fields. For the default genlist item theme, we have @b one label
16240 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16241 * "elm.swallow.end") and @b no state parts.
16243 * A genlist item may be at one of several styles. Elementary provides one
16244 * by default - "default", but this can be extended by system or application
16245 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16248 * @section Genlist_Manipulation Editing and Navigating
16250 * Items can be added by several calls. All of them return a @ref
16251 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16252 * They all take a data parameter that is meant to be used for a handle to
16253 * the applications internal data (eg the struct with the original item
16254 * data). The parent parameter is the parent genlist item this belongs to if
16255 * it is a tree or an indexed group, and NULL if there is no parent. The
16256 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16257 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16258 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16259 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16260 * is set then this item is group index item that is displayed at the top
16261 * until the next group comes. The func parameter is a convenience callback
16262 * that is called when the item is selected and the data parameter will be
16263 * the func_data parameter, obj be the genlist object and event_info will be
16264 * the genlist item.
16266 * elm_genlist_item_append() adds an item to the end of the list, or if
16267 * there is a parent, to the end of all the child items of the parent.
16268 * elm_genlist_item_prepend() is the same but adds to the beginning of
16269 * the list or children list. elm_genlist_item_insert_before() inserts at
16270 * item before another item and elm_genlist_item_insert_after() inserts after
16271 * the indicated item.
16273 * The application can clear the list with elm_genlist_clear() which deletes
16274 * all the items in the list and elm_genlist_item_del() will delete a specific
16275 * item. elm_genlist_item_subitems_clear() will clear all items that are
16276 * children of the indicated parent item.
16278 * To help inspect list items you can jump to the item at the top of the list
16279 * with elm_genlist_first_item_get() which will return the item pointer, and
16280 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16281 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16282 * and previous items respectively relative to the indicated item. Using
16283 * these calls you can walk the entire item list/tree. Note that as a tree
16284 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16285 * let you know which item is the parent (and thus know how to skip them if
16288 * @section Genlist_Muti_Selection Multi-selection
16290 * If the application wants multiple items to be able to be selected,
16291 * elm_genlist_multi_select_set() can enable this. If the list is
16292 * single-selection only (the default), then elm_genlist_selected_item_get()
16293 * will return the selected item, if any, or NULL I none is selected. If the
16294 * list is multi-select then elm_genlist_selected_items_get() will return a
16295 * list (that is only valid as long as no items are modified (added, deleted,
16296 * selected or unselected)).
16298 * @section Genlist_Usage_Hints Usage hints
16300 * There are also convenience functions. elm_genlist_item_genlist_get() will
16301 * return the genlist object the item belongs to. elm_genlist_item_show()
16302 * will make the scroller scroll to show that specific item so its visible.
16303 * elm_genlist_item_data_get() returns the data pointer set by the item
16304 * creation functions.
16306 * If an item changes (state of boolean changes, label or icons change),
16307 * then use elm_genlist_item_update() to have genlist update the item with
16308 * the new state. Genlist will re-realize the item thus call the functions
16309 * in the _Elm_Genlist_Item_Class for that item.
16311 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16312 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16313 * to expand/contract an item and get its expanded state, use
16314 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16315 * again to make an item disabled (unable to be selected and appear
16316 * differently) use elm_genlist_item_disabled_set() to set this and
16317 * elm_genlist_item_disabled_get() to get the disabled state.
16319 * In general to indicate how the genlist should expand items horizontally to
16320 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16321 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16322 * mode means that if items are too wide to fit, the scroller will scroll
16323 * horizontally. Otherwise items are expanded to fill the width of the
16324 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16325 * to the viewport width and limited to that size. This can be combined with
16326 * a different style that uses edjes' ellipsis feature (cutting text off like
16329 * Items will only call their selection func and callback when first becoming
16330 * selected. Any further clicks will do nothing, unless you enable always
16331 * select with elm_genlist_always_select_mode_set(). This means even if
16332 * selected, every click will make the selected callbacks be called.
16333 * elm_genlist_no_select_mode_set() will turn off the ability to select
16334 * items entirely and they will neither appear selected nor call selected
16335 * callback functions.
16337 * Remember that you can create new styles and add your own theme augmentation
16338 * per application with elm_theme_extension_add(). If you absolutely must
16339 * have a specific style that overrides any theme the user or system sets up
16340 * you can use elm_theme_overlay_add() to add such a file.
16342 * @section Genlist_Implementation Implementation
16344 * Evas tracks every object you create. Every time it processes an event
16345 * (mouse move, down, up etc.) it needs to walk through objects and find out
16346 * what event that affects. Even worse every time it renders display updates,
16347 * in order to just calculate what to re-draw, it needs to walk through many
16348 * many many objects. Thus, the more objects you keep active, the more
16349 * overhead Evas has in just doing its work. It is advisable to keep your
16350 * active objects to the minimum working set you need. Also remember that
16351 * object creation and deletion carries an overhead, so there is a
16352 * middle-ground, which is not easily determined. But don't keep massive lists
16353 * of objects you can't see or use. Genlist does this with list objects. It
16354 * creates and destroys them dynamically as you scroll around. It groups them
16355 * into blocks so it can determine the visibility etc. of a whole block at
16356 * once as opposed to having to walk the whole list. This 2-level list allows
16357 * for very large numbers of items to be in the list (tests have used up to
16358 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16359 * may be different sizes, every item added needs to be calculated as to its
16360 * size and thus this presents a lot of overhead on populating the list, this
16361 * genlist employs a queue. Any item added is queued and spooled off over
16362 * time, actually appearing some time later, so if your list has many members
16363 * you may find it takes a while for them to all appear, with your process
16364 * consuming a lot of CPU while it is busy spooling.
16366 * Genlist also implements a tree structure, but it does so with callbacks to
16367 * the application, with the application filling in tree structures when
16368 * requested (allowing for efficient building of a very deep tree that could
16369 * even be used for file-management). See the above smart signal callbacks for
16372 * @section Genlist_Smart_Events Genlist smart events
16374 * Signals that you can add callbacks for are:
16375 * - @c "activated" - The user has double-clicked or pressed
16376 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16377 * item that was activated.
16378 * - @c "clicked,double" - The user has double-clicked an item. The @c
16379 * event_info parameter is the item that was double-clicked.
16380 * - @c "selected" - This is called when a user has made an item selected.
16381 * The event_info parameter is the genlist item that was selected.
16382 * - @c "unselected" - This is called when a user has made an item
16383 * unselected. The event_info parameter is the genlist item that was
16385 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16386 * called and the item is now meant to be expanded. The event_info
16387 * parameter is the genlist item that was indicated to expand. It is the
16388 * job of this callback to then fill in the child items.
16389 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16390 * called and the item is now meant to be contracted. The event_info
16391 * parameter is the genlist item that was indicated to contract. It is the
16392 * job of this callback to then delete the child items.
16393 * - @c "expand,request" - This is called when a user has indicated they want
16394 * to expand a tree branch item. The callback should decide if the item can
16395 * expand (has any children) and then call elm_genlist_item_expanded_set()
16396 * appropriately to set the state. The event_info parameter is the genlist
16397 * item that was indicated to expand.
16398 * - @c "contract,request" - This is called when a user has indicated they
16399 * want to contract a tree branch item. The callback should decide if the
16400 * item can contract (has any children) and then call
16401 * elm_genlist_item_expanded_set() appropriately to set the state. The
16402 * event_info parameter is the genlist item that was indicated to contract.
16403 * - @c "realized" - This is called when the item in the list is created as a
16404 * real evas object. event_info parameter is the genlist item that was
16405 * created. The object may be deleted at any time, so it is up to the
16406 * caller to not use the object pointer from elm_genlist_item_object_get()
16407 * in a way where it may point to freed objects.
16408 * - @c "unrealized" - This is called just before an item is unrealized.
16409 * After this call icon objects provided will be deleted and the item
16410 * object itself delete or be put into a floating cache.
16411 * - @c "drag,start,up" - This is called when the item in the list has been
16412 * dragged (not scrolled) up.
16413 * - @c "drag,start,down" - This is called when the item in the list has been
16414 * dragged (not scrolled) down.
16415 * - @c "drag,start,left" - This is called when the item in the list has been
16416 * dragged (not scrolled) left.
16417 * - @c "drag,start,right" - This is called when the item in the list has
16418 * been dragged (not scrolled) right.
16419 * - @c "drag,stop" - This is called when the item in the list has stopped
16421 * - @c "drag" - This is called when the item in the list is being dragged.
16422 * - @c "longpressed" - This is called when the item is pressed for a certain
16423 * amount of time. By default it's 1 second.
16424 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16426 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16427 * until the bottom edge.
16428 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16429 * until the left edge.
16430 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16431 * until the right edge.
16432 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16434 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16436 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16438 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16440 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16441 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16442 * multi-touch pinched in.
16443 * - @c "swipe" - This is called when the genlist is swiped.
16445 * @section Genlist_Examples Examples
16447 * Here is a list of examples that use the genlist, trying to show some of
16448 * its capabilities:
16449 * - @ref genlist_example_01
16450 * - @ref genlist_example_02
16451 * - @ref genlist_example_03
16452 * - @ref genlist_example_04
16453 * - @ref genlist_example_05
16457 * @addtogroup Genlist
16462 * @enum _Elm_Genlist_Item_Flags
16463 * @typedef Elm_Genlist_Item_Flags
16465 * Defines if the item is of any special type (has subitems or it's the
16466 * index of a group), or is just a simple item.
16470 typedef enum _Elm_Genlist_Item_Flags
16472 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16473 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16474 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16475 } Elm_Genlist_Item_Flags;
16476 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16477 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16478 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16479 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16480 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. */
16481 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. */
16482 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16483 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16485 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16486 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16487 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16488 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16491 * @struct _Elm_Genlist_Item_Class
16493 * Genlist item class definition structs.
16495 * This struct contains the style and fetching functions that will define the
16496 * contents of each item.
16498 * @see @ref Genlist_Item_Class
16500 struct _Elm_Genlist_Item_Class
16502 const char *item_style; /**< style of this class. */
16505 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16506 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16507 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16508 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16509 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16511 const char *mode_item_style;
16515 * Add a new genlist widget to the given parent Elementary
16516 * (container) object
16518 * @param parent The parent object
16519 * @return a new genlist widget handle or @c NULL, on errors
16521 * This function inserts a new genlist widget on the canvas.
16523 * @see elm_genlist_item_append()
16524 * @see elm_genlist_item_del()
16525 * @see elm_genlist_clear()
16529 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16531 * Remove all items from a given genlist widget.
16533 * @param obj The genlist object
16535 * This removes (and deletes) all items in @p obj, leaving it empty.
16537 * @see elm_genlist_item_del(), to remove just one item.
16541 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16543 * Enable or disable multi-selection in the genlist
16545 * @param obj The genlist object
16546 * @param multi Multi-select enable/disable. Default is disabled.
16548 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16549 * the list. This allows more than 1 item to be selected. To retrieve the list
16550 * of selected items, use elm_genlist_selected_items_get().
16552 * @see elm_genlist_selected_items_get()
16553 * @see elm_genlist_multi_select_get()
16557 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16559 * Gets if multi-selection in genlist is enabled or disabled.
16561 * @param obj The genlist object
16562 * @return Multi-select enabled/disabled
16563 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16565 * @see elm_genlist_multi_select_set()
16569 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16571 * This sets the horizontal stretching mode.
16573 * @param obj The genlist object
16574 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16576 * This sets the mode used for sizing items horizontally. Valid modes
16577 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16578 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16579 * the scroller will scroll horizontally. Otherwise items are expanded
16580 * to fill the width of the viewport of the scroller. If it is
16581 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16582 * limited to that size.
16584 * @see elm_genlist_horizontal_get()
16588 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16589 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16591 * Gets the horizontal stretching mode.
16593 * @param obj The genlist object
16594 * @return The mode to use
16595 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16597 * @see elm_genlist_horizontal_set()
16601 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16602 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16604 * Set the always select mode.
16606 * @param obj The genlist object
16607 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16608 * EINA_FALSE = off). Default is @c EINA_FALSE.
16610 * Items will only call their selection func and callback when first
16611 * becoming selected. Any further clicks will do nothing, unless you
16612 * enable always select with elm_genlist_always_select_mode_set().
16613 * This means that, even if selected, every click will make the selected
16614 * callbacks be called.
16616 * @see elm_genlist_always_select_mode_get()
16620 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16622 * Get the always select mode.
16624 * @param obj The genlist object
16625 * @return The always select mode
16626 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16628 * @see elm_genlist_always_select_mode_set()
16632 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16634 * Enable/disable the no select mode.
16636 * @param obj The genlist object
16637 * @param no_select The no select mode
16638 * (EINA_TRUE = on, EINA_FALSE = off)
16640 * This will turn off the ability to select items entirely and they
16641 * will neither appear selected nor call selected callback functions.
16643 * @see elm_genlist_no_select_mode_get()
16647 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16649 * Gets whether the no select mode is enabled.
16651 * @param obj The genlist object
16652 * @return The no select mode
16653 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16655 * @see elm_genlist_no_select_mode_set()
16659 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16661 * Enable/disable compress mode.
16663 * @param obj The genlist object
16664 * @param compress The compress mode
16665 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16667 * This will enable the compress mode where items are "compressed"
16668 * horizontally to fit the genlist scrollable viewport width. This is
16669 * special for genlist. Do not rely on
16670 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16671 * work as genlist needs to handle it specially.
16673 * @see elm_genlist_compress_mode_get()
16677 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16679 * Get whether the compress mode is enabled.
16681 * @param obj The genlist object
16682 * @return The compress mode
16683 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16685 * @see elm_genlist_compress_mode_set()
16689 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16691 * Enable/disable height-for-width mode.
16693 * @param obj The genlist object
16694 * @param setting The height-for-width mode (@c EINA_TRUE = on,
16695 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16697 * With height-for-width mode the item width will be fixed (restricted
16698 * to a minimum of) to the list width when calculating its size in
16699 * order to allow the height to be calculated based on it. This allows,
16700 * for instance, text block to wrap lines if the Edje part is
16701 * configured with "text.min: 0 1".
16703 * @note This mode will make list resize slower as it will have to
16704 * recalculate every item height again whenever the list width
16707 * @note When height-for-width mode is enabled, it also enables
16708 * compress mode (see elm_genlist_compress_mode_set()) and
16709 * disables homogeneous (see elm_genlist_homogeneous_set()).
16713 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16715 * Get whether the height-for-width mode is enabled.
16717 * @param obj The genlist object
16718 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16723 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16725 * Enable/disable horizontal and vertical bouncing effect.
16727 * @param obj The genlist object
16728 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16729 * EINA_FALSE = off). Default is @c EINA_FALSE.
16730 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16731 * EINA_FALSE = off). Default is @c EINA_TRUE.
16733 * This will enable or disable the scroller bouncing effect for the
16734 * genlist. See elm_scroller_bounce_set() for details.
16736 * @see elm_scroller_bounce_set()
16737 * @see elm_genlist_bounce_get()
16741 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16743 * Get whether the horizontal and vertical bouncing effect is enabled.
16745 * @param obj The genlist object
16746 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16748 * @param v_bounce Pointer to a bool to receive if the bounce vertically
16751 * @see elm_genlist_bounce_set()
16755 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16757 * Enable/disable homogenous mode.
16759 * @param obj The genlist object
16760 * @param homogeneous Assume the items within the genlist are of the
16761 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16764 * This will enable the homogeneous mode where items are of the same
16765 * height and width so that genlist may do the lazy-loading at its
16766 * maximum (which increases the performance for scrolling the list). This
16767 * implies 'compressed' mode.
16769 * @see elm_genlist_compress_mode_set()
16770 * @see elm_genlist_homogeneous_get()
16774 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16776 * Get whether the homogenous mode is enabled.
16778 * @param obj The genlist object
16779 * @return Assume the items within the genlist are of the same height
16780 * and width (EINA_TRUE = on, EINA_FALSE = off)
16782 * @see elm_genlist_homogeneous_set()
16786 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16788 * Set the maximum number of items within an item block
16790 * @param obj The genlist object
16791 * @param n Maximum number of items within an item block. Default is 32.
16793 * This will configure the block count to tune to the target with
16794 * particular performance matrix.
16796 * A block of objects will be used to reduce the number of operations due to
16797 * many objects in the screen. It can determine the visibility, or if the
16798 * object has changed, it theme needs to be updated, etc. doing this kind of
16799 * calculation to the entire block, instead of per object.
16801 * The default value for the block count is enough for most lists, so unless
16802 * you know you will have a lot of objects visible in the screen at the same
16803 * time, don't try to change this.
16805 * @see elm_genlist_block_count_get()
16806 * @see @ref Genlist_Implementation
16810 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
16812 * Get the maximum number of items within an item block
16814 * @param obj The genlist object
16815 * @return Maximum number of items within an item block
16817 * @see elm_genlist_block_count_set()
16821 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16823 * Set the timeout in seconds for the longpress event.
16825 * @param obj The genlist object
16826 * @param timeout timeout in seconds. Default is 1.
16828 * This option will change how long it takes to send an event "longpressed"
16829 * after the mouse down signal is sent to the list. If this event occurs, no
16830 * "clicked" event will be sent.
16832 * @see elm_genlist_longpress_timeout_set()
16836 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16838 * Get the timeout in seconds for the longpress event.
16840 * @param obj The genlist object
16841 * @return timeout in seconds
16843 * @see elm_genlist_longpress_timeout_get()
16847 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16849 * Append a new item in a given genlist widget.
16851 * @param obj The genlist object
16852 * @param itc The item class for the item
16853 * @param data The item data
16854 * @param parent The parent item, or NULL if none
16855 * @param flags Item flags
16856 * @param func Convenience function called when the item is selected
16857 * @param func_data Data passed to @p func above.
16858 * @return A handle to the item added or @c NULL if not possible
16860 * This adds the given item to the end of the list or the end of
16861 * the children list if the @p parent is given.
16863 * @see elm_genlist_item_prepend()
16864 * @see elm_genlist_item_insert_before()
16865 * @see elm_genlist_item_insert_after()
16866 * @see elm_genlist_item_del()
16870 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);
16872 * Prepend a new item in a given genlist widget.
16874 * @param obj The genlist object
16875 * @param itc The item class for the item
16876 * @param data The item data
16877 * @param parent The parent item, or NULL if none
16878 * @param flags Item flags
16879 * @param func Convenience function called when the item is selected
16880 * @param func_data Data passed to @p func above.
16881 * @return A handle to the item added or NULL if not possible
16883 * This adds an item to the beginning of the list or beginning of the
16884 * children of the parent if given.
16886 * @see elm_genlist_item_append()
16887 * @see elm_genlist_item_insert_before()
16888 * @see elm_genlist_item_insert_after()
16889 * @see elm_genlist_item_del()
16893 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);
16895 * Insert an item before another in a genlist widget
16897 * @param obj The genlist object
16898 * @param itc The item class for the item
16899 * @param data The item data
16900 * @param before The item to place this new one before.
16901 * @param flags Item flags
16902 * @param func Convenience function called when the item is selected
16903 * @param func_data Data passed to @p func above.
16904 * @return A handle to the item added or @c NULL if not possible
16906 * This inserts an item before another in the list. It will be in the
16907 * same tree level or group as the item it is inserted before.
16909 * @see elm_genlist_item_append()
16910 * @see elm_genlist_item_prepend()
16911 * @see elm_genlist_item_insert_after()
16912 * @see elm_genlist_item_del()
16916 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);
16918 * Insert an item after another in a genlist widget
16920 * @param obj The genlist object
16921 * @param itc The item class for the item
16922 * @param data The item data
16923 * @param after The item to place this new one after.
16924 * @param flags Item flags
16925 * @param func Convenience function called when the item is selected
16926 * @param func_data Data passed to @p func above.
16927 * @return A handle to the item added or @c NULL if not possible
16929 * This inserts an item after another in the list. It will be in the
16930 * same tree level or group as the item it is inserted after.
16932 * @see elm_genlist_item_append()
16933 * @see elm_genlist_item_prepend()
16934 * @see elm_genlist_item_insert_before()
16935 * @see elm_genlist_item_del()
16939 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);
16941 * Insert a new item into the sorted genlist object
16943 * @param obj The genlist object
16944 * @param itc The item class for the item
16945 * @param data The item data
16946 * @param parent The parent item, or NULL if none
16947 * @param flags Item flags
16948 * @param comp The function called for the sort
16949 * @param func Convenience function called when item selected
16950 * @param func_data Data passed to @p func above.
16951 * @return A handle to the item added or NULL if not possible
16955 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);
16956 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);
16957 /* operations to retrieve existing items */
16959 * Get the selectd item in the genlist.
16961 * @param obj The genlist object
16962 * @return The selected item, or NULL if none is selected.
16964 * This gets the selected item in the list (if multi-selection is enabled, only
16965 * the item that was first selected in the list is returned - which is not very
16966 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
16969 * If no item is selected, NULL is returned.
16971 * @see elm_genlist_selected_items_get()
16975 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16977 * Get a list of selected items in the genlist.
16979 * @param obj The genlist object
16980 * @return The list of selected items, or NULL if none are selected.
16982 * It returns a list of the selected items. This list pointer is only valid so
16983 * long as the selection doesn't change (no items are selected or unselected, or
16984 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
16985 * pointers. The order of the items in this list is the order which they were
16986 * selected, i.e. the first item in this list is the first item that was
16987 * selected, and so on.
16989 * @note If not in multi-select mode, consider using function
16990 * elm_genlist_selected_item_get() instead.
16992 * @see elm_genlist_multi_select_set()
16993 * @see elm_genlist_selected_item_get()
16997 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16999 * Get a list of realized items in genlist
17001 * @param obj The genlist object
17002 * @return The list of realized items, nor NULL if none are realized.
17004 * This returns a list of the realized items in the genlist. The list
17005 * contains Elm_Genlist_Item pointers. The list must be freed by the
17006 * caller when done with eina_list_free(). The item pointers in the
17007 * list are only valid so long as those items are not deleted or the
17008 * genlist is not deleted.
17010 * @see elm_genlist_realized_items_update()
17014 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17016 * Get the item that is at the x, y canvas coords.
17018 * @param obj The gelinst object.
17019 * @param x The input x coordinate
17020 * @param y The input y coordinate
17021 * @param posret The position relative to the item returned here
17022 * @return The item at the coordinates or NULL if none
17024 * This returns the item at the given coordinates (which are canvas
17025 * relative, not object-relative). If an item is at that coordinate,
17026 * that item handle is returned, and if @p posret is not NULL, the
17027 * integer pointed to is set to a value of -1, 0 or 1, depending if
17028 * the coordinate is on the upper portion of that item (-1), on the
17029 * middle section (0) or on the lower part (1). If NULL is returned as
17030 * an item (no item found there), then posret may indicate -1 or 1
17031 * based if the coordinate is above or below all items respectively in
17036 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);
17038 * Get the first item in the genlist
17040 * This returns the first item in the list.
17042 * @param obj The genlist object
17043 * @return The first item, or NULL if none
17047 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17049 * Get the last item in the genlist
17051 * This returns the last item in the list.
17053 * @return The last item, or NULL if none
17057 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17059 * Set the scrollbar policy
17061 * @param obj The genlist object
17062 * @param policy_h Horizontal scrollbar policy.
17063 * @param policy_v Vertical scrollbar policy.
17065 * This sets the scrollbar visibility policy for the given genlist
17066 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17067 * made visible if it is needed, and otherwise kept hidden.
17068 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17069 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17070 * respectively for the horizontal and vertical scrollbars. Default is
17071 * #ELM_SMART_SCROLLER_POLICY_AUTO
17073 * @see elm_genlist_scroller_policy_get()
17077 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17079 * Get the scrollbar policy
17081 * @param obj The genlist object
17082 * @param policy_h Pointer to store the horizontal scrollbar policy.
17083 * @param policy_v Pointer to store the vertical scrollbar policy.
17085 * @see elm_genlist_scroller_policy_set()
17089 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);
17091 * Get the @b next item in a genlist widget's internal list of items,
17092 * given a handle to one of those items.
17094 * @param item The genlist item to fetch next from
17095 * @return The item after @p item, or @c NULL if there's none (and
17098 * This returns the item placed after the @p item, on the container
17101 * @see elm_genlist_item_prev_get()
17105 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17107 * Get the @b previous item in a genlist widget's internal list of items,
17108 * given a handle to one of those items.
17110 * @param item The genlist item to fetch previous from
17111 * @return The item before @p item, or @c NULL if there's none (and
17114 * This returns the item placed before the @p item, on the container
17117 * @see elm_genlist_item_next_get()
17121 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17123 * Get the genlist object's handle which contains a given genlist
17126 * @param item The item to fetch the container from
17127 * @return The genlist (parent) object
17129 * This returns the genlist object itself that an item belongs to.
17133 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17135 * Get the parent item of the given item
17137 * @param it The item
17138 * @return The parent of the item or @c NULL if it has no parent.
17140 * This returns the item that was specified as parent of the item @p it on
17141 * elm_genlist_item_append() and insertion related functions.
17145 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17147 * Remove all sub-items (children) of the given item
17149 * @param it The item
17151 * This removes all items that are children (and their descendants) of the
17152 * given item @p it.
17154 * @see elm_genlist_clear()
17155 * @see elm_genlist_item_del()
17159 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17161 * Set whether a given genlist item is selected or not
17163 * @param it The item
17164 * @param selected Use @c EINA_TRUE, to make it selected, @c
17165 * EINA_FALSE to make it unselected
17167 * This sets the selected state of an item. If multi selection is
17168 * not enabled on the containing genlist and @p selected is @c
17169 * EINA_TRUE, any other previously selected items will get
17170 * unselected in favor of this new one.
17172 * @see elm_genlist_item_selected_get()
17176 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17178 * Get whether a given genlist item is selected or not
17180 * @param it The item
17181 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17183 * @see elm_genlist_item_selected_set() for more details
17187 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17189 * Sets the expanded state of an item.
17191 * @param it The item
17192 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17194 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17197 * The theme will respond to this change visually, and a signal "expanded" or
17198 * "contracted" will be sent from the genlist with a pointer to the item that
17199 * has been expanded/contracted.
17201 * Calling this function won't show or hide any child of this item (if it is
17202 * a parent). You must manually delete and create them on the callbacks fo
17203 * the "expanded" or "contracted" signals.
17205 * @see elm_genlist_item_expanded_get()
17209 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17211 * Get the expanded state of an item
17213 * @param it The item
17214 * @return The expanded state
17216 * This gets the expanded state of an item.
17218 * @see elm_genlist_item_expanded_set()
17222 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17224 * Get the depth of expanded item
17226 * @param it The genlist item object
17227 * @return The depth of expanded item
17231 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17233 * Set whether a given genlist item is disabled or not.
17235 * @param it The item
17236 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17237 * to enable it back.
17239 * A disabled item cannot be selected or unselected. It will also
17240 * change its appearance, to signal the user it's disabled.
17242 * @see elm_genlist_item_disabled_get()
17246 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17248 * Get whether a given genlist item is disabled or not.
17250 * @param it The item
17251 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17254 * @see elm_genlist_item_disabled_set() for more details
17258 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17260 * Sets the display only state of an item.
17262 * @param it The item
17263 * @param display_only @c EINA_TRUE if the item is display only, @c
17264 * EINA_FALSE otherwise.
17266 * A display only item cannot be selected or unselected. It is for
17267 * display only and not selecting or otherwise clicking, dragging
17268 * etc. by the user, thus finger size rules will not be applied to
17271 * It's good to set group index items to display only state.
17273 * @see elm_genlist_item_display_only_get()
17277 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17279 * Get the display only state of an item
17281 * @param it The item
17282 * @return @c EINA_TRUE if the item is display only, @c
17283 * EINA_FALSE otherwise.
17285 * @see elm_genlist_item_display_only_set()
17289 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17291 * Show the portion of a genlist's internal list containing a given
17292 * item, immediately.
17294 * @param it The item to display
17296 * This causes genlist to jump to the given item @p it and show it (by
17297 * immediately scrolling to that position), if it is not fully visible.
17299 * @see elm_genlist_item_bring_in()
17300 * @see elm_genlist_item_top_show()
17301 * @see elm_genlist_item_middle_show()
17305 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17307 * Animatedly bring in, to the visible are of a genlist, a given
17310 * @param it The item to display
17312 * This causes genlist to jump to the given item @p it and show it (by
17313 * animatedly scrolling), if it is not fully visible. This may use animation
17314 * to do so and take a period of time
17316 * @see elm_genlist_item_show()
17317 * @see elm_genlist_item_top_bring_in()
17318 * @see elm_genlist_item_middle_bring_in()
17322 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17324 * Show the portion of a genlist's internal list containing a given
17325 * item, immediately.
17327 * @param it The item to display
17329 * This causes genlist to jump to the given item @p it and show it (by
17330 * immediately scrolling to that position), if it is not fully visible.
17332 * The item will be positioned at the top of the genlist viewport.
17334 * @see elm_genlist_item_show()
17335 * @see elm_genlist_item_top_bring_in()
17339 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17341 * Animatedly bring in, to the visible are of a genlist, a given
17344 * @param it The item
17346 * This causes genlist to jump to the given item @p it and show it (by
17347 * animatedly scrolling), if it is not fully visible. This may use animation
17348 * to do so and take a period of time
17350 * The item will be positioned at the top of the genlist viewport.
17352 * @see elm_genlist_item_bring_in()
17353 * @see elm_genlist_item_top_show()
17357 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17359 * Show the portion of a genlist's internal list containing a given
17360 * item, immediately.
17362 * @param it The item to display
17364 * This causes genlist to jump to the given item @p it and show it (by
17365 * immediately scrolling to that position), if it is not fully visible.
17367 * The item will be positioned at the middle of the genlist viewport.
17369 * @see elm_genlist_item_show()
17370 * @see elm_genlist_item_middle_bring_in()
17374 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17376 * Animatedly bring in, to the visible are of a genlist, a given
17379 * @param it The item
17381 * This causes genlist to jump to the given item @p it and show it (by
17382 * animatedly scrolling), if it is not fully visible. This may use animation
17383 * to do so and take a period of time
17385 * The item will be positioned at the middle of the genlist viewport.
17387 * @see elm_genlist_item_bring_in()
17388 * @see elm_genlist_item_middle_show()
17392 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17394 * Remove a genlist item from the its parent, deleting it.
17396 * @param item The item to be removed.
17397 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17399 * @see elm_genlist_clear(), to remove all items in a genlist at
17404 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17406 * Return the data associated to a given genlist item
17408 * @param item The genlist item.
17409 * @return the data associated to this item.
17411 * This returns the @c data value passed on the
17412 * elm_genlist_item_append() and related item addition calls.
17414 * @see elm_genlist_item_append()
17415 * @see elm_genlist_item_data_set()
17419 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17421 * Set the data associated to a given genlist item
17423 * @param item The genlist item
17424 * @param data The new data pointer to set on it
17426 * This @b overrides the @c data value passed on the
17427 * elm_genlist_item_append() and related item addition calls. This
17428 * function @b won't call elm_genlist_item_update() automatically,
17429 * so you'd issue it afterwards if you want to hove the item
17430 * updated to reflect the that new data.
17432 * @see elm_genlist_item_data_get()
17436 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17438 * Tells genlist to "orphan" icons fetchs by the item class
17440 * @param it The item
17442 * This instructs genlist to release references to icons in the item,
17443 * meaning that they will no longer be managed by genlist and are
17444 * floating "orphans" that can be re-used elsewhere if the user wants
17449 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17451 * Get the real Evas object created to implement the view of a
17452 * given genlist item
17454 * @param item The genlist item.
17455 * @return the Evas object implementing this item's view.
17457 * This returns the actual Evas object used to implement the
17458 * specified genlist item's view. This may be @c NULL, as it may
17459 * not have been created or may have been deleted, at any time, by
17460 * the genlist. <b>Do not modify this object</b> (move, resize,
17461 * show, hide, etc.), as the genlist is controlling it. This
17462 * function is for querying, emitting custom signals or hooking
17463 * lower level callbacks for events on that object. Do not delete
17464 * this object under any circumstances.
17466 * @see elm_genlist_item_data_get()
17470 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17472 * Update the contents of an item
17474 * @param it The item
17476 * This updates an item by calling all the item class functions again
17477 * to get the icons, labels and states. Use this when the original
17478 * item data has changed and the changes are desired to be reflected.
17480 * Use elm_genlist_realized_items_update() to update all already realized
17483 * @see elm_genlist_realized_items_update()
17487 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17489 * Update the item class of an item
17491 * @param it The item
17492 * @param itc The item class for the item
17494 * This sets another class fo the item, changing the way that it is
17495 * displayed. After changing the item class, elm_genlist_item_update() is
17496 * called on the item @p it.
17500 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17501 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17503 * Set the text to be shown in a given genlist item's tooltips.
17505 * @param item The genlist item
17506 * @param text The text to set in the content
17508 * This call will setup the text to be used as tooltip to that item
17509 * (analogous to elm_object_tooltip_text_set(), but being item
17510 * tooltips with higher precedence than object tooltips). It can
17511 * have only one tooltip at a time, so any previous tooltip data
17512 * will get removed.
17514 * In order to set an icon or something else as a tooltip, look at
17515 * elm_genlist_item_tooltip_content_cb_set().
17519 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17521 * Set the content to be shown in a given genlist item's tooltips
17523 * @param item The genlist item.
17524 * @param func The function returning the tooltip contents.
17525 * @param data What to provide to @a func as callback data/context.
17526 * @param del_cb Called when data is not needed anymore, either when
17527 * another callback replaces @p func, the tooltip is unset with
17528 * elm_genlist_item_tooltip_unset() or the owner @p item
17529 * dies. This callback receives as its first parameter the
17530 * given @p data, being @c event_info the item handle.
17532 * This call will setup the tooltip's contents to @p item
17533 * (analogous to elm_object_tooltip_content_cb_set(), but being
17534 * item tooltips with higher precedence than object tooltips). It
17535 * can have only one tooltip at a time, so any previous tooltip
17536 * content will get removed. @p func (with @p data) will be called
17537 * every time Elementary needs to show the tooltip and it should
17538 * return a valid Evas object, which will be fully managed by the
17539 * tooltip system, getting deleted when the tooltip is gone.
17541 * In order to set just a text as a tooltip, look at
17542 * elm_genlist_item_tooltip_text_set().
17546 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);
17548 * Unset a tooltip from a given genlist item
17550 * @param item genlist item to remove a previously set tooltip from.
17552 * This call removes any tooltip set on @p item. The callback
17553 * provided as @c del_cb to
17554 * elm_genlist_item_tooltip_content_cb_set() will be called to
17555 * notify it is not used anymore (and have resources cleaned, if
17558 * @see elm_genlist_item_tooltip_content_cb_set()
17562 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17564 * Set a different @b style for a given genlist item's tooltip.
17566 * @param item genlist item with tooltip set
17567 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17568 * "default", @c "transparent", etc)
17570 * Tooltips can have <b>alternate styles</b> to be displayed on,
17571 * which are defined by the theme set on Elementary. This function
17572 * works analogously as elm_object_tooltip_style_set(), but here
17573 * applied only to genlist item objects. The default style for
17574 * tooltips is @c "default".
17576 * @note before you set a style you should define a tooltip with
17577 * elm_genlist_item_tooltip_content_cb_set() or
17578 * elm_genlist_item_tooltip_text_set()
17580 * @see elm_genlist_item_tooltip_style_get()
17584 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17586 * Get the style set a given genlist item's tooltip.
17588 * @param item genlist item with tooltip already set on.
17589 * @return style the theme style in use, which defaults to
17590 * "default". If the object does not have a tooltip set,
17591 * then @c NULL is returned.
17593 * @see elm_genlist_item_tooltip_style_set() for more details
17597 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17599 * @brief Disable size restrictions on an object's tooltip
17600 * @param item The tooltip's anchor object
17601 * @param disable If EINA_TRUE, size restrictions are disabled
17602 * @return EINA_FALSE on failure, EINA_TRUE on success
17604 * This function allows a tooltip to expand beyond its parant window's canvas.
17605 * It will instead be limited only by the size of the display.
17607 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17609 * @brief Retrieve size restriction state of an object's tooltip
17610 * @param item The tooltip's anchor object
17611 * @return If EINA_TRUE, size restrictions are disabled
17613 * This function returns whether a tooltip is allowed to expand beyond
17614 * its parant window's canvas.
17615 * It will instead be limited only by the size of the display.
17617 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17619 * Set the type of mouse pointer/cursor decoration to be shown,
17620 * when the mouse pointer is over the given genlist widget item
17622 * @param item genlist item to customize cursor on
17623 * @param cursor the cursor type's name
17625 * This function works analogously as elm_object_cursor_set(), but
17626 * here the cursor's changing area is restricted to the item's
17627 * area, and not the whole widget's. Note that that item cursors
17628 * have precedence over widget cursors, so that a mouse over @p
17629 * item will always show cursor @p type.
17631 * If this function is called twice for an object, a previously set
17632 * cursor will be unset on the second call.
17634 * @see elm_object_cursor_set()
17635 * @see elm_genlist_item_cursor_get()
17636 * @see elm_genlist_item_cursor_unset()
17640 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17642 * Get the type of mouse pointer/cursor decoration set to be shown,
17643 * when the mouse pointer is over the given genlist widget item
17645 * @param item genlist item with custom cursor set
17646 * @return the cursor type's name or @c NULL, if no custom cursors
17647 * were set to @p item (and on errors)
17649 * @see elm_object_cursor_get()
17650 * @see elm_genlist_item_cursor_set() for more details
17651 * @see elm_genlist_item_cursor_unset()
17655 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17657 * Unset any custom mouse pointer/cursor decoration set to be
17658 * shown, when the mouse pointer is over the given genlist widget
17659 * item, thus making it show the @b default cursor again.
17661 * @param item a genlist item
17663 * Use this call to undo any custom settings on this item's cursor
17664 * decoration, bringing it back to defaults (no custom style set).
17666 * @see elm_object_cursor_unset()
17667 * @see elm_genlist_item_cursor_set() for more details
17671 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17673 * Set a different @b style for a given custom cursor set for a
17676 * @param item genlist item with custom cursor set
17677 * @param style the <b>theme style</b> to use (e.g. @c "default",
17678 * @c "transparent", etc)
17680 * This function only makes sense when one is using custom mouse
17681 * cursor decorations <b>defined in a theme file</b> , which can
17682 * have, given a cursor name/type, <b>alternate styles</b> on
17683 * it. It works analogously as elm_object_cursor_style_set(), but
17684 * here applied only to genlist item objects.
17686 * @warning Before you set a cursor style you should have defined a
17687 * custom cursor previously on the item, with
17688 * elm_genlist_item_cursor_set()
17690 * @see elm_genlist_item_cursor_engine_only_set()
17691 * @see elm_genlist_item_cursor_style_get()
17695 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17697 * Get the current @b style set for a given genlist item's custom
17700 * @param item genlist item with custom cursor set.
17701 * @return style the cursor style in use. If the object does not
17702 * have a cursor set, then @c NULL is returned.
17704 * @see elm_genlist_item_cursor_style_set() for more details
17708 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17710 * Set if the (custom) cursor for a given genlist item should be
17711 * searched in its theme, also, or should only rely on the
17712 * rendering engine.
17714 * @param item item with custom (custom) cursor already set on
17715 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17716 * only on those provided by the rendering engine, @c EINA_FALSE to
17717 * have them searched on the widget's theme, as well.
17719 * @note This call is of use only if you've set a custom cursor
17720 * for genlist items, with elm_genlist_item_cursor_set().
17722 * @note By default, cursors will only be looked for between those
17723 * provided by the rendering engine.
17727 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17729 * Get if the (custom) cursor for a given genlist item is being
17730 * searched in its theme, also, or is only relying on the rendering
17733 * @param item a genlist item
17734 * @return @c EINA_TRUE, if cursors are being looked for only on
17735 * those provided by the rendering engine, @c EINA_FALSE if they
17736 * are being searched on the widget's theme, as well.
17738 * @see elm_genlist_item_cursor_engine_only_set(), for more details
17742 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17744 * Update the contents of all realized items.
17746 * @param obj The genlist object.
17748 * This updates all realized items by calling all the item class functions again
17749 * to get the icons, labels and states. Use this when the original
17750 * item data has changed and the changes are desired to be reflected.
17752 * To update just one item, use elm_genlist_item_update().
17754 * @see elm_genlist_realized_items_get()
17755 * @see elm_genlist_item_update()
17759 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17761 * Activate a genlist mode on an item
17763 * @param item The genlist item
17764 * @param mode Mode name
17765 * @param mode_set Boolean to define set or unset mode.
17767 * A genlist mode is a different way of selecting an item. Once a mode is
17768 * activated on an item, any other selected item is immediately unselected.
17769 * This feature provides an easy way of implementing a new kind of animation
17770 * for selecting an item, without having to entirely rewrite the item style
17771 * theme. However, the elm_genlist_selected_* API can't be used to get what
17772 * item is activate for a mode.
17774 * The current item style will still be used, but applying a genlist mode to
17775 * an item will select it using a different kind of animation.
17777 * The current active item for a mode can be found by
17778 * elm_genlist_mode_item_get().
17780 * The characteristics of genlist mode are:
17781 * - Only one mode can be active at any time, and for only one item.
17782 * - Genlist handles deactivating other items when one item is activated.
17783 * - A mode is defined in the genlist theme (edc), and more modes can easily
17785 * - A mode style and the genlist item style are different things. They
17786 * can be combined to provide a default style to the item, with some kind
17787 * of animation for that item when the mode is activated.
17789 * When a mode is activated on an item, a new view for that item is created.
17790 * The theme of this mode defines the animation that will be used to transit
17791 * the item from the old view to the new view. This second (new) view will be
17792 * active for that item while the mode is active on the item, and will be
17793 * destroyed after the mode is totally deactivated from that item.
17795 * @see elm_genlist_mode_get()
17796 * @see elm_genlist_mode_item_get()
17800 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
17802 * Get the last (or current) genlist mode used.
17804 * @param obj The genlist object
17806 * This function just returns the name of the last used genlist mode. It will
17807 * be the current mode if it's still active.
17809 * @see elm_genlist_item_mode_set()
17810 * @see elm_genlist_mode_item_get()
17814 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17816 * Get active genlist mode item
17818 * @param obj The genlist object
17819 * @return The active item for that current mode. Or @c NULL if no item is
17820 * activated with any mode.
17822 * This function returns the item that was activated with a mode, by the
17823 * function elm_genlist_item_mode_set().
17825 * @see elm_genlist_item_mode_set()
17826 * @see elm_genlist_mode_get()
17830 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17835 * @param obj The genlist object
17836 * @param reorder_mode The reorder mode
17837 * (EINA_TRUE = on, EINA_FALSE = off)
17841 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
17844 * Get the reorder mode
17846 * @param obj The genlist object
17847 * @return The reorder mode
17848 * (EINA_TRUE = on, EINA_FALSE = off)
17852 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17859 * @defgroup Check Check
17861 * @image html img/widget/check/preview-00.png
17862 * @image latex img/widget/check/preview-00.eps
17863 * @image html img/widget/check/preview-01.png
17864 * @image latex img/widget/check/preview-01.eps
17865 * @image html img/widget/check/preview-02.png
17866 * @image latex img/widget/check/preview-02.eps
17868 * @brief The check widget allows for toggling a value between true and
17871 * Check objects are a lot like radio objects in layout and functionality
17872 * except they do not work as a group, but independently and only toggle the
17873 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
17874 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
17875 * returns the current state. For convenience, like the radio objects, you
17876 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
17877 * for it to modify.
17879 * Signals that you can add callbacks for are:
17880 * "changed" - This is called whenever the user changes the state of one of
17881 * the check object(event_info is NULL).
17883 * @ref tutorial_check should give you a firm grasp of how to use this widget.
17887 * @brief Add a new Check object
17889 * @param parent The parent object
17890 * @return The new object or NULL if it cannot be created
17892 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17894 * @brief Set the text label of the check object
17896 * @param obj The check object
17897 * @param label The text label string in UTF-8
17899 * @deprecated use elm_object_text_set() instead.
17901 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17903 * @brief Get the text label of the check object
17905 * @param obj The check object
17906 * @return The text label string in UTF-8
17908 * @deprecated use elm_object_text_get() instead.
17910 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17912 * @brief Set the icon object of the check object
17914 * @param obj The check object
17915 * @param icon The icon object
17917 * Once the icon object is set, a previously set one will be deleted.
17918 * If you want to keep that old content object, use the
17919 * elm_check_icon_unset() function.
17921 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17923 * @brief Get the icon object of the check object
17925 * @param obj The check object
17926 * @return The icon object
17928 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17930 * @brief Unset the icon used for the check object
17932 * @param obj The check object
17933 * @return The icon object that was being used
17935 * Unparent and return the icon object which was set for this widget.
17937 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17939 * @brief Set the on/off state of the check object
17941 * @param obj The check object
17942 * @param state The state to use (1 == on, 0 == off)
17944 * This sets the state of the check. If set
17945 * with elm_check_state_pointer_set() the state of that variable is also
17946 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
17948 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17950 * @brief Get the state of the check object
17952 * @param obj The check object
17953 * @return The boolean state
17955 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17957 * @brief Set a convenience pointer to a boolean to change
17959 * @param obj The check object
17960 * @param statep Pointer to the boolean to modify
17962 * This sets a pointer to a boolean, that, in addition to the check objects
17963 * state will also be modified directly. To stop setting the object pointed
17964 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
17965 * then when this is called, the check objects state will also be modified to
17966 * reflect the value of the boolean @p statep points to, just like calling
17967 * elm_check_state_set().
17969 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
17975 * @defgroup Radio Radio
17977 * @image html img/widget/radio/preview-00.png
17978 * @image latex img/widget/radio/preview-00.eps
17980 * @brief Radio is a widget that allows for 1 or more options to be displayed
17981 * and have the user choose only 1 of them.
17983 * A radio object contains an indicator, an optional Label and an optional
17984 * icon object. While it's possible to have a group of only one radio they,
17985 * are normally used in groups of 2 or more. To add a radio to a group use
17986 * elm_radio_group_add(). The radio object(s) will select from one of a set
17987 * of integer values, so any value they are configuring needs to be mapped to
17988 * a set of integers. To configure what value that radio object represents,
17989 * use elm_radio_state_value_set() to set the integer it represents. To set
17990 * the value the whole group(which one is currently selected) is to indicate
17991 * use elm_radio_value_set() on any group member, and to get the groups value
17992 * use elm_radio_value_get(). For convenience the radio objects are also able
17993 * to directly set an integer(int) to the value that is selected. To specify
17994 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
17995 * The radio objects will modify this directly. That implies the pointer must
17996 * point to valid memory for as long as the radio objects exist.
17998 * Signals that you can add callbacks for are:
17999 * @li changed - This is called whenever the user changes the state of one of
18000 * the radio objects within the group of radio objects that work together.
18002 * @ref tutorial_radio show most of this API in action.
18006 * @brief Add a new radio to the parent
18008 * @param parent The parent object
18009 * @return The new object or NULL if it cannot be created
18011 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18013 * @brief Set the text label of the radio object
18015 * @param obj The radio object
18016 * @param label The text label string in UTF-8
18018 * @deprecated use elm_object_text_set() instead.
18020 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18022 * @brief Get the text label of the radio object
18024 * @param obj The radio object
18025 * @return The text label string in UTF-8
18027 * @deprecated use elm_object_text_set() instead.
18029 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18031 * @brief Set the icon object of the radio object
18033 * @param obj The radio object
18034 * @param icon The icon object
18036 * Once the icon object is set, a previously set one will be deleted. If you
18037 * want to keep that old content object, use the elm_radio_icon_unset()
18040 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18042 * @brief Get the icon object of the radio object
18044 * @param obj The radio object
18045 * @return The icon object
18047 * @see elm_radio_icon_set()
18049 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18051 * @brief Unset the icon used for the radio object
18053 * @param obj The radio object
18054 * @return The icon object that was being used
18056 * Unparent and return the icon object which was set for this widget.
18058 * @see elm_radio_icon_set()
18060 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18062 * @brief Add this radio to a group of other radio objects
18064 * @param obj The radio object
18065 * @param group Any object whose group the @p obj is to join.
18067 * Radio objects work in groups. Each member should have a different integer
18068 * value assigned. In order to have them work as a group, they need to know
18069 * about each other. This adds the given radio object to the group of which
18070 * the group object indicated is a member.
18072 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18074 * @brief Set the integer value that this radio object represents
18076 * @param obj The radio object
18077 * @param value The value to use if this radio object is selected
18079 * This sets the value of the radio.
18081 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18083 * @brief Get the integer value that this radio object represents
18085 * @param obj The radio object
18086 * @return The value used if this radio object is selected
18088 * This gets the value of the radio.
18090 * @see elm_radio_value_set()
18092 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18094 * @brief Set the value of the radio.
18096 * @param obj The radio object
18097 * @param value The value to use for the group
18099 * This sets the value of the radio group and will also set the value if
18100 * pointed to, to the value supplied, but will not call any callbacks.
18102 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18104 * @brief Get the state of the radio object
18106 * @param obj The radio object
18107 * @return The integer state
18109 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18111 * @brief Set a convenience pointer to a integer to change
18113 * @param obj The radio object
18114 * @param valuep Pointer to the integer to modify
18116 * This sets a pointer to a integer, that, in addition to the radio objects
18117 * state will also be modified directly. To stop setting the object pointed
18118 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18119 * when this is called, the radio objects state will also be modified to
18120 * reflect the value of the integer valuep points to, just like calling
18121 * elm_radio_value_set().
18123 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18129 * @defgroup Pager Pager
18131 * @image html img/widget/pager/preview-00.png
18132 * @image latex img/widget/pager/preview-00.eps
18134 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18136 * The flipping between “pages” of objects is animated. All content in pager
18137 * is kept in a stack, the last content to be added will be on the top of the
18138 * stack(be visible).
18140 * Objects can be pushed or popped from the stack or deleted as normal.
18141 * Pushes and pops will animate (and a pop will delete the object once the
18142 * animation is finished). Any object already in the pager can be promoted to
18143 * the top(from its current stacking position) through the use of
18144 * elm_pager_content_promote(). Objects are pushed to the top with
18145 * elm_pager_content_push() and when the top item is no longer wanted, simply
18146 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18147 * object is no longer needed and is not the top item, just delete it as
18148 * normal. You can query which objects are the top and bottom with
18149 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18151 * Signals that you can add callbacks for are:
18152 * "hide,finished" - when the previous page is hided
18154 * This widget has the following styles available:
18157 * @li fade_translucide
18158 * @li fade_invisible
18159 * @note This styles affect only the flipping animations, the appearance when
18160 * not animating is unaffected by styles.
18162 * @ref tutorial_pager gives a good overview of the usage of the API.
18166 * Add a new pager to the parent
18168 * @param parent The parent object
18169 * @return The new object or NULL if it cannot be created
18173 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18175 * @brief Push an object to the top of the pager stack (and show it).
18177 * @param obj The pager object
18178 * @param content The object to push
18180 * The object pushed becomes a child of the pager, it will be controlled and
18181 * deleted when the pager is deleted.
18183 * @note If the content is already in the stack use
18184 * elm_pager_content_promote().
18185 * @warning Using this function on @p content already in the stack results in
18186 * undefined behavior.
18188 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18190 * @brief Pop the object that is on top of the stack
18192 * @param obj The pager object
18194 * This pops the object that is on the top(visible) of the pager, makes it
18195 * disappear, then deletes the object. The object that was underneath it on
18196 * the stack will become visible.
18198 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18200 * @brief Moves an object already in the pager stack to the top of the stack.
18202 * @param obj The pager object
18203 * @param content The object to promote
18205 * This will take the @p content and move it to the top of the stack as
18206 * if it had been pushed there.
18208 * @note If the content isn't already in the stack use
18209 * elm_pager_content_push().
18210 * @warning Using this function on @p content not already in the stack
18211 * results in undefined behavior.
18213 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18215 * @brief Return the object at the bottom of the pager stack
18217 * @param obj The pager object
18218 * @return The bottom object or NULL if none
18220 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18222 * @brief Return the object at the top of the pager stack
18224 * @param obj The pager object
18225 * @return The top object or NULL if none
18227 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18233 * @defgroup Slideshow Slideshow
18235 * @image html img/widget/slideshow/preview-00.png
18236 * @image latex img/widget/slideshow/preview-00.eps
18238 * This widget, as the name indicates, is a pre-made image
18239 * slideshow panel, with API functions acting on (child) image
18240 * items presentation. Between those actions, are:
18241 * - advance to next/previous image
18242 * - select the style of image transition animation
18243 * - set the exhibition time for each image
18244 * - start/stop the slideshow
18246 * The transition animations are defined in the widget's theme,
18247 * consequently new animations can be added without having to
18248 * update the widget's code.
18250 * @section Slideshow_Items Slideshow items
18252 * For slideshow items, just like for @ref Genlist "genlist" ones,
18253 * the user defines a @b classes, specifying functions that will be
18254 * called on the item's creation and deletion times.
18256 * The #Elm_Slideshow_Item_Class structure contains the following
18259 * - @c func.get - When an item is displayed, this function is
18260 * called, and it's where one should create the item object, de
18261 * facto. For example, the object can be a pure Evas image object
18262 * or an Elementary @ref Photocam "photocam" widget. See
18263 * #SlideshowItemGetFunc.
18264 * - @c func.del - When an item is no more displayed, this function
18265 * is called, where the user must delete any data associated to
18266 * the item. See #SlideshowItemDelFunc.
18268 * @section Slideshow_Caching Slideshow caching
18270 * The slideshow provides facilities to have items adjacent to the
18271 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18272 * you, so that the system does not have to decode image data
18273 * anymore at the time it has to actually switch images on its
18274 * viewport. The user is able to set the numbers of items to be
18275 * cached @b before and @b after the current item, in the widget's
18278 * Smart events one can add callbacks for are:
18280 * - @c "changed" - when the slideshow switches its view to a new
18283 * List of examples for the slideshow widget:
18284 * @li @ref slideshow_example
18288 * @addtogroup Slideshow
18292 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18293 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18294 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18295 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18296 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18299 * @struct _Elm_Slideshow_Item_Class
18301 * Slideshow item class definition. See @ref Slideshow_Items for
18304 struct _Elm_Slideshow_Item_Class
18306 struct _Elm_Slideshow_Item_Class_Func
18308 SlideshowItemGetFunc get;
18309 SlideshowItemDelFunc del;
18311 }; /**< #Elm_Slideshow_Item_Class member definitions */
18314 * Add a new slideshow widget to the given parent Elementary
18315 * (container) object
18317 * @param parent The parent object
18318 * @return A new slideshow widget handle or @c NULL, on errors
18320 * This function inserts a new slideshow widget on the canvas.
18322 * @ingroup Slideshow
18324 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18327 * Add (append) a new item in a given slideshow widget.
18329 * @param obj The slideshow object
18330 * @param itc The item class for the item
18331 * @param data The item's data
18332 * @return A handle to the item added or @c NULL, on errors
18334 * Add a new item to @p obj's internal list of items, appending it.
18335 * The item's class must contain the function really fetching the
18336 * image object to show for this item, which could be an Evas image
18337 * object or an Elementary photo, for example. The @p data
18338 * parameter is going to be passed to both class functions of the
18341 * @see #Elm_Slideshow_Item_Class
18342 * @see elm_slideshow_item_sorted_insert()
18344 * @ingroup Slideshow
18346 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18349 * Insert a new item into the given slideshow widget, using the @p func
18350 * function to sort items (by item handles).
18352 * @param obj The slideshow object
18353 * @param itc The item class for the item
18354 * @param data The item's data
18355 * @param func The comparing function to be used to sort slideshow
18356 * items <b>by #Elm_Slideshow_Item item handles</b>
18357 * @return Returns The slideshow item handle, on success, or
18358 * @c NULL, on errors
18360 * Add a new item to @p obj's internal list of items, in a position
18361 * determined by the @p func comparing function. The item's class
18362 * must contain the function really fetching the image object to
18363 * show for this item, which could be an Evas image object or an
18364 * Elementary photo, for example. The @p data parameter is going to
18365 * be passed to both class functions of the item.
18367 * @see #Elm_Slideshow_Item_Class
18368 * @see elm_slideshow_item_add()
18370 * @ingroup Slideshow
18372 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);
18375 * Display a given slideshow widget's item, programmatically.
18377 * @param obj The slideshow object
18378 * @param item The item to display on @p obj's viewport
18380 * The change between the current item and @p item will use the
18381 * transition @p obj is set to use (@see
18382 * elm_slideshow_transition_set()).
18384 * @ingroup Slideshow
18386 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18389 * Slide to the @b next item, in a given slideshow widget
18391 * @param obj The slideshow object
18393 * The sliding animation @p obj is set to use will be the
18394 * transition effect used, after this call is issued.
18396 * @note If the end of the slideshow's internal list of items is
18397 * reached, it'll wrap around to the list's beginning, again.
18399 * @ingroup Slideshow
18401 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18404 * Slide to the @b previous item, in a given slideshow widget
18406 * @param obj The slideshow object
18408 * The sliding animation @p obj is set to use will be the
18409 * transition effect used, after this call is issued.
18411 * @note If the beginning of the slideshow's internal list of items
18412 * is reached, it'll wrap around to the list's end, again.
18414 * @ingroup Slideshow
18416 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18419 * Returns the list of sliding transition/effect names available, for a
18420 * given slideshow widget.
18422 * @param obj The slideshow object
18423 * @return The list of transitions (list of @b stringshared strings
18426 * The transitions, which come from @p obj's theme, must be an EDC
18427 * data item named @c "transitions" on the theme file, with (prefix)
18428 * names of EDC programs actually implementing them.
18430 * The available transitions for slideshows on the default theme are:
18431 * - @c "fade" - the current item fades out, while the new one
18432 * fades in to the slideshow's viewport.
18433 * - @c "black_fade" - the current item fades to black, and just
18434 * then, the new item will fade in.
18435 * - @c "horizontal" - the current item slides horizontally, until
18436 * it gets out of the slideshow's viewport, while the new item
18437 * comes from the left to take its place.
18438 * - @c "vertical" - the current item slides vertically, until it
18439 * gets out of the slideshow's viewport, while the new item comes
18440 * from the bottom to take its place.
18441 * - @c "square" - the new item starts to appear from the middle of
18442 * the current one, but with a tiny size, growing until its
18443 * target (full) size and covering the old one.
18445 * @warning The stringshared strings get no new references
18446 * exclusive to the user grabbing the list, here, so if you'd like
18447 * to use them out of this call's context, you'd better @c
18448 * eina_stringshare_ref() them.
18450 * @see elm_slideshow_transition_set()
18452 * @ingroup Slideshow
18454 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18457 * Set the current slide transition/effect in use for a given
18460 * @param obj The slideshow object
18461 * @param transition The new transition's name string
18463 * If @p transition is implemented in @p obj's theme (i.e., is
18464 * contained in the list returned by
18465 * elm_slideshow_transitions_get()), this new sliding effect will
18466 * be used on the widget.
18468 * @see elm_slideshow_transitions_get() for more details
18470 * @ingroup Slideshow
18472 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18475 * Get the current slide transition/effect in use for a given
18478 * @param obj The slideshow object
18479 * @return The current transition's name
18481 * @see elm_slideshow_transition_set() for more details
18483 * @ingroup Slideshow
18485 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18488 * Set the interval between each image transition on a given
18489 * slideshow widget, <b>and start the slideshow, itself</b>
18491 * @param obj The slideshow object
18492 * @param timeout The new displaying timeout for images
18494 * After this call, the slideshow widget will start cycling its
18495 * view, sequentially and automatically, with the images of the
18496 * items it has. The time between each new image displayed is going
18497 * to be @p timeout, in @b seconds. If a different timeout was set
18498 * previously and an slideshow was in progress, it will continue
18499 * with the new time between transitions, after this call.
18501 * @note A value less than or equal to 0 on @p timeout will disable
18502 * the widget's internal timer, thus halting any slideshow which
18503 * could be happening on @p obj.
18505 * @see elm_slideshow_timeout_get()
18507 * @ingroup Slideshow
18509 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18512 * Get the interval set for image transitions on a given slideshow
18515 * @param obj The slideshow object
18516 * @return Returns the timeout set on it
18518 * @see elm_slideshow_timeout_set() for more details
18520 * @ingroup Slideshow
18522 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18525 * Set if, after a slideshow is started, for a given slideshow
18526 * widget, its items should be displayed cyclically or not.
18528 * @param obj The slideshow object
18529 * @param loop Use @c EINA_TRUE to make it cycle through items or
18530 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18533 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18534 * ignore what is set by this functions, i.e., they'll @b always
18535 * cycle through items. This affects only the "automatic"
18536 * slideshow, as set by elm_slideshow_timeout_set().
18538 * @see elm_slideshow_loop_get()
18540 * @ingroup Slideshow
18542 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18545 * Get if, after a slideshow is started, for a given slideshow
18546 * widget, its items are to be displayed cyclically or not.
18548 * @param obj The slideshow object
18549 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18550 * through or @c EINA_FALSE, otherwise
18552 * @see elm_slideshow_loop_set() for more details
18554 * @ingroup Slideshow
18556 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18559 * Remove all items from a given slideshow widget
18561 * @param obj The slideshow object
18563 * This removes (and deletes) all items in @p obj, leaving it
18566 * @see elm_slideshow_item_del(), to remove just one item.
18568 * @ingroup Slideshow
18570 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18573 * Get the internal list of items in a given slideshow widget.
18575 * @param obj The slideshow object
18576 * @return The list of items (#Elm_Slideshow_Item as data) or
18577 * @c NULL on errors.
18579 * This list is @b not to be modified in any way and must not be
18580 * freed. Use the list members with functions like
18581 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18583 * @warning This list is only valid until @p obj object's internal
18584 * items list is changed. It should be fetched again with another
18585 * call to this function when changes happen.
18587 * @ingroup Slideshow
18589 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18592 * Delete a given item from a slideshow widget.
18594 * @param item The slideshow item
18596 * @ingroup Slideshow
18598 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18601 * Return the data associated with a given slideshow item
18603 * @param item The slideshow item
18604 * @return Returns the data associated to this item
18606 * @ingroup Slideshow
18608 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18611 * Returns the currently displayed item, in a given slideshow widget
18613 * @param obj The slideshow object
18614 * @return A handle to the item being displayed in @p obj or
18615 * @c NULL, if none is (and on errors)
18617 * @ingroup Slideshow
18619 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18622 * Get the real Evas object created to implement the view of a
18623 * given slideshow item
18625 * @param item The slideshow item.
18626 * @return the Evas object implementing this item's view.
18628 * This returns the actual Evas object used to implement the
18629 * specified slideshow item's view. This may be @c NULL, as it may
18630 * not have been created or may have been deleted, at any time, by
18631 * the slideshow. <b>Do not modify this object</b> (move, resize,
18632 * show, hide, etc.), as the slideshow is controlling it. This
18633 * function is for querying, emitting custom signals or hooking
18634 * lower level callbacks for events on that object. Do not delete
18635 * this object under any circumstances.
18637 * @see elm_slideshow_item_data_get()
18639 * @ingroup Slideshow
18641 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18644 * Get the the item, in a given slideshow widget, placed at
18645 * position @p nth, in its internal items list
18647 * @param obj The slideshow object
18648 * @param nth The number of the item to grab a handle to (0 being
18650 * @return The item stored in @p obj at position @p nth or @c NULL,
18651 * if there's no item with that index (and on errors)
18653 * @ingroup Slideshow
18655 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18658 * Set the current slide layout in use for a given slideshow widget
18660 * @param obj The slideshow object
18661 * @param layout The new layout's name string
18663 * If @p layout is implemented in @p obj's theme (i.e., is contained
18664 * in the list returned by elm_slideshow_layouts_get()), this new
18665 * images layout will be used on the widget.
18667 * @see elm_slideshow_layouts_get() for more details
18669 * @ingroup Slideshow
18671 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18674 * Get the current slide layout in use for a given slideshow widget
18676 * @param obj The slideshow object
18677 * @return The current layout's name
18679 * @see elm_slideshow_layout_set() for more details
18681 * @ingroup Slideshow
18683 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18686 * Returns the list of @b layout names available, for a given
18687 * slideshow widget.
18689 * @param obj The slideshow object
18690 * @return The list of layouts (list of @b stringshared strings
18693 * Slideshow layouts will change how the widget is to dispose each
18694 * image item in its viewport, with regard to cropping, scaling,
18697 * The layouts, which come from @p obj's theme, must be an EDC
18698 * data item name @c "layouts" on the theme file, with (prefix)
18699 * names of EDC programs actually implementing them.
18701 * The available layouts for slideshows on the default theme are:
18702 * - @c "fullscreen" - item images with original aspect, scaled to
18703 * touch top and down slideshow borders or, if the image's heigh
18704 * is not enough, left and right slideshow borders.
18705 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18706 * one, but always leaving 10% of the slideshow's dimensions of
18707 * distance between the item image's borders and the slideshow
18708 * borders, for each axis.
18710 * @warning The stringshared strings get no new references
18711 * exclusive to the user grabbing the list, here, so if you'd like
18712 * to use them out of this call's context, you'd better @c
18713 * eina_stringshare_ref() them.
18715 * @see elm_slideshow_layout_set()
18717 * @ingroup Slideshow
18719 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18722 * Set the number of items to cache, on a given slideshow widget,
18723 * <b>before the current item</b>
18725 * @param obj The slideshow object
18726 * @param count Number of items to cache before the current one
18728 * The default value for this property is @c 2. See
18729 * @ref Slideshow_Caching "slideshow caching" for more details.
18731 * @see elm_slideshow_cache_before_get()
18733 * @ingroup Slideshow
18735 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18738 * Retrieve the number of items to cache, on a given slideshow widget,
18739 * <b>before the current item</b>
18741 * @param obj The slideshow object
18742 * @return The number of items set to be cached before the current one
18744 * @see elm_slideshow_cache_before_set() for more details
18746 * @ingroup Slideshow
18748 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18751 * Set the number of items to cache, on a given slideshow widget,
18752 * <b>after the current item</b>
18754 * @param obj The slideshow object
18755 * @param count Number of items to cache after the current one
18757 * The default value for this property is @c 2. See
18758 * @ref Slideshow_Caching "slideshow caching" for more details.
18760 * @see elm_slideshow_cache_after_get()
18762 * @ingroup Slideshow
18764 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18767 * Retrieve the number of items to cache, on a given slideshow widget,
18768 * <b>after the current item</b>
18770 * @param obj The slideshow object
18771 * @return The number of items set to be cached after the current one
18773 * @see elm_slideshow_cache_after_set() for more details
18775 * @ingroup Slideshow
18777 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18780 * Get the number of items stored in a given slideshow widget
18782 * @param obj The slideshow object
18783 * @return The number of items on @p obj, at the moment of this call
18785 * @ingroup Slideshow
18787 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18794 * @defgroup Fileselector File Selector
18796 * @image html img/widget/fileselector/preview-00.png
18797 * @image latex img/widget/fileselector/preview-00.eps
18799 * A file selector is a widget that allows a user to navigate
18800 * through a file system, reporting file selections back via its
18803 * It contains shortcut buttons for home directory (@c ~) and to
18804 * jump one directory upwards (..), as well as cancel/ok buttons to
18805 * confirm/cancel a given selection. After either one of those two
18806 * former actions, the file selector will issue its @c "done" smart
18809 * There's a text entry on it, too, showing the name of the current
18810 * selection. There's the possibility of making it editable, so it
18811 * is useful on file saving dialogs on applications, where one
18812 * gives a file name to save contents to, in a given directory in
18813 * the system. This custom file name will be reported on the @c
18814 * "done" smart callback (explained in sequence).
18816 * Finally, it has a view to display file system items into in two
18821 * If Elementary is built with support of the Ethumb thumbnailing
18822 * library, the second form of view will display preview thumbnails
18823 * of files which it supports.
18825 * Smart callbacks one can register to:
18827 * - @c "selected" - the user has clicked on a file (when not in
18828 * folders-only mode) or directory (when in folders-only mode)
18829 * - @c "directory,open" - the list has been populated with new
18830 * content (@c event_info is a pointer to the directory's
18831 * path, a @b stringshared string)
18832 * - @c "done" - the user has clicked on the "ok" or "cancel"
18833 * buttons (@c event_info is a pointer to the selection's
18834 * path, a @b stringshared string)
18836 * Here is an example on its usage:
18837 * @li @ref fileselector_example
18841 * @addtogroup Fileselector
18846 * Defines how a file selector widget is to layout its contents
18847 * (file system entries).
18849 typedef enum _Elm_Fileselector_Mode
18851 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
18852 ELM_FILESELECTOR_GRID, /**< layout as a grid */
18853 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
18854 } Elm_Fileselector_Mode;
18857 * Add a new file selector widget to the given parent Elementary
18858 * (container) object
18860 * @param parent The parent object
18861 * @return a new file selector widget handle or @c NULL, on errors
18863 * This function inserts a new file selector widget on the canvas.
18865 * @ingroup Fileselector
18867 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18870 * Enable/disable the file name entry box where the user can type
18871 * in a name for a file, in a given file selector widget
18873 * @param obj The file selector object
18874 * @param is_save @c EINA_TRUE to make the file selector a "saving
18875 * dialog", @c EINA_FALSE otherwise
18877 * Having the entry editable is useful on file saving dialogs on
18878 * applications, where one gives a file name to save contents to,
18879 * in a given directory in the system. This custom file name will
18880 * be reported on the @c "done" smart callback.
18882 * @see elm_fileselector_is_save_get()
18884 * @ingroup Fileselector
18886 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
18889 * Get whether the given file selector is in "saving dialog" mode
18891 * @param obj The file selector object
18892 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
18893 * mode, @c EINA_FALSE otherwise (and on errors)
18895 * @see elm_fileselector_is_save_set() for more details
18897 * @ingroup Fileselector
18899 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18902 * Enable/disable folder-only view for a given file selector widget
18904 * @param obj The file selector object
18905 * @param only @c EINA_TRUE to make @p obj only display
18906 * directories, @c EINA_FALSE to make files to be displayed in it
18909 * If enabled, the widget's view will only display folder items,
18912 * @see elm_fileselector_folder_only_get()
18914 * @ingroup Fileselector
18916 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
18919 * Get whether folder-only view is set for a given file selector
18922 * @param obj The file selector object
18923 * @return only @c EINA_TRUE if @p obj is only displaying
18924 * directories, @c EINA_FALSE if files are being displayed in it
18925 * too (and on errors)
18927 * @see elm_fileselector_folder_only_get()
18929 * @ingroup Fileselector
18931 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18934 * Enable/disable the "ok" and "cancel" buttons on a given file
18937 * @param obj The file selector object
18938 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
18940 * @note A file selector without those buttons will never emit the
18941 * @c "done" smart event, and is only usable if one is just hooking
18942 * to the other two events.
18944 * @see elm_fileselector_buttons_ok_cancel_get()
18946 * @ingroup Fileselector
18948 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
18951 * Get whether the "ok" and "cancel" buttons on a given file
18952 * selector widget are being shown.
18954 * @param obj The file selector object
18955 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
18956 * otherwise (and on errors)
18958 * @see elm_fileselector_buttons_ok_cancel_set() for more details
18960 * @ingroup Fileselector
18962 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18965 * Enable/disable a tree view in the given file selector widget,
18966 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
18968 * @param obj The file selector object
18969 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
18972 * In a tree view, arrows are created on the sides of directories,
18973 * allowing them to expand in place.
18975 * @note If it's in other mode, the changes made by this function
18976 * will only be visible when one switches back to "list" mode.
18978 * @see elm_fileselector_expandable_get()
18980 * @ingroup Fileselector
18982 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
18985 * Get whether tree view is enabled for the given file selector
18988 * @param obj The file selector object
18989 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
18990 * otherwise (and or errors)
18992 * @see elm_fileselector_expandable_set() for more details
18994 * @ingroup Fileselector
18996 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18999 * Set, programmatically, the @b directory that a given file
19000 * selector widget will display contents from
19002 * @param obj The file selector object
19003 * @param path The path to display in @p obj
19005 * This will change the @b directory that @p obj is displaying. It
19006 * will also clear the text entry area on the @p obj object, which
19007 * displays select files' names.
19009 * @see elm_fileselector_path_get()
19011 * @ingroup Fileselector
19013 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19016 * Get the parent directory's path that a given file selector
19017 * widget is displaying
19019 * @param obj The file selector object
19020 * @return The (full) path of the directory the file selector is
19021 * displaying, a @b stringshared string
19023 * @see elm_fileselector_path_set()
19025 * @ingroup Fileselector
19027 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19030 * Set, programmatically, the currently selected file/directory in
19031 * the given file selector widget
19033 * @param obj The file selector object
19034 * @param path The (full) path to a file or directory
19035 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19036 * latter case occurs if the directory or file pointed to do not
19039 * @see elm_fileselector_selected_get()
19041 * @ingroup Fileselector
19043 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19046 * Get the currently selected item's (full) path, in the given file
19049 * @param obj The file selector object
19050 * @return The absolute path of the selected item, a @b
19051 * stringshared string
19053 * @note Custom editions on @p obj object's text entry, if made,
19054 * will appear on the return string of this function, naturally.
19056 * @see elm_fileselector_selected_set() for more details
19058 * @ingroup Fileselector
19060 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19063 * Set the mode in which a given file selector widget will display
19064 * (layout) file system entries in its view
19066 * @param obj The file selector object
19067 * @param mode The mode of the fileselector, being it one of
19068 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19069 * first one, naturally, will display the files in a list. The
19070 * latter will make the widget to display its entries in a grid
19073 * @note By using elm_fileselector_expandable_set(), the user may
19074 * trigger a tree view for that list.
19076 * @note If Elementary is built with support of the Ethumb
19077 * thumbnailing library, the second form of view will display
19078 * preview thumbnails of files which it supports. You must have
19079 * elm_need_ethumb() called in your Elementary for thumbnailing to
19082 * @see elm_fileselector_expandable_set().
19083 * @see elm_fileselector_mode_get().
19085 * @ingroup Fileselector
19087 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19090 * Get the mode in which a given file selector widget is displaying
19091 * (layouting) file system entries in its view
19093 * @param obj The fileselector object
19094 * @return The mode in which the fileselector is at
19096 * @see elm_fileselector_mode_set() for more details
19098 * @ingroup Fileselector
19100 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19107 * @defgroup Progressbar Progress bar
19109 * The progress bar is a widget for visually representing the
19110 * progress status of a given job/task.
19112 * A progress bar may be horizontal or vertical. It may display an
19113 * icon besides it, as well as primary and @b units labels. The
19114 * former is meant to label the widget as a whole, while the
19115 * latter, which is formatted with floating point values (and thus
19116 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19117 * units"</c>), is meant to label the widget's <b>progress
19118 * value</b>. Label, icon and unit strings/objects are @b optional
19119 * for progress bars.
19121 * A progress bar may be @b inverted, in which state it gets its
19122 * values inverted, with high values being on the left or top and
19123 * low values on the right or bottom, as opposed to normally have
19124 * the low values on the former and high values on the latter,
19125 * respectively, for horizontal and vertical modes.
19127 * The @b span of the progress, as set by
19128 * elm_progressbar_span_size_set(), is its length (horizontally or
19129 * vertically), unless one puts size hints on the widget to expand
19130 * on desired directions, by any container. That length will be
19131 * scaled by the object or applications scaling factor. At any
19132 * point code can query the progress bar for its value with
19133 * elm_progressbar_value_get().
19135 * Available widget styles for progress bars:
19137 * - @c "wheel" (simple style, no text, no progression, only
19138 * "pulse" effect is available)
19140 * Here is an example on its usage:
19141 * @li @ref progressbar_example
19145 * Add a new progress bar widget to the given parent Elementary
19146 * (container) object
19148 * @param parent The parent object
19149 * @return a new progress bar widget handle or @c NULL, on errors
19151 * This function inserts a new progress bar widget on the canvas.
19153 * @ingroup Progressbar
19155 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19158 * Set whether a given progress bar widget is at "pulsing mode" or
19161 * @param obj The progress bar object
19162 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19163 * @c EINA_FALSE to put it back to its default one
19165 * By default, progress bars will display values from the low to
19166 * high value boundaries. There are, though, contexts in which the
19167 * state of progression of a given task is @b unknown. For those,
19168 * one can set a progress bar widget to a "pulsing state", to give
19169 * the user an idea that some computation is being held, but
19170 * without exact progress values. In the default theme it will
19171 * animate its bar with the contents filling in constantly and back
19172 * to non-filled, in a loop. To start and stop this pulsing
19173 * animation, one has to explicitly call elm_progressbar_pulse().
19175 * @see elm_progressbar_pulse_get()
19176 * @see elm_progressbar_pulse()
19178 * @ingroup Progressbar
19180 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19183 * Get whether a given progress bar widget is at "pulsing mode" or
19186 * @param obj The progress bar object
19187 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19188 * if it's in the default one (and on errors)
19190 * @ingroup Progressbar
19192 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19195 * Start/stop a given progress bar "pulsing" animation, if its
19198 * @param obj The progress bar object
19199 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19200 * @c EINA_FALSE to @b stop it
19202 * @note This call won't do anything if @p obj is not under "pulsing mode".
19204 * @see elm_progressbar_pulse_set() for more details.
19206 * @ingroup Progressbar
19208 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19211 * Set the progress value (in percentage) on a given progress bar
19214 * @param obj The progress bar object
19215 * @param val The progress value (@b must be between @c 0.0 and @c
19218 * Use this call to set progress bar levels.
19220 * @note If you passes a value out of the specified range for @p
19221 * val, it will be interpreted as the @b closest of the @b boundary
19222 * values in the range.
19224 * @ingroup Progressbar
19226 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19229 * Get the progress value (in percentage) on a given progress bar
19232 * @param obj The progress bar object
19233 * @return The value of the progressbar
19235 * @see elm_progressbar_value_set() for more details
19237 * @ingroup Progressbar
19239 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19242 * Set the label of a given progress bar widget
19244 * @param obj The progress bar object
19245 * @param label The text label string, in UTF-8
19247 * @ingroup Progressbar
19248 * @deprecated use elm_object_text_set() instead.
19250 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19253 * Get the label of a given progress bar widget
19255 * @param obj The progressbar object
19256 * @return The text label string, in UTF-8
19258 * @ingroup Progressbar
19259 * @deprecated use elm_object_text_set() instead.
19261 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19264 * Set the icon object of a given progress bar widget
19266 * @param obj The progress bar object
19267 * @param icon The icon object
19269 * Use this call to decorate @p obj with an icon next to it.
19271 * @note Once the icon object is set, a previously set one will be
19272 * deleted. If you want to keep that old content object, use the
19273 * elm_progressbar_icon_unset() function.
19275 * @see elm_progressbar_icon_get()
19277 * @ingroup Progressbar
19279 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19282 * Retrieve the icon object set for a given progress bar widget
19284 * @param obj The progress bar object
19285 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19286 * otherwise (and on errors)
19288 * @see elm_progressbar_icon_set() for more details
19290 * @ingroup Progressbar
19292 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19295 * Unset an icon set on a given progress bar widget
19297 * @param obj The progress bar object
19298 * @return The icon object that was being used, if any was set, or
19299 * @c NULL, otherwise (and on errors)
19301 * This call will unparent and return the icon object which was set
19302 * for this widget, previously, on success.
19304 * @see elm_progressbar_icon_set() for more details
19306 * @ingroup Progressbar
19308 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19311 * Set the (exact) length of the bar region of a given progress bar
19314 * @param obj The progress bar object
19315 * @param size The length of the progress bar's bar region
19317 * This sets the minimum width (when in horizontal mode) or height
19318 * (when in vertical mode) of the actual bar area of the progress
19319 * bar @p obj. This in turn affects the object's minimum size. Use
19320 * this when you're not setting other size hints expanding on the
19321 * given direction (like weight and alignment hints) and you would
19322 * like it to have a specific size.
19324 * @note Icon, label and unit text around @p obj will require their
19325 * own space, which will make @p obj to require more the @p size,
19328 * @see elm_progressbar_span_size_get()
19330 * @ingroup Progressbar
19332 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19335 * Get the length set for the bar region of a given progress bar
19338 * @param obj The progress bar object
19339 * @return The length of the progress bar's bar region
19341 * If that size was not set previously, with
19342 * elm_progressbar_span_size_set(), this call will return @c 0.
19344 * @ingroup Progressbar
19346 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19349 * Set the format string for a given progress bar widget's units
19352 * @param obj The progress bar object
19353 * @param format The format string for @p obj's units label
19355 * If @c NULL is passed on @p format, it will make @p obj's units
19356 * area to be hidden completely. If not, it'll set the <b>format
19357 * string</b> for the units label's @b text. The units label is
19358 * provided a floating point value, so the units text is up display
19359 * at most one floating point falue. Note that the units label is
19360 * optional. Use a format string such as "%1.2f meters" for
19363 * @note The default format string for a progress bar is an integer
19364 * percentage, as in @c "%.0f %%".
19366 * @see elm_progressbar_unit_format_get()
19368 * @ingroup Progressbar
19370 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19373 * Retrieve the format string set for a given progress bar widget's
19376 * @param obj The progress bar object
19377 * @return The format set string for @p obj's units label or
19378 * @c NULL, if none was set (and on errors)
19380 * @see elm_progressbar_unit_format_set() for more details
19382 * @ingroup Progressbar
19384 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19387 * Set the orientation of a given progress bar widget
19389 * @param obj The progress bar object
19390 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19391 * @b horizontal, @c EINA_FALSE to make it @b vertical
19393 * Use this function to change how your progress bar is to be
19394 * disposed: vertically or horizontally.
19396 * @see elm_progressbar_horizontal_get()
19398 * @ingroup Progressbar
19400 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19403 * Retrieve the orientation of a given progress bar widget
19405 * @param obj The progress bar object
19406 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19407 * @c EINA_FALSE if it's @b vertical (and on errors)
19409 * @see elm_progressbar_horizontal_set() for more details
19411 * @ingroup Progressbar
19413 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19416 * Invert a given progress bar widget's displaying values order
19418 * @param obj The progress bar object
19419 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19420 * @c EINA_FALSE to bring it back to default, non-inverted values.
19422 * A progress bar may be @b inverted, in which state it gets its
19423 * values inverted, with high values being on the left or top and
19424 * low values on the right or bottom, as opposed to normally have
19425 * the low values on the former and high values on the latter,
19426 * respectively, for horizontal and vertical modes.
19428 * @see elm_progressbar_inverted_get()
19430 * @ingroup Progressbar
19432 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19435 * Get whether a given progress bar widget's displaying values are
19438 * @param obj The progress bar object
19439 * @return @c EINA_TRUE, if @p obj has inverted values,
19440 * @c EINA_FALSE otherwise (and on errors)
19442 * @see elm_progressbar_inverted_set() for more details
19444 * @ingroup Progressbar
19446 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19449 * @defgroup Separator Separator
19451 * @brief Separator is a very thin object used to separate other objects.
19453 * A separator can be vertical or horizontal.
19455 * @ref tutorial_separator is a good example of how to use a separator.
19459 * @brief Add a separator object to @p parent
19461 * @param parent The parent object
19463 * @return The separator object, or NULL upon failure
19465 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19467 * @brief Set the horizontal mode of a separator object
19469 * @param obj The separator object
19470 * @param horizontal If true, the separator is horizontal
19472 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19474 * @brief Get the horizontal mode of a separator object
19476 * @param obj The separator object
19477 * @return If true, the separator is horizontal
19479 * @see elm_separator_horizontal_set()
19481 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19487 * @defgroup Spinner Spinner
19488 * @ingroup Elementary
19490 * @image html img/widget/spinner/preview-00.png
19491 * @image latex img/widget/spinner/preview-00.eps
19493 * A spinner is a widget which allows the user to increase or decrease
19494 * numeric values using arrow buttons, or edit values directly, clicking
19495 * over it and typing the new value.
19497 * By default the spinner will not wrap and has a label
19498 * of "%.0f" (just showing the integer value of the double).
19500 * A spinner has a label that is formatted with floating
19501 * point values and thus accepts a printf-style format string, like
19504 * It also allows specific values to be replaced by pre-defined labels.
19506 * Smart callbacks one can register to:
19508 * - "changed" - Whenever the spinner value is changed.
19509 * - "delay,changed" - A short time after the value is changed by the user.
19510 * This will be called only when the user stops dragging for a very short
19511 * period or when they release their finger/mouse, so it avoids possibly
19512 * expensive reactions to the value change.
19514 * Available styles for it:
19516 * - @c "vertical": up/down buttons at the right side and text left aligned.
19518 * Here is an example on its usage:
19519 * @ref spinner_example
19523 * @addtogroup Spinner
19528 * Add a new spinner widget to the given parent Elementary
19529 * (container) object.
19531 * @param parent The parent object.
19532 * @return a new spinner widget handle or @c NULL, on errors.
19534 * This function inserts a new spinner widget on the canvas.
19539 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19542 * Set the format string of the displayed label.
19544 * @param obj The spinner object.
19545 * @param fmt The format string for the label display.
19547 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19548 * string for the label text. The label text is provided a floating point
19549 * value, so the label text can display up to 1 floating point value.
19550 * Note that this is optional.
19552 * Use a format string such as "%1.2f meters" for example, and it will
19553 * display values like: "3.14 meters" for a value equal to 3.14159.
19555 * Default is "%0.f".
19557 * @see elm_spinner_label_format_get()
19561 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19564 * Get the label format of the spinner.
19566 * @param obj The spinner object.
19567 * @return The text label format string in UTF-8.
19569 * @see elm_spinner_label_format_set() for details.
19573 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19576 * Set the minimum and maximum values for the spinner.
19578 * @param obj The spinner object.
19579 * @param min The minimum value.
19580 * @param max The maximum value.
19582 * Define the allowed range of values to be selected by the user.
19584 * If actual value is less than @p min, it will be updated to @p min. If it
19585 * is bigger then @p max, will be updated to @p max. Actual value can be
19586 * get with elm_spinner_value_get().
19588 * By default, min is equal to 0, and max is equal to 100.
19590 * @warning Maximum must be greater than minimum.
19592 * @see elm_spinner_min_max_get()
19596 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19599 * Get the minimum and maximum values of the spinner.
19601 * @param obj The spinner object.
19602 * @param min Pointer where to store the minimum value.
19603 * @param max Pointer where to store the maximum value.
19605 * @note If only one value is needed, the other pointer can be passed
19608 * @see elm_spinner_min_max_set() for details.
19612 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19615 * Set the step used to increment or decrement the spinner value.
19617 * @param obj The spinner object.
19618 * @param step The step value.
19620 * This value will be incremented or decremented to the displayed value.
19621 * It will be incremented while the user keep right or top arrow pressed,
19622 * and will be decremented while the user keep left or bottom arrow pressed.
19624 * The interval to increment / decrement can be set with
19625 * elm_spinner_interval_set().
19627 * By default step value is equal to 1.
19629 * @see elm_spinner_step_get()
19633 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19636 * Get the step used to increment or decrement the spinner value.
19638 * @param obj The spinner object.
19639 * @return The step value.
19641 * @see elm_spinner_step_get() for more details.
19645 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19648 * Set the value the spinner displays.
19650 * @param obj The spinner object.
19651 * @param val The value to be displayed.
19653 * Value will be presented on the label following format specified with
19654 * elm_spinner_format_set().
19656 * @warning The value must to be between min and max values. This values
19657 * are set by elm_spinner_min_max_set().
19659 * @see elm_spinner_value_get().
19660 * @see elm_spinner_format_set().
19661 * @see elm_spinner_min_max_set().
19665 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19668 * Get the value displayed by the spinner.
19670 * @param obj The spinner object.
19671 * @return The value displayed.
19673 * @see elm_spinner_value_set() for details.
19677 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19680 * Set whether the spinner should wrap when it reaches its
19681 * minimum or maximum value.
19683 * @param obj The spinner object.
19684 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19687 * Disabled by default. If disabled, when the user tries to increment the
19689 * but displayed value plus step value is bigger than maximum value,
19691 * won't allow it. The same happens when the user tries to decrement it,
19692 * but the value less step is less than minimum value.
19694 * When wrap is enabled, in such situations it will allow these changes,
19695 * but will get the value that would be less than minimum and subtracts
19696 * from maximum. Or add the value that would be more than maximum to
19700 * @li min value = 10
19701 * @li max value = 50
19702 * @li step value = 20
19703 * @li displayed value = 20
19705 * When the user decrement value (using left or bottom arrow), it will
19706 * displays @c 40, because max - (min - (displayed - step)) is
19707 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19709 * @see elm_spinner_wrap_get().
19713 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19716 * Get whether the spinner should wrap when it reaches its
19717 * minimum or maximum value.
19719 * @param obj The spinner object
19720 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19721 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19723 * @see elm_spinner_wrap_set() for details.
19727 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19730 * Set whether the spinner can be directly edited by the user or not.
19732 * @param obj The spinner object.
19733 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19734 * don't allow users to edit it directly.
19736 * Spinner objects can have edition @b disabled, in which state they will
19737 * be changed only by arrows.
19738 * Useful for contexts
19739 * where you don't want your users to interact with it writting the value.
19741 * when using special values, the user can see real value instead
19742 * of special label on edition.
19744 * It's enabled by default.
19746 * @see elm_spinner_editable_get()
19750 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19753 * Get whether the spinner can be directly edited by the user or not.
19755 * @param obj The spinner object.
19756 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19757 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19759 * @see elm_spinner_editable_set() for details.
19763 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19766 * Set a special string to display in the place of the numerical value.
19768 * @param obj The spinner object.
19769 * @param value The value to be replaced.
19770 * @param label The label to be used.
19772 * It's useful for cases when a user should select an item that is
19773 * better indicated by a label than a value. For example, weekdays or months.
19777 * sp = elm_spinner_add(win);
19778 * elm_spinner_min_max_set(sp, 1, 3);
19779 * elm_spinner_special_value_add(sp, 1, "January");
19780 * elm_spinner_special_value_add(sp, 2, "February");
19781 * elm_spinner_special_value_add(sp, 3, "March");
19782 * evas_object_show(sp);
19787 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
19790 * Set the interval on time updates for an user mouse button hold
19791 * on spinner widgets' arrows.
19793 * @param obj The spinner object.
19794 * @param interval The (first) interval value in seconds.
19796 * This interval value is @b decreased while the user holds the
19797 * mouse pointer either incrementing or decrementing spinner's value.
19799 * This helps the user to get to a given value distant from the
19800 * current one easier/faster, as it will start to change quicker and
19801 * quicker on mouse button holds.
19803 * The calculation for the next change interval value, starting from
19804 * the one set with this call, is the previous interval divided by
19805 * @c 1.05, so it decreases a little bit.
19807 * The default starting interval value for automatic changes is
19810 * @see elm_spinner_interval_get()
19814 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
19817 * Get the interval on time updates for an user mouse button hold
19818 * on spinner widgets' arrows.
19820 * @param obj The spinner object.
19821 * @return The (first) interval value, in seconds, set on it.
19823 * @see elm_spinner_interval_set() for more details.
19827 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19834 * @defgroup Index Index
19836 * @image html img/widget/index/preview-00.png
19837 * @image latex img/widget/index/preview-00.eps
19839 * An index widget gives you an index for fast access to whichever
19840 * group of other UI items one might have. It's a list of text
19841 * items (usually letters, for alphabetically ordered access).
19843 * Index widgets are by default hidden and just appear when the
19844 * user clicks over it's reserved area in the canvas. In its
19845 * default theme, it's an area one @ref Fingers "finger" wide on
19846 * the right side of the index widget's container.
19848 * When items on the index are selected, smart callbacks get
19849 * called, so that its user can make other container objects to
19850 * show a given area or child object depending on the index item
19851 * selected. You'd probably be using an index together with @ref
19852 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
19855 * Smart events one can add callbacks for are:
19856 * - @c "changed" - When the selected index item changes. @c
19857 * event_info is the selected item's data pointer.
19858 * - @c "delay,changed" - When the selected index item changes, but
19859 * after a small idling period. @c event_info is the selected
19860 * item's data pointer.
19861 * - @c "selected" - When the user releases a mouse button and
19862 * selects an item. @c event_info is the selected item's data
19864 * - @c "level,up" - when the user moves a finger from the first
19865 * level to the second level
19866 * - @c "level,down" - when the user moves a finger from the second
19867 * level to the first level
19869 * The @c "delay,changed" event is so that it'll wait a small time
19870 * before actually reporting those events and, moreover, just the
19871 * last event happening on those time frames will actually be
19874 * Here are some examples on its usage:
19875 * @li @ref index_example_01
19876 * @li @ref index_example_02
19880 * @addtogroup Index
19884 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
19887 * Add a new index widget to the given parent Elementary
19888 * (container) object
19890 * @param parent The parent object
19891 * @return a new index widget handle or @c NULL, on errors
19893 * This function inserts a new index widget on the canvas.
19897 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19900 * Set whether a given index widget is or not visible,
19903 * @param obj The index object
19904 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
19906 * Not to be confused with visible as in @c evas_object_show() --
19907 * visible with regard to the widget's auto hiding feature.
19909 * @see elm_index_active_get()
19913 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
19916 * Get whether a given index widget is currently visible or not.
19918 * @param obj The index object
19919 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
19921 * @see elm_index_active_set() for more details
19925 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19928 * Set the items level for a given index widget.
19930 * @param obj The index object.
19931 * @param level @c 0 or @c 1, the currently implemented levels.
19933 * @see elm_index_item_level_get()
19937 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
19940 * Get the items level set for a given index widget.
19942 * @param obj The index object.
19943 * @return @c 0 or @c 1, which are the levels @p obj might be at.
19945 * @see elm_index_item_level_set() for more information
19949 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19952 * Returns the last selected item's data, for a given index widget.
19954 * @param obj The index object.
19955 * @return The item @b data associated to the last selected item on
19956 * @p obj (or @c NULL, on errors).
19958 * @warning The returned value is @b not an #Elm_Index_Item item
19959 * handle, but the data associated to it (see the @c item parameter
19960 * in elm_index_item_append(), as an example).
19964 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
19967 * Append a new item on a given index widget.
19969 * @param obj The index object.
19970 * @param letter Letter under which the item should be indexed
19971 * @param item The item data to set for the index's item
19973 * Despite the most common usage of the @p letter argument is for
19974 * single char strings, one could use arbitrary strings as index
19977 * @c item will be the pointer returned back on @c "changed", @c
19978 * "delay,changed" and @c "selected" smart events.
19982 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
19985 * Prepend a new item on a given index widget.
19987 * @param obj The index object.
19988 * @param letter Letter under which the item should be indexed
19989 * @param item The item data to set for the index's item
19991 * Despite the most common usage of the @p letter argument is for
19992 * single char strings, one could use arbitrary strings as index
19995 * @c item will be the pointer returned back on @c "changed", @c
19996 * "delay,changed" and @c "selected" smart events.
20000 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20003 * Append a new item, on a given index widget, <b>after the item
20004 * having @p relative as data</b>.
20006 * @param obj The index object.
20007 * @param letter Letter under which the item should be indexed
20008 * @param item The item data to set for the index's item
20009 * @param relative The item data of the index item to be the
20010 * predecessor of this new one
20012 * Despite the most common usage of the @p letter argument is for
20013 * single char strings, one could use arbitrary strings as index
20016 * @c item will be the pointer returned back on @c "changed", @c
20017 * "delay,changed" and @c "selected" smart events.
20019 * @note If @p relative is @c NULL or if it's not found to be data
20020 * set on any previous item on @p obj, this function will behave as
20021 * elm_index_item_append().
20025 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20028 * Prepend a new item, on a given index widget, <b>after the item
20029 * having @p relative as data</b>.
20031 * @param obj The index object.
20032 * @param letter Letter under which the item should be indexed
20033 * @param item The item data to set for the index's item
20034 * @param relative The item data of the index item to be the
20035 * successor of this new one
20037 * Despite the most common usage of the @p letter argument is for
20038 * single char strings, one could use arbitrary strings as index
20041 * @c item will be the pointer returned back on @c "changed", @c
20042 * "delay,changed" and @c "selected" smart events.
20044 * @note If @p relative is @c NULL or if it's not found to be data
20045 * set on any previous item on @p obj, this function will behave as
20046 * elm_index_item_prepend().
20050 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20053 * Insert a new item into the given index widget, using @p cmp_func
20054 * function to sort items (by item handles).
20056 * @param obj The index object.
20057 * @param letter Letter under which the item should be indexed
20058 * @param item The item data to set for the index's item
20059 * @param cmp_func The comparing function to be used to sort index
20060 * items <b>by #Elm_Index_Item item handles</b>
20061 * @param cmp_data_func A @b fallback function to be called for the
20062 * sorting of index items <b>by item data</b>). It will be used
20063 * when @p cmp_func returns @c 0 (equality), which means an index
20064 * item with provided item data already exists. To decide which
20065 * data item should be pointed to by the index item in question, @p
20066 * cmp_data_func will be used. If @p cmp_data_func returns a
20067 * non-negative value, the previous index item data will be
20068 * replaced by the given @p item pointer. If the previous data need
20069 * to be freed, it should be done by the @p cmp_data_func function,
20070 * because all references to it will be lost. If this function is
20071 * not provided (@c NULL is given), index items will be @b
20072 * duplicated, if @p cmp_func returns @c 0.
20074 * Despite the most common usage of the @p letter argument is for
20075 * single char strings, one could use arbitrary strings as index
20078 * @c item will be the pointer returned back on @c "changed", @c
20079 * "delay,changed" and @c "selected" smart events.
20083 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);
20086 * Remove an item from a given index widget, <b>to be referenced by
20087 * it's data value</b>.
20089 * @param obj The index object
20090 * @param item The item's data pointer for the item to be removed
20093 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20094 * that callback function will be called by this one.
20096 * @warning The item to be removed from @p obj will be found via
20097 * its item data pointer, and not by an #Elm_Index_Item handle.
20101 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20104 * Find a given index widget's item, <b>using item data</b>.
20106 * @param obj The index object
20107 * @param item The item data pointed to by the desired index item
20108 * @return The index item handle, if found, or @c NULL otherwise
20112 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20115 * Removes @b all items from a given index widget.
20117 * @param obj The index object.
20119 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20120 * that callback function will be called for each item in @p obj.
20124 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20127 * Go to a given items level on a index widget
20129 * @param obj The index object
20130 * @param level The index level (one of @c 0 or @c 1)
20134 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20137 * Return the data associated with a given index widget item
20139 * @param it The index widget item handle
20140 * @return The data associated with @p it
20142 * @see elm_index_item_data_set()
20146 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20149 * Set the data associated with a given index widget item
20151 * @param it The index widget item handle
20152 * @param data The new data pointer to set to @p it
20154 * This sets new item data on @p it.
20156 * @warning The old data pointer won't be touched by this function, so
20157 * the user had better to free that old data himself/herself.
20161 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20164 * Set the function to be called when a given index widget item is freed.
20166 * @param it The item to set the callback on
20167 * @param func The function to call on the item's deletion
20169 * When called, @p func will have both @c data and @c event_info
20170 * arguments with the @p it item's data value and, naturally, the
20171 * @c obj argument with a handle to the parent index widget.
20175 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20178 * Get the letter (string) set on a given index widget item.
20180 * @param it The index item handle
20181 * @return The letter string set on @p it
20185 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20192 * @defgroup Photocam Photocam
20194 * @image html img/widget/photocam/preview-00.png
20195 * @image latex img/widget/photocam/preview-00.eps
20197 * This is a widget specifically for displaying high-resolution digital
20198 * camera photos giving speedy feedback (fast load), low memory footprint
20199 * and zooming and panning as well as fitting logic. It is entirely focused
20200 * on jpeg images, and takes advantage of properties of the jpeg format (via
20201 * evas loader features in the jpeg loader).
20203 * Signals that you can add callbacks for are:
20204 * @li "clicked" - This is called when a user has clicked the photo without
20206 * @li "press" - This is called when a user has pressed down on the photo.
20207 * @li "longpressed" - This is called when a user has pressed down on the
20208 * photo for a long time without dragging around.
20209 * @li "clicked,double" - This is called when a user has double-clicked the
20211 * @li "load" - Photo load begins.
20212 * @li "loaded" - This is called when the image file load is complete for the
20213 * first view (low resolution blurry version).
20214 * @li "load,detail" - Photo detailed data load begins.
20215 * @li "loaded,detail" - This is called when the image file load is complete
20216 * for the detailed image data (full resolution needed).
20217 * @li "zoom,start" - Zoom animation started.
20218 * @li "zoom,stop" - Zoom animation stopped.
20219 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20220 * @li "scroll" - the content has been scrolled (moved)
20221 * @li "scroll,anim,start" - scrolling animation has started
20222 * @li "scroll,anim,stop" - scrolling animation has stopped
20223 * @li "scroll,drag,start" - dragging the contents around has started
20224 * @li "scroll,drag,stop" - dragging the contents around has stopped
20226 * @ref tutorial_photocam shows the API in action.
20230 * @brief Types of zoom available.
20232 typedef enum _Elm_Photocam_Zoom_Mode
20234 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20235 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20236 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20237 ELM_PHOTOCAM_ZOOM_MODE_LAST
20238 } Elm_Photocam_Zoom_Mode;
20240 * @brief Add a new Photocam object
20242 * @param parent The parent object
20243 * @return The new object or NULL if it cannot be created
20245 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20247 * @brief Set the photo file to be shown
20249 * @param obj The photocam object
20250 * @param file The photo file
20251 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20253 * This sets (and shows) the specified file (with a relative or absolute
20254 * path) and will return a load error (same error that
20255 * evas_object_image_load_error_get() will return). The image will change and
20256 * adjust its size at this point and begin a background load process for this
20257 * photo that at some time in the future will be displayed at the full
20260 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20262 * @brief Returns the path of the current image file
20264 * @param obj The photocam object
20265 * @return Returns the path
20267 * @see elm_photocam_file_set()
20269 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20271 * @brief Set the zoom level of the photo
20273 * @param obj The photocam object
20274 * @param zoom The zoom level to set
20276 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20277 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20278 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20279 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20282 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20284 * @brief Get the zoom level of the photo
20286 * @param obj The photocam object
20287 * @return The current zoom level
20289 * This returns the current zoom level of the photocam object. Note that if
20290 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20291 * (which is the default), the zoom level may be changed at any time by the
20292 * photocam object itself to account for photo size and photocam viewpoer
20295 * @see elm_photocam_zoom_set()
20296 * @see elm_photocam_zoom_mode_set()
20298 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20300 * @brief Set the zoom mode
20302 * @param obj The photocam object
20303 * @param mode The desired mode
20305 * This sets the zoom mode to manual or one of several automatic levels.
20306 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20307 * elm_photocam_zoom_set() and will stay at that level until changed by code
20308 * or until zoom mode is changed. This is the default mode. The Automatic
20309 * modes will allow the photocam object to automatically adjust zoom mode
20310 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20311 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20312 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20313 * pixels within the frame are left unfilled.
20315 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20317 * @brief Get the zoom mode
20319 * @param obj The photocam object
20320 * @return The current zoom mode
20322 * This gets the current zoom mode of the photocam object.
20324 * @see elm_photocam_zoom_mode_set()
20326 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20328 * @brief Get the current image pixel width and height
20330 * @param obj The photocam object
20331 * @param w A pointer to the width return
20332 * @param h A pointer to the height return
20334 * This gets the current photo pixel width and height (for the original).
20335 * The size will be returned in the integers @p w and @p h that are pointed
20338 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20340 * @brief Get the area of the image that is currently shown
20343 * @param x A pointer to the X-coordinate of region
20344 * @param y A pointer to the Y-coordinate of region
20345 * @param w A pointer to the width
20346 * @param h A pointer to the height
20348 * @see elm_photocam_image_region_show()
20349 * @see elm_photocam_image_region_bring_in()
20351 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20353 * @brief Set the viewed portion of the image
20355 * @param obj The photocam object
20356 * @param x X-coordinate of region in image original pixels
20357 * @param y Y-coordinate of region in image original pixels
20358 * @param w Width of region in image original pixels
20359 * @param h Height of region in image original pixels
20361 * This shows the region of the image without using animation.
20363 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20365 * @brief Bring in the viewed portion of the image
20367 * @param obj The photocam object
20368 * @param x X-coordinate of region in image original pixels
20369 * @param y Y-coordinate of region in image original pixels
20370 * @param w Width of region in image original pixels
20371 * @param h Height of region in image original pixels
20373 * This shows the region of the image using animation.
20375 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20377 * @brief Set the paused state for photocam
20379 * @param obj The photocam object
20380 * @param paused The pause state to set
20382 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20383 * photocam. The default is off. This will stop zooming using animation on
20384 * zoom levels changes and change instantly. This will stop any existing
20385 * animations that are running.
20387 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20389 * @brief Get the paused state for photocam
20391 * @param obj The photocam object
20392 * @return The current paused state
20394 * This gets the current paused state for the photocam object.
20396 * @see elm_photocam_paused_set()
20398 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20400 * @brief Get the internal low-res image used for photocam
20402 * @param obj The photocam object
20403 * @return The internal image object handle, or NULL if none exists
20405 * This gets the internal image object inside photocam. Do not modify it. It
20406 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20407 * deleted at any time as well.
20409 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20411 * @brief Set the photocam scrolling bouncing.
20413 * @param obj The photocam object
20414 * @param h_bounce bouncing for horizontal
20415 * @param v_bounce bouncing for vertical
20417 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20419 * @brief Get the photocam scrolling bouncing.
20421 * @param obj The photocam object
20422 * @param h_bounce bouncing for horizontal
20423 * @param v_bounce bouncing for vertical
20425 * @see elm_photocam_bounce_set()
20427 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20433 * @defgroup Map Map
20434 * @ingroup Elementary
20436 * @image html img/widget/map/preview-00.png
20437 * @image latex img/widget/map/preview-00.eps
20439 * This is a widget specifically for displaying a map. It uses basically
20440 * OpenStreetMap provider http://www.openstreetmap.org/,
20441 * but custom providers can be added.
20443 * It supports some basic but yet nice features:
20444 * @li zoom and scroll
20445 * @li markers with content to be displayed when user clicks over it
20446 * @li group of markers
20449 * Smart callbacks one can listen to:
20451 * - "clicked" - This is called when a user has clicked the map without
20453 * - "press" - This is called when a user has pressed down on the map.
20454 * - "longpressed" - This is called when a user has pressed down on the map
20455 * for a long time without dragging around.
20456 * - "clicked,double" - This is called when a user has double-clicked
20458 * - "load,detail" - Map detailed data load begins.
20459 * - "loaded,detail" - This is called when all currently visible parts of
20460 * the map are loaded.
20461 * - "zoom,start" - Zoom animation started.
20462 * - "zoom,stop" - Zoom animation stopped.
20463 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20464 * - "scroll" - the content has been scrolled (moved).
20465 * - "scroll,anim,start" - scrolling animation has started.
20466 * - "scroll,anim,stop" - scrolling animation has stopped.
20467 * - "scroll,drag,start" - dragging the contents around has started.
20468 * - "scroll,drag,stop" - dragging the contents around has stopped.
20469 * - "downloaded" - This is called when all currently required map images
20471 * - "route,load" - This is called when route request begins.
20472 * - "route,loaded" - This is called when route request ends.
20473 * - "name,load" - This is called when name request begins.
20474 * - "name,loaded- This is called when name request ends.
20476 * Available style for map widget:
20479 * Available style for markers:
20484 * Available style for marker bubble:
20487 * List of examples:
20488 * @li @ref map_example_01
20489 * @li @ref map_example_02
20490 * @li @ref map_example_03
20499 * @enum _Elm_Map_Zoom_Mode
20500 * @typedef Elm_Map_Zoom_Mode
20502 * Set map's zoom behavior. It can be set to manual or automatic.
20504 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20506 * Values <b> don't </b> work as bitmask, only one can be choosen.
20508 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20509 * than the scroller view.
20511 * @see elm_map_zoom_mode_set()
20512 * @see elm_map_zoom_mode_get()
20516 typedef enum _Elm_Map_Zoom_Mode
20518 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20519 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20520 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20521 ELM_MAP_ZOOM_MODE_LAST
20522 } Elm_Map_Zoom_Mode;
20525 * @enum _Elm_Map_Route_Sources
20526 * @typedef Elm_Map_Route_Sources
20528 * Set route service to be used. By default used source is
20529 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20531 * @see elm_map_route_source_set()
20532 * @see elm_map_route_source_get()
20536 typedef enum _Elm_Map_Route_Sources
20538 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20539 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. */
20540 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20541 ELM_MAP_ROUTE_SOURCE_LAST
20542 } Elm_Map_Route_Sources;
20544 typedef enum _Elm_Map_Name_Sources
20546 ELM_MAP_NAME_SOURCE_NOMINATIM,
20547 ELM_MAP_NAME_SOURCE_LAST
20548 } Elm_Map_Name_Sources;
20551 * @enum _Elm_Map_Route_Type
20552 * @typedef Elm_Map_Route_Type
20554 * Set type of transport used on route.
20556 * @see elm_map_route_add()
20560 typedef enum _Elm_Map_Route_Type
20562 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20563 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20564 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20565 ELM_MAP_ROUTE_TYPE_LAST
20566 } Elm_Map_Route_Type;
20569 * @enum _Elm_Map_Route_Method
20570 * @typedef Elm_Map_Route_Method
20572 * Set the routing method, what should be priorized, time or distance.
20574 * @see elm_map_route_add()
20578 typedef enum _Elm_Map_Route_Method
20580 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20581 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20582 ELM_MAP_ROUTE_METHOD_LAST
20583 } Elm_Map_Route_Method;
20585 typedef enum _Elm_Map_Name_Method
20587 ELM_MAP_NAME_METHOD_SEARCH,
20588 ELM_MAP_NAME_METHOD_REVERSE,
20589 ELM_MAP_NAME_METHOD_LAST
20590 } Elm_Map_Name_Method;
20592 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(). */
20593 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(). */
20594 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(). */
20595 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(). */
20596 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20597 typedef struct _Elm_Map_Track Elm_Map_Track;
20599 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. */
20600 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20601 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20602 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20604 typedef char *(*ElmMapModuleSourceFunc) (void);
20605 typedef int (*ElmMapModuleZoomMinFunc) (void);
20606 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20607 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20608 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20609 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20610 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20611 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20612 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20615 * Add a new map widget to the given parent Elementary (container) object.
20617 * @param parent The parent object.
20618 * @return a new map widget handle or @c NULL, on errors.
20620 * This function inserts a new map widget on the canvas.
20624 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20627 * Set the zoom level of the map.
20629 * @param obj The map object.
20630 * @param zoom The zoom level to set.
20632 * This sets the zoom level.
20634 * It will respect limits defined by elm_map_source_zoom_min_set() and
20635 * elm_map_source_zoom_max_set().
20637 * By default these values are 0 (world map) and 18 (maximum zoom).
20639 * This function should be used when zoom mode is set to
20640 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20641 * with elm_map_zoom_mode_set().
20643 * @see elm_map_zoom_mode_set().
20644 * @see elm_map_zoom_get().
20648 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20651 * Get the zoom level of the map.
20653 * @param obj The map object.
20654 * @return The current zoom level.
20656 * This returns the current zoom level of the map object.
20658 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20659 * (which is the default), the zoom level may be changed at any time by the
20660 * map object itself to account for map size and map viewport size.
20662 * @see elm_map_zoom_set() for details.
20666 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20669 * Set the zoom mode used by the map object.
20671 * @param obj The map object.
20672 * @param mode The zoom mode of the map, being it one of
20673 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20674 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20676 * This sets the zoom mode to manual or one of the automatic levels.
20677 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20678 * elm_map_zoom_set() and will stay at that level until changed by code
20679 * or until zoom mode is changed. This is the default mode.
20681 * The Automatic modes will allow the map object to automatically
20682 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20683 * adjust zoom so the map fits inside the scroll frame with no pixels
20684 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20685 * ensure no pixels within the frame are left unfilled. Do not forget that
20686 * the valid sizes are 2^zoom, consequently the map may be smaller than
20687 * the scroller view.
20689 * @see elm_map_zoom_set()
20693 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20696 * Get the zoom mode used by the map object.
20698 * @param obj The map object.
20699 * @return The zoom mode of the map, being it one of
20700 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20701 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20703 * This function returns the current zoom mode used by the map object.
20705 * @see elm_map_zoom_mode_set() for more details.
20709 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20712 * Get the current coordinates of the map.
20714 * @param obj The map object.
20715 * @param lon Pointer where to store longitude.
20716 * @param lat Pointer where to store latitude.
20718 * This gets the current center coordinates of the map object. It can be
20719 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20721 * @see elm_map_geo_region_bring_in()
20722 * @see elm_map_geo_region_show()
20726 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20729 * Animatedly bring in given coordinates to the center of the map.
20731 * @param obj The map object.
20732 * @param lon Longitude to center at.
20733 * @param lat Latitude to center at.
20735 * This causes map to jump to the given @p lat and @p lon coordinates
20736 * and show it (by scrolling) in the center of the viewport, if it is not
20737 * already centered. This will use animation to do so and take a period
20738 * of time to complete.
20740 * @see elm_map_geo_region_show() for a function to avoid animation.
20741 * @see elm_map_geo_region_get()
20745 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20748 * Show the given coordinates at the center of the map, @b immediately.
20750 * @param obj The map object.
20751 * @param lon Longitude to center at.
20752 * @param lat Latitude to center at.
20754 * This causes map to @b redraw its viewport's contents to the
20755 * region contining the given @p lat and @p lon, that will be moved to the
20756 * center of the map.
20758 * @see elm_map_geo_region_bring_in() for a function to move with animation.
20759 * @see elm_map_geo_region_get()
20763 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20766 * Pause or unpause the map.
20768 * @param obj The map object.
20769 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20772 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20775 * The default is off.
20777 * This will stop zooming using animation, changing zoom levels will
20778 * change instantly. This will stop any existing animations that are running.
20780 * @see elm_map_paused_get()
20784 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20787 * Get a value whether map is paused or not.
20789 * @param obj The map object.
20790 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
20791 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
20793 * This gets the current paused state for the map object.
20795 * @see elm_map_paused_set() for details.
20799 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20802 * Set to show markers during zoom level changes or not.
20804 * @param obj The map object.
20805 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
20808 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20811 * The default is off.
20813 * This will stop zooming using animation, changing zoom levels will
20814 * change instantly. This will stop any existing animations that are running.
20816 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20819 * The default is off.
20821 * Enabling it will force the map to stop displaying the markers during
20822 * zoom level changes. Set to on if you have a large number of markers.
20824 * @see elm_map_paused_markers_get()
20828 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20831 * Get a value whether markers will be displayed on zoom level changes or not
20833 * @param obj The map object.
20834 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
20835 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
20837 * This gets the current markers paused state for the map object.
20839 * @see elm_map_paused_markers_set() for details.
20843 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20846 * Get the information of downloading status.
20848 * @param obj The map object.
20849 * @param try_num Pointer where to store number of tiles being downloaded.
20850 * @param finish_num Pointer where to store number of tiles successfully
20853 * This gets the current downloading status for the map object, the number
20854 * of tiles being downloaded and the number of tiles already downloaded.
20858 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
20861 * Convert a pixel coordinate (x,y) into a geographic coordinate
20862 * (longitude, latitude).
20864 * @param obj The map object.
20865 * @param x the coordinate.
20866 * @param y the coordinate.
20867 * @param size the size in pixels of the map.
20868 * The map is a square and generally his size is : pow(2.0, zoom)*256.
20869 * @param lon Pointer where to store the longitude that correspond to x.
20870 * @param lat Pointer where to store the latitude that correspond to y.
20872 * @note Origin pixel point is the top left corner of the viewport.
20873 * Map zoom and size are taken on account.
20875 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
20879 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);
20882 * Convert a geographic coordinate (longitude, latitude) into a pixel
20883 * coordinate (x, y).
20885 * @param obj The map object.
20886 * @param lon the longitude.
20887 * @param lat the latitude.
20888 * @param size the size in pixels of the map. The map is a square
20889 * and generally his size is : pow(2.0, zoom)*256.
20890 * @param x Pointer where to store the horizontal pixel coordinate that
20891 * correspond to the longitude.
20892 * @param y Pointer where to store the vertical pixel coordinate that
20893 * correspond to the latitude.
20895 * @note Origin pixel point is the top left corner of the viewport.
20896 * Map zoom and size are taken on account.
20898 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
20902 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);
20905 * Convert a geographic coordinate (longitude, latitude) into a name
20908 * @param obj The map object.
20909 * @param lon the longitude.
20910 * @param lat the latitude.
20911 * @return name A #Elm_Map_Name handle for this coordinate.
20913 * To get the string for this address, elm_map_name_address_get()
20916 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
20920 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20923 * Convert a name (address) into a geographic coordinate
20924 * (longitude, latitude).
20926 * @param obj The map object.
20927 * @param name The address.
20928 * @return name A #Elm_Map_Name handle for this address.
20930 * To get the longitude and latitude, elm_map_name_region_get()
20933 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
20937 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
20940 * Convert a pixel coordinate into a rotated pixel coordinate.
20942 * @param obj The map object.
20943 * @param x horizontal coordinate of the point to rotate.
20944 * @param y vertical coordinate of the point to rotate.
20945 * @param cx rotation's center horizontal position.
20946 * @param cy rotation's center vertical position.
20947 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
20948 * @param xx Pointer where to store rotated x.
20949 * @param yy Pointer where to store rotated y.
20953 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);
20956 * Add a new marker to the map object.
20958 * @param obj The map object.
20959 * @param lon The longitude of the marker.
20960 * @param lat The latitude of the marker.
20961 * @param clas The class, to use when marker @b isn't grouped to others.
20962 * @param clas_group The class group, to use when marker is grouped to others
20963 * @param data The data passed to the callbacks.
20965 * @return The created marker or @c NULL upon failure.
20967 * A marker will be created and shown in a specific point of the map, defined
20968 * by @p lon and @p lat.
20970 * It will be displayed using style defined by @p class when this marker
20971 * is displayed alone (not grouped). A new class can be created with
20972 * elm_map_marker_class_new().
20974 * If the marker is grouped to other markers, it will be displayed with
20975 * style defined by @p class_group. Markers with the same group are grouped
20976 * if they are close. A new group class can be created with
20977 * elm_map_marker_group_class_new().
20979 * Markers created with this method can be deleted with
20980 * elm_map_marker_remove().
20982 * A marker can have associated content to be displayed by a bubble,
20983 * when a user click over it, as well as an icon. These objects will
20984 * be fetch using class' callback functions.
20986 * @see elm_map_marker_class_new()
20987 * @see elm_map_marker_group_class_new()
20988 * @see elm_map_marker_remove()
20992 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);
20995 * Set the maximum numbers of markers' content to be displayed in a group.
20997 * @param obj The map object.
20998 * @param max The maximum numbers of items displayed in a bubble.
21000 * A bubble will be displayed when the user clicks over the group,
21001 * and will place the content of markers that belong to this group
21004 * A group can have a long list of markers, consequently the creation
21005 * of the content of the bubble can be very slow.
21007 * In order to avoid this, a maximum number of items is displayed
21010 * By default this number is 30.
21012 * Marker with the same group class are grouped if they are close.
21014 * @see elm_map_marker_add()
21018 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21021 * Remove a marker from the map.
21023 * @param marker The marker to remove.
21025 * @see elm_map_marker_add()
21029 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21032 * Get the current coordinates of the marker.
21034 * @param marker marker.
21035 * @param lat Pointer where to store the marker's latitude.
21036 * @param lon Pointer where to store the marker's longitude.
21038 * These values are set when adding markers, with function
21039 * elm_map_marker_add().
21041 * @see elm_map_marker_add()
21045 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21048 * Animatedly bring in given marker to the center of the map.
21050 * @param marker The marker to center at.
21052 * This causes map to jump to the given @p marker's coordinates
21053 * and show it (by scrolling) in the center of the viewport, if it is not
21054 * already centered. This will use animation to do so and take a period
21055 * of time to complete.
21057 * @see elm_map_marker_show() for a function to avoid animation.
21058 * @see elm_map_marker_region_get()
21062 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21065 * Show the given marker at the center of the map, @b immediately.
21067 * @param marker The marker to center at.
21069 * This causes map to @b redraw its viewport's contents to the
21070 * region contining the given @p marker's coordinates, that will be
21071 * moved to the center of the map.
21073 * @see elm_map_marker_bring_in() for a function to move with animation.
21074 * @see elm_map_markers_list_show() if more than one marker need to be
21076 * @see elm_map_marker_region_get()
21080 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21083 * Move and zoom the map to display a list of markers.
21085 * @param markers A list of #Elm_Map_Marker handles.
21087 * The map will be centered on the center point of the markers in the list.
21088 * Then the map will be zoomed in order to fit the markers using the maximum
21089 * zoom which allows display of all the markers.
21091 * @warning All the markers should belong to the same map object.
21093 * @see elm_map_marker_show() to show a single marker.
21094 * @see elm_map_marker_bring_in()
21098 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21101 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21103 * @param marker The marker wich content should be returned.
21104 * @return Return the evas object if it exists, else @c NULL.
21106 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21107 * elm_map_marker_class_get_cb_set() should be used.
21109 * This content is what will be inside the bubble that will be displayed
21110 * when an user clicks over the marker.
21112 * This returns the actual Evas object used to be placed inside
21113 * the bubble. This may be @c NULL, as it may
21114 * not have been created or may have been deleted, at any time, by
21115 * the map. <b>Do not modify this object</b> (move, resize,
21116 * show, hide, etc.), as the map is controlling it. This
21117 * function is for querying, emitting custom signals or hooking
21118 * lower level callbacks for events on that object. Do not delete
21119 * this object under any circumstances.
21123 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21126 * Update the marker
21128 * @param marker The marker to be updated.
21130 * If a content is set to this marker, it will call function to delete it,
21131 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21132 * #ElmMapMarkerGetFunc.
21134 * These functions are set for the marker class with
21135 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21139 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21142 * Close all the bubbles opened by the user.
21144 * @param obj The map object.
21146 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21147 * when the user clicks on a marker.
21149 * This functions is set for the marker class with
21150 * elm_map_marker_class_get_cb_set().
21154 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21157 * Create a new group class.
21159 * @param obj The map object.
21160 * @return Returns the new group class.
21162 * Each marker must be associated to a group class. Markers in the same
21163 * group are grouped if they are close.
21165 * The group class defines the style of the marker when a marker is grouped
21166 * to others markers. When it is alone, another class will be used.
21168 * A group class will need to be provided when creating a marker with
21169 * elm_map_marker_add().
21171 * Some properties and functions can be set by class, as:
21172 * - style, with elm_map_group_class_style_set()
21173 * - data - to be associated to the group class. It can be set using
21174 * elm_map_group_class_data_set().
21175 * - min zoom to display markers, set with
21176 * elm_map_group_class_zoom_displayed_set().
21177 * - max zoom to group markers, set using
21178 * elm_map_group_class_zoom_grouped_set().
21179 * - visibility - set if markers will be visible or not, set with
21180 * elm_map_group_class_hide_set().
21181 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21182 * It can be set using elm_map_group_class_icon_cb_set().
21184 * @see elm_map_marker_add()
21185 * @see elm_map_group_class_style_set()
21186 * @see elm_map_group_class_data_set()
21187 * @see elm_map_group_class_zoom_displayed_set()
21188 * @see elm_map_group_class_zoom_grouped_set()
21189 * @see elm_map_group_class_hide_set()
21190 * @see elm_map_group_class_icon_cb_set()
21194 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21197 * Set the marker's style of a group class.
21199 * @param clas The group class.
21200 * @param style The style to be used by markers.
21202 * Each marker must be associated to a group class, and will use the style
21203 * defined by such class when grouped to other markers.
21205 * The following styles are provided by default theme:
21206 * @li @c radio - blue circle
21207 * @li @c radio2 - green circle
21210 * @see elm_map_group_class_new() for more details.
21211 * @see elm_map_marker_add()
21215 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21218 * Set the icon callback function of a group class.
21220 * @param clas The group class.
21221 * @param icon_get The callback function that will return the icon.
21223 * Each marker must be associated to a group class, and it can display a
21224 * custom icon. The function @p icon_get must return this icon.
21226 * @see elm_map_group_class_new() for more details.
21227 * @see elm_map_marker_add()
21231 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21234 * Set the data associated to the group class.
21236 * @param clas The group class.
21237 * @param data The new user data.
21239 * This data will be passed for callback functions, like icon get callback,
21240 * that can be set with elm_map_group_class_icon_cb_set().
21242 * If a data was previously set, the object will lose the pointer for it,
21243 * so if needs to be freed, you must do it yourself.
21245 * @see elm_map_group_class_new() for more details.
21246 * @see elm_map_group_class_icon_cb_set()
21247 * @see elm_map_marker_add()
21251 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21254 * Set the minimum zoom from where the markers are displayed.
21256 * @param clas The group class.
21257 * @param zoom The minimum zoom.
21259 * Markers only will be displayed when the map is displayed at @p zoom
21262 * @see elm_map_group_class_new() for more details.
21263 * @see elm_map_marker_add()
21267 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21270 * Set the zoom from where the markers are no more grouped.
21272 * @param clas The group class.
21273 * @param zoom The maximum zoom.
21275 * Markers only will be grouped when the map is displayed at
21276 * less than @p zoom.
21278 * @see elm_map_group_class_new() for more details.
21279 * @see elm_map_marker_add()
21283 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21286 * Set if the markers associated to the group class @clas are hidden or not.
21288 * @param clas The group class.
21289 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21292 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21297 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21300 * Create a new marker class.
21302 * @param obj The map object.
21303 * @return Returns the new group class.
21305 * Each marker must be associated to a class.
21307 * The marker class defines the style of the marker when a marker is
21308 * displayed alone, i.e., not grouped to to others markers. When grouped
21309 * it will use group class style.
21311 * A marker class will need to be provided when creating a marker with
21312 * elm_map_marker_add().
21314 * Some properties and functions can be set by class, as:
21315 * - style, with elm_map_marker_class_style_set()
21316 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21317 * It can be set using elm_map_marker_class_icon_cb_set().
21318 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21319 * Set using elm_map_marker_class_get_cb_set().
21320 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21321 * Set using elm_map_marker_class_del_cb_set().
21323 * @see elm_map_marker_add()
21324 * @see elm_map_marker_class_style_set()
21325 * @see elm_map_marker_class_icon_cb_set()
21326 * @see elm_map_marker_class_get_cb_set()
21327 * @see elm_map_marker_class_del_cb_set()
21331 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21334 * Set the marker's style of a marker class.
21336 * @param clas The marker class.
21337 * @param style The style to be used by markers.
21339 * Each marker must be associated to a marker class, and will use the style
21340 * defined by such class when alone, i.e., @b not grouped to other markers.
21342 * The following styles are provided by default theme:
21347 * @see elm_map_marker_class_new() for more details.
21348 * @see elm_map_marker_add()
21352 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21355 * Set the icon callback function of a marker class.
21357 * @param clas The marker class.
21358 * @param icon_get The callback function that will return the icon.
21360 * Each marker must be associated to a marker class, and it can display a
21361 * custom icon. The function @p icon_get must return this icon.
21363 * @see elm_map_marker_class_new() for more details.
21364 * @see elm_map_marker_add()
21368 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21371 * Set the bubble content callback function of a marker class.
21373 * @param clas The marker class.
21374 * @param get The callback function that will return the content.
21376 * Each marker must be associated to a marker class, and it can display a
21377 * a content on a bubble that opens when the user click over the marker.
21378 * The function @p get must return this content object.
21380 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21383 * @see elm_map_marker_class_new() for more details.
21384 * @see elm_map_marker_class_del_cb_set()
21385 * @see elm_map_marker_add()
21389 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21392 * Set the callback function used to delete bubble content of a marker class.
21394 * @param clas The marker class.
21395 * @param del The callback function that will delete the content.
21397 * Each marker must be associated to a marker class, and it can display a
21398 * a content on a bubble that opens when the user click over the marker.
21399 * The function to return such content can be set with
21400 * elm_map_marker_class_get_cb_set().
21402 * If this content must be freed, a callback function need to be
21403 * set for that task with this function.
21405 * If this callback is defined it will have to delete (or not) the
21406 * object inside, but if the callback is not defined the object will be
21407 * destroyed with evas_object_del().
21409 * @see elm_map_marker_class_new() for more details.
21410 * @see elm_map_marker_class_get_cb_set()
21411 * @see elm_map_marker_add()
21415 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21418 * Get the list of available sources.
21420 * @param obj The map object.
21421 * @return The source names list.
21423 * It will provide a list with all available sources, that can be set as
21424 * current source with elm_map_source_name_set(), or get with
21425 * elm_map_source_name_get().
21427 * Available sources:
21433 * @see elm_map_source_name_set() for more details.
21434 * @see elm_map_source_name_get()
21438 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21441 * Set the source of the map.
21443 * @param obj The map object.
21444 * @param source The source to be used.
21446 * Map widget retrieves images that composes the map from a web service.
21447 * This web service can be set with this method.
21449 * A different service can return a different maps with different
21450 * information and it can use different zoom values.
21452 * The @p source_name need to match one of the names provided by
21453 * elm_map_source_names_get().
21455 * The current source can be get using elm_map_source_name_get().
21457 * @see elm_map_source_names_get()
21458 * @see elm_map_source_name_get()
21463 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21466 * Get the name of currently used source.
21468 * @param obj The map object.
21469 * @return Returns the name of the source in use.
21471 * @see elm_map_source_name_set() for more details.
21475 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21478 * Set the source of the route service to be used by the map.
21480 * @param obj The map object.
21481 * @param source The route service to be used, being it one of
21482 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21483 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21485 * Each one has its own algorithm, so the route retrieved may
21486 * differ depending on the source route. Now, only the default is working.
21488 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21489 * http://www.yournavigation.org/.
21491 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21492 * assumptions. Its routing core is based on Contraction Hierarchies.
21494 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21496 * @see elm_map_route_source_get().
21500 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21503 * Get the current route source.
21505 * @param obj The map object.
21506 * @return The source of the route service used by the map.
21508 * @see elm_map_route_source_set() for details.
21512 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21515 * Set the minimum zoom of the source.
21517 * @param obj The map object.
21518 * @param zoom New minimum zoom value to be used.
21520 * By default, it's 0.
21524 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21527 * Get the minimum zoom of the source.
21529 * @param obj The map object.
21530 * @return Returns the minimum zoom of the source.
21532 * @see elm_map_source_zoom_min_set() for details.
21536 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21539 * Set the maximum zoom of the source.
21541 * @param obj The map object.
21542 * @param zoom New maximum zoom value to be used.
21544 * By default, it's 18.
21548 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21551 * Get the maximum zoom of the source.
21553 * @param obj The map object.
21554 * @return Returns the maximum zoom of the source.
21556 * @see elm_map_source_zoom_min_set() for details.
21560 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21563 * Set the user agent used by the map object to access routing services.
21565 * @param obj The map object.
21566 * @param user_agent The user agent to be used by the map.
21568 * User agent is a client application implementing a network protocol used
21569 * in communications within a client–server distributed computing system
21571 * The @p user_agent identification string will transmitted in a header
21572 * field @c User-Agent.
21574 * @see elm_map_user_agent_get()
21578 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21581 * Get the user agent used by the map object.
21583 * @param obj The map object.
21584 * @return The user agent identification string used by the map.
21586 * @see elm_map_user_agent_set() for details.
21590 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21593 * Add a new route to the map object.
21595 * @param obj The map object.
21596 * @param type The type of transport to be considered when tracing a route.
21597 * @param method The routing method, what should be priorized.
21598 * @param flon The start longitude.
21599 * @param flat The start latitude.
21600 * @param tlon The destination longitude.
21601 * @param tlat The destination latitude.
21603 * @return The created route or @c NULL upon failure.
21605 * A route will be traced by point on coordinates (@p flat, @p flon)
21606 * to point on coordinates (@p tlat, @p tlon), using the route service
21607 * set with elm_map_route_source_set().
21609 * It will take @p type on consideration to define the route,
21610 * depending if the user will be walking or driving, the route may vary.
21611 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21612 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21614 * Another parameter is what the route should priorize, the minor distance
21615 * or the less time to be spend on the route. So @p method should be one
21616 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21618 * Routes created with this method can be deleted with
21619 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21620 * and distance can be get with elm_map_route_distance_get().
21622 * @see elm_map_route_remove()
21623 * @see elm_map_route_color_set()
21624 * @see elm_map_route_distance_get()
21625 * @see elm_map_route_source_set()
21629 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);
21632 * Remove a route from the map.
21634 * @param route The route to remove.
21636 * @see elm_map_route_add()
21640 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21643 * Set the route color.
21645 * @param route The route object.
21646 * @param r Red channel value, from 0 to 255.
21647 * @param g Green channel value, from 0 to 255.
21648 * @param b Blue channel value, from 0 to 255.
21649 * @param a Alpha channel value, from 0 to 255.
21651 * It uses an additive color model, so each color channel represents
21652 * how much of each primary colors must to be used. 0 represents
21653 * ausence of this color, so if all of the three are set to 0,
21654 * the color will be black.
21656 * These component values should be integers in the range 0 to 255,
21657 * (single 8-bit byte).
21659 * This sets the color used for the route. By default, it is set to
21660 * solid red (r = 255, g = 0, b = 0, a = 255).
21662 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21664 * @see elm_map_route_color_get()
21668 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21671 * Get the route color.
21673 * @param route The route object.
21674 * @param r Pointer where to store the red channel value.
21675 * @param g Pointer where to store the green channel value.
21676 * @param b Pointer where to store the blue channel value.
21677 * @param a Pointer where to store the alpha channel value.
21679 * @see elm_map_route_color_set() for details.
21683 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21686 * Get the route distance in kilometers.
21688 * @param route The route object.
21689 * @return The distance of route (unit : km).
21693 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21696 * Get the information of route nodes.
21698 * @param route The route object.
21699 * @return Returns a string with the nodes of route.
21703 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21706 * Get the information of route waypoint.
21708 * @param route the route object.
21709 * @return Returns a string with information about waypoint of route.
21713 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21716 * Get the address of the name.
21718 * @param name The name handle.
21719 * @return Returns the address string of @p name.
21721 * This gets the coordinates of the @p name, created with one of the
21722 * conversion functions.
21724 * @see elm_map_utils_convert_name_into_coord()
21725 * @see elm_map_utils_convert_coord_into_name()
21729 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21732 * Get the current coordinates of the name.
21734 * @param name The name handle.
21735 * @param lat Pointer where to store the latitude.
21736 * @param lon Pointer where to store The longitude.
21738 * This gets the coordinates of the @p name, created with one of the
21739 * conversion functions.
21741 * @see elm_map_utils_convert_name_into_coord()
21742 * @see elm_map_utils_convert_coord_into_name()
21746 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21749 * Remove a name from the map.
21751 * @param name The name to remove.
21753 * Basically the struct handled by @p name will be freed, so convertions
21754 * between address and coordinates will be lost.
21756 * @see elm_map_utils_convert_name_into_coord()
21757 * @see elm_map_utils_convert_coord_into_name()
21761 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21766 * @param obj The map object.
21767 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21768 * @param cx Rotation's center horizontal position.
21769 * @param cy Rotation's center vertical position.
21771 * @see elm_map_rotate_get()
21775 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
21778 * Get the rotate degree of the map
21780 * @param obj The map object
21781 * @param degree Pointer where to store degrees from 0.0 to 360.0
21782 * to rotate arount Z axis.
21783 * @param cx Pointer where to store rotation's center horizontal position.
21784 * @param cy Pointer where to store rotation's center vertical position.
21786 * @see elm_map_rotate_set() to set map rotation.
21790 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);
21793 * Enable or disable mouse wheel to be used to zoom in / out the map.
21795 * @param obj The map object.
21796 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
21799 * Mouse wheel can be used for the user to zoom in or zoom out the map.
21801 * It's disabled by default.
21803 * @see elm_map_wheel_disabled_get()
21807 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
21810 * Get a value whether mouse wheel is enabled or not.
21812 * @param obj The map object.
21813 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
21814 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21816 * Mouse wheel can be used for the user to zoom in or zoom out the map.
21818 * @see elm_map_wheel_disabled_set() for details.
21822 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21826 * Add a track on the map
21828 * @param obj The map object.
21829 * @param emap The emap route object.
21830 * @return The route object. This is an elm object of type Route.
21832 * @see elm_route_add() for details.
21836 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
21840 * Remove a track from the map
21842 * @param obj The map object.
21843 * @param route The track to remove.
21847 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
21854 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
21856 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
21858 EAPI double elm_route_lon_min_get(Evas_Object *obj);
21859 EAPI double elm_route_lat_min_get(Evas_Object *obj);
21860 EAPI double elm_route_lon_max_get(Evas_Object *obj);
21861 EAPI double elm_route_lat_max_get(Evas_Object *obj);
21865 * @defgroup Panel Panel
21867 * @image html img/widget/panel/preview-00.png
21868 * @image latex img/widget/panel/preview-00.eps
21870 * @brief A panel is a type of animated container that contains subobjects.
21871 * It can be expanded or contracted by clicking the button on it's edge.
21873 * Orientations are as follows:
21874 * @li ELM_PANEL_ORIENT_TOP
21875 * @li ELM_PANEL_ORIENT_LEFT
21876 * @li ELM_PANEL_ORIENT_RIGHT
21878 * @ref tutorial_panel shows one way to use this widget.
21881 typedef enum _Elm_Panel_Orient
21883 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
21884 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
21885 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
21886 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
21887 } Elm_Panel_Orient;
21889 * @brief Adds a panel object
21891 * @param parent The parent object
21893 * @return The panel object, or NULL on failure
21895 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21897 * @brief Sets the orientation of the panel
21899 * @param parent The parent object
21900 * @param orient The panel orientation. Can be one of the following:
21901 * @li ELM_PANEL_ORIENT_TOP
21902 * @li ELM_PANEL_ORIENT_LEFT
21903 * @li ELM_PANEL_ORIENT_RIGHT
21905 * Sets from where the panel will (dis)appear.
21907 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
21909 * @brief Get the orientation of the panel.
21911 * @param obj The panel object
21912 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
21914 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21916 * @brief Set the content of the panel.
21918 * @param obj The panel object
21919 * @param content The panel content
21921 * Once the content object is set, a previously set one will be deleted.
21922 * If you want to keep that old content object, use the
21923 * elm_panel_content_unset() function.
21925 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21927 * @brief Get the content of the panel.
21929 * @param obj The panel object
21930 * @return The content that is being used
21932 * Return the content object which is set for this widget.
21934 * @see elm_panel_content_set()
21936 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21938 * @brief Unset the content of the panel.
21940 * @param obj The panel object
21941 * @return The content that was being used
21943 * Unparent and return the content object which was set for this widget.
21945 * @see elm_panel_content_set()
21947 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21949 * @brief Set the state of the panel.
21951 * @param obj The panel object
21952 * @param hidden If true, the panel will run the animation to contract
21954 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
21956 * @brief Get the state of the panel.
21958 * @param obj The panel object
21959 * @param hidden If true, the panel is in the "hide" state
21961 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21963 * @brief Toggle the hidden state of the panel from code
21965 * @param obj The panel object
21967 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
21973 * @defgroup Panes Panes
21974 * @ingroup Elementary
21976 * @image html img/widget/panes/preview-00.png
21977 * @image latex img/widget/panes/preview-00.eps width=\textwidth
21979 * @image html img/panes.png
21980 * @image latex img/panes.eps width=\textwidth
21982 * The panes adds a dragable bar between two contents. When dragged
21983 * this bar will resize contents size.
21985 * Panes can be displayed vertically or horizontally, and contents
21986 * size proportion can be customized (homogeneous by default).
21988 * Smart callbacks one can listen to:
21989 * - "press" - The panes has been pressed (button wasn't released yet).
21990 * - "unpressed" - The panes was released after being pressed.
21991 * - "clicked" - The panes has been clicked>
21992 * - "clicked,double" - The panes has been double clicked
21994 * Available styles for it:
21997 * Here is an example on its usage:
21998 * @li @ref panes_example
22002 * @addtogroup Panes
22007 * Add a new panes widget to the given parent Elementary
22008 * (container) object.
22010 * @param parent The parent object.
22011 * @return a new panes widget handle or @c NULL, on errors.
22013 * This function inserts a new panes widget on the canvas.
22017 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22020 * Set the left content of the panes widget.
22022 * @param obj The panes object.
22023 * @param content The new left content object.
22025 * Once the content object is set, a previously set one will be deleted.
22026 * If you want to keep that old content object, use the
22027 * elm_panes_content_left_unset() function.
22029 * If panes is displayed vertically, left content will be displayed at
22032 * @see elm_panes_content_left_get()
22033 * @see elm_panes_content_right_set() to set content on the other side.
22037 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22040 * Set the right content of the panes widget.
22042 * @param obj The panes object.
22043 * @param content The new right content object.
22045 * Once the content object is set, a previously set one will be deleted.
22046 * If you want to keep that old content object, use the
22047 * elm_panes_content_right_unset() function.
22049 * If panes is displayed vertically, left content will be displayed at
22052 * @see elm_panes_content_right_get()
22053 * @see elm_panes_content_left_set() to set content on the other side.
22057 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22060 * Get the left content of the panes.
22062 * @param obj The panes object.
22063 * @return The left content object that is being used.
22065 * Return the left content object which is set for this widget.
22067 * @see elm_panes_content_left_set() for details.
22071 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22074 * Get the right content of the panes.
22076 * @param obj The panes object
22077 * @return The right content object that is being used
22079 * Return the right content object which is set for this widget.
22081 * @see elm_panes_content_right_set() for details.
22085 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22088 * Unset the left content used for the panes.
22090 * @param obj The panes object.
22091 * @return The left content object that was being used.
22093 * Unparent and return the left content object which was set for this widget.
22095 * @see elm_panes_content_left_set() for details.
22096 * @see elm_panes_content_left_get().
22100 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22103 * Unset the right content used for the panes.
22105 * @param obj The panes object.
22106 * @return The right content object that was being used.
22108 * Unparent and return the right content object which was set for this
22111 * @see elm_panes_content_right_set() for details.
22112 * @see elm_panes_content_right_get().
22116 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22119 * Get the size proportion of panes widget's left side.
22121 * @param obj The panes object.
22122 * @return float value between 0.0 and 1.0 representing size proportion
22125 * @see elm_panes_content_left_size_set() for more details.
22129 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22132 * Set the size proportion of panes widget's left side.
22134 * @param obj The panes object.
22135 * @param size Value between 0.0 and 1.0 representing size proportion
22138 * By default it's homogeneous, i.e., both sides have the same size.
22140 * If something different is required, it can be set with this function.
22141 * For example, if the left content should be displayed over
22142 * 75% of the panes size, @p size should be passed as @c 0.75.
22143 * This way, right content will be resized to 25% of panes size.
22145 * If displayed vertically, left content is displayed at top, and
22146 * right content at bottom.
22148 * @note This proportion will change when user drags the panes bar.
22150 * @see elm_panes_content_left_size_get()
22154 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22157 * Set the orientation of a given panes widget.
22159 * @param obj The panes object.
22160 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22161 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22163 * Use this function to change how your panes is to be
22164 * disposed: vertically or horizontally.
22166 * By default it's displayed horizontally.
22168 * @see elm_panes_horizontal_get()
22172 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22175 * Retrieve the orientation of a given panes widget.
22177 * @param obj The panes object.
22178 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22179 * @c EINA_FALSE if it's @b vertical (and on errors).
22181 * @see elm_panes_horizontal_set() for more details.
22185 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22192 * @defgroup Flip Flip
22194 * @image html img/widget/flip/preview-00.png
22195 * @image latex img/widget/flip/preview-00.eps
22197 * This widget holds 2 content objects(Evas_Object): one on the front and one
22198 * on the back. It allows you to flip from front to back and vice-versa using
22199 * various animations.
22201 * If either the front or back contents are not set the flip will treat that
22202 * as transparent. So if you wore to set the front content but not the back,
22203 * and then call elm_flip_go() you would see whatever is below the flip.
22205 * For a list of supported animations see elm_flip_go().
22207 * Signals that you can add callbacks for are:
22208 * "animate,begin" - when a flip animation was started
22209 * "animate,done" - when a flip animation is finished
22211 * @ref tutorial_flip show how to use most of the API.
22215 typedef enum _Elm_Flip_Mode
22217 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22218 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22219 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22220 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22221 ELM_FLIP_CUBE_LEFT,
22222 ELM_FLIP_CUBE_RIGHT,
22224 ELM_FLIP_CUBE_DOWN,
22225 ELM_FLIP_PAGE_LEFT,
22226 ELM_FLIP_PAGE_RIGHT,
22230 typedef enum _Elm_Flip_Interaction
22232 ELM_FLIP_INTERACTION_NONE,
22233 ELM_FLIP_INTERACTION_ROTATE,
22234 ELM_FLIP_INTERACTION_CUBE,
22235 ELM_FLIP_INTERACTION_PAGE
22236 } Elm_Flip_Interaction;
22237 typedef enum _Elm_Flip_Direction
22239 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22240 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22241 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22242 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22243 } Elm_Flip_Direction;
22245 * @brief Add a new flip to the parent
22247 * @param parent The parent object
22248 * @return The new object or NULL if it cannot be created
22250 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22252 * @brief Set the front content of the flip widget.
22254 * @param obj The flip object
22255 * @param content The new front content object
22257 * Once the content object is set, a previously set one will be deleted.
22258 * If you want to keep that old content object, use the
22259 * elm_flip_content_front_unset() function.
22261 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22263 * @brief Set the back content of the flip widget.
22265 * @param obj The flip object
22266 * @param content The new back content object
22268 * Once the content object is set, a previously set one will be deleted.
22269 * If you want to keep that old content object, use the
22270 * elm_flip_content_back_unset() function.
22272 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22274 * @brief Get the front content used for the flip
22276 * @param obj The flip object
22277 * @return The front content object that is being used
22279 * Return the front content object which is set for this widget.
22281 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22283 * @brief Get the back content used for the flip
22285 * @param obj The flip object
22286 * @return The back content object that is being used
22288 * Return the back content object which is set for this widget.
22290 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22292 * @brief Unset the front content used for the flip
22294 * @param obj The flip object
22295 * @return The front content object that was being used
22297 * Unparent and return the front content object which was set for this widget.
22299 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22301 * @brief Unset the back content used for the flip
22303 * @param obj The flip object
22304 * @return The back content object that was being used
22306 * Unparent and return the back content object which was set for this widget.
22308 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22310 * @brief Get flip front visibility state
22312 * @param obj The flip objct
22313 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22316 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22318 * @brief Set flip perspective
22320 * @param obj The flip object
22321 * @param foc The coordinate to set the focus on
22322 * @param x The X coordinate
22323 * @param y The Y coordinate
22325 * @warning This function currently does nothing.
22327 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22329 * @brief Runs the flip animation
22331 * @param obj The flip object
22332 * @param mode The mode type
22334 * Flips the front and back contents using the @p mode animation. This
22335 * efectively hides the currently visible content and shows the hidden one.
22337 * There a number of possible animations to use for the flipping:
22338 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22339 * around a horizontal axis in the middle of its height, the other content
22340 * is shown as the other side of the flip.
22341 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22342 * around a vertical axis in the middle of its width, the other content is
22343 * shown as the other side of the flip.
22344 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22345 * around a diagonal axis in the middle of its width, the other content is
22346 * shown as the other side of the flip.
22347 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22348 * around a diagonal axis in the middle of its height, the other content is
22349 * shown as the other side of the flip.
22350 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22351 * as if the flip was a cube, the other content is show as the right face of
22353 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22354 * right as if the flip was a cube, the other content is show as the left
22355 * face of the cube.
22356 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22357 * flip was a cube, the other content is show as the bottom face of the cube.
22358 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22359 * the flip was a cube, the other content is show as the upper face of the
22361 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22362 * if the flip was a book, the other content is shown as the page below that.
22363 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22364 * as if the flip was a book, the other content is shown as the page below
22366 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22367 * flip was a book, the other content is shown as the page below that.
22368 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22369 * flip was a book, the other content is shown as the page below that.
22371 * @image html elm_flip.png
22372 * @image latex elm_flip.eps width=\textwidth
22374 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22376 * @brief Set the interactive flip mode
22378 * @param obj The flip object
22379 * @param mode The interactive flip mode to use
22381 * This sets if the flip should be interactive (allow user to click and
22382 * drag a side of the flip to reveal the back page and cause it to flip).
22383 * By default a flip is not interactive. You may also need to set which
22384 * sides of the flip are "active" for flipping and how much space they use
22385 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22386 * and elm_flip_interacton_direction_hitsize_set()
22388 * The four avilable mode of interaction are:
22389 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22390 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22391 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22392 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22394 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22395 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22396 * happen, those can only be acheived with elm_flip_go();
22398 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22400 * @brief Get the interactive flip mode
22402 * @param obj The flip object
22403 * @return The interactive flip mode
22405 * Returns the interactive flip mode set by elm_flip_interaction_set()
22407 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22409 * @brief Set which directions of the flip respond to interactive flip
22411 * @param obj The flip object
22412 * @param dir The direction to change
22413 * @param enabled If that direction is enabled or not
22415 * By default all directions are disabled, so you may want to enable the
22416 * desired directions for flipping if you need interactive flipping. You must
22417 * call this function once for each direction that should be enabled.
22419 * @see elm_flip_interaction_set()
22421 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22423 * @brief Get the enabled state of that flip direction
22425 * @param obj The flip object
22426 * @param dir The direction to check
22427 * @return If that direction is enabled or not
22429 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22431 * @see elm_flip_interaction_set()
22433 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22435 * @brief Set the amount of the flip that is sensitive to interactive flip
22437 * @param obj The flip object
22438 * @param dir The direction to modify
22439 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22441 * Set the amount of the flip that is sensitive to interactive flip, with 0
22442 * representing no area in the flip and 1 representing the entire flip. There
22443 * is however a consideration to be made in that the area will never be
22444 * smaller than the finger size set(as set in your Elementary configuration).
22446 * @see elm_flip_interaction_set()
22448 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22450 * @brief Get the amount of the flip that is sensitive to interactive flip
22452 * @param obj The flip object
22453 * @param dir The direction to check
22454 * @return The size set for that direction
22456 * Returns the amount os sensitive area set by
22457 * elm_flip_interacton_direction_hitsize_set().
22459 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22464 /* scrolledentry */
22465 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22466 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22467 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22468 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22469 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22470 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22471 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22472 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22473 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22474 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22475 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22476 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22477 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22478 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22479 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22480 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22481 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22482 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22483 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22484 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22485 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22486 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22487 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22488 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22489 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22490 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22491 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22492 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22493 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22494 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22495 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22496 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22497 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22498 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22499 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22500 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);
22501 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22502 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22503 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);
22504 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22505 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);
22506 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22507 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22508 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22509 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22510 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22511 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22512 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22513 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22514 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);
22515 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);
22516 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);
22517 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);
22518 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);
22519 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);
22520 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22521 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22522 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22523 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22524 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22525 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22526 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22529 * @defgroup Conformant Conformant
22530 * @ingroup Elementary
22532 * @image html img/widget/conformant/preview-00.png
22533 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22535 * @image html img/conformant.png
22536 * @image latex img/conformant.eps width=\textwidth
22538 * The aim is to provide a widget that can be used in elementary apps to
22539 * account for space taken up by the indicator, virtual keypad & softkey
22540 * windows when running the illume2 module of E17.
22542 * So conformant content will be sized and positioned considering the
22543 * space required for such stuff, and when they popup, as a keyboard
22544 * shows when an entry is selected, conformant content won't change.
22546 * Available styles for it:
22549 * See how to use this widget in this example:
22550 * @ref conformant_example
22554 * @addtogroup Conformant
22559 * Add a new conformant widget to the given parent Elementary
22560 * (container) object.
22562 * @param parent The parent object.
22563 * @return A new conformant widget handle or @c NULL, on errors.
22565 * This function inserts a new conformant widget on the canvas.
22567 * @ingroup Conformant
22569 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22572 * Set the content of the conformant widget.
22574 * @param obj The conformant object.
22575 * @param content The content to be displayed by the conformant.
22577 * Content will be sized and positioned considering the space required
22578 * to display a virtual keyboard. So it won't fill all the conformant
22579 * size. This way is possible to be sure that content won't resize
22580 * or be re-positioned after the keyboard is displayed.
22582 * Once the content object is set, a previously set one will be deleted.
22583 * If you want to keep that old content object, use the
22584 * elm_conformat_content_unset() function.
22586 * @see elm_conformant_content_unset()
22587 * @see elm_conformant_content_get()
22589 * @ingroup Conformant
22591 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22594 * Get the content of the conformant widget.
22596 * @param obj The conformant object.
22597 * @return The content that is being used.
22599 * Return the content object which is set for this widget.
22600 * It won't be unparent from conformant. For that, use
22601 * elm_conformant_content_unset().
22603 * @see elm_conformant_content_set() for more details.
22604 * @see elm_conformant_content_unset()
22606 * @ingroup Conformant
22608 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22611 * Unset the content of the conformant widget.
22613 * @param obj The conformant object.
22614 * @return The content that was being used.
22616 * Unparent and return the content object which was set for this widget.
22618 * @see elm_conformant_content_set() for more details.
22620 * @ingroup Conformant
22622 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22625 * Returns the Evas_Object that represents the content area.
22627 * @param obj The conformant object.
22628 * @return The content area of the widget.
22630 * @ingroup Conformant
22632 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22639 * @defgroup Mapbuf Mapbuf
22640 * @ingroup Elementary
22642 * @image html img/widget/mapbuf/preview-00.png
22643 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22645 * This holds one content object and uses an Evas Map of transformation
22646 * points to be later used with this content. So the content will be
22647 * moved, resized, etc as a single image. So it will improve performance
22648 * when you have a complex interafce, with a lot of elements, and will
22649 * need to resize or move it frequently (the content object and its
22652 * See how to use this widget in this example:
22653 * @ref mapbuf_example
22657 * @addtogroup Mapbuf
22662 * Add a new mapbuf widget to the given parent Elementary
22663 * (container) object.
22665 * @param parent The parent object.
22666 * @return A new mapbuf widget handle or @c NULL, on errors.
22668 * This function inserts a new mapbuf widget on the canvas.
22672 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22675 * Set the content of the mapbuf.
22677 * @param obj The mapbuf object.
22678 * @param content The content that will be filled in this mapbuf object.
22680 * Once the content object is set, a previously set one will be deleted.
22681 * If you want to keep that old content object, use the
22682 * elm_mapbuf_content_unset() function.
22684 * To enable map, elm_mapbuf_enabled_set() should be used.
22688 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22691 * Get the content of the mapbuf.
22693 * @param obj The mapbuf object.
22694 * @return The content that is being used.
22696 * Return the content object which is set for this widget.
22698 * @see elm_mapbuf_content_set() for details.
22702 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22705 * Unset the content of the mapbuf.
22707 * @param obj The mapbuf object.
22708 * @return The content that was being used.
22710 * Unparent and return the content object which was set for this widget.
22712 * @see elm_mapbuf_content_set() for details.
22716 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22719 * Enable or disable the map.
22721 * @param obj The mapbuf object.
22722 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22724 * This enables the map that is set or disables it. On enable, the object
22725 * geometry will be saved, and the new geometry will change (position and
22726 * size) to reflect the map geometry set.
22728 * Also, when enabled, alpha and smooth states will be used, so if the
22729 * content isn't solid, alpha should be enabled, for example, otherwise
22730 * a black retangle will fill the content.
22732 * When disabled, the stored map will be freed and geometry prior to
22733 * enabling the map will be restored.
22735 * It's disabled by default.
22737 * @see elm_mapbuf_alpha_set()
22738 * @see elm_mapbuf_smooth_set()
22742 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22745 * Get a value whether map is enabled or not.
22747 * @param obj The mapbuf object.
22748 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22749 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22751 * @see elm_mapbuf_enabled_set() for details.
22755 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22758 * Enable or disable smooth map rendering.
22760 * @param obj The mapbuf object.
22761 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22764 * This sets smoothing for map rendering. If the object is a type that has
22765 * its own smoothing settings, then both the smooth settings for this object
22766 * and the map must be turned off.
22768 * By default smooth maps are enabled.
22772 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22775 * Get a value whether smooth map rendering is enabled or not.
22777 * @param obj The mapbuf object.
22778 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
22779 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22781 * @see elm_mapbuf_smooth_set() for details.
22785 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22788 * Set or unset alpha flag for map rendering.
22790 * @param obj The mapbuf object.
22791 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
22794 * This sets alpha flag for map rendering. If the object is a type that has
22795 * its own alpha settings, then this will take precedence. Only image objects
22796 * have this currently. It stops alpha blending of the map area, and is
22797 * useful if you know the object and/or all sub-objects is 100% solid.
22799 * Alpha is enabled by default.
22803 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
22806 * Get a value whether alpha blending is enabled or not.
22808 * @param obj The mapbuf object.
22809 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
22810 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22812 * @see elm_mapbuf_alpha_set() for details.
22816 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22823 * @defgroup Flipselector Flip Selector
22825 * @image html img/widget/flipselector/preview-00.png
22826 * @image latex img/widget/flipselector/preview-00.eps
22828 * A flip selector is a widget to show a set of @b text items, one
22829 * at a time, with the same sheet switching style as the @ref Clock
22830 * "clock" widget, when one changes the current displaying sheet
22831 * (thus, the "flip" in the name).
22833 * User clicks to flip sheets which are @b held for some time will
22834 * make the flip selector to flip continuosly and automatically for
22835 * the user. The interval between flips will keep growing in time,
22836 * so that it helps the user to reach an item which is distant from
22837 * the current selection.
22839 * Smart callbacks one can register to:
22840 * - @c "selected" - when the widget's selected text item is changed
22841 * - @c "overflowed" - when the widget's current selection is changed
22842 * from the first item in its list to the last
22843 * - @c "underflowed" - when the widget's current selection is changed
22844 * from the last item in its list to the first
22846 * Available styles for it:
22849 * Here is an example on its usage:
22850 * @li @ref flipselector_example
22854 * @addtogroup Flipselector
22858 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
22861 * Add a new flip selector widget to the given parent Elementary
22862 * (container) widget
22864 * @param parent The parent object
22865 * @return a new flip selector widget handle or @c NULL, on errors
22867 * This function inserts a new flip selector widget on the canvas.
22869 * @ingroup Flipselector
22871 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22874 * Programmatically select the next item of a flip selector widget
22876 * @param obj The flipselector object
22878 * @note The selection will be animated. Also, if it reaches the
22879 * end of its list of member items, it will continue with the first
22882 * @ingroup Flipselector
22884 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22887 * Programmatically select the previous item of a flip selector
22890 * @param obj The flipselector object
22892 * @note The selection will be animated. Also, if it reaches the
22893 * beginning of its list of member items, it will continue with the
22894 * last one backwards.
22896 * @ingroup Flipselector
22898 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22901 * Append a (text) item to a flip selector widget
22903 * @param obj The flipselector object
22904 * @param label The (text) label of the new item
22905 * @param func Convenience callback function to take place when
22907 * @param data Data passed to @p func, above
22908 * @return A handle to the item added or @c NULL, on errors
22910 * The widget's list of labels to show will be appended with the
22911 * given value. If the user wishes so, a callback function pointer
22912 * can be passed, which will get called when this same item is
22915 * @note The current selection @b won't be modified by appending an
22916 * element to the list.
22918 * @note The maximum length of the text label is going to be
22919 * determined <b>by the widget's theme</b>. Strings larger than
22920 * that value are going to be @b truncated.
22922 * @ingroup Flipselector
22924 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
22927 * Prepend a (text) item to a flip selector widget
22929 * @param obj The flipselector object
22930 * @param label The (text) label of the new item
22931 * @param func Convenience callback function to take place when
22933 * @param data Data passed to @p func, above
22934 * @return A handle to the item added or @c NULL, on errors
22936 * The widget's list of labels to show will be prepended with the
22937 * given value. If the user wishes so, a callback function pointer
22938 * can be passed, which will get called when this same item is
22941 * @note The current selection @b won't be modified by prepending
22942 * an element to the list.
22944 * @note The maximum length of the text label is going to be
22945 * determined <b>by the widget's theme</b>. Strings larger than
22946 * that value are going to be @b truncated.
22948 * @ingroup Flipselector
22950 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
22953 * Get the internal list of items in a given flip selector widget.
22955 * @param obj The flipselector object
22956 * @return The list of items (#Elm_Flipselector_Item as data) or
22957 * @c NULL on errors.
22959 * This list is @b not to be modified in any way and must not be
22960 * freed. Use the list members with functions like
22961 * elm_flipselector_item_label_set(),
22962 * elm_flipselector_item_label_get(),
22963 * elm_flipselector_item_del(),
22964 * elm_flipselector_item_selected_get(),
22965 * elm_flipselector_item_selected_set().
22967 * @warning This list is only valid until @p obj object's internal
22968 * items list is changed. It should be fetched again with another
22969 * call to this function when changes happen.
22971 * @ingroup Flipselector
22973 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22976 * Get the first item in the given flip selector widget's list of
22979 * @param obj The flipselector object
22980 * @return The first item or @c NULL, if it has no items (and on
22983 * @see elm_flipselector_item_append()
22984 * @see elm_flipselector_last_item_get()
22986 * @ingroup Flipselector
22988 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22991 * Get the last item in the given flip selector widget's list of
22994 * @param obj The flipselector object
22995 * @return The last item or @c NULL, if it has no items (and on
22998 * @see elm_flipselector_item_prepend()
22999 * @see elm_flipselector_first_item_get()
23001 * @ingroup Flipselector
23003 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23006 * Get the currently selected item in a flip selector widget.
23008 * @param obj The flipselector object
23009 * @return The selected item or @c NULL, if the widget has no items
23012 * @ingroup Flipselector
23014 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23017 * Set whether a given flip selector widget's item should be the
23018 * currently selected one.
23020 * @param item The flip selector item
23021 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23023 * This sets whether @p item is or not the selected (thus, under
23024 * display) one. If @p item is different than one under display,
23025 * the latter will be unselected. If the @p item is set to be
23026 * unselected, on the other hand, the @b first item in the widget's
23027 * internal members list will be the new selected one.
23029 * @see elm_flipselector_item_selected_get()
23031 * @ingroup Flipselector
23033 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23036 * Get whether a given flip selector widget's item is the currently
23039 * @param item The flip selector item
23040 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23043 * @see elm_flipselector_item_selected_set()
23045 * @ingroup Flipselector
23047 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23050 * Delete a given item from a flip selector widget.
23052 * @param item The item to delete
23054 * @ingroup Flipselector
23056 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23059 * Get the label of a given flip selector widget's item.
23061 * @param item The item to get label from
23062 * @return The text label of @p item or @c NULL, on errors
23064 * @see elm_flipselector_item_label_set()
23066 * @ingroup Flipselector
23068 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23071 * Set the label of a given flip selector widget's item.
23073 * @param item The item to set label on
23074 * @param label The text label string, in UTF-8 encoding
23076 * @see elm_flipselector_item_label_get()
23078 * @ingroup Flipselector
23080 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23083 * Gets the item before @p item in a flip selector widget's
23084 * internal list of items.
23086 * @param item The item to fetch previous from
23087 * @return The item before the @p item, in its parent's list. If
23088 * there is no previous item for @p item or there's an
23089 * error, @c NULL is returned.
23091 * @see elm_flipselector_item_next_get()
23093 * @ingroup Flipselector
23095 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23098 * Gets the item after @p item in a flip selector widget's
23099 * internal list of items.
23101 * @param item The item to fetch next from
23102 * @return The item after the @p item, in its parent's list. If
23103 * there is no next item for @p item or there's an
23104 * error, @c NULL is returned.
23106 * @see elm_flipselector_item_next_get()
23108 * @ingroup Flipselector
23110 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23113 * Set the interval on time updates for an user mouse button hold
23114 * on a flip selector widget.
23116 * @param obj The flip selector object
23117 * @param interval The (first) interval value in seconds
23119 * This interval value is @b decreased while the user holds the
23120 * mouse pointer either flipping up or flipping doww a given flip
23123 * This helps the user to get to a given item distant from the
23124 * current one easier/faster, as it will start to flip quicker and
23125 * quicker on mouse button holds.
23127 * The calculation for the next flip interval value, starting from
23128 * the one set with this call, is the previous interval divided by
23129 * 1.05, so it decreases a little bit.
23131 * The default starting interval value for automatic flips is
23134 * @see elm_flipselector_interval_get()
23136 * @ingroup Flipselector
23138 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23141 * Get the interval on time updates for an user mouse button hold
23142 * on a flip selector widget.
23144 * @param obj The flip selector object
23145 * @return The (first) interval value, in seconds, set on it
23147 * @see elm_flipselector_interval_set() for more details
23149 * @ingroup Flipselector
23151 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23157 * @addtogroup Calendar
23162 * @enum _Elm_Calendar_Mark_Repeat
23163 * @typedef Elm_Calendar_Mark_Repeat
23165 * Event periodicity, used to define if a mark should be repeated
23166 * @b beyond event's day. It's set when a mark is added.
23168 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23169 * there will be marks every week after this date. Marks will be displayed
23170 * at 13th, 20th, 27th, 3rd June ...
23172 * Values don't work as bitmask, only one can be choosen.
23174 * @see elm_calendar_mark_add()
23176 * @ingroup Calendar
23178 typedef enum _Elm_Calendar_Mark_Repeat
23180 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23181 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23182 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23183 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*/
23184 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. */
23185 } Elm_Calendar_Mark_Repeat;
23187 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(). */
23190 * Add a new calendar widget to the given parent Elementary
23191 * (container) object.
23193 * @param parent The parent object.
23194 * @return a new calendar widget handle or @c NULL, on errors.
23196 * This function inserts a new calendar widget on the canvas.
23198 * @ref calendar_example_01
23200 * @ingroup Calendar
23202 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23205 * Get weekdays names displayed by the calendar.
23207 * @param obj The calendar object.
23208 * @return Array of seven strings to be used as weekday names.
23210 * By default, weekdays abbreviations get from system are displayed:
23211 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23212 * The first string is related to Sunday, the second to Monday...
23214 * @see elm_calendar_weekdays_name_set()
23216 * @ref calendar_example_05
23218 * @ingroup Calendar
23220 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23223 * Set weekdays names to be displayed by the calendar.
23225 * @param obj The calendar object.
23226 * @param weekdays Array of seven strings to be used as weekday names.
23227 * @warning It must have 7 elements, or it will access invalid memory.
23228 * @warning The strings must be NULL terminated ('@\0').
23230 * By default, weekdays abbreviations get from system are displayed:
23231 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23233 * The first string should be related to Sunday, the second to Monday...
23235 * The usage should be like this:
23237 * const char *weekdays[] =
23239 * "Sunday", "Monday", "Tuesday", "Wednesday",
23240 * "Thursday", "Friday", "Saturday"
23242 * elm_calendar_weekdays_names_set(calendar, weekdays);
23245 * @see elm_calendar_weekdays_name_get()
23247 * @ref calendar_example_02
23249 * @ingroup Calendar
23251 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23254 * Set the minimum and maximum values for the year
23256 * @param obj The calendar object
23257 * @param min The minimum year, greater than 1901;
23258 * @param max The maximum year;
23260 * Maximum must be greater than minimum, except if you don't wan't to set
23262 * Default values are 1902 and -1.
23264 * If the maximum year is a negative value, it will be limited depending
23265 * on the platform architecture (year 2037 for 32 bits);
23267 * @see elm_calendar_min_max_year_get()
23269 * @ref calendar_example_03
23271 * @ingroup Calendar
23273 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23276 * Get the minimum and maximum values for the year
23278 * @param obj The calendar object.
23279 * @param min The minimum year.
23280 * @param max The maximum year.
23282 * Default values are 1902 and -1.
23284 * @see elm_calendar_min_max_year_get() for more details.
23286 * @ref calendar_example_05
23288 * @ingroup Calendar
23290 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23293 * Enable or disable day selection
23295 * @param obj The calendar object.
23296 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23299 * Enabled by default. If disabled, the user still can select months,
23300 * but not days. Selected days are highlighted on calendar.
23301 * It should be used if you won't need such selection for the widget usage.
23303 * When a day is selected, or month is changed, smart callbacks for
23304 * signal "changed" will be called.
23306 * @see elm_calendar_day_selection_enable_get()
23308 * @ref calendar_example_04
23310 * @ingroup Calendar
23312 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23315 * Get a value whether day selection is enabled or not.
23317 * @see elm_calendar_day_selection_enable_set() for details.
23319 * @param obj The calendar object.
23320 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23321 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23323 * @ref calendar_example_05
23325 * @ingroup Calendar
23327 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23331 * Set selected date to be highlighted on calendar.
23333 * @param obj The calendar object.
23334 * @param selected_time A @b tm struct to represent the selected date.
23336 * Set the selected date, changing the displayed month if needed.
23337 * Selected date changes when the user goes to next/previous month or
23338 * select a day pressing over it on calendar.
23340 * @see elm_calendar_selected_time_get()
23342 * @ref calendar_example_04
23344 * @ingroup Calendar
23346 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23349 * Get selected date.
23351 * @param obj The calendar object
23352 * @param selected_time A @b tm struct to point to selected date
23353 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23356 * Get date selected by the user or set by function
23357 * elm_calendar_selected_time_set().
23358 * Selected date changes when the user goes to next/previous month or
23359 * select a day pressing over it on calendar.
23361 * @see elm_calendar_selected_time_get()
23363 * @ref calendar_example_05
23365 * @ingroup Calendar
23367 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23370 * Set a function to format the string that will be used to display
23373 * @param obj The calendar object
23374 * @param format_function Function to set the month-year string given
23375 * the selected date
23377 * By default it uses strftime with "%B %Y" format string.
23378 * It should allocate the memory that will be used by the string,
23379 * that will be freed by the widget after usage.
23380 * A pointer to the string and a pointer to the time struct will be provided.
23385 * _format_month_year(struct tm *selected_time)
23388 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23389 * return strdup(buf);
23392 * elm_calendar_format_function_set(calendar, _format_month_year);
23395 * @ref calendar_example_02
23397 * @ingroup Calendar
23399 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23402 * Add a new mark to the calendar
23404 * @param obj The calendar object
23405 * @param mark_type A string used to define the type of mark. It will be
23406 * emitted to the theme, that should display a related modification on these
23407 * days representation.
23408 * @param mark_time A time struct to represent the date of inclusion of the
23409 * mark. For marks that repeats it will just be displayed after the inclusion
23410 * date in the calendar.
23411 * @param repeat Repeat the event following this periodicity. Can be a unique
23412 * mark (that don't repeat), daily, weekly, monthly or annually.
23413 * @return The created mark or @p NULL upon failure.
23415 * Add a mark that will be drawn in the calendar respecting the insertion
23416 * time and periodicity. It will emit the type as signal to the widget theme.
23417 * Default theme supports "holiday" and "checked", but it can be extended.
23419 * It won't immediately update the calendar, drawing the marks.
23420 * For this, call elm_calendar_marks_draw(). However, when user selects
23421 * next or previous month calendar forces marks drawn.
23423 * Marks created with this method can be deleted with
23424 * elm_calendar_mark_del().
23428 * struct tm selected_time;
23429 * time_t current_time;
23431 * current_time = time(NULL) + 5 * 84600;
23432 * localtime_r(¤t_time, &selected_time);
23433 * elm_calendar_mark_add(cal, "holiday", selected_time,
23434 * ELM_CALENDAR_ANNUALLY);
23436 * current_time = time(NULL) + 1 * 84600;
23437 * localtime_r(¤t_time, &selected_time);
23438 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23440 * elm_calendar_marks_draw(cal);
23443 * @see elm_calendar_marks_draw()
23444 * @see elm_calendar_mark_del()
23446 * @ref calendar_example_06
23448 * @ingroup Calendar
23450 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);
23453 * Delete mark from the calendar.
23455 * @param mark The mark to be deleted.
23457 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23458 * should be used instead of getting marks list and deleting each one.
23460 * @see elm_calendar_mark_add()
23462 * @ref calendar_example_06
23464 * @ingroup Calendar
23466 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23469 * Remove all calendar's marks
23471 * @param obj The calendar object.
23473 * @see elm_calendar_mark_add()
23474 * @see elm_calendar_mark_del()
23476 * @ingroup Calendar
23478 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23482 * Get a list of all the calendar marks.
23484 * @param obj The calendar object.
23485 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23487 * @see elm_calendar_mark_add()
23488 * @see elm_calendar_mark_del()
23489 * @see elm_calendar_marks_clear()
23491 * @ingroup Calendar
23493 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23496 * Draw calendar marks.
23498 * @param obj The calendar object.
23500 * Should be used after adding, removing or clearing marks.
23501 * It will go through the entire marks list updating the calendar.
23502 * If lots of marks will be added, add all the marks and then call
23505 * When the month is changed, i.e. user selects next or previous month,
23506 * marks will be drawed.
23508 * @see elm_calendar_mark_add()
23509 * @see elm_calendar_mark_del()
23510 * @see elm_calendar_marks_clear()
23512 * @ref calendar_example_06
23514 * @ingroup Calendar
23516 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23519 * Set a day text color to the same that represents Saturdays.
23521 * @param obj The calendar object.
23522 * @param pos The text position. Position is the cell counter, from left
23523 * to right, up to down. It starts on 0 and ends on 41.
23525 * @deprecated use elm_calendar_mark_add() instead like:
23528 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23529 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23532 * @see elm_calendar_mark_add()
23534 * @ingroup Calendar
23536 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23539 * Set a day text color to the same that represents Sundays.
23541 * @param obj The calendar object.
23542 * @param pos The text position. Position is the cell counter, from left
23543 * to right, up to down. It starts on 0 and ends on 41.
23545 * @deprecated use elm_calendar_mark_add() instead like:
23548 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23549 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23552 * @see elm_calendar_mark_add()
23554 * @ingroup Calendar
23556 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23559 * Set a day text color to the same that represents Weekdays.
23561 * @param obj The calendar object
23562 * @param pos The text position. Position is the cell counter, from left
23563 * to right, up to down. It starts on 0 and ends on 41.
23565 * @deprecated use elm_calendar_mark_add() instead like:
23568 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23570 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23571 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23572 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23573 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23574 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23575 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23576 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23577 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23578 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23581 * @see elm_calendar_mark_add()
23583 * @ingroup Calendar
23585 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23588 * Set the interval on time updates for an user mouse button hold
23589 * on calendar widgets' month selection.
23591 * @param obj The calendar object
23592 * @param interval The (first) interval value in seconds
23594 * This interval value is @b decreased while the user holds the
23595 * mouse pointer either selecting next or previous month.
23597 * This helps the user to get to a given month distant from the
23598 * current one easier/faster, as it will start to change quicker and
23599 * quicker on mouse button holds.
23601 * The calculation for the next change interval value, starting from
23602 * the one set with this call, is the previous interval divided by
23603 * 1.05, so it decreases a little bit.
23605 * The default starting interval value for automatic changes is
23608 * @see elm_calendar_interval_get()
23610 * @ingroup Calendar
23612 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23615 * Get the interval on time updates for an user mouse button hold
23616 * on calendar widgets' month selection.
23618 * @param obj The calendar object
23619 * @return The (first) interval value, in seconds, set on it
23621 * @see elm_calendar_interval_set() for more details
23623 * @ingroup Calendar
23625 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23632 * @defgroup Diskselector Diskselector
23633 * @ingroup Elementary
23635 * @image html img/widget/diskselector/preview-00.png
23636 * @image latex img/widget/diskselector/preview-00.eps
23638 * A diskselector is a kind of list widget. It scrolls horizontally,
23639 * and can contain label and icon objects. Three items are displayed
23640 * with the selected one in the middle.
23642 * It can act like a circular list with round mode and labels can be
23643 * reduced for a defined length for side items.
23645 * Smart callbacks one can listen to:
23646 * - "selected" - when item is selected, i.e. scroller stops.
23648 * Available styles for it:
23651 * List of examples:
23652 * @li @ref diskselector_example_01
23653 * @li @ref diskselector_example_02
23657 * @addtogroup Diskselector
23661 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(). */
23664 * Add a new diskselector widget to the given parent Elementary
23665 * (container) object.
23667 * @param parent The parent object.
23668 * @return a new diskselector widget handle or @c NULL, on errors.
23670 * This function inserts a new diskselector widget on the canvas.
23672 * @ingroup Diskselector
23674 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23677 * Enable or disable round mode.
23679 * @param obj The diskselector object.
23680 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23683 * Disabled by default. If round mode is enabled the items list will
23684 * work like a circle list, so when the user reaches the last item,
23685 * the first one will popup.
23687 * @see elm_diskselector_round_get()
23689 * @ingroup Diskselector
23691 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23694 * Get a value whether round mode is enabled or not.
23696 * @see elm_diskselector_round_set() for details.
23698 * @param obj The diskselector object.
23699 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23700 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23702 * @ingroup Diskselector
23704 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23707 * Get the side labels max length.
23709 * @deprecated use elm_diskselector_side_label_length_get() instead:
23711 * @param obj The diskselector object.
23712 * @return The max length defined for side labels, or 0 if not a valid
23715 * @ingroup Diskselector
23717 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23720 * Set the side labels max length.
23722 * @deprecated use elm_diskselector_side_label_length_set() instead:
23724 * @param obj The diskselector object.
23725 * @param len The max length defined for side labels.
23727 * @ingroup Diskselector
23729 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23732 * Get the side labels max length.
23734 * @see elm_diskselector_side_label_length_set() for details.
23736 * @param obj The diskselector object.
23737 * @return The max length defined for side labels, or 0 if not a valid
23740 * @ingroup Diskselector
23742 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23745 * Set the side labels max length.
23747 * @param obj The diskselector object.
23748 * @param len The max length defined for side labels.
23750 * Length is the number of characters of items' label that will be
23751 * visible when it's set on side positions. It will just crop
23752 * the string after defined size. E.g.:
23754 * An item with label "January" would be displayed on side position as
23755 * "Jan" if max length is set to 3, or "Janu", if this property
23758 * When it's selected, the entire label will be displayed, except for
23759 * width restrictions. In this case label will be cropped and "..."
23760 * will be concatenated.
23762 * Default side label max length is 3.
23764 * This property will be applyed over all items, included before or
23765 * later this function call.
23767 * @ingroup Diskselector
23769 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23772 * Set the number of items to be displayed.
23774 * @param obj The diskselector object.
23775 * @param num The number of items the diskselector will display.
23777 * Default value is 3, and also it's the minimun. If @p num is less
23778 * than 3, it will be set to 3.
23780 * Also, it can be set on theme, using data item @c display_item_num
23781 * on group "elm/diskselector/item/X", where X is style set.
23784 * group { name: "elm/diskselector/item/X";
23786 * item: "display_item_num" "5";
23789 * @ingroup Diskselector
23791 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
23794 * Set bouncing behaviour when the scrolled content reaches an edge.
23796 * Tell the internal scroller object whether it should bounce or not
23797 * when it reaches the respective edges for each axis.
23799 * @param obj The diskselector object.
23800 * @param h_bounce Whether to bounce or not in the horizontal axis.
23801 * @param v_bounce Whether to bounce or not in the vertical axis.
23803 * @see elm_scroller_bounce_set()
23805 * @ingroup Diskselector
23807 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23810 * Get the bouncing behaviour of the internal scroller.
23812 * Get whether the internal scroller should bounce when the edge of each
23813 * axis is reached scrolling.
23815 * @param obj The diskselector object.
23816 * @param h_bounce Pointer where to store the bounce state of the horizontal
23818 * @param v_bounce Pointer where to store the bounce state of the vertical
23821 * @see elm_scroller_bounce_get()
23822 * @see elm_diskselector_bounce_set()
23824 * @ingroup Diskselector
23826 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23829 * Get the scrollbar policy.
23831 * @see elm_diskselector_scroller_policy_get() for details.
23833 * @param obj The diskselector object.
23834 * @param policy_h Pointer where to store horizontal scrollbar policy.
23835 * @param policy_v Pointer where to store vertical scrollbar policy.
23837 * @ingroup Diskselector
23839 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);
23842 * Set the scrollbar policy.
23844 * @param obj The diskselector object.
23845 * @param policy_h Horizontal scrollbar policy.
23846 * @param policy_v Vertical scrollbar policy.
23848 * This sets the scrollbar visibility policy for the given scroller.
23849 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
23850 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
23851 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
23852 * This applies respectively for the horizontal and vertical scrollbars.
23854 * The both are disabled by default, i.e., are set to
23855 * #ELM_SCROLLER_POLICY_OFF.
23857 * @ingroup Diskselector
23859 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
23862 * Remove all diskselector's items.
23864 * @param obj The diskselector object.
23866 * @see elm_diskselector_item_del()
23867 * @see elm_diskselector_item_append()
23869 * @ingroup Diskselector
23871 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23874 * Get a list of all the diskselector items.
23876 * @param obj The diskselector object.
23877 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
23878 * or @c NULL on failure.
23880 * @see elm_diskselector_item_append()
23881 * @see elm_diskselector_item_del()
23882 * @see elm_diskselector_clear()
23884 * @ingroup Diskselector
23886 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23889 * Appends a new item to the diskselector object.
23891 * @param obj The diskselector object.
23892 * @param label The label of the diskselector item.
23893 * @param icon The icon object to use at left side of the item. An
23894 * icon can be any Evas object, but usually it is an icon created
23895 * with elm_icon_add().
23896 * @param func The function to call when the item is selected.
23897 * @param data The data to associate with the item for related callbacks.
23899 * @return The created item or @c NULL upon failure.
23901 * A new item will be created and appended to the diskselector, i.e., will
23902 * be set as last item. Also, if there is no selected item, it will
23903 * be selected. This will always happens for the first appended item.
23905 * If no icon is set, label will be centered on item position, otherwise
23906 * the icon will be placed at left of the label, that will be shifted
23909 * Items created with this method can be deleted with
23910 * elm_diskselector_item_del().
23912 * Associated @p data can be properly freed when item is deleted if a
23913 * callback function is set with elm_diskselector_item_del_cb_set().
23915 * If a function is passed as argument, it will be called everytime this item
23916 * is selected, i.e., the user stops the diskselector with this
23917 * item on center position. If such function isn't needed, just passing
23918 * @c NULL as @p func is enough. The same should be done for @p data.
23920 * Simple example (with no function callback or data associated):
23922 * disk = elm_diskselector_add(win);
23923 * ic = elm_icon_add(win);
23924 * elm_icon_file_set(ic, "path/to/image", NULL);
23925 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23926 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
23929 * @see elm_diskselector_item_del()
23930 * @see elm_diskselector_item_del_cb_set()
23931 * @see elm_diskselector_clear()
23932 * @see elm_icon_add()
23934 * @ingroup Diskselector
23936 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);
23940 * Delete them item from the diskselector.
23942 * @param it The item of diskselector to be deleted.
23944 * If deleting all diskselector items is required, elm_diskselector_clear()
23945 * should be used instead of getting items list and deleting each one.
23947 * @see elm_diskselector_clear()
23948 * @see elm_diskselector_item_append()
23949 * @see elm_diskselector_item_del_cb_set()
23951 * @ingroup Diskselector
23953 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
23956 * Set the function called when a diskselector item is freed.
23958 * @param it The item to set the callback on
23959 * @param func The function called
23961 * If there is a @p func, then it will be called prior item's memory release.
23962 * That will be called with the following arguments:
23964 * @li item's Evas object;
23967 * This way, a data associated to a diskselector item could be properly
23970 * @ingroup Diskselector
23972 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23975 * Get the data associated to the item.
23977 * @param it The diskselector item
23978 * @return The data associated to @p it
23980 * The return value is a pointer to data associated to @p item when it was
23981 * created, with function elm_diskselector_item_append(). If no data
23982 * was passed as argument, it will return @c NULL.
23984 * @see elm_diskselector_item_append()
23986 * @ingroup Diskselector
23988 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
23991 * Set the icon associated to the item.
23993 * @param it The diskselector item
23994 * @param icon The icon object to associate with @p it
23996 * The icon object to use at left side of the item. An
23997 * icon can be any Evas object, but usually it is an icon created
23998 * with elm_icon_add().
24000 * Once the icon object is set, a previously set one will be deleted.
24001 * @warning Setting the same icon for two items will cause the icon to
24002 * dissapear from the first item.
24004 * If an icon was passed as argument on item creation, with function
24005 * elm_diskselector_item_append(), it will be already
24006 * associated to the item.
24008 * @see elm_diskselector_item_append()
24009 * @see elm_diskselector_item_icon_get()
24011 * @ingroup Diskselector
24013 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24016 * Get the icon associated to the item.
24018 * @param it The diskselector item
24019 * @return The icon associated to @p it
24021 * The return value is a pointer to the icon associated to @p item when it was
24022 * created, with function elm_diskselector_item_append(), or later
24023 * with function elm_diskselector_item_icon_set. If no icon
24024 * was passed as argument, it will return @c NULL.
24026 * @see elm_diskselector_item_append()
24027 * @see elm_diskselector_item_icon_set()
24029 * @ingroup Diskselector
24031 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24034 * Set the label of item.
24036 * @param it The item of diskselector.
24037 * @param label The label of item.
24039 * The label to be displayed by the item.
24041 * If no icon is set, label will be centered on item position, otherwise
24042 * the icon will be placed at left of the label, that will be shifted
24045 * An item with label "January" would be displayed on side position as
24046 * "Jan" if max length is set to 3 with function
24047 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24050 * When this @p item is selected, the entire label will be displayed,
24051 * except for width restrictions.
24052 * In this case label will be cropped and "..." will be concatenated,
24053 * but only for display purposes. It will keep the entire string, so
24054 * if diskselector is resized the remaining characters will be displayed.
24056 * If a label was passed as argument on item creation, with function
24057 * elm_diskselector_item_append(), it will be already
24058 * displayed by the item.
24060 * @see elm_diskselector_side_label_lenght_set()
24061 * @see elm_diskselector_item_label_get()
24062 * @see elm_diskselector_item_append()
24064 * @ingroup Diskselector
24066 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24069 * Get the label of item.
24071 * @param it The item of diskselector.
24072 * @return The label of item.
24074 * The return value is a pointer to the label associated to @p item when it was
24075 * created, with function elm_diskselector_item_append(), or later
24076 * with function elm_diskselector_item_label_set. If no label
24077 * was passed as argument, it will return @c NULL.
24079 * @see elm_diskselector_item_label_set() for more details.
24080 * @see elm_diskselector_item_append()
24082 * @ingroup Diskselector
24084 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24087 * Get the selected item.
24089 * @param obj The diskselector object.
24090 * @return The selected diskselector item.
24092 * The selected item can be unselected with function
24093 * elm_diskselector_item_selected_set(), and the first item of
24094 * diskselector will be selected.
24096 * The selected item always will be centered on diskselector, with
24097 * full label displayed, i.e., max lenght set to side labels won't
24098 * apply on the selected item. More details on
24099 * elm_diskselector_side_label_length_set().
24101 * @ingroup Diskselector
24103 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24106 * Set the selected state of an item.
24108 * @param it The diskselector item
24109 * @param selected The selected state
24111 * This sets the selected state of the given item @p it.
24112 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24114 * If a new item is selected the previosly selected will be unselected.
24115 * Previoulsy selected item can be get with function
24116 * elm_diskselector_selected_item_get().
24118 * If the item @p it is unselected, the first item of diskselector will
24121 * Selected items will be visible on center position of diskselector.
24122 * So if it was on another position before selected, or was invisible,
24123 * diskselector will animate items until the selected item reaches center
24126 * @see elm_diskselector_item_selected_get()
24127 * @see elm_diskselector_selected_item_get()
24129 * @ingroup Diskselector
24131 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24134 * Get whether the @p item is selected or not.
24136 * @param it The diskselector item.
24137 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24138 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24140 * @see elm_diskselector_selected_item_set() for details.
24141 * @see elm_diskselector_item_selected_get()
24143 * @ingroup Diskselector
24145 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24148 * Get the first item of the diskselector.
24150 * @param obj The diskselector object.
24151 * @return The first item, or @c NULL if none.
24153 * The list of items follows append order. So it will return the first
24154 * item appended to the widget that wasn't deleted.
24156 * @see elm_diskselector_item_append()
24157 * @see elm_diskselector_items_get()
24159 * @ingroup Diskselector
24161 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24164 * Get the last item of the diskselector.
24166 * @param obj The diskselector object.
24167 * @return The last item, or @c NULL if none.
24169 * The list of items follows append order. So it will return last first
24170 * item appended to the widget that wasn't deleted.
24172 * @see elm_diskselector_item_append()
24173 * @see elm_diskselector_items_get()
24175 * @ingroup Diskselector
24177 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24180 * Get the item before @p item in diskselector.
24182 * @param it The diskselector item.
24183 * @return The item before @p item, or @c NULL if none or on failure.
24185 * The list of items follows append order. So it will return item appended
24186 * just before @p item and that wasn't deleted.
24188 * If it is the first item, @c NULL will be returned.
24189 * First item can be get by elm_diskselector_first_item_get().
24191 * @see elm_diskselector_item_append()
24192 * @see elm_diskselector_items_get()
24194 * @ingroup Diskselector
24196 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24199 * Get the item after @p item in diskselector.
24201 * @param it The diskselector item.
24202 * @return The item after @p item, or @c NULL if none or on failure.
24204 * The list of items follows append order. So it will return item appended
24205 * just after @p item and that wasn't deleted.
24207 * If it is the last item, @c NULL will be returned.
24208 * Last item can be get by elm_diskselector_last_item_get().
24210 * @see elm_diskselector_item_append()
24211 * @see elm_diskselector_items_get()
24213 * @ingroup Diskselector
24215 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24218 * Set the text to be shown in the diskselector item.
24220 * @param item Target item
24221 * @param text The text to set in the content
24223 * Setup the text as tooltip to object. The item can have only one tooltip,
24224 * so any previous tooltip data is removed.
24226 * @see elm_object_tooltip_text_set() for more details.
24228 * @ingroup Diskselector
24230 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24233 * Set the content to be shown in the tooltip item.
24235 * Setup the tooltip to item. The item can have only one tooltip,
24236 * so any previous tooltip data is removed. @p func(with @p data) will
24237 * be called every time that need show the tooltip and it should
24238 * return a valid Evas_Object. This object is then managed fully by
24239 * tooltip system and is deleted when the tooltip is gone.
24241 * @param item the diskselector item being attached a tooltip.
24242 * @param func the function used to create the tooltip contents.
24243 * @param data what to provide to @a func as callback data/context.
24244 * @param del_cb called when data is not needed anymore, either when
24245 * another callback replaces @p func, the tooltip is unset with
24246 * elm_diskselector_item_tooltip_unset() or the owner @a item
24247 * dies. This callback receives as the first parameter the
24248 * given @a data, and @c event_info is the item.
24250 * @see elm_object_tooltip_content_cb_set() for more details.
24252 * @ingroup Diskselector
24254 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);
24257 * Unset tooltip from item.
24259 * @param item diskselector item to remove previously set tooltip.
24261 * Remove tooltip from item. The callback provided as del_cb to
24262 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24263 * it is not used anymore.
24265 * @see elm_object_tooltip_unset() for more details.
24266 * @see elm_diskselector_item_tooltip_content_cb_set()
24268 * @ingroup Diskselector
24270 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24274 * Sets a different style for this item tooltip.
24276 * @note before you set a style you should define a tooltip with
24277 * elm_diskselector_item_tooltip_content_cb_set() or
24278 * elm_diskselector_item_tooltip_text_set()
24280 * @param item diskselector item with tooltip already set.
24281 * @param style the theme style to use (default, transparent, ...)
24283 * @see elm_object_tooltip_style_set() for more details.
24285 * @ingroup Diskselector
24287 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24290 * Get the style for this item tooltip.
24292 * @param item diskselector item with tooltip already set.
24293 * @return style the theme style in use, defaults to "default". If the
24294 * object does not have a tooltip set, then NULL is returned.
24296 * @see elm_object_tooltip_style_get() for more details.
24297 * @see elm_diskselector_item_tooltip_style_set()
24299 * @ingroup Diskselector
24301 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24304 * Set the cursor to be shown when mouse is over the diskselector item
24306 * @param item Target item
24307 * @param cursor the cursor name to be used.
24309 * @see elm_object_cursor_set() for more details.
24311 * @ingroup Diskselector
24313 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24316 * Get the cursor to be shown when mouse is over the diskselector item
24318 * @param item diskselector item with cursor already set.
24319 * @return the cursor name.
24321 * @see elm_object_cursor_get() for more details.
24322 * @see elm_diskselector_cursor_set()
24324 * @ingroup Diskselector
24326 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24330 * Unset the cursor to be shown when mouse is over the diskselector item
24332 * @param item Target item
24334 * @see elm_object_cursor_unset() for more details.
24335 * @see elm_diskselector_cursor_set()
24337 * @ingroup Diskselector
24339 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24342 * Sets a different style for this item cursor.
24344 * @note before you set a style you should define a cursor with
24345 * elm_diskselector_item_cursor_set()
24347 * @param item diskselector item with cursor already set.
24348 * @param style the theme style to use (default, transparent, ...)
24350 * @see elm_object_cursor_style_set() for more details.
24352 * @ingroup Diskselector
24354 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24358 * Get the style for this item cursor.
24360 * @param item diskselector item with cursor already set.
24361 * @return style the theme style in use, defaults to "default". If the
24362 * object does not have a cursor set, then @c NULL is returned.
24364 * @see elm_object_cursor_style_get() for more details.
24365 * @see elm_diskselector_item_cursor_style_set()
24367 * @ingroup Diskselector
24369 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24373 * Set if the cursor set should be searched on the theme or should use
24374 * the provided by the engine, only.
24376 * @note before you set if should look on theme you should define a cursor
24377 * with elm_diskselector_item_cursor_set().
24378 * By default it will only look for cursors provided by the engine.
24380 * @param item widget item with cursor already set.
24381 * @param engine_only boolean to define if cursors set with
24382 * elm_diskselector_item_cursor_set() should be searched only
24383 * between cursors provided by the engine or searched on widget's
24386 * @see elm_object_cursor_engine_only_set() for more details.
24388 * @ingroup Diskselector
24390 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24393 * Get the cursor engine only usage for this item cursor.
24395 * @param item widget item with cursor already set.
24396 * @return engine_only boolean to define it cursors should be looked only
24397 * between the provided by the engine or searched on widget's theme as well.
24398 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24400 * @see elm_object_cursor_engine_only_get() for more details.
24401 * @see elm_diskselector_item_cursor_engine_only_set()
24403 * @ingroup Diskselector
24405 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24412 * @defgroup Colorselector Colorselector
24416 * @image html img/widget/colorselector/preview-00.png
24417 * @image latex img/widget/colorselector/preview-00.eps
24419 * @brief Widget for user to select a color.
24421 * Signals that you can add callbacks for are:
24422 * "changed" - When the color value changes(event_info is NULL).
24424 * See @ref tutorial_colorselector.
24427 * @brief Add a new colorselector to the parent
24429 * @param parent The parent object
24430 * @return The new object or NULL if it cannot be created
24432 * @ingroup Colorselector
24434 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24436 * Set a color for the colorselector
24438 * @param obj Colorselector object
24439 * @param r r-value of color
24440 * @param g g-value of color
24441 * @param b b-value of color
24442 * @param a a-value of color
24444 * @ingroup Colorselector
24446 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24448 * Get a color from the colorselector
24450 * @param obj Colorselector object
24451 * @param r integer pointer for r-value of color
24452 * @param g integer pointer for g-value of color
24453 * @param b integer pointer for b-value of color
24454 * @param a integer pointer for a-value of color
24456 * @ingroup Colorselector
24458 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24464 * @defgroup Ctxpopup Ctxpopup
24466 * @image html img/widget/ctxpopup/preview-00.png
24467 * @image latex img/widget/ctxpopup/preview-00.eps
24469 * @brief Context popup widet.
24471 * A ctxpopup is a widget that, when shown, pops up a list of items.
24472 * It automatically chooses an area inside its parent object's view
24473 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24474 * optimally fit into it. In the default theme, it will also point an
24475 * arrow to it's top left position at the time one shows it. Ctxpopup
24476 * items have a label and/or an icon. It is intended for a small
24477 * number of items (hence the use of list, not genlist).
24479 * @note Ctxpopup is a especialization of @ref Hover.
24481 * Signals that you can add callbacks for are:
24482 * "dismissed" - the ctxpopup was dismissed
24484 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24487 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
24489 typedef enum _Elm_Ctxpopup_Direction
24491 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24493 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24494 the clicked area */
24495 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24496 the clicked area */
24497 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24499 } Elm_Ctxpopup_Direction;
24502 * @brief Add a new Ctxpopup object to the parent.
24504 * @param parent Parent object
24505 * @return New object or @c NULL, if it cannot be created
24507 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24509 * @brief Set the Ctxpopup's parent
24511 * @param obj The ctxpopup object
24512 * @param area The parent to use
24514 * Set the parent object.
24516 * @note elm_ctxpopup_add() will automatically call this function
24517 * with its @c parent argument.
24519 * @see elm_ctxpopup_add()
24520 * @see elm_hover_parent_set()
24522 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24524 * @brief Get the Ctxpopup's parent
24526 * @param obj The ctxpopup object
24528 * @see elm_ctxpopup_hover_parent_set() for more information
24530 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24532 * @brief Clear all items in the given ctxpopup object.
24534 * @param obj Ctxpopup object
24536 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24538 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24540 * @param obj Ctxpopup object
24541 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24543 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24545 * @brief Get the value of current ctxpopup object's orientation.
24547 * @param obj Ctxpopup object
24548 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24550 * @see elm_ctxpopup_horizontal_set()
24552 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24554 * @brief Add a new item to a ctxpopup object.
24556 * @param obj Ctxpopup object
24557 * @param icon Icon to be set on new item
24558 * @param label The Label of the new item
24559 * @param func Convenience function called when item selected
24560 * @param data Data passed to @p func
24561 * @return A handle to the item added or @c NULL, on errors
24563 * @warning Ctxpopup can't hold both an item list and a content at the same
24564 * time. When an item is added, any previous content will be removed.
24566 * @see elm_ctxpopup_content_set()
24568 Elm_Ctxpopup_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);
24570 * @brief Delete the given item in a ctxpopup object.
24572 * @param item Ctxpopup item to be deleted
24574 * @see elm_ctxpopup_item_append()
24576 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
24578 * @brief Set the ctxpopup item's state as disabled or enabled.
24580 * @param item Ctxpopup item to be enabled/disabled
24581 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24583 * When disabled the item is greyed out to indicate it's state.
24585 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24587 * @brief Get the ctxpopup item's disabled/enabled state.
24589 * @param item Ctxpopup item to be enabled/disabled
24590 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24592 * @see elm_ctxpopup_item_disabled_set()
24594 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24596 * @brief Get the icon object for the given ctxpopup item.
24598 * @param item Ctxpopup item
24599 * @return icon object or @c NULL, if the item does not have icon or an error
24602 * @see elm_ctxpopup_item_append()
24603 * @see elm_ctxpopup_item_icon_set()
24605 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24607 * @brief Sets the side icon associated with the ctxpopup item
24609 * @param item Ctxpopup item
24610 * @param icon Icon object to be set
24612 * Once the icon object is set, a previously set one will be deleted.
24613 * @warning Setting the same icon for two items will cause the icon to
24614 * dissapear from the first item.
24616 * @see elm_ctxpopup_item_append()
24618 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24620 * @brief Get the label for the given ctxpopup item.
24622 * @param item Ctxpopup item
24623 * @return label string or @c NULL, if the item does not have label or an
24626 * @see elm_ctxpopup_item_append()
24627 * @see elm_ctxpopup_item_label_set()
24629 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24631 * @brief (Re)set the label on the given ctxpopup item.
24633 * @param item Ctxpopup item
24634 * @param label String to set as label
24636 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
24638 * @brief Set an elm widget as the content of the ctxpopup.
24640 * @param obj Ctxpopup object
24641 * @param content Content to be swallowed
24643 * If the content object is already set, a previous one will bedeleted. If
24644 * you want to keep that old content object, use the
24645 * elm_ctxpopup_content_unset() function.
24647 * @deprecated use elm_object_content_set()
24649 * @warning Ctxpopup can't hold both a item list and a content at the same
24650 * time. When a content is set, any previous items will be removed.
24652 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24654 * @brief Unset the ctxpopup content
24656 * @param obj Ctxpopup object
24657 * @return The content that was being used
24659 * Unparent and return the content object which was set for this widget.
24661 * @deprecated use elm_object_content_unset()
24663 * @see elm_ctxpopup_content_set()
24665 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24667 * @brief Set the direction priority of a ctxpopup.
24669 * @param obj Ctxpopup object
24670 * @param first 1st priority of direction
24671 * @param second 2nd priority of direction
24672 * @param third 3th priority of direction
24673 * @param fourth 4th priority of direction
24675 * This functions gives a chance to user to set the priority of ctxpopup
24676 * showing direction. This doesn't guarantee the ctxpopup will appear in the
24677 * requested direction.
24679 * @see Elm_Ctxpopup_Direction
24681 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);
24683 * @brief Get the direction priority of a ctxpopup.
24685 * @param obj Ctxpopup object
24686 * @param first 1st priority of direction to be returned
24687 * @param second 2nd priority of direction to be returned
24688 * @param third 3th priority of direction to be returned
24689 * @param fourth 4th priority of direction to be returned
24691 * @see elm_ctxpopup_direction_priority_set() for more information.
24693 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);
24701 * @defgroup Transit Transit
24702 * @ingroup Elementary
24704 * Transit is designed to apply various animated transition effects to @c
24705 * Evas_Object, such like translation, rotation, etc. For using these
24706 * effects, create an @ref Elm_Transit and add the desired transition effects.
24708 * Once the effects are added into transit, they will be automatically
24709 * managed (their callback will be called until the duration is ended, and
24710 * they will be deleted on completion).
24714 * Elm_Transit *trans = elm_transit_add();
24715 * elm_transit_object_add(trans, obj);
24716 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24717 * elm_transit_duration_set(transit, 1);
24718 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24719 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24720 * elm_transit_repeat_times_set(transit, 3);
24723 * Some transition effects are used to change the properties of objects. They
24725 * @li @ref elm_transit_effect_translation_add
24726 * @li @ref elm_transit_effect_color_add
24727 * @li @ref elm_transit_effect_rotation_add
24728 * @li @ref elm_transit_effect_wipe_add
24729 * @li @ref elm_transit_effect_zoom_add
24730 * @li @ref elm_transit_effect_resizing_add
24732 * Other transition effects are used to make one object disappear and another
24733 * object appear on its old place. These effects are:
24735 * @li @ref elm_transit_effect_flip_add
24736 * @li @ref elm_transit_effect_resizable_flip_add
24737 * @li @ref elm_transit_effect_fade_add
24738 * @li @ref elm_transit_effect_blend_add
24740 * It's also possible to make a transition chain with @ref
24741 * elm_transit_chain_transit_add.
24743 * @warning We strongly recommend to use elm_transit just when edje can not do
24744 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24745 * animations can be manipulated inside the theme.
24747 * List of examples:
24748 * @li @ref transit_example_01_explained
24749 * @li @ref transit_example_02_explained
24750 * @li @ref transit_example_03_c
24751 * @li @ref transit_example_04_c
24757 * @enum Elm_Transit_Tween_Mode
24759 * The type of acceleration used in the transition.
24763 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24764 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24765 over time, then decrease again
24767 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24769 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24771 } Elm_Transit_Tween_Mode;
24774 * @enum Elm_Transit_Effect_Flip_Axis
24776 * The axis where flip effect should be applied.
24780 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
24781 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
24782 } Elm_Transit_Effect_Flip_Axis;
24784 * @enum Elm_Transit_Effect_Wipe_Dir
24786 * The direction where the wipe effect should occur.
24790 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
24791 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
24792 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
24793 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
24794 } Elm_Transit_Effect_Wipe_Dir;
24795 /** @enum Elm_Transit_Effect_Wipe_Type
24797 * Whether the wipe effect should show or hide the object.
24801 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
24803 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
24805 } Elm_Transit_Effect_Wipe_Type;
24808 * @typedef Elm_Transit
24810 * The Transit created with elm_transit_add(). This type has the information
24811 * about the objects which the transition will be applied, and the
24812 * transition effects that will be used. It also contains info about
24813 * duration, number of repetitions, auto-reverse, etc.
24815 typedef struct _Elm_Transit Elm_Transit;
24816 typedef void Elm_Transit_Effect;
24818 * @typedef Elm_Transit_Effect_Transition_Cb
24820 * Transition callback called for this effect on each transition iteration.
24822 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
24824 * Elm_Transit_Effect_End_Cb
24826 * Transition callback called for this effect when the transition is over.
24828 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
24831 * Elm_Transit_Del_Cb
24833 * A callback called when the transit is deleted.
24835 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
24840 * @note Is not necessary to delete the transit object, it will be deleted at
24841 * the end of its operation.
24842 * @note The transit will start playing when the program enter in the main loop, is not
24843 * necessary to give a start to the transit.
24845 * @return The transit object.
24849 EAPI Elm_Transit *elm_transit_add(void);
24852 * Stops the animation and delete the @p transit object.
24854 * Call this function if you wants to stop the animation before the duration
24855 * time. Make sure the @p transit object is still alive with
24856 * elm_transit_del_cb_set() function.
24857 * All added effects will be deleted, calling its repective data_free_cb
24858 * functions. The function setted by elm_transit_del_cb_set() will be called.
24860 * @see elm_transit_del_cb_set()
24862 * @param transit The transit object to be deleted.
24865 * @warning Just call this function if you are sure the transit is alive.
24867 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
24870 * Add a new effect to the transit.
24872 * @note The cb function and the data are the key to the effect. If you try to
24873 * add an already added effect, nothing is done.
24874 * @note After the first addition of an effect in @p transit, if its
24875 * effect list become empty again, the @p transit will be killed by
24876 * elm_transit_del(transit) function.
24880 * Elm_Transit *transit = elm_transit_add();
24881 * elm_transit_effect_add(transit,
24882 * elm_transit_effect_blend_op,
24883 * elm_transit_effect_blend_context_new(),
24884 * elm_transit_effect_blend_context_free);
24887 * @param transit The transit object.
24888 * @param transition_cb The operation function. It is called when the
24889 * animation begins, it is the function that actually performs the animation.
24890 * It is called with the @p data, @p transit and the time progression of the
24891 * animation (a double value between 0.0 and 1.0).
24892 * @param effect The context data of the effect.
24893 * @param end_cb The function to free the context data, it will be called
24894 * at the end of the effect, it must finalize the animation and free the
24898 * @warning The transit free the context data at the and of the transition with
24899 * the data_free_cb function, do not use the context data in another transit.
24901 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);
24904 * Delete an added effect.
24906 * This function will remove the effect from the @p transit, calling the
24907 * data_free_cb to free the @p data.
24909 * @see elm_transit_effect_add()
24911 * @note If the effect is not found, nothing is done.
24912 * @note If the effect list become empty, this function will call
24913 * elm_transit_del(transit), that is, it will kill the @p transit.
24915 * @param transit The transit object.
24916 * @param transition_cb The operation function.
24917 * @param effect The context data of the effect.
24921 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);
24924 * Add new object to apply the effects.
24926 * @note After the first addition of an object in @p transit, if its
24927 * object list become empty again, the @p transit will be killed by
24928 * elm_transit_del(transit) function.
24929 * @note If the @p obj belongs to another transit, the @p obj will be
24930 * removed from it and it will only belong to the @p transit. If the old
24931 * transit stays without objects, it will die.
24932 * @note When you add an object into the @p transit, its state from
24933 * evas_object_pass_events_get(obj) is saved, and it is applied when the
24934 * transit ends, if you change this state whith evas_object_pass_events_set()
24935 * after add the object, this state will change again when @p transit stops to
24938 * @param transit The transit object.
24939 * @param obj Object to be animated.
24942 * @warning It is not allowed to add a new object after transit begins to go.
24944 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
24947 * Removes an added object from the transit.
24949 * @note If the @p obj is not in the @p transit, nothing is done.
24950 * @note If the list become empty, this function will call
24951 * elm_transit_del(transit), that is, it will kill the @p transit.
24953 * @param transit The transit object.
24954 * @param obj Object to be removed from @p transit.
24957 * @warning It is not allowed to remove objects after transit begins to go.
24959 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
24962 * Get the objects of the transit.
24964 * @param transit The transit object.
24965 * @return a Eina_List with the objects from the transit.
24969 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
24972 * Enable/disable keeping up the objects states.
24973 * If it is not kept, the objects states will be reset when transition ends.
24975 * @note @p transit can not be NULL.
24976 * @note One state includes geometry, color, map data.
24978 * @param transit The transit object.
24979 * @param state_keep Keeping or Non Keeping.
24983 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
24986 * Get a value whether the objects states will be reset or not.
24988 * @note @p transit can not be NULL
24990 * @see elm_transit_objects_final_state_keep_set()
24992 * @param transit The transit object.
24993 * @return EINA_TRUE means the states of the objects will be reset.
24994 * If @p transit is NULL, EINA_FALSE is returned
24998 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25001 * Set the event enabled when transit is operating.
25003 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25004 * events from mouse and keyboard during the animation.
25005 * @note When you add an object with elm_transit_object_add(), its state from
25006 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25007 * transit ends, if you change this state with evas_object_pass_events_set()
25008 * after adding the object, this state will change again when @p transit stops
25011 * @param transit The transit object.
25012 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25013 * ignored otherwise.
25017 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25020 * Get the value of event enabled status.
25022 * @see elm_transit_event_enabled_set()
25024 * @param transit The Transit object
25025 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25026 * EINA_FALSE is returned
25030 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25033 * Set the user-callback function when the transit is deleted.
25035 * @note Using this function twice will overwrite the first function setted.
25036 * @note the @p transit object will be deleted after call @p cb function.
25038 * @param transit The transit object.
25039 * @param cb Callback function pointer. This function will be called before
25040 * the deletion of the transit.
25041 * @param data Callback funtion user data. It is the @p op parameter.
25045 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25048 * Set reverse effect automatically.
25050 * If auto reverse is setted, after running the effects with the progress
25051 * parameter from 0 to 1, it will call the effecs again with the progress
25052 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25053 * where the duration was setted with the function elm_transit_add and
25054 * the repeat with the function elm_transit_repeat_times_set().
25056 * @param transit The transit object.
25057 * @param reverse EINA_TRUE means the auto_reverse is on.
25061 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25064 * Get if the auto reverse is on.
25066 * @see elm_transit_auto_reverse_set()
25068 * @param transit The transit object.
25069 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25070 * EINA_FALSE is returned
25074 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25077 * Set the transit repeat count. Effect will be repeated by repeat count.
25079 * This function sets the number of repetition the transit will run after
25080 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25081 * If the @p repeat is a negative number, it will repeat infinite times.
25083 * @note If this function is called during the transit execution, the transit
25084 * will run @p repeat times, ignoring the times it already performed.
25086 * @param transit The transit object
25087 * @param repeat Repeat count
25091 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25094 * Get the transit repeat count.
25096 * @see elm_transit_repeat_times_set()
25098 * @param transit The Transit object.
25099 * @return The repeat count. If @p transit is NULL
25104 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25107 * Set the transit animation acceleration type.
25109 * This function sets the tween mode of the transit that can be:
25110 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25111 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25112 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25113 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25115 * @param transit The transit object.
25116 * @param tween_mode The tween type.
25120 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25123 * Get the transit animation acceleration type.
25125 * @note @p transit can not be NULL
25127 * @param transit The transit object.
25128 * @return The tween type. If @p transit is NULL
25129 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25133 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25136 * Set the transit animation time
25138 * @note @p transit can not be NULL
25140 * @param transit The transit object.
25141 * @param duration The animation time.
25145 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25148 * Get the transit animation time
25150 * @note @p transit can not be NULL
25152 * @param transit The transit object.
25154 * @return The transit animation time.
25158 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25161 * Starts the transition.
25162 * Once this API is called, the transit begins to measure the time.
25164 * @note @p transit can not be NULL
25166 * @param transit The transit object.
25170 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25173 * Pause/Resume the transition.
25175 * If you call elm_transit_go again, the transit will be started from the
25176 * beginning, and will be unpaused.
25178 * @note @p transit can not be NULL
25180 * @param transit The transit object.
25181 * @param paused Whether the transition should be paused or not.
25185 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25188 * Get the value of paused status.
25190 * @see elm_transit_paused_set()
25192 * @note @p transit can not be NULL
25194 * @param transit The transit object.
25195 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25196 * EINA_FALSE is returned
25200 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25203 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25205 * The value returned is a fraction (current time / total time). It
25206 * represents the progression position relative to the total.
25208 * @note @p transit can not be NULL
25210 * @param transit The transit object.
25212 * @return The time progression value. If @p transit is NULL
25217 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25220 * Makes the chain relationship between two transits.
25222 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25223 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25225 * @param transit The transit object.
25226 * @param chain_transit The chain transit object. This transit will be operated
25227 * after transit is done.
25229 * This function adds @p chain_transit transition to a chain after the @p
25230 * transit, and will be started as soon as @p transit ends. See @ref
25231 * transit_example_02_explained for a full example.
25235 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25238 * Cut off the chain relationship between two transits.
25240 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25241 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25243 * @param transit The transit object.
25244 * @param chain_transit The chain transit object.
25246 * This function remove the @p chain_transit transition from the @p transit.
25250 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25253 * Get the current chain transit list.
25255 * @note @p transit can not be NULL.
25257 * @param transit The transit object.
25258 * @return chain transit list.
25262 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25265 * Add the Resizing Effect to Elm_Transit.
25267 * @note This API is one of the facades. It creates resizing effect context
25268 * and add it's required APIs to elm_transit_effect_add.
25270 * @see elm_transit_effect_add()
25272 * @param transit Transit object.
25273 * @param from_w Object width size when effect begins.
25274 * @param from_h Object height size when effect begins.
25275 * @param to_w Object width size when effect ends.
25276 * @param to_h Object height size when effect ends.
25277 * @return Resizing effect context data.
25281 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);
25284 * Add the Translation Effect to Elm_Transit.
25286 * @note This API is one of the facades. It creates translation effect context
25287 * and add it's required APIs to elm_transit_effect_add.
25289 * @see elm_transit_effect_add()
25291 * @param transit Transit object.
25292 * @param from_dx X Position variation when effect begins.
25293 * @param from_dy Y Position variation when effect begins.
25294 * @param to_dx X Position variation when effect ends.
25295 * @param to_dy Y Position variation when effect ends.
25296 * @return Translation effect context data.
25299 * @warning It is highly recommended just create a transit with this effect when
25300 * the window that the objects of the transit belongs has already been created.
25301 * This is because this effect needs the geometry information about the objects,
25302 * and if the window was not created yet, it can get a wrong information.
25304 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);
25307 * Add the Zoom Effect to Elm_Transit.
25309 * @note This API is one of the facades. It creates zoom effect context
25310 * and add it's required APIs to elm_transit_effect_add.
25312 * @see elm_transit_effect_add()
25314 * @param transit Transit object.
25315 * @param from_rate Scale rate when effect begins (1 is current rate).
25316 * @param to_rate Scale rate when effect ends.
25317 * @return Zoom effect context data.
25320 * @warning It is highly recommended just create a transit with this effect when
25321 * the window that the objects of the transit belongs has already been created.
25322 * This is because this effect needs the geometry information about the objects,
25323 * and if the window was not created yet, it can get a wrong information.
25325 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25328 * Add the Flip Effect to Elm_Transit.
25330 * @note This API is one of the facades. It creates flip effect context
25331 * and add it's required APIs to elm_transit_effect_add.
25332 * @note This effect is applied to each pair of objects in the order they are listed
25333 * in the transit list of objects. The first object in the pair will be the
25334 * "front" object and the second will be the "back" object.
25336 * @see elm_transit_effect_add()
25338 * @param transit Transit object.
25339 * @param axis Flipping Axis(X or Y).
25340 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25341 * @return Flip effect context data.
25344 * @warning It is highly recommended just create a transit with this effect when
25345 * the window that the objects of the transit belongs has already been created.
25346 * This is because this effect needs the geometry information about the objects,
25347 * and if the window was not created yet, it can get a wrong information.
25349 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25352 * Add the Resizable Flip Effect to Elm_Transit.
25354 * @note This API is one of the facades. It creates resizable flip effect context
25355 * and add it's required APIs to elm_transit_effect_add.
25356 * @note This effect is applied to each pair of objects in the order they are listed
25357 * in the transit list of objects. The first object in the pair will be the
25358 * "front" object and the second will be the "back" object.
25360 * @see elm_transit_effect_add()
25362 * @param transit Transit object.
25363 * @param axis Flipping Axis(X or Y).
25364 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25365 * @return Resizable flip effect context data.
25368 * @warning It is highly recommended just create a transit with this effect when
25369 * the window that the objects of the transit belongs has already been created.
25370 * This is because this effect needs the geometry information about the objects,
25371 * and if the window was not created yet, it can get a wrong information.
25373 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25376 * Add the Wipe Effect to Elm_Transit.
25378 * @note This API is one of the facades. It creates wipe effect context
25379 * and add it's required APIs to elm_transit_effect_add.
25381 * @see elm_transit_effect_add()
25383 * @param transit Transit object.
25384 * @param type Wipe type. Hide or show.
25385 * @param dir Wipe Direction.
25386 * @return Wipe effect context data.
25389 * @warning It is highly recommended just create a transit with this effect when
25390 * the window that the objects of the transit belongs has already been created.
25391 * This is because this effect needs the geometry information about the objects,
25392 * and if the window was not created yet, it can get a wrong information.
25394 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25397 * Add the Color Effect to Elm_Transit.
25399 * @note This API is one of the facades. It creates color effect context
25400 * and add it's required APIs to elm_transit_effect_add.
25402 * @see elm_transit_effect_add()
25404 * @param transit Transit object.
25405 * @param from_r RGB R when effect begins.
25406 * @param from_g RGB G when effect begins.
25407 * @param from_b RGB B when effect begins.
25408 * @param from_a RGB A when effect begins.
25409 * @param to_r RGB R when effect ends.
25410 * @param to_g RGB G when effect ends.
25411 * @param to_b RGB B when effect ends.
25412 * @param to_a RGB A when effect ends.
25413 * @return Color effect context data.
25417 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);
25420 * Add the Fade Effect to Elm_Transit.
25422 * @note This API is one of the facades. It creates fade effect context
25423 * and add it's required APIs to elm_transit_effect_add.
25424 * @note This effect is applied to each pair of objects in the order they are listed
25425 * in the transit list of objects. The first object in the pair will be the
25426 * "before" object and the second will be the "after" object.
25428 * @see elm_transit_effect_add()
25430 * @param transit Transit object.
25431 * @return Fade effect context data.
25434 * @warning It is highly recommended just create a transit with this effect when
25435 * the window that the objects of the transit belongs has already been created.
25436 * This is because this effect needs the color information about the objects,
25437 * and if the window was not created yet, it can get a wrong information.
25439 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25442 * Add the Blend Effect to Elm_Transit.
25444 * @note This API is one of the facades. It creates blend effect context
25445 * and add it's required APIs to elm_transit_effect_add.
25446 * @note This effect is applied to each pair of objects in the order they are listed
25447 * in the transit list of objects. The first object in the pair will be the
25448 * "before" object and the second will be the "after" object.
25450 * @see elm_transit_effect_add()
25452 * @param transit Transit object.
25453 * @return Blend effect context data.
25456 * @warning It is highly recommended just create a transit with this effect when
25457 * the window that the objects of the transit belongs has already been created.
25458 * This is because this effect needs the color information about the objects,
25459 * and if the window was not created yet, it can get a wrong information.
25461 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25464 * Add the Rotation Effect to Elm_Transit.
25466 * @note This API is one of the facades. It creates rotation effect context
25467 * and add it's required APIs to elm_transit_effect_add.
25469 * @see elm_transit_effect_add()
25471 * @param transit Transit object.
25472 * @param from_degree Degree when effect begins.
25473 * @param to_degree Degree when effect is ends.
25474 * @return Rotation effect context data.
25477 * @warning It is highly recommended just create a transit with this effect when
25478 * the window that the objects of the transit belongs has already been created.
25479 * This is because this effect needs the geometry information about the objects,
25480 * and if the window was not created yet, it can get a wrong information.
25482 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25485 * Add the ImageAnimation Effect to Elm_Transit.
25487 * @note This API is one of the facades. It creates image animation effect context
25488 * and add it's required APIs to elm_transit_effect_add.
25489 * The @p images parameter is a list images paths. This list and
25490 * its contents will be deleted at the end of the effect by
25491 * elm_transit_effect_image_animation_context_free() function.
25495 * char buf[PATH_MAX];
25496 * Eina_List *images = NULL;
25497 * Elm_Transit *transi = elm_transit_add();
25499 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25500 * images = eina_list_append(images, eina_stringshare_add(buf));
25502 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25503 * images = eina_list_append(images, eina_stringshare_add(buf));
25504 * elm_transit_effect_image_animation_add(transi, images);
25508 * @see elm_transit_effect_add()
25510 * @param transit Transit object.
25511 * @param images Eina_List of images file paths. This list and
25512 * its contents will be deleted at the end of the effect by
25513 * elm_transit_effect_image_animation_context_free() function.
25514 * @return Image Animation effect context data.
25518 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25523 typedef struct _Elm_Store Elm_Store;
25524 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25525 typedef struct _Elm_Store_Item Elm_Store_Item;
25526 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25527 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25528 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25529 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25530 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25531 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25532 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25533 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25535 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25536 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25537 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25538 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25542 ELM_STORE_ITEM_MAPPING_NONE = 0,
25543 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25544 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25545 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25546 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25547 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25548 // can add more here as needed by common apps
25549 ELM_STORE_ITEM_MAPPING_LAST
25550 } Elm_Store_Item_Mapping_Type;
25552 struct _Elm_Store_Item_Mapping_Icon
25554 // FIXME: allow edje file icons
25556 Elm_Icon_Lookup_Order lookup_order;
25557 Eina_Bool standard_name : 1;
25558 Eina_Bool no_scale : 1;
25559 Eina_Bool smooth : 1;
25560 Eina_Bool scale_up : 1;
25561 Eina_Bool scale_down : 1;
25564 struct _Elm_Store_Item_Mapping_Empty
25569 struct _Elm_Store_Item_Mapping_Photo
25574 struct _Elm_Store_Item_Mapping_Custom
25576 Elm_Store_Item_Mapping_Cb func;
25579 struct _Elm_Store_Item_Mapping
25581 Elm_Store_Item_Mapping_Type type;
25586 Elm_Store_Item_Mapping_Empty empty;
25587 Elm_Store_Item_Mapping_Icon icon;
25588 Elm_Store_Item_Mapping_Photo photo;
25589 Elm_Store_Item_Mapping_Custom custom;
25590 // add more types here
25594 struct _Elm_Store_Item_Info
25596 Elm_Genlist_Item_Class *item_class;
25597 const Elm_Store_Item_Mapping *mapping;
25602 struct _Elm_Store_Item_Info_Filesystem
25604 Elm_Store_Item_Info base;
25608 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25609 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25611 EAPI void elm_store_free(Elm_Store *st);
25613 EAPI Elm_Store *elm_store_filesystem_new(void);
25614 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25615 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25616 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25618 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25620 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25621 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25622 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25623 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25624 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25625 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25627 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25628 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25629 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25630 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25631 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25632 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25633 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25636 * @defgroup SegmentControl SegmentControl
25637 * @ingroup Elementary
25639 * @image html img/widget/segment_control/preview-00.png
25640 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25642 * @image html img/segment_control.png
25643 * @image latex img/segment_control.eps width=\textwidth
25645 * Segment control widget is a horizontal control made of multiple segment
25646 * items, each segment item functioning similar to discrete two state button.
25647 * A segment control groups the items together and provides compact
25648 * single button with multiple equal size segments.
25650 * Segment item size is determined by base widget
25651 * size and the number of items added.
25652 * Only one segment item can be at selected state. A segment item can display
25653 * combination of Text and any Evas_Object like Images or other widget.
25655 * Smart callbacks one can listen to:
25656 * - "changed" - When the user clicks on a segment item which is not
25657 * previously selected and get selected. The event_info parameter is the
25658 * segment item index.
25660 * Available styles for it:
25663 * Here is an example on its usage:
25664 * @li @ref segment_control_example
25668 * @addtogroup SegmentControl
25672 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25675 * Add a new segment control widget to the given parent Elementary
25676 * (container) object.
25678 * @param parent The parent object.
25679 * @return a new segment control widget handle or @c NULL, on errors.
25681 * This function inserts a new segment control widget on the canvas.
25683 * @ingroup SegmentControl
25685 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25688 * Append a new item to the segment control object.
25690 * @param obj The segment control object.
25691 * @param icon The icon object to use for the left side of the item. An
25692 * icon can be any Evas object, but usually it is an icon created
25693 * with elm_icon_add().
25694 * @param label The label of the item.
25695 * Note that, NULL is different from empty string "".
25696 * @return The created item or @c NULL upon failure.
25698 * A new item will be created and appended to the segment control, i.e., will
25699 * be set as @b last item.
25701 * If it should be inserted at another position,
25702 * elm_segment_control_item_insert_at() should be used instead.
25704 * Items created with this function can be deleted with function
25705 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25707 * @note @p label set to @c NULL is different from empty string "".
25709 * only has icon, it will be displayed bigger and centered. If it has
25710 * icon and label, even that an empty string, icon will be smaller and
25711 * positioned at left.
25715 * sc = elm_segment_control_add(win);
25716 * ic = elm_icon_add(win);
25717 * elm_icon_file_set(ic, "path/to/image", NULL);
25718 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25719 * elm_segment_control_item_add(sc, ic, "label");
25720 * evas_object_show(sc);
25723 * @see elm_segment_control_item_insert_at()
25724 * @see elm_segment_control_item_del()
25726 * @ingroup SegmentControl
25728 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25731 * Insert a new item to the segment control object at specified position.
25733 * @param obj The segment control object.
25734 * @param icon The icon object to use for the left side of the item. An
25735 * icon can be any Evas object, but usually it is an icon created
25736 * with elm_icon_add().
25737 * @param label The label of the item.
25738 * @param index Item position. Value should be between 0 and items count.
25739 * @return The created item or @c NULL upon failure.
25741 * Index values must be between @c 0, when item will be prepended to
25742 * segment control, and items count, that can be get with
25743 * elm_segment_control_item_count_get(), case when item will be appended
25744 * to segment control, just like elm_segment_control_item_add().
25746 * Items created with this function can be deleted with function
25747 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25749 * @note @p label set to @c NULL is different from empty string "".
25751 * only has icon, it will be displayed bigger and centered. If it has
25752 * icon and label, even that an empty string, icon will be smaller and
25753 * positioned at left.
25755 * @see elm_segment_control_item_add()
25756 * @see elm_segment_control_count_get()
25757 * @see elm_segment_control_item_del()
25759 * @ingroup SegmentControl
25761 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);
25764 * Remove a segment control item from its parent, deleting it.
25766 * @param it The item to be removed.
25768 * Items can be added with elm_segment_control_item_add() or
25769 * elm_segment_control_item_insert_at().
25771 * @ingroup SegmentControl
25773 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25776 * Remove a segment control item at given index from its parent,
25779 * @param obj The segment control object.
25780 * @param index The position of the segment control item to be deleted.
25782 * Items can be added with elm_segment_control_item_add() or
25783 * elm_segment_control_item_insert_at().
25785 * @ingroup SegmentControl
25787 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25790 * Get the Segment items count from segment control.
25792 * @param obj The segment control object.
25793 * @return Segment items count.
25795 * It will just return the number of items added to segment control @p obj.
25797 * @ingroup SegmentControl
25799 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25802 * Get the item placed at specified index.
25804 * @param obj The segment control object.
25805 * @param index The index of the segment item.
25806 * @return The segment control item or @c NULL on failure.
25808 * Index is the position of an item in segment control widget. Its
25809 * range is from @c 0 to <tt> count - 1 </tt>.
25810 * Count is the number of items, that can be get with
25811 * elm_segment_control_item_count_get().
25813 * @ingroup SegmentControl
25815 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25818 * Get the label of item.
25820 * @param obj The segment control object.
25821 * @param index The index of the segment item.
25822 * @return The label of the item at @p index.
25824 * The return value is a pointer to the label associated to the item when
25825 * it was created, with function elm_segment_control_item_add(), or later
25826 * with function elm_segment_control_item_label_set. If no label
25827 * was passed as argument, it will return @c NULL.
25829 * @see elm_segment_control_item_label_set() for more details.
25830 * @see elm_segment_control_item_add()
25832 * @ingroup SegmentControl
25834 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25837 * Set the label of item.
25839 * @param it The item of segment control.
25840 * @param text The label of item.
25842 * The label to be displayed by the item.
25843 * Label will be at right of the icon (if set).
25845 * If a label was passed as argument on item creation, with function
25846 * elm_control_segment_item_add(), it will be already
25847 * displayed by the item.
25849 * @see elm_segment_control_item_label_get()
25850 * @see elm_segment_control_item_add()
25852 * @ingroup SegmentControl
25854 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
25857 * Get the icon associated to the item.
25859 * @param obj The segment control object.
25860 * @param index The index of the segment item.
25861 * @return The left side icon associated to the item at @p index.
25863 * The return value is a pointer to the icon associated to the item when
25864 * it was created, with function elm_segment_control_item_add(), or later
25865 * with function elm_segment_control_item_icon_set(). If no icon
25866 * was passed as argument, it will return @c NULL.
25868 * @see elm_segment_control_item_add()
25869 * @see elm_segment_control_item_icon_set()
25871 * @ingroup SegmentControl
25873 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25876 * Set the icon associated to the item.
25878 * @param it The segment control item.
25879 * @param icon The icon object to associate with @p it.
25881 * The icon object to use at left side of the item. An
25882 * icon can be any Evas object, but usually it is an icon created
25883 * with elm_icon_add().
25885 * Once the icon object is set, a previously set one will be deleted.
25886 * @warning Setting the same icon for two items will cause the icon to
25887 * dissapear from the first item.
25889 * If an icon was passed as argument on item creation, with function
25890 * elm_segment_control_item_add(), it will be already
25891 * associated to the item.
25893 * @see elm_segment_control_item_add()
25894 * @see elm_segment_control_item_icon_get()
25896 * @ingroup SegmentControl
25898 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25901 * Get the index of an item.
25903 * @param it The segment control item.
25904 * @return The position of item in segment control widget.
25906 * Index is the position of an item in segment control widget. Its
25907 * range is from @c 0 to <tt> count - 1 </tt>.
25908 * Count is the number of items, that can be get with
25909 * elm_segment_control_item_count_get().
25911 * @ingroup SegmentControl
25913 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25916 * Get the base object of the item.
25918 * @param it The segment control item.
25919 * @return The base object associated with @p it.
25921 * Base object is the @c Evas_Object that represents that item.
25923 * @ingroup SegmentControl
25925 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25928 * Get the selected item.
25930 * @param obj The segment control object.
25931 * @return The selected item or @c NULL if none of segment items is
25934 * The selected item can be unselected with function
25935 * elm_segment_control_item_selected_set().
25937 * The selected item always will be highlighted on segment control.
25939 * @ingroup SegmentControl
25941 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25944 * Set the selected state of an item.
25946 * @param it The segment control item
25947 * @param select The selected state
25949 * This sets the selected state of the given item @p it.
25950 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25952 * If a new item is selected the previosly selected will be unselected.
25953 * Previoulsy selected item can be get with function
25954 * elm_segment_control_item_selected_get().
25956 * The selected item always will be highlighted on segment control.
25958 * @see elm_segment_control_item_selected_get()
25960 * @ingroup SegmentControl
25962 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
25969 * @defgroup Grid Grid
25971 * The grid is a grid layout widget that lays out a series of children as a
25972 * fixed "grid" of widgets using a given percentage of the grid width and
25973 * height each using the child object.
25975 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
25976 * widgets size itself. The default is 100 x 100, so that means the
25977 * position and sizes of children will effectively be percentages (0 to 100)
25978 * of the width or height of the grid widget
25984 * Add a new grid to the parent
25986 * @param parent The parent object
25987 * @return The new object or NULL if it cannot be created
25991 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
25994 * Set the virtual size of the grid
25996 * @param obj The grid object
25997 * @param w The virtual width of the grid
25998 * @param h The virtual height of the grid
26002 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26005 * Get the virtual size of the grid
26007 * @param obj The grid object
26008 * @param w Pointer to integer to store the virtual width of the grid
26009 * @param h Pointer to integer to store the virtual height of the grid
26013 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26016 * Pack child at given position and size
26018 * @param obj The grid object
26019 * @param subobj The child to pack
26020 * @param x The virtual x coord at which to pack it
26021 * @param y The virtual y coord at which to pack it
26022 * @param w The virtual width at which to pack it
26023 * @param h The virtual height at which to pack it
26027 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26030 * Unpack a child from a grid object
26032 * @param obj The grid object
26033 * @param subobj The child to unpack
26037 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26040 * Faster way to remove all child objects from a grid object.
26042 * @param obj The grid object
26043 * @param clear If true, it will delete just removed children
26047 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26050 * Set packing of an existing child at to position and size
26052 * @param subobj The child to set packing of
26053 * @param x The virtual x coord at which to pack it
26054 * @param y The virtual y coord at which to pack it
26055 * @param w The virtual width at which to pack it
26056 * @param h The virtual height at which to pack it
26060 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26063 * get packing of a child
26065 * @param subobj The child to query
26066 * @param x Pointer to integer to store the virtual x coord
26067 * @param y Pointer to integer to store the virtual y coord
26068 * @param w Pointer to integer to store the virtual width
26069 * @param h Pointer to integer to store the virtual height
26073 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26079 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26080 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26081 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26083 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26084 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26085 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26086 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26087 EAPI void elm_video_play(Evas_Object *video);
26088 EAPI void elm_video_pause(Evas_Object *video);
26089 EAPI void elm_video_stop(Evas_Object *video);
26090 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26091 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26092 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26093 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26094 EAPI double elm_video_audio_level_get(Evas_Object *video);
26095 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26096 EAPI double elm_video_play_position_get(Evas_Object *video);
26097 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26098 EAPI double elm_video_play_length_get(Evas_Object *video);
26099 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26100 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26101 EAPI const char *elm_video_title_get(Evas_Object *video);
26103 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26104 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26107 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26108 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);
26109 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26110 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26111 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26112 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26113 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26114 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26115 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26116 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26117 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26118 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26119 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26120 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26121 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26124 * @defgroup Video Video
26126 * This object display an player that let you control an Elm_Video
26127 * object. It take care of updating it's content according to what is
26128 * going on inside the Emotion object. It does activate the remember
26129 * function on the linked Elm_Video object.
26131 * Signals that you cann add callback for are :
26133 * "forward,clicked" - the user clicked the forward button.
26134 * "info,clicked" - the user clicked the info button.
26135 * "next,clicked" - the user clicked the next button.
26136 * "pause,clicked" - the user clicked the pause button.
26137 * "play,clicked" - the user clicked the play button.
26138 * "prev,clicked" - the user clicked the prev button.
26139 * "rewind,clicked" - the user clicked the rewind button.
26140 * "stop,clicked" - the user clicked the stop button.