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_text_part_get((it), NULL)
1069 * @defgroup Caches Caches
1071 * These are functions which let one fine-tune some cache values for
1072 * Elementary applications, thus allowing for performance adjustments.
1078 * @brief Flush all caches.
1080 * Frees all data that was in cache and is not currently being used to reduce
1081 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1082 * to calling all of the following functions:
1083 * @li edje_file_cache_flush()
1084 * @li edje_collection_cache_flush()
1085 * @li eet_clearcache()
1086 * @li evas_image_cache_flush()
1087 * @li evas_font_cache_flush()
1088 * @li evas_render_dump()
1089 * @note Evas caches are flushed for every canvas associated with a window.
1093 EAPI void elm_all_flush(void);
1096 * Get the configured cache flush interval time
1098 * This gets the globally configured cache flush interval time, in
1101 * @return The cache flush interval time
1104 * @see elm_all_flush()
1106 EAPI int elm_cache_flush_interval_get(void);
1109 * Set the configured cache flush interval time
1111 * This sets the globally configured cache flush interval time, in ticks
1113 * @param size The cache flush interval time
1116 * @see elm_all_flush()
1118 EAPI void elm_cache_flush_interval_set(int size);
1121 * Set the configured cache flush interval time for all applications on the
1124 * This sets the globally configured cache flush interval time -- in ticks
1125 * -- for all applications on the display.
1127 * @param size The cache flush interval time
1130 EAPI void elm_cache_flush_interval_all_set(int size);
1133 * Get the configured cache flush enabled state
1135 * This gets the globally configured cache flush state - if it is enabled
1136 * or not. When cache flushing is enabled, elementary will regularly
1137 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1138 * memory and allow usage to re-seed caches and data in memory where it
1139 * can do so. An idle application will thus minimise its memory usage as
1140 * data will be freed from memory and not be re-loaded as it is idle and
1141 * not rendering or doing anything graphically right now.
1143 * @return The cache flush state
1146 * @see elm_all_flush()
1148 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1151 * Set the configured cache flush enabled state
1153 * This sets the globally configured cache flush enabled state
1155 * @param size The cache flush enabled state
1158 * @see elm_all_flush()
1160 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1163 * Set the configured cache flush enabled state for all applications on the
1166 * This sets the globally configured cache flush enabled state for all
1167 * applications on the display.
1169 * @param size The cache flush enabled state
1172 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1175 * Get the configured font cache size
1177 * This gets the globally configured font cache size, in bytes
1179 * @return The font cache size
1182 EAPI int elm_font_cache_get(void);
1185 * Set the configured font cache size
1187 * This sets the globally configured font cache size, in bytes
1189 * @param size The font cache size
1192 EAPI void elm_font_cache_set(int size);
1195 * Set the configured font cache size for all applications on the
1198 * This sets the globally configured font cache size -- in bytes
1199 * -- for all applications on the display.
1201 * @param size The font cache size
1204 EAPI void elm_font_cache_all_set(int size);
1207 * Get the configured image cache size
1209 * This gets the globally configured image cache size, in bytes
1211 * @return The image cache size
1214 EAPI int elm_image_cache_get(void);
1217 * Set the configured image cache size
1219 * This sets the globally configured image cache size, in bytes
1221 * @param size The image cache size
1224 EAPI void elm_image_cache_set(int size);
1227 * Set the configured image cache size for all applications on the
1230 * This sets the globally configured image cache size -- in bytes
1231 * -- for all applications on the display.
1233 * @param size The image cache size
1236 EAPI void elm_image_cache_all_set(int size);
1239 * Get the configured edje file cache size.
1241 * This gets the globally configured edje file cache size, in number
1244 * @return The edje file cache size
1247 EAPI int elm_edje_file_cache_get(void);
1250 * Set the configured edje file cache size
1252 * This sets the globally configured edje file cache size, in number
1255 * @param size The edje file cache size
1258 EAPI void elm_edje_file_cache_set(int size);
1261 * Set the configured edje file cache size for all applications on the
1264 * This sets the globally configured edje file cache size -- in number
1265 * of files -- for all applications on the display.
1267 * @param size The edje file cache size
1270 EAPI void elm_edje_file_cache_all_set(int size);
1273 * Get the configured edje collections (groups) cache size.
1275 * This gets the globally configured edje collections cache size, in
1276 * number of collections.
1278 * @return The edje collections cache size
1281 EAPI int elm_edje_collection_cache_get(void);
1284 * Set the configured edje collections (groups) cache size
1286 * This sets the globally configured edje collections cache size, in
1287 * number of collections.
1289 * @param size The edje collections cache size
1292 EAPI void elm_edje_collection_cache_set(int size);
1295 * Set the configured edje collections (groups) cache size for all
1296 * applications on the display
1298 * This sets the globally configured edje collections cache size -- in
1299 * number of collections -- for all applications on the display.
1301 * @param size The edje collections cache size
1304 EAPI void elm_edje_collection_cache_all_set(int size);
1311 * @defgroup Scaling Widget Scaling
1313 * Different widgets can be scaled independently. These functions
1314 * allow you to manipulate this scaling on a per-widget basis. The
1315 * object and all its children get their scaling factors multiplied
1316 * by the scale factor set. This is multiplicative, in that if a
1317 * child also has a scale size set it is in turn multiplied by its
1318 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1319 * double size, @c 0.5 is half, etc.
1321 * @ref general_functions_example_page "This" example contemplates
1322 * some of these functions.
1326 * Get the global scaling factor
1328 * This gets the globally configured scaling factor that is applied to all
1331 * @return The scaling factor
1334 EAPI double elm_scale_get(void);
1337 * Set the global scaling factor
1339 * This sets the globally configured scaling factor that is applied to all
1342 * @param scale The scaling factor to set
1345 EAPI void elm_scale_set(double scale);
1348 * Set the global scaling factor for all applications on the display
1350 * This sets the globally configured scaling factor that is applied to all
1351 * objects for all applications.
1352 * @param scale The scaling factor to set
1355 EAPI void elm_scale_all_set(double scale);
1358 * Set the scaling factor for a given Elementary object
1360 * @param obj The Elementary to operate on
1361 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1366 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1369 * Get the scaling factor for a given Elementary object
1371 * @param obj The object
1372 * @return The scaling factor set by elm_object_scale_set()
1376 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1379 * @defgroup UI-Mirroring Selective Widget mirroring
1381 * These functions allow you to set ui-mirroring on specific
1382 * widgets or the whole interface. Widgets can be in one of two
1383 * modes, automatic and manual. Automatic means they'll be changed
1384 * according to the system mirroring mode and manual means only
1385 * explicit changes will matter. You are not supposed to change
1386 * mirroring state of a widget set to automatic, will mostly work,
1387 * but the behavior is not really defined.
1392 EAPI Eina_Bool elm_mirrored_get(void);
1393 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1396 * Get the system mirrored mode. This determines the default mirrored mode
1399 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1401 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1404 * Set the system mirrored mode. This determines the default mirrored mode
1407 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1409 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1412 * Returns the widget's mirrored mode setting.
1414 * @param obj The widget.
1415 * @return mirrored mode setting of the object.
1418 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1421 * Sets the widget's mirrored mode setting.
1422 * When widget in automatic mode, it follows the system mirrored mode set by
1423 * elm_mirrored_set().
1424 * @param obj The widget.
1425 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1427 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1434 * Set the style to use by a widget
1436 * Sets the style name that will define the appearance of a widget. Styles
1437 * vary from widget to widget and may also be defined by other themes
1438 * by means of extensions and overlays.
1440 * @param obj The Elementary widget to style
1441 * @param style The style name to use
1443 * @see elm_theme_extension_add()
1444 * @see elm_theme_extension_del()
1445 * @see elm_theme_overlay_add()
1446 * @see elm_theme_overlay_del()
1450 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1452 * Get the style used by the widget
1454 * This gets the style being used for that widget. Note that the string
1455 * pointer is only valid as longas the object is valid and the style doesn't
1458 * @param obj The Elementary widget to query for its style
1459 * @return The style name used
1461 * @see elm_object_style_set()
1465 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1468 * @defgroup Styles Styles
1470 * Widgets can have different styles of look. These generic API's
1471 * set styles of widgets, if they support them (and if the theme(s)
1474 * @ref general_functions_example_page "This" example contemplates
1475 * some of these functions.
1479 * Set the disabled state of an Elementary object.
1481 * @param obj The Elementary object to operate on
1482 * @param disabled The state to put in in: @c EINA_TRUE for
1483 * disabled, @c EINA_FALSE for enabled
1485 * Elementary objects can be @b disabled, in which state they won't
1486 * receive input and, in general, will be themed differently from
1487 * their normal state, usually greyed out. Useful for contexts
1488 * where you don't want your users to interact with some of the
1489 * parts of you interface.
1491 * This sets the state for the widget, either disabling it or
1496 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1499 * Get the disabled state of an Elementary object.
1501 * @param obj The Elementary object to operate on
1502 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1503 * if it's enabled (or on errors)
1505 * This gets the state of the widget, which might be enabled or disabled.
1509 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1512 * @defgroup WidgetNavigation Widget Tree Navigation.
1514 * How to check if an Evas Object is an Elementary widget? How to
1515 * get the first elementary widget that is parent of the given
1516 * object? These are all covered in widget tree navigation.
1518 * @ref general_functions_example_page "This" example contemplates
1519 * some of these functions.
1523 * Check if the given Evas Object is an Elementary widget.
1525 * @param obj the object to query.
1526 * @return @c EINA_TRUE if it is an elementary widget variant,
1527 * @c EINA_FALSE otherwise
1528 * @ingroup WidgetNavigation
1530 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1533 * Get the first parent of the given object that is an Elementary
1536 * @param obj the Elementary object to query parent from.
1537 * @return the parent object that is an Elementary widget, or @c
1538 * NULL, if it was not found.
1540 * Use this to query for an object's parent widget.
1542 * @note Most of Elementary users wouldn't be mixing non-Elementary
1543 * smart objects in the objects tree of an application, as this is
1544 * an advanced usage of Elementary with Evas. So, except for the
1545 * application's window, which is the root of that tree, all other
1546 * objects would have valid Elementary widget parents.
1548 * @ingroup WidgetNavigation
1550 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1553 * Get the top level parent of an Elementary widget.
1555 * @param obj The object to query.
1556 * @return The top level Elementary widget, or @c NULL if parent cannot be
1558 * @ingroup WidgetNavigation
1560 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 * Get the string that represents this Elementary widget.
1565 * @note Elementary is weird and exposes itself as a single
1566 * Evas_Object_Smart_Class of type "elm_widget", so
1567 * evas_object_type_get() always return that, making debug and
1568 * language bindings hard. This function tries to mitigate this
1569 * problem, but the solution is to change Elementary to use
1570 * proper inheritance.
1572 * @param obj the object to query.
1573 * @return Elementary widget name, or @c NULL if not a valid widget.
1574 * @ingroup WidgetNavigation
1576 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1579 * @defgroup Config Elementary Config
1581 * Elementary configuration is formed by a set options bounded to a
1582 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1583 * "finger size", etc. These are functions with which one syncronizes
1584 * changes made to those values to the configuration storing files, de
1585 * facto. You most probably don't want to use the functions in this
1586 * group unlees you're writing an elementary configuration manager.
1592 * Save back Elementary's configuration, so that it will persist on
1595 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1598 * This function will take effect -- thus, do I/O -- immediately. Use
1599 * it when you want to apply all configuration changes at once. The
1600 * current configuration set will get saved onto the current profile
1601 * configuration file.
1604 EAPI Eina_Bool elm_config_save(void);
1607 * Reload Elementary's configuration, bounded to current selected
1610 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1613 * Useful when you want to force reloading of configuration values for
1614 * a profile. If one removes user custom configuration directories,
1615 * for example, it will force a reload with system values insted.
1618 EAPI void elm_config_reload(void);
1625 * @defgroup Profile Elementary Profile
1627 * Profiles are pre-set options that affect the whole look-and-feel of
1628 * Elementary-based applications. There are, for example, profiles
1629 * aimed at desktop computer applications and others aimed at mobile,
1630 * touchscreen-based ones. You most probably don't want to use the
1631 * functions in this group unlees you're writing an elementary
1632 * configuration manager.
1638 * Get Elementary's profile in use.
1640 * This gets the global profile that is applied to all Elementary
1643 * @return The profile's name
1646 EAPI const char *elm_profile_current_get(void);
1649 * Get an Elementary's profile directory path in the filesystem. One
1650 * may want to fetch a system profile's dir or an user one (fetched
1653 * @param profile The profile's name
1654 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1655 * or a system one (@c EINA_FALSE)
1656 * @return The profile's directory path.
1659 * @note You must free it with elm_profile_dir_free().
1661 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1664 * Free an Elementary's profile directory path, as returned by
1665 * elm_profile_dir_get().
1667 * @param p_dir The profile's path
1671 EAPI void elm_profile_dir_free(const char *p_dir);
1674 * Get Elementary's list of available profiles.
1676 * @return The profiles list. List node data are the profile name
1680 * @note One must free this list, after usage, with the function
1681 * elm_profile_list_free().
1683 EAPI Eina_List *elm_profile_list_get(void);
1686 * Free Elementary's list of available profiles.
1688 * @param l The profiles list, as returned by elm_profile_list_get().
1692 EAPI void elm_profile_list_free(Eina_List *l);
1695 * Set Elementary's profile.
1697 * This sets the global profile that is applied to Elementary
1698 * applications. Just the process the call comes from will be
1701 * @param profile The profile's name
1705 EAPI void elm_profile_set(const char *profile);
1708 * Set Elementary's profile.
1710 * This sets the global profile that is applied to all Elementary
1711 * applications. All running Elementary windows will be affected.
1713 * @param profile The profile's name
1717 EAPI void elm_profile_all_set(const char *profile);
1724 * @defgroup Engine Elementary Engine
1726 * These are functions setting and querying which rendering engine
1727 * Elementary will use for drawing its windows' pixels.
1729 * The following are the available engines:
1730 * @li "software_x11"
1733 * @li "software_16_x11"
1734 * @li "software_8_x11"
1737 * @li "software_gdi"
1738 * @li "software_16_wince_gdi"
1740 * @li "software_16_sdl"
1748 * @brief Get Elementary's rendering engine in use.
1750 * @return The rendering engine's name
1751 * @note there's no need to free the returned string, here.
1753 * This gets the global rendering engine that is applied to all Elementary
1756 * @see elm_engine_set()
1758 EAPI const char *elm_engine_current_get(void);
1761 * @brief Set Elementary's rendering engine for use.
1763 * @param engine The rendering engine's name
1765 * This sets global rendering engine that is applied to all Elementary
1766 * applications. Note that it will take effect only to Elementary windows
1767 * created after this is called.
1769 * @see elm_win_add()
1771 EAPI void elm_engine_set(const char *engine);
1778 * @defgroup Fonts Elementary Fonts
1780 * These are functions dealing with font rendering, selection and the
1781 * like for Elementary applications. One might fetch which system
1782 * fonts are there to use and set custom fonts for individual classes
1783 * of UI items containing text (text classes).
1788 typedef struct _Elm_Text_Class
1794 typedef struct _Elm_Font_Overlay
1796 const char *text_class;
1798 Evas_Font_Size size;
1801 typedef struct _Elm_Font_Properties
1805 } Elm_Font_Properties;
1808 * Get Elementary's list of supported text classes.
1810 * @return The text classes list, with @c Elm_Text_Class blobs as data.
1813 * Release the list with elm_text_classes_list_free().
1815 EAPI const Eina_List *elm_text_classes_list_get(void);
1818 * Free Elementary's list of supported text classes.
1822 * @see elm_text_classes_list_get().
1824 EAPI void elm_text_classes_list_free(const Eina_List *list);
1827 * Get Elementary's list of font overlays, set with
1828 * elm_font_overlay_set().
1830 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1835 * For each text class, one can set a <b>font overlay</b> for it,
1836 * overriding the default font properties for that class coming from
1837 * the theme in use. There is no need to free this list.
1839 * @see elm_font_overlay_set() and elm_font_overlay_unset().
1841 EAPI const Eina_List *elm_font_overlay_list_get(void);
1844 * Set a font overlay for a given Elementary text class.
1846 * @param text_class Text class name
1847 * @param font Font name and style string
1848 * @param size Font size
1852 * @p font has to be in the format returned by
1853 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1854 * and elm_font_overlay_unset().
1856 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1859 * Unset a font overlay for a given Elementary text class.
1861 * @param text_class Text class name
1865 * This will bring back text elements belonging to text class
1866 * @p text_class back to their default font settings.
1868 EAPI void elm_font_overlay_unset(const char *text_class);
1871 * Apply the changes made with elm_font_overlay_set() and
1872 * elm_font_overlay_unset() on the current Elementary window.
1876 * This applies all font overlays set to all objects in the UI.
1878 EAPI void elm_font_overlay_apply(void);
1881 * Apply the changes made with elm_font_overlay_set() and
1882 * elm_font_overlay_unset() on all Elementary application windows.
1886 * This applies all font overlays set to all objects in the UI.
1888 EAPI void elm_font_overlay_all_apply(void);
1891 * Translate a font (family) name string in fontconfig's font names
1892 * syntax into an @c Elm_Font_Properties struct.
1894 * @param font The font name and styles string
1895 * @return the font properties struct
1899 * @note The reverse translation can be achived with
1900 * elm_font_fontconfig_name_get(), for one style only (single font
1901 * instance, not family).
1903 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1906 * Free font properties return by elm_font_properties_get().
1908 * @param efp the font properties struct
1912 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1915 * Translate a font name, bound to a style, into fontconfig's font names
1918 * @param name The font (family) name
1919 * @param style The given style (may be @c NULL)
1921 * @return the font name and style string
1925 * @note The reverse translation can be achived with
1926 * elm_font_properties_get(), for one style only (single font
1927 * instance, not family).
1929 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1932 * Free the font string return by elm_font_fontconfig_name_get().
1934 * @param efp the font properties struct
1938 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1941 * Create a font hash table of available system fonts.
1943 * One must call it with @p list being the return value of
1944 * evas_font_available_list(). The hash will be indexed by font
1945 * (family) names, being its values @c Elm_Font_Properties blobs.
1947 * @param list The list of available system fonts, as returned by
1948 * evas_font_available_list().
1949 * @return the font hash.
1953 * @note The user is supposed to get it populated at least with 3
1954 * default font families (Sans, Serif, Monospace), which should be
1955 * present on most systems.
1957 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1960 * Free the hash return by elm_font_available_hash_add().
1962 * @param hash the hash to be freed.
1966 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1973 * @defgroup Fingers Fingers
1975 * Elementary is designed to be finger-friendly for touchscreens,
1976 * and so in addition to scaling for display resolution, it can
1977 * also scale based on finger "resolution" (or size). You can then
1978 * customize the granularity of the areas meant to receive clicks
1981 * Different profiles may have pre-set values for finger sizes.
1983 * @ref general_functions_example_page "This" example contemplates
1984 * some of these functions.
1990 * Get the configured "finger size"
1992 * @return The finger size
1994 * This gets the globally configured finger size, <b>in pixels</b>
1998 EAPI Evas_Coord elm_finger_size_get(void);
2001 * Set the configured finger size
2003 * This sets the globally configured finger size in pixels
2005 * @param size The finger size
2008 EAPI void elm_finger_size_set(Evas_Coord size);
2011 * Set the configured finger size for all applications on the display
2013 * This sets the globally configured finger size in pixels for all
2014 * applications on the display
2016 * @param size The finger size
2019 EAPI void elm_finger_size_all_set(Evas_Coord size);
2026 * @defgroup Focus Focus
2028 * An Elementary application has, at all times, one (and only one)
2029 * @b focused object. This is what determines where the input
2030 * events go to within the application's window. Also, focused
2031 * objects can be decorated differently, in order to signal to the
2032 * user where the input is, at a given moment.
2034 * Elementary applications also have the concept of <b>focus
2035 * chain</b>: one can cycle through all the windows' focusable
2036 * objects by input (tab key) or programmatically. The default
2037 * focus chain for an application is the one define by the order in
2038 * which the widgets where added in code. One will cycle through
2039 * top level widgets, and, for each one containg sub-objects, cycle
2040 * through them all, before returning to the level
2041 * above. Elementary also allows one to set @b custom focus chains
2042 * for their applications.
2044 * Besides the focused decoration a widget may exhibit, when it
2045 * gets focus, Elementary has a @b global focus highlight object
2046 * that can be enabled for a window. If one chooses to do so, this
2047 * extra highlight effect will surround the current focused object,
2050 * @note Some Elementary widgets are @b unfocusable, after
2051 * creation, by their very nature: they are not meant to be
2052 * interacted with input events, but are there just for visual
2055 * @ref general_functions_example_page "This" example contemplates
2056 * some of these functions.
2060 * Get the enable status of the focus highlight
2062 * This gets whether the highlight on focused objects is enabled or not
2065 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2068 * Set the enable status of the focus highlight
2070 * Set whether to show or not the highlight on focused objects
2071 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2074 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2077 * Get the enable status of the highlight animation
2079 * Get whether the focus highlight, if enabled, will animate its switch from
2080 * one object to the next
2083 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2086 * Set the enable status of the highlight animation
2088 * Set whether the focus highlight, if enabled, will animate its switch from
2089 * one object to the next
2090 * @param animate Enable animation if EINA_TRUE, disable otherwise
2093 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2096 * Get the whether an Elementary object has the focus or not.
2098 * @param obj The Elementary object to get the information from
2099 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2100 * not (and on errors).
2102 * @see elm_object_focus_set()
2106 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2109 * Set/unset focus to a given Elementary object.
2111 * @param obj The Elementary object to operate on.
2112 * @param enable @c EINA_TRUE Set focus to a given object,
2113 * @c EINA_FALSE Unset focus to a given object.
2115 * @note When you set focus to this object, if it can handle focus, will
2116 * take the focus away from the one who had it previously and will, for
2117 * now on, be the one receiving input events. Unsetting focus will remove
2118 * the focus from @p obj, passing it back to the previous element in the
2121 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2125 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2128 * Make a given Elementary object the focused one.
2130 * @param obj The Elementary object to make focused.
2132 * @note This object, if it can handle focus, will take the focus
2133 * away from the one who had it previously and will, for now on, be
2134 * the one receiving input events.
2136 * @see elm_object_focus_get()
2137 * @deprecated use elm_object_focus_set() instead.
2141 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2144 * Remove the focus from an Elementary object
2146 * @param obj The Elementary to take focus from
2148 * This removes the focus from @p obj, passing it back to the
2149 * previous element in the focus chain list.
2151 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2152 * @deprecated use elm_object_focus_set() instead.
2156 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2159 * Set the ability for an Element object to be focused
2161 * @param obj The Elementary object to operate on
2162 * @param enable @c EINA_TRUE if the object can be focused, @c
2163 * EINA_FALSE if not (and on errors)
2165 * This sets whether the object @p obj is able to take focus or
2166 * not. Unfocusable objects do nothing when programmatically
2167 * focused, being the nearest focusable parent object the one
2168 * really getting focus. Also, when they receive mouse input, they
2169 * will get the event, but not take away the focus from where it
2174 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2177 * Get whether an Elementary object is focusable or not
2179 * @param obj The Elementary object to operate on
2180 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2181 * EINA_FALSE if not (and on errors)
2183 * @note Objects which are meant to be interacted with by input
2184 * events are created able to be focused, by default. All the
2189 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2192 * Set custom focus chain.
2194 * This function overwrites any previous custom focus chain within
2195 * the list of objects. The previous list will be deleted and this list
2196 * will be managed by elementary. After it is set, don't modify it.
2198 * @note On focus cycle, only will be evaluated children of this container.
2200 * @param obj The container object
2201 * @param objs Chain of objects to pass focus
2204 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2207 * Unset a custom focus chain on a given Elementary widget
2209 * @param obj The container object to remove focus chain from
2211 * Any focus chain previously set on @p obj (for its child objects)
2212 * is removed entirely after this call.
2216 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2219 * Get custom focus chain
2221 * @param obj The container object
2224 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2227 * Append object to custom focus chain.
2229 * @note If relative_child equal to NULL or not in custom chain, the object
2230 * will be added in end.
2232 * @note On focus cycle, only will be evaluated children of this container.
2234 * @param obj The container object
2235 * @param child The child to be added in custom chain
2236 * @param relative_child The relative object to position the child
2239 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2242 * Prepend object to custom focus chain.
2244 * @note If relative_child equal to NULL or not in custom chain, the object
2245 * will be added in begin.
2247 * @note On focus cycle, only will be evaluated children of this container.
2249 * @param obj The container object
2250 * @param child The child to be added in custom chain
2251 * @param relative_child The relative object to position the child
2254 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2257 * Give focus to next object in object tree.
2259 * Give focus to next object in focus chain of one object sub-tree.
2260 * If the last object of chain already have focus, the focus will go to the
2261 * first object of chain.
2263 * @param obj The object root of sub-tree
2264 * @param dir Direction to cycle the focus
2268 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2271 * Give focus to near object in one direction.
2273 * Give focus to near object in direction of one object.
2274 * If none focusable object in given direction, the focus will not change.
2276 * @param obj The reference object
2277 * @param x Horizontal component of direction to focus
2278 * @param y Vertical component of direction to focus
2282 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2285 * Make the elementary object and its children to be unfocusable
2288 * @param obj The Elementary object to operate on
2289 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2290 * @c EINA_FALSE for focusable.
2292 * This sets whether the object @p obj and its children objects
2293 * are able to take focus or not. If the tree is set as unfocusable,
2294 * newest focused object which is not in this tree will get focus.
2295 * This API can be helpful for an object to be deleted.
2296 * When an object will be deleted soon, it and its children may not
2297 * want to get focus (by focus reverting or by other focus controls).
2298 * Then, just use this API before deleting.
2300 * @see elm_object_tree_unfocusable_get()
2304 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2307 * Get whether an Elementary object and its children are unfocusable or not.
2309 * @param obj The Elementary object to get the information from
2310 * @return @c EINA_TRUE, if the tree is unfocussable,
2311 * @c EINA_FALSE if not (and on errors).
2313 * @see elm_object_tree_unfocusable_set()
2317 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2320 * @defgroup Scrolling Scrolling
2322 * These are functions setting how scrollable views in Elementary
2323 * widgets should behave on user interaction.
2329 * Get whether scrollers should bounce when they reach their
2330 * viewport's edge during a scroll.
2332 * @return the thumb scroll bouncing state
2334 * This is the default behavior for touch screens, in general.
2335 * @ingroup Scrolling
2337 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2340 * Set whether scrollers should bounce when they reach their
2341 * viewport's edge during a scroll.
2343 * @param enabled the thumb scroll bouncing state
2345 * @see elm_thumbscroll_bounce_enabled_get()
2346 * @ingroup Scrolling
2348 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2351 * Set whether scrollers should bounce when they reach their
2352 * viewport's edge during a scroll, for all Elementary application
2355 * @param enabled the thumb scroll bouncing state
2357 * @see elm_thumbscroll_bounce_enabled_get()
2358 * @ingroup Scrolling
2360 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2363 * Get the amount of inertia a scroller will impose at bounce
2366 * @return the thumb scroll bounce friction
2368 * @ingroup Scrolling
2370 EAPI double elm_scroll_bounce_friction_get(void);
2373 * Set the amount of inertia a scroller will impose at bounce
2376 * @param friction the thumb scroll bounce friction
2378 * @see elm_thumbscroll_bounce_friction_get()
2379 * @ingroup Scrolling
2381 EAPI void elm_scroll_bounce_friction_set(double friction);
2384 * Set the amount of inertia a scroller will impose at bounce
2385 * animations, for all Elementary application windows.
2387 * @param friction the thumb scroll bounce friction
2389 * @see elm_thumbscroll_bounce_friction_get()
2390 * @ingroup Scrolling
2392 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2395 * Get the amount of inertia a <b>paged</b> scroller will impose at
2396 * page fitting animations.
2398 * @return the page scroll friction
2400 * @ingroup Scrolling
2402 EAPI double elm_scroll_page_scroll_friction_get(void);
2405 * Set the amount of inertia a <b>paged</b> scroller will impose at
2406 * page fitting animations.
2408 * @param friction the page scroll friction
2410 * @see elm_thumbscroll_page_scroll_friction_get()
2411 * @ingroup Scrolling
2413 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2416 * Set the amount of inertia a <b>paged</b> scroller will impose at
2417 * page fitting animations, for all Elementary application windows.
2419 * @param friction the page scroll friction
2421 * @see elm_thumbscroll_page_scroll_friction_get()
2422 * @ingroup Scrolling
2424 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2427 * Get the amount of inertia a scroller will impose at region bring
2430 * @return the bring in scroll friction
2432 * @ingroup Scrolling
2434 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2437 * Set the amount of inertia a scroller will impose at region bring
2440 * @param friction the bring in scroll friction
2442 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2443 * @ingroup Scrolling
2445 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2448 * Set the amount of inertia a scroller will impose at region bring
2449 * animations, for all Elementary application windows.
2451 * @param friction the bring in scroll friction
2453 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2454 * @ingroup Scrolling
2456 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2459 * Get the amount of inertia scrollers will impose at animations
2460 * triggered by Elementary widgets' zooming API.
2462 * @return the zoom friction
2464 * @ingroup Scrolling
2466 EAPI double elm_scroll_zoom_friction_get(void);
2469 * Set the amount of inertia scrollers will impose at animations
2470 * triggered by Elementary widgets' zooming API.
2472 * @param friction the zoom friction
2474 * @see elm_thumbscroll_zoom_friction_get()
2475 * @ingroup Scrolling
2477 EAPI void elm_scroll_zoom_friction_set(double friction);
2480 * Set the amount of inertia scrollers will impose at animations
2481 * triggered by Elementary widgets' zooming API, for all Elementary
2482 * application windows.
2484 * @param friction the zoom friction
2486 * @see elm_thumbscroll_zoom_friction_get()
2487 * @ingroup Scrolling
2489 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2492 * Get whether scrollers should be draggable from any point in their
2495 * @return the thumb scroll state
2497 * @note This is the default behavior for touch screens, in general.
2498 * @note All other functions namespaced with "thumbscroll" will only
2499 * have effect if this mode is enabled.
2501 * @ingroup Scrolling
2503 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2506 * Set whether scrollers should be draggable from any point in their
2509 * @param enabled the thumb scroll state
2511 * @see elm_thumbscroll_enabled_get()
2512 * @ingroup Scrolling
2514 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2517 * Set whether scrollers should be draggable from any point in their
2518 * views, for all Elementary application windows.
2520 * @param enabled the thumb scroll state
2522 * @see elm_thumbscroll_enabled_get()
2523 * @ingroup Scrolling
2525 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2528 * Get the number of pixels one should travel while dragging a
2529 * scroller's view to actually trigger scrolling.
2531 * @return the thumb scroll threshould
2533 * One would use higher values for touch screens, in general, because
2534 * of their inherent imprecision.
2535 * @ingroup Scrolling
2537 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2540 * Set the number of pixels one should travel while dragging a
2541 * scroller's view to actually trigger scrolling.
2543 * @param threshold the thumb scroll threshould
2545 * @see elm_thumbscroll_threshould_get()
2546 * @ingroup Scrolling
2548 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2551 * Set the number of pixels one should travel while dragging a
2552 * scroller's view to actually trigger scrolling, for all Elementary
2553 * application windows.
2555 * @param threshold the thumb scroll threshould
2557 * @see elm_thumbscroll_threshould_get()
2558 * @ingroup Scrolling
2560 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2563 * Get the minimum speed of mouse cursor movement which will trigger
2564 * list self scrolling animation after a mouse up event
2567 * @return the thumb scroll momentum threshould
2569 * @ingroup Scrolling
2571 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2574 * Set the minimum speed of mouse cursor movement which will trigger
2575 * list self scrolling animation after a mouse up event
2578 * @param threshold the thumb scroll momentum threshould
2580 * @see elm_thumbscroll_momentum_threshould_get()
2581 * @ingroup Scrolling
2583 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2586 * Set the minimum speed of mouse cursor movement which will trigger
2587 * list self scrolling animation after a mouse up event
2588 * (pixels/second), for all Elementary application windows.
2590 * @param threshold the thumb scroll momentum threshould
2592 * @see elm_thumbscroll_momentum_threshould_get()
2593 * @ingroup Scrolling
2595 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2598 * Get the amount of inertia a scroller will impose at self scrolling
2601 * @return the thumb scroll friction
2603 * @ingroup Scrolling
2605 EAPI double elm_scroll_thumbscroll_friction_get(void);
2608 * Set the amount of inertia a scroller will impose at self scrolling
2611 * @param friction the thumb scroll friction
2613 * @see elm_thumbscroll_friction_get()
2614 * @ingroup Scrolling
2616 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2619 * Set the amount of inertia a scroller will impose at self scrolling
2620 * animations, for all Elementary application windows.
2622 * @param friction the thumb scroll friction
2624 * @see elm_thumbscroll_friction_get()
2625 * @ingroup Scrolling
2627 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2630 * Get the amount of lag between your actual mouse cursor dragging
2631 * movement and a scroller's view movement itself, while pushing it
2632 * into bounce state manually.
2634 * @return the thumb scroll border friction
2636 * @ingroup Scrolling
2638 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2641 * Set the amount of lag between your actual mouse cursor dragging
2642 * movement and a scroller's view movement itself, while pushing it
2643 * into bounce state manually.
2645 * @param friction the thumb scroll border friction. @c 0.0 for
2646 * perfect synchrony between two movements, @c 1.0 for maximum
2649 * @see elm_thumbscroll_border_friction_get()
2650 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2652 * @ingroup Scrolling
2654 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2657 * Set the amount of lag between your actual mouse cursor dragging
2658 * movement and a scroller's view movement itself, while pushing it
2659 * into bounce state manually, for all Elementary application windows.
2661 * @param friction the thumb scroll border friction. @c 0.0 for
2662 * perfect synchrony between two movements, @c 1.0 for maximum
2665 * @see elm_thumbscroll_border_friction_get()
2666 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2668 * @ingroup Scrolling
2670 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2677 * @defgroup Scrollhints Scrollhints
2679 * Objects when inside a scroller can scroll, but this may not always be
2680 * desirable in certain situations. This allows an object to hint to itself
2681 * and parents to "not scroll" in one of 2 ways. If any chilkd object of a
2682 * scroller has pushed a scroll freeze or hold then it affects all parent
2683 * scrollers until all children have released them.
2685 * 1. To hold on scrolling. This means just flicking and dragging may no
2686 * longer scroll, but pressing/dragging near an edge of the scroller will
2687 * still scroll. This is automatically used by the entry object when
2690 * 2. To totally freeze scrolling. This means it stops. until
2697 * Push the scroll hold by 1
2699 * This increments the scroll hold count by one. If it is more than 0 it will
2700 * take effect on the parents of the indicated object.
2702 * @param obj The object
2703 * @ingroup Scrollhints
2705 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2708 * Pop the scroll hold by 1
2710 * This decrements the scroll hold count by one. If it is more than 0 it will
2711 * take effect on the parents of the indicated object.
2713 * @param obj The object
2714 * @ingroup Scrollhints
2716 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2719 * Push the scroll freeze by 1
2721 * This increments the scroll freeze count by one. If it is more
2722 * than 0 it will take effect on the parents of the indicated
2725 * @param obj The object
2726 * @ingroup Scrollhints
2728 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2731 * Pop the scroll freeze by 1
2733 * This decrements the scroll freeze count by one. If it is more
2734 * than 0 it will take effect on the parents of the indicated
2737 * @param obj The object
2738 * @ingroup Scrollhints
2740 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2743 * Lock the scrolling of the given widget (and thus all parents)
2745 * This locks the given object from scrolling in the X axis (and implicitly
2746 * also locks all parent scrollers too from doing the same).
2748 * @param obj The object
2749 * @param lock The lock state (1 == locked, 0 == unlocked)
2750 * @ingroup Scrollhints
2752 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2755 * Lock the scrolling of the given widget (and thus all parents)
2757 * This locks the given object from scrolling in the Y axis (and implicitly
2758 * also locks all parent scrollers too from doing the same).
2760 * @param obj The object
2761 * @param lock The lock state (1 == locked, 0 == unlocked)
2762 * @ingroup Scrollhints
2764 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2767 * Get the scrolling lock of the given widget
2769 * This gets the lock for X axis scrolling.
2771 * @param obj The object
2772 * @ingroup Scrollhints
2774 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2777 * Get the scrolling lock of the given widget
2779 * This gets the lock for X axis scrolling.
2781 * @param obj The object
2782 * @ingroup Scrollhints
2784 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2791 * Send a signal to the widget edje object.
2793 * This function sends a signal to the edje object of the obj. An
2794 * edje program can respond to a signal by specifying matching
2795 * 'signal' and 'source' fields.
2797 * @param obj The object
2798 * @param emission The signal's name.
2799 * @param source The signal's source.
2802 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2805 * Add a callback for a signal emitted by widget edje object.
2807 * This function connects a callback function to a signal emitted by the
2808 * edje object of the obj.
2809 * Globs can occur in either the emission or source name.
2811 * @param obj The object
2812 * @param emission The signal's name.
2813 * @param source The signal's source.
2814 * @param func The callback function to be executed when the signal is
2816 * @param data A pointer to data to pass in to the callback function.
2819 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
2822 * Remove a signal-triggered callback from an widget edje object.
2824 * This function removes a callback, previoulsy attached to a
2825 * signal emitted by the edje object of the obj. The parameters
2826 * emission, source and func must match exactly those passed to a
2827 * previous call to elm_object_signal_callback_add(). The data
2828 * pointer that was passed to this call will be returned.
2830 * @param obj The object
2831 * @param emission The signal's name.
2832 * @param source The signal's source.
2833 * @param func The callback function to be executed when the signal is
2835 * @return The data pointer
2838 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
2841 * Add a callback for a event emitted by widget or their children.
2843 * This function connects a callback function to any key_down key_up event
2844 * emitted by the @p obj or their children.
2845 * This only will be called if no other callback has consumed the event.
2846 * If you want consume the event, and no other get it, func should return
2847 * EINA_TRUE and put EVAS_EVENT_FLAG_ON_HOLD in event_flags.
2849 * @warning Accept duplicated callback addition.
2851 * @param obj The object
2852 * @param func The callback function to be executed when the event is
2854 * @param data Data to pass in to the callback function.
2857 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2860 * Remove a event callback from an widget.
2862 * This function removes a callback, previoulsy attached to event emission
2864 * The parameters func and data must match exactly those passed to
2865 * a previous call to elm_object_event_callback_add(). The data pointer that
2866 * was passed to this call will be returned.
2868 * @param obj The object
2869 * @param func The callback function to be executed when the event is
2871 * @param data Data to pass in to the callback function.
2872 * @return The data pointer
2875 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2878 * Adjust size of an element for finger usage.
2880 * @param times_w How many fingers should fit horizontally
2881 * @param w Pointer to the width size to adjust
2882 * @param times_h How many fingers should fit vertically
2883 * @param h Pointer to the height size to adjust
2885 * This takes width and height sizes (in pixels) as input and a
2886 * size multiple (which is how many fingers you want to place
2887 * within the area, being "finger" the size set by
2888 * elm_finger_size_set()), and adjusts the size to be large enough
2889 * to accommodate the resulting size -- if it doesn't already
2890 * accommodate it. On return the @p w and @p h sizes pointed to by
2891 * these parameters will be modified, on those conditions.
2893 * @note This is kind of a low level Elementary call, most useful
2894 * on size evaluation times for widgets. An external user wouldn't
2895 * be calling, most of the time.
2899 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2902 * Get the duration for occuring long press event.
2904 * @return Timeout for long press event
2905 * @ingroup Longpress
2907 EAPI double elm_longpress_timeout_get(void);
2910 * Set the duration for occuring long press event.
2912 * @param lonpress_timeout Timeout for long press event
2913 * @ingroup Longpress
2915 EAPI void elm_longpress_timeout_set(double longpress_timeout);
2918 * @defgroup Debug Debug
2919 * don't use it unless you are sure
2925 * Print Tree object hierarchy in stdout
2927 * @param obj The root object
2930 EAPI void elm_object_tree_dump(const Evas_Object *top);
2933 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2935 * @param obj The root object
2936 * @param file The path of output file
2939 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2946 * @defgroup Theme Theme
2948 * Elementary uses Edje to theme its widgets, naturally. But for the most
2949 * part this is hidden behind a simpler interface that lets the user set
2950 * extensions and choose the style of widgets in a much easier way.
2952 * Instead of thinking in terms of paths to Edje files and their groups
2953 * each time you want to change the appearance of a widget, Elementary
2954 * works so you can add any theme file with extensions or replace the
2955 * main theme at one point in the application, and then just set the style
2956 * of widgets with elm_object_style_set() and related functions. Elementary
2957 * will then look in its list of themes for a matching group and apply it,
2958 * and when the theme changes midway through the application, all widgets
2959 * will be updated accordingly.
2961 * There are three concepts you need to know to understand how Elementary
2962 * theming works: default theme, extensions and overlays.
2964 * Default theme, obviously enough, is the one that provides the default
2965 * look of all widgets. End users can change the theme used by Elementary
2966 * by setting the @c ELM_THEME environment variable before running an
2967 * application, or globally for all programs using the @c elementary_config
2968 * utility. Applications can change the default theme using elm_theme_set(),
2969 * but this can go against the user wishes, so it's not an adviced practice.
2971 * Ideally, applications should find everything they need in the already
2972 * provided theme, but there may be occasions when that's not enough and
2973 * custom styles are required to correctly express the idea. For this
2974 * cases, Elementary has extensions.
2976 * Extensions allow the application developer to write styles of its own
2977 * to apply to some widgets. This requires knowledge of how each widget
2978 * is themed, as extensions will always replace the entire group used by
2979 * the widget, so important signals and parts need to be there for the
2980 * object to behave properly (see documentation of Edje for details).
2981 * Once the theme for the extension is done, the application needs to add
2982 * it to the list of themes Elementary will look into, using
2983 * elm_theme_extension_add(), and set the style of the desired widgets as
2984 * he would normally with elm_object_style_set().
2986 * Overlays, on the other hand, can replace the look of all widgets by
2987 * overriding the default style. Like extensions, it's up to the application
2988 * developer to write the theme for the widgets it wants, the difference
2989 * being that when looking for the theme, Elementary will check first the
2990 * list of overlays, then the set theme and lastly the list of extensions,
2991 * so with overlays it's possible to replace the default view and every
2992 * widget will be affected. This is very much alike to setting the whole
2993 * theme for the application and will probably clash with the end user
2994 * options, not to mention the risk of ending up with not matching styles
2995 * across the program. Unless there's a very special reason to use them,
2996 * overlays should be avoided for the resons exposed before.
2998 * All these theme lists are handled by ::Elm_Theme instances. Elementary
2999 * keeps one default internally and every function that receives one of
3000 * these can be called with NULL to refer to this default (except for
3001 * elm_theme_free()). It's possible to create a new instance of a
3002 * ::Elm_Theme to set other theme for a specific widget (and all of its
3003 * children), but this is as discouraged, if not even more so, than using
3004 * overlays. Don't use this unless you really know what you are doing.
3006 * But to be less negative about things, you can look at the following
3008 * @li @ref theme_example_01 "Using extensions"
3009 * @li @ref theme_example_02 "Using overlays"
3014 * @typedef Elm_Theme
3016 * Opaque handler for the list of themes Elementary looks for when
3017 * rendering widgets.
3019 * Stay out of this unless you really know what you are doing. For most
3020 * cases, sticking to the default is all a developer needs.
3022 typedef struct _Elm_Theme Elm_Theme;
3025 * Create a new specific theme
3027 * This creates an empty specific theme that only uses the default theme. A
3028 * specific theme has its own private set of extensions and overlays too
3029 * (which are empty by default). Specific themes do not fall back to themes
3030 * of parent objects. They are not intended for this use. Use styles, overlays
3031 * and extensions when needed, but avoid specific themes unless there is no
3032 * other way (example: you want to have a preview of a new theme you are
3033 * selecting in a "theme selector" window. The preview is inside a scroller
3034 * and should display what the theme you selected will look like, but not
3035 * actually apply it yet. The child of the scroller will have a specific
3036 * theme set to show this preview before the user decides to apply it to all
3039 EAPI Elm_Theme *elm_theme_new(void);
3041 * Free a specific theme
3043 * @param th The theme to free
3045 * This frees a theme created with elm_theme_new().
3047 EAPI void elm_theme_free(Elm_Theme *th);
3049 * Copy the theme fom the source to the destination theme
3051 * @param th The source theme to copy from
3052 * @param thdst The destination theme to copy data to
3054 * This makes a one-time static copy of all the theme config, extensions
3055 * and overlays from @p th to @p thdst. If @p th references a theme, then
3056 * @p thdst is also set to reference it, with all the theme settings,
3057 * overlays and extensions that @p th had.
3059 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3061 * Tell the source theme to reference the ref theme
3063 * @param th The theme that will do the referencing
3064 * @param thref The theme that is the reference source
3066 * This clears @p th to be empty and then sets it to refer to @p thref
3067 * so @p th acts as an override to @p thref, but where its overrides
3068 * don't apply, it will fall through to @p thref for configuration.
3070 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3072 * Return the theme referred to
3074 * @param th The theme to get the reference from
3075 * @return The referenced theme handle
3077 * This gets the theme set as the reference theme by elm_theme_ref_set().
3078 * If no theme is set as a reference, NULL is returned.
3080 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3082 * Return the default theme
3084 * @return The default theme handle
3086 * This returns the internal default theme setup handle that all widgets
3087 * use implicitly unless a specific theme is set. This is also often use
3088 * as a shorthand of NULL.
3090 EAPI Elm_Theme *elm_theme_default_get(void);
3092 * Prepends a theme overlay to the list of overlays
3094 * @param th The theme to add to, or if NULL, the default theme
3095 * @param item The Edje file path to be used
3097 * Use this if your application needs to provide some custom overlay theme
3098 * (An Edje file that replaces some default styles of widgets) where adding
3099 * new styles, or changing system theme configuration is not possible. Do
3100 * NOT use this instead of a proper system theme configuration. Use proper
3101 * configuration files, profiles, environment variables etc. to set a theme
3102 * so that the theme can be altered by simple confiugration by a user. Using
3103 * this call to achieve that effect is abusing the API and will create lots
3106 * @see elm_theme_extension_add()
3108 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3110 * Delete a theme overlay from the list of overlays
3112 * @param th The theme to delete from, or if NULL, the default theme
3113 * @param item The name of the theme overlay
3115 * @see elm_theme_overlay_add()
3117 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3119 * Appends a theme extension to the list of extensions.
3121 * @param th The theme to add to, or if NULL, the default theme
3122 * @param item The Edje file path to be used
3124 * This is intended when an application needs more styles of widgets or new
3125 * widget themes that the default does not provide (or may not provide). The
3126 * application has "extended" usage by coming up with new custom style names
3127 * for widgets for specific uses, but as these are not "standard", they are
3128 * not guaranteed to be provided by a default theme. This means the
3129 * application is required to provide these extra elements itself in specific
3130 * Edje files. This call adds one of those Edje files to the theme search
3131 * path to be search after the default theme. The use of this call is
3132 * encouraged when default styles do not meet the needs of the application.
3133 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3135 * @see elm_object_style_set()
3137 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3139 * Deletes a theme extension from the list of extensions.
3141 * @param th The theme to delete from, or if NULL, the default theme
3142 * @param item The name of the theme extension
3144 * @see elm_theme_extension_add()
3146 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3148 * Set the theme search order for the given theme
3150 * @param th The theme to set the search order, or if NULL, the default theme
3151 * @param theme Theme search string
3153 * This sets the search string for the theme in path-notation from first
3154 * theme to search, to last, delimited by the : character. Example:
3156 * "shiny:/path/to/file.edj:default"
3158 * See the ELM_THEME environment variable for more information.
3160 * @see elm_theme_get()
3161 * @see elm_theme_list_get()
3163 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3165 * Return the theme search order
3167 * @param th The theme to get the search order, or if NULL, the default theme
3168 * @return The internal search order path
3170 * This function returns a colon separated string of theme elements as
3171 * returned by elm_theme_list_get().
3173 * @see elm_theme_set()
3174 * @see elm_theme_list_get()
3176 EAPI const char *elm_theme_get(Elm_Theme *th);
3178 * Return a list of theme elements to be used in a theme.
3180 * @param th Theme to get the list of theme elements from.
3181 * @return The internal list of theme elements
3183 * This returns the internal list of theme elements (will only be valid as
3184 * long as the theme is not modified by elm_theme_set() or theme is not
3185 * freed by elm_theme_free(). This is a list of strings which must not be
3186 * altered as they are also internal. If @p th is NULL, then the default
3187 * theme element list is returned.
3189 * A theme element can consist of a full or relative path to a .edj file,
3190 * or a name, without extension, for a theme to be searched in the known
3191 * theme paths for Elemementary.
3193 * @see elm_theme_set()
3194 * @see elm_theme_get()
3196 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3198 * Return the full patrh for a theme element
3200 * @param f The theme element name
3201 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3202 * @return The full path to the file found.
3204 * This returns a string you should free with free() on success, NULL on
3205 * failure. This will search for the given theme element, and if it is a
3206 * full or relative path element or a simple searchable name. The returned
3207 * path is the full path to the file, if searched, and the file exists, or it
3208 * is simply the full path given in the element or a resolved path if
3209 * relative to home. The @p in_search_path boolean pointed to is set to
3210 * EINA_TRUE if the file was a searchable file andis in the search path,
3211 * and EINA_FALSE otherwise.
3213 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3215 * Flush the current theme.
3217 * @param th Theme to flush
3219 * This flushes caches that let elementary know where to find theme elements
3220 * in the given theme. If @p th is NULL, then the default theme is flushed.
3221 * Call this function if source theme data has changed in such a way as to
3222 * make any caches Elementary kept invalid.
3224 EAPI void elm_theme_flush(Elm_Theme *th);
3226 * This flushes all themes (default and specific ones).
3228 * This will flush all themes in the current application context, by calling
3229 * elm_theme_flush() on each of them.
3231 EAPI void elm_theme_full_flush(void);
3233 * Set the theme for all elementary using applications on the current display
3235 * @param theme The name of the theme to use. Format same as the ELM_THEME
3236 * environment variable.
3238 EAPI void elm_theme_all_set(const char *theme);
3240 * Return a list of theme elements in the theme search path
3242 * @return A list of strings that are the theme element names.
3244 * This lists all available theme files in the standard Elementary search path
3245 * for theme elements, and returns them in alphabetical order as theme
3246 * element names in a list of strings. Free this with
3247 * elm_theme_name_available_list_free() when you are done with the list.
3249 EAPI Eina_List *elm_theme_name_available_list_new(void);
3251 * Free the list returned by elm_theme_name_available_list_new()
3253 * This frees the list of themes returned by
3254 * elm_theme_name_available_list_new(). Once freed the list should no longer
3255 * be used. a new list mys be created.
3257 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3259 * Set a specific theme to be used for this object and its children
3261 * @param obj The object to set the theme on
3262 * @param th The theme to set
3264 * This sets a specific theme that will be used for the given object and any
3265 * child objects it has. If @p th is NULL then the theme to be used is
3266 * cleared and the object will inherit its theme from its parent (which
3267 * ultimately will use the default theme if no specific themes are set).
3269 * Use special themes with great care as this will annoy users and make
3270 * configuration difficult. Avoid any custom themes at all if it can be
3273 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3275 * Get the specific theme to be used
3277 * @param obj The object to get the specific theme from
3278 * @return The specifc theme set.
3280 * This will return a specific theme set, or NULL if no specific theme is
3281 * set on that object. It will not return inherited themes from parents, only
3282 * the specific theme set for that specific object. See elm_object_theme_set()
3283 * for more information.
3285 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3291 /** @defgroup Win Win
3293 * @image html img/widget/win/preview-00.png
3294 * @image latex img/widget/win/preview-00.eps
3296 * The window class of Elementary. Contains functions to manipulate
3297 * windows. The Evas engine used to render the window contents is specified
3298 * in the system or user elementary config files (whichever is found last),
3299 * and can be overridden with the ELM_ENGINE environment variable for
3300 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3301 * compilation setup and modules actually installed at runtime) are (listed
3302 * in order of best supported and most likely to be complete and work to
3305 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3306 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3308 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3310 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3312 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3314 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3315 * rendering using SDL as the buffer)
3316 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3317 * GDI with software)
3318 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3319 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3320 * grayscale using dedicated 8bit software engine in X11)
3321 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3322 * X11 using 16bit software engine)
3323 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3324 * (Windows CE rendering via GDI with 16bit software renderer)
3325 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3326 * buffer with 16bit software renderer)
3328 * All engines use a simple string to select the engine to render, EXCEPT
3329 * the "shot" engine. This actually encodes the output of the virtual
3330 * screenshot and how long to delay in the engine string. The engine string
3331 * is encoded in the following way:
3333 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3335 * Where options are separated by a ":" char if more than one option is
3336 * given, with delay, if provided being the first option and file the last
3337 * (order is important). The delay specifies how long to wait after the
3338 * window is shown before doing the virtual "in memory" rendering and then
3339 * save the output to the file specified by the file option (and then exit).
3340 * If no delay is given, the default is 0.5 seconds. If no file is given the
3341 * default output file is "out.png". Repeat option is for continous
3342 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3343 * fixed to "out001.png" Some examples of using the shot engine:
3345 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3346 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3347 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3348 * ELM_ENGINE="shot:delay=2.0" elementary_test
3349 * ELM_ENGINE="shot:" elementary_test
3351 * Signals that you can add callbacks for are:
3353 * @li "delete,request": the user requested to close the window. See
3354 * elm_win_autodel_set().
3355 * @li "focus,in": window got focus
3356 * @li "focus,out": window lost focus
3357 * @li "moved": window that holds the canvas was moved
3360 * @li @ref win_example_01
3365 * Defines the types of window that can be created
3367 * These are hints set on the window so that a running Window Manager knows
3368 * how the window should be handled and/or what kind of decorations it
3371 * Currently, only the X11 backed engines use them.
3373 typedef enum _Elm_Win_Type
3375 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3376 window. Almost every window will be created with this
3378 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3379 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3380 window holding desktop icons. */
3381 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3382 be kept on top of any other window by the Window
3384 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3386 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3387 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3389 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3390 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3391 entry in a menubar is clicked. Typically used
3392 with elm_win_override_set(). This hint exists
3393 for completion only, as the EFL way of
3394 implementing a menu would not normally use a
3395 separate window for its contents. */
3396 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3397 triggered by right-clicking an object. */
3398 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3399 explanatory text that typically appear after the
3400 mouse cursor hovers over an object for a while.
3401 Typically used with elm_win_override_set() and also
3402 not very commonly used in the EFL. */
3403 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3404 battery life or a new E-Mail received. */
3405 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3406 usually used in the EFL. */
3407 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3408 object being dragged across different windows, or even
3409 applications. Typically used with
3410 elm_win_override_set(). */
3411 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3412 buffer. No actual window is created for this
3413 type, instead the window and all of its
3414 contents will be rendered to an image buffer.
3415 This allows to have children window inside a
3416 parent one just like any other object would
3417 be, and do other things like applying @c
3418 Evas_Map effects to it. This is the only type
3419 of window that requires the @c parent
3420 parameter of elm_win_add() to be a valid @c
3425 * The differents layouts that can be requested for the virtual keyboard.
3427 * When the application window is being managed by Illume, it may request
3428 * any of the following layouts for the virtual keyboard.
3430 typedef enum _Elm_Win_Keyboard_Mode
3432 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3433 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3434 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3435 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3436 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3437 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3438 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3439 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3440 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3441 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3442 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3443 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3444 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3445 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3446 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3447 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3448 } Elm_Win_Keyboard_Mode;
3451 * Available commands that can be sent to the Illume manager.
3453 * When running under an Illume session, a window may send commands to the
3454 * Illume manager to perform different actions.
3456 typedef enum _Elm_Illume_Command
3458 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3460 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3462 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3464 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3465 } Elm_Illume_Command;
3468 * Adds a window object. If this is the first window created, pass NULL as
3471 * @param parent Parent object to add the window to, or NULL
3472 * @param name The name of the window
3473 * @param type The window type, one of #Elm_Win_Type.
3475 * The @p parent paramter can be @c NULL for every window @p type except
3476 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3477 * which the image object will be created.
3479 * @return The created object, or NULL on failure
3481 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3483 * Add @p subobj as a resize object of window @p obj.
3486 * Setting an object as a resize object of the window means that the
3487 * @p subobj child's size and position will be controlled by the window
3488 * directly. That is, the object will be resized to match the window size
3489 * and should never be moved or resized manually by the developer.
3491 * In addition, resize objects of the window control what the minimum size
3492 * of it will be, as well as whether it can or not be resized by the user.
3494 * For the end user to be able to resize a window by dragging the handles
3495 * or borders provided by the Window Manager, or using any other similar
3496 * mechanism, all of the resize objects in the window should have their
3497 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3499 * @param obj The window object
3500 * @param subobj The resize object to add
3502 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3504 * Delete @p subobj as a resize object of window @p obj.
3506 * This function removes the object @p subobj from the resize objects of
3507 * the window @p obj. It will not delete the object itself, which will be
3508 * left unmanaged and should be deleted by the developer, manually handled
3509 * or set as child of some other container.
3511 * @param obj The window object
3512 * @param subobj The resize object to add
3514 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3516 * Set the title of the window
3518 * @param obj The window object
3519 * @param title The title to set
3521 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3523 * Get the title of the window
3525 * The returned string is an internal one and should not be freed or
3526 * modified. It will also be rendered invalid if a new title is set or if
3527 * the window is destroyed.
3529 * @param obj The window object
3532 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3534 * Set the window's autodel state.
3536 * When closing the window in any way outside of the program control, like
3537 * pressing the X button in the titlebar or using a command from the
3538 * Window Manager, a "delete,request" signal is emitted to indicate that
3539 * this event occurred and the developer can take any action, which may
3540 * include, or not, destroying the window object.
3542 * When the @p autodel parameter is set, the window will be automatically
3543 * destroyed when this event occurs, after the signal is emitted.
3544 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3545 * and is up to the program to do so when it's required.
3547 * @param obj The window object
3548 * @param autodel If true, the window will automatically delete itself when
3551 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3553 * Get the window's autodel state.
3555 * @param obj The window object
3556 * @return If the window will automatically delete itself when closed
3558 * @see elm_win_autodel_set()
3560 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3562 * Activate a window object.
3564 * This function sends a request to the Window Manager to activate the
3565 * window pointed by @p obj. If honored by the WM, the window will receive
3566 * the keyboard focus.
3568 * @note This is just a request that a Window Manager may ignore, so calling
3569 * this function does not ensure in any way that the window will be the
3570 * active one after it.
3572 * @param obj The window object
3574 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3576 * Lower a window object.
3578 * Places the window pointed by @p obj at the bottom of the stack, so that
3579 * no other window is covered by it.
3581 * If elm_win_override_set() is not set, the Window Manager may ignore this
3584 * @param obj The window object
3586 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3588 * Raise a window object.
3590 * Places the window pointed by @p obj at the top of the stack, so that it's
3591 * not covered by any other window.
3593 * If elm_win_override_set() is not set, the Window Manager may ignore this
3596 * @param obj The window object
3598 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3600 * Set the borderless state of a window.
3602 * This function requests the Window Manager to not draw any decoration
3603 * around the window.
3605 * @param obj The window object
3606 * @param borderless If true, the window is borderless
3608 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3610 * Get the borderless state of a window.
3612 * @param obj The window object
3613 * @return If true, the window is borderless
3615 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3617 * Set the shaped state of a window.
3619 * Shaped windows, when supported, will render the parts of the window that
3620 * has no content, transparent.
3622 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3623 * background object or cover the entire window in any other way, or the
3624 * parts of the canvas that have no data will show framebuffer artifacts.
3626 * @param obj The window object
3627 * @param shaped If true, the window is shaped
3629 * @see elm_win_alpha_set()
3631 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3633 * Get the shaped state of a window.
3635 * @param obj The window object
3636 * @return If true, the window is shaped
3638 * @see elm_win_shaped_set()
3640 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3642 * Set the alpha channel state of a window.
3644 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3645 * possibly making parts of the window completely or partially transparent.
3646 * This is also subject to the underlying system supporting it, like for
3647 * example, running under a compositing manager. If no compositing is
3648 * available, enabling this option will instead fallback to using shaped
3649 * windows, with elm_win_shaped_set().
3651 * @param obj The window object
3652 * @param alpha If true, the window has an alpha channel
3654 * @see elm_win_alpha_set()
3656 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3658 * Get the transparency state of a window.
3660 * @param obj The window object
3661 * @return If true, the window is transparent
3663 * @see elm_win_transparent_set()
3665 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3667 * Set the transparency state of a window.
3669 * Use elm_win_alpha_set() instead.
3671 * @param obj The window object
3672 * @param transparent If true, the window is transparent
3674 * @see elm_win_alpha_set()
3676 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3678 * Get the alpha channel state of a window.
3680 * @param obj The window object
3681 * @return If true, the window has an alpha channel
3683 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3685 * Set the override state of a window.
3687 * A window with @p override set to EINA_TRUE will not be managed by the
3688 * Window Manager. This means that no decorations of any kind will be shown
3689 * for it, moving and resizing must be handled by the application, as well
3690 * as the window visibility.
3692 * This should not be used for normal windows, and even for not so normal
3693 * ones, it should only be used when there's a good reason and with a lot
3694 * of care. Mishandling override windows may result situations that
3695 * disrupt the normal workflow of the end user.
3697 * @param obj The window object
3698 * @param override If true, the window is overridden
3700 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3702 * Get the override state of a window.
3704 * @param obj The window object
3705 * @return If true, the window is overridden
3707 * @see elm_win_override_set()
3709 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3711 * Set the fullscreen state of a window.
3713 * @param obj The window object
3714 * @param fullscreen If true, the window is fullscreen
3716 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3718 * Get the fullscreen state of a window.
3720 * @param obj The window object
3721 * @return If true, the window is fullscreen
3723 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3725 * Set the maximized state of a window.
3727 * @param obj The window object
3728 * @param maximized If true, the window is maximized
3730 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3732 * Get the maximized state of a window.
3734 * @param obj The window object
3735 * @return If true, the window is maximized
3737 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3739 * Set the iconified state of a window.
3741 * @param obj The window object
3742 * @param iconified If true, the window is iconified
3744 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3746 * Get the iconified state of a window.
3748 * @param obj The window object
3749 * @return If true, the window is iconified
3751 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3753 * Set the layer of the window.
3755 * What this means exactly will depend on the underlying engine used.
3757 * In the case of X11 backed engines, the value in @p layer has the
3758 * following meanings:
3759 * @li < 3: The window will be placed below all others.
3760 * @li > 5: The window will be placed above all others.
3761 * @li other: The window will be placed in the default layer.
3763 * @param obj The window object
3764 * @param layer The layer of the window
3766 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3768 * Get the layer of the window.
3770 * @param obj The window object
3771 * @return The layer of the window
3773 * @see elm_win_layer_set()
3775 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3777 * Set the rotation of the window.
3779 * Most engines only work with multiples of 90.
3781 * This function is used to set the orientation of the window @p obj to
3782 * match that of the screen. The window itself will be resized to adjust
3783 * to the new geometry of its contents. If you want to keep the window size,
3784 * see elm_win_rotation_with_resize_set().
3786 * @param obj The window object
3787 * @param rotation The rotation of the window, in degrees (0-360),
3788 * counter-clockwise.
3790 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3792 * Rotates the window and resizes it.
3794 * Like elm_win_rotation_set(), but it also resizes the window's contents so
3795 * that they fit inside the current window geometry.
3797 * @param obj The window object
3798 * @param layer The rotation of the window in degrees (0-360),
3799 * counter-clockwise.
3801 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3803 * Get the rotation of the window.
3805 * @param obj The window object
3806 * @return The rotation of the window in degrees (0-360)
3808 * @see elm_win_rotation_set()
3809 * @see elm_win_rotation_with_resize_set()
3811 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3813 * Set the sticky state of the window.
3815 * Hints the Window Manager that the window in @p obj should be left fixed
3816 * at its position even when the virtual desktop it's on moves or changes.
3818 * @param obj The window object
3819 * @param sticky If true, the window's sticky state is enabled
3821 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3823 * Get the sticky state of the window.
3825 * @param obj The window object
3826 * @return If true, the window's sticky state is enabled
3828 * @see elm_win_sticky_set()
3830 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3832 * Set if this window is an illume conformant window
3834 * @param obj The window object
3835 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3837 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3839 * Get if this window is an illume conformant window
3841 * @param obj The window object
3842 * @return A boolean if this window is illume conformant or not
3844 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3846 * Set a window to be an illume quickpanel window
3848 * By default window objects are not quickpanel windows.
3850 * @param obj The window object
3851 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3853 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3855 * Get if this window is a quickpanel or not
3857 * @param obj The window object
3858 * @return A boolean if this window is a quickpanel or not
3860 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3862 * Set the major priority of a quickpanel window
3864 * @param obj The window object
3865 * @param priority The major priority for this quickpanel
3867 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3869 * Get the major priority of a quickpanel window
3871 * @param obj The window object
3872 * @return The major priority of this quickpanel
3874 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3876 * Set the minor priority of a quickpanel window
3878 * @param obj The window object
3879 * @param priority The minor priority for this quickpanel
3881 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3883 * Get the minor priority of a quickpanel window
3885 * @param obj The window object
3886 * @return The minor priority of this quickpanel
3888 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3890 * Set which zone this quickpanel should appear in
3892 * @param obj The window object
3893 * @param zone The requested zone for this quickpanel
3895 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3897 * Get which zone this quickpanel should appear in
3899 * @param obj The window object
3900 * @return The requested zone for this quickpanel
3902 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3904 * Set the window to be skipped by keyboard focus
3906 * This sets the window to be skipped by normal keyboard input. This means
3907 * a window manager will be asked to not focus this window as well as omit
3908 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3910 * Call this and enable it on a window BEFORE you show it for the first time,
3911 * otherwise it may have no effect.
3913 * Use this for windows that have only output information or might only be
3914 * interacted with by the mouse or fingers, and never for typing input.
3915 * Be careful that this may have side-effects like making the window
3916 * non-accessible in some cases unless the window is specially handled. Use
3919 * @param obj The window object
3920 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3922 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3924 * Send a command to the windowing environment
3926 * This is intended to work in touchscreen or small screen device
3927 * environments where there is a more simplistic window management policy in
3928 * place. This uses the window object indicated to select which part of the
3929 * environment to control (the part that this window lives in), and provides
3930 * a command and an optional parameter structure (use NULL for this if not
3933 * @param obj The window object that lives in the environment to control
3934 * @param command The command to send
3935 * @param params Optional parameters for the command
3937 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3939 * Get the inlined image object handle
3941 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3942 * then the window is in fact an evas image object inlined in the parent
3943 * canvas. You can get this object (be careful to not manipulate it as it
3944 * is under control of elementary), and use it to do things like get pixel
3945 * data, save the image to a file, etc.
3947 * @param obj The window object to get the inlined image from
3948 * @return The inlined image object, or NULL if none exists
3950 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3952 * Set the enabled status for the focus highlight in a window
3954 * This function will enable or disable the focus highlight only for the
3955 * given window, regardless of the global setting for it
3957 * @param obj The window where to enable the highlight
3958 * @param enabled The enabled value for the highlight
3960 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3962 * Get the enabled value of the focus highlight for this window
3964 * @param obj The window in which to check if the focus highlight is enabled
3966 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
3968 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3970 * Set the style for the focus highlight on this window
3972 * Sets the style to use for theming the highlight of focused objects on
3973 * the given window. If @p style is NULL, the default will be used.
3975 * @param obj The window where to set the style
3976 * @param style The style to set
3978 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3980 * Get the style set for the focus highlight object
3982 * Gets the style set for this windows highilght object, or NULL if none
3985 * @param obj The window to retrieve the highlights style from
3987 * @return The style set or NULL if none was. Default is used in that case.
3989 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3991 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
3992 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
3993 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
3994 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
3995 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
3996 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
3997 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
3999 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4000 * (blank mouse, private mouse obj, defaultmouse)
4004 * Sets the keyboard mode of the window.
4006 * @param obj The window object
4007 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4009 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4011 * Gets the keyboard mode of the window.
4013 * @param obj The window object
4014 * @return The mode, one of #Elm_Win_Keyboard_Mode
4016 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4018 * Sets whether the window is a keyboard.
4020 * @param obj The window object
4021 * @param is_keyboard If true, the window is a virtual keyboard
4023 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4025 * Gets whether the window is a keyboard.
4027 * @param obj The window object
4028 * @return If the window is a virtual keyboard
4030 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4033 * Get the screen position of a window.
4035 * @param obj The window object
4036 * @param x The int to store the x coordinate to
4037 * @param y The int to store the y coordinate to
4039 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4045 * @defgroup Inwin Inwin
4047 * @image html img/widget/inwin/preview-00.png
4048 * @image latex img/widget/inwin/preview-00.eps
4049 * @image html img/widget/inwin/preview-01.png
4050 * @image latex img/widget/inwin/preview-01.eps
4051 * @image html img/widget/inwin/preview-02.png
4052 * @image latex img/widget/inwin/preview-02.eps
4054 * An inwin is a window inside a window that is useful for a quick popup.
4055 * It does not hover.
4057 * It works by creating an object that will occupy the entire window, so it
4058 * must be created using an @ref Win "elm_win" as parent only. The inwin
4059 * object can be hidden or restacked below every other object if it's
4060 * needed to show what's behind it without destroying it. If this is done,
4061 * the elm_win_inwin_activate() function can be used to bring it back to
4062 * full visibility again.
4064 * There are three styles available in the default theme. These are:
4065 * @li default: The inwin is sized to take over most of the window it's
4067 * @li minimal: The size of the inwin will be the minimum necessary to show
4069 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4070 * possible, but it's sized vertically the most it needs to fit its\
4073 * Some examples of Inwin can be found in the following:
4074 * @li @ref inwin_example_01
4079 * Adds an inwin to the current window
4081 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4082 * Never call this function with anything other than the top-most window
4083 * as its parameter, unless you are fond of undefined behavior.
4085 * After creating the object, the widget will set itself as resize object
4086 * for the window with elm_win_resize_object_add(), so when shown it will
4087 * appear to cover almost the entire window (how much of it depends on its
4088 * content and the style used). It must not be added into other container
4089 * objects and it needs not be moved or resized manually.
4091 * @param parent The parent object
4092 * @return The new object or NULL if it cannot be created
4094 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4096 * Activates an inwin object, ensuring its visibility
4098 * This function will make sure that the inwin @p obj is completely visible
4099 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4100 * to the front. It also sets the keyboard focus to it, which will be passed
4103 * The object's theme will also receive the signal "elm,action,show" with
4106 * @param obj The inwin to activate
4108 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4110 * Set the content of an inwin object.
4112 * Once the content object is set, a previously set one will be deleted.
4113 * If you want to keep that old content object, use the
4114 * elm_win_inwin_content_unset() function.
4116 * @param obj The inwin object
4117 * @param content The object to set as content
4119 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4121 * Get the content of an inwin object.
4123 * Return the content object which is set for this widget.
4125 * The returned object is valid as long as the inwin is still alive and no
4126 * other content is set on it. Deleting the object will notify the inwin
4127 * about it and this one will be left empty.
4129 * If you need to remove an inwin's content to be reused somewhere else,
4130 * see elm_win_inwin_content_unset().
4132 * @param obj The inwin object
4133 * @return The content that is being used
4135 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4137 * Unset the content of an inwin object.
4139 * Unparent and return the content object which was set for this widget.
4141 * @param obj The inwin object
4142 * @return The content that was being used
4144 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4148 /* X specific calls - won't work on non-x engines (return 0) */
4151 * Get the Ecore_X_Window of an Evas_Object
4153 * @param obj The object
4155 * @return The Ecore_X_Window of @p obj
4159 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4161 /* smart callbacks called:
4162 * "delete,request" - the user requested to delete the window
4163 * "focus,in" - window got focus
4164 * "focus,out" - window lost focus
4165 * "moved" - window that holds the canvas was moved
4171 * @image html img/widget/bg/preview-00.png
4172 * @image latex img/widget/bg/preview-00.eps
4174 * @brief Background object, used for setting a solid color, image or Edje
4175 * group as background to a window or any container object.
4177 * The bg object is used for setting a solid background to a window or
4178 * packing into any container object. It works just like an image, but has
4179 * some properties useful to a background, like setting it to tiled,
4180 * centered, scaled or stretched.
4182 * Here is some sample code using it:
4183 * @li @ref bg_01_example_page
4184 * @li @ref bg_02_example_page
4185 * @li @ref bg_03_example_page
4189 typedef enum _Elm_Bg_Option
4191 ELM_BG_OPTION_CENTER, /**< center the background */
4192 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4193 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4194 ELM_BG_OPTION_TILE /**< tile background at its original size */
4198 * Add a new background to the parent
4200 * @param parent The parent object
4201 * @return The new object or NULL if it cannot be created
4205 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4208 * Set the file (image or edje) used for the background
4210 * @param obj The bg object
4211 * @param file The file path
4212 * @param group Optional key (group in Edje) within the file
4214 * This sets the image file used in the background object. The image (or edje)
4215 * will be stretched (retaining aspect if its an image file) to completely fill
4216 * the bg object. This may mean some parts are not visible.
4218 * @note Once the image of @p obj is set, a previously set one will be deleted,
4219 * even if @p file is NULL.
4223 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4226 * Get the file (image or edje) used for the background
4228 * @param obj The bg object
4229 * @param file The file path
4230 * @param group Optional key (group in Edje) within the file
4234 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4237 * Set the option used for the background image
4239 * @param obj The bg object
4240 * @param option The desired background option (TILE, SCALE)
4242 * This sets the option used for manipulating the display of the background
4243 * image. The image can be tiled or scaled.
4247 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4250 * Get the option used for the background image
4252 * @param obj The bg object
4253 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4257 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4259 * Set the option used for the background color
4261 * @param obj The bg object
4266 * This sets the color used for the background rectangle. Its range goes
4271 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4273 * Get the option used for the background color
4275 * @param obj The bg object
4282 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4285 * Set the overlay object used for the background object.
4287 * @param obj The bg object
4288 * @param overlay The overlay object
4290 * This provides a way for elm_bg to have an 'overlay' that will be on top
4291 * of the bg. Once the over object is set, a previously set one will be
4292 * deleted, even if you set the new one to NULL. If you want to keep that
4293 * old content object, use the elm_bg_overlay_unset() function.
4298 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4301 * Get the overlay object used for the background object.
4303 * @param obj The bg object
4304 * @return The content that is being used
4306 * Return the content object which is set for this widget
4310 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4313 * Get the overlay object used for the background object.
4315 * @param obj The bg object
4316 * @return The content that was being used
4318 * Unparent and return the overlay object which was set for this widget
4322 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4325 * Set the size of the pixmap representation of the image.
4327 * This option just makes sense if an image is going to be set in the bg.
4329 * @param obj The bg object
4330 * @param w The new width of the image pixmap representation.
4331 * @param h The new height of the image pixmap representation.
4333 * This function sets a new size for pixmap representation of the given bg
4334 * image. It allows the image to be loaded already in the specified size,
4335 * reducing the memory usage and load time when loading a big image with load
4336 * size set to a smaller size.
4338 * NOTE: this is just a hint, the real size of the pixmap may differ
4339 * depending on the type of image being loaded, being bigger than requested.
4343 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4344 /* smart callbacks called:
4348 * @defgroup Icon Icon
4350 * @image html img/widget/icon/preview-00.png
4351 * @image latex img/widget/icon/preview-00.eps
4353 * An object that provides standard icon images (delete, edit, arrows, etc.)
4354 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4356 * The icon image requested can be in the elementary theme, or in the
4357 * freedesktop.org paths. It's possible to set the order of preference from
4358 * where the image will be used.
4360 * This API is very similar to @ref Image, but with ready to use images.
4362 * Default images provided by the theme are described below.
4364 * The first list contains icons that were first intended to be used in
4365 * toolbars, but can be used in many other places too:
4381 * Now some icons that were designed to be used in menus (but again, you can
4382 * use them anywhere else):
4387 * @li menu/arrow_down
4388 * @li menu/arrow_left
4389 * @li menu/arrow_right
4398 * And here we have some media player specific icons:
4399 * @li media_player/forward
4400 * @li media_player/info
4401 * @li media_player/next
4402 * @li media_player/pause
4403 * @li media_player/play
4404 * @li media_player/prev
4405 * @li media_player/rewind
4406 * @li media_player/stop
4408 * Signals that you can add callbacks for are:
4410 * "clicked" - This is called when a user has clicked the icon
4412 * An example of usage for this API follows:
4413 * @li @ref tutorial_icon
4421 typedef enum _Elm_Icon_Type
4428 * @enum _Elm_Icon_Lookup_Order
4429 * @typedef Elm_Icon_Lookup_Order
4431 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4432 * theme, FDO paths, or both?
4436 typedef enum _Elm_Icon_Lookup_Order
4438 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4439 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4440 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4441 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4442 } Elm_Icon_Lookup_Order;
4445 * Add a new icon object to the parent.
4447 * @param parent The parent object
4448 * @return The new object or NULL if it cannot be created
4450 * @see elm_icon_file_set()
4454 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4456 * Set the file that will be used as icon.
4458 * @param obj The icon object
4459 * @param file The path to file that will be used as icon image
4460 * @param group The group that the icon belongs to in edje file
4462 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4464 * @note The icon image set by this function can be changed by
4465 * elm_icon_standard_set().
4467 * @see elm_icon_file_get()
4471 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4473 * Set a location in memory to be used as an icon
4475 * @param obj The icon object
4476 * @param img The binary data that will be used as an image
4477 * @param size The size of binary data @p img
4478 * @param format Optional format of @p img to pass to the image loader
4479 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4481 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4483 * @note The icon image set by this function can be changed by
4484 * elm_icon_standard_set().
4488 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);
4490 * Get the file that will be used as icon.
4492 * @param obj The icon object
4493 * @param file The path to file that will be used as icon icon image
4494 * @param group The group that the icon belongs to in edje file
4496 * @see elm_icon_file_set()
4500 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4501 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4503 * Set the icon by icon standards names.
4505 * @param obj The icon object
4506 * @param name The icon name
4508 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4510 * For example, freedesktop.org defines standard icon names such as "home",
4511 * "network", etc. There can be different icon sets to match those icon
4512 * keys. The @p name given as parameter is one of these "keys", and will be
4513 * used to look in the freedesktop.org paths and elementary theme. One can
4514 * change the lookup order with elm_icon_order_lookup_set().
4516 * If name is not found in any of the expected locations and it is the
4517 * absolute path of an image file, this image will be used.
4519 * @note The icon image set by this function can be changed by
4520 * elm_icon_file_set().
4522 * @see elm_icon_standard_get()
4523 * @see elm_icon_file_set()
4527 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4529 * Get the icon name set by icon standard names.
4531 * @param obj The icon object
4532 * @return The icon name
4534 * If the icon image was set using elm_icon_file_set() instead of
4535 * elm_icon_standard_set(), then this function will return @c NULL.
4537 * @see elm_icon_standard_set()
4541 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4543 * Set the smooth effect for an icon object.
4545 * @param obj The icon object
4546 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4547 * otherwise. Default is @c EINA_TRUE.
4549 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4550 * scaling provides a better resulting image, but is slower.
4552 * The smooth scaling should be disabled when making animations that change
4553 * the icon size, since they will be faster. Animations that don't require
4554 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4555 * is already scaled, since the scaled icon image will be cached).
4557 * @see elm_icon_smooth_get()
4561 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4563 * Get the smooth effect for an icon object.
4565 * @param obj The icon object
4566 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4568 * @see elm_icon_smooth_set()
4572 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4574 * Disable scaling of this object.
4576 * @param obj The icon object.
4577 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4578 * otherwise. Default is @c EINA_FALSE.
4580 * This function disables scaling of the icon object through the function
4581 * elm_object_scale_set(). However, this does not affect the object
4582 * size/resize in any way. For that effect, take a look at
4583 * elm_icon_scale_set().
4585 * @see elm_icon_no_scale_get()
4586 * @see elm_icon_scale_set()
4587 * @see elm_object_scale_set()
4591 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4593 * Get whether scaling is disabled on the object.
4595 * @param obj The icon object
4596 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4598 * @see elm_icon_no_scale_set()
4602 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4604 * Set if the object is (up/down) resizeable.
4606 * @param obj The icon object
4607 * @param scale_up A bool to set if the object is resizeable up. Default is
4609 * @param scale_down A bool to set if the object is resizeable down. Default
4612 * This function limits the icon object resize ability. If @p scale_up is set to
4613 * @c EINA_FALSE, the object can't have its height or width resized to a value
4614 * higher than the original icon size. Same is valid for @p scale_down.
4616 * @see elm_icon_scale_get()
4620 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4622 * Get if the object is (up/down) resizeable.
4624 * @param obj The icon object
4625 * @param scale_up A bool to set if the object is resizeable up
4626 * @param scale_down A bool to set if the object is resizeable down
4628 * @see elm_icon_scale_set()
4632 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4634 * Get the object's image size
4636 * @param obj The icon object
4637 * @param w A pointer to store the width in
4638 * @param h A pointer to store the height in
4642 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4644 * Set if the icon fill the entire object area.
4646 * @param obj The icon object
4647 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4648 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4650 * When the icon object is resized to a different aspect ratio from the
4651 * original icon image, the icon image will still keep its aspect. This flag
4652 * tells how the image should fill the object's area. They are: keep the
4653 * entire icon inside the limits of height and width of the object (@p
4654 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4655 * of the object, and the icon will fill the entire object (@p fill_outside
4658 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4659 * retain property to false. Thus, the icon image will always keep its
4660 * original aspect ratio.
4662 * @see elm_icon_fill_outside_get()
4663 * @see elm_image_fill_outside_set()
4667 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4669 * Get if the object is filled outside.
4671 * @param obj The icon object
4672 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4674 * @see elm_icon_fill_outside_set()
4678 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4680 * Set the prescale size for the icon.
4682 * @param obj The icon object
4683 * @param size The prescale size. This value is used for both width and
4686 * This function sets a new size for pixmap representation of the given
4687 * icon. It allows the icon to be loaded already in the specified size,
4688 * reducing the memory usage and load time when loading a big icon with load
4689 * size set to a smaller size.
4691 * It's equivalent to the elm_bg_load_size_set() function for bg.
4693 * @note this is just a hint, the real size of the pixmap may differ
4694 * depending on the type of icon being loaded, being bigger than requested.
4696 * @see elm_icon_prescale_get()
4697 * @see elm_bg_load_size_set()
4701 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4703 * Get the prescale size for the icon.
4705 * @param obj The icon object
4706 * @return The prescale size
4708 * @see elm_icon_prescale_set()
4712 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4714 * Sets the icon lookup order used by elm_icon_standard_set().
4716 * @param obj The icon object
4717 * @param order The icon lookup order (can be one of
4718 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4719 * or ELM_ICON_LOOKUP_THEME)
4721 * @see elm_icon_order_lookup_get()
4722 * @see Elm_Icon_Lookup_Order
4726 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4728 * Gets the icon lookup order.
4730 * @param obj The icon object
4731 * @return The icon lookup order
4733 * @see elm_icon_order_lookup_set()
4734 * @see Elm_Icon_Lookup_Order
4738 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4745 * @defgroup Image Image
4747 * @image html img/widget/image/preview-00.png
4748 * @image latex img/widget/image/preview-00.eps
4750 * An object that allows one to load an image file to it. It can be used
4751 * anywhere like any other elementary widget.
4753 * This widget provides most of the functionality provided from @ref Bg or @ref
4754 * Icon, but with a slightly different API (use the one that fits better your
4757 * The features not provided by those two other image widgets are:
4758 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4759 * @li change the object orientation with elm_image_orient_set();
4760 * @li and turning the image editable with elm_image_editable_set().
4762 * Signals that you can add callbacks for are:
4764 * @li @c "clicked" - This is called when a user has clicked the image
4766 * An example of usage for this API follows:
4767 * @li @ref tutorial_image
4776 * @enum _Elm_Image_Orient
4777 * @typedef Elm_Image_Orient
4779 * Possible orientation options for elm_image_orient_set().
4781 * @image html elm_image_orient_set.png
4782 * @image latex elm_image_orient_set.eps width=\textwidth
4786 typedef enum _Elm_Image_Orient
4788 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4789 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4790 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4791 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4792 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4793 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4794 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4795 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4799 * Add a new image to the parent.
4801 * @param parent The parent object
4802 * @return The new object or NULL if it cannot be created
4804 * @see elm_image_file_set()
4808 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4810 * Set the file that will be used as image.
4812 * @param obj The image object
4813 * @param file The path to file that will be used as image
4814 * @param group The group that the image belongs in edje file (if it's an
4817 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4819 * @see elm_image_file_get()
4823 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4825 * Get the file that will be used as image.
4827 * @param obj The image object
4828 * @param file The path to file
4829 * @param group The group that the image belongs in edje file
4831 * @see elm_image_file_set()
4835 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4837 * Set the smooth effect for an image.
4839 * @param obj The image object
4840 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4841 * otherwise. Default is @c EINA_TRUE.
4843 * Set the scaling algorithm to be used when scaling the image. Smooth
4844 * scaling provides a better resulting image, but is slower.
4846 * The smooth scaling should be disabled when making animations that change
4847 * the image size, since it will be faster. Animations that don't require
4848 * resizing of the image can keep the smooth scaling enabled (even if the
4849 * image is already scaled, since the scaled image will be cached).
4851 * @see elm_image_smooth_get()
4855 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4857 * Get the smooth effect for an image.
4859 * @param obj The image object
4860 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4862 * @see elm_image_smooth_get()
4866 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4868 * Gets the current size of the image.
4870 * @param obj The image object.
4871 * @param w Pointer to store width, or NULL.
4872 * @param h Pointer to store height, or NULL.
4874 * This is the real size of the image, not the size of the object.
4876 * On error, neither w or h will be written.
4880 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4882 * Disable scaling of this object.
4884 * @param obj The image object.
4885 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4886 * otherwise. Default is @c EINA_FALSE.
4888 * This function disables scaling of the elm_image widget through the
4889 * function elm_object_scale_set(). However, this does not affect the widget
4890 * size/resize in any way. For that effect, take a look at
4891 * elm_image_scale_set().
4893 * @see elm_image_no_scale_get()
4894 * @see elm_image_scale_set()
4895 * @see elm_object_scale_set()
4899 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4901 * Get whether scaling is disabled on the object.
4903 * @param obj The image object
4904 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4906 * @see elm_image_no_scale_set()
4910 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4912 * Set if the object is (up/down) resizeable.
4914 * @param obj The image object
4915 * @param scale_up A bool to set if the object is resizeable up. Default is
4917 * @param scale_down A bool to set if the object is resizeable down. Default
4920 * This function limits the image resize ability. If @p scale_up is set to
4921 * @c EINA_FALSE, the object can't have its height or width resized to a value
4922 * higher than the original image size. Same is valid for @p scale_down.
4924 * @see elm_image_scale_get()
4928 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4930 * Get if the object is (up/down) resizeable.
4932 * @param obj The image object
4933 * @param scale_up A bool to set if the object is resizeable up
4934 * @param scale_down A bool to set if the object is resizeable down
4936 * @see elm_image_scale_set()
4940 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4942 * Set if the image fill the entire object area when keeping the aspect ratio.
4944 * @param obj The image object
4945 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4946 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4948 * When the image should keep its aspect ratio even if resized to another
4949 * aspect ratio, there are two possibilities to resize it: keep the entire
4950 * image inside the limits of height and width of the object (@p fill_outside
4951 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
4952 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
4954 * @note This option will have no effect if
4955 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
4957 * @see elm_image_fill_outside_get()
4958 * @see elm_image_aspect_ratio_retained_set()
4962 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4964 * Get if the object is filled outside
4966 * @param obj The image object
4967 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4969 * @see elm_image_fill_outside_set()
4973 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4975 * Set the prescale size for the image
4977 * @param obj The image object
4978 * @param size The prescale size. This value is used for both width and
4981 * This function sets a new size for pixmap representation of the given
4982 * image. It allows the image to be loaded already in the specified size,
4983 * reducing the memory usage and load time when loading a big image with load
4984 * size set to a smaller size.
4986 * It's equivalent to the elm_bg_load_size_set() function for bg.
4988 * @note this is just a hint, the real size of the pixmap may differ
4989 * depending on the type of image being loaded, being bigger than requested.
4991 * @see elm_image_prescale_get()
4992 * @see elm_bg_load_size_set()
4996 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4998 * Get the prescale size for the image
5000 * @param obj The image object
5001 * @return The prescale size
5003 * @see elm_image_prescale_set()
5007 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5009 * Set the image orientation.
5011 * @param obj The image object
5012 * @param orient The image orientation
5013 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5014 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5015 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5016 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5017 * Default is #ELM_IMAGE_ORIENT_NONE.
5019 * This function allows to rotate or flip the given image.
5021 * @see elm_image_orient_get()
5022 * @see @ref Elm_Image_Orient
5026 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5028 * Get the image orientation.
5030 * @param obj The image object
5031 * @return The image orientation
5032 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5033 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5034 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5035 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5037 * @see elm_image_orient_set()
5038 * @see @ref Elm_Image_Orient
5042 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5044 * Make the image 'editable'.
5046 * @param obj Image object.
5047 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5049 * This means the image is a valid drag target for drag and drop, and can be
5050 * cut or pasted too.
5054 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5056 * Make the image 'editable'.
5058 * @param obj Image object.
5059 * @return Editability.
5061 * This means the image is a valid drag target for drag and drop, and can be
5062 * cut or pasted too.
5066 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5068 * Get the basic Evas_Image object from this object (widget).
5070 * @param obj The image object to get the inlined image from
5071 * @return The inlined image object, or NULL if none exists
5073 * This function allows one to get the underlying @c Evas_Object of type
5074 * Image from this elementary widget. It can be useful to do things like get
5075 * the pixel data, save the image to a file, etc.
5077 * @note Be careful to not manipulate it, as it is under control of
5082 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5084 * Set whether the original aspect ratio of the image should be kept on resize.
5086 * @param obj The image object.
5087 * @param retained @c EINA_TRUE if the image should retain the aspect,
5088 * @c EINA_FALSE otherwise.
5090 * The original aspect ratio (width / height) of the image is usually
5091 * distorted to match the object's size. Enabling this option will retain
5092 * this original aspect, and the way that the image is fit into the object's
5093 * area depends on the option set by elm_image_fill_outside_set().
5095 * @see elm_image_aspect_ratio_retained_get()
5096 * @see elm_image_fill_outside_set()
5100 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5102 * Get if the object retains the original aspect ratio.
5104 * @param obj The image object.
5105 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5110 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5112 /* smart callbacks called:
5113 * "clicked" - the user clicked the image
5121 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5123 typedef enum _Elm_GLView_Mode
5125 ELM_GLVIEW_ALPHA = 1,
5126 ELM_GLVIEW_DEPTH = 2,
5127 ELM_GLVIEW_STENCIL = 4
5131 * Defines a policy for the glview resizing.
5133 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5135 typedef enum _Elm_GLView_Resize_Policy
5137 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5138 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5139 } Elm_GLView_Resize_Policy;
5141 typedef enum _Elm_GLView_Render_Policy
5143 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5144 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5145 } Elm_GLView_Render_Policy;
5150 * A simple GLView widget that allows GL rendering.
5152 * Signals that you can add callbacks for are:
5158 * Add a new glview to the parent
5160 * @param parent The parent object
5161 * @return The new object or NULL if it cannot be created
5165 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5168 * Sets the size of the glview
5170 * @param obj The glview object
5171 * @param width width of the glview object
5172 * @param height height of the glview object
5176 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5179 * Gets the size of the glview.
5181 * @param obj The glview object
5182 * @param width width of the glview object
5183 * @param height height of the glview object
5185 * Note that this function returns the actual image size of the
5186 * glview. This means that when the scale policy is set to
5187 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5192 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5195 * Gets the gl api struct for gl rendering
5197 * @param obj The glview object
5198 * @return The api object or NULL if it cannot be created
5202 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5205 * Set the mode of the GLView. Supports Three simple modes.
5207 * @param obj The glview object
5208 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5209 * @return True if set properly.
5213 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5216 * Set the resize policy for the glview object.
5218 * @param obj The glview object.
5219 * @param policy The scaling policy.
5221 * By default, the resize policy is set to
5222 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5223 * destroys the previous surface and recreates the newly specified
5224 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5225 * however, glview only scales the image object and not the underlying
5230 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5233 * Set the render policy for the glview object.
5235 * @param obj The glview object.
5236 * @param policy The render policy.
5238 * By default, the render policy is set to
5239 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5240 * that during the render loop, glview is only redrawn if it needs
5241 * to be redrawn. (i.e. When it is visible) If the policy is set to
5242 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5243 * whether it is visible/need redrawing or not.
5247 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5250 * Set the init function that runs once in the main loop.
5252 * @param obj The glview object.
5253 * @param func The init function to be registered.
5255 * The registered init function gets called once during the render loop.
5259 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5262 * Set the render function that runs in the main loop.
5264 * @param obj The glview object.
5265 * @param func The delete function to be registered.
5267 * The registered del function gets called when GLView object is deleted.
5271 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5274 * Set the resize function that gets called when resize happens.
5276 * @param obj The glview object.
5277 * @param func The resize function to be registered.
5281 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5284 * Set the render function that runs in the main loop.
5286 * @param obj The glview object.
5287 * @param func The render function to be registered.
5291 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5294 * Notifies that there has been changes in the GLView.
5296 * @param obj The glview object.
5300 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5310 * @image html img/widget/box/preview-00.png
5311 * @image latex img/widget/box/preview-00.eps width=\textwidth
5313 * @image html img/box.png
5314 * @image latex img/box.eps width=\textwidth
5316 * A box arranges objects in a linear fashion, governed by a layout function
5317 * that defines the details of this arrangement.
5319 * By default, the box will use an internal function to set the layout to
5320 * a single row, either vertical or horizontal. This layout is affected
5321 * by a number of parameters, such as the homogeneous flag set by
5322 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5323 * elm_box_align_set() and the hints set to each object in the box.
5325 * For this default layout, it's possible to change the orientation with
5326 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5327 * placing its elements ordered from top to bottom. When horizontal is set,
5328 * the order will go from left to right. If the box is set to be
5329 * homogeneous, every object in it will be assigned the same space, that
5330 * of the largest object. Padding can be used to set some spacing between
5331 * the cell given to each object. The alignment of the box, set with
5332 * elm_box_align_set(), determines how the bounding box of all the elements
5333 * will be placed within the space given to the box widget itself.
5335 * The size hints of each object also affect how they are placed and sized
5336 * within the box. evas_object_size_hint_min_set() will give the minimum
5337 * size the object can have, and the box will use it as the basis for all
5338 * latter calculations. Elementary widgets set their own minimum size as
5339 * needed, so there's rarely any need to use it manually.
5341 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5342 * used to tell whether the object will be allocated the minimum size it
5343 * needs or if the space given to it should be expanded. It's important
5344 * to realize that expanding the size given to the object is not the same
5345 * thing as resizing the object. It could very well end being a small
5346 * widget floating in a much larger empty space. If not set, the weight
5347 * for objects will normally be 0.0 for both axis, meaning the widget will
5348 * not be expanded. To take as much space possible, set the weight to
5349 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5351 * Besides how much space each object is allocated, it's possible to control
5352 * how the widget will be placed within that space using
5353 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5354 * for both axis, meaning the object will be centered, but any value from
5355 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5356 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5357 * is -1.0, means the object will be resized to fill the entire space it
5360 * In addition, customized functions to define the layout can be set, which
5361 * allow the application developer to organize the objects within the box
5362 * in any number of ways.
5364 * The special elm_box_layout_transition() function can be used
5365 * to switch from one layout to another, animating the motion of the
5366 * children of the box.
5368 * @note Objects should not be added to box objects using _add() calls.
5370 * Some examples on how to use boxes follow:
5371 * @li @ref box_example_01
5372 * @li @ref box_example_02
5377 * @typedef Elm_Box_Transition
5379 * Opaque handler containing the parameters to perform an animated
5380 * transition of the layout the box uses.
5382 * @see elm_box_transition_new()
5383 * @see elm_box_layout_set()
5384 * @see elm_box_layout_transition()
5386 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5389 * Add a new box to the parent
5391 * By default, the box will be in vertical mode and non-homogeneous.
5393 * @param parent The parent object
5394 * @return The new object or NULL if it cannot be created
5396 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5398 * Set the horizontal orientation
5400 * By default, box object arranges their contents vertically from top to
5402 * By calling this function with @p horizontal as EINA_TRUE, the box will
5403 * become horizontal, arranging contents from left to right.
5405 * @note This flag is ignored if a custom layout function is set.
5407 * @param obj The box object
5408 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5409 * EINA_FALSE = vertical)
5411 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5413 * Get the horizontal orientation
5415 * @param obj The box object
5416 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5418 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5420 * Set the box to arrange its children homogeneously
5422 * If enabled, homogeneous layout makes all items the same size, according
5423 * to the size of the largest of its children.
5425 * @note This flag is ignored if a custom layout function is set.
5427 * @param obj The box object
5428 * @param homogeneous The homogeneous flag
5430 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5432 * Get whether the box is using homogeneous mode or not
5434 * @param obj The box object
5435 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5437 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5438 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5439 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5441 * Add an object to the beginning of the pack list
5443 * Pack @p subobj into the box @p obj, placing it first in the list of
5444 * children objects. The actual position the object will get on screen
5445 * depends on the layout used. If no custom layout is set, it will be at
5446 * the top or left, depending if the box is vertical or horizontal,
5449 * @param obj The box object
5450 * @param subobj The object to add to the box
5452 * @see elm_box_pack_end()
5453 * @see elm_box_pack_before()
5454 * @see elm_box_pack_after()
5455 * @see elm_box_unpack()
5456 * @see elm_box_unpack_all()
5457 * @see elm_box_clear()
5459 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5461 * Add an object at the end of the pack list
5463 * Pack @p subobj into the box @p obj, placing it last in the list of
5464 * children objects. The actual position the object will get on screen
5465 * depends on the layout used. If no custom layout is set, it will be at
5466 * the bottom or right, depending if the box is vertical or horizontal,
5469 * @param obj The box object
5470 * @param subobj The object to add to the box
5472 * @see elm_box_pack_start()
5473 * @see elm_box_pack_before()
5474 * @see elm_box_pack_after()
5475 * @see elm_box_unpack()
5476 * @see elm_box_unpack_all()
5477 * @see elm_box_clear()
5479 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5481 * Adds an object to the box before the indicated object
5483 * This will add the @p subobj to the box indicated before the object
5484 * indicated with @p before. If @p before is not already in the box, results
5485 * are undefined. Before means either to the left of the indicated object or
5486 * above it depending on orientation.
5488 * @param obj The box object
5489 * @param subobj The object to add to the box
5490 * @param before The object before which to add it
5492 * @see elm_box_pack_start()
5493 * @see elm_box_pack_end()
5494 * @see elm_box_pack_after()
5495 * @see elm_box_unpack()
5496 * @see elm_box_unpack_all()
5497 * @see elm_box_clear()
5499 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5501 * Adds an object to the box after the indicated object
5503 * This will add the @p subobj to the box indicated after the object
5504 * indicated with @p after. If @p after is not already in the box, results
5505 * are undefined. After means either to the right of the indicated object or
5506 * below it depending on orientation.
5508 * @param obj The box object
5509 * @param subobj The object to add to the box
5510 * @param after The object after which to add it
5512 * @see elm_box_pack_start()
5513 * @see elm_box_pack_end()
5514 * @see elm_box_pack_before()
5515 * @see elm_box_unpack()
5516 * @see elm_box_unpack_all()
5517 * @see elm_box_clear()
5519 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5521 * Clear the box of all children
5523 * Remove all the elements contained by the box, deleting the respective
5526 * @param obj The box object
5528 * @see elm_box_unpack()
5529 * @see elm_box_unpack_all()
5531 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5535 * Remove the object given by @p subobj from the box @p obj without
5538 * @param obj The box object
5540 * @see elm_box_unpack_all()
5541 * @see elm_box_clear()
5543 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5545 * Remove all items from the box, without deleting them
5547 * Clear the box from all children, but don't delete the respective objects.
5548 * If no other references of the box children exist, the objects will never
5549 * be deleted, and thus the application will leak the memory. Make sure
5550 * when using this function that you hold a reference to all the objects
5551 * in the box @p obj.
5553 * @param obj The box object
5555 * @see elm_box_clear()
5556 * @see elm_box_unpack()
5558 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5560 * Retrieve a list of the objects packed into the box
5562 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5563 * The order of the list corresponds to the packing order the box uses.
5565 * You must free this list with eina_list_free() once you are done with it.
5567 * @param obj The box object
5569 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5571 * Set the space (padding) between the box's elements.
5573 * Extra space in pixels that will be added between a box child and its
5574 * neighbors after its containing cell has been calculated. This padding
5575 * is set for all elements in the box, besides any possible padding that
5576 * individual elements may have through their size hints.
5578 * @param obj The box object
5579 * @param horizontal The horizontal space between elements
5580 * @param vertical The vertical space between elements
5582 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5584 * Get the space (padding) between the box's elements.
5586 * @param obj The box object
5587 * @param horizontal The horizontal space between elements
5588 * @param vertical The vertical space between elements
5590 * @see elm_box_padding_set()
5592 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5594 * Set the alignment of the whole bouding box of contents.
5596 * Sets how the bounding box containing all the elements of the box, after
5597 * their sizes and position has been calculated, will be aligned within
5598 * the space given for the whole box widget.
5600 * @param obj The box object
5601 * @param horizontal The horizontal alignment of elements
5602 * @param vertical The vertical alignment of elements
5604 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5606 * Get the alignment of the whole bouding box of contents.
5608 * @param obj The box object
5609 * @param horizontal The horizontal alignment of elements
5610 * @param vertical The vertical alignment of elements
5612 * @see elm_box_align_set()
5614 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5617 * Set the layout defining function to be used by the box
5619 * Whenever anything changes that requires the box in @p obj to recalculate
5620 * the size and position of its elements, the function @p cb will be called
5621 * to determine what the layout of the children will be.
5623 * Once a custom function is set, everything about the children layout
5624 * is defined by it. The flags set by elm_box_horizontal_set() and
5625 * elm_box_homogeneous_set() no longer have any meaning, and the values
5626 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5627 * layout function to decide if they are used and how. These last two
5628 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5629 * passed to @p cb. The @c Evas_Object the function receives is not the
5630 * Elementary widget, but the internal Evas Box it uses, so none of the
5631 * functions described here can be used on it.
5633 * Any of the layout functions in @c Evas can be used here, as well as the
5634 * special elm_box_layout_transition().
5636 * The final @p data argument received by @p cb is the same @p data passed
5637 * here, and the @p free_data function will be called to free it
5638 * whenever the box is destroyed or another layout function is set.
5640 * Setting @p cb to NULL will revert back to the default layout function.
5642 * @param obj The box object
5643 * @param cb The callback function used for layout
5644 * @param data Data that will be passed to layout function
5645 * @param free_data Function called to free @p data
5647 * @see elm_box_layout_transition()
5649 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);
5651 * Special layout function that animates the transition from one layout to another
5653 * Normally, when switching the layout function for a box, this will be
5654 * reflected immediately on screen on the next render, but it's also
5655 * possible to do this through an animated transition.
5657 * This is done by creating an ::Elm_Box_Transition and setting the box
5658 * layout to this function.
5662 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5663 * evas_object_box_layout_vertical, // start
5664 * NULL, // data for initial layout
5665 * NULL, // free function for initial data
5666 * evas_object_box_layout_horizontal, // end
5667 * NULL, // data for final layout
5668 * NULL, // free function for final data
5669 * anim_end, // will be called when animation ends
5670 * NULL); // data for anim_end function\
5671 * elm_box_layout_set(box, elm_box_layout_transition, t,
5672 * elm_box_transition_free);
5675 * @note This function can only be used with elm_box_layout_set(). Calling
5676 * it directly will not have the expected results.
5678 * @see elm_box_transition_new
5679 * @see elm_box_transition_free
5680 * @see elm_box_layout_set
5682 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5684 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5686 * If you want to animate the change from one layout to another, you need
5687 * to set the layout function of the box to elm_box_layout_transition(),
5688 * passing as user data to it an instance of ::Elm_Box_Transition with the
5689 * necessary information to perform this animation. The free function to
5690 * set for the layout is elm_box_transition_free().
5692 * The parameters to create an ::Elm_Box_Transition sum up to how long
5693 * will it be, in seconds, a layout function to describe the initial point,
5694 * another for the final position of the children and one function to be
5695 * called when the whole animation ends. This last function is useful to
5696 * set the definitive layout for the box, usually the same as the end
5697 * layout for the animation, but could be used to start another transition.
5699 * @param start_layout The layout function that will be used to start the animation
5700 * @param start_layout_data The data to be passed the @p start_layout function
5701 * @param start_layout_free_data Function to free @p start_layout_data
5702 * @param end_layout The layout function that will be used to end the animation
5703 * @param end_layout_free_data The data to be passed the @p end_layout function
5704 * @param end_layout_free_data Function to free @p end_layout_data
5705 * @param transition_end_cb Callback function called when animation ends
5706 * @param transition_end_data Data to be passed to @p transition_end_cb
5707 * @return An instance of ::Elm_Box_Transition
5709 * @see elm_box_transition_new
5710 * @see elm_box_layout_transition
5712 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);
5714 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5716 * This function is mostly useful as the @c free_data parameter in
5717 * elm_box_layout_set() when elm_box_layout_transition().
5719 * @param data The Elm_Box_Transition instance to be freed.
5721 * @see elm_box_transition_new
5722 * @see elm_box_layout_transition
5724 EAPI void elm_box_transition_free(void *data);
5731 * @defgroup Button Button
5733 * @image html img/widget/button/preview-00.png
5734 * @image latex img/widget/button/preview-00.eps
5735 * @image html img/widget/button/preview-01.png
5736 * @image latex img/widget/button/preview-01.eps
5737 * @image html img/widget/button/preview-02.png
5738 * @image latex img/widget/button/preview-02.eps
5740 * This is a push-button. Press it and run some function. It can contain
5741 * a simple label and icon object and it also has an autorepeat feature.
5743 * This widgets emits the following signals:
5744 * @li "clicked": the user clicked the button (press/release).
5745 * @li "repeated": the user pressed the button without releasing it.
5746 * @li "pressed": button was pressed.
5747 * @li "unpressed": button was released after being pressed.
5748 * In all three cases, the @c event parameter of the callback will be
5751 * Also, defined in the default theme, the button has the following styles
5753 * @li default: a normal button.
5754 * @li anchor: Like default, but the button fades away when the mouse is not
5755 * over it, leaving only the text or icon.
5756 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5757 * continuous look across its options.
5758 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5760 * Follow through a complete example @ref button_example_01 "here".
5764 * Add a new button to the parent's canvas
5766 * @param parent The parent object
5767 * @return The new object or NULL if it cannot be created
5769 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5771 * Set the label used in the button
5773 * The passed @p label can be NULL to clean any existing text in it and
5774 * leave the button as an icon only object.
5776 * @param obj The button object
5777 * @param label The text will be written on the button
5778 * @deprecated use elm_object_text_set() instead.
5780 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5782 * Get the label set for the button
5784 * The string returned is an internal pointer and should not be freed or
5785 * altered. It will also become invalid when the button is destroyed.
5786 * The string returned, if not NULL, is a stringshare, so if you need to
5787 * keep it around even after the button is destroyed, you can use
5788 * eina_stringshare_ref().
5790 * @param obj The button object
5791 * @return The text set to the label, or NULL if nothing is set
5792 * @deprecated use elm_object_text_set() instead.
5794 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5796 * Set the icon used for the button
5798 * Setting a new icon will delete any other that was previously set, making
5799 * any reference to them invalid. If you need to maintain the previous
5800 * object alive, unset it first with elm_button_icon_unset().
5802 * @param obj The button object
5803 * @param icon The icon object for the button
5805 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5807 * Get the icon used for the button
5809 * Return the icon object which is set for this widget. If the button is
5810 * destroyed or another icon is set, the returned object will be deleted
5811 * and any reference to it will be invalid.
5813 * @param obj The button object
5814 * @return The icon object that is being used
5816 * @see elm_button_icon_unset()
5818 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5820 * Remove the icon set without deleting it and return the object
5822 * This function drops the reference the button holds of the icon object
5823 * and returns this last object. It is used in case you want to remove any
5824 * icon, or set another one, without deleting the actual object. The button
5825 * will be left without an icon set.
5827 * @param obj The button object
5828 * @return The icon object that was being used
5830 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5832 * Turn on/off the autorepeat event generated when the button is kept pressed
5834 * When off, no autorepeat is performed and buttons emit a normal @c clicked
5835 * signal when they are clicked.
5837 * When on, keeping a button pressed will continuously emit a @c repeated
5838 * signal until the button is released. The time it takes until it starts
5839 * emitting the signal is given by
5840 * elm_button_autorepeat_initial_timeout_set(), and the time between each
5841 * new emission by elm_button_autorepeat_gap_timeout_set().
5843 * @param obj The button object
5844 * @param on A bool to turn on/off the event
5846 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5848 * Get whether the autorepeat feature is enabled
5850 * @param obj The button object
5851 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5853 * @see elm_button_autorepeat_set()
5855 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5857 * Set the initial timeout before the autorepeat event is generated
5859 * Sets the timeout, in seconds, since the button is pressed until the
5860 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5861 * won't be any delay and the even will be fired the moment the button is
5864 * @param obj The button object
5865 * @param t Timeout in seconds
5867 * @see elm_button_autorepeat_set()
5868 * @see elm_button_autorepeat_gap_timeout_set()
5870 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5872 * Get the initial timeout before the autorepeat event is generated
5874 * @param obj The button object
5875 * @return Timeout in seconds
5877 * @see elm_button_autorepeat_initial_timeout_set()
5879 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5881 * Set the interval between each generated autorepeat event
5883 * After the first @c repeated event is fired, all subsequent ones will
5884 * follow after a delay of @p t seconds for each.
5886 * @param obj The button object
5887 * @param t Interval in seconds
5889 * @see elm_button_autorepeat_initial_timeout_set()
5891 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5893 * Get the interval between each generated autorepeat event
5895 * @param obj The button object
5896 * @return Interval in seconds
5898 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5904 * @defgroup File_Selector_Button File Selector Button
5906 * @image html img/widget/fileselector_button/preview-00.png
5907 * @image latex img/widget/fileselector_button/preview-00.eps
5908 * @image html img/widget/fileselector_button/preview-01.png
5909 * @image latex img/widget/fileselector_button/preview-01.eps
5910 * @image html img/widget/fileselector_button/preview-02.png
5911 * @image latex img/widget/fileselector_button/preview-02.eps
5913 * This is a button that, when clicked, creates an Elementary
5914 * window (or inner window) <b> with a @ref Fileselector "file
5915 * selector widget" within</b>. When a file is chosen, the (inner)
5916 * window is closed and the button emits a signal having the
5917 * selected file as it's @c event_info.
5919 * This widget encapsulates operations on its internal file
5920 * selector on its own API. There is less control over its file
5921 * selector than that one would have instatiating one directly.
5923 * The following styles are available for this button:
5926 * @li @c "hoversel_vertical"
5927 * @li @c "hoversel_vertical_entry"
5929 * Smart callbacks one can register to:
5930 * - @c "file,chosen" - the user has selected a path, whose string
5931 * pointer comes as the @c event_info data (a stringshared
5934 * Here is an example on its usage:
5935 * @li @ref fileselector_button_example
5937 * @see @ref File_Selector_Entry for a similar widget.
5942 * Add a new file selector button widget to the given parent
5943 * Elementary (container) object
5945 * @param parent The parent object
5946 * @return a new file selector button widget handle or @c NULL, on
5949 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5952 * Set the label for a given file selector button widget
5954 * @param obj The file selector button widget
5955 * @param label The text label to be displayed on @p obj
5957 * @deprecated use elm_object_text_set() instead.
5959 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5962 * Get the label set for a given file selector button widget
5964 * @param obj The file selector button widget
5965 * @return The button label
5967 * @deprecated use elm_object_text_set() instead.
5969 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5972 * Set the icon on a given file selector button widget
5974 * @param obj The file selector button widget
5975 * @param icon The icon object for the button
5977 * Once the icon object is set, a previously set one will be
5978 * deleted. If you want to keep the latter, use the
5979 * elm_fileselector_button_icon_unset() function.
5981 * @see elm_fileselector_button_icon_get()
5983 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5986 * Get the icon set for a given file selector button widget
5988 * @param obj The file selector button widget
5989 * @return The icon object currently set on @p obj or @c NULL, if
5992 * @see elm_fileselector_button_icon_set()
5994 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5997 * Unset the icon used in a given file selector button widget
5999 * @param obj The file selector button widget
6000 * @return The icon object that was being used on @p obj or @c
6003 * Unparent and return the icon object which was set for this
6006 * @see elm_fileselector_button_icon_set()
6008 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6011 * Set the title for a given file selector button widget's window
6013 * @param obj The file selector button widget
6014 * @param title The title string
6016 * This will change the window's title, when the file selector pops
6017 * out after a click on the button. Those windows have the default
6018 * (unlocalized) value of @c "Select a file" as titles.
6020 * @note It will only take any effect if the file selector
6021 * button widget is @b not under "inwin mode".
6023 * @see elm_fileselector_button_window_title_get()
6025 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6028 * Get the title set for a given file selector button widget's
6031 * @param obj The file selector button widget
6032 * @return Title of the file selector button's window
6034 * @see elm_fileselector_button_window_title_get() for more details
6036 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6039 * Set the size of a given file selector button widget's window,
6040 * holding the file selector itself.
6042 * @param obj The file selector button widget
6043 * @param width The window's width
6044 * @param height The window's height
6046 * @note it will only take any effect if the file selector button
6047 * widget is @b not under "inwin mode". The default size for the
6048 * window (when applicable) is 400x400 pixels.
6050 * @see elm_fileselector_button_window_size_get()
6052 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6055 * Get the size of a given file selector button widget's window,
6056 * holding the file selector itself.
6058 * @param obj The file selector button widget
6059 * @param width Pointer into which to store the width value
6060 * @param height Pointer into which to store the height value
6062 * @note Use @c NULL pointers on the size values you're not
6063 * interested in: they'll be ignored by the function.
6065 * @see elm_fileselector_button_window_size_set(), for more details
6067 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6070 * Set the initial file system path for a given file selector
6073 * @param obj The file selector button widget
6074 * @param path The path string
6076 * It must be a <b>directory</b> path, which will have the contents
6077 * displayed initially in the file selector's view, when invoked
6078 * from @p obj. The default initial path is the @c "HOME"
6079 * environment variable's value.
6081 * @see elm_fileselector_button_path_get()
6083 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6086 * Get the initial file system path set for a given file selector
6089 * @param obj The file selector button widget
6090 * @return path The path string
6092 * @see elm_fileselector_button_path_set() for more details
6094 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6097 * Enable/disable a tree view in the given file selector button
6098 * widget's internal file selector
6100 * @param obj The file selector button widget
6101 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6104 * This has the same effect as elm_fileselector_expandable_set(),
6105 * but now applied to a file selector button's internal file
6108 * @note There's no way to put a file selector button's internal
6109 * file selector in "grid mode", as one may do with "pure" file
6112 * @see elm_fileselector_expandable_get()
6114 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6117 * Get whether tree view is enabled for the given file selector
6118 * button widget's internal file selector
6120 * @param obj The file selector button widget
6121 * @return @c EINA_TRUE if @p obj widget's internal file selector
6122 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6124 * @see elm_fileselector_expandable_set() for more details
6126 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6129 * Set whether a given file selector button widget's internal file
6130 * selector is to display folders only or the directory contents,
6133 * @param obj The file selector button widget
6134 * @param only @c EINA_TRUE to make @p obj widget's internal file
6135 * selector only display directories, @c EINA_FALSE to make files
6136 * to be displayed in it too
6138 * This has the same effect as elm_fileselector_folder_only_set(),
6139 * but now applied to a file selector button's internal file
6142 * @see elm_fileselector_folder_only_get()
6144 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6147 * Get whether a given file selector button widget's internal file
6148 * selector is displaying folders only or the directory contents,
6151 * @param obj The file selector button widget
6152 * @return @c EINA_TRUE if @p obj widget's internal file
6153 * selector is only displaying directories, @c EINA_FALSE if files
6154 * are being displayed in it too (and on errors)
6156 * @see elm_fileselector_button_folder_only_set() for more details
6158 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6161 * Enable/disable the file name entry box where the user can type
6162 * in a name for a file, in a given file selector button widget's
6163 * internal file selector.
6165 * @param obj The file selector button widget
6166 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6167 * file selector a "saving dialog", @c EINA_FALSE otherwise
6169 * This has the same effect as elm_fileselector_is_save_set(),
6170 * but now applied to a file selector button's internal file
6173 * @see elm_fileselector_is_save_get()
6175 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6178 * Get whether the given file selector button widget's internal
6179 * file selector is in "saving dialog" mode
6181 * @param obj The file selector button widget
6182 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6183 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6186 * @see elm_fileselector_button_is_save_set() for more details
6188 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6191 * Set 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. By default, it won't.
6195 * @param obj The file selector button widget
6196 * @param value @c EINA_TRUE to make it use an inner window, @c
6197 * EINA_TRUE to make it use a dedicated window
6199 * @see elm_win_inwin_add() for more information on inner windows
6200 * @see elm_fileselector_button_inwin_mode_get()
6202 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6205 * Get whether a given file selector button widget's internal file
6206 * selector will raise an Elementary "inner window", instead of a
6207 * dedicated Elementary window.
6209 * @param obj The file selector button widget
6210 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6211 * if it will use a dedicated window
6213 * @see elm_fileselector_button_inwin_mode_set() for more details
6215 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6222 * @defgroup File_Selector_Entry File Selector Entry
6224 * @image html img/widget/fileselector_entry/preview-00.png
6225 * @image latex img/widget/fileselector_entry/preview-00.eps
6227 * This is an entry made to be filled with or display a <b>file
6228 * system path string</b>. Besides the entry itself, the widget has
6229 * a @ref File_Selector_Button "file selector button" on its side,
6230 * which will raise an internal @ref Fileselector "file selector widget",
6231 * when clicked, for path selection aided by file system
6234 * This file selector may appear in an Elementary window or in an
6235 * inner window. When a file is chosen from it, the (inner) window
6236 * is closed and the selected file's path string is exposed both as
6237 * an smart event and as the new text on the entry.
6239 * This widget encapsulates operations on its internal file
6240 * selector on its own API. There is less control over its file
6241 * selector than that one would have instatiating one directly.
6243 * Smart callbacks one can register to:
6244 * - @c "changed" - The text within the entry was changed
6245 * - @c "activated" - The entry has had editing finished and
6246 * changes are to be "committed"
6247 * - @c "press" - The entry has been clicked
6248 * - @c "longpressed" - The entry has been clicked (and held) for a
6250 * - @c "clicked" - The entry has been clicked
6251 * - @c "clicked,double" - The entry has been double clicked
6252 * - @c "focused" - The entry has received focus
6253 * - @c "unfocused" - The entry has lost focus
6254 * - @c "selection,paste" - A paste action has occurred on the
6256 * - @c "selection,copy" - A copy action has occurred on the entry
6257 * - @c "selection,cut" - A cut action has occurred on the entry
6258 * - @c "unpressed" - The file selector entry's button was released
6259 * after being pressed.
6260 * - @c "file,chosen" - The user has selected a path via the file
6261 * selector entry's internal file selector, whose string pointer
6262 * comes as the @c event_info data (a stringshared string)
6264 * Here is an example on its usage:
6265 * @li @ref fileselector_entry_example
6267 * @see @ref File_Selector_Button for a similar widget.
6272 * Add a new file selector entry widget to the given parent
6273 * Elementary (container) object
6275 * @param parent The parent object
6276 * @return a new file selector entry widget handle or @c NULL, on
6279 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6282 * Set the label for a given file selector entry widget's button
6284 * @param obj The file selector entry widget
6285 * @param label The text label to be displayed on @p obj widget's
6288 * @deprecated use elm_object_text_set() instead.
6290 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6293 * Get the label set for a given file selector entry widget's button
6295 * @param obj The file selector entry widget
6296 * @return The widget button's label
6298 * @deprecated use elm_object_text_set() instead.
6300 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6303 * Set the icon on a given file selector entry widget's button
6305 * @param obj The file selector entry widget
6306 * @param icon The icon object for the entry's button
6308 * Once the icon object is set, a previously set one will be
6309 * deleted. If you want to keep the latter, use the
6310 * elm_fileselector_entry_button_icon_unset() function.
6312 * @see elm_fileselector_entry_button_icon_get()
6314 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6317 * Get the icon set for a given file selector entry widget's button
6319 * @param obj The file selector entry widget
6320 * @return The icon object currently set on @p obj widget's button
6321 * or @c NULL, if none is
6323 * @see elm_fileselector_entry_button_icon_set()
6325 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6328 * Unset the icon used in a given file selector entry widget's
6331 * @param obj The file selector entry widget
6332 * @return The icon object that was being used on @p obj widget's
6333 * button or @c NULL, on errors
6335 * Unparent and return the icon object which was set for this
6338 * @see elm_fileselector_entry_button_icon_set()
6340 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6343 * Set the title for a given file selector entry widget's window
6345 * @param obj The file selector entry widget
6346 * @param title The title string
6348 * This will change the window's title, when the file selector pops
6349 * out after a click on the entry's button. Those windows have the
6350 * default (unlocalized) value of @c "Select a file" as titles.
6352 * @note It will only take any effect if the file selector
6353 * entry widget is @b not under "inwin mode".
6355 * @see elm_fileselector_entry_window_title_get()
6357 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6360 * Get the title set for a given file selector entry widget's
6363 * @param obj The file selector entry widget
6364 * @return Title of the file selector entry's window
6366 * @see elm_fileselector_entry_window_title_get() for more details
6368 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6371 * Set the size of a given file selector entry widget's window,
6372 * holding the file selector itself.
6374 * @param obj The file selector entry widget
6375 * @param width The window's width
6376 * @param height The window's height
6378 * @note it will only take any effect if the file selector entry
6379 * widget is @b not under "inwin mode". The default size for the
6380 * window (when applicable) is 400x400 pixels.
6382 * @see elm_fileselector_entry_window_size_get()
6384 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6387 * Get the size of a given file selector entry widget's window,
6388 * holding the file selector itself.
6390 * @param obj The file selector entry widget
6391 * @param width Pointer into which to store the width value
6392 * @param height Pointer into which to store the height value
6394 * @note Use @c NULL pointers on the size values you're not
6395 * interested in: they'll be ignored by the function.
6397 * @see elm_fileselector_entry_window_size_set(), for more details
6399 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6402 * Set the initial file system path and the entry's path string for
6403 * a given file selector entry widget
6405 * @param obj The file selector entry widget
6406 * @param path The path string
6408 * It must be a <b>directory</b> path, which will have the contents
6409 * displayed initially in the file selector's view, when invoked
6410 * from @p obj. The default initial path is the @c "HOME"
6411 * environment variable's value.
6413 * @see elm_fileselector_entry_path_get()
6415 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6418 * Get the entry's path string for a given file selector entry
6421 * @param obj The file selector entry widget
6422 * @return path The path string
6424 * @see elm_fileselector_entry_path_set() for more details
6426 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6429 * Enable/disable a tree view in the given file selector entry
6430 * widget's internal file selector
6432 * @param obj The file selector entry widget
6433 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6436 * This has the same effect as elm_fileselector_expandable_set(),
6437 * but now applied to a file selector entry's internal file
6440 * @note There's no way to put a file selector entry's internal
6441 * file selector in "grid mode", as one may do with "pure" file
6444 * @see elm_fileselector_expandable_get()
6446 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6449 * Get whether tree view is enabled for the given file selector
6450 * entry widget's internal file selector
6452 * @param obj The file selector entry widget
6453 * @return @c EINA_TRUE if @p obj widget's internal file selector
6454 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6456 * @see elm_fileselector_expandable_set() for more details
6458 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6461 * Set whether a given file selector entry widget's internal file
6462 * selector is to display folders only or the directory contents,
6465 * @param obj The file selector entry widget
6466 * @param only @c EINA_TRUE to make @p obj widget's internal file
6467 * selector only display directories, @c EINA_FALSE to make files
6468 * to be displayed in it too
6470 * This has the same effect as elm_fileselector_folder_only_set(),
6471 * but now applied to a file selector entry's internal file
6474 * @see elm_fileselector_folder_only_get()
6476 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6479 * Get whether a given file selector entry widget's internal file
6480 * selector is displaying folders only or the directory contents,
6483 * @param obj The file selector entry widget
6484 * @return @c EINA_TRUE if @p obj widget's internal file
6485 * selector is only displaying directories, @c EINA_FALSE if files
6486 * are being displayed in it too (and on errors)
6488 * @see elm_fileselector_entry_folder_only_set() for more details
6490 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6493 * Enable/disable the file name entry box where the user can type
6494 * in a name for a file, in a given file selector entry widget's
6495 * internal file selector.
6497 * @param obj The file selector entry widget
6498 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6499 * file selector a "saving dialog", @c EINA_FALSE otherwise
6501 * This has the same effect as elm_fileselector_is_save_set(),
6502 * but now applied to a file selector entry's internal file
6505 * @see elm_fileselector_is_save_get()
6507 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6510 * Get whether the given file selector entry widget's internal
6511 * file selector is in "saving dialog" mode
6513 * @param obj The file selector entry widget
6514 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6515 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6518 * @see elm_fileselector_entry_is_save_set() for more details
6520 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6523 * Set 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. By default, it won't.
6527 * @param obj The file selector entry widget
6528 * @param value @c EINA_TRUE to make it use an inner window, @c
6529 * EINA_TRUE to make it use a dedicated window
6531 * @see elm_win_inwin_add() for more information on inner windows
6532 * @see elm_fileselector_entry_inwin_mode_get()
6534 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6537 * Get whether a given file selector entry widget's internal file
6538 * selector will raise an Elementary "inner window", instead of a
6539 * dedicated Elementary window.
6541 * @param obj The file selector entry widget
6542 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6543 * if it will use a dedicated window
6545 * @see elm_fileselector_entry_inwin_mode_set() for more details
6547 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6550 * Set the initial file system path for a given file selector entry
6553 * @param obj The file selector entry widget
6554 * @param path The path string
6556 * It must be a <b>directory</b> path, which will have the contents
6557 * displayed initially in the file selector's view, when invoked
6558 * from @p obj. The default initial path is the @c "HOME"
6559 * environment variable's value.
6561 * @see elm_fileselector_entry_path_get()
6563 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6566 * Get the parent directory's path to the latest file selection on
6567 * a given filer selector entry widget
6569 * @param obj The file selector object
6570 * @return The (full) path of the directory of the last selection
6571 * on @p obj widget, a @b stringshared string
6573 * @see elm_fileselector_entry_path_set()
6575 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6582 * @defgroup Scroller Scroller
6584 * A scroller holds a single object and "scrolls it around". This means that
6585 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6586 * region around, allowing to move through a much larger object that is
6587 * contained in the scroller. The scroiller will always have a small minimum
6588 * size by default as it won't be limited by the contents of the scroller.
6590 * Signals that you can add callbacks for are:
6591 * @li "edge,left" - the left edge of the content has been reached
6592 * @li "edge,right" - the right edge of the content has been reached
6593 * @li "edge,top" - the top edge of the content has been reached
6594 * @li "edge,bottom" - the bottom edge of the content has been reached
6595 * @li "scroll" - the content has been scrolled (moved)
6596 * @li "scroll,anim,start" - scrolling animation has started
6597 * @li "scroll,anim,stop" - scrolling animation has stopped
6598 * @li "scroll,drag,start" - dragging the contents around has started
6599 * @li "scroll,drag,stop" - dragging the contents around has stopped
6600 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6603 * @note When Elemementary is in embedded mode the scrollbars will not be
6604 * dragable, they appear merely as indicators of how much has been scrolled.
6605 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6606 * fingerscroll) won't work.
6608 * In @ref tutorial_scroller you'll find an example of how to use most of
6613 * @brief Type that controls when scrollbars should appear.
6615 * @see elm_scroller_policy_set()
6617 typedef enum _Elm_Scroller_Policy
6619 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6620 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6621 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6622 ELM_SCROLLER_POLICY_LAST
6623 } Elm_Scroller_Policy;
6625 * @brief Add a new scroller to the parent
6627 * @param parent The parent object
6628 * @return The new object or NULL if it cannot be created
6630 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6632 * @brief Set the content of the scroller widget (the object to be scrolled around).
6634 * @param obj The scroller object
6635 * @param content The new content object
6637 * Once the content object is set, a previously set one will be deleted.
6638 * If you want to keep that old content object, use the
6639 * elm_scroller_content_unset() function.
6641 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6643 * @brief Get the content of the scroller widget
6645 * @param obj The slider object
6646 * @return The content that is being used
6648 * Return the content object which is set for this widget
6650 * @see elm_scroller_content_set()
6652 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6654 * @brief Unset the content of the scroller widget
6656 * @param obj The slider object
6657 * @return The content that was being used
6659 * Unparent and return the content object which was set for this widget
6661 * @see elm_scroller_content_set()
6663 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6665 * @brief Set custom theme elements for the scroller
6667 * @param obj The scroller object
6668 * @param widget The widget name to use (default is "scroller")
6669 * @param base The base name to use (default is "base")
6671 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6673 * @brief Make the scroller minimum size limited to the minimum size of the content
6675 * @param obj The scroller object
6676 * @param w Enable limiting minimum size horizontally
6677 * @param h Enable limiting minimum size vertically
6679 * By default the scroller will be as small as its design allows,
6680 * irrespective of its content. This will make the scroller minimum size the
6681 * right size horizontally and/or vertically to perfectly fit its content in
6684 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6686 * @brief Show a specific virtual region within the scroller content object
6688 * @param obj The scroller object
6689 * @param x X coordinate of the region
6690 * @param y Y coordinate of the region
6691 * @param w Width of the region
6692 * @param h Height of the region
6694 * This will ensure all (or part if it does not fit) of the designated
6695 * region in the virtual content object (0, 0 starting at the top-left of the
6696 * virtual content object) is shown within the scroller.
6698 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);
6700 * @brief Set the scrollbar visibility policy
6702 * @param obj The scroller object
6703 * @param policy_h Horizontal scrollbar policy
6704 * @param policy_v Vertical scrollbar policy
6706 * This sets the scrollbar visibility policy for the given scroller.
6707 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6708 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6709 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6710 * respectively for the horizontal and vertical scrollbars.
6712 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6714 * @brief Gets scrollbar visibility policy
6716 * @param obj The scroller object
6717 * @param policy_h Horizontal scrollbar policy
6718 * @param policy_v Vertical scrollbar policy
6720 * @see elm_scroller_policy_set()
6722 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6724 * @brief Get the currently visible content region
6726 * @param obj The scroller object
6727 * @param x X coordinate of the region
6728 * @param y Y coordinate of the region
6729 * @param w Width of the region
6730 * @param h Height of the region
6732 * This gets the current region in the content object that is visible through
6733 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6734 * w, @p h values pointed to.
6736 * @note All coordinates are relative to the content.
6738 * @see elm_scroller_region_show()
6740 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);
6742 * @brief Get the size of the content object
6744 * @param obj The scroller object
6745 * @param w Width return
6746 * @param h Height return
6748 * This gets the size of the content object of the scroller.
6750 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6752 * @brief Set bouncing behavior
6754 * @param obj The scroller object
6755 * @param h_bounce Will the scroller bounce horizontally or not
6756 * @param v_bounce Will the scroller bounce vertically or not
6758 * When scrolling, the scroller may "bounce" when reaching an edge of the
6759 * content object. This is a visual way to indicate the end has been reached.
6760 * This is enabled by default for both axis. This will set if it is enabled
6761 * for that axis with the boolean parameters for each axis.
6763 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6765 * @brief Get the bounce mode
6767 * @param obj The Scroller object
6768 * @param h_bounce Allow bounce horizontally
6769 * @param v_bounce Allow bounce vertically
6771 * @see elm_scroller_bounce_set()
6773 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6775 * @brief Set scroll page size relative to viewport size.
6777 * @param obj The scroller object
6778 * @param h_pagerel The horizontal page relative size
6779 * @param v_pagerel The vertical page relative size
6781 * The scroller is capable of limiting scrolling by the user to "pages". That
6782 * is to jump by and only show a "whole page" at a time as if the continuous
6783 * area of the scroller content is split into page sized pieces. This sets
6784 * the size of a page relative to the viewport of the scroller. 1.0 is "1
6785 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6786 * axis. This is mutually exclusive with page size
6787 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
6788 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6789 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6792 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6794 * @brief Set scroll page size.
6796 * @param obj The scroller object
6797 * @param h_pagesize The horizontal page size
6798 * @param v_pagesize The vertical page size
6800 * This sets the page size to an absolute fixed value, with 0 turning it off
6803 * @see elm_scroller_page_relative_set()
6805 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6807 * @brief Show a specific virtual region within the scroller content object.
6809 * @param obj The scroller object
6810 * @param x X coordinate of the region
6811 * @param y Y coordinate of the region
6812 * @param w Width of the region
6813 * @param h Height of the region
6815 * This will ensure all (or part if it does not fit) of the designated
6816 * region in the virtual content object (0, 0 starting at the top-left of the
6817 * virtual content object) is shown within the scroller. Unlike
6818 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
6819 * to this location (if configuration in general calls for transitions). It
6820 * may not jump immediately to the new location and make take a while and
6821 * show other content along the way.
6823 * @see elm_scroller_region_show()
6825 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);
6827 * @brief Set event propagation on a scroller
6829 * @param obj The scroller object
6830 * @param propagation If propagation is enabled or not
6832 * This enables or disabled event propagation from the scroller content to
6833 * the scroller and its parent. By default event propagation is disabled.
6835 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
6837 * @brief Get event propagation for a scroller
6839 * @param obj The scroller object
6840 * @return The propagation state
6842 * This gets the event propagation for a scroller.
6844 * @see elm_scroller_propagate_events_set()
6846 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
6852 * @defgroup Label Label
6854 * @image html img/widget/label/preview-00.png
6855 * @image latex img/widget/label/preview-00.eps
6857 * @brief Widget to display text, with simple html-like markup.
6859 * The Label widget @b doesn't allow text to overflow its boundaries, if the
6860 * text doesn't fit the geometry of the label it will be ellipsized or be
6861 * cut. Elementary provides several themes for this widget:
6862 * @li default - No animation
6863 * @li marker - Centers the text in the label and make it bold by default
6864 * @li slide_long - The entire text appears from the right of the screen and
6865 * slides until it disappears in the left of the screen(reappering on the
6867 * @li slide_short - The text appears in the left of the label and slides to
6868 * the right to show the overflow. When all of the text has been shown the
6869 * position is reset.
6870 * @li slide_bounce - The text appears in the left of the label and slides to
6871 * the right to show the overflow. When all of the text has been shown the
6872 * animation reverses, moving the text to the left.
6874 * Custom themes can of course invent new markup tags and style them any way
6877 * See @ref tutorial_label for a demonstration of how to use a label widget.
6881 * @brief Add a new label to the parent
6883 * @param parent The parent object
6884 * @return The new object or NULL if it cannot be created
6886 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6888 * @brief Set the label on the label object
6890 * @param obj The label object
6891 * @param label The label will be used on the label object
6892 * @deprecated See elm_object_text_set()
6894 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 */
6896 * @brief Get the label used on the label object
6898 * @param obj The label object
6899 * @return The string inside the label
6900 * @deprecated See elm_object_text_get()
6902 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
6904 * @brief Set the wrapping behavior of the label
6906 * @param obj The label object
6907 * @param wrap To wrap text or not
6909 * By default no wrapping is done. Possible values for @p wrap are:
6910 * @li ELM_WRAP_NONE - No wrapping
6911 * @li ELM_WRAP_CHAR - wrap between characters
6912 * @li ELM_WRAP_WORD - wrap between words
6913 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
6915 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6917 * @brief Get the wrapping behavior of the label
6919 * @param obj The label object
6922 * @see elm_label_line_wrap_set()
6924 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6926 * @brief Set wrap width of the label
6928 * @param obj The label object
6929 * @param w The wrap width in pixels at a minimum where words need to wrap
6931 * This function sets the maximum width size hint of the label.
6933 * @warning This is only relevant if the label is inside a container.
6935 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
6937 * @brief Get wrap width of the label
6939 * @param obj The label object
6940 * @return The wrap width in pixels at a minimum where words need to wrap
6942 * @see elm_label_wrap_width_set()
6944 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6946 * @brief Set wrap height of the label
6948 * @param obj The label object
6949 * @param h The wrap height in pixels at a minimum where words need to wrap
6951 * This function sets the maximum height size hint of the label.
6953 * @warning This is only relevant if the label is inside a container.
6955 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
6957 * @brief get wrap width of the label
6959 * @param obj The label object
6960 * @return The wrap height in pixels at a minimum where words need to wrap
6962 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6964 * @brief Set the font size on the label object.
6966 * @param obj The label object
6967 * @param size font size
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_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
6975 * @brief Set the text color on the label object
6977 * @param obj The label object
6978 * @param r Red property background color of The label object
6979 * @param g Green property background color of The label object
6980 * @param b Blue property background color of The label object
6981 * @param a Alpha property background color of The label object
6983 * @warning NEVER use this. It is for hyper-special cases only. use styles
6984 * instead. e.g. "big", "medium", "small" - or better name them by use:
6985 * "title", "footnote", "quote" etc.
6987 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);
6989 * @brief Set the text align on the label object
6991 * @param obj The label object
6992 * @param align align mode ("left", "center", "right")
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_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7000 * @brief Set background color of the label
7002 * @param obj The label object
7003 * @param r Red property background color of The label object
7004 * @param g Green property background color of The label object
7005 * @param b Blue property background color of The label object
7006 * @param a Alpha property background alpha of The label object
7008 * @warning NEVER use this. It is for hyper-special cases only. use styles
7009 * instead. e.g. "big", "medium", "small" - or better name them by use:
7010 * "title", "footnote", "quote" etc.
7012 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);
7014 * @brief Set the ellipsis behavior of the label
7016 * @param obj The label object
7017 * @param ellipsis To ellipsis text or not
7019 * If set to true and the text doesn't fit in the label an ellipsis("...")
7020 * will be shown at the end of the widget.
7022 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7023 * choosen wrap method was ELM_WRAP_WORD.
7025 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7027 * @brief Set the text slide of the label
7029 * @param obj The label object
7030 * @param slide To start slide or stop
7032 * If set to true the text of the label will slide throught the length of
7035 * @warning This only work with the themes "slide_short", "slide_long" and
7038 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7040 * @brief Get the text slide mode of the label
7042 * @param obj The label object
7043 * @return slide slide mode value
7045 * @see elm_label_slide_set()
7047 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7049 * @brief Set the slide duration(speed) of the label
7051 * @param obj The label object
7052 * @return The duration in seconds in moving text from slide begin position
7053 * to slide end position
7055 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7057 * @brief Get the slide duration(speed) of the label
7059 * @param obj The label object
7060 * @return The duration time in moving text from slide begin position to slide end position
7062 * @see elm_label_slide_duration_set()
7064 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7070 * @defgroup Toggle Toggle
7072 * @image html img/widget/toggle/preview-00.png
7073 * @image latex img/widget/toggle/preview-00.eps
7075 * @brief A toggle is a slider which can be used to toggle between
7076 * two values. It has two states: on and off.
7078 * Signals that you can add callbacks for are:
7079 * @li "changed" - Whenever the toggle value has been changed. Is not called
7080 * until the toggle is released by the cursor (assuming it
7081 * has been triggered by the cursor in the first place).
7083 * @ref tutorial_toggle show how to use a toggle.
7087 * @brief Add a toggle to @p parent.
7089 * @param parent The parent object
7091 * @return The toggle object
7093 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7095 * @brief Sets the label to be displayed with the toggle.
7097 * @param obj The toggle object
7098 * @param label The label to be displayed
7100 * @deprecated use elm_object_text_set() instead.
7102 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7104 * @brief Gets the label of the toggle
7106 * @param obj toggle object
7107 * @return The label of the toggle
7109 * @deprecated use elm_object_text_get() instead.
7111 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7113 * @brief Set the icon used for the toggle
7115 * @param obj The toggle object
7116 * @param icon The icon object for the button
7118 * Once the icon object is set, a previously set one will be deleted
7119 * If you want to keep that old content object, use the
7120 * elm_toggle_icon_unset() function.
7122 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7124 * @brief Get the icon used for the toggle
7126 * @param obj The toggle object
7127 * @return The icon object that is being used
7129 * Return the icon object which is set for this widget.
7131 * @see elm_toggle_icon_set()
7133 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7135 * @brief Unset the icon used for the toggle
7137 * @param obj The toggle object
7138 * @return The icon object that was being used
7140 * Unparent and return the icon object which was set for this widget.
7142 * @see elm_toggle_icon_set()
7144 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7146 * @brief Sets the labels to be associated with the on and off states of the toggle.
7148 * @param obj The toggle object
7149 * @param onlabel The label displayed when the toggle is in the "on" state
7150 * @param offlabel The label displayed when the toggle is in the "off" state
7152 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7154 * @brief Gets the labels associated with the on and off states of the toggle.
7156 * @param obj The toggle object
7157 * @param onlabel A char** to place the onlabel of @p obj into
7158 * @param offlabel A char** to place the offlabel of @p obj into
7160 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7162 * @brief Sets the state of the toggle to @p state.
7164 * @param obj The toggle object
7165 * @param state The state of @p obj
7167 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7169 * @brief Gets the state of the toggle to @p state.
7171 * @param obj The toggle object
7172 * @return The state of @p obj
7174 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7176 * @brief Sets the state pointer of the toggle to @p statep.
7178 * @param obj The toggle object
7179 * @param statep The state pointer of @p obj
7181 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7187 * @defgroup Frame Frame
7189 * @image html img/widget/frame/preview-00.png
7190 * @image latex img/widget/frame/preview-00.eps
7192 * @brief Frame is a widget that holds some content and has a title.
7194 * The default look is a frame with a title, but Frame supports multple
7202 * @li outdent_bottom
7204 * Of all this styles only default shows the title. Frame emits no signals.
7206 * For a detailed example see the @ref tutorial_frame.
7211 * @brief Add a new frame to the parent
7213 * @param parent The parent object
7214 * @return The new object or NULL if it cannot be created
7216 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7218 * @brief Set the frame label
7220 * @param obj The frame object
7221 * @param label The label of this frame object
7223 * @deprecated use elm_object_text_set() instead.
7225 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7227 * @brief Get the frame label
7229 * @param obj The frame object
7231 * @return The label of this frame objet or NULL if unable to get frame
7233 * @deprecated use elm_object_text_get() instead.
7235 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7237 * @brief Set the content of the frame widget
7239 * Once the content object is set, a previously set one will be deleted.
7240 * If you want to keep that old content object, use the
7241 * elm_frame_content_unset() function.
7243 * @param obj The frame object
7244 * @param content The content will be filled in this frame object
7246 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7248 * @brief Get the content of the frame widget
7250 * Return the content object which is set for this widget
7252 * @param obj The frame object
7253 * @return The content that is being used
7255 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7257 * @brief Unset the content of the frame widget
7259 * Unparent and return the content object which was set for this widget
7261 * @param obj The frame object
7262 * @return The content that was being used
7264 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7270 * @defgroup Table Table
7272 * A container widget to arrange other widgets in a table where items can
7273 * also span multiple columns or rows - even overlap (and then be raised or
7274 * lowered accordingly to adjust stacking if they do overlap).
7276 * The followin are examples of how to use a table:
7277 * @li @ref tutorial_table_01
7278 * @li @ref tutorial_table_02
7283 * @brief Add a new table to the parent
7285 * @param parent The parent object
7286 * @return The new object or NULL if it cannot be created
7288 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7290 * @brief Set the homogeneous layout in the table
7292 * @param obj The layout object
7293 * @param homogeneous A boolean to set if the layout is homogeneous in the
7294 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7296 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7298 * @brief Get the current table homogeneous mode.
7300 * @param obj The table object
7301 * @return A boolean to indicating if the layout is homogeneous in the table
7302 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7304 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7306 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7308 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7310 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7312 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7314 * @brief Set padding between cells.
7316 * @param obj The layout object.
7317 * @param horizontal set the horizontal padding.
7318 * @param vertical set the vertical padding.
7320 * Default value is 0.
7322 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7324 * @brief Get padding between cells.
7326 * @param obj The layout object.
7327 * @param horizontal set the horizontal padding.
7328 * @param vertical set the vertical padding.
7330 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7332 * @brief Add a subobject on the table with the coordinates passed
7334 * @param obj The table object
7335 * @param subobj The subobject to be added to the table
7336 * @param x Row number
7337 * @param y Column number
7341 * @note All positioning inside the table is relative to rows and columns, so
7342 * a value of 0 for x and y, means the top left cell of the table, and a
7343 * value of 1 for w and h means @p subobj only takes that 1 cell.
7345 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7347 * @brief Remove child from table.
7349 * @param obj The table object
7350 * @param subobj The subobject
7352 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7354 * @brief Faster way to remove all child objects from a table object.
7356 * @param obj The table object
7357 * @param clear If true, will delete children, else just remove from table.
7359 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7361 * @brief Set the packing location of an existing child of the table
7363 * @param subobj The subobject to be modified in the table
7364 * @param x Row number
7365 * @param y Column number
7369 * Modifies the position of an object already in the table.
7371 * @note All positioning inside the table is relative to rows and columns, so
7372 * a value of 0 for x and y, means the top left cell of the table, and a
7373 * value of 1 for w and h means @p subobj only takes that 1 cell.
7375 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7377 * @brief Get the packing location of an existing child of the table
7379 * @param subobj The subobject to be modified in the table
7380 * @param x Row number
7381 * @param y Column number
7385 * @see elm_table_pack_set()
7387 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7393 * @defgroup Gengrid Gengrid (Generic grid)
7395 * This widget aims to position objects in a grid layout while
7396 * actually creating and rendering only the visible ones, using the
7397 * same idea as the @ref Genlist "genlist": the user defines a @b
7398 * class for each item, specifying functions that will be called at
7399 * object creation, deletion, etc. When those items are selected by
7400 * the user, a callback function is issued. Users may interact with
7401 * a gengrid via the mouse (by clicking on items to select them and
7402 * clicking on the grid's viewport and swiping to pan the whole
7403 * view) or via the keyboard, navigating through item with the
7406 * @section Gengrid_Layouts Gengrid layouts
7408 * Gengrids may layout its items in one of two possible layouts:
7412 * When in "horizontal mode", items will be placed in @b columns,
7413 * from top to bottom and, when the space for a column is filled,
7414 * another one is started on the right, thus expanding the grid
7415 * horizontally, making for horizontal scrolling. When in "vertical
7416 * mode" , though, items will be placed in @b rows, from left to
7417 * right and, when the space for a row is filled, another one is
7418 * started below, thus expanding the grid vertically (and making
7419 * for vertical scrolling).
7421 * @section Gengrid_Items Gengrid items
7423 * An item in a gengrid can have 0 or more text labels (they can be
7424 * regular text or textblock Evas objects - that's up to the style
7425 * to determine), 0 or more icons (which are simply objects
7426 * swallowed into the gengrid item's theming Edje object) and 0 or
7427 * more <b>boolean states</b>, which have the behavior left to the
7428 * user to define. The Edje part names for each of these properties
7429 * will be looked up, in the theme file for the gengrid, under the
7430 * Edje (string) data items named @c "labels", @c "icons" and @c
7431 * "states", respectively. For each of those properties, if more
7432 * than one part is provided, they must have names listed separated
7433 * by spaces in the data fields. For the default gengrid item
7434 * theme, we have @b one label part (@c "elm.text"), @b two icon
7435 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7438 * A gengrid item may be at one of several styles. Elementary
7439 * provides one by default - "default", but this can be extended by
7440 * system or application custom themes/overlays/extensions (see
7441 * @ref Theme "themes" for more details).
7443 * @section Gengrid_Item_Class Gengrid item classes
7445 * In order to have the ability to add and delete items on the fly,
7446 * gengrid implements a class (callback) system where the
7447 * application provides a structure with information about that
7448 * type of item (gengrid may contain multiple different items with
7449 * different classes, states and styles). Gengrid will call the
7450 * functions in this struct (methods) when an item is "realized"
7451 * (i.e., created dynamically, while the user is scrolling the
7452 * grid). All objects will simply be deleted when no longer needed
7453 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7454 * contains the following members:
7455 * - @c item_style - This is a constant string and simply defines
7456 * the name of the item style. It @b must be specified and the
7457 * default should be @c "default".
7458 * - @c func.label_get - This function is called when an item
7459 * object is actually created. The @c data parameter will point to
7460 * the same data passed to elm_gengrid_item_append() and related
7461 * item creation functions. The @c obj parameter is the gengrid
7462 * object itself, while the @c part one is the name string of one
7463 * of the existing text parts in the Edje group implementing the
7464 * item's theme. This function @b must return a strdup'()ed string,
7465 * as the caller will free() it when done. See
7466 * #Elm_Gengrid_Item_Label_Get_Cb.
7467 * - @c func.icon_get - This function is called when an item object
7468 * is actually created. The @c data parameter will point to the
7469 * same data passed to elm_gengrid_item_append() and related item
7470 * creation functions. The @c obj parameter is the gengrid object
7471 * itself, while the @c part one is the name string of one of the
7472 * existing (icon) swallow parts in the Edje group implementing the
7473 * item's theme. It must return @c NULL, when no icon is desired,
7474 * or a valid object handle, otherwise. The object will be deleted
7475 * by the gengrid on its deletion or when the item is "unrealized".
7476 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7477 * - @c func.state_get - This function is called when an item
7478 * object is actually created. The @c data parameter will point to
7479 * the same data passed to elm_gengrid_item_append() and related
7480 * item creation functions. The @c obj parameter is the gengrid
7481 * object itself, while the @c part one is the name string of one
7482 * of the state parts in the Edje group implementing the item's
7483 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7484 * true/on. Gengrids will emit a signal to its theming Edje object
7485 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7486 * "source" arguments, respectively, when the state is true (the
7487 * default is false), where @c XXX is the name of the (state) part.
7488 * See #Elm_Gengrid_Item_State_Get_Cb.
7489 * - @c func.del - This is called when elm_gengrid_item_del() is
7490 * called on an item or elm_gengrid_clear() is called on the
7491 * gengrid. This is intended for use when gengrid items are
7492 * deleted, so any data attached to the item (e.g. its data
7493 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7495 * @section Gengrid_Usage_Hints Usage hints
7497 * If the user wants to have multiple items selected at the same
7498 * time, elm_gengrid_multi_select_set() will permit it. If the
7499 * gengrid is single-selection only (the default), then
7500 * elm_gengrid_select_item_get() will return the selected item or
7501 * @c NULL, if none is selected. If the gengrid is under
7502 * multi-selection, then elm_gengrid_selected_items_get() will
7503 * return a list (that is only valid as long as no items are
7504 * modified (added, deleted, selected or unselected) of child items
7507 * If an item changes (internal (boolean) state, label or icon
7508 * changes), then use elm_gengrid_item_update() to have gengrid
7509 * update the item with the new state. A gengrid will re-"realize"
7510 * the item, thus calling the functions in the
7511 * #Elm_Gengrid_Item_Class set for that item.
7513 * To programmatically (un)select an item, use
7514 * elm_gengrid_item_selected_set(). To get its selected state use
7515 * elm_gengrid_item_selected_get(). To make an item disabled
7516 * (unable to be selected and appear differently) use
7517 * elm_gengrid_item_disabled_set() to set this and
7518 * elm_gengrid_item_disabled_get() to get the disabled state.
7520 * Grid cells will only have their selection smart callbacks called
7521 * when firstly getting selected. Any further clicks will do
7522 * nothing, unless you enable the "always select mode", with
7523 * elm_gengrid_always_select_mode_set(), thus making every click to
7524 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7525 * turn off the ability to select items entirely in the widget and
7526 * they will neither appear selected nor call the selection smart
7529 * Remember that you can create new styles and add your own theme
7530 * augmentation per application with elm_theme_extension_add(). If
7531 * you absolutely must have a specific style that overrides any
7532 * theme the user or system sets up you can use
7533 * elm_theme_overlay_add() to add such a file.
7535 * @section Gengrid_Smart_Events Gengrid smart events
7537 * Smart events that you can add callbacks for are:
7538 * - @c "activated" - The user has double-clicked or pressed
7539 * (enter|return|spacebar) on an item. The @c event_info parameter
7540 * is the gengrid item that was activated.
7541 * - @c "clicked,double" - The user has double-clicked an item.
7542 * The @c event_info parameter is the gengrid item that was double-clicked.
7543 * - @c "selected" - The user has made an item selected. The
7544 * @c event_info parameter is the gengrid item that was selected.
7545 * - @c "unselected" - The user has made an item unselected. The
7546 * @c event_info parameter is the gengrid item that was unselected.
7547 * - @c "realized" - This is called when the item in the gengrid
7548 * has its implementing Evas object instantiated, de facto. @c
7549 * event_info is the gengrid item that was created. The object
7550 * may be deleted at any time, so it is highly advised to the
7551 * caller @b not to use the object pointer returned from
7552 * elm_gengrid_item_object_get(), because it may point to freed
7554 * - @c "unrealized" - This is called when the implementing Evas
7555 * object for this item is deleted. @c event_info is the gengrid
7556 * item that was deleted.
7557 * - @c "changed" - Called when an item is added, removed, resized
7558 * or moved and when the gengrid is resized or gets "horizontal"
7560 * - @c "drag,start,up" - Called when the item in the gengrid has
7561 * been dragged (not scrolled) up.
7562 * - @c "drag,start,down" - Called when the item in the gengrid has
7563 * been dragged (not scrolled) down.
7564 * - @c "drag,start,left" - Called when the item in the gengrid has
7565 * been dragged (not scrolled) left.
7566 * - @c "drag,start,right" - Called when the item in the gengrid has
7567 * been dragged (not scrolled) right.
7568 * - @c "drag,stop" - Called when the item in the gengrid has
7569 * stopped being dragged.
7570 * - @c "drag" - Called when the item in the gengrid is being
7572 * - @c "scroll" - called when the content has been scrolled
7574 * - @c "scroll,drag,start" - called when dragging the content has
7576 * - @c "scroll,drag,stop" - called when dragging the content has
7579 * List of gendrid examples:
7580 * @li @ref gengrid_example
7584 * @addtogroup Gengrid
7588 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7589 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7590 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7591 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7592 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. */
7593 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. */
7594 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7596 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7597 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7598 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7599 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7602 * @struct _Elm_Gengrid_Item_Class
7604 * Gengrid item class definition. See @ref Gengrid_Item_Class for
7607 struct _Elm_Gengrid_Item_Class
7609 const char *item_style;
7610 struct _Elm_Gengrid_Item_Class_Func
7612 Elm_Gengrid_Item_Label_Get_Cb label_get;
7613 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
7614 Elm_Gengrid_Item_State_Get_Cb state_get;
7615 Elm_Gengrid_Item_Del_Cb del;
7617 }; /**< #Elm_Gengrid_Item_Class member definitions */
7620 * Add a new gengrid widget to the given parent Elementary
7621 * (container) object
7623 * @param parent The parent object
7624 * @return a new gengrid widget handle or @c NULL, on errors
7626 * This function inserts a new gengrid widget on the canvas.
7628 * @see elm_gengrid_item_size_set()
7629 * @see elm_gengrid_horizontal_set()
7630 * @see elm_gengrid_item_append()
7631 * @see elm_gengrid_item_del()
7632 * @see elm_gengrid_clear()
7636 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7639 * Set the size for the items of a given gengrid widget
7641 * @param obj The gengrid object.
7642 * @param w The items' width.
7643 * @param h The items' height;
7645 * A gengrid, after creation, has still no information on the size
7646 * to give to each of its cells. So, you most probably will end up
7647 * with squares one @ref Fingers "finger" wide, the default
7648 * size. Use this function to force a custom size for you items,
7649 * making them as big as you wish.
7651 * @see elm_gengrid_item_size_get()
7655 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7658 * Get the size set for the items of a given gengrid widget
7660 * @param obj The gengrid object.
7661 * @param w Pointer to a variable where to store the items' width.
7662 * @param h Pointer to a variable where to store the items' height.
7664 * @note Use @c NULL pointers on the size values you're not
7665 * interested in: they'll be ignored by the function.
7667 * @see elm_gengrid_item_size_get() for more details
7671 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7674 * Set the items grid's alignment within a given gengrid widget
7676 * @param obj The gengrid object.
7677 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7678 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7680 * This sets the alignment of the whole grid of items of a gengrid
7681 * within its given viewport. By default, those values are both
7682 * 0.5, meaning that the gengrid will have its items grid placed
7683 * exactly in the middle of its viewport.
7685 * @note If given alignment values are out of the cited ranges,
7686 * they'll be changed to the nearest boundary values on the valid
7689 * @see elm_gengrid_align_get()
7693 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7696 * Get the items grid's alignment values within a given gengrid
7699 * @param obj The gengrid object.
7700 * @param align_x Pointer to a variable where to store the
7701 * horizontal alignment.
7702 * @param align_y Pointer to a variable where to store the vertical
7705 * @note Use @c NULL pointers on the alignment values you're not
7706 * interested in: they'll be ignored by the function.
7708 * @see elm_gengrid_align_set() for more details
7712 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7715 * Set whether a given gengrid widget is or not able have items
7718 * @param obj The gengrid object
7719 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7720 * @c EINA_FALSE to turn it off
7722 * If a gengrid is set to allow reordering, a click held for more
7723 * than 0.5 over a given item will highlight it specially,
7724 * signalling the gengrid has entered the reordering state. From
7725 * that time on, the user will be able to, while still holding the
7726 * mouse button down, move the item freely in the gengrid's
7727 * viewport, replacing to said item to the locations it goes to.
7728 * The replacements will be animated and, whenever the user
7729 * releases the mouse button, the item being replaced gets a new
7730 * definitive place in the grid.
7732 * @see elm_gengrid_reorder_mode_get()
7736 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7739 * Get whether a given gengrid widget is or not able have items
7742 * @param obj The gengrid object
7743 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7746 * @see elm_gengrid_reorder_mode_set() for more details
7750 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7753 * Append a new item in a given gengrid widget.
7755 * @param obj The gengrid object.
7756 * @param gic The item class for the item.
7757 * @param data The item data.
7758 * @param func Convenience function called when the item is
7760 * @param func_data Data to be passed to @p func.
7761 * @return A handle to the item added or @c NULL, on errors.
7763 * This adds an item to the beginning of the gengrid.
7765 * @see elm_gengrid_item_prepend()
7766 * @see elm_gengrid_item_insert_before()
7767 * @see elm_gengrid_item_insert_after()
7768 * @see elm_gengrid_item_del()
7772 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);
7775 * Prepend a new item in a given gengrid widget.
7777 * @param obj The gengrid object.
7778 * @param gic The item class for the item.
7779 * @param data The item data.
7780 * @param func Convenience function called when the item is
7782 * @param func_data Data to be passed to @p func.
7783 * @return A handle to the item added or @c NULL, on errors.
7785 * This adds an item to the end of the gengrid.
7787 * @see elm_gengrid_item_append()
7788 * @see elm_gengrid_item_insert_before()
7789 * @see elm_gengrid_item_insert_after()
7790 * @see elm_gengrid_item_del()
7794 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);
7797 * Insert an item before another in a gengrid widget
7799 * @param obj The gengrid object.
7800 * @param gic The item class for the item.
7801 * @param data The item data.
7802 * @param relative The item to place this new one before.
7803 * @param func Convenience function called when the item is
7805 * @param func_data Data to be passed to @p func.
7806 * @return A handle to the item added or @c NULL, on errors.
7808 * This inserts an item before another in the gengrid.
7810 * @see elm_gengrid_item_append()
7811 * @see elm_gengrid_item_prepend()
7812 * @see elm_gengrid_item_insert_after()
7813 * @see elm_gengrid_item_del()
7817 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);
7820 * Insert an item after another in a gengrid widget
7822 * @param obj The gengrid object.
7823 * @param gic The item class for the item.
7824 * @param data The item data.
7825 * @param relative The item to place this new one after.
7826 * @param func Convenience function called when the item is
7828 * @param func_data Data to be passed to @p func.
7829 * @return A handle to the item added or @c NULL, on errors.
7831 * This inserts an item after another in the gengrid.
7833 * @see elm_gengrid_item_append()
7834 * @see elm_gengrid_item_prepend()
7835 * @see elm_gengrid_item_insert_after()
7836 * @see elm_gengrid_item_del()
7840 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);
7842 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);
7844 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);
7847 * Set whether items on a given gengrid widget are to get their
7848 * selection callbacks issued for @b every subsequent selection
7849 * click on them or just for the first click.
7851 * @param obj The gengrid object
7852 * @param always_select @c EINA_TRUE to make items "always
7853 * selected", @c EINA_FALSE, otherwise
7855 * By default, grid items will only call their selection callback
7856 * function when firstly getting selected, any subsequent further
7857 * clicks will do nothing. With this call, you make those
7858 * subsequent clicks also to issue the selection callbacks.
7860 * @note <b>Double clicks</b> will @b always be reported on items.
7862 * @see elm_gengrid_always_select_mode_get()
7866 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7869 * Get whether items on a given gengrid widget have their selection
7870 * callbacks issued for @b every subsequent selection click on them
7871 * or just for the first click.
7873 * @param obj The gengrid object.
7874 * @return @c EINA_TRUE if the gengrid items are "always selected",
7875 * @c EINA_FALSE, otherwise
7877 * @see elm_gengrid_always_select_mode_set() for more details
7881 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7884 * Set whether items on a given gengrid widget can be selected or not.
7886 * @param obj The gengrid object
7887 * @param no_select @c EINA_TRUE to make items selectable,
7888 * @c EINA_FALSE otherwise
7890 * This will make items in @p obj selectable or not. In the latter
7891 * case, any user interacion on the gendrid items will neither make
7892 * them appear selected nor them call their selection callback
7895 * @see elm_gengrid_no_select_mode_get()
7899 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
7902 * Get whether items on a given gengrid widget can be selected or
7905 * @param obj The gengrid object
7906 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
7909 * @see elm_gengrid_no_select_mode_set() for more details
7913 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7916 * Enable or disable multi-selection in a given gengrid widget
7918 * @param obj The gengrid object.
7919 * @param multi @c EINA_TRUE, to enable multi-selection,
7920 * @c EINA_FALSE to disable it.
7922 * Multi-selection is the ability for one to have @b more than one
7923 * item selected, on a given gengrid, simultaneously. When it is
7924 * enabled, a sequence of clicks on different items will make them
7925 * all selected, progressively. A click on an already selected item
7926 * will unselect it. If interecting via the keyboard,
7927 * multi-selection is enabled while holding the "Shift" key.
7929 * @note By default, multi-selection is @b disabled on gengrids
7931 * @see elm_gengrid_multi_select_get()
7935 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
7938 * Get whether multi-selection is enabled or disabled for a given
7941 * @param obj The gengrid object.
7942 * @return @c EINA_TRUE, if multi-selection is enabled, @c
7943 * EINA_FALSE otherwise
7945 * @see elm_gengrid_multi_select_set() for more details
7949 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7952 * Enable or disable bouncing effect for a given gengrid widget
7954 * @param obj The gengrid object
7955 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
7956 * @c EINA_FALSE to disable it
7957 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
7958 * @c EINA_FALSE to disable it
7960 * The bouncing effect occurs whenever one reaches the gengrid's
7961 * edge's while panning it -- it will scroll past its limits a
7962 * little bit and return to the edge again, in a animated for,
7965 * @note By default, gengrids have bouncing enabled on both axis
7967 * @see elm_gengrid_bounce_get()
7971 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7974 * Get whether bouncing effects are enabled or disabled, for a
7975 * given gengrid widget, on each axis
7977 * @param obj The gengrid object
7978 * @param h_bounce Pointer to a variable where to store the
7979 * horizontal bouncing flag.
7980 * @param v_bounce Pointer to a variable where to store the
7981 * vertical bouncing flag.
7983 * @see elm_gengrid_bounce_set() for more details
7987 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7990 * Set a given gengrid widget's scrolling page size, relative to
7991 * its viewport size.
7993 * @param obj The gengrid object
7994 * @param h_pagerel The horizontal page (relative) size
7995 * @param v_pagerel The vertical page (relative) size
7997 * The gengrid's scroller is capable of binding scrolling by the
7998 * user to "pages". It means that, while scrolling and, specially
7999 * after releasing the mouse button, the grid will @b snap to the
8000 * nearest displaying page's area. When page sizes are set, the
8001 * grid's continuous content area is split into (equal) page sized
8004 * This function sets the size of a page <b>relatively to the
8005 * viewport dimensions</b> of the gengrid, for each axis. A value
8006 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8007 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8008 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8009 * 1.0. Values beyond those will make it behave behave
8010 * inconsistently. If you only want one axis to snap to pages, use
8011 * the value @c 0.0 for the other one.
8013 * There is a function setting page size values in @b absolute
8014 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8015 * is mutually exclusive to this one.
8017 * @see elm_gengrid_page_relative_get()
8021 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8024 * Get a given gengrid widget's scrolling page size, relative to
8025 * its viewport size.
8027 * @param obj The gengrid object
8028 * @param h_pagerel Pointer to a variable where to store the
8029 * horizontal page (relative) size
8030 * @param v_pagerel Pointer to a variable where to store the
8031 * vertical page (relative) size
8033 * @see elm_gengrid_page_relative_set() for more details
8037 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8040 * Set a given gengrid widget's scrolling page size
8042 * @param obj The gengrid object
8043 * @param h_pagerel The horizontal page size, in pixels
8044 * @param v_pagerel The vertical page size, in pixels
8046 * The gengrid's scroller is capable of binding scrolling by the
8047 * user to "pages". It means that, while scrolling and, specially
8048 * after releasing the mouse button, the grid will @b snap to the
8049 * nearest displaying page's area. When page sizes are set, the
8050 * grid's continuous content area is split into (equal) page sized
8053 * This function sets the size of a page of the gengrid, in pixels,
8054 * for each axis. Sane usable values are, between @c 0 and the
8055 * dimensions of @p obj, for each axis. Values beyond those will
8056 * make it behave behave inconsistently. If you only want one axis
8057 * to snap to pages, use the value @c 0 for the other one.
8059 * There is a function setting page size values in @b relative
8060 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8061 * use is mutually exclusive to this one.
8065 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8068 * Set for what direction a given gengrid widget will expand while
8069 * placing its items.
8071 * @param obj The gengrid object.
8072 * @param setting @c EINA_TRUE to make the gengrid expand
8073 * horizontally, @c EINA_FALSE to expand vertically.
8075 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8076 * in @b columns, from top to bottom and, when the space for a
8077 * column is filled, another one is started on the right, thus
8078 * expanding the grid horizontally. When in "vertical mode"
8079 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8080 * to right and, when the space for a row is filled, another one is
8081 * started below, thus expanding the grid vertically.
8083 * @see elm_gengrid_horizontal_get()
8087 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8090 * Get for what direction a given gengrid widget will expand while
8091 * placing its items.
8093 * @param obj The gengrid object.
8094 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8095 * @c EINA_FALSE if it's set to expand vertically.
8097 * @see elm_gengrid_horizontal_set() for more detais
8101 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8104 * Get the first item in a given gengrid widget
8106 * @param obj The gengrid object
8107 * @return The first item's handle or @c NULL, if there are no
8108 * items in @p obj (and on errors)
8110 * This returns the first item in the @p obj's internal list of
8113 * @see elm_gengrid_last_item_get()
8117 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8120 * Get the last item in a given gengrid widget
8122 * @param obj The gengrid object
8123 * @return The last item's handle or @c NULL, if there are no
8124 * items in @p obj (and on errors)
8126 * This returns the last item in the @p obj's internal list of
8129 * @see elm_gengrid_first_item_get()
8133 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8136 * Get the @b next item in a gengrid widget's internal list of items,
8137 * given a handle to one of those items.
8139 * @param item The gengrid item to fetch next from
8140 * @return The item after @p item, or @c NULL if there's none (and
8143 * This returns the item placed after the @p item, on the container
8146 * @see elm_gengrid_item_prev_get()
8150 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8153 * Get the @b previous item in a gengrid widget's internal list of items,
8154 * given a handle to one of those items.
8156 * @param item The gengrid item to fetch previous from
8157 * @return The item before @p item, or @c NULL if there's none (and
8160 * This returns the item placed before the @p item, on the container
8163 * @see elm_gengrid_item_next_get()
8167 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8170 * Get the gengrid object's handle which contains a given gengrid
8173 * @param item The item to fetch the container from
8174 * @return The gengrid (parent) object
8176 * This returns the gengrid object itself that an item belongs to.
8180 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8183 * Remove a gengrid item from the its parent, deleting it.
8185 * @param item The item to be removed.
8186 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8188 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8193 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8196 * Update the contents of a given gengrid item
8198 * @param item The gengrid item
8200 * This updates an item by calling all the item class functions
8201 * again to get the icons, labels and states. Use this when the
8202 * original item data has changed and you want thta changes to be
8207 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8208 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8209 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8212 * Return the data associated to a given gengrid item
8214 * @param item The gengrid item.
8215 * @return the data associated to this item.
8217 * This returns the @c data value passed on the
8218 * elm_gengrid_item_append() and related item addition calls.
8220 * @see elm_gengrid_item_append()
8221 * @see elm_gengrid_item_data_set()
8225 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8228 * Set the data associated to a given gengrid item
8230 * @param item The gengrid item
8231 * @param data The new data pointer to set on it
8233 * This @b overrides the @c data value passed on the
8234 * elm_gengrid_item_append() and related item addition calls. This
8235 * function @b won't call elm_gengrid_item_update() automatically,
8236 * so you'd issue it afterwards if you want to hove the item
8237 * updated to reflect the that new data.
8239 * @see elm_gengrid_item_data_get()
8243 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8246 * Get a given gengrid item's position, relative to the whole
8247 * gengrid's grid area.
8249 * @param item The Gengrid item.
8250 * @param x Pointer to variable where to store the item's <b>row
8252 * @param y Pointer to variable where to store the item's <b>column
8255 * This returns the "logical" position of the item whithin the
8256 * gengrid. For example, @c (0, 1) would stand for first row,
8261 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8264 * Set whether a given gengrid item is selected or not
8266 * @param item The gengrid item
8267 * @param selected Use @c EINA_TRUE, to make it selected, @c
8268 * EINA_FALSE to make it unselected
8270 * This sets the selected state of an item. If multi selection is
8271 * not enabled on the containing gengrid and @p selected is @c
8272 * EINA_TRUE, any other previously selected items will get
8273 * unselected in favor of this new one.
8275 * @see elm_gengrid_item_selected_get()
8279 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8282 * Get whether a given gengrid item is selected or not
8284 * @param item The gengrid item
8285 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8287 * @see elm_gengrid_item_selected_set() for more details
8291 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8294 * Get the real Evas object created to implement the view of a
8295 * given gengrid item
8297 * @param item The gengrid item.
8298 * @return the Evas object implementing this item's view.
8300 * This returns the actual Evas object used to implement the
8301 * specified gengrid item's view. This may be @c NULL, as it may
8302 * not have been created or may have been deleted, at any time, by
8303 * the gengrid. <b>Do not modify this object</b> (move, resize,
8304 * show, hide, etc.), as the gengrid is controlling it. This
8305 * function is for querying, emitting custom signals or hooking
8306 * lower level callbacks for events on that object. Do not delete
8307 * this object under any circumstances.
8309 * @see elm_gengrid_item_data_get()
8313 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8316 * Show the portion of a gengrid's internal grid containing a given
8317 * item, @b immediately.
8319 * @param item The item to display
8321 * This causes gengrid to @b redraw its viewport's contents to the
8322 * region contining the given @p item item, if it is not fully
8325 * @see elm_gengrid_item_bring_in()
8329 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8332 * Animatedly bring in, to the visible are of a gengrid, a given
8335 * @param item The gengrid item to display
8337 * This causes gengrig to jump to the given @p item item and show
8338 * it (by scrolling), if it is not fully visible. This will use
8339 * animation to do so and take a period of time to complete.
8341 * @see elm_gengrid_item_show()
8345 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8348 * Set whether a given gengrid item is disabled or not.
8350 * @param item The gengrid item
8351 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8352 * to enable it back.
8354 * A disabled item cannot be selected or unselected. It will also
8355 * change its appearance, to signal the user it's disabled.
8357 * @see elm_gengrid_item_disabled_get()
8361 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8364 * Get whether a given gengrid item is disabled or not.
8366 * @param item The gengrid item
8367 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8370 * @see elm_gengrid_item_disabled_set() for more details
8374 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8377 * Set the text to be shown in a given gengrid item's tooltips.
8379 * @param item The gengrid item
8380 * @param text The text to set in the content
8382 * This call will setup the text to be used as tooltip to that item
8383 * (analogous to elm_object_tooltip_text_set(), but being item
8384 * tooltips with higher precedence than object tooltips). It can
8385 * have only one tooltip at a time, so any previous tooltip data
8390 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8393 * Set the content to be shown in a given gengrid item's tooltips
8395 * @param item The gengrid item.
8396 * @param func The function returning the tooltip contents.
8397 * @param data What to provide to @a func as callback data/context.
8398 * @param del_cb Called when data is not needed anymore, either when
8399 * another callback replaces @p func, the tooltip is unset with
8400 * elm_gengrid_item_tooltip_unset() or the owner @p item
8401 * dies. This callback receives as its first parameter the
8402 * given @p data, being @c event_info the item handle.
8404 * This call will setup the tooltip's contents to @p item
8405 * (analogous to elm_object_tooltip_content_cb_set(), but being
8406 * item tooltips with higher precedence than object tooltips). It
8407 * can have only one tooltip at a time, so any previous tooltip
8408 * content will get removed. @p func (with @p data) will be called
8409 * every time Elementary needs to show the tooltip and it should
8410 * return a valid Evas object, which will be fully managed by the
8411 * tooltip system, getting deleted when the tooltip is gone.
8415 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);
8418 * Unset a tooltip from a given gengrid item
8420 * @param item gengrid item to remove a previously set tooltip from.
8422 * This call removes any tooltip set on @p item. The callback
8423 * provided as @c del_cb to
8424 * elm_gengrid_item_tooltip_content_cb_set() will be called to
8425 * notify it is not used anymore (and have resources cleaned, if
8428 * @see elm_gengrid_item_tooltip_content_cb_set()
8432 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8435 * Set a different @b style for a given gengrid item's tooltip.
8437 * @param item gengrid item with tooltip set
8438 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8439 * "default", @c "transparent", etc)
8441 * Tooltips can have <b>alternate styles</b> to be displayed on,
8442 * which are defined by the theme set on Elementary. This function
8443 * works analogously as elm_object_tooltip_style_set(), but here
8444 * applied only to gengrid item objects. The default style for
8445 * tooltips is @c "default".
8447 * @note before you set a style you should define a tooltip with
8448 * elm_gengrid_item_tooltip_content_cb_set() or
8449 * elm_gengrid_item_tooltip_text_set()
8451 * @see elm_gengrid_item_tooltip_style_get()
8455 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8458 * Get the style set a given gengrid item's tooltip.
8460 * @param item gengrid item with tooltip already set on.
8461 * @return style the theme style in use, which defaults to
8462 * "default". If the object does not have a tooltip set,
8463 * then @c NULL is returned.
8465 * @see elm_gengrid_item_tooltip_style_set() for more details
8469 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8471 * @brief Disable size restrictions on an object's tooltip
8472 * @param item The tooltip's anchor object
8473 * @param disable If EINA_TRUE, size restrictions are disabled
8474 * @return EINA_FALSE on failure, EINA_TRUE on success
8476 * This function allows a tooltip to expand beyond its parant window's canvas.
8477 * It will instead be limited only by the size of the display.
8479 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8481 * @brief Retrieve size restriction state of an object's tooltip
8482 * @param item The tooltip's anchor object
8483 * @return If EINA_TRUE, size restrictions are disabled
8485 * This function returns whether a tooltip is allowed to expand beyond
8486 * its parant window's canvas.
8487 * It will instead be limited only by the size of the display.
8489 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8491 * Set the type of mouse pointer/cursor decoration to be shown,
8492 * when the mouse pointer is over the given gengrid widget item
8494 * @param item gengrid item to customize cursor on
8495 * @param cursor the cursor type's name
8497 * This function works analogously as elm_object_cursor_set(), but
8498 * here the cursor's changing area is restricted to the item's
8499 * area, and not the whole widget's. Note that that item cursors
8500 * have precedence over widget cursors, so that a mouse over @p
8501 * item will always show cursor @p type.
8503 * If this function is called twice for an object, a previously set
8504 * cursor will be unset on the second call.
8506 * @see elm_object_cursor_set()
8507 * @see elm_gengrid_item_cursor_get()
8508 * @see elm_gengrid_item_cursor_unset()
8512 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8515 * Get the type of mouse pointer/cursor decoration set to be shown,
8516 * when the mouse pointer is over the given gengrid widget item
8518 * @param item gengrid item with custom cursor set
8519 * @return the cursor type's name or @c NULL, if no custom cursors
8520 * were set to @p item (and on errors)
8522 * @see elm_object_cursor_get()
8523 * @see elm_gengrid_item_cursor_set() for more details
8524 * @see elm_gengrid_item_cursor_unset()
8528 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8531 * Unset any custom mouse pointer/cursor decoration set to be
8532 * shown, when the mouse pointer is over the given gengrid widget
8533 * item, thus making it show the @b default cursor again.
8535 * @param item a gengrid item
8537 * Use this call to undo any custom settings on this item's cursor
8538 * decoration, bringing it back to defaults (no custom style set).
8540 * @see elm_object_cursor_unset()
8541 * @see elm_gengrid_item_cursor_set() for more details
8545 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8548 * Set a different @b style for a given custom cursor set for a
8551 * @param item gengrid item with custom cursor set
8552 * @param style the <b>theme style</b> to use (e.g. @c "default",
8553 * @c "transparent", etc)
8555 * This function only makes sense when one is using custom mouse
8556 * cursor decorations <b>defined in a theme file</b> , which can
8557 * have, given a cursor name/type, <b>alternate styles</b> on
8558 * it. It works analogously as elm_object_cursor_style_set(), but
8559 * here applied only to gengrid item objects.
8561 * @warning Before you set a cursor style you should have defined a
8562 * custom cursor previously on the item, with
8563 * elm_gengrid_item_cursor_set()
8565 * @see elm_gengrid_item_cursor_engine_only_set()
8566 * @see elm_gengrid_item_cursor_style_get()
8570 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8573 * Get the current @b style set for a given gengrid item's custom
8576 * @param item gengrid item with custom cursor set.
8577 * @return style the cursor style in use. If the object does not
8578 * have a cursor set, then @c NULL is returned.
8580 * @see elm_gengrid_item_cursor_style_set() for more details
8584 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8587 * Set if the (custom) cursor for a given gengrid item should be
8588 * searched in its theme, also, or should only rely on the
8591 * @param item item with custom (custom) cursor already set on
8592 * @param engine_only Use @c EINA_TRUE to have cursors looked for
8593 * only on those provided by the rendering engine, @c EINA_FALSE to
8594 * have them searched on the widget's theme, as well.
8596 * @note This call is of use only if you've set a custom cursor
8597 * for gengrid items, with elm_gengrid_item_cursor_set().
8599 * @note By default, cursors will only be looked for between those
8600 * provided by the rendering engine.
8604 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8607 * Get if the (custom) cursor for a given gengrid item is being
8608 * searched in its theme, also, or is only relying on the rendering
8611 * @param item a gengrid item
8612 * @return @c EINA_TRUE, if cursors are being looked for only on
8613 * those provided by the rendering engine, @c EINA_FALSE if they
8614 * are being searched on the widget's theme, as well.
8616 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8620 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8623 * Remove all items from a given gengrid widget
8625 * @param obj The gengrid object.
8627 * This removes (and deletes) all items in @p obj, leaving it
8630 * @see elm_gengrid_item_del(), to remove just one item.
8634 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8637 * Get the selected item in a given gengrid widget
8639 * @param obj The gengrid object.
8640 * @return The selected item's handleor @c NULL, if none is
8641 * selected at the moment (and on errors)
8643 * This returns the selected item in @p obj. If multi selection is
8644 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8645 * the first item in the list is selected, which might not be very
8646 * useful. For that case, see elm_gengrid_selected_items_get().
8650 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8653 * Get <b>a list</b> of selected items in a given gengrid
8655 * @param obj The gengrid object.
8656 * @return The list of selected items or @c NULL, if none is
8657 * selected at the moment (and on errors)
8659 * This returns a list of the selected items, in the order that
8660 * they appear in the grid. This list is only valid as long as no
8661 * more items are selected or unselected (or unselected implictly
8662 * by deletion). The list contains #Elm_Gengrid_Item pointers as
8665 * @see elm_gengrid_selected_item_get()
8669 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8676 * @defgroup Clock Clock
8678 * @image html img/widget/clock/preview-00.png
8679 * @image latex img/widget/clock/preview-00.eps
8681 * This is a @b digital clock widget. In its default theme, it has a
8682 * vintage "flipping numbers clock" appearance, which will animate
8683 * sheets of individual algarisms individually as time goes by.
8685 * A newly created clock will fetch system's time (already
8686 * considering local time adjustments) to start with, and will tick
8687 * accondingly. It may or may not show seconds.
8689 * Clocks have an @b edition mode. When in it, the sheets will
8690 * display extra arrow indications on the top and bottom and the
8691 * user may click on them to raise or lower the time values. After
8692 * it's told to exit edition mode, it will keep ticking with that
8693 * new time set (it keeps the difference from local time).
8695 * Also, when under edition mode, user clicks on the cited arrows
8696 * which are @b held for some time will make the clock to flip the
8697 * sheet, thus editing the time, continuosly and automatically for
8698 * the user. The interval between sheet flips will keep growing in
8699 * time, so that it helps the user to reach a time which is distant
8702 * The time display is, by default, in military mode (24h), but an
8703 * am/pm indicator may be optionally shown, too, when it will
8706 * Smart callbacks one can register to:
8707 * - "changed" - the clock's user changed the time
8709 * Here is an example on its usage:
8710 * @li @ref clock_example
8719 * Identifiers for which clock digits should be editable, when a
8720 * clock widget is in edition mode. Values may be ORed together to
8721 * make a mask, naturally.
8723 * @see elm_clock_edit_set()
8724 * @see elm_clock_digit_edit_set()
8726 typedef enum _Elm_Clock_Digedit
8728 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8729 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8730 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
8731 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8732 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
8733 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8734 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
8735 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
8736 } Elm_Clock_Digedit;
8739 * Add a new clock widget to the given parent Elementary
8740 * (container) object
8742 * @param parent The parent object
8743 * @return a new clock widget handle or @c NULL, on errors
8745 * This function inserts a new clock widget on the canvas.
8749 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8752 * Set a clock widget's time, programmatically
8754 * @param obj The clock widget object
8755 * @param hrs The hours to set
8756 * @param min The minutes to set
8757 * @param sec The secondes to set
8759 * This function updates the time that is showed by the clock
8762 * Values @b must be set within the following ranges:
8763 * - 0 - 23, for hours
8764 * - 0 - 59, for minutes
8765 * - 0 - 59, for seconds,
8767 * even if the clock is not in "military" mode.
8769 * @warning The behavior for values set out of those ranges is @b
8774 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8777 * Get a clock widget's time values
8779 * @param obj The clock object
8780 * @param[out] hrs Pointer to the variable to get the hours value
8781 * @param[out] min Pointer to the variable to get the minutes value
8782 * @param[out] sec Pointer to the variable to get the seconds value
8784 * This function gets the time set for @p obj, returning
8785 * it on the variables passed as the arguments to function
8787 * @note Use @c NULL pointers on the time values you're not
8788 * interested in: they'll be ignored by the function.
8792 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8795 * Set whether a given clock widget is under <b>edition mode</b> or
8796 * under (default) displaying-only mode.
8798 * @param obj The clock object
8799 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8800 * put it back to "displaying only" mode
8802 * This function makes a clock's time to be editable or not <b>by
8803 * user interaction</b>. When in edition mode, clocks @b stop
8804 * ticking, until one brings them back to canonical mode. The
8805 * elm_clock_digit_edit_set() function will influence which digits
8806 * of the clock will be editable. By default, all of them will be
8807 * (#ELM_CLOCK_NONE).
8809 * @note am/pm sheets, if being shown, will @b always be editable
8810 * under edition mode.
8812 * @see elm_clock_edit_get()
8816 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8819 * Retrieve whether a given clock widget is under <b>edition
8820 * mode</b> or under (default) displaying-only mode.
8822 * @param obj The clock object
8823 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
8826 * This function retrieves whether the clock's time can be edited
8827 * or not by user interaction.
8829 * @see elm_clock_edit_set() for more details
8833 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8836 * Set what digits of the given clock widget should be editable
8837 * when in edition mode.
8839 * @param obj The clock object
8840 * @param digedit Bit mask indicating the digits to be editable
8841 * (values in #Elm_Clock_Digedit).
8843 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
8844 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
8847 * @see elm_clock_digit_edit_get()
8851 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
8854 * Retrieve what digits of the given clock widget should be
8855 * editable when in edition mode.
8857 * @param obj The clock object
8858 * @return Bit mask indicating the digits to be editable
8859 * (values in #Elm_Clock_Digedit).
8861 * @see elm_clock_digit_edit_set() for more details
8865 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8868 * Set if the given clock widget must show hours in military or
8871 * @param obj The clock object
8872 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
8875 * This function sets if the clock must show hours in military or
8876 * am/pm mode. In some countries like Brazil the military mode
8877 * (00-24h-format) is used, in opposition to the USA, where the
8878 * am/pm mode is more commonly used.
8880 * @see elm_clock_show_am_pm_get()
8884 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
8887 * Get if the given clock widget shows hours in military or am/pm
8890 * @param obj The clock object
8891 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
8894 * This function gets if the clock shows hours in military or am/pm
8897 * @see elm_clock_show_am_pm_set() for more details
8901 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8904 * Set if the given clock widget must show time with seconds or not
8906 * @param obj The clock object
8907 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
8909 * This function sets if the given clock must show or not elapsed
8910 * seconds. By default, they are @b not shown.
8912 * @see elm_clock_show_seconds_get()
8916 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
8919 * Get whether the given clock widget is showing time with seconds
8922 * @param obj The clock object
8923 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
8925 * This function gets whether @p obj is showing or not the elapsed
8928 * @see elm_clock_show_seconds_set()
8932 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8935 * Set the interval on time updates for an user mouse button hold
8936 * on clock widgets' time edition.
8938 * @param obj The clock object
8939 * @param interval The (first) interval value in seconds
8941 * This interval value is @b decreased while the user holds the
8942 * mouse pointer either incrementing or decrementing a given the
8943 * clock digit's value.
8945 * This helps the user to get to a given time distant from the
8946 * current one easier/faster, as it will start to flip quicker and
8947 * quicker on mouse button holds.
8949 * The calculation for the next flip interval value, starting from
8950 * the one set with this call, is the previous interval divided by
8951 * 1.05, so it decreases a little bit.
8953 * The default starting interval value for automatic flips is
8956 * @see elm_clock_interval_get()
8960 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
8963 * Get the interval on time updates for an user mouse button hold
8964 * on clock widgets' time edition.
8966 * @param obj The clock object
8967 * @return The (first) interval value, in seconds, set on it
8969 * @see elm_clock_interval_set() for more details
8973 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8980 * @defgroup Layout Layout
8982 * @image html img/widget/layout/preview-00.png
8983 * @image latex img/widget/layout/preview-00.eps width=\textwidth
8985 * @image html img/layout-predefined.png
8986 * @image latex img/layout-predefined.eps width=\textwidth
8988 * This is a container widget that takes a standard Edje design file and
8989 * wraps it very thinly in a widget.
8991 * An Edje design (theme) file has a very wide range of possibilities to
8992 * describe the behavior of elements added to the Layout. Check out the Edje
8993 * documentation and the EDC reference to get more information about what can
8994 * be done with Edje.
8996 * Just like @ref List, @ref Box, and other container widgets, any
8997 * object added to the Layout will become its child, meaning that it will be
8998 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9000 * The Layout widget can contain as many Contents, Boxes or Tables as
9001 * described in its theme file. For instance, objects can be added to
9002 * different Tables by specifying the respective Table part names. The same
9003 * is valid for Content and Box.
9005 * The objects added as child of the Layout will behave as described in the
9006 * part description where they were added. There are 3 possible types of
9007 * parts where a child can be added:
9009 * @section secContent Content (SWALLOW part)
9011 * Only one object can be added to the @c SWALLOW part (but you still can
9012 * have many @c SWALLOW parts and one object on each of them). Use the @c
9013 * elm_layout_content_* set of functions to set, retrieve and unset objects
9014 * as content of the @c SWALLOW. After being set to this part, the object
9015 * size, position, visibility, clipping and other description properties
9016 * will be totally controled by the description of the given part (inside
9017 * the Edje theme file).
9019 * One can use @c evas_object_size_hint_* functions on the child to have some
9020 * kind of control over its behavior, but the resulting behavior will still
9021 * depend heavily on the @c SWALLOW part description.
9023 * The Edje theme also can change the part description, based on signals or
9024 * scripts running inside the theme. This change can also be animated. All of
9025 * this will affect the child object set as content accordingly. The object
9026 * size will be changed if the part size is changed, it will animate move if
9027 * the part is moving, and so on.
9029 * The following picture demonstrates a Layout widget with a child object
9030 * added to its @c SWALLOW:
9032 * @image html layout_swallow.png
9033 * @image latex layout_swallow.eps width=\textwidth
9035 * @section secBox Box (BOX part)
9037 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9038 * allows one to add objects to the box and have them distributed along its
9039 * area, accordingly to the specified @a layout property (now by @a layout we
9040 * mean the chosen layouting design of the Box, not the Layout widget
9043 * A similar effect for having a box with its position, size and other things
9044 * controled by the Layout theme would be to create an Elementary @ref Box
9045 * widget and add it as a Content in the @c SWALLOW part.
9047 * The main difference of using the Layout Box is that its behavior, the box
9048 * properties like layouting format, padding, align, etc. will be all
9049 * controled by the theme. This means, for example, that a signal could be
9050 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9051 * handled the signal by changing the box padding, or align, or both. Using
9052 * the Elementary @ref Box widget is not necessarily harder or easier, it
9053 * just depends on the circunstances and requirements.
9055 * The Layout Box can be used through the @c elm_layout_box_* set of
9058 * The following picture demonstrates a Layout widget with many child objects
9059 * added to its @c BOX part:
9061 * @image html layout_box.png
9062 * @image latex layout_box.eps width=\textwidth
9064 * @section secTable Table (TABLE part)
9066 * Just like the @ref secBox, the Layout Table is very similar to the
9067 * Elementary @ref Table widget. It allows one to add objects to the Table
9068 * specifying the row and column where the object should be added, and any
9069 * column or row span if necessary.
9071 * Again, we could have this design by adding a @ref Table widget to the @c
9072 * SWALLOW part using elm_layout_content_set(). The same difference happens
9073 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9074 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9076 * The Layout Table can be used through the @c elm_layout_table_* set of
9079 * The following picture demonstrates a Layout widget with many child objects
9080 * added to its @c TABLE part:
9082 * @image html layout_table.png
9083 * @image latex layout_table.eps width=\textwidth
9085 * @section secPredef Predefined Layouts
9087 * Another interesting thing about the Layout widget is that it offers some
9088 * predefined themes that come with the default Elementary theme. These
9089 * themes can be set by the call elm_layout_theme_set(), and provide some
9090 * basic functionality depending on the theme used.
9092 * Most of them already send some signals, some already provide a toolbar or
9093 * back and next buttons.
9095 * These are available predefined theme layouts. All of them have class = @c
9096 * layout, group = @c application, and style = one of the following options:
9098 * @li @c toolbar-content - application with toolbar and main content area
9099 * @li @c toolbar-content-back - application with toolbar and main content
9100 * area with a back button and title area
9101 * @li @c toolbar-content-back-next - application with toolbar and main
9102 * content area with a back and next buttons and title area
9103 * @li @c content-back - application with a main content area with a back
9104 * button and title area
9105 * @li @c content-back-next - application with a main content area with a
9106 * back and next buttons and title area
9107 * @li @c toolbar-vbox - application with toolbar and main content area as a
9109 * @li @c toolbar-table - application with toolbar and main content area as a
9112 * @section secExamples Examples
9114 * Some examples of the Layout widget can be found here:
9115 * @li @ref layout_example_01
9116 * @li @ref layout_example_02
9117 * @li @ref layout_example_03
9118 * @li @ref layout_example_edc
9123 * Add a new layout to the parent
9125 * @param parent The parent object
9126 * @return The new object or NULL if it cannot be created
9128 * @see elm_layout_file_set()
9129 * @see elm_layout_theme_set()
9133 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9135 * Set the file that will be used as layout
9137 * @param obj The layout object
9138 * @param file The path to file (edj) that will be used as layout
9139 * @param group The group that the layout belongs in edje file
9141 * @return (1 = success, 0 = error)
9145 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9147 * Set the edje group from the elementary theme that will be used as layout
9149 * @param obj The layout object
9150 * @param clas the clas of the group
9151 * @param group the group
9152 * @param style the style to used
9154 * @return (1 = success, 0 = error)
9158 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9160 * Set the layout content.
9162 * @param obj The layout object
9163 * @param swallow The swallow part name in the edje file
9164 * @param content The child that will be added in this layout object
9166 * Once the content object is set, a previously set one will be deleted.
9167 * If you want to keep that old content object, use the
9168 * elm_layout_content_unset() function.
9170 * @note In an Edje theme, the part used as a content container is called @c
9171 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9172 * expected to be a part name just like the second parameter of
9173 * elm_layout_box_append().
9175 * @see elm_layout_box_append()
9176 * @see elm_layout_content_get()
9177 * @see elm_layout_content_unset()
9182 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9184 * Get the child object in the given content part.
9186 * @param obj The layout object
9187 * @param swallow The SWALLOW part to get its content
9189 * @return The swallowed object or NULL if none or an error occurred
9191 * @see elm_layout_content_set()
9195 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9197 * Unset the layout content.
9199 * @param obj The layout object
9200 * @param swallow The swallow part name in the edje file
9201 * @return The content that was being used
9203 * Unparent and return the content object which was set for this part.
9205 * @see elm_layout_content_set()
9209 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9211 * Set the text of the given part
9213 * @param obj The layout object
9214 * @param part The TEXT part where to set the text
9215 * @param text The text to set
9218 * @deprecated use elm_object_text_* instead.
9220 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9222 * Get the text set in the given part
9224 * @param obj The layout object
9225 * @param part The TEXT part to retrieve the text off
9227 * @return The text set in @p part
9230 * @deprecated use elm_object_text_* instead.
9232 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9234 * Append child to layout box part.
9236 * @param obj the layout object
9237 * @param part the box part to which the object will be appended.
9238 * @param child the child object to append to box.
9240 * Once the object is appended, it will become child of the layout. Its
9241 * lifetime will be bound to the layout, whenever the layout dies the child
9242 * will be deleted automatically. One should use elm_layout_box_remove() to
9243 * make this layout forget about the object.
9245 * @see elm_layout_box_prepend()
9246 * @see elm_layout_box_insert_before()
9247 * @see elm_layout_box_insert_at()
9248 * @see elm_layout_box_remove()
9252 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9254 * Prepend child to layout box part.
9256 * @param obj the layout object
9257 * @param part the box part to prepend.
9258 * @param child the child object to prepend to box.
9260 * Once the object is prepended, it will become child of the layout. Its
9261 * lifetime will be bound to the layout, whenever the layout dies the child
9262 * will be deleted automatically. One should use elm_layout_box_remove() to
9263 * make this layout forget about the object.
9265 * @see elm_layout_box_append()
9266 * @see elm_layout_box_insert_before()
9267 * @see elm_layout_box_insert_at()
9268 * @see elm_layout_box_remove()
9272 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9274 * Insert child to layout box part before a reference object.
9276 * @param obj the layout object
9277 * @param part the box part to insert.
9278 * @param child the child object to insert into box.
9279 * @param reference another reference object to insert before in box.
9281 * Once the object is inserted, it will become child of the layout. Its
9282 * lifetime will be bound to the layout, whenever the layout dies the child
9283 * will be deleted automatically. One should use elm_layout_box_remove() to
9284 * make this layout forget about the object.
9286 * @see elm_layout_box_append()
9287 * @see elm_layout_box_prepend()
9288 * @see elm_layout_box_insert_before()
9289 * @see elm_layout_box_remove()
9293 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9295 * Insert child to layout box part at a given position.
9297 * @param obj the layout object
9298 * @param part the box part to insert.
9299 * @param child the child object to insert into box.
9300 * @param pos the numeric position >=0 to insert the child.
9302 * Once the object is inserted, it will become child of the layout. Its
9303 * lifetime will be bound to the layout, whenever the layout dies the child
9304 * will be deleted automatically. One should use elm_layout_box_remove() to
9305 * make this layout forget about the object.
9307 * @see elm_layout_box_append()
9308 * @see elm_layout_box_prepend()
9309 * @see elm_layout_box_insert_before()
9310 * @see elm_layout_box_remove()
9314 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9316 * Remove a child of the given part box.
9318 * @param obj The layout object
9319 * @param part The box part name to remove child.
9320 * @param child The object to remove from box.
9321 * @return The object that was being used, or NULL if not found.
9323 * The object will be removed from the box part and its lifetime will
9324 * not be handled by the layout anymore. This is equivalent to
9325 * elm_layout_content_unset() for box.
9327 * @see elm_layout_box_append()
9328 * @see elm_layout_box_remove_all()
9332 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9334 * Remove all child of the given part box.
9336 * @param obj The layout object
9337 * @param part The box part name to remove child.
9338 * @param clear If EINA_TRUE, then all objects will be deleted as
9339 * well, otherwise they will just be removed and will be
9340 * dangling on the canvas.
9342 * The objects will be removed from the box part and their lifetime will
9343 * not be handled by the layout anymore. This is equivalent to
9344 * elm_layout_box_remove() for all box children.
9346 * @see elm_layout_box_append()
9347 * @see elm_layout_box_remove()
9351 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9353 * Insert child to layout table part.
9355 * @param obj the layout object
9356 * @param part the box part to pack child.
9357 * @param child_obj the child object to pack into table.
9358 * @param col the column to which the child should be added. (>= 0)
9359 * @param row the row to which the child should be added. (>= 0)
9360 * @param colspan how many columns should be used to store this object. (>=
9362 * @param rowspan how many rows should be used to store this object. (>= 1)
9364 * Once the object is inserted, it will become child of the table. Its
9365 * lifetime will be bound to the layout, and whenever the layout dies the
9366 * child will be deleted automatically. One should use
9367 * elm_layout_table_remove() to make this layout forget about the object.
9369 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9370 * more space than a single cell. For instance, the following code:
9372 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9375 * Would result in an object being added like the following picture:
9377 * @image html layout_colspan.png
9378 * @image latex layout_colspan.eps width=\textwidth
9380 * @see elm_layout_table_unpack()
9381 * @see elm_layout_table_clear()
9385 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);
9387 * Unpack (remove) a child of the given part table.
9389 * @param obj The layout object
9390 * @param part The table part name to remove child.
9391 * @param child_obj The object to remove from table.
9392 * @return The object that was being used, or NULL if not found.
9394 * The object will be unpacked from the table part and its lifetime
9395 * will not be handled by the layout anymore. This is equivalent to
9396 * elm_layout_content_unset() for table.
9398 * @see elm_layout_table_pack()
9399 * @see elm_layout_table_clear()
9403 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9405 * Remove all child of the given part table.
9407 * @param obj The layout object
9408 * @param part The table part name to remove child.
9409 * @param clear If EINA_TRUE, then all objects will be deleted as
9410 * well, otherwise they will just be removed and will be
9411 * dangling on the canvas.
9413 * The objects will be removed from the table part and their lifetime will
9414 * not be handled by the layout anymore. This is equivalent to
9415 * elm_layout_table_unpack() for all table children.
9417 * @see elm_layout_table_pack()
9418 * @see elm_layout_table_unpack()
9422 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9424 * Get the edje layout
9426 * @param obj The layout object
9428 * @return A Evas_Object with the edje layout settings loaded
9429 * with function elm_layout_file_set
9431 * This returns the edje object. It is not expected to be used to then
9432 * swallow objects via edje_object_part_swallow() for example. Use
9433 * elm_layout_content_set() instead so child object handling and sizing is
9436 * @note This function should only be used if you really need to call some
9437 * low level Edje function on this edje object. All the common stuff (setting
9438 * text, emitting signals, hooking callbacks to signals, etc.) can be done
9439 * with proper elementary functions.
9441 * @see elm_object_signal_callback_add()
9442 * @see elm_object_signal_emit()
9443 * @see elm_object_text_part_set()
9444 * @see elm_layout_content_set()
9445 * @see elm_layout_box_append()
9446 * @see elm_layout_table_pack()
9447 * @see elm_layout_data_get()
9451 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9453 * Get the edje data from the given layout
9455 * @param obj The layout object
9456 * @param key The data key
9458 * @return The edje data string
9460 * This function fetches data specified inside the edje theme of this layout.
9461 * This function return NULL if data is not found.
9463 * In EDC this comes from a data block within the group block that @p
9464 * obj was loaded from. E.g.
9471 * item: "key1" "value1";
9472 * item: "key2" "value2";
9480 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9484 * @param obj The layout object
9486 * Manually forces a sizing re-evaluation. This is useful when the minimum
9487 * size required by the edje theme of this layout has changed. The change on
9488 * the minimum size required by the edje theme is not immediately reported to
9489 * the elementary layout, so one needs to call this function in order to tell
9490 * the widget (layout) that it needs to reevaluate its own size.
9492 * The minimum size of the theme is calculated based on minimum size of
9493 * parts, the size of elements inside containers like box and table, etc. All
9494 * of this can change due to state changes, and that's when this function
9497 * Also note that a standard signal of "size,eval" "elm" emitted from the
9498 * edje object will cause this to happen too.
9502 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9505 * Sets a specific cursor for an edje part.
9507 * @param obj The layout object.
9508 * @param part_name a part from loaded edje group.
9509 * @param cursor cursor name to use, see Elementary_Cursor.h
9511 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9512 * part not exists or it has "mouse_events: 0".
9516 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9519 * Get the cursor to be shown when mouse is over an edje part
9521 * @param obj The layout object.
9522 * @param part_name a part from loaded edje group.
9523 * @return the cursor name.
9527 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9530 * Unsets a cursor previously set with elm_layout_part_cursor_set().
9532 * @param obj The layout object.
9533 * @param part_name a part from loaded edje group, that had a cursor set
9534 * with elm_layout_part_cursor_set().
9538 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9541 * Sets a specific cursor style for an edje part.
9543 * @param obj The layout object.
9544 * @param part_name a part from loaded edje group.
9545 * @param style the theme style to use (default, transparent, ...)
9547 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9548 * part not exists or it did not had a cursor set.
9552 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9555 * Gets a specific cursor style for an edje part.
9557 * @param obj The layout object.
9558 * @param part_name a part from loaded edje group.
9560 * @return the theme style in use, defaults to "default". If the
9561 * object does not have a cursor set, then NULL is returned.
9565 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9568 * Sets if the cursor set should be searched on the theme or should use
9569 * the provided by the engine, only.
9571 * @note before you set if should look on theme you should define a
9572 * cursor with elm_layout_part_cursor_set(). By default it will only
9573 * look for cursors provided by the engine.
9575 * @param obj The layout object.
9576 * @param part_name a part from loaded edje group.
9577 * @param engine_only if cursors should be just provided by the engine
9578 * or should also search on widget's theme as well
9580 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9581 * part not exists or it did not had a cursor set.
9585 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);
9588 * Gets a specific cursor engine_only for an edje part.
9590 * @param obj The layout object.
9591 * @param part_name a part from loaded edje group.
9593 * @return whenever the cursor is just provided by engine or also from theme.
9597 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9600 * @def elm_layout_icon_set
9601 * Convienience macro to set the icon object in a layout that follows the
9602 * Elementary naming convention for its parts.
9606 #define elm_layout_icon_set(_ly, _obj) \
9609 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9610 if ((_obj)) sig = "elm,state,icon,visible"; \
9611 else sig = "elm,state,icon,hidden"; \
9612 elm_object_signal_emit((_ly), sig, "elm"); \
9616 * @def elm_layout_icon_get
9617 * Convienience macro to get the icon object from a layout that follows the
9618 * Elementary naming convention for its parts.
9622 #define elm_layout_icon_get(_ly) \
9623 elm_layout_content_get((_ly), "elm.swallow.icon")
9626 * @def elm_layout_end_set
9627 * Convienience macro to set the end object in a layout that follows the
9628 * Elementary naming convention for its parts.
9632 #define elm_layout_end_set(_ly, _obj) \
9635 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9636 if ((_obj)) sig = "elm,state,end,visible"; \
9637 else sig = "elm,state,end,hidden"; \
9638 elm_object_signal_emit((_ly), sig, "elm"); \
9642 * @def elm_layout_end_get
9643 * Convienience macro to get the end object in a layout that follows the
9644 * Elementary naming convention for its parts.
9648 #define elm_layout_end_get(_ly) \
9649 elm_layout_content_get((_ly), "elm.swallow.end")
9652 * @def elm_layout_label_set
9653 * Convienience macro to set the label in a layout that follows the
9654 * Elementary naming convention for its parts.
9657 * @deprecated use elm_object_text_* instead.
9659 #define elm_layout_label_set(_ly, _txt) \
9660 elm_layout_text_set((_ly), "elm.text", (_txt))
9663 * @def elm_layout_label_get
9664 * Convienience macro to get the label in a layout that follows the
9665 * Elementary naming convention for its parts.
9668 * @deprecated use elm_object_text_* instead.
9670 #define elm_layout_label_get(_ly) \
9671 elm_layout_text_get((_ly), "elm.text")
9673 /* smart callbacks called:
9674 * "theme,changed" - when elm theme is changed.
9678 * @defgroup Notify Notify
9680 * @image html img/widget/notify/preview-00.png
9681 * @image latex img/widget/notify/preview-00.eps
9683 * Display a container in a particular region of the parent(top, bottom,
9684 * etc. A timeout can be set to automatically hide the notify. This is so
9685 * that, after an evas_object_show() on a notify object, if a timeout was set
9686 * on it, it will @b automatically get hidden after that time.
9688 * Signals that you can add callbacks for are:
9689 * @li "timeout" - when timeout happens on notify and it's hidden
9690 * @li "block,clicked" - when a click outside of the notify happens
9692 * @ref tutorial_notify show usage of the API.
9697 * @brief Possible orient values for notify.
9699 * This values should be used in conjunction to elm_notify_orient_set() to
9700 * set the position in which the notify should appear(relative to its parent)
9701 * and in conjunction with elm_notify_orient_get() to know where the notify
9704 typedef enum _Elm_Notify_Orient
9706 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9707 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9708 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9709 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9710 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9711 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9712 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9713 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9714 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9715 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9716 } Elm_Notify_Orient;
9718 * @brief Add a new notify to the parent
9720 * @param parent The parent object
9721 * @return The new object or NULL if it cannot be created
9723 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9725 * @brief Set the content of the notify widget
9727 * @param obj The notify object
9728 * @param content The content will be filled in this notify object
9730 * Once the content object is set, a previously set one will be deleted. If
9731 * you want to keep that old content object, use the
9732 * elm_notify_content_unset() function.
9734 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9736 * @brief Unset the content of the notify widget
9738 * @param obj The notify object
9739 * @return The content that was being used
9741 * Unparent and return the content object which was set for this widget
9743 * @see elm_notify_content_set()
9745 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9747 * @brief Return the content of the notify widget
9749 * @param obj The notify object
9750 * @return The content that is being used
9752 * @see elm_notify_content_set()
9754 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9756 * @brief Set the notify parent
9758 * @param obj The notify object
9759 * @param content The new parent
9761 * Once the parent object is set, a previously set one will be disconnected
9764 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9766 * @brief Get the notify parent
9768 * @param obj The notify object
9769 * @return The parent
9771 * @see elm_notify_parent_set()
9773 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9775 * @brief Set the orientation
9777 * @param obj The notify object
9778 * @param orient The new orientation
9780 * Sets the position in which the notify will appear in its parent.
9782 * @see @ref Elm_Notify_Orient for possible values.
9784 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9786 * @brief Return the orientation
9787 * @param obj The notify object
9788 * @return The orientation of the notification
9790 * @see elm_notify_orient_set()
9791 * @see Elm_Notify_Orient
9793 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9795 * @brief Set the time interval after which the notify window is going to be
9798 * @param obj The notify object
9799 * @param time The timeout in seconds
9801 * This function sets a timeout and starts the timer controlling when the
9802 * notify is hidden. Since calling evas_object_show() on a notify restarts
9803 * the timer controlling when the notify is hidden, setting this before the
9804 * notify is shown will in effect mean starting the timer when the notify is
9807 * @note Set a value <= 0.0 to disable a running timer.
9809 * @note If the value > 0.0 and the notify is previously visible, the
9810 * timer will be started with this value, canceling any running timer.
9812 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
9814 * @brief Return the timeout value (in seconds)
9815 * @param obj the notify object
9817 * @see elm_notify_timeout_set()
9819 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9821 * @brief Sets whether events should be passed to by a click outside
9824 * @param obj The notify object
9825 * @param repeats EINA_TRUE Events are repeats, else no
9827 * When true if the user clicks outside the window the events will be caught
9828 * by the others widgets, else the events are blocked.
9830 * @note The default value is EINA_TRUE.
9832 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
9834 * @brief Return true if events are repeat below the notify object
9835 * @param obj the notify object
9837 * @see elm_notify_repeat_events_set()
9839 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9845 * @defgroup Hover Hover
9847 * @image html img/widget/hover/preview-00.png
9848 * @image latex img/widget/hover/preview-00.eps
9850 * A Hover object will hover over its @p parent object at the @p target
9851 * location. Anything in the background will be given a darker coloring to
9852 * indicate that the hover object is on top (at the default theme). When the
9853 * hover is clicked it is dismissed(hidden), if the contents of the hover are
9854 * clicked that @b doesn't cause the hover to be dismissed.
9856 * @note The hover object will take up the entire space of @p target
9859 * Elementary has the following styles for the hover widget:
9863 * @li hoversel_vertical
9865 * The following are the available position for content:
9877 * Signals that you can add callbacks for are:
9878 * @li "clicked" - the user clicked the empty space in the hover to dismiss
9879 * @li "smart,changed" - a content object placed under the "smart"
9880 * policy was replaced to a new slot direction.
9882 * See @ref tutorial_hover for more information.
9886 typedef enum _Elm_Hover_Axis
9888 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
9889 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
9890 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
9891 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
9894 * @brief Adds a hover object to @p parent
9896 * @param parent The parent object
9897 * @return The hover object or NULL if one could not be created
9899 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9901 * @brief Sets the target object for the hover.
9903 * @param obj The hover object
9904 * @param target The object to center the hover onto. The hover
9906 * This function will cause the hover to be centered on the target object.
9908 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
9910 * @brief Gets the target object for the hover.
9912 * @param obj The hover object
9913 * @param parent The object to locate the hover over.
9915 * @see elm_hover_target_set()
9917 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9919 * @brief Sets the parent object for the hover.
9921 * @param obj The hover object
9922 * @param parent The object to locate the hover over.
9924 * This function will cause the hover to take up the entire space that the
9925 * parent object fills.
9927 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9929 * @brief Gets the parent object for the hover.
9931 * @param obj The hover object
9932 * @return The parent object to locate the hover over.
9934 * @see elm_hover_parent_set()
9936 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9938 * @brief Sets the content of the hover object and the direction in which it
9941 * @param obj The hover object
9942 * @param swallow The direction that the object will be displayed
9943 * at. Accepted values are "left", "top-left", "top", "top-right",
9944 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
9946 * @param content The content to place at @p swallow
9948 * Once the content object is set for a given direction, a previously
9949 * set one (on the same direction) will be deleted. If you want to
9950 * keep that old content object, use the elm_hover_content_unset()
9953 * All directions may have contents at the same time, except for
9954 * "smart". This is a special placement hint and its use case
9955 * independs of the calculations coming from
9956 * elm_hover_best_content_location_get(). Its use is for cases when
9957 * one desires only one hover content, but with a dinamic special
9958 * placement within the hover area. The content's geometry, whenever
9959 * it changes, will be used to decide on a best location not
9960 * extrapolating the hover's parent object view to show it in (still
9961 * being the hover's target determinant of its medium part -- move and
9962 * resize it to simulate finger sizes, for example). If one of the
9963 * directions other than "smart" are used, a previously content set
9964 * using it will be deleted, and vice-versa.
9966 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9968 * @brief Get the content of the hover object, in a given direction.
9970 * Return the content object which was set for this widget in the
9971 * @p swallow direction.
9973 * @param obj The hover object
9974 * @param swallow The direction that the object was display at.
9975 * @return The content that was being used
9977 * @see elm_hover_content_set()
9979 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9981 * @brief Unset the content of the hover object, in a given direction.
9983 * Unparent and return the content object set at @p swallow direction.
9985 * @param obj The hover object
9986 * @param swallow The direction that the object was display at.
9987 * @return The content that was being used.
9989 * @see elm_hover_content_set()
9991 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9993 * @brief Returns the best swallow location for content in the hover.
9995 * @param obj The hover object
9996 * @param pref_axis The preferred orientation axis for the hover object to use
9997 * @return The edje location to place content into the hover or @c
10000 * Best is defined here as the location at which there is the most available
10003 * @p pref_axis may be one of
10004 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10005 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10006 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10007 * - @c ELM_HOVER_AXIS_BOTH -- both
10009 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10010 * nescessarily be along the horizontal axis("left" or "right"). If
10011 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10012 * be along the vertical axis("top" or "bottom"). Chossing
10013 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10014 * returned position may be in either axis.
10016 * @see elm_hover_content_set()
10018 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10025 * @defgroup Entry Entry
10027 * @image html img/widget/entry/preview-00.png
10028 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10029 * @image html img/widget/entry/preview-01.png
10030 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10031 * @image html img/widget/entry/preview-02.png
10032 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10033 * @image html img/widget/entry/preview-03.png
10034 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10036 * An entry is a convenience widget which shows a box that the user can
10037 * enter text into. Entries by default don't scroll, so they grow to
10038 * accomodate the entire text, resizing the parent window as needed. This
10039 * can be changed with the elm_entry_scrollable_set() function.
10041 * They can also be single line or multi line (the default) and when set
10042 * to multi line mode they support text wrapping in any of the modes
10043 * indicated by #Elm_Wrap_Type.
10045 * Other features include password mode, filtering of inserted text with
10046 * elm_entry_text_filter_append() and related functions, inline "items" and
10047 * formatted markup text.
10049 * @section entry-markup Formatted text
10051 * The markup tags supported by the Entry are defined by the theme, but
10052 * even when writing new themes or extensions it's a good idea to stick to
10053 * a sane default, to maintain coherency and avoid application breakages.
10054 * Currently defined by the default theme are the following tags:
10055 * @li \<br\>: Inserts a line break.
10056 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10058 * @li \<tab\>: Inserts a tab.
10059 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10061 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10062 * @li \<link\>...\</link\>: Underlines the enclosed text.
10063 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10065 * @section entry-special Special markups
10067 * Besides those used to format text, entries support two special markup
10068 * tags used to insert clickable portions of text or items inlined within
10071 * @subsection entry-anchors Anchors
10073 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10074 * \</a\> tags and an event will be generated when this text is clicked,
10078 * This text is outside <a href=anc-01>but this one is an anchor</a>
10081 * The @c href attribute in the opening tag gives the name that will be
10082 * used to identify the anchor and it can be any valid utf8 string.
10084 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10085 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10086 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10087 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10090 * @subsection entry-items Items
10092 * Inlined in the text, any other @c Evas_Object can be inserted by using
10093 * \<item\> tags this way:
10096 * <item size=16x16 vsize=full href=emoticon/haha></item>
10099 * Just like with anchors, the @c href identifies each item, but these need,
10100 * in addition, to indicate their size, which is done using any one of
10101 * @c size, @c absize or @c relsize attributes. These attributes take their
10102 * value in the WxH format, where W is the width and H the height of the
10105 * @li absize: Absolute pixel size for the item. Whatever value is set will
10106 * be the item's size regardless of any scale value the object may have
10107 * been set to. The final line height will be adjusted to fit larger items.
10108 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10110 * @li relsize: Size is adjusted for the item to fit within the current
10113 * Besides their size, items are specificed a @c vsize value that affects
10114 * how their final size and position are calculated. The possible values
10116 * @li ascent: Item will be placed within the line's baseline and its
10117 * ascent. That is, the height between the line where all characters are
10118 * positioned and the highest point in the line. For @c size and @c absize
10119 * items, the descent value will be added to the total line height to make
10120 * them fit. @c relsize items will be adjusted to fit within this space.
10121 * @li full: Items will be placed between the descent and ascent, or the
10122 * lowest point in the line and its highest.
10124 * The next image shows different configurations of items and how they
10125 * are the previously mentioned options affect their sizes. In all cases,
10126 * the green line indicates the ascent, blue for the baseline and red for
10129 * @image html entry_item.png
10130 * @image latex entry_item.eps width=\textwidth
10132 * And another one to show how size differs from absize. In the first one,
10133 * the scale value is set to 1.0, while the second one is using one of 2.0.
10135 * @image html entry_item_scale.png
10136 * @image latex entry_item_scale.eps width=\textwidth
10138 * After the size for an item is calculated, the entry will request an
10139 * object to place in its space. For this, the functions set with
10140 * elm_entry_item_provider_append() and related functions will be called
10141 * in order until one of them returns a @c non-NULL value. If no providers
10142 * are available, or all of them return @c NULL, then the entry falls back
10143 * to one of the internal defaults, provided the name matches with one of
10146 * All of the following are currently supported:
10149 * - emoticon/angry-shout
10150 * - emoticon/crazy-laugh
10151 * - emoticon/evil-laugh
10153 * - emoticon/goggle-smile
10154 * - emoticon/grumpy
10155 * - emoticon/grumpy-smile
10156 * - emoticon/guilty
10157 * - emoticon/guilty-smile
10159 * - emoticon/half-smile
10160 * - emoticon/happy-panting
10162 * - emoticon/indifferent
10164 * - emoticon/knowing-grin
10166 * - emoticon/little-bit-sorry
10167 * - emoticon/love-lots
10169 * - emoticon/minimal-smile
10170 * - emoticon/not-happy
10171 * - emoticon/not-impressed
10173 * - emoticon/opensmile
10176 * - emoticon/squint-laugh
10177 * - emoticon/surprised
10178 * - emoticon/suspicious
10179 * - emoticon/tongue-dangling
10180 * - emoticon/tongue-poke
10182 * - emoticon/unhappy
10183 * - emoticon/very-sorry
10186 * - emoticon/worried
10189 * Alternatively, an item may reference an image by its path, using
10190 * the URI form @c file:///path/to/an/image.png and the entry will then
10191 * use that image for the item.
10193 * @section entry-files Loading and saving files
10195 * Entries have convinience functions to load text from a file and save
10196 * changes back to it after a short delay. The automatic saving is enabled
10197 * by default, but can be disabled with elm_entry_autosave_set() and files
10198 * can be loaded directly as plain text or have any markup in them
10199 * recognized. See elm_entry_file_set() for more details.
10201 * @section entry-signals Emitted signals
10203 * This widget emits the following signals:
10205 * @li "changed": The text within the entry was changed.
10206 * @li "changed,user": The text within the entry was changed because of user interaction.
10207 * @li "activated": The enter key was pressed on a single line entry.
10208 * @li "press": A mouse button has been pressed on the entry.
10209 * @li "longpressed": A mouse button has been pressed and held for a couple
10211 * @li "clicked": The entry has been clicked (mouse press and release).
10212 * @li "clicked,double": The entry has been double clicked.
10213 * @li "clicked,triple": The entry has been triple clicked.
10214 * @li "focused": The entry has received focus.
10215 * @li "unfocused": The entry has lost focus.
10216 * @li "selection,paste": A paste of the clipboard contents was requested.
10217 * @li "selection,copy": A copy of the selected text into the clipboard was
10219 * @li "selection,cut": A cut of the selected text into the clipboard was
10221 * @li "selection,start": A selection has begun and no previous selection
10223 * @li "selection,changed": The current selection has changed.
10224 * @li "selection,cleared": The current selection has been cleared.
10225 * @li "cursor,changed": The cursor has changed position.
10226 * @li "anchor,clicked": An anchor has been clicked. The event_info
10227 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10228 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10229 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10230 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10231 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10232 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10233 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10234 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10235 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10236 * @li "preedit,changed": The preedit string has changed.
10238 * @section entry-examples
10240 * An overview of the Entry API can be seen in @ref entry_example_01
10245 * @typedef Elm_Entry_Anchor_Info
10247 * The info sent in the callback for the "anchor,clicked" signals emitted
10250 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10252 * @struct _Elm_Entry_Anchor_Info
10254 * The info sent in the callback for the "anchor,clicked" signals emitted
10257 struct _Elm_Entry_Anchor_Info
10259 const char *name; /**< The name of the anchor, as stated in its href */
10260 int button; /**< The mouse button used to click on it */
10261 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10262 y, /**< Anchor geometry, relative to canvas */
10263 w, /**< Anchor geometry, relative to canvas */
10264 h; /**< Anchor geometry, relative to canvas */
10267 * @typedef Elm_Entry_Filter_Cb
10268 * This callback type is used by entry filters to modify text.
10269 * @param data The data specified as the last param when adding the filter
10270 * @param entry The entry object
10271 * @param text A pointer to the location of the text being filtered. This data can be modified,
10272 * but any additional allocations must be managed by the user.
10273 * @see elm_entry_text_filter_append
10274 * @see elm_entry_text_filter_prepend
10276 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10279 * This adds an entry to @p parent object.
10281 * By default, entries are:
10285 * @li autosave is enabled
10287 * @param parent The parent object
10288 * @return The new object or NULL if it cannot be created
10290 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10292 * Sets the entry to single line mode.
10294 * In single line mode, entries don't ever wrap when the text reaches the
10295 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10296 * key will generate an @c "activate" event instead of adding a new line.
10298 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10299 * and pressing enter will break the text into a different line
10300 * without generating any events.
10302 * @param obj The entry object
10303 * @param single_line If true, the text in the entry
10304 * will be on a single line.
10306 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10308 * Gets whether the entry is set to be single line.
10310 * @param obj The entry object
10311 * @return single_line If true, the text in the entry is set to display
10312 * on a single line.
10314 * @see elm_entry_single_line_set()
10316 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10318 * Sets the entry to password mode.
10320 * In password mode, entries are implicitly single line and the display of
10321 * any text in them is replaced with asterisks (*).
10323 * @param obj The entry object
10324 * @param password If true, password mode is enabled.
10326 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10328 * Gets whether the entry is set to password mode.
10330 * @param obj The entry object
10331 * @return If true, the entry is set to display all characters
10332 * as asterisks (*).
10334 * @see elm_entry_password_set()
10336 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10338 * This sets the text displayed within the entry to @p entry.
10340 * @param obj The entry object
10341 * @param entry The text to be displayed
10343 * @deprecated Use elm_object_text_set() instead.
10345 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10347 * This returns the text currently shown in object @p entry.
10348 * See also elm_entry_entry_set().
10350 * @param obj The entry object
10351 * @return The currently displayed text or NULL on failure
10353 * @deprecated Use elm_object_text_get() instead.
10355 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10357 * Appends @p entry to the text of the entry.
10359 * Adds the text in @p entry to the end of any text already present in the
10362 * The appended text is subject to any filters set for the widget.
10364 * @param obj The entry object
10365 * @param entry The text to be displayed
10367 * @see elm_entry_text_filter_append()
10369 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10371 * Gets whether the entry is empty.
10373 * Empty means no text at all. If there are any markup tags, like an item
10374 * tag for which no provider finds anything, and no text is displayed, this
10375 * function still returns EINA_FALSE.
10377 * @param obj The entry object
10378 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10380 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10382 * Gets any selected text within the entry.
10384 * If there's any selected text in the entry, this function returns it as
10385 * a string in markup format. NULL is returned if no selection exists or
10386 * if an error occurred.
10388 * The returned value points to an internal string and should not be freed
10389 * or modified in any way. If the @p entry object is deleted or its
10390 * contents are changed, the returned pointer should be considered invalid.
10392 * @param obj The entry object
10393 * @return The selected text within the entry or NULL on failure
10395 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10397 * Inserts the given text into the entry at the current cursor position.
10399 * This inserts text at the cursor position as if it was typed
10400 * by the user (note that this also allows markup which a user
10401 * can't just "type" as it would be converted to escaped text, so this
10402 * call can be used to insert things like emoticon items or bold push/pop
10403 * tags, other font and color change tags etc.)
10405 * If any selection exists, it will be replaced by the inserted text.
10407 * The inserted text is subject to any filters set for the widget.
10409 * @param obj The entry object
10410 * @param entry The text to insert
10412 * @see elm_entry_text_filter_append()
10414 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10416 * Set the line wrap type to use on multi-line entries.
10418 * Sets the wrap type used by the entry to any of the specified in
10419 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10420 * line (without inserting a line break or paragraph separator) when it
10421 * reaches the far edge of the widget.
10423 * Note that this only makes sense for multi-line entries. A widget set
10424 * to be single line will never wrap.
10426 * @param obj The entry object
10427 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10429 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10431 * Gets the wrap mode the entry was set to use.
10433 * @param obj The entry object
10434 * @return Wrap type
10436 * @see also elm_entry_line_wrap_set()
10438 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10440 * Sets if the entry is to be editable or not.
10442 * By default, entries are editable and when focused, any text input by the
10443 * user will be inserted at the current cursor position. But calling this
10444 * function with @p editable as EINA_FALSE will prevent the user from
10445 * inputting text into the entry.
10447 * The only way to change the text of a non-editable entry is to use
10448 * elm_object_text_set(), elm_entry_entry_insert() and other related
10451 * @param obj The entry object
10452 * @param editable If EINA_TRUE, user input will be inserted in the entry,
10453 * if not, the entry is read-only and no user input is allowed.
10455 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10457 * Gets whether the entry is editable or not.
10459 * @param obj The entry object
10460 * @return If true, the entry is editable by the user.
10461 * If false, it is not editable by the user
10463 * @see elm_entry_editable_set()
10465 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10467 * This drops any existing text selection within the entry.
10469 * @param obj The entry object
10471 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10473 * This selects all text within the entry.
10475 * @param obj The entry object
10477 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10479 * This moves the cursor one place to the right 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_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10486 * This moves the cursor one place to the left 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_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10493 * This moves the cursor one line up within the entry.
10495 * @param obj The entry object
10496 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10498 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10500 * This moves the cursor one line down within the entry.
10502 * @param obj The entry object
10503 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10505 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10507 * This moves the cursor to the beginning of the entry.
10509 * @param obj The entry object
10511 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10513 * This moves the cursor to the end of the entry.
10515 * @param obj The entry object
10517 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10519 * This moves the cursor to the beginning of the current line.
10521 * @param obj The entry object
10523 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10525 * This moves the cursor to the end of the current line.
10527 * @param obj The entry object
10529 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10531 * This begins a selection within the entry as though
10532 * the user were holding down the mouse button to make a selection.
10534 * @param obj The entry object
10536 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10538 * This ends a selection within the entry as though
10539 * the user had just released the mouse button while making a selection.
10541 * @param obj The entry object
10543 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10545 * Gets whether a format node exists at the current cursor position.
10547 * A format node is anything that defines how the text is rendered. It can
10548 * be a visible format node, such as a line break or a paragraph separator,
10549 * or an invisible one, such as bold begin or end tag.
10550 * This function returns whether any format node exists at the current
10553 * @param obj The entry object
10554 * @return EINA_TRUE if the current cursor position contains a format node,
10555 * EINA_FALSE otherwise.
10557 * @see elm_entry_cursor_is_visible_format_get()
10559 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10561 * Gets if the current cursor position holds a visible format node.
10563 * @param obj The entry object
10564 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10565 * if it's an invisible one or no format exists.
10567 * @see elm_entry_cursor_is_format_get()
10569 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10571 * Gets the character pointed by the cursor at its current position.
10573 * This function returns a string with the utf8 character stored at the
10574 * current cursor position.
10575 * Only the text is returned, any format that may exist will not be part
10576 * of the return value.
10578 * @param obj The entry object
10579 * @return The text pointed by the cursors.
10581 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10583 * This function returns the geometry of the cursor.
10585 * It's useful if you want to draw something on the cursor (or where it is),
10586 * or for example in the case of scrolled entry where you want to show the
10589 * @param obj The entry object
10590 * @param x returned geometry
10591 * @param y returned geometry
10592 * @param w returned geometry
10593 * @param h returned geometry
10594 * @return EINA_TRUE upon success, EINA_FALSE upon failure
10596 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);
10598 * Sets the cursor position in the entry to the given value
10600 * The value in @p pos is the index of the character position within the
10601 * contents of the string as returned by elm_entry_cursor_pos_get().
10603 * @param obj The entry object
10604 * @param pos The position of the cursor
10606 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10608 * Retrieves the current position of the cursor in the entry
10610 * @param obj The entry object
10611 * @return The cursor position
10613 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10615 * This executes a "cut" action on the selected text in the entry.
10617 * @param obj The entry object
10619 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10621 * This executes a "copy" action on the selected text in the entry.
10623 * @param obj The entry object
10625 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10627 * This executes a "paste" action in the entry.
10629 * @param obj The entry object
10631 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10633 * This clears and frees the items in a entry's contextual (longpress)
10636 * @param obj The entry object
10638 * @see elm_entry_context_menu_item_add()
10640 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10642 * This adds an item to the entry's contextual menu.
10644 * A longpress on an entry will make the contextual menu show up, if this
10645 * hasn't been disabled with elm_entry_context_menu_disabled_set().
10646 * By default, this menu provides a few options like enabling selection mode,
10647 * which is useful on embedded devices that need to be explicit about it,
10648 * and when a selection exists it also shows the copy and cut actions.
10650 * With this function, developers can add other options to this menu to
10651 * perform any action they deem necessary.
10653 * @param obj The entry object
10654 * @param label The item's text label
10655 * @param icon_file The item's icon file
10656 * @param icon_type The item's icon type
10657 * @param func The callback to execute when the item is clicked
10658 * @param data The data to associate with the item for related functions
10660 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);
10662 * This disables the entry's contextual (longpress) menu.
10664 * @param obj The entry object
10665 * @param disabled If true, the menu is disabled
10667 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10669 * This returns whether the entry's contextual (longpress) menu is
10672 * @param obj The entry object
10673 * @return If true, the menu is disabled
10675 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10677 * This appends a custom item provider to the list for that entry
10679 * This appends the given callback. The list is walked from beginning to end
10680 * with each function called given the item href string in the text. If the
10681 * function returns an object handle other than NULL (it should create an
10682 * object to do this), then this object is used to replace that item. If
10683 * not the next provider is called until one provides an item object, or the
10684 * default provider in entry does.
10686 * @param obj The entry object
10687 * @param func The function called to provide the item object
10688 * @param data The data passed to @p func
10690 * @see @ref entry-items
10692 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);
10694 * This prepends a custom item provider to the list for that entry
10696 * This prepends the given callback. See elm_entry_item_provider_append() for
10699 * @param obj The entry object
10700 * @param func The function called to provide the item object
10701 * @param data The data passed to @p func
10703 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);
10705 * This removes a custom item provider to the list for that entry
10707 * This removes the given callback. See elm_entry_item_provider_append() for
10710 * @param obj The entry object
10711 * @param func The function called to provide the item object
10712 * @param data The data passed to @p func
10714 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);
10716 * Append a filter function for text inserted in the entry
10718 * Append the given callback to the list. This functions will be called
10719 * whenever any text is inserted into the entry, with the text to be inserted
10720 * as a parameter. The callback function is free to alter the text in any way
10721 * it wants, but it must remember to free the given pointer and update it.
10722 * If the new text is to be discarded, the function can free it and set its
10723 * text parameter to NULL. This will also prevent any following filters from
10726 * @param obj The entry object
10727 * @param func The function to use as text filter
10728 * @param data User data to pass to @p func
10730 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10732 * Prepend a filter function for text insdrted in the entry
10734 * Prepend the given callback to the list. See elm_entry_text_filter_append()
10735 * for more information
10737 * @param obj The entry object
10738 * @param func The function to use as text filter
10739 * @param data User data to pass to @p func
10741 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10743 * Remove a filter from the list
10745 * Removes the given callback from the filter list. See
10746 * elm_entry_text_filter_append() for more information.
10748 * @param obj The entry object
10749 * @param func The filter function to remove
10750 * @param data The user data passed when adding the function
10752 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10754 * This converts a markup (HTML-like) string into UTF-8.
10756 * The returned string is a malloc'ed buffer and it should be freed when
10757 * not needed anymore.
10759 * @param s The string (in markup) to be converted
10760 * @return The converted string (in UTF-8). It should be freed.
10762 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10764 * This converts a UTF-8 string into markup (HTML-like).
10766 * The returned string is a malloc'ed buffer and it should be freed when
10767 * not needed anymore.
10769 * @param s The string (in UTF-8) to be converted
10770 * @return The converted string (in markup). It should be freed.
10772 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10774 * This sets the file (and implicitly loads it) for the text to display and
10775 * then edit. All changes are written back to the file after a short delay if
10776 * the entry object is set to autosave (which is the default).
10778 * If the entry had any other file set previously, any changes made to it
10779 * will be saved if the autosave feature is enabled, otherwise, the file
10780 * will be silently discarded and any non-saved changes will be lost.
10782 * @param obj The entry object
10783 * @param file The path to the file to load and save
10784 * @param format The file format
10786 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10788 * Gets the file being edited by the entry.
10790 * This function can be used to retrieve any file set on the entry for
10791 * edition, along with the format used to load and save it.
10793 * @param obj The entry object
10794 * @param file The path to the file to load and save
10795 * @param format The file format
10797 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10799 * This function writes any changes made to the file set with
10800 * elm_entry_file_set()
10802 * @param obj The entry object
10804 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10806 * This sets the entry object to 'autosave' the loaded text file or not.
10808 * @param obj The entry object
10809 * @param autosave Autosave the loaded file or not
10811 * @see elm_entry_file_set()
10813 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
10815 * This gets the entry object's 'autosave' status.
10817 * @param obj The entry object
10818 * @return Autosave the loaded file or not
10820 * @see elm_entry_file_set()
10822 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10824 * Control pasting of text and images for the widget.
10826 * Normally the entry allows both text and images to be pasted. By setting
10827 * textonly to be true, this prevents images from being pasted.
10829 * Note this only changes the behaviour of text.
10831 * @param obj The entry object
10832 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
10833 * text+image+other.
10835 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
10837 * Getting elm_entry text paste/drop mode.
10839 * In textonly mode, only text may be pasted or dropped into the widget.
10841 * @param obj The entry object
10842 * @return If the widget only accepts text from pastes.
10844 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10846 * Enable or disable scrolling in entry
10848 * Normally the entry is not scrollable unless you enable it with this call.
10850 * @param obj The entry object
10851 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
10853 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
10855 * Get the scrollable state of the entry
10857 * Normally the entry is not scrollable. This gets the scrollable state
10858 * of the entry. See elm_entry_scrollable_set() for more information.
10860 * @param obj The entry object
10861 * @return The scrollable state
10863 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
10865 * This sets a widget to be displayed to the left of a scrolled entry.
10867 * @param obj The scrolled entry object
10868 * @param icon The widget to display on the left side of the scrolled
10871 * @note A previously set widget will be destroyed.
10872 * @note If the object being set does not have minimum size hints set,
10873 * it won't get properly displayed.
10875 * @see elm_entry_end_set()
10877 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
10879 * Gets the leftmost widget of the scrolled entry. This object is
10880 * owned by the scrolled entry and should not be modified.
10882 * @param obj The scrolled entry object
10883 * @return the left widget inside the scroller
10885 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
10887 * Unset the leftmost widget of the scrolled entry, unparenting and
10890 * @param obj The scrolled entry object
10891 * @return the previously set icon sub-object of this entry, on
10894 * @see elm_entry_icon_set()
10896 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
10898 * Sets the visibility of the left-side widget of the scrolled entry,
10899 * set by elm_entry_icon_set().
10901 * @param obj The scrolled entry object
10902 * @param setting EINA_TRUE if the object should be displayed,
10903 * EINA_FALSE if not.
10905 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
10907 * This sets a widget to be displayed to the end of a scrolled entry.
10909 * @param obj The scrolled entry object
10910 * @param end The widget to display on the right side of the scrolled
10913 * @note A previously set widget will be destroyed.
10914 * @note If the object being set does not have minimum size hints set,
10915 * it won't get properly displayed.
10917 * @see elm_entry_icon_set
10919 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
10921 * Gets the endmost widget of the scrolled entry. This object is owned
10922 * by the scrolled entry and should not be modified.
10924 * @param obj The scrolled entry object
10925 * @return the right widget inside the scroller
10927 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
10929 * Unset the endmost widget of the scrolled entry, unparenting and
10932 * @param obj The scrolled entry object
10933 * @return the previously set icon sub-object of this entry, on
10936 * @see elm_entry_icon_set()
10938 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
10940 * Sets the visibility of the end widget of the scrolled entry, set by
10941 * elm_entry_end_set().
10943 * @param obj The scrolled entry object
10944 * @param setting EINA_TRUE if the object should be displayed,
10945 * EINA_FALSE if not.
10947 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
10949 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
10952 * Setting an entry to single-line mode with elm_entry_single_line_set()
10953 * will automatically disable the display of scrollbars when the entry
10954 * moves inside its scroller.
10956 * @param obj The scrolled entry object
10957 * @param h The horizontal scrollbar policy to apply
10958 * @param v The vertical scrollbar policy to apply
10960 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
10962 * This enables/disables bouncing within the entry.
10964 * This function sets whether the entry will bounce when scrolling reaches
10965 * the end of the contained entry.
10967 * @param obj The scrolled entry object
10968 * @param h The horizontal bounce state
10969 * @param v The vertical bounce state
10971 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
10973 * Get the bounce mode
10975 * @param obj The Entry object
10976 * @param h_bounce Allow bounce horizontally
10977 * @param v_bounce Allow bounce vertically
10979 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
10981 /* pre-made filters for entries */
10983 * @typedef Elm_Entry_Filter_Limit_Size
10985 * Data for the elm_entry_filter_limit_size() entry filter.
10987 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
10989 * @struct _Elm_Entry_Filter_Limit_Size
10991 * Data for the elm_entry_filter_limit_size() entry filter.
10993 struct _Elm_Entry_Filter_Limit_Size
10995 int max_char_count; /**< The maximum number of characters allowed. */
10996 int max_byte_count; /**< The maximum number of bytes allowed*/
10999 * Filter inserted text based on user defined character and byte limits
11001 * Add this filter to an entry to limit the characters that it will accept
11002 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11003 * The funtion works on the UTF-8 representation of the string, converting
11004 * it from the set markup, thus not accounting for any format in it.
11006 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11007 * it as data when setting the filter. In it, it's possible to set limits
11008 * by character count or bytes (any of them is disabled if 0), and both can
11009 * be set at the same time. In that case, it first checks for characters,
11012 * The function will cut the inserted text in order to allow only the first
11013 * number of characters that are still allowed. The cut is made in
11014 * characters, even when limiting by bytes, in order to always contain
11015 * valid ones and avoid half unicode characters making it in.
11017 * This filter, like any others, does not apply when setting the entry text
11018 * directly with elm_object_text_set() (or the deprecated
11019 * elm_entry_entry_set()).
11021 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11023 * @typedef Elm_Entry_Filter_Accept_Set
11025 * Data for the elm_entry_filter_accept_set() entry filter.
11027 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11029 * @struct _Elm_Entry_Filter_Accept_Set
11031 * Data for the elm_entry_filter_accept_set() entry filter.
11033 struct _Elm_Entry_Filter_Accept_Set
11035 const char *accepted; /**< Set of characters accepted in the entry. */
11036 const char *rejected; /**< Set of characters rejected from the entry. */
11039 * Filter inserted text based on accepted or rejected sets of characters
11041 * Add this filter to an entry to restrict the set of accepted characters
11042 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11043 * This structure contains both accepted and rejected sets, but they are
11044 * mutually exclusive.
11046 * The @c accepted set takes preference, so if it is set, the filter will
11047 * only work based on the accepted characters, ignoring anything in the
11048 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11050 * In both cases, the function filters by matching utf8 characters to the
11051 * raw markup text, so it can be used to remove formatting tags.
11053 * This filter, like any others, does not apply when setting the entry text
11054 * directly with elm_object_text_set() (or the deprecated
11055 * elm_entry_entry_set()).
11057 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11062 /* composite widgets - these basically put together basic widgets above
11063 * in convenient packages that do more than basic stuff */
11067 * @defgroup Anchorview Anchorview
11069 * @image html img/widget/anchorview/preview-00.png
11070 * @image latex img/widget/anchorview/preview-00.eps
11072 * Anchorview is for displaying text that contains markup with anchors
11073 * like <c>\<a href=1234\>something\</\></c> in it.
11075 * Besides being styled differently, the anchorview widget provides the
11076 * necessary functionality so that clicking on these anchors brings up a
11077 * popup with user defined content such as "call", "add to contacts" or
11078 * "open web page". This popup is provided using the @ref Hover widget.
11080 * This widget is very similar to @ref Anchorblock, so refer to that
11081 * widget for an example. The only difference Anchorview has is that the
11082 * widget is already provided with scrolling functionality, so if the
11083 * text set to it is too large to fit in the given space, it will scroll,
11084 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11085 * text can be displayed.
11087 * This widget emits the following signals:
11088 * @li "anchor,clicked": will be called when an anchor is clicked. The
11089 * @p event_info parameter on the callback will be a pointer of type
11090 * ::Elm_Entry_Anchorview_Info.
11092 * See @ref Anchorblock for an example on how to use both of them.
11101 * @typedef Elm_Entry_Anchorview_Info
11103 * The info sent in the callback for "anchor,clicked" signals emitted by
11104 * the Anchorview widget.
11106 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11108 * @struct _Elm_Entry_Anchorview_Info
11110 * The info sent in the callback for "anchor,clicked" signals emitted by
11111 * the Anchorview widget.
11113 struct _Elm_Entry_Anchorview_Info
11115 const char *name; /**< Name of the anchor, as indicated in its href
11117 int button; /**< The mouse button used to click on it */
11118 Evas_Object *hover; /**< The hover object to use for the popup */
11120 Evas_Coord x, y, w, h;
11121 } anchor, /**< Geometry selection of text used as anchor */
11122 hover_parent; /**< Geometry of the object used as parent by the
11124 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11125 for content on the left side of
11126 the hover. Before calling the
11127 callback, the widget will make the
11128 necessary calculations to check
11129 which sides are fit to be set with
11130 content, based on the position the
11131 hover is activated and its distance
11132 to the edges of its parent object
11134 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11135 the right side of the hover.
11136 See @ref hover_left */
11137 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11138 of the hover. See @ref hover_left */
11139 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11140 below the hover. See @ref
11144 * Add a new Anchorview object
11146 * @param parent The parent object
11147 * @return The new object or NULL if it cannot be created
11149 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11151 * Set the text to show in the anchorview
11153 * Sets the text of the anchorview to @p text. This text can include markup
11154 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11155 * text that will be specially styled and react to click events, ended with
11156 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11157 * "anchor,clicked" signal that you can attach a callback to with
11158 * evas_object_smart_callback_add(). The name of the anchor given in the
11159 * event info struct will be the one set in the href attribute, in this
11160 * case, anchorname.
11162 * Other markup can be used to style the text in different ways, but it's
11163 * up to the style defined in the theme which tags do what.
11164 * @deprecated use elm_object_text_set() instead.
11166 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11168 * Get the markup text set for the anchorview
11170 * Retrieves the text set on the anchorview, with markup tags included.
11172 * @param obj The anchorview object
11173 * @return The markup text set or @c NULL if nothing was set or an error
11175 * @deprecated use elm_object_text_set() instead.
11177 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11179 * Set the parent of the hover popup
11181 * Sets the parent object to use by the hover created by the anchorview
11182 * when an anchor is clicked. See @ref Hover for more details on this.
11183 * If no parent is set, the same anchorview object will be used.
11185 * @param obj The anchorview object
11186 * @param parent The object to use as parent for the hover
11188 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11190 * Get the parent of the hover popup
11192 * Get the object used as parent for the hover created by the anchorview
11193 * widget. See @ref Hover for more details on this.
11195 * @param obj The anchorview object
11196 * @return The object used as parent for the hover, NULL if none is set.
11198 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11200 * Set the style that the hover should use
11202 * When creating the popup hover, anchorview will request that it's
11203 * themed according to @p style.
11205 * @param obj The anchorview object
11206 * @param style The style to use for the underlying hover
11208 * @see elm_object_style_set()
11210 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11212 * Get the style that the hover should use
11214 * Get the style the hover created by anchorview will use.
11216 * @param obj The anchorview object
11217 * @return The style to use by the hover. NULL means the default is used.
11219 * @see elm_object_style_set()
11221 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11223 * Ends the hover popup in the anchorview
11225 * When an anchor is clicked, the anchorview widget will create a hover
11226 * object to use as a popup with user provided content. This function
11227 * terminates this popup, returning the anchorview to its normal state.
11229 * @param obj The anchorview object
11231 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11233 * Set bouncing behaviour when the scrolled content reaches an edge
11235 * Tell the internal scroller object whether it should bounce or not
11236 * when it reaches the respective edges for each axis.
11238 * @param obj The anchorview object
11239 * @param h_bounce Whether to bounce or not in the horizontal axis
11240 * @param v_bounce Whether to bounce or not in the vertical axis
11242 * @see elm_scroller_bounce_set()
11244 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11246 * Get the set bouncing behaviour of the internal scroller
11248 * Get whether the internal scroller should bounce when the edge of each
11249 * axis is reached scrolling.
11251 * @param obj The anchorview object
11252 * @param h_bounce Pointer where to store the bounce state of the horizontal
11254 * @param v_bounce Pointer where to store the bounce state of the vertical
11257 * @see elm_scroller_bounce_get()
11259 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11261 * Appends a custom item provider to the given anchorview
11263 * Appends the given function to the list of items providers. This list is
11264 * called, one function at a time, with the given @p data pointer, the
11265 * anchorview object and, in the @p item parameter, the item name as
11266 * referenced in its href string. Following functions in the list will be
11267 * called in order until one of them returns something different to NULL,
11268 * which should be an Evas_Object which will be used in place of the item
11271 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11272 * href=item/name\>\</item\>
11274 * @param obj The anchorview object
11275 * @param func The function to add to the list of providers
11276 * @param data User data that will be passed to the callback function
11278 * @see elm_entry_item_provider_append()
11280 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);
11282 * Prepend a custom item provider to the given anchorview
11284 * Like elm_anchorview_item_provider_append(), but it adds the function
11285 * @p func to the beginning of the list, instead of the end.
11287 * @param obj The anchorview object
11288 * @param func The function to add to the list of providers
11289 * @param data User data that will be passed to the callback function
11291 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);
11293 * Remove a custom item provider from the list of the given anchorview
11295 * Removes the function and data pairing that matches @p func and @p data.
11296 * That is, unless the same function and same user data are given, the
11297 * function will not be removed from the list. This allows us to add the
11298 * same callback several times, with different @p data pointers and be
11299 * able to remove them later without conflicts.
11301 * @param obj The anchorview object
11302 * @param func The function to remove from the list
11303 * @param data The data matching the function to remove from the list
11305 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);
11312 * @defgroup Anchorblock Anchorblock
11314 * @image html img/widget/anchorblock/preview-00.png
11315 * @image latex img/widget/anchorblock/preview-00.eps
11317 * Anchorblock is for displaying text that contains markup with anchors
11318 * like <c>\<a href=1234\>something\</\></c> in it.
11320 * Besides being styled differently, the anchorblock widget provides the
11321 * necessary functionality so that clicking on these anchors brings up a
11322 * popup with user defined content such as "call", "add to contacts" or
11323 * "open web page". This popup is provided using the @ref Hover widget.
11325 * This widget emits the following signals:
11326 * @li "anchor,clicked": will be called when an anchor is clicked. The
11327 * @p event_info parameter on the callback will be a pointer of type
11328 * ::Elm_Entry_Anchorblock_Info.
11334 * Since examples are usually better than plain words, we might as well
11335 * try @ref tutorial_anchorblock_example "one".
11338 * @addtogroup Anchorblock
11342 * @typedef Elm_Entry_Anchorblock_Info
11344 * The info sent in the callback for "anchor,clicked" signals emitted by
11345 * the Anchorblock widget.
11347 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11349 * @struct _Elm_Entry_Anchorblock_Info
11351 * The info sent in the callback for "anchor,clicked" signals emitted by
11352 * the Anchorblock widget.
11354 struct _Elm_Entry_Anchorblock_Info
11356 const char *name; /**< Name of the anchor, as indicated in its href
11358 int button; /**< The mouse button used to click on it */
11359 Evas_Object *hover; /**< The hover object to use for the popup */
11361 Evas_Coord x, y, w, h;
11362 } anchor, /**< Geometry selection of text used as anchor */
11363 hover_parent; /**< Geometry of the object used as parent by the
11365 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11366 for content on the left side of
11367 the hover. Before calling the
11368 callback, the widget will make the
11369 necessary calculations to check
11370 which sides are fit to be set with
11371 content, based on the position the
11372 hover is activated and its distance
11373 to the edges of its parent object
11375 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11376 the right side of the hover.
11377 See @ref hover_left */
11378 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11379 of the hover. See @ref hover_left */
11380 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11381 below the hover. See @ref
11385 * Add a new Anchorblock object
11387 * @param parent The parent object
11388 * @return The new object or NULL if it cannot be created
11390 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11392 * Set the text to show in the anchorblock
11394 * Sets the text of the anchorblock to @p text. This text can include markup
11395 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11396 * of text that will be specially styled and react to click events, ended
11397 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11398 * "anchor,clicked" signal that you can attach a callback to with
11399 * evas_object_smart_callback_add(). The name of the anchor given in the
11400 * event info struct will be the one set in the href attribute, in this
11401 * case, anchorname.
11403 * Other markup can be used to style the text in different ways, but it's
11404 * up to the style defined in the theme which tags do what.
11405 * @deprecated use elm_object_text_set() instead.
11407 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11409 * Get the markup text set for the anchorblock
11411 * Retrieves the text set on the anchorblock, with markup tags included.
11413 * @param obj The anchorblock object
11414 * @return The markup text set or @c NULL if nothing was set or an error
11416 * @deprecated use elm_object_text_set() instead.
11418 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11420 * Set the parent of the hover popup
11422 * Sets the parent object to use by the hover created by the anchorblock
11423 * when an anchor is clicked. See @ref Hover for more details on this.
11425 * @param obj The anchorblock object
11426 * @param parent The object to use as parent for the hover
11428 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11430 * Get the parent of the hover popup
11432 * Get the object used as parent for the hover created by the anchorblock
11433 * widget. See @ref Hover for more details on this.
11434 * If no parent is set, the same anchorblock object will be used.
11436 * @param obj The anchorblock object
11437 * @return The object used as parent for the hover, NULL if none is set.
11439 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11441 * Set the style that the hover should use
11443 * When creating the popup hover, anchorblock will request that it's
11444 * themed according to @p style.
11446 * @param obj The anchorblock object
11447 * @param style The style to use for the underlying hover
11449 * @see elm_object_style_set()
11451 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11453 * Get the style that the hover should use
11455 * Get the style the hover created by anchorblock will use.
11457 * @param obj The anchorblock object
11458 * @return The style to use by the hover. NULL means the default is used.
11460 * @see elm_object_style_set()
11462 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11464 * Ends the hover popup in the anchorblock
11466 * When an anchor is clicked, the anchorblock widget will create a hover
11467 * object to use as a popup with user provided content. This function
11468 * terminates this popup, returning the anchorblock to its normal state.
11470 * @param obj The anchorblock object
11472 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11474 * Appends a custom item provider to the given anchorblock
11476 * Appends the given function to the list of items providers. This list is
11477 * called, one function at a time, with the given @p data pointer, the
11478 * anchorblock object and, in the @p item parameter, the item name as
11479 * referenced in its href string. Following functions in the list will be
11480 * called in order until one of them returns something different to NULL,
11481 * which should be an Evas_Object which will be used in place of the item
11484 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11485 * href=item/name\>\</item\>
11487 * @param obj The anchorblock object
11488 * @param func The function to add to the list of providers
11489 * @param data User data that will be passed to the callback function
11491 * @see elm_entry_item_provider_append()
11493 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);
11495 * Prepend a custom item provider to the given anchorblock
11497 * Like elm_anchorblock_item_provider_append(), but it adds the function
11498 * @p func to the beginning of the list, instead of the end.
11500 * @param obj The anchorblock object
11501 * @param func The function to add to the list of providers
11502 * @param data User data that will be passed to the callback function
11504 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);
11506 * Remove a custom item provider from the list of the given anchorblock
11508 * Removes the function and data pairing that matches @p func and @p data.
11509 * That is, unless the same function and same user data are given, the
11510 * function will not be removed from the list. This allows us to add the
11511 * same callback several times, with different @p data pointers and be
11512 * able to remove them later without conflicts.
11514 * @param obj The anchorblock object
11515 * @param func The function to remove from the list
11516 * @param data The data matching the function to remove from the list
11518 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);
11524 * @defgroup Bubble Bubble
11526 * @image html img/widget/bubble/preview-00.png
11527 * @image latex img/widget/bubble/preview-00.eps
11528 * @image html img/widget/bubble/preview-01.png
11529 * @image latex img/widget/bubble/preview-01.eps
11530 * @image html img/widget/bubble/preview-02.png
11531 * @image latex img/widget/bubble/preview-02.eps
11533 * @brief The Bubble is a widget to show text similarly to how speech is
11534 * represented in comics.
11536 * The bubble widget contains 5 important visual elements:
11537 * @li The frame is a rectangle with rounded rectangles and an "arrow".
11538 * @li The @p icon is an image to which the frame's arrow points to.
11539 * @li The @p label is a text which appears to the right of the icon if the
11540 * corner is "top_left" or "bottom_left" and is right aligned to the frame
11542 * @li The @p info is a text which appears to the right of the label. Info's
11543 * font is of a ligther color than label.
11544 * @li The @p content is an evas object that is shown inside the frame.
11546 * The position of the arrow, icon, label and info depends on which corner is
11547 * selected. The four available corners are:
11548 * @li "top_left" - Default
11550 * @li "bottom_left"
11551 * @li "bottom_right"
11553 * Signals that you can add callbacks for are:
11554 * @li "clicked" - This is called when a user has clicked the bubble.
11556 * For an example of using a buble see @ref bubble_01_example_page "this".
11561 * Add a new bubble to the parent
11563 * @param parent The parent object
11564 * @return The new object or NULL if it cannot be created
11566 * This function adds a text bubble to the given parent evas object.
11568 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11570 * Set the label of the bubble
11572 * @param obj The bubble object
11573 * @param label The string to set in the label
11575 * This function sets the title of the bubble. Where this appears depends on
11576 * the selected corner.
11577 * @deprecated use elm_object_text_set() instead.
11579 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11581 * Get the label of the bubble
11583 * @param obj The bubble object
11584 * @return The string of set in the label
11586 * This function gets the title of the bubble.
11587 * @deprecated use elm_object_text_get() instead.
11589 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11591 * Set the info of the bubble
11593 * @param obj The bubble object
11594 * @param info The given info about the bubble
11596 * This function sets the info of the bubble. Where this appears depends on
11597 * the selected corner.
11598 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11600 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11602 * Get the info of the bubble
11604 * @param obj The bubble object
11606 * @return The "info" string of the bubble
11608 * This function gets the info text.
11609 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11611 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11613 * Set the content to be shown in the bubble
11615 * Once the content object is set, a previously set one will be deleted.
11616 * If you want to keep the old content object, use the
11617 * elm_bubble_content_unset() function.
11619 * @param obj The bubble object
11620 * @param content The given content of the bubble
11622 * This function sets the content shown on the middle of the bubble.
11624 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11626 * Get the content shown in the bubble
11628 * Return the content object which is set for this widget.
11630 * @param obj The bubble object
11631 * @return The content that is being used
11633 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11635 * Unset the content shown in the bubble
11637 * Unparent and return the content object which was set for this widget.
11639 * @param obj The bubble object
11640 * @return The content that was being used
11642 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11644 * Set the icon of the bubble
11646 * Once the icon object is set, a previously set one will be deleted.
11647 * If you want to keep the old content object, use the
11648 * elm_icon_content_unset() function.
11650 * @param obj The bubble object
11651 * @param icon The given icon for the bubble
11653 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11655 * Get the icon of the bubble
11657 * @param obj The bubble object
11658 * @return The icon for the bubble
11660 * This function gets the icon shown on the top left of bubble.
11662 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11664 * Unset the icon of the bubble
11666 * Unparent and return the icon object which was set for this widget.
11668 * @param obj The bubble object
11669 * @return The icon that was being used
11671 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11673 * Set the corner of the bubble
11675 * @param obj The bubble object.
11676 * @param corner The given corner for the bubble.
11678 * This function sets the corner of the bubble. The corner will be used to
11679 * determine where the arrow in the frame points to and where label, icon and
11682 * Possible values for corner are:
11683 * @li "top_left" - Default
11685 * @li "bottom_left"
11686 * @li "bottom_right"
11688 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11690 * Get the corner of the bubble
11692 * @param obj The bubble object.
11693 * @return The given corner for the bubble.
11695 * This function gets the selected corner of the bubble.
11697 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11703 * @defgroup Photo Photo
11705 * For displaying the photo of a person (contact). Simple yet
11706 * with a very specific purpose.
11708 * Signals that you can add callbacks for are:
11710 * "clicked" - This is called when a user has clicked the photo
11711 * "drag,start" - Someone started dragging the image out of the object
11712 * "drag,end" - Dragged item was dropped (somewhere)
11718 * Add a new photo to the parent
11720 * @param parent The parent object
11721 * @return The new object or NULL if it cannot be created
11725 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11728 * Set the file that will be used as photo
11730 * @param obj The photo object
11731 * @param file The path to file that will be used as photo
11733 * @return (1 = success, 0 = error)
11737 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11740 * Set the size that will be used on the photo
11742 * @param obj The photo object
11743 * @param size The size that the photo will be
11747 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11750 * Set if the photo should be completely visible or not.
11752 * @param obj The photo object
11753 * @param fill if true the photo will be completely visible
11757 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11760 * Set editability of the photo.
11762 * An editable photo can be dragged to or from, and can be cut or
11763 * pasted too. Note that pasting an image or dropping an item on
11764 * the image will delete the existing content.
11766 * @param obj The photo object.
11767 * @param set To set of clear editablity.
11769 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11775 /* gesture layer */
11777 * @defgroup Elm_Gesture_Layer Gesture Layer
11778 * Gesture Layer Usage:
11780 * Use Gesture Layer to detect gestures.
11781 * The advantage is that you don't have to implement
11782 * gesture detection, just set callbacks of gesture state.
11783 * By using gesture layer we make standard interface.
11785 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11786 * with a parent object parameter.
11787 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11788 * call. Usually with same object as target (2nd parameter).
11790 * Now you need to tell gesture layer what gestures you follow.
11791 * This is done with @ref elm_gesture_layer_cb_set call.
11792 * By setting the callback you actually saying to gesture layer:
11793 * I would like to know when the gesture @ref Elm_Gesture_Types
11794 * switches to state @ref Elm_Gesture_State.
11796 * Next, you need to implement the actual action that follows the input
11797 * in your callback.
11799 * Note that if you like to stop being reported about a gesture, just set
11800 * all callbacks referring this gesture to NULL.
11801 * (again with @ref elm_gesture_layer_cb_set)
11803 * The information reported by gesture layer to your callback is depending
11804 * on @ref Elm_Gesture_Types:
11805 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
11806 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
11807 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
11809 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
11810 * @ref ELM_GESTURE_MOMENTUM.
11812 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
11813 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
11814 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
11815 * Note that we consider a flick as a line-gesture that should be completed
11816 * in flick-time-limit as defined in @ref Config.
11818 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
11820 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
11824 * @enum _Elm_Gesture_Types
11825 * Enum of supported gesture types.
11826 * @ingroup Elm_Gesture_Layer
11828 enum _Elm_Gesture_Types
11830 ELM_GESTURE_FIRST = 0,
11832 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
11833 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
11834 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
11835 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
11837 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
11839 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
11840 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
11842 ELM_GESTURE_ZOOM, /**< Zoom */
11843 ELM_GESTURE_ROTATE, /**< Rotate */
11849 * @typedef Elm_Gesture_Types
11850 * gesture types enum
11851 * @ingroup Elm_Gesture_Layer
11853 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
11856 * @enum _Elm_Gesture_State
11857 * Enum of gesture states.
11858 * @ingroup Elm_Gesture_Layer
11860 enum _Elm_Gesture_State
11862 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
11863 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
11864 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
11865 ELM_GESTURE_STATE_END, /**< Gesture completed */
11866 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
11870 * @typedef Elm_Gesture_State
11871 * gesture states enum
11872 * @ingroup Elm_Gesture_Layer
11874 typedef enum _Elm_Gesture_State Elm_Gesture_State;
11877 * @struct _Elm_Gesture_Taps_Info
11878 * Struct holds taps info for user
11879 * @ingroup Elm_Gesture_Layer
11881 struct _Elm_Gesture_Taps_Info
11883 Evas_Coord x, y; /**< Holds center point between fingers */
11884 unsigned int n; /**< Number of fingers tapped */
11885 unsigned int timestamp; /**< event timestamp */
11889 * @typedef Elm_Gesture_Taps_Info
11890 * holds taps info for user
11891 * @ingroup Elm_Gesture_Layer
11893 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
11896 * @struct _Elm_Gesture_Momentum_Info
11897 * Struct holds momentum info for user
11898 * x1 and y1 are not necessarily in sync
11899 * x1 holds x value of x direction starting point
11900 * and same holds for y1.
11901 * This is noticeable when doing V-shape movement
11902 * @ingroup Elm_Gesture_Layer
11904 struct _Elm_Gesture_Momentum_Info
11905 { /* Report line ends, timestamps, and momentum computed */
11906 Evas_Coord x1; /**< Final-swipe direction starting point on X */
11907 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
11908 Evas_Coord x2; /**< Final-swipe direction ending point on X */
11909 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
11911 unsigned int tx; /**< Timestamp of start of final x-swipe */
11912 unsigned int ty; /**< Timestamp of start of final y-swipe */
11914 Evas_Coord mx; /**< Momentum on X */
11915 Evas_Coord my; /**< Momentum on Y */
11919 * @typedef Elm_Gesture_Momentum_Info
11920 * holds momentum info for user
11921 * @ingroup Elm_Gesture_Layer
11923 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
11926 * @struct _Elm_Gesture_Line_Info
11927 * Struct holds line info for user
11928 * @ingroup Elm_Gesture_Layer
11930 struct _Elm_Gesture_Line_Info
11931 { /* Report line ends, timestamps, and momentum computed */
11932 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
11933 unsigned int n; /**< Number of fingers (lines) */
11934 /* FIXME should be radians, bot degrees */
11935 double angle; /**< Angle (direction) of lines */
11939 * @typedef Elm_Gesture_Line_Info
11940 * Holds line info for user
11941 * @ingroup Elm_Gesture_Layer
11943 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
11946 * @struct _Elm_Gesture_Zoom_Info
11947 * Struct holds zoom info for user
11948 * @ingroup Elm_Gesture_Layer
11950 struct _Elm_Gesture_Zoom_Info
11952 Evas_Coord x, y; /**< Holds zoom center point reported to user */
11953 Evas_Coord radius; /**< Holds radius between fingers reported to user */
11954 double zoom; /**< Zoom value: 1.0 means no zoom */
11955 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
11959 * @typedef Elm_Gesture_Zoom_Info
11960 * Holds zoom info for user
11961 * @ingroup Elm_Gesture_Layer
11963 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
11966 * @struct _Elm_Gesture_Rotate_Info
11967 * Struct holds rotation info for user
11968 * @ingroup Elm_Gesture_Layer
11970 struct _Elm_Gesture_Rotate_Info
11972 Evas_Coord x, y; /**< Holds zoom center point reported to user */
11973 Evas_Coord radius; /**< Holds radius between fingers reported to user */
11974 double base_angle; /**< Holds start-angle */
11975 double angle; /**< Rotation value: 0.0 means no rotation */
11976 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
11980 * @typedef Elm_Gesture_Rotate_Info
11981 * Holds rotation info for user
11982 * @ingroup Elm_Gesture_Layer
11984 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
11987 * @typedef Elm_Gesture_Event_Cb
11988 * User callback used to stream gesture info from gesture layer
11989 * @param data user data
11990 * @param event_info gesture report info
11991 * Returns a flag field to be applied on the causing event.
11992 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
11993 * upon the event, in an irreversible way.
11995 * @ingroup Elm_Gesture_Layer
11997 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12000 * Use function to set callbacks to be notified about
12001 * change of state of gesture.
12002 * When a user registers a callback with this function
12003 * this means this gesture has to be tested.
12005 * When ALL callbacks for a gesture are set to NULL
12006 * it means user isn't interested in gesture-state
12007 * and it will not be tested.
12009 * @param obj Pointer to gesture-layer.
12010 * @param idx The gesture you would like to track its state.
12011 * @param cb callback function pointer.
12012 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12013 * @param data user info to be sent to callback (usually, Smart Data)
12015 * @ingroup Elm_Gesture_Layer
12017 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);
12020 * Call this function to get repeat-events settings.
12022 * @param obj Pointer to gesture-layer.
12024 * @return repeat events settings.
12025 * @see elm_gesture_layer_hold_events_set()
12026 * @ingroup Elm_Gesture_Layer
12028 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12031 * This function called in order to make gesture-layer repeat events.
12032 * Set this of you like to get the raw events only if gestures were not detected.
12033 * Clear this if you like gesture layer to fwd events as testing gestures.
12035 * @param obj Pointer to gesture-layer.
12036 * @param r Repeat: TRUE/FALSE
12038 * @ingroup Elm_Gesture_Layer
12040 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12043 * This function sets step-value for zoom action.
12044 * Set step to any positive value.
12045 * Cancel step setting by setting to 0.0
12047 * @param obj Pointer to gesture-layer.
12048 * @param s new zoom step value.
12050 * @ingroup Elm_Gesture_Layer
12052 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12055 * This function sets step-value for rotate action.
12056 * Set step to any positive value.
12057 * Cancel step setting by setting to 0.0
12059 * @param obj Pointer to gesture-layer.
12060 * @param s new roatate step value.
12062 * @ingroup Elm_Gesture_Layer
12064 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12067 * This function called to attach gesture-layer to an Evas_Object.
12068 * @param obj Pointer to gesture-layer.
12069 * @param t Pointer to underlying object (AKA Target)
12071 * @return TRUE, FALSE on success, failure.
12073 * @ingroup Elm_Gesture_Layer
12075 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12078 * Call this function to construct a new gesture-layer object.
12079 * This does not activate the gesture layer. You have to
12080 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12082 * @param parent the parent object.
12084 * @return Pointer to new gesture-layer object.
12086 * @ingroup Elm_Gesture_Layer
12088 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12091 * @defgroup Thumb Thumb
12093 * @image html img/widget/thumb/preview-00.png
12094 * @image latex img/widget/thumb/preview-00.eps
12096 * A thumb object is used for displaying the thumbnail of an image or video.
12097 * You must have compiled Elementary with Ethumb_Client support and the DBus
12098 * service must be present and auto-activated in order to have thumbnails to
12101 * Once the thumbnail object becomes visible, it will check if there is a
12102 * previously generated thumbnail image for the file set on it. If not, it
12103 * will start generating this thumbnail.
12105 * Different config settings will cause different thumbnails to be generated
12106 * even on the same file.
12108 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12109 * Ethumb documentation to change this path, and to see other configuration
12112 * Signals that you can add callbacks for are:
12114 * - "clicked" - This is called when a user has clicked the thumb without dragging
12116 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12117 * - "press" - This is called when a user has pressed down the thumb.
12118 * - "generate,start" - The thumbnail generation started.
12119 * - "generate,stop" - The generation process stopped.
12120 * - "generate,error" - The generation failed.
12121 * - "load,error" - The thumbnail image loading failed.
12123 * available styles:
12127 * An example of use of thumbnail:
12129 * - @ref thumb_example_01
12133 * @addtogroup Thumb
12138 * @enum _Elm_Thumb_Animation_Setting
12139 * @typedef Elm_Thumb_Animation_Setting
12141 * Used to set if a video thumbnail is animating or not.
12145 typedef enum _Elm_Thumb_Animation_Setting
12147 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12148 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12149 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12150 ELM_THUMB_ANIMATION_LAST
12151 } Elm_Thumb_Animation_Setting;
12154 * Add a new thumb object to the parent.
12156 * @param parent The parent object.
12157 * @return The new object or NULL if it cannot be created.
12159 * @see elm_thumb_file_set()
12160 * @see elm_thumb_ethumb_client_get()
12164 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12166 * Reload thumbnail if it was generated before.
12168 * @param obj The thumb object to reload
12170 * This is useful if the ethumb client configuration changed, like its
12171 * size, aspect or any other property one set in the handle returned
12172 * by elm_thumb_ethumb_client_get().
12174 * If the options didn't change, the thumbnail won't be generated again, but
12175 * the old one will still be used.
12177 * @see elm_thumb_file_set()
12181 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12183 * Set the file that will be used as thumbnail.
12185 * @param obj The thumb object.
12186 * @param file The path to file that will be used as thumb.
12187 * @param key The key used in case of an EET file.
12189 * The file can be an image or a video (in that case, acceptable extensions are:
12190 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12191 * function elm_thumb_animate().
12193 * @see elm_thumb_file_get()
12194 * @see elm_thumb_reload()
12195 * @see elm_thumb_animate()
12199 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12201 * Get the image or video path and key used to generate the thumbnail.
12203 * @param obj The thumb object.
12204 * @param file Pointer to filename.
12205 * @param key Pointer to key.
12207 * @see elm_thumb_file_set()
12208 * @see elm_thumb_path_get()
12212 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12214 * Get the path and key to the image or video generated by ethumb.
12216 * One just need to make sure that the thumbnail was generated before getting
12217 * its path; otherwise, the path will be NULL. One way to do that is by asking
12218 * for the path when/after the "generate,stop" smart callback is called.
12220 * @param obj The thumb object.
12221 * @param file Pointer to thumb path.
12222 * @param key Pointer to thumb key.
12224 * @see elm_thumb_file_get()
12228 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12230 * Set the animation state for the thumb object. If its content is an animated
12231 * video, you may start/stop the animation or tell it to play continuously and
12234 * @param obj The thumb object.
12235 * @param setting The animation setting.
12237 * @see elm_thumb_file_set()
12241 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12243 * Get the animation state for the thumb object.
12245 * @param obj The thumb object.
12246 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12249 * @see elm_thumb_animate_set()
12253 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12255 * Get the ethumb_client handle so custom configuration can be made.
12257 * @return Ethumb_Client instance or NULL.
12259 * This must be called before the objects are created to be sure no object is
12260 * visible and no generation started.
12262 * Example of usage:
12265 * #include <Elementary.h>
12266 * #ifndef ELM_LIB_QUICKLAUNCH
12268 * elm_main(int argc, char **argv)
12270 * Ethumb_Client *client;
12272 * elm_need_ethumb();
12276 * client = elm_thumb_ethumb_client_get();
12279 * ERR("could not get ethumb_client");
12282 * ethumb_client_size_set(client, 100, 100);
12283 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12286 * // Create elm_thumb objects here
12296 * @note There's only one client handle for Ethumb, so once a configuration
12297 * change is done to it, any other request for thumbnails (for any thumbnail
12298 * object) will use that configuration. Thus, this configuration is global.
12302 EAPI void *elm_thumb_ethumb_client_get(void);
12304 * Get the ethumb_client connection state.
12306 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12309 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12311 * Make the thumbnail 'editable'.
12313 * @param obj Thumb object.
12314 * @param set Turn on or off editability. Default is @c EINA_FALSE.
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_get()
12323 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12325 * Make the thumbnail 'editable'.
12327 * @param obj Thumb object.
12328 * @return Editability.
12330 * This means the thumbnail is a valid drag target for drag and drop, and can be
12331 * cut or pasted too.
12333 * @see elm_thumb_editable_set()
12337 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12344 * @defgroup Hoversel Hoversel
12346 * @image html img/widget/hoversel/preview-00.png
12347 * @image latex img/widget/hoversel/preview-00.eps
12349 * A hoversel is a button that pops up a list of items (automatically
12350 * choosing the direction to display) that have a label and, optionally, an
12351 * icon to select from. It is a convenience widget to avoid the need to do
12352 * all the piecing together yourself. It is intended for a small number of
12353 * items in the hoversel menu (no more than 8), though is capable of many
12356 * Signals that you can add callbacks for are:
12357 * "clicked" - the user clicked the hoversel button and popped up the sel
12358 * "selected" - an item in the hoversel list is selected. event_info is the item
12359 * "dismissed" - the hover is dismissed
12361 * See @ref tutorial_hoversel for an example.
12364 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12366 * @brief Add a new Hoversel object
12368 * @param parent The parent object
12369 * @return The new object or NULL if it cannot be created
12371 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12373 * @brief This sets the hoversel to expand horizontally.
12375 * @param obj The hoversel object
12376 * @param horizontal If true, the hover will expand horizontally to the
12379 * @note The initial button will display horizontally regardless of this
12382 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12384 * @brief This returns whether the hoversel is set to expand horizontally.
12386 * @param obj The hoversel object
12387 * @return If true, the hover will expand horizontally to the right.
12389 * @see elm_hoversel_horizontal_set()
12391 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12393 * @brief Set the Hover parent
12395 * @param obj The hoversel object
12396 * @param parent The parent to use
12398 * Sets the hover parent object, the area that will be darkened when the
12399 * hoversel is clicked. Should probably be the window that the hoversel is
12400 * in. See @ref Hover objects for more information.
12402 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12404 * @brief Get the Hover parent
12406 * @param obj The hoversel object
12407 * @return The used parent
12409 * Gets the hover parent object.
12411 * @see elm_hoversel_hover_parent_set()
12413 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12415 * @brief Set the hoversel button label
12417 * @param obj The hoversel object
12418 * @param label The label text.
12420 * This sets the label of the button that is always visible (before it is
12421 * clicked and expanded).
12423 * @deprecated elm_object_text_set()
12425 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12427 * @brief Get the hoversel button label
12429 * @param obj The hoversel object
12430 * @return The label text.
12432 * @deprecated elm_object_text_get()
12434 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12436 * @brief Set the icon of the hoversel button
12438 * @param obj The hoversel object
12439 * @param icon The icon object
12441 * Sets the icon of the button that is always visible (before it is clicked
12442 * and expanded). Once the icon object is set, a previously set one will be
12443 * deleted, if you want to keep that old content object, use the
12444 * elm_hoversel_icon_unset() function.
12446 * @see elm_button_icon_set()
12448 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12450 * @brief Get the icon of the hoversel button
12452 * @param obj The hoversel object
12453 * @return The icon object
12455 * Get the icon of the button that is always visible (before it is clicked
12456 * and expanded). Also see elm_button_icon_get().
12458 * @see elm_hoversel_icon_set()
12460 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12462 * @brief Get and unparent the icon of the hoversel button
12464 * @param obj The hoversel object
12465 * @return The icon object that was being used
12467 * Unparent and return the icon of the button that is always visible
12468 * (before it is clicked and expanded).
12470 * @see elm_hoversel_icon_set()
12471 * @see elm_button_icon_unset()
12473 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12475 * @brief This triggers the hoversel popup from code, the same as if the user
12476 * had clicked the button.
12478 * @param obj The hoversel object
12480 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12482 * @brief This dismisses the hoversel popup as if the user had clicked
12483 * outside the hover.
12485 * @param obj The hoversel object
12487 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12489 * @brief Returns whether the hoversel is expanded.
12491 * @param obj The hoversel object
12492 * @return This will return EINA_TRUE if the hoversel is expanded or
12493 * EINA_FALSE if it is not expanded.
12495 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12497 * @brief This will remove all the children items from the hoversel.
12499 * @param obj The hoversel object
12501 * @warning Should @b not be called while the hoversel is active; use
12502 * elm_hoversel_expanded_get() to check first.
12504 * @see elm_hoversel_item_del_cb_set()
12505 * @see elm_hoversel_item_del()
12507 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12509 * @brief Get the list of items within the given hoversel.
12511 * @param obj The hoversel object
12512 * @return Returns a list of Elm_Hoversel_Item*
12514 * @see elm_hoversel_item_add()
12516 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12518 * @brief Add an item to the hoversel button
12520 * @param obj The hoversel object
12521 * @param label The text label to use for the item (NULL if not desired)
12522 * @param icon_file An image file path on disk to use for the icon or standard
12523 * icon name (NULL if not desired)
12524 * @param icon_type The icon type if relevant
12525 * @param func Convenience function to call when this item is selected
12526 * @param data Data to pass to item-related functions
12527 * @return A handle to the item added.
12529 * This adds an item to the hoversel to show when it is clicked. Note: if you
12530 * need to use an icon from an edje file then use
12531 * elm_hoversel_item_icon_set() right after the this function, and set
12532 * icon_file to NULL here.
12534 * For more information on what @p icon_file and @p icon_type are see the
12535 * @ref Icon "icon documentation".
12537 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);
12539 * @brief Delete an item from the hoversel
12541 * @param item The item to delete
12543 * This deletes the item from the hoversel (should not be called while the
12544 * hoversel is active; use elm_hoversel_expanded_get() to check first).
12546 * @see elm_hoversel_item_add()
12547 * @see elm_hoversel_item_del_cb_set()
12549 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12551 * @brief Set the function to be called when an item from the hoversel is
12554 * @param item The item to set the callback on
12555 * @param func The function called
12557 * That function will receive these parameters:
12558 * @li void *item_data
12559 * @li Evas_Object *the_item_object
12560 * @li Elm_Hoversel_Item *the_object_struct
12562 * @see elm_hoversel_item_add()
12564 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12566 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12567 * that will be passed to associated function callbacks.
12569 * @param item The item to get the data from
12570 * @return The data pointer set with elm_hoversel_item_add()
12572 * @see elm_hoversel_item_add()
12574 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12576 * @brief This returns the label text of the given hoversel item.
12578 * @param item The item to get the label
12579 * @return The label text of the hoversel item
12581 * @see elm_hoversel_item_add()
12583 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12585 * @brief This sets the icon for the given hoversel item.
12587 * @param item The item to set the icon
12588 * @param icon_file An image file path on disk to use for the icon or standard
12590 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12591 * to NULL if the icon is not an edje file
12592 * @param icon_type The icon type
12594 * The icon can be loaded from the standard set, from an image file, or from
12597 * @see elm_hoversel_item_add()
12599 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);
12601 * @brief Get the icon object of the hoversel item
12603 * @param item The item to get the icon from
12604 * @param icon_file The image file path on disk used for the icon or standard
12606 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12607 * if the icon is not an edje file
12608 * @param icon_type The icon type
12610 * @see elm_hoversel_item_icon_set()
12611 * @see elm_hoversel_item_add()
12613 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);
12619 * @defgroup Toolbar Toolbar
12620 * @ingroup Elementary
12622 * @image html img/widget/toolbar/preview-00.png
12623 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12625 * @image html img/toolbar.png
12626 * @image latex img/toolbar.eps width=\textwidth
12628 * A toolbar is a widget that displays a list of items inside
12629 * a box. It can be scrollable, show a menu with items that don't fit
12630 * to toolbar size or even crop them.
12632 * Only one item can be selected at a time.
12634 * Items can have multiple states, or show menus when selected by the user.
12636 * Smart callbacks one can listen to:
12637 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12639 * Available styles for it:
12641 * - @c "transparent" - no background or shadow, just show the content
12643 * List of examples:
12644 * @li @ref toolbar_example_01
12645 * @li @ref toolbar_example_02
12646 * @li @ref toolbar_example_03
12650 * @addtogroup Toolbar
12655 * @enum _Elm_Toolbar_Shrink_Mode
12656 * @typedef Elm_Toolbar_Shrink_Mode
12658 * Set toolbar's items display behavior, it can be scrollabel,
12659 * show a menu with exceeding items, or simply hide them.
12661 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12664 * Values <b> don't </b> work as bitmask, only one can be choosen.
12666 * @see elm_toolbar_mode_shrink_set()
12667 * @see elm_toolbar_mode_shrink_get()
12671 typedef enum _Elm_Toolbar_Shrink_Mode
12673 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
12674 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
12675 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12676 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
12677 } Elm_Toolbar_Shrink_Mode;
12679 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(). */
12681 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(). */
12684 * Add a new toolbar widget to the given parent Elementary
12685 * (container) object.
12687 * @param parent The parent object.
12688 * @return a new toolbar widget handle or @c NULL, on errors.
12690 * This function inserts a new toolbar widget on the canvas.
12694 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12697 * Set the icon size, in pixels, to be used by toolbar items.
12699 * @param obj The toolbar object
12700 * @param icon_size The icon size in pixels
12702 * @note Default value is @c 32. It reads value from elm config.
12704 * @see elm_toolbar_icon_size_get()
12708 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12711 * Get the icon size, in pixels, to be used by toolbar items.
12713 * @param obj The toolbar object.
12714 * @return The icon size in pixels.
12716 * @see elm_toolbar_icon_size_set() for details.
12720 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12723 * Sets icon lookup order, for toolbar items' icons.
12725 * @param obj The toolbar object.
12726 * @param order The icon lookup order.
12728 * Icons added before calling this function will not be affected.
12729 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12731 * @see elm_toolbar_icon_order_lookup_get()
12735 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12738 * Gets the icon lookup order.
12740 * @param obj The toolbar object.
12741 * @return The icon lookup order.
12743 * @see elm_toolbar_icon_order_lookup_set() for details.
12747 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12750 * Set whether the toolbar items' should be selected by the user or not.
12752 * @param obj The toolbar object.
12753 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12756 * This will turn off the ability to select items entirely and they will
12757 * neither appear selected nor emit selected signals. The clicked
12758 * callback function will still be called.
12760 * Selection is enabled by default.
12762 * @see elm_toolbar_no_select_mode_get().
12766 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12769 * Set whether the toolbar items' should be selected by the user or not.
12771 * @param obj The toolbar object.
12772 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12773 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12775 * @see elm_toolbar_no_select_mode_set() for details.
12779 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12782 * Append item to the toolbar.
12784 * @param obj The toolbar object.
12785 * @param icon A string with icon name or the absolute path of an image file.
12786 * @param label The label of the item.
12787 * @param func The function to call when the item is clicked.
12788 * @param data The data to associate with the item for related callbacks.
12789 * @return The created item or @c NULL upon failure.
12791 * A new item will be created and appended to the toolbar, i.e., will
12792 * be set as @b last item.
12794 * Items created with this method can be deleted with
12795 * elm_toolbar_item_del().
12797 * Associated @p data can be properly freed when item is deleted if a
12798 * callback function is set with elm_toolbar_item_del_cb_set().
12800 * If a function is passed as argument, it will be called everytime this item
12801 * is selected, i.e., the user clicks over an unselected item.
12802 * If such function isn't needed, just passing
12803 * @c NULL as @p func is enough. The same should be done for @p data.
12805 * Toolbar will load icon image from fdo or current theme.
12806 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12807 * If an absolute path is provided it will load it direct from a file.
12809 * @see elm_toolbar_item_icon_set()
12810 * @see elm_toolbar_item_del()
12811 * @see elm_toolbar_item_del_cb_set()
12815 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);
12818 * Prepend item to the toolbar.
12820 * @param obj The toolbar object.
12821 * @param icon A string with icon name or the absolute path of an image file.
12822 * @param label The label of the item.
12823 * @param func The function to call when the item is clicked.
12824 * @param data The data to associate with the item for related callbacks.
12825 * @return The created item or @c NULL upon failure.
12827 * A new item will be created and prepended to the toolbar, i.e., will
12828 * be set as @b first item.
12830 * Items created with this method can be deleted with
12831 * elm_toolbar_item_del().
12833 * Associated @p data can be properly freed when item is deleted if a
12834 * callback function is set with elm_toolbar_item_del_cb_set().
12836 * If a function is passed as argument, it will be called everytime this item
12837 * is selected, i.e., the user clicks over an unselected item.
12838 * If such function isn't needed, just passing
12839 * @c NULL as @p func is enough. The same should be done for @p data.
12841 * Toolbar will load icon image from fdo or current theme.
12842 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12843 * If an absolute path is provided it will load it direct from a file.
12845 * @see elm_toolbar_item_icon_set()
12846 * @see elm_toolbar_item_del()
12847 * @see elm_toolbar_item_del_cb_set()
12851 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);
12854 * Insert a new item into the toolbar object before item @p before.
12856 * @param obj The toolbar object.
12857 * @param before The toolbar item to insert before.
12858 * @param icon A string with icon name or the absolute path of an image file.
12859 * @param label The label of the item.
12860 * @param func The function to call when the item is clicked.
12861 * @param data The data to associate with the item for related callbacks.
12862 * @return The created item or @c NULL upon failure.
12864 * A new item will be created and added to the toolbar. Its position in
12865 * this toolbar will be just before item @p before.
12867 * Items created with this method can be deleted with
12868 * elm_toolbar_item_del().
12870 * Associated @p data can be properly freed when item is deleted if a
12871 * callback function is set with elm_toolbar_item_del_cb_set().
12873 * If a function is passed as argument, it will be called everytime this item
12874 * is selected, i.e., the user clicks over an unselected item.
12875 * If such function isn't needed, just passing
12876 * @c NULL as @p func is enough. The same should be done for @p data.
12878 * Toolbar will load icon image from fdo or current theme.
12879 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12880 * If an absolute path is provided it will load it direct from a file.
12882 * @see elm_toolbar_item_icon_set()
12883 * @see elm_toolbar_item_del()
12884 * @see elm_toolbar_item_del_cb_set()
12888 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);
12891 * Insert a new item into the toolbar object after item @p after.
12893 * @param obj The toolbar object.
12894 * @param before The toolbar item to insert before.
12895 * @param icon A string with icon name or the absolute path of an image file.
12896 * @param label The label of the item.
12897 * @param func The function to call when the item is clicked.
12898 * @param data The data to associate with the item for related callbacks.
12899 * @return The created item or @c NULL upon failure.
12901 * A new item will be created and added to the toolbar. Its position in
12902 * this toolbar will be just after item @p after.
12904 * Items created with this method can be deleted with
12905 * elm_toolbar_item_del().
12907 * Associated @p data can be properly freed when item is deleted if a
12908 * callback function is set with elm_toolbar_item_del_cb_set().
12910 * If a function is passed as argument, it will be called everytime this item
12911 * is selected, i.e., the user clicks over an unselected item.
12912 * If such function isn't needed, just passing
12913 * @c NULL as @p func is enough. The same should be done for @p data.
12915 * Toolbar will load icon image from fdo or current theme.
12916 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12917 * If an absolute path is provided it will load it direct from a file.
12919 * @see elm_toolbar_item_icon_set()
12920 * @see elm_toolbar_item_del()
12921 * @see elm_toolbar_item_del_cb_set()
12925 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);
12928 * Get the first item in the given toolbar widget's list of
12931 * @param obj The toolbar object
12932 * @return The first item or @c NULL, if it has no items (and on
12935 * @see elm_toolbar_item_append()
12936 * @see elm_toolbar_last_item_get()
12940 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12943 * Get the last item in the given toolbar widget's list of
12946 * @param obj The toolbar object
12947 * @return The last item or @c NULL, if it has no items (and on
12950 * @see elm_toolbar_item_prepend()
12951 * @see elm_toolbar_first_item_get()
12955 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12958 * Get the item after @p item in toolbar.
12960 * @param item The toolbar item.
12961 * @return The item after @p item, or @c NULL if none or on failure.
12963 * @note If it is the last item, @c NULL will be returned.
12965 * @see elm_toolbar_item_append()
12969 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12972 * Get the item before @p item in toolbar.
12974 * @param item The toolbar item.
12975 * @return The item before @p item, or @c NULL if none or on failure.
12977 * @note If it is the first item, @c NULL will be returned.
12979 * @see elm_toolbar_item_prepend()
12983 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12986 * Get the toolbar object from an item.
12988 * @param item The item.
12989 * @return The toolbar object.
12991 * This returns the toolbar object itself that an item belongs to.
12995 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12998 * Set the priority of a toolbar item.
13000 * @param item The toolbar item.
13001 * @param priority The item priority. The default is zero.
13003 * This is used only when the toolbar shrink mode is set to
13004 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13005 * When space is less than required, items with low priority
13006 * will be removed from the toolbar and added to a dynamically-created menu,
13007 * while items with higher priority will remain on the toolbar,
13008 * with the same order they were added.
13010 * @see elm_toolbar_item_priority_get()
13014 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13017 * Get the priority of a toolbar item.
13019 * @param item The toolbar item.
13020 * @return The @p item priority, or @c 0 on failure.
13022 * @see elm_toolbar_item_priority_set() for details.
13026 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13029 * Get the label of item.
13031 * @param item The item of toolbar.
13032 * @return The label of item.
13034 * The return value is a pointer to the label associated to @p item when
13035 * it was created, with function elm_toolbar_item_append() or similar,
13037 * with function elm_toolbar_item_label_set. If no label
13038 * was passed as argument, it will return @c NULL.
13040 * @see elm_toolbar_item_label_set() for more details.
13041 * @see elm_toolbar_item_append()
13045 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13048 * Set the label of item.
13050 * @param item The item of toolbar.
13051 * @param text The label of item.
13053 * The label to be displayed by the item.
13054 * Label will be placed at icons bottom (if set).
13056 * If a label was passed as argument on item creation, with function
13057 * elm_toolbar_item_append() or similar, it will be already
13058 * displayed by the item.
13060 * @see elm_toolbar_item_label_get()
13061 * @see elm_toolbar_item_append()
13065 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13068 * Return the data associated with a given toolbar widget item.
13070 * @param item The toolbar widget item handle.
13071 * @return The data associated with @p item.
13073 * @see elm_toolbar_item_data_set()
13077 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13080 * Set the data associated with a given toolbar widget item.
13082 * @param item The toolbar widget item handle.
13083 * @param data The new data pointer to set to @p item.
13085 * This sets new item data on @p item.
13087 * @warning The old data pointer won't be touched by this function, so
13088 * the user had better to free that old data himself/herself.
13092 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13095 * Returns a pointer to a toolbar item by its label.
13097 * @param obj The toolbar object.
13098 * @param label The label of the item to find.
13100 * @return The pointer to the toolbar item matching @p label or @c NULL
13105 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13108 * Get whether the @p item is selected or not.
13110 * @param item The toolbar item.
13111 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13112 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13114 * @see elm_toolbar_selected_item_set() for details.
13115 * @see elm_toolbar_item_selected_get()
13119 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13122 * Set the selected state of an item.
13124 * @param item The toolbar item
13125 * @param selected The selected state
13127 * This sets the selected state of the given item @p it.
13128 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13130 * If a new item is selected the previosly selected will be unselected.
13131 * Previoulsy selected item can be get with function
13132 * elm_toolbar_selected_item_get().
13134 * Selected items will be highlighted.
13136 * @see elm_toolbar_item_selected_get()
13137 * @see elm_toolbar_selected_item_get()
13141 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13144 * Get the selected item.
13146 * @param obj The toolbar object.
13147 * @return The selected toolbar item.
13149 * The selected item can be unselected with function
13150 * elm_toolbar_item_selected_set().
13152 * The selected item always will be highlighted on toolbar.
13154 * @see elm_toolbar_selected_items_get()
13158 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13161 * Set the icon associated with @p item.
13163 * @param obj The parent of this item.
13164 * @param item The toolbar item.
13165 * @param icon A string with icon name or the absolute path of an image file.
13167 * Toolbar will load icon image from fdo or current theme.
13168 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13169 * If an absolute path is provided it will load it direct from a file.
13171 * @see elm_toolbar_icon_order_lookup_set()
13172 * @see elm_toolbar_icon_order_lookup_get()
13176 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13179 * Get the string used to set the icon of @p item.
13181 * @param item The toolbar item.
13182 * @return The string associated with the icon object.
13184 * @see elm_toolbar_item_icon_set() for details.
13188 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13191 * Delete them item from the toolbar.
13193 * @param item The item of toolbar to be deleted.
13195 * @see elm_toolbar_item_append()
13196 * @see elm_toolbar_item_del_cb_set()
13200 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13203 * Set the function called when a toolbar item is freed.
13205 * @param item The item to set the callback on.
13206 * @param func The function called.
13208 * If there is a @p func, then it will be called prior item's memory release.
13209 * That will be called with the following arguments:
13211 * @li item's Evas object;
13214 * This way, a data associated to a toolbar item could be properly freed.
13218 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13221 * Get a value whether toolbar item is disabled or not.
13223 * @param item The item.
13224 * @return The disabled state.
13226 * @see elm_toolbar_item_disabled_set() for more details.
13230 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13233 * Sets the disabled/enabled state of a toolbar item.
13235 * @param item The item.
13236 * @param disabled The disabled state.
13238 * A disabled item cannot be selected or unselected. It will also
13239 * change its appearance (generally greyed out). This sets the
13240 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13245 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13248 * Set or unset item as a separator.
13250 * @param item The toolbar item.
13251 * @param setting @c EINA_TRUE to set item @p item as separator or
13252 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13254 * Items aren't set as separator by default.
13256 * If set as separator it will display separator theme, so won't display
13259 * @see elm_toolbar_item_separator_get()
13263 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13266 * Get a value whether item is a separator or not.
13268 * @param item The toolbar item.
13269 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13270 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13272 * @see elm_toolbar_item_separator_set() for details.
13276 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13279 * Set the shrink state of toolbar @p obj.
13281 * @param obj The toolbar object.
13282 * @param shrink_mode Toolbar's items display behavior.
13284 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13285 * but will enforce a minimun size so all the items will fit, won't scroll
13286 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13287 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13288 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13292 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13295 * Get the shrink mode of toolbar @p obj.
13297 * @param obj The toolbar object.
13298 * @return Toolbar's items display behavior.
13300 * @see elm_toolbar_mode_shrink_set() for details.
13304 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13307 * Enable/disable homogenous mode.
13309 * @param obj The toolbar object
13310 * @param homogeneous Assume the items within the toolbar are of the
13311 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13313 * This will enable the homogeneous mode where items are of the same size.
13314 * @see elm_toolbar_homogeneous_get()
13318 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13321 * Get whether the homogenous mode is enabled.
13323 * @param obj The toolbar object.
13324 * @return Assume the items within the toolbar are of the same height
13325 * and width (EINA_TRUE = on, EINA_FALSE = off).
13327 * @see elm_toolbar_homogeneous_set()
13331 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13334 * Enable/disable homogenous mode.
13336 * @param obj The toolbar object
13337 * @param homogeneous Assume the items within the toolbar are of the
13338 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13340 * This will enable the homogeneous mode where items are of the same size.
13341 * @see elm_toolbar_homogeneous_get()
13343 * @deprecated use elm_toolbar_homogeneous_set() instead.
13347 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13350 * Get whether the homogenous mode is enabled.
13352 * @param obj The toolbar object.
13353 * @return Assume the items within the toolbar are of the same height
13354 * and width (EINA_TRUE = on, EINA_FALSE = off).
13356 * @see elm_toolbar_homogeneous_set()
13357 * @deprecated use elm_toolbar_homogeneous_get() instead.
13361 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13364 * Set the parent object of the toolbar items' menus.
13366 * @param obj The toolbar object.
13367 * @param parent The parent of the menu objects.
13369 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13371 * For more details about setting the parent for toolbar menus, see
13372 * elm_menu_parent_set().
13374 * @see elm_menu_parent_set() for details.
13375 * @see elm_toolbar_item_menu_set() for details.
13379 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13382 * Get the parent object of the toolbar items' menus.
13384 * @param obj The toolbar object.
13385 * @return The parent of the menu objects.
13387 * @see elm_toolbar_menu_parent_set() for details.
13391 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13394 * Set the alignment of the items.
13396 * @param obj The toolbar object.
13397 * @param align The new alignment, a float between <tt> 0.0 </tt>
13398 * and <tt> 1.0 </tt>.
13400 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13401 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13404 * Centered items by default.
13406 * @see elm_toolbar_align_get()
13410 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13413 * Get the alignment of the items.
13415 * @param obj The toolbar object.
13416 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13419 * @see elm_toolbar_align_set() for details.
13423 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13426 * Set whether the toolbar item opens a menu.
13428 * @param item The toolbar item.
13429 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13431 * A toolbar item can be set to be a menu, using this function.
13433 * Once it is set to be a menu, it can be manipulated through the
13434 * menu-like function elm_toolbar_menu_parent_set() and the other
13435 * elm_menu functions, using the Evas_Object @c menu returned by
13436 * elm_toolbar_item_menu_get().
13438 * So, items to be displayed in this item's menu should be added with
13439 * elm_menu_item_add().
13441 * The following code exemplifies the most basic usage:
13443 * tb = elm_toolbar_add(win)
13444 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13445 * elm_toolbar_item_menu_set(item, EINA_TRUE);
13446 * elm_toolbar_menu_parent_set(tb, win);
13447 * menu = elm_toolbar_item_menu_get(item);
13448 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13449 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13453 * @see elm_toolbar_item_menu_get()
13457 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13460 * Get toolbar item's menu.
13462 * @param item The toolbar item.
13463 * @return Item's menu object or @c NULL on failure.
13465 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13466 * this function will set it.
13468 * @see elm_toolbar_item_menu_set() for details.
13472 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13475 * Add a new state to @p item.
13477 * @param item The item.
13478 * @param icon A string with icon name or the absolute path of an image file.
13479 * @param label The label of the new state.
13480 * @param func The function to call when the item is clicked when this
13481 * state is selected.
13482 * @param data The data to associate with the state.
13483 * @return The toolbar item state, or @c NULL upon failure.
13485 * Toolbar will load icon image from fdo or current theme.
13486 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13487 * If an absolute path is provided it will load it direct from a file.
13489 * States created with this function can be removed with
13490 * elm_toolbar_item_state_del().
13492 * @see elm_toolbar_item_state_del()
13493 * @see elm_toolbar_item_state_sel()
13494 * @see elm_toolbar_item_state_get()
13498 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);
13501 * Delete a previoulsy added state to @p item.
13503 * @param item The toolbar item.
13504 * @param state The state to be deleted.
13505 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13507 * @see elm_toolbar_item_state_add()
13509 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13512 * Set @p state as the current state of @p it.
13514 * @param it The item.
13515 * @param state The state to use.
13516 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13518 * If @p state is @c NULL, it won't select any state and the default item's
13519 * icon and label will be used. It's the same behaviour than
13520 * elm_toolbar_item_state_unser().
13522 * @see elm_toolbar_item_state_unset()
13526 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13529 * Unset the state of @p it.
13531 * @param it The item.
13533 * The default icon and label from this item will be displayed.
13535 * @see elm_toolbar_item_state_set() for more details.
13539 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13542 * Get the current state of @p it.
13544 * @param item The item.
13545 * @return The selected state or @c NULL if none is selected or on failure.
13547 * @see elm_toolbar_item_state_set() for details.
13548 * @see elm_toolbar_item_state_unset()
13549 * @see elm_toolbar_item_state_add()
13553 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13556 * Get the state after selected state in toolbar's @p item.
13558 * @param it The toolbar item to change state.
13559 * @return The state after current state, or @c NULL on failure.
13561 * If last state is selected, this function will return first state.
13563 * @see elm_toolbar_item_state_set()
13564 * @see elm_toolbar_item_state_add()
13568 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13571 * Get the state before selected state in toolbar's @p item.
13573 * @param it The toolbar item to change state.
13574 * @return The state before current state, or @c NULL on failure.
13576 * If first state is selected, this function will return last state.
13578 * @see elm_toolbar_item_state_set()
13579 * @see elm_toolbar_item_state_add()
13583 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13586 * Set the text to be shown in a given toolbar item's tooltips.
13588 * @param item Target item.
13589 * @param text The text to set in the content.
13591 * Setup the text as tooltip to object. The item can have only one tooltip,
13592 * so any previous tooltip data - set with this function or
13593 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13595 * @see elm_object_tooltip_text_set() for more details.
13599 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13602 * Set the content to be shown in the tooltip item.
13604 * Setup the tooltip to item. The item can have only one tooltip,
13605 * so any previous tooltip data is removed. @p func(with @p data) will
13606 * be called every time that need show the tooltip and it should
13607 * return a valid Evas_Object. This object is then managed fully by
13608 * tooltip system and is deleted when the tooltip is gone.
13610 * @param item the toolbar item being attached a tooltip.
13611 * @param func the function used to create the tooltip contents.
13612 * @param data what to provide to @a func as callback data/context.
13613 * @param del_cb called when data is not needed anymore, either when
13614 * another callback replaces @a func, the tooltip is unset with
13615 * elm_toolbar_item_tooltip_unset() or the owner @a item
13616 * dies. This callback receives as the first parameter the
13617 * given @a data, and @c event_info is the item.
13619 * @see elm_object_tooltip_content_cb_set() for more details.
13623 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);
13626 * Unset tooltip from item.
13628 * @param item toolbar item to remove previously set tooltip.
13630 * Remove tooltip from item. The callback provided as del_cb to
13631 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13632 * it is not used anymore.
13634 * @see elm_object_tooltip_unset() for more details.
13635 * @see elm_toolbar_item_tooltip_content_cb_set()
13639 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13642 * Sets a different style for this item tooltip.
13644 * @note before you set a style you should define a tooltip with
13645 * elm_toolbar_item_tooltip_content_cb_set() or
13646 * elm_toolbar_item_tooltip_text_set()
13648 * @param item toolbar item with tooltip already set.
13649 * @param style the theme style to use (default, transparent, ...)
13651 * @see elm_object_tooltip_style_set() for more details.
13655 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13658 * Get the style for this item tooltip.
13660 * @param item toolbar item with tooltip already set.
13661 * @return style the theme style in use, defaults to "default". If the
13662 * object does not have a tooltip set, then NULL is returned.
13664 * @see elm_object_tooltip_style_get() for more details.
13665 * @see elm_toolbar_item_tooltip_style_set()
13669 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13672 * Set the type of mouse pointer/cursor decoration to be shown,
13673 * when the mouse pointer is over the given toolbar widget item
13675 * @param item toolbar item to customize cursor on
13676 * @param cursor the cursor type's name
13678 * This function works analogously as elm_object_cursor_set(), but
13679 * here the cursor's changing area is restricted to the item's
13680 * area, and not the whole widget's. Note that that item cursors
13681 * have precedence over widget cursors, so that a mouse over an
13682 * item with custom cursor set will always show @b that cursor.
13684 * If this function is called twice for an object, a previously set
13685 * cursor will be unset on the second call.
13687 * @see elm_object_cursor_set()
13688 * @see elm_toolbar_item_cursor_get()
13689 * @see elm_toolbar_item_cursor_unset()
13693 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13696 * Get the type of mouse pointer/cursor decoration set to be shown,
13697 * when the mouse pointer is over the given toolbar widget item
13699 * @param item toolbar item with custom cursor set
13700 * @return the cursor type's name or @c NULL, if no custom cursors
13701 * were set to @p item (and on errors)
13703 * @see elm_object_cursor_get()
13704 * @see elm_toolbar_item_cursor_set()
13705 * @see elm_toolbar_item_cursor_unset()
13709 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13712 * Unset any custom mouse pointer/cursor decoration set to be
13713 * shown, when the mouse pointer is over the given toolbar widget
13714 * item, thus making it show the @b default cursor again.
13716 * @param item a toolbar item
13718 * Use this call to undo any custom settings on this item's cursor
13719 * decoration, bringing it back to defaults (no custom style set).
13721 * @see elm_object_cursor_unset()
13722 * @see elm_toolbar_item_cursor_set()
13726 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13729 * Set a different @b style for a given custom cursor set for a
13732 * @param item toolbar item with custom cursor set
13733 * @param style the <b>theme style</b> to use (e.g. @c "default",
13734 * @c "transparent", etc)
13736 * This function only makes sense when one is using custom mouse
13737 * cursor decorations <b>defined in a theme file</b>, which can have,
13738 * given a cursor name/type, <b>alternate styles</b> on it. It
13739 * works analogously as elm_object_cursor_style_set(), but here
13740 * applyed only to toolbar item objects.
13742 * @warning Before you set a cursor style you should have definen a
13743 * custom cursor previously on the item, with
13744 * elm_toolbar_item_cursor_set()
13746 * @see elm_toolbar_item_cursor_engine_only_set()
13747 * @see elm_toolbar_item_cursor_style_get()
13751 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13754 * Get the current @b style set for a given toolbar item's custom
13757 * @param item toolbar item with custom cursor set.
13758 * @return style the cursor style in use. If the object does not
13759 * have a cursor set, then @c NULL is returned.
13761 * @see elm_toolbar_item_cursor_style_set() for more details
13765 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13768 * Set if the (custom)cursor for a given toolbar item should be
13769 * searched in its theme, also, or should only rely on the
13770 * rendering engine.
13772 * @param item item with custom (custom) cursor already set on
13773 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13774 * only on those provided by the rendering engine, @c EINA_FALSE to
13775 * have them searched on the widget's theme, as well.
13777 * @note This call is of use only if you've set a custom cursor
13778 * for toolbar items, with elm_toolbar_item_cursor_set().
13780 * @note By default, cursors will only be looked for between those
13781 * provided by the rendering engine.
13785 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13788 * Get if the (custom) cursor for a given toolbar item is being
13789 * searched in its theme, also, or is only relying on the rendering
13792 * @param item a toolbar item
13793 * @return @c EINA_TRUE, if cursors are being looked for only on
13794 * those provided by the rendering engine, @c EINA_FALSE if they
13795 * are being searched on the widget's theme, as well.
13797 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13801 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13804 * Change a toolbar's orientation
13805 * @param obj The toolbar object
13806 * @param vertical If @c EINA_TRUE, the toolbar is vertical
13807 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
13810 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
13813 * Get a toolbar's orientation
13814 * @param obj The toolbar object
13815 * @return If @c EINA_TRUE, the toolbar is vertical
13816 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
13819 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13826 * @defgroup Tooltips Tooltips
13828 * The Tooltip is an (internal, for now) smart object used to show a
13829 * content in a frame on mouse hover of objects(or widgets), with
13830 * tips/information about them.
13835 EAPI double elm_tooltip_delay_get(void);
13836 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
13837 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
13838 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
13839 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
13840 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);
13841 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13842 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13843 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13844 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
13845 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
13852 * @defgroup Cursors Cursors
13854 * The Elementary cursor is an internal smart object used to
13855 * customize the mouse cursor displayed over objects (or
13856 * widgets). In the most common scenario, the cursor decoration
13857 * comes from the graphical @b engine Elementary is running
13858 * on. Those engines may provide different decorations for cursors,
13859 * and Elementary provides functions to choose them (think of X11
13860 * cursors, as an example).
13862 * There's also the possibility of, besides using engine provided
13863 * cursors, also use ones coming from Edje theming files. Both
13864 * globally and per widget, Elementary makes it possible for one to
13865 * make the cursors lookup to be held on engines only or on
13866 * Elementary's theme file, too.
13872 * Set the cursor to be shown when mouse is over the object
13874 * Set the cursor that will be displayed when mouse is over the
13875 * object. The object can have only one cursor set to it, so if
13876 * this function is called twice for an object, the previous set
13878 * If using X cursors, a definition of all the valid cursor names
13879 * is listed on Elementary_Cursors.h. If an invalid name is set
13880 * the default cursor will be used.
13882 * @param obj the object being set a cursor.
13883 * @param cursor the cursor name to be used.
13887 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
13890 * Get the cursor to be shown when mouse is over the object
13892 * @param obj an object with cursor already set.
13893 * @return the cursor name.
13897 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13900 * Unset cursor for object
13902 * Unset cursor for object, and set the cursor to default if the mouse
13903 * was over this object.
13905 * @param obj Target object
13906 * @see elm_object_cursor_set()
13910 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13913 * Sets a different style for this object cursor.
13915 * @note before you set a style you should define a cursor with
13916 * elm_object_cursor_set()
13918 * @param obj an object with cursor already set.
13919 * @param style the theme style to use (default, transparent, ...)
13923 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13926 * Get the style for this object cursor.
13928 * @param obj an object with cursor already set.
13929 * @return style the theme style in use, defaults to "default". If the
13930 * object does not have a cursor set, then NULL is returned.
13934 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13937 * Set if the cursor set should be searched on the theme or should use
13938 * the provided by the engine, only.
13940 * @note before you set if should look on theme you should define a cursor
13941 * with elm_object_cursor_set(). By default it will only look for cursors
13942 * provided by the engine.
13944 * @param obj an object with cursor already set.
13945 * @param engine_only boolean to define it cursors should be looked only
13946 * between the provided by the engine or searched on widget's theme as well.
13950 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13953 * Get the cursor engine only usage for this object cursor.
13955 * @param obj an object with cursor already set.
13956 * @return engine_only boolean to define it cursors should be
13957 * looked only between the provided by the engine or searched on
13958 * widget's theme as well. If the object does not have a cursor
13959 * set, then EINA_FALSE is returned.
13963 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13966 * Get the configured cursor engine only usage
13968 * This gets the globally configured exclusive usage of engine cursors.
13970 * @return 1 if only engine cursors should be used
13973 EAPI int elm_cursor_engine_only_get(void);
13976 * Set the configured cursor engine only usage
13978 * This sets the globally configured exclusive usage of engine cursors.
13979 * It won't affect cursors set before changing this value.
13981 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
13982 * look for them on theme before.
13983 * @return EINA_TRUE if value is valid and setted (0 or 1)
13986 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
13993 * @defgroup Menu Menu
13995 * @image html img/widget/menu/preview-00.png
13996 * @image latex img/widget/menu/preview-00.eps
13998 * A menu is a list of items displayed above its parent. When the menu is
13999 * showing its parent is darkened. Each item can have a sub-menu. The menu
14000 * object can be used to display a menu on a right click event, in a toolbar,
14003 * Signals that you can add callbacks for are:
14004 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14005 * event_info is NULL.
14007 * @see @ref tutorial_menu
14010 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14012 * @brief Add a new menu to the parent
14014 * @param parent The parent object.
14015 * @return The new object or NULL if it cannot be created.
14017 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14019 * @brief Set the parent for the given menu widget
14021 * @param obj The menu object.
14022 * @param parent The new parent.
14024 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14026 * @brief Get the parent for the given menu widget
14028 * @param obj The menu object.
14029 * @return The parent.
14031 * @see elm_menu_parent_set()
14033 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14035 * @brief Move the menu to a new position
14037 * @param obj The menu object.
14038 * @param x The new position.
14039 * @param y The new position.
14041 * Sets the top-left position of the menu to (@p x,@p y).
14043 * @note @p x and @p y coordinates are relative to parent.
14045 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14047 * @brief Close a opened menu
14049 * @param obj the menu object
14052 * Hides the menu and all it's sub-menus.
14054 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14056 * @brief Returns a list of @p item's items.
14058 * @param obj The menu object
14059 * @return An Eina_List* of @p item's items
14061 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14063 * @brief Get the Evas_Object of an Elm_Menu_Item
14065 * @param item The menu item object.
14066 * @return The edje object containing the swallowed content
14068 * @warning Don't manipulate this object!
14070 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14072 * @brief Add an item at the end of the given menu widget
14074 * @param obj The menu object.
14075 * @param parent The parent menu item (optional)
14076 * @param icon A icon display on the item. The icon will be destryed by the menu.
14077 * @param label The label of the item.
14078 * @param func Function called when the user select the item.
14079 * @param data Data sent by the callback.
14080 * @return Returns the new item.
14082 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);
14084 * @brief Add an object swallowed in an item at the end of the given menu
14087 * @param obj The menu object.
14088 * @param parent The parent menu item (optional)
14089 * @param subobj The object to swallow
14090 * @param func Function called when the user select the item.
14091 * @param data Data sent by the callback.
14092 * @return Returns the new item.
14094 * Add an evas object as an item to the menu.
14096 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);
14098 * @brief Set the label of a menu item
14100 * @param item The menu item object.
14101 * @param label The label to set for @p item
14103 * @warning Don't use this funcion on items created with
14104 * elm_menu_item_add_object() or elm_menu_item_separator_add().
14106 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14108 * @brief Get the label of a menu item
14110 * @param item The menu item object.
14111 * @return The label of @p item
14113 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14115 * @brief Set the icon of a menu item to the standard icon with name @p icon
14117 * @param item The menu item object.
14118 * @param icon The icon object to set for the content of @p item
14120 * Once this icon is set, any previously set icon will be deleted.
14122 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14124 * @brief Get the string representation from the icon of a menu item
14126 * @param item The menu item object.
14127 * @return The string representation of @p item's icon or NULL
14129 * @see elm_menu_item_object_icon_name_set()
14131 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14133 * @brief Set the content object of a menu item
14135 * @param item The menu item object
14136 * @param The content object or NULL
14137 * @return EINA_TRUE on success, else EINA_FALSE
14139 * Use this function to change the object swallowed by a menu item, deleting
14140 * any previously swallowed object.
14142 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14144 * @brief Get the content object of a menu item
14146 * @param item The menu item object
14147 * @return The content object or NULL
14148 * @note If @p item was added with elm_menu_item_add_object, this
14149 * function will return the object passed, else it will return the
14152 * @see elm_menu_item_object_content_set()
14154 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14156 * @brief Set the selected state of @p item.
14158 * @param item The menu item object.
14159 * @param selected The selected/unselected state of the item
14161 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14163 * @brief Get the selected state of @p item.
14165 * @param item The menu item object.
14166 * @return The selected/unselected state of the item
14168 * @see elm_menu_item_selected_set()
14170 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14172 * @brief Set the disabled state of @p item.
14174 * @param item The menu item object.
14175 * @param disabled The enabled/disabled state of the item
14177 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14179 * @brief Get the disabled state of @p item.
14181 * @param item The menu item object.
14182 * @return The enabled/disabled state of the item
14184 * @see elm_menu_item_disabled_set()
14186 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14188 * @brief Add a separator item to menu @p obj under @p parent.
14190 * @param obj The menu object
14191 * @param parent The item to add the separator under
14192 * @return The created item or NULL on failure
14194 * This is item is a @ref Separator.
14196 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14198 * @brief Returns whether @p item is a separator.
14200 * @param item The item to check
14201 * @return If true, @p item is a separator
14203 * @see elm_menu_item_separator_add()
14205 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14207 * @brief Deletes an item from the menu.
14209 * @param item The item to delete.
14211 * @see elm_menu_item_add()
14213 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14215 * @brief Set the function called when a menu item is deleted.
14217 * @param item The item to set the callback on
14218 * @param func The function called
14220 * @see elm_menu_item_add()
14221 * @see elm_menu_item_del()
14223 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14225 * @brief Returns the data associated with menu item @p item.
14227 * @param item The item
14228 * @return The data associated with @p item or NULL if none was set.
14230 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14232 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14234 * @brief Sets the data to be associated with menu item @p item.
14236 * @param item The item
14237 * @param data The data to be associated with @p item
14239 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14241 * @brief Returns a list of @p item's subitems.
14243 * @param item The item
14244 * @return An Eina_List* of @p item's subitems
14246 * @see elm_menu_add()
14248 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14250 * @brief Get the position of a menu item
14252 * @param item The menu item
14253 * @return The item's index
14255 * This function returns the index position of a menu item in a menu.
14256 * For a sub-menu, this number is relative to the first item in the sub-menu.
14258 * @note Index values begin with 0
14260 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14262 * @brief @brief Return a menu item's owner menu
14264 * @param item The menu item
14265 * @return The menu object owning @p item, or NULL on failure
14267 * Use this function to get the menu object owning an item.
14269 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14271 * @brief Get the selected item in the menu
14273 * @param obj The menu object
14274 * @return The selected item, or NULL if none
14276 * @see elm_menu_item_selected_get()
14277 * @see elm_menu_item_selected_set()
14279 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14281 * @brief Get the last item in the menu
14283 * @param obj The menu object
14284 * @return The last item, or NULL if none
14286 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14288 * @brief Get the first item in the menu
14290 * @param obj The menu object
14291 * @return The first item, or NULL if none
14293 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14295 * @brief Get the next item in the menu.
14297 * @param item The menu item object.
14298 * @return The item after it, or NULL if none
14300 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14302 * @brief Get the previous item in the menu.
14304 * @param item The menu item object.
14305 * @return The item before it, or NULL if none
14307 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14313 * @defgroup List List
14314 * @ingroup Elementary
14316 * @image html img/widget/list/preview-00.png
14317 * @image latex img/widget/list/preview-00.eps width=\textwidth
14319 * @image html img/list.png
14320 * @image latex img/list.eps width=\textwidth
14322 * A list widget is a container whose children are displayed vertically or
14323 * horizontally, in order, and can be selected.
14324 * The list can accept only one or multiple items selection. Also has many
14325 * modes of items displaying.
14327 * A list is a very simple type of list widget. For more robust
14328 * lists, @ref Genlist should probably be used.
14330 * Smart callbacks one can listen to:
14331 * - @c "activated" - The user has double-clicked or pressed
14332 * (enter|return|spacebar) on an item. The @c event_info parameter
14333 * is the item that was activated.
14334 * - @c "clicked,double" - The user has double-clicked an item.
14335 * The @c event_info parameter is the item that was double-clicked.
14336 * - "selected" - when the user selected an item
14337 * - "unselected" - when the user unselected an item
14338 * - "longpressed" - an item in the list is long-pressed
14339 * - "scroll,edge,top" - the list is scrolled until the top edge
14340 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14341 * - "scroll,edge,left" - the list is scrolled until the left edge
14342 * - "scroll,edge,right" - the list is scrolled until the right edge
14344 * Available styles for it:
14347 * List of examples:
14348 * @li @ref list_example_01
14349 * @li @ref list_example_02
14350 * @li @ref list_example_03
14359 * @enum _Elm_List_Mode
14360 * @typedef Elm_List_Mode
14362 * Set list's resize behavior, transverse axis scroll and
14363 * items cropping. See each mode's description for more details.
14365 * @note Default value is #ELM_LIST_SCROLL.
14367 * Values <b> don't </b> work as bitmask, only one can be choosen.
14369 * @see elm_list_mode_set()
14370 * @see elm_list_mode_get()
14374 typedef enum _Elm_List_Mode
14376 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. */
14377 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). */
14378 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. */
14379 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. */
14380 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14383 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(). */
14386 * Add a new list widget to the given parent Elementary
14387 * (container) object.
14389 * @param parent The parent object.
14390 * @return a new list widget handle or @c NULL, on errors.
14392 * This function inserts a new list widget on the canvas.
14396 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14401 * @param obj The list object
14403 * @note Call before running show() on the list object.
14404 * @warning If not called, it won't display the list properly.
14407 * li = elm_list_add(win);
14408 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14409 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14411 * evas_object_show(li);
14416 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14419 * Enable or disable multiple items selection on the list object.
14421 * @param obj The list object
14422 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14425 * Disabled by default. If disabled, the user can select a single item of
14426 * the list each time. Selected items are highlighted on list.
14427 * If enabled, many items can be selected.
14429 * If a selected item is selected again, it will be unselected.
14431 * @see elm_list_multi_select_get()
14435 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14438 * Get a value whether multiple items selection is enabled or not.
14440 * @see elm_list_multi_select_set() for details.
14442 * @param obj The list object.
14443 * @return @c EINA_TRUE means multiple items selection is enabled.
14444 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14445 * @c EINA_FALSE is returned.
14449 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14452 * Set which mode to use for the list object.
14454 * @param obj The list object
14455 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14456 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14458 * Set list's resize behavior, transverse axis scroll and
14459 * items cropping. See each mode's description for more details.
14461 * @note Default value is #ELM_LIST_SCROLL.
14463 * Only one can be set, if a previous one was set, it will be changed
14464 * by the new mode set. Bitmask won't work as well.
14466 * @see elm_list_mode_get()
14470 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14473 * Get the mode the list is at.
14475 * @param obj The list object
14476 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14477 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14479 * @note see elm_list_mode_set() for more information.
14483 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14486 * Enable or disable horizontal mode on the list object.
14488 * @param obj The list object.
14489 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14490 * disable it, i.e., to enable vertical mode.
14492 * @note Vertical mode is set by default.
14494 * On horizontal mode items are displayed on list from left to right,
14495 * instead of from top to bottom. Also, the list will scroll horizontally.
14496 * Each item will presents left icon on top and right icon, or end, at
14499 * @see elm_list_horizontal_get()
14503 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14506 * Get a value whether horizontal mode is enabled or not.
14508 * @param obj The list object.
14509 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14510 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14511 * @c EINA_FALSE is returned.
14513 * @see elm_list_horizontal_set() for details.
14517 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14520 * Enable or disable always select mode on the list object.
14522 * @param obj The list object
14523 * @param always_select @c EINA_TRUE to enable always select mode or
14524 * @c EINA_FALSE to disable it.
14526 * @note Always select mode is disabled by default.
14528 * Default behavior of list items is to only call its callback function
14529 * the first time it's pressed, i.e., when it is selected. If a selected
14530 * item is pressed again, and multi-select is disabled, it won't call
14531 * this function (if multi-select is enabled it will unselect the item).
14533 * If always select is enabled, it will call the callback function
14534 * everytime a item is pressed, so it will call when the item is selected,
14535 * and again when a selected item is pressed.
14537 * @see elm_list_always_select_mode_get()
14538 * @see elm_list_multi_select_set()
14542 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14545 * Get a value whether always select mode is enabled or not, meaning that
14546 * an item will always call its callback function, even if already selected.
14548 * @param obj The list object
14549 * @return @c EINA_TRUE means horizontal mode selection is enabled.
14550 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14551 * @c EINA_FALSE is returned.
14553 * @see elm_list_always_select_mode_set() for details.
14557 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14560 * Set bouncing behaviour when the scrolled content reaches an edge.
14562 * Tell the internal scroller object whether it should bounce or not
14563 * when it reaches the respective edges for each axis.
14565 * @param obj The list object
14566 * @param h_bounce Whether to bounce or not in the horizontal axis.
14567 * @param v_bounce Whether to bounce or not in the vertical axis.
14569 * @see elm_scroller_bounce_set()
14573 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14576 * Get the bouncing behaviour of the internal scroller.
14578 * Get whether the internal scroller should bounce when the edge of each
14579 * axis is reached scrolling.
14581 * @param obj The list object.
14582 * @param h_bounce Pointer where to store the bounce state of the horizontal
14584 * @param v_bounce Pointer where to store the bounce state of the vertical
14587 * @see elm_scroller_bounce_get()
14588 * @see elm_list_bounce_set()
14592 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14595 * Set the scrollbar policy.
14597 * @param obj The list object
14598 * @param policy_h Horizontal scrollbar policy.
14599 * @param policy_v Vertical scrollbar policy.
14601 * This sets the scrollbar visibility policy for the given scroller.
14602 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14603 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14604 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14605 * This applies respectively for the horizontal and vertical scrollbars.
14607 * The both are disabled by default, i.e., are set to
14608 * #ELM_SCROLLER_POLICY_OFF.
14612 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14615 * Get the scrollbar policy.
14617 * @see elm_list_scroller_policy_get() for details.
14619 * @param obj The list object.
14620 * @param policy_h Pointer where to store horizontal scrollbar policy.
14621 * @param policy_v Pointer where to store vertical scrollbar policy.
14625 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);
14628 * Append a new item to the list object.
14630 * @param obj The list object.
14631 * @param label The label of the list item.
14632 * @param icon The icon object to use for the left side of the item. An
14633 * icon can be any Evas object, but usually it is an icon created
14634 * with elm_icon_add().
14635 * @param end The icon object to use for the right side of the item. An
14636 * icon can be any Evas object.
14637 * @param func The function to call when the item is clicked.
14638 * @param data The data to associate with the item for related callbacks.
14640 * @return The created item or @c NULL upon failure.
14642 * A new item will be created and appended to the list, i.e., will
14643 * be set as @b last item.
14645 * Items created with this method can be deleted with
14646 * elm_list_item_del().
14648 * Associated @p data can be properly freed when item is deleted if a
14649 * callback function is set with elm_list_item_del_cb_set().
14651 * If a function is passed as argument, it will be called everytime this item
14652 * is selected, i.e., the user clicks over an unselected item.
14653 * If always select is enabled it will call this function every time
14654 * user clicks over an item (already selected or not).
14655 * If such function isn't needed, just passing
14656 * @c NULL as @p func is enough. The same should be done for @p data.
14658 * Simple example (with no function callback or data associated):
14660 * li = elm_list_add(win);
14661 * ic = elm_icon_add(win);
14662 * elm_icon_file_set(ic, "path/to/image", NULL);
14663 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14664 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14666 * evas_object_show(li);
14669 * @see elm_list_always_select_mode_set()
14670 * @see elm_list_item_del()
14671 * @see elm_list_item_del_cb_set()
14672 * @see elm_list_clear()
14673 * @see elm_icon_add()
14677 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);
14680 * Prepend a new item to the list object.
14682 * @param obj The list object.
14683 * @param label The label of the list item.
14684 * @param icon The icon object to use for the left side of the item. An
14685 * icon can be any Evas object, but usually it is an icon created
14686 * with elm_icon_add().
14687 * @param end The icon object to use for the right side of the item. An
14688 * icon can be any Evas object.
14689 * @param func The function to call when the item is clicked.
14690 * @param data The data to associate with the item for related callbacks.
14692 * @return The created item or @c NULL upon failure.
14694 * A new item will be created and prepended to the list, i.e., will
14695 * be set as @b first item.
14697 * Items created with this method can be deleted with
14698 * elm_list_item_del().
14700 * Associated @p data can be properly freed when item is deleted if a
14701 * callback function is set with elm_list_item_del_cb_set().
14703 * If a function is passed as argument, it will be called everytime this item
14704 * is selected, i.e., the user clicks over an unselected item.
14705 * If always select is enabled it will call this function every time
14706 * user clicks over an item (already selected or not).
14707 * If such function isn't needed, just passing
14708 * @c NULL as @p func is enough. The same should be done for @p data.
14710 * @see elm_list_item_append() for a simple code example.
14711 * @see elm_list_always_select_mode_set()
14712 * @see elm_list_item_del()
14713 * @see elm_list_item_del_cb_set()
14714 * @see elm_list_clear()
14715 * @see elm_icon_add()
14719 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);
14722 * Insert a new item into the list object before item @p before.
14724 * @param obj The list object.
14725 * @param before The list item to insert before.
14726 * @param label The label of the list item.
14727 * @param icon The icon object to use for the left side of the item. An
14728 * icon can be any Evas object, but usually it is an icon created
14729 * with elm_icon_add().
14730 * @param end The icon object to use for the right side of the item. An
14731 * icon can be any Evas object.
14732 * @param func The function to call when the item is clicked.
14733 * @param data The data to associate with the item for related callbacks.
14735 * @return The created item or @c NULL upon failure.
14737 * A new item will be created and added to the list. Its position in
14738 * this list will be just before item @p before.
14740 * Items created with this method can be deleted with
14741 * elm_list_item_del().
14743 * Associated @p data can be properly freed when item is deleted if a
14744 * callback function is set with elm_list_item_del_cb_set().
14746 * If a function is passed as argument, it will be called everytime this item
14747 * is selected, i.e., the user clicks over an unselected item.
14748 * If always select is enabled it will call this function every time
14749 * user clicks over an item (already selected or not).
14750 * If such function isn't needed, just passing
14751 * @c NULL as @p func is enough. The same should be done for @p data.
14753 * @see elm_list_item_append() for a simple code example.
14754 * @see elm_list_always_select_mode_set()
14755 * @see elm_list_item_del()
14756 * @see elm_list_item_del_cb_set()
14757 * @see elm_list_clear()
14758 * @see elm_icon_add()
14762 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);
14765 * Insert a new item into the list object after item @p after.
14767 * @param obj The list object.
14768 * @param after The list item to insert after.
14769 * @param label The label of the list item.
14770 * @param icon The icon object to use for the left side of the item. An
14771 * icon can be any Evas object, but usually it is an icon created
14772 * with elm_icon_add().
14773 * @param end The icon object to use for the right side of the item. An
14774 * icon can be any Evas object.
14775 * @param func The function to call when the item is clicked.
14776 * @param data The data to associate with the item for related callbacks.
14778 * @return The created item or @c NULL upon failure.
14780 * A new item will be created and added to the list. Its position in
14781 * this list will be just after item @p after.
14783 * Items created with this method can be deleted with
14784 * elm_list_item_del().
14786 * Associated @p data can be properly freed when item is deleted if a
14787 * callback function is set with elm_list_item_del_cb_set().
14789 * If a function is passed as argument, it will be called everytime this item
14790 * is selected, i.e., the user clicks over an unselected item.
14791 * If always select is enabled it will call this function every time
14792 * user clicks over an item (already selected or not).
14793 * If such function isn't needed, just passing
14794 * @c NULL as @p func is enough. The same should be done for @p data.
14796 * @see elm_list_item_append() for a simple code example.
14797 * @see elm_list_always_select_mode_set()
14798 * @see elm_list_item_del()
14799 * @see elm_list_item_del_cb_set()
14800 * @see elm_list_clear()
14801 * @see elm_icon_add()
14805 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);
14808 * Insert a new item into the sorted list object.
14810 * @param obj The list object.
14811 * @param label The label of the list item.
14812 * @param icon The icon object to use for the left side of the item. An
14813 * icon can be any Evas object, but usually it is an icon created
14814 * with elm_icon_add().
14815 * @param end The icon object to use for the right side of the item. An
14816 * icon can be any Evas object.
14817 * @param func The function to call when the item is clicked.
14818 * @param data The data to associate with the item for related callbacks.
14819 * @param cmp_func The comparing function to be used to sort list
14820 * items <b>by #Elm_List_Item item handles</b>. This function will
14821 * receive two items and compare them, returning a non-negative integer
14822 * if the second item should be place after the first, or negative value
14823 * if should be placed before.
14825 * @return The created item or @c NULL upon failure.
14827 * @note This function inserts values into a list object assuming it was
14828 * sorted and the result will be sorted.
14830 * A new item will be created and added to the list. Its position in
14831 * this list will be found comparing the new item with previously inserted
14832 * items using function @p cmp_func.
14834 * Items created with this method can be deleted with
14835 * elm_list_item_del().
14837 * Associated @p data can be properly freed when item is deleted if a
14838 * callback function is set with elm_list_item_del_cb_set().
14840 * If a function is passed as argument, it will be called everytime this item
14841 * is selected, i.e., the user clicks over an unselected item.
14842 * If always select is enabled it will call this function every time
14843 * user clicks over an item (already selected or not).
14844 * If such function isn't needed, just passing
14845 * @c NULL as @p func is enough. The same should be done for @p data.
14847 * @see elm_list_item_append() for a simple code example.
14848 * @see elm_list_always_select_mode_set()
14849 * @see elm_list_item_del()
14850 * @see elm_list_item_del_cb_set()
14851 * @see elm_list_clear()
14852 * @see elm_icon_add()
14856 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);
14859 * Remove all list's items.
14861 * @param obj The list object
14863 * @see elm_list_item_del()
14864 * @see elm_list_item_append()
14868 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14871 * Get a list of all the list items.
14873 * @param obj The list object
14874 * @return An @c Eina_List of list items, #Elm_List_Item,
14875 * or @c NULL on failure.
14877 * @see elm_list_item_append()
14878 * @see elm_list_item_del()
14879 * @see elm_list_clear()
14883 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14886 * Get the selected item.
14888 * @param obj The list object.
14889 * @return The selected list item.
14891 * The selected item can be unselected with function
14892 * elm_list_item_selected_set().
14894 * The selected item always will be highlighted on list.
14896 * @see elm_list_selected_items_get()
14900 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14903 * Return a list of the currently selected list items.
14905 * @param obj The list object.
14906 * @return An @c Eina_List of list items, #Elm_List_Item,
14907 * or @c NULL on failure.
14909 * Multiple items can be selected if multi select is enabled. It can be
14910 * done with elm_list_multi_select_set().
14912 * @see elm_list_selected_item_get()
14913 * @see elm_list_multi_select_set()
14917 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14920 * Set the selected state of an item.
14922 * @param item The list item
14923 * @param selected The selected state
14925 * This sets the selected state of the given item @p it.
14926 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14928 * If a new item is selected the previosly selected will be unselected,
14929 * unless multiple selection is enabled with elm_list_multi_select_set().
14930 * Previoulsy selected item can be get with function
14931 * elm_list_selected_item_get().
14933 * Selected items will be highlighted.
14935 * @see elm_list_item_selected_get()
14936 * @see elm_list_selected_item_get()
14937 * @see elm_list_multi_select_set()
14941 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14944 * Get whether the @p item is selected or not.
14946 * @param item The list item.
14947 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14948 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14950 * @see elm_list_selected_item_set() for details.
14951 * @see elm_list_item_selected_get()
14955 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
14958 * Set or unset item as a separator.
14960 * @param it The list item.
14961 * @param setting @c EINA_TRUE to set item @p it as separator or
14962 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14964 * Items aren't set as separator by default.
14966 * If set as separator it will display separator theme, so won't display
14969 * @see elm_list_item_separator_get()
14973 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
14976 * Get a value whether item is a separator or not.
14978 * @see elm_list_item_separator_set() for details.
14980 * @param it The list item.
14981 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14982 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14986 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
14989 * Show @p item in the list view.
14991 * @param item The list item to be shown.
14993 * It won't animate list until item is visible. If such behavior is wanted,
14994 * use elm_list_bring_in() intead.
14998 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15001 * Bring in the given item to list view.
15003 * @param item The item.
15005 * This causes list to jump to the given item @p item and show it
15006 * (by scrolling), if it is not fully visible.
15008 * This may use animation to do so and take a period of time.
15010 * If animation isn't wanted, elm_list_item_show() can be used.
15014 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15017 * Delete them item from the list.
15019 * @param item The item of list to be deleted.
15021 * If deleting all list items is required, elm_list_clear()
15022 * should be used instead of getting items list and deleting each one.
15024 * @see elm_list_clear()
15025 * @see elm_list_item_append()
15026 * @see elm_list_item_del_cb_set()
15030 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15033 * Set the function called when a list item is freed.
15035 * @param item The item to set the callback on
15036 * @param func The function called
15038 * If there is a @p func, then it will be called prior item's memory release.
15039 * That will be called with the following arguments:
15041 * @li item's Evas object;
15044 * This way, a data associated to a list item could be properly freed.
15048 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15051 * Get the data associated to the item.
15053 * @param item The list item
15054 * @return The data associated to @p item
15056 * The return value is a pointer to data associated to @p item when it was
15057 * created, with function elm_list_item_append() or similar. If no data
15058 * was passed as argument, it will return @c NULL.
15060 * @see elm_list_item_append()
15064 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15067 * Get the left side icon associated to the item.
15069 * @param item The list item
15070 * @return The left side icon associated to @p item
15072 * The return value is a pointer to the icon associated to @p item when
15074 * created, with function elm_list_item_append() or similar, or later
15075 * with function elm_list_item_icon_set(). If no icon
15076 * was passed as argument, it will return @c NULL.
15078 * @see elm_list_item_append()
15079 * @see elm_list_item_icon_set()
15083 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15086 * Set the left side icon associated to the item.
15088 * @param item The list item
15089 * @param icon The left side icon object to associate with @p item
15091 * The icon object to use at left side of the item. An
15092 * icon can be any Evas object, but usually it is an icon created
15093 * with elm_icon_add().
15095 * Once the icon object is set, a previously set one will be deleted.
15096 * @warning Setting the same icon for two items will cause the icon to
15097 * dissapear from the first item.
15099 * If an icon was passed as argument on item creation, with function
15100 * elm_list_item_append() or similar, it will be already
15101 * associated to the item.
15103 * @see elm_list_item_append()
15104 * @see elm_list_item_icon_get()
15108 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15111 * Get the right side icon associated to the item.
15113 * @param item The list item
15114 * @return The right side icon associated to @p item
15116 * The return value is a pointer to the icon associated to @p item when
15118 * created, with function elm_list_item_append() or similar, or later
15119 * with function elm_list_item_icon_set(). If no icon
15120 * was passed as argument, it will return @c NULL.
15122 * @see elm_list_item_append()
15123 * @see elm_list_item_icon_set()
15127 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15130 * Set the right side icon associated to the item.
15132 * @param item The list item
15133 * @param end The right side icon object to associate with @p item
15135 * The icon object to use at right side of the item. An
15136 * icon can be any Evas object, but usually it is an icon created
15137 * with elm_icon_add().
15139 * Once the icon object is set, a previously set one will be deleted.
15140 * @warning Setting the same icon for two items will cause the icon to
15141 * dissapear from the first item.
15143 * If an icon was passed as argument on item creation, with function
15144 * elm_list_item_append() or similar, it will be already
15145 * associated to the item.
15147 * @see elm_list_item_append()
15148 * @see elm_list_item_end_get()
15152 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15155 * Gets the base object of the item.
15157 * @param item The list item
15158 * @return The base object associated with @p item
15160 * Base object is the @c Evas_Object that represents that item.
15164 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15167 * Get the label of item.
15169 * @param item The item of list.
15170 * @return The label of item.
15172 * The return value is a pointer to the label associated to @p item when
15173 * it was created, with function elm_list_item_append(), or later
15174 * with function elm_list_item_label_set. If no label
15175 * was passed as argument, it will return @c NULL.
15177 * @see elm_list_item_label_set() for more details.
15178 * @see elm_list_item_append()
15182 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15185 * Set the label of item.
15187 * @param item The item of list.
15188 * @param text The label of item.
15190 * The label to be displayed by the item.
15191 * Label will be placed between left and right side icons (if set).
15193 * If a label was passed as argument on item creation, with function
15194 * elm_list_item_append() or similar, it will be already
15195 * displayed by the item.
15197 * @see elm_list_item_label_get()
15198 * @see elm_list_item_append()
15202 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15206 * Get the item before @p it in list.
15208 * @param it The list item.
15209 * @return The item before @p it, or @c NULL if none or on failure.
15211 * @note If it is the first item, @c NULL will be returned.
15213 * @see elm_list_item_append()
15214 * @see elm_list_items_get()
15218 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15221 * Get the item after @p it in list.
15223 * @param it The list item.
15224 * @return The item after @p it, or @c NULL if none or on failure.
15226 * @note If it is the last item, @c NULL will be returned.
15228 * @see elm_list_item_append()
15229 * @see elm_list_items_get()
15233 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15236 * Sets the disabled/enabled state of a list item.
15238 * @param it The item.
15239 * @param disabled The disabled state.
15241 * A disabled item cannot be selected or unselected. It will also
15242 * change its appearance (generally greyed out). This sets the
15243 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15248 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15251 * Get a value whether list item is disabled or not.
15253 * @param it The item.
15254 * @return The disabled state.
15256 * @see elm_list_item_disabled_set() for more details.
15260 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15263 * Set the text to be shown in a given list item's tooltips.
15265 * @param item Target item.
15266 * @param text The text to set in the content.
15268 * Setup the text as tooltip to object. The item can have only one tooltip,
15269 * so any previous tooltip data - set with this function or
15270 * elm_list_item_tooltip_content_cb_set() - is removed.
15272 * @see elm_object_tooltip_text_set() for more details.
15276 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15280 * @brief Disable size restrictions on an object's tooltip
15281 * @param item The tooltip's anchor object
15282 * @param disable If EINA_TRUE, size restrictions are disabled
15283 * @return EINA_FALSE on failure, EINA_TRUE on success
15285 * This function allows a tooltip to expand beyond its parant window's canvas.
15286 * It will instead be limited only by the size of the display.
15288 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15290 * @brief Retrieve size restriction state of an object's tooltip
15291 * @param obj The tooltip's anchor object
15292 * @return If EINA_TRUE, size restrictions are disabled
15294 * This function returns whether a tooltip is allowed to expand beyond
15295 * its parant window's canvas.
15296 * It will instead be limited only by the size of the display.
15298 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15301 * Set the content to be shown in the tooltip item.
15303 * Setup the tooltip to item. The item can have only one tooltip,
15304 * so any previous tooltip data is removed. @p func(with @p data) will
15305 * be called every time that need show the tooltip and it should
15306 * return a valid Evas_Object. This object is then managed fully by
15307 * tooltip system and is deleted when the tooltip is gone.
15309 * @param item the list item being attached a tooltip.
15310 * @param func the function used to create the tooltip contents.
15311 * @param data what to provide to @a func as callback data/context.
15312 * @param del_cb called when data is not needed anymore, either when
15313 * another callback replaces @a func, the tooltip is unset with
15314 * elm_list_item_tooltip_unset() or the owner @a item
15315 * dies. This callback receives as the first parameter the
15316 * given @a data, and @c event_info is the item.
15318 * @see elm_object_tooltip_content_cb_set() for more details.
15322 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);
15325 * Unset tooltip from item.
15327 * @param item list item to remove previously set tooltip.
15329 * Remove tooltip from item. The callback provided as del_cb to
15330 * elm_list_item_tooltip_content_cb_set() will be called to notify
15331 * it is not used anymore.
15333 * @see elm_object_tooltip_unset() for more details.
15334 * @see elm_list_item_tooltip_content_cb_set()
15338 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15341 * Sets a different style for this item tooltip.
15343 * @note before you set a style you should define a tooltip with
15344 * elm_list_item_tooltip_content_cb_set() or
15345 * elm_list_item_tooltip_text_set()
15347 * @param item list item with tooltip already set.
15348 * @param style the theme style to use (default, transparent, ...)
15350 * @see elm_object_tooltip_style_set() for more details.
15354 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15357 * Get the style for this item tooltip.
15359 * @param item list item with tooltip already set.
15360 * @return style the theme style in use, defaults to "default". If the
15361 * object does not have a tooltip set, then NULL is returned.
15363 * @see elm_object_tooltip_style_get() for more details.
15364 * @see elm_list_item_tooltip_style_set()
15368 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15371 * Set the type of mouse pointer/cursor decoration to be shown,
15372 * when the mouse pointer is over the given list widget item
15374 * @param item list item to customize cursor on
15375 * @param cursor the cursor type's name
15377 * This function works analogously as elm_object_cursor_set(), but
15378 * here the cursor's changing area is restricted to the item's
15379 * area, and not the whole widget's. Note that that item cursors
15380 * have precedence over widget cursors, so that a mouse over an
15381 * item with custom cursor set will always show @b that cursor.
15383 * If this function is called twice for an object, a previously set
15384 * cursor will be unset on the second call.
15386 * @see elm_object_cursor_set()
15387 * @see elm_list_item_cursor_get()
15388 * @see elm_list_item_cursor_unset()
15392 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15395 * Get the type of mouse pointer/cursor decoration set to be shown,
15396 * when the mouse pointer is over the given list widget item
15398 * @param item list item with custom cursor set
15399 * @return the cursor type's name or @c NULL, if no custom cursors
15400 * were set to @p item (and on errors)
15402 * @see elm_object_cursor_get()
15403 * @see elm_list_item_cursor_set()
15404 * @see elm_list_item_cursor_unset()
15408 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15411 * Unset any custom mouse pointer/cursor decoration set to be
15412 * shown, when the mouse pointer is over the given list widget
15413 * item, thus making it show the @b default cursor again.
15415 * @param item a list item
15417 * Use this call to undo any custom settings on this item's cursor
15418 * decoration, bringing it back to defaults (no custom style set).
15420 * @see elm_object_cursor_unset()
15421 * @see elm_list_item_cursor_set()
15425 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15428 * Set a different @b style for a given custom cursor set for a
15431 * @param item list item with custom cursor set
15432 * @param style the <b>theme style</b> to use (e.g. @c "default",
15433 * @c "transparent", etc)
15435 * This function only makes sense when one is using custom mouse
15436 * cursor decorations <b>defined in a theme file</b>, which can have,
15437 * given a cursor name/type, <b>alternate styles</b> on it. It
15438 * works analogously as elm_object_cursor_style_set(), but here
15439 * applyed only to list item objects.
15441 * @warning Before you set a cursor style you should have definen a
15442 * custom cursor previously on the item, with
15443 * elm_list_item_cursor_set()
15445 * @see elm_list_item_cursor_engine_only_set()
15446 * @see elm_list_item_cursor_style_get()
15450 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15453 * Get the current @b style set for a given list item's custom
15456 * @param item list item with custom cursor set.
15457 * @return style the cursor style in use. If the object does not
15458 * have a cursor set, then @c NULL is returned.
15460 * @see elm_list_item_cursor_style_set() for more details
15464 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15467 * Set if the (custom)cursor for a given list item should be
15468 * searched in its theme, also, or should only rely on the
15469 * rendering engine.
15471 * @param item item with custom (custom) cursor already set on
15472 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15473 * only on those provided by the rendering engine, @c EINA_FALSE to
15474 * have them searched on the widget's theme, as well.
15476 * @note This call is of use only if you've set a custom cursor
15477 * for list items, with elm_list_item_cursor_set().
15479 * @note By default, cursors will only be looked for between those
15480 * provided by the rendering engine.
15484 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15487 * Get if the (custom) cursor for a given list item is being
15488 * searched in its theme, also, or is only relying on the rendering
15491 * @param item a list item
15492 * @return @c EINA_TRUE, if cursors are being looked for only on
15493 * those provided by the rendering engine, @c EINA_FALSE if they
15494 * are being searched on the widget's theme, as well.
15496 * @see elm_list_item_cursor_engine_only_set(), for more details
15500 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15507 * @defgroup Slider Slider
15508 * @ingroup Elementary
15510 * @image html img/widget/slider/preview-00.png
15511 * @image latex img/widget/slider/preview-00.eps width=\textwidth
15513 * The slider adds a dragable “slider” widget for selecting the value of
15514 * something within a range.
15516 * A slider can be horizontal or vertical. It can contain an Icon and has a
15517 * primary label as well as a units label (that is formatted with floating
15518 * point values and thus accepts a printf-style format string, like
15519 * “%1.2f units”. There is also an indicator string that may be somewhere
15520 * else (like on the slider itself) that also accepts a format string like
15521 * units. Label, Icon Unit and Indicator strings/objects are optional.
15523 * A slider may be inverted which means values invert, with high vales being
15524 * on the left or top and low values on the right or bottom (as opposed to
15525 * normally being low on the left or top and high on the bottom and right).
15527 * The slider should have its minimum and maximum values set by the
15528 * application with elm_slider_min_max_set() and value should also be set by
15529 * the application before use with elm_slider_value_set(). The span of the
15530 * slider is its length (horizontally or vertically). This will be scaled by
15531 * the object or applications scaling factor. At any point code can query the
15532 * slider for its value with elm_slider_value_get().
15534 * Smart callbacks one can listen to:
15535 * - "changed" - Whenever the slider value is changed by the user.
15536 * - "slider,drag,start" - dragging the slider indicator around has started.
15537 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15538 * - "delay,changed" - A short time after the value is changed by the user.
15539 * This will be called only when the user stops dragging for
15540 * a very short period or when they release their
15541 * finger/mouse, so it avoids possibly expensive reactions to
15542 * the value change.
15544 * Available styles for it:
15547 * Here is an example on its usage:
15548 * @li @ref slider_example
15552 * @addtogroup Slider
15557 * Add a new slider widget to the given parent Elementary
15558 * (container) object.
15560 * @param parent The parent object.
15561 * @return a new slider widget handle or @c NULL, on errors.
15563 * This function inserts a new slider widget on the canvas.
15567 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15570 * Set the label of a given slider widget
15572 * @param obj The progress bar object
15573 * @param label The text label string, in UTF-8
15576 * @deprecated use elm_object_text_set() instead.
15578 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15581 * Get the label of a given slider widget
15583 * @param obj The progressbar object
15584 * @return The text label string, in UTF-8
15587 * @deprecated use elm_object_text_get() instead.
15589 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15592 * Set the icon object of the slider object.
15594 * @param obj The slider object.
15595 * @param icon The icon object.
15597 * On horizontal mode, icon is placed at left, and on vertical mode,
15600 * @note Once the icon object is set, a previously set one will be deleted.
15601 * If you want to keep that old content object, use the
15602 * elm_slider_icon_unset() function.
15604 * @warning If the object being set does not have minimum size hints set,
15605 * it won't get properly displayed.
15609 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15612 * Unset an icon set on a given slider widget.
15614 * @param obj The slider object.
15615 * @return The icon object that was being used, if any was set, or
15616 * @c NULL, otherwise (and on errors).
15618 * On horizontal mode, icon is placed at left, and on vertical mode,
15621 * This call will unparent and return the icon object which was set
15622 * for this widget, previously, on success.
15624 * @see elm_slider_icon_set() for more details
15625 * @see elm_slider_icon_get()
15629 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15632 * Retrieve the icon object set for a given slider widget.
15634 * @param obj The slider object.
15635 * @return The icon object's handle, if @p obj had one set, or @c NULL,
15636 * otherwise (and on errors).
15638 * On horizontal mode, icon is placed at left, and on vertical mode,
15641 * @see elm_slider_icon_set() for more details
15642 * @see elm_slider_icon_unset()
15646 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15649 * Set the end object of the slider object.
15651 * @param obj The slider object.
15652 * @param end The end object.
15654 * On horizontal mode, end is placed at left, and on vertical mode,
15655 * placed at bottom.
15657 * @note Once the icon object is set, a previously set one will be deleted.
15658 * If you want to keep that old content object, use the
15659 * elm_slider_end_unset() function.
15661 * @warning If the object being set does not have minimum size hints set,
15662 * it won't get properly displayed.
15666 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15669 * Unset an end object set on a given slider widget.
15671 * @param obj The slider object.
15672 * @return The end object that was being used, if any was set, or
15673 * @c NULL, otherwise (and on errors).
15675 * On horizontal mode, end is placed at left, and on vertical mode,
15676 * placed at bottom.
15678 * This call will unparent and return the icon object which was set
15679 * for this widget, previously, on success.
15681 * @see elm_slider_end_set() for more details.
15682 * @see elm_slider_end_get()
15686 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15689 * Retrieve the end object set for a given slider widget.
15691 * @param obj The slider object.
15692 * @return The end object's handle, if @p obj had one set, or @c NULL,
15693 * otherwise (and on errors).
15695 * On horizontal mode, icon is placed at right, and on vertical mode,
15696 * placed at bottom.
15698 * @see elm_slider_end_set() for more details.
15699 * @see elm_slider_end_unset()
15703 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15706 * Set the (exact) length of the bar region of a given slider widget.
15708 * @param obj The slider object.
15709 * @param size The length of the slider's bar region.
15711 * This sets the minimum width (when in horizontal mode) or height
15712 * (when in vertical mode) of the actual bar area of the slider
15713 * @p obj. This in turn affects the object's minimum size. Use
15714 * this when you're not setting other size hints expanding on the
15715 * given direction (like weight and alignment hints) and you would
15716 * like it to have a specific size.
15718 * @note Icon, end, label, indicator and unit text around @p obj
15719 * will require their
15720 * own space, which will make @p obj to require more the @p size,
15723 * @see elm_slider_span_size_get()
15727 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15730 * Get the length set for the bar region of a given slider widget
15732 * @param obj The slider object.
15733 * @return The length of the slider's bar region.
15735 * If that size was not set previously, with
15736 * elm_slider_span_size_set(), this call will return @c 0.
15740 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15743 * Set the format string for the unit label.
15745 * @param obj The slider object.
15746 * @param format The format string for the unit display.
15748 * Unit label is displayed all the time, if set, after slider's bar.
15749 * In horizontal mode, at right and in vertical mode, at bottom.
15751 * If @c NULL, unit label won't be visible. If not it sets the format
15752 * string for the label text. To the label text is provided a floating point
15753 * value, so the label text can display up to 1 floating point value.
15754 * Note that this is optional.
15756 * Use a format string such as "%1.2f meters" for example, and it will
15757 * display values like: "3.14 meters" for a value equal to 3.14159.
15759 * Default is unit label disabled.
15761 * @see elm_slider_indicator_format_get()
15765 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15768 * Get the unit label format of the slider.
15770 * @param obj The slider object.
15771 * @return The unit label format string in UTF-8.
15773 * Unit label is displayed all the time, if set, after slider's bar.
15774 * In horizontal mode, at right and in vertical mode, at bottom.
15776 * @see elm_slider_unit_format_set() for more
15777 * information on how this works.
15781 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15784 * Set the format string for the indicator label.
15786 * @param obj The slider object.
15787 * @param indicator The format string for the indicator display.
15789 * The slider may display its value somewhere else then unit label,
15790 * for example, above the slider knob that is dragged around. This function
15791 * sets the format string used for this.
15793 * If @c NULL, indicator label won't be visible. If not it sets the format
15794 * string for the label text. To the label text is provided a floating point
15795 * value, so the label text can display up to 1 floating point value.
15796 * Note that this is optional.
15798 * Use a format string such as "%1.2f meters" for example, and it will
15799 * display values like: "3.14 meters" for a value equal to 3.14159.
15801 * Default is indicator label disabled.
15803 * @see elm_slider_indicator_format_get()
15807 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
15810 * Get the indicator label format of the slider.
15812 * @param obj The slider object.
15813 * @return The indicator label format string in UTF-8.
15815 * The slider may display its value somewhere else then unit label,
15816 * for example, above the slider knob that is dragged around. This function
15817 * gets the format string used for this.
15819 * @see elm_slider_indicator_format_set() for more
15820 * information on how this works.
15824 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15827 * Set the format function pointer for the indicator label
15829 * @param obj The slider object.
15830 * @param func The indicator format function.
15831 * @param free_func The freeing function for the format string.
15833 * Set the callback function to format the indicator string.
15835 * @see elm_slider_indicator_format_set() for more info on how this works.
15839 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);
15842 * Set the format function pointer for the units label
15844 * @param obj The slider object.
15845 * @param func The units format function.
15846 * @param free_func The freeing function for the format string.
15848 * Set the callback function to format the indicator string.
15850 * @see elm_slider_units_format_set() for more info on how this works.
15854 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);
15857 * Set the orientation of a given slider widget.
15859 * @param obj The slider object.
15860 * @param horizontal Use @c EINA_TRUE to make @p obj to be
15861 * @b horizontal, @c EINA_FALSE to make it @b vertical.
15863 * Use this function to change how your slider is to be
15864 * disposed: vertically or horizontally.
15866 * By default it's displayed horizontally.
15868 * @see elm_slider_horizontal_get()
15872 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15875 * Retrieve the orientation of a given slider widget
15877 * @param obj The slider object.
15878 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
15879 * @c EINA_FALSE if it's @b vertical (and on errors).
15881 * @see elm_slider_horizontal_set() for more details.
15885 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15888 * Set the minimum and maximum values for the slider.
15890 * @param obj The slider object.
15891 * @param min The minimum value.
15892 * @param max The maximum value.
15894 * Define the allowed range of values to be selected by the user.
15896 * If actual value is less than @p min, it will be updated to @p min. If it
15897 * is bigger then @p max, will be updated to @p max. Actual value can be
15898 * get with elm_slider_value_get().
15900 * By default, min is equal to 0.0, and max is equal to 1.0.
15902 * @warning Maximum must be greater than minimum, otherwise behavior
15905 * @see elm_slider_min_max_get()
15909 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
15912 * Get the minimum and maximum values of the slider.
15914 * @param obj The slider object.
15915 * @param min Pointer where to store the minimum value.
15916 * @param max Pointer where to store the maximum value.
15918 * @note If only one value is needed, the other pointer can be passed
15921 * @see elm_slider_min_max_set() for details.
15925 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
15928 * Set the value the slider displays.
15930 * @param obj The slider object.
15931 * @param val The value to be displayed.
15933 * Value will be presented on the unit label following format specified with
15934 * elm_slider_unit_format_set() and on indicator with
15935 * elm_slider_indicator_format_set().
15937 * @warning The value must to be between min and max values. This values
15938 * are set by elm_slider_min_max_set().
15940 * @see elm_slider_value_get()
15941 * @see elm_slider_unit_format_set()
15942 * @see elm_slider_indicator_format_set()
15943 * @see elm_slider_min_max_set()
15947 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
15950 * Get the value displayed by the spinner.
15952 * @param obj The spinner object.
15953 * @return The value displayed.
15955 * @see elm_spinner_value_set() for details.
15959 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15962 * Invert a given slider widget's displaying values order
15964 * @param obj The slider object.
15965 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
15966 * @c EINA_FALSE to bring it back to default, non-inverted values.
15968 * A slider may be @b inverted, in which state it gets its
15969 * values inverted, with high vales being on the left or top and
15970 * low values on the right or bottom, as opposed to normally have
15971 * the low values on the former and high values on the latter,
15972 * respectively, for horizontal and vertical modes.
15974 * @see elm_slider_inverted_get()
15978 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
15981 * Get whether a given slider widget's displaying values are
15984 * @param obj The slider object.
15985 * @return @c EINA_TRUE, if @p obj has inverted values,
15986 * @c EINA_FALSE otherwise (and on errors).
15988 * @see elm_slider_inverted_set() for more details.
15992 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15995 * Set whether to enlarge slider indicator (augmented knob) or not.
15997 * @param obj The slider object.
15998 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
15999 * let the knob always at default size.
16001 * By default, indicator will be bigger while dragged by the user.
16003 * @warning It won't display values set with
16004 * elm_slider_indicator_format_set() if you disable indicator.
16008 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16011 * Get whether a given slider widget's enlarging indicator or not.
16013 * @param obj The slider object.
16014 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16015 * @c EINA_FALSE otherwise (and on errors).
16017 * @see elm_slider_indicator_show_set() for details.
16021 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16028 * @addtogroup Actionslider Actionslider
16030 * @image html img/widget/actionslider/preview-00.png
16031 * @image latex img/widget/actionslider/preview-00.eps
16033 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16034 * properties. The indicator is the element the user drags to choose a label.
16035 * When the position is set with magnet, when released the indicator will be
16036 * moved to it if it's nearest the magnetized position.
16038 * @note By default all positions are set as enabled.
16040 * Signals that you can add callbacks for are:
16042 * "selected" - when user selects an enabled position (the label is passed
16045 * "pos_changed" - when the indicator reaches any of the positions("left",
16046 * "right" or "center").
16048 * See an example of actionslider usage @ref actionslider_example_page "here"
16051 typedef enum _Elm_Actionslider_Pos
16053 ELM_ACTIONSLIDER_NONE = 0,
16054 ELM_ACTIONSLIDER_LEFT = 1 << 0,
16055 ELM_ACTIONSLIDER_CENTER = 1 << 1,
16056 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16057 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16058 } Elm_Actionslider_Pos;
16061 * Add a new actionslider to the parent.
16063 * @param parent The parent object
16064 * @return The new actionslider object or NULL if it cannot be created
16066 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16068 * Set actionslider labels.
16070 * @param obj The actionslider object
16071 * @param left_label The label to be set on the left.
16072 * @param center_label The label to be set on the center.
16073 * @param right_label The label to be set on the right.
16074 * @deprecated use elm_object_text_set() instead.
16076 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);
16078 * Get actionslider labels.
16080 * @param obj The actionslider object
16081 * @param left_label A char** to place the left_label of @p obj into.
16082 * @param center_label A char** to place the center_label of @p obj into.
16083 * @param right_label A char** to place the right_label of @p obj into.
16084 * @deprecated use elm_object_text_set() instead.
16086 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);
16088 * Get actionslider selected label.
16090 * @param obj The actionslider object
16091 * @return The selected label
16093 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16095 * Set actionslider indicator position.
16097 * @param obj The actionslider object.
16098 * @param pos The position of the indicator.
16100 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16102 * Get actionslider indicator position.
16104 * @param obj The actionslider object.
16105 * @return The position of the indicator.
16107 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16109 * Set actionslider magnet position. To make multiple positions magnets @c or
16110 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16112 * @param obj The actionslider object.
16113 * @param pos Bit mask indicating the magnet positions.
16115 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16117 * Get actionslider magnet position.
16119 * @param obj The actionslider object.
16120 * @return The positions with magnet property.
16122 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16124 * Set actionslider enabled position. To set multiple positions as enabled @c or
16125 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16127 * @note All the positions are enabled by default.
16129 * @param obj The actionslider object.
16130 * @param pos Bit mask indicating the enabled positions.
16132 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16134 * Get actionslider enabled position.
16136 * @param obj The actionslider object.
16137 * @return The enabled positions.
16139 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16141 * Set the label used on the indicator.
16143 * @param obj The actionslider object
16144 * @param label The label to be set on the indicator.
16145 * @deprecated use elm_object_text_set() instead.
16147 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16149 * Get the label used on the indicator object.
16151 * @param obj The actionslider object
16152 * @return The indicator label
16153 * @deprecated use elm_object_text_get() instead.
16155 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16161 * @defgroup Genlist Genlist
16163 * @image html img/widget/genlist/preview-00.png
16164 * @image latex img/widget/genlist/preview-00.eps
16165 * @image html img/genlist.png
16166 * @image latex img/genlist.eps
16168 * This widget aims to have more expansive list than the simple list in
16169 * Elementary that could have more flexible items and allow many more entries
16170 * while still being fast and low on memory usage. At the same time it was
16171 * also made to be able to do tree structures. But the price to pay is more
16172 * complexity when it comes to usage. If all you want is a simple list with
16173 * icons and a single label, use the normal @ref List object.
16175 * Genlist has a fairly large API, mostly because it's relatively complex,
16176 * trying to be both expansive, powerful and efficient. First we will begin
16177 * an overview on the theory behind genlist.
16179 * @section Genlist_Item_Class Genlist item classes - creating items
16181 * In order to have the ability to add and delete items on the fly, genlist
16182 * implements a class (callback) system where the application provides a
16183 * structure with information about that type of item (genlist may contain
16184 * multiple different items with different classes, states and styles).
16185 * Genlist will call the functions in this struct (methods) when an item is
16186 * "realized" (i.e., created dynamically, while the user is scrolling the
16187 * grid). All objects will simply be deleted when no longer needed with
16188 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16189 * following members:
16190 * - @c item_style - This is a constant string and simply defines the name
16191 * of the item style. It @b must be specified and the default should be @c
16193 * - @c mode_item_style - This is a constant string and simply defines the
16194 * name of the style that will be used for mode animations. It can be left
16195 * as @c NULL if you don't plan to use Genlist mode. See
16196 * elm_genlist_item_mode_set() for more info.
16198 * - @c func - A struct with pointers to functions that will be called when
16199 * an item is going to be actually created. All of them receive a @c data
16200 * parameter that will point to the same data passed to
16201 * elm_genlist_item_append() and related item creation functions, and a @c
16202 * obj parameter that points to the genlist object itself.
16204 * The function pointers inside @c func are @c label_get, @c icon_get, @c
16205 * state_get and @c del. The 3 first functions also receive a @c part
16206 * parameter described below. A brief description of these functions follows:
16208 * - @c label_get - The @c part parameter is the name string of one of the
16209 * existing text parts in the Edje group implementing the item's theme.
16210 * This function @b must return a strdup'()ed string, as the caller will
16211 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16212 * - @c icon_get - The @c part parameter is the name string of one of the
16213 * existing (icon) swallow parts in the Edje group implementing the item's
16214 * theme. It must return @c NULL, when no icon is desired, or a valid
16215 * object handle, otherwise. The object will be deleted by the genlist on
16216 * its deletion or when the item is "unrealized". See
16217 * #Elm_Genlist_Item_Icon_Get_Cb.
16218 * - @c func.state_get - The @c part parameter is the name string of one of
16219 * the state parts in the Edje group implementing the item's theme. Return
16220 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16221 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16222 * and @c "elm" as "emission" and "source" arguments, respectively, when
16223 * the state is true (the default is false), where @c XXX is the name of
16224 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
16225 * - @c func.del - This is intended for use when genlist items are deleted,
16226 * so any data attached to the item (e.g. its data parameter on creation)
16227 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
16229 * available item styles:
16231 * - default_style - The text part is a textblock
16233 * @image html img/widget/genlist/preview-04.png
16234 * @image latex img/widget/genlist/preview-04.eps
16238 * @image html img/widget/genlist/preview-01.png
16239 * @image latex img/widget/genlist/preview-01.eps
16241 * - icon_top_text_bottom
16243 * @image html img/widget/genlist/preview-02.png
16244 * @image latex img/widget/genlist/preview-02.eps
16248 * @image html img/widget/genlist/preview-03.png
16249 * @image latex img/widget/genlist/preview-03.eps
16251 * @section Genlist_Items Structure of items
16253 * An item in a genlist can have 0 or more text labels (they can be regular
16254 * text or textblock Evas objects - that's up to the style to determine), 0
16255 * or more icons (which are simply objects swallowed into the genlist item's
16256 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16257 * behavior left to the user to define. The Edje part names for each of
16258 * these properties will be looked up, in the theme file for the genlist,
16259 * under the Edje (string) data items named @c "labels", @c "icons" and @c
16260 * "states", respectively. For each of those properties, if more than one
16261 * part is provided, they must have names listed separated by spaces in the
16262 * data fields. For the default genlist item theme, we have @b one label
16263 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16264 * "elm.swallow.end") and @b no state parts.
16266 * A genlist item may be at one of several styles. Elementary provides one
16267 * by default - "default", but this can be extended by system or application
16268 * custom themes/overlays/extensions (see @ref Theme "themes" for more
16271 * @section Genlist_Manipulation Editing and Navigating
16273 * Items can be added by several calls. All of them return a @ref
16274 * Elm_Genlist_Item handle that is an internal member inside the genlist.
16275 * They all take a data parameter that is meant to be used for a handle to
16276 * the applications internal data (eg the struct with the original item
16277 * data). The parent parameter is the parent genlist item this belongs to if
16278 * it is a tree or an indexed group, and NULL if there is no parent. The
16279 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16280 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16281 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16282 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
16283 * is set then this item is group index item that is displayed at the top
16284 * until the next group comes. The func parameter is a convenience callback
16285 * that is called when the item is selected and the data parameter will be
16286 * the func_data parameter, obj be the genlist object and event_info will be
16287 * the genlist item.
16289 * elm_genlist_item_append() adds an item to the end of the list, or if
16290 * there is a parent, to the end of all the child items of the parent.
16291 * elm_genlist_item_prepend() is the same but adds to the beginning of
16292 * the list or children list. elm_genlist_item_insert_before() inserts at
16293 * item before another item and elm_genlist_item_insert_after() inserts after
16294 * the indicated item.
16296 * The application can clear the list with elm_genlist_clear() which deletes
16297 * all the items in the list and elm_genlist_item_del() will delete a specific
16298 * item. elm_genlist_item_subitems_clear() will clear all items that are
16299 * children of the indicated parent item.
16301 * To help inspect list items you can jump to the item at the top of the list
16302 * with elm_genlist_first_item_get() which will return the item pointer, and
16303 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16304 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16305 * and previous items respectively relative to the indicated item. Using
16306 * these calls you can walk the entire item list/tree. Note that as a tree
16307 * the items are flattened in the list, so elm_genlist_item_parent_get() will
16308 * let you know which item is the parent (and thus know how to skip them if
16311 * @section Genlist_Muti_Selection Multi-selection
16313 * If the application wants multiple items to be able to be selected,
16314 * elm_genlist_multi_select_set() can enable this. If the list is
16315 * single-selection only (the default), then elm_genlist_selected_item_get()
16316 * will return the selected item, if any, or NULL I none is selected. If the
16317 * list is multi-select then elm_genlist_selected_items_get() will return a
16318 * list (that is only valid as long as no items are modified (added, deleted,
16319 * selected or unselected)).
16321 * @section Genlist_Usage_Hints Usage hints
16323 * There are also convenience functions. elm_genlist_item_genlist_get() will
16324 * return the genlist object the item belongs to. elm_genlist_item_show()
16325 * will make the scroller scroll to show that specific item so its visible.
16326 * elm_genlist_item_data_get() returns the data pointer set by the item
16327 * creation functions.
16329 * If an item changes (state of boolean changes, label or icons change),
16330 * then use elm_genlist_item_update() to have genlist update the item with
16331 * the new state. Genlist will re-realize the item thus call the functions
16332 * in the _Elm_Genlist_Item_Class for that item.
16334 * To programmatically (un)select an item use elm_genlist_item_selected_set().
16335 * To get its selected state use elm_genlist_item_selected_get(). Similarly
16336 * to expand/contract an item and get its expanded state, use
16337 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16338 * again to make an item disabled (unable to be selected and appear
16339 * differently) use elm_genlist_item_disabled_set() to set this and
16340 * elm_genlist_item_disabled_get() to get the disabled state.
16342 * In general to indicate how the genlist should expand items horizontally to
16343 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16344 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16345 * mode means that if items are too wide to fit, the scroller will scroll
16346 * horizontally. Otherwise items are expanded to fill the width of the
16347 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16348 * to the viewport width and limited to that size. This can be combined with
16349 * a different style that uses edjes' ellipsis feature (cutting text off like
16352 * Items will only call their selection func and callback when first becoming
16353 * selected. Any further clicks will do nothing, unless you enable always
16354 * select with elm_genlist_always_select_mode_set(). This means even if
16355 * selected, every click will make the selected callbacks be called.
16356 * elm_genlist_no_select_mode_set() will turn off the ability to select
16357 * items entirely and they will neither appear selected nor call selected
16358 * callback functions.
16360 * Remember that you can create new styles and add your own theme augmentation
16361 * per application with elm_theme_extension_add(). If you absolutely must
16362 * have a specific style that overrides any theme the user or system sets up
16363 * you can use elm_theme_overlay_add() to add such a file.
16365 * @section Genlist_Implementation Implementation
16367 * Evas tracks every object you create. Every time it processes an event
16368 * (mouse move, down, up etc.) it needs to walk through objects and find out
16369 * what event that affects. Even worse every time it renders display updates,
16370 * in order to just calculate what to re-draw, it needs to walk through many
16371 * many many objects. Thus, the more objects you keep active, the more
16372 * overhead Evas has in just doing its work. It is advisable to keep your
16373 * active objects to the minimum working set you need. Also remember that
16374 * object creation and deletion carries an overhead, so there is a
16375 * middle-ground, which is not easily determined. But don't keep massive lists
16376 * of objects you can't see or use. Genlist does this with list objects. It
16377 * creates and destroys them dynamically as you scroll around. It groups them
16378 * into blocks so it can determine the visibility etc. of a whole block at
16379 * once as opposed to having to walk the whole list. This 2-level list allows
16380 * for very large numbers of items to be in the list (tests have used up to
16381 * 2,000,000 items). Also genlist employs a queue for adding items. As items
16382 * may be different sizes, every item added needs to be calculated as to its
16383 * size and thus this presents a lot of overhead on populating the list, this
16384 * genlist employs a queue. Any item added is queued and spooled off over
16385 * time, actually appearing some time later, so if your list has many members
16386 * you may find it takes a while for them to all appear, with your process
16387 * consuming a lot of CPU while it is busy spooling.
16389 * Genlist also implements a tree structure, but it does so with callbacks to
16390 * the application, with the application filling in tree structures when
16391 * requested (allowing for efficient building of a very deep tree that could
16392 * even be used for file-management). See the above smart signal callbacks for
16395 * @section Genlist_Smart_Events Genlist smart events
16397 * Signals that you can add callbacks for are:
16398 * - @c "activated" - The user has double-clicked or pressed
16399 * (enter|return|spacebar) on an item. The @c event_info parameter is the
16400 * item that was activated.
16401 * - @c "clicked,double" - The user has double-clicked an item. The @c
16402 * event_info parameter is the item that was double-clicked.
16403 * - @c "selected" - This is called when a user has made an item selected.
16404 * The event_info parameter is the genlist item that was selected.
16405 * - @c "unselected" - This is called when a user has made an item
16406 * unselected. The event_info parameter is the genlist item that was
16408 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16409 * called and the item is now meant to be expanded. The event_info
16410 * parameter is the genlist item that was indicated to expand. It is the
16411 * job of this callback to then fill in the child items.
16412 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16413 * called and the item is now meant to be contracted. The event_info
16414 * parameter is the genlist item that was indicated to contract. It is the
16415 * job of this callback to then delete the child items.
16416 * - @c "expand,request" - This is called when a user has indicated they want
16417 * to expand a tree branch item. The callback should decide if the item can
16418 * expand (has any children) and then call elm_genlist_item_expanded_set()
16419 * appropriately to set the state. The event_info parameter is the genlist
16420 * item that was indicated to expand.
16421 * - @c "contract,request" - This is called when a user has indicated they
16422 * want to contract a tree branch item. The callback should decide if the
16423 * item can contract (has any children) and then call
16424 * elm_genlist_item_expanded_set() appropriately to set the state. The
16425 * event_info parameter is the genlist item that was indicated to contract.
16426 * - @c "realized" - This is called when the item in the list is created as a
16427 * real evas object. event_info parameter is the genlist item that was
16428 * created. The object may be deleted at any time, so it is up to the
16429 * caller to not use the object pointer from elm_genlist_item_object_get()
16430 * in a way where it may point to freed objects.
16431 * - @c "unrealized" - This is called just before an item is unrealized.
16432 * After this call icon objects provided will be deleted and the item
16433 * object itself delete or be put into a floating cache.
16434 * - @c "drag,start,up" - This is called when the item in the list has been
16435 * dragged (not scrolled) up.
16436 * - @c "drag,start,down" - This is called when the item in the list has been
16437 * dragged (not scrolled) down.
16438 * - @c "drag,start,left" - This is called when the item in the list has been
16439 * dragged (not scrolled) left.
16440 * - @c "drag,start,right" - This is called when the item in the list has
16441 * been dragged (not scrolled) right.
16442 * - @c "drag,stop" - This is called when the item in the list has stopped
16444 * - @c "drag" - This is called when the item in the list is being dragged.
16445 * - @c "longpressed" - This is called when the item is pressed for a certain
16446 * amount of time. By default it's 1 second.
16447 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16449 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16450 * until the bottom edge.
16451 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16452 * until the left edge.
16453 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16454 * until the right edge.
16455 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16457 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16459 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16461 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16463 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16464 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
16465 * multi-touch pinched in.
16466 * - @c "swipe" - This is called when the genlist is swiped.
16468 * @section Genlist_Examples Examples
16470 * Here is a list of examples that use the genlist, trying to show some of
16471 * its capabilities:
16472 * - @ref genlist_example_01
16473 * - @ref genlist_example_02
16474 * - @ref genlist_example_03
16475 * - @ref genlist_example_04
16476 * - @ref genlist_example_05
16480 * @addtogroup Genlist
16485 * @enum _Elm_Genlist_Item_Flags
16486 * @typedef Elm_Genlist_Item_Flags
16488 * Defines if the item is of any special type (has subitems or it's the
16489 * index of a group), or is just a simple item.
16493 typedef enum _Elm_Genlist_Item_Flags
16495 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16496 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16497 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16498 } Elm_Genlist_Item_Flags;
16499 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
16500 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16501 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16502 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16503 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. */
16504 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. */
16505 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16506 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16508 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16509 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16510 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16511 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16514 * @struct _Elm_Genlist_Item_Class
16516 * Genlist item class definition structs.
16518 * This struct contains the style and fetching functions that will define the
16519 * contents of each item.
16521 * @see @ref Genlist_Item_Class
16523 struct _Elm_Genlist_Item_Class
16525 const char *item_style; /**< style of this class. */
16528 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
16529 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
16530 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
16531 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
16532 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
16534 const char *mode_item_style;
16538 * Add a new genlist widget to the given parent Elementary
16539 * (container) object
16541 * @param parent The parent object
16542 * @return a new genlist widget handle or @c NULL, on errors
16544 * This function inserts a new genlist widget on the canvas.
16546 * @see elm_genlist_item_append()
16547 * @see elm_genlist_item_del()
16548 * @see elm_genlist_clear()
16552 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16554 * Remove all items from a given genlist widget.
16556 * @param obj The genlist object
16558 * This removes (and deletes) all items in @p obj, leaving it empty.
16560 * @see elm_genlist_item_del(), to remove just one item.
16564 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16566 * Enable or disable multi-selection in the genlist
16568 * @param obj The genlist object
16569 * @param multi Multi-select enable/disable. Default is disabled.
16571 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16572 * the list. This allows more than 1 item to be selected. To retrieve the list
16573 * of selected items, use elm_genlist_selected_items_get().
16575 * @see elm_genlist_selected_items_get()
16576 * @see elm_genlist_multi_select_get()
16580 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16582 * Gets if multi-selection in genlist is enabled or disabled.
16584 * @param obj The genlist object
16585 * @return Multi-select enabled/disabled
16586 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16588 * @see elm_genlist_multi_select_set()
16592 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16594 * This sets the horizontal stretching mode.
16596 * @param obj The genlist object
16597 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16599 * This sets the mode used for sizing items horizontally. Valid modes
16600 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16601 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16602 * the scroller will scroll horizontally. Otherwise items are expanded
16603 * to fill the width of the viewport of the scroller. If it is
16604 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16605 * limited to that size.
16607 * @see elm_genlist_horizontal_get()
16611 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16612 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16614 * Gets the horizontal stretching mode.
16616 * @param obj The genlist object
16617 * @return The mode to use
16618 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16620 * @see elm_genlist_horizontal_set()
16624 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16625 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16627 * Set the always select mode.
16629 * @param obj The genlist object
16630 * @param always_select The always select mode (@c EINA_TRUE = on, @c
16631 * EINA_FALSE = off). Default is @c EINA_FALSE.
16633 * Items will only call their selection func and callback when first
16634 * becoming selected. Any further clicks will do nothing, unless you
16635 * enable always select with elm_genlist_always_select_mode_set().
16636 * This means that, even if selected, every click will make the selected
16637 * callbacks be called.
16639 * @see elm_genlist_always_select_mode_get()
16643 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16645 * Get the always select mode.
16647 * @param obj The genlist object
16648 * @return The always select mode
16649 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16651 * @see elm_genlist_always_select_mode_set()
16655 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16657 * Enable/disable the no select mode.
16659 * @param obj The genlist object
16660 * @param no_select The no select mode
16661 * (EINA_TRUE = on, EINA_FALSE = off)
16663 * This will turn off the ability to select items entirely and they
16664 * will neither appear selected nor call selected callback functions.
16666 * @see elm_genlist_no_select_mode_get()
16670 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16672 * Gets whether the no select mode is enabled.
16674 * @param obj The genlist object
16675 * @return The no select mode
16676 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16678 * @see elm_genlist_no_select_mode_set()
16682 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16684 * Enable/disable compress mode.
16686 * @param obj The genlist object
16687 * @param compress The compress mode
16688 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16690 * This will enable the compress mode where items are "compressed"
16691 * horizontally to fit the genlist scrollable viewport width. This is
16692 * special for genlist. Do not rely on
16693 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16694 * work as genlist needs to handle it specially.
16696 * @see elm_genlist_compress_mode_get()
16700 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16702 * Get whether the compress mode is enabled.
16704 * @param obj The genlist object
16705 * @return The compress mode
16706 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16708 * @see elm_genlist_compress_mode_set()
16712 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16714 * Enable/disable height-for-width mode.
16716 * @param obj The genlist object
16717 * @param setting The height-for-width mode (@c EINA_TRUE = on,
16718 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16720 * With height-for-width mode the item width will be fixed (restricted
16721 * to a minimum of) to the list width when calculating its size in
16722 * order to allow the height to be calculated based on it. This allows,
16723 * for instance, text block to wrap lines if the Edje part is
16724 * configured with "text.min: 0 1".
16726 * @note This mode will make list resize slower as it will have to
16727 * recalculate every item height again whenever the list width
16730 * @note When height-for-width mode is enabled, it also enables
16731 * compress mode (see elm_genlist_compress_mode_set()) and
16732 * disables homogeneous (see elm_genlist_homogeneous_set()).
16736 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16738 * Get whether the height-for-width mode is enabled.
16740 * @param obj The genlist object
16741 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16746 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16748 * Enable/disable horizontal and vertical bouncing effect.
16750 * @param obj The genlist object
16751 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16752 * EINA_FALSE = off). Default is @c EINA_FALSE.
16753 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16754 * EINA_FALSE = off). Default is @c EINA_TRUE.
16756 * This will enable or disable the scroller bouncing effect for the
16757 * genlist. See elm_scroller_bounce_set() for details.
16759 * @see elm_scroller_bounce_set()
16760 * @see elm_genlist_bounce_get()
16764 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16766 * Get whether the horizontal and vertical bouncing effect is enabled.
16768 * @param obj The genlist object
16769 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16771 * @param v_bounce Pointer to a bool to receive if the bounce vertically
16774 * @see elm_genlist_bounce_set()
16778 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16780 * Enable/disable homogenous mode.
16782 * @param obj The genlist object
16783 * @param homogeneous Assume the items within the genlist are of the
16784 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16787 * This will enable the homogeneous mode where items are of the same
16788 * height and width so that genlist may do the lazy-loading at its
16789 * maximum (which increases the performance for scrolling the list). This
16790 * implies 'compressed' mode.
16792 * @see elm_genlist_compress_mode_set()
16793 * @see elm_genlist_homogeneous_get()
16797 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16799 * Get whether the homogenous mode is enabled.
16801 * @param obj The genlist object
16802 * @return Assume the items within the genlist are of the same height
16803 * and width (EINA_TRUE = on, EINA_FALSE = off)
16805 * @see elm_genlist_homogeneous_set()
16809 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16811 * Set the maximum number of items within an item block
16813 * @param obj The genlist object
16814 * @param n Maximum number of items within an item block. Default is 32.
16816 * This will configure the block count to tune to the target with
16817 * particular performance matrix.
16819 * A block of objects will be used to reduce the number of operations due to
16820 * many objects in the screen. It can determine the visibility, or if the
16821 * object has changed, it theme needs to be updated, etc. doing this kind of
16822 * calculation to the entire block, instead of per object.
16824 * The default value for the block count is enough for most lists, so unless
16825 * you know you will have a lot of objects visible in the screen at the same
16826 * time, don't try to change this.
16828 * @see elm_genlist_block_count_get()
16829 * @see @ref Genlist_Implementation
16833 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
16835 * Get the maximum number of items within an item block
16837 * @param obj The genlist object
16838 * @return Maximum number of items within an item block
16840 * @see elm_genlist_block_count_set()
16844 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16846 * Set the timeout in seconds for the longpress event.
16848 * @param obj The genlist object
16849 * @param timeout timeout in seconds. Default is 1.
16851 * This option will change how long it takes to send an event "longpressed"
16852 * after the mouse down signal is sent to the list. If this event occurs, no
16853 * "clicked" event will be sent.
16855 * @see elm_genlist_longpress_timeout_set()
16859 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16861 * Get the timeout in seconds for the longpress event.
16863 * @param obj The genlist object
16864 * @return timeout in seconds
16866 * @see elm_genlist_longpress_timeout_get()
16870 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16872 * Append 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 @c NULL if not possible
16883 * This adds the given item to the end of the list or the end of
16884 * the children list if the @p parent is given.
16886 * @see elm_genlist_item_prepend()
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_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);
16895 * Prepend a new item in a given 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 parent The parent item, or NULL if none
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 NULL if not possible
16906 * This adds an item to the beginning of the list or beginning of the
16907 * children of the parent if given.
16909 * @see elm_genlist_item_append()
16910 * @see elm_genlist_item_insert_before()
16911 * @see elm_genlist_item_insert_after()
16912 * @see elm_genlist_item_del()
16916 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);
16918 * Insert an item before 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 before The item to place this new one before.
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 before another in the list. It will be in the
16930 * same tree level or group as the item it is inserted before.
16932 * @see elm_genlist_item_append()
16933 * @see elm_genlist_item_prepend()
16934 * @see elm_genlist_item_insert_after()
16935 * @see elm_genlist_item_del()
16939 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);
16941 * Insert an item after another in a genlist widget
16943 * @param obj The genlist object
16944 * @param itc The item class for the item
16945 * @param data The item data
16946 * @param after The item to place this new one after.
16947 * @param flags Item flags
16948 * @param func Convenience function called when the item is selected
16949 * @param func_data Data passed to @p func above.
16950 * @return A handle to the item added or @c NULL if not possible
16952 * This inserts an item after another in the list. It will be in the
16953 * same tree level or group as the item it is inserted after.
16955 * @see elm_genlist_item_append()
16956 * @see elm_genlist_item_prepend()
16957 * @see elm_genlist_item_insert_before()
16958 * @see elm_genlist_item_del()
16962 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);
16964 * Insert a new item into the sorted genlist object
16966 * @param obj The genlist object
16967 * @param itc The item class for the item
16968 * @param data The item data
16969 * @param parent The parent item, or NULL if none
16970 * @param flags Item flags
16971 * @param comp The function called for the sort
16972 * @param func Convenience function called when item selected
16973 * @param func_data Data passed to @p func above.
16974 * @return A handle to the item added or NULL if not possible
16978 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);
16979 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);
16980 /* operations to retrieve existing items */
16982 * Get the selectd item in the genlist.
16984 * @param obj The genlist object
16985 * @return The selected item, or NULL if none is selected.
16987 * This gets the selected item in the list (if multi-selection is enabled, only
16988 * the item that was first selected in the list is returned - which is not very
16989 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
16992 * If no item is selected, NULL is returned.
16994 * @see elm_genlist_selected_items_get()
16998 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17000 * Get a list of selected items in the genlist.
17002 * @param obj The genlist object
17003 * @return The list of selected items, or NULL if none are selected.
17005 * It returns a list of the selected items. This list pointer is only valid so
17006 * long as the selection doesn't change (no items are selected or unselected, or
17007 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17008 * pointers. The order of the items in this list is the order which they were
17009 * selected, i.e. the first item in this list is the first item that was
17010 * selected, and so on.
17012 * @note If not in multi-select mode, consider using function
17013 * elm_genlist_selected_item_get() instead.
17015 * @see elm_genlist_multi_select_set()
17016 * @see elm_genlist_selected_item_get()
17020 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17022 * Get a list of realized items in genlist
17024 * @param obj The genlist object
17025 * @return The list of realized items, nor NULL if none are realized.
17027 * This returns a list of the realized items in the genlist. The list
17028 * contains Elm_Genlist_Item pointers. The list must be freed by the
17029 * caller when done with eina_list_free(). The item pointers in the
17030 * list are only valid so long as those items are not deleted or the
17031 * genlist is not deleted.
17033 * @see elm_genlist_realized_items_update()
17037 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17039 * Get the item that is at the x, y canvas coords.
17041 * @param obj The gelinst object.
17042 * @param x The input x coordinate
17043 * @param y The input y coordinate
17044 * @param posret The position relative to the item returned here
17045 * @return The item at the coordinates or NULL if none
17047 * This returns the item at the given coordinates (which are canvas
17048 * relative, not object-relative). If an item is at that coordinate,
17049 * that item handle is returned, and if @p posret is not NULL, the
17050 * integer pointed to is set to a value of -1, 0 or 1, depending if
17051 * the coordinate is on the upper portion of that item (-1), on the
17052 * middle section (0) or on the lower part (1). If NULL is returned as
17053 * an item (no item found there), then posret may indicate -1 or 1
17054 * based if the coordinate is above or below all items respectively in
17059 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);
17061 * Get the first item in the genlist
17063 * This returns the first item in the list.
17065 * @param obj The genlist object
17066 * @return The first item, or NULL if none
17070 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17072 * Get the last item in the genlist
17074 * This returns the last item in the list.
17076 * @return The last item, or NULL if none
17080 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17082 * Set the scrollbar policy
17084 * @param obj The genlist object
17085 * @param policy_h Horizontal scrollbar policy.
17086 * @param policy_v Vertical scrollbar policy.
17088 * This sets the scrollbar visibility policy for the given genlist
17089 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17090 * made visible if it is needed, and otherwise kept hidden.
17091 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17092 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17093 * respectively for the horizontal and vertical scrollbars. Default is
17094 * #ELM_SMART_SCROLLER_POLICY_AUTO
17096 * @see elm_genlist_scroller_policy_get()
17100 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17102 * Get the scrollbar policy
17104 * @param obj The genlist object
17105 * @param policy_h Pointer to store the horizontal scrollbar policy.
17106 * @param policy_v Pointer to store the vertical scrollbar policy.
17108 * @see elm_genlist_scroller_policy_set()
17112 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);
17114 * Get the @b next item in a genlist widget's internal list of items,
17115 * given a handle to one of those items.
17117 * @param item The genlist item to fetch next from
17118 * @return The item after @p item, or @c NULL if there's none (and
17121 * This returns the item placed after the @p item, on the container
17124 * @see elm_genlist_item_prev_get()
17128 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17130 * Get the @b previous item in a genlist widget's internal list of items,
17131 * given a handle to one of those items.
17133 * @param item The genlist item to fetch previous from
17134 * @return The item before @p item, or @c NULL if there's none (and
17137 * This returns the item placed before the @p item, on the container
17140 * @see elm_genlist_item_next_get()
17144 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17146 * Get the genlist object's handle which contains a given genlist
17149 * @param item The item to fetch the container from
17150 * @return The genlist (parent) object
17152 * This returns the genlist object itself that an item belongs to.
17156 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17158 * Get the parent item of the given item
17160 * @param it The item
17161 * @return The parent of the item or @c NULL if it has no parent.
17163 * This returns the item that was specified as parent of the item @p it on
17164 * elm_genlist_item_append() and insertion related functions.
17168 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17170 * Remove all sub-items (children) of the given item
17172 * @param it The item
17174 * This removes all items that are children (and their descendants) of the
17175 * given item @p it.
17177 * @see elm_genlist_clear()
17178 * @see elm_genlist_item_del()
17182 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17184 * Set whether a given genlist item is selected or not
17186 * @param it The item
17187 * @param selected Use @c EINA_TRUE, to make it selected, @c
17188 * EINA_FALSE to make it unselected
17190 * This sets the selected state of an item. If multi selection is
17191 * not enabled on the containing genlist and @p selected is @c
17192 * EINA_TRUE, any other previously selected items will get
17193 * unselected in favor of this new one.
17195 * @see elm_genlist_item_selected_get()
17199 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17201 * Get whether a given genlist item is selected or not
17203 * @param it The item
17204 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17206 * @see elm_genlist_item_selected_set() for more details
17210 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17212 * Sets the expanded state of an item.
17214 * @param it The item
17215 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17217 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17220 * The theme will respond to this change visually, and a signal "expanded" or
17221 * "contracted" will be sent from the genlist with a pointer to the item that
17222 * has been expanded/contracted.
17224 * Calling this function won't show or hide any child of this item (if it is
17225 * a parent). You must manually delete and create them on the callbacks fo
17226 * the "expanded" or "contracted" signals.
17228 * @see elm_genlist_item_expanded_get()
17232 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17234 * Get the expanded state of an item
17236 * @param it The item
17237 * @return The expanded state
17239 * This gets the expanded state of an item.
17241 * @see elm_genlist_item_expanded_set()
17245 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17247 * Get the depth of expanded item
17249 * @param it The genlist item object
17250 * @return The depth of expanded item
17254 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17256 * Set whether a given genlist item is disabled or not.
17258 * @param it The item
17259 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17260 * to enable it back.
17262 * A disabled item cannot be selected or unselected. It will also
17263 * change its appearance, to signal the user it's disabled.
17265 * @see elm_genlist_item_disabled_get()
17269 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17271 * Get whether a given genlist item is disabled or not.
17273 * @param it The item
17274 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17277 * @see elm_genlist_item_disabled_set() for more details
17281 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17283 * Sets the display only state of an item.
17285 * @param it The item
17286 * @param display_only @c EINA_TRUE if the item is display only, @c
17287 * EINA_FALSE otherwise.
17289 * A display only item cannot be selected or unselected. It is for
17290 * display only and not selecting or otherwise clicking, dragging
17291 * etc. by the user, thus finger size rules will not be applied to
17294 * It's good to set group index items to display only state.
17296 * @see elm_genlist_item_display_only_get()
17300 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17302 * Get the display only state of an item
17304 * @param it The item
17305 * @return @c EINA_TRUE if the item is display only, @c
17306 * EINA_FALSE otherwise.
17308 * @see elm_genlist_item_display_only_set()
17312 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17314 * Show the portion of a genlist's internal list containing a given
17315 * item, immediately.
17317 * @param it The item to display
17319 * This causes genlist to jump to the given item @p it and show it (by
17320 * immediately scrolling to that position), if it is not fully visible.
17322 * @see elm_genlist_item_bring_in()
17323 * @see elm_genlist_item_top_show()
17324 * @see elm_genlist_item_middle_show()
17328 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17330 * Animatedly bring in, to the visible are of a genlist, a given
17333 * @param it The item to display
17335 * This causes genlist to jump to the given item @p it and show it (by
17336 * animatedly scrolling), if it is not fully visible. This may use animation
17337 * to do so and take a period of time
17339 * @see elm_genlist_item_show()
17340 * @see elm_genlist_item_top_bring_in()
17341 * @see elm_genlist_item_middle_bring_in()
17345 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17347 * Show the portion of a genlist's internal list containing a given
17348 * item, immediately.
17350 * @param it The item to display
17352 * This causes genlist to jump to the given item @p it and show it (by
17353 * immediately scrolling to that position), if it is not fully visible.
17355 * The item will be positioned at the top of the genlist viewport.
17357 * @see elm_genlist_item_show()
17358 * @see elm_genlist_item_top_bring_in()
17362 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17364 * Animatedly bring in, to the visible are of a genlist, a given
17367 * @param it The item
17369 * This causes genlist to jump to the given item @p it and show it (by
17370 * animatedly scrolling), if it is not fully visible. This may use animation
17371 * to do so and take a period of time
17373 * The item will be positioned at the top of the genlist viewport.
17375 * @see elm_genlist_item_bring_in()
17376 * @see elm_genlist_item_top_show()
17380 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17382 * Show the portion of a genlist's internal list containing a given
17383 * item, immediately.
17385 * @param it The item to display
17387 * This causes genlist to jump to the given item @p it and show it (by
17388 * immediately scrolling to that position), if it is not fully visible.
17390 * The item will be positioned at the middle of the genlist viewport.
17392 * @see elm_genlist_item_show()
17393 * @see elm_genlist_item_middle_bring_in()
17397 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17399 * Animatedly bring in, to the visible are of a genlist, a given
17402 * @param it The item
17404 * This causes genlist to jump to the given item @p it and show it (by
17405 * animatedly scrolling), if it is not fully visible. This may use animation
17406 * to do so and take a period of time
17408 * The item will be positioned at the middle of the genlist viewport.
17410 * @see elm_genlist_item_bring_in()
17411 * @see elm_genlist_item_middle_show()
17415 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17417 * Remove a genlist item from the its parent, deleting it.
17419 * @param item The item to be removed.
17420 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17422 * @see elm_genlist_clear(), to remove all items in a genlist at
17427 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17429 * Return the data associated to a given genlist item
17431 * @param item The genlist item.
17432 * @return the data associated to this item.
17434 * This returns the @c data value passed on the
17435 * elm_genlist_item_append() and related item addition calls.
17437 * @see elm_genlist_item_append()
17438 * @see elm_genlist_item_data_set()
17442 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17444 * Set the data associated to a given genlist item
17446 * @param item The genlist item
17447 * @param data The new data pointer to set on it
17449 * This @b overrides the @c data value passed on the
17450 * elm_genlist_item_append() and related item addition calls. This
17451 * function @b won't call elm_genlist_item_update() automatically,
17452 * so you'd issue it afterwards if you want to hove the item
17453 * updated to reflect the that new data.
17455 * @see elm_genlist_item_data_get()
17459 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17461 * Tells genlist to "orphan" icons fetchs by the item class
17463 * @param it The item
17465 * This instructs genlist to release references to icons in the item,
17466 * meaning that they will no longer be managed by genlist and are
17467 * floating "orphans" that can be re-used elsewhere if the user wants
17472 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17474 * Get the real Evas object created to implement the view of a
17475 * given genlist item
17477 * @param item The genlist item.
17478 * @return the Evas object implementing this item's view.
17480 * This returns the actual Evas object used to implement the
17481 * specified genlist item's view. This may be @c NULL, as it may
17482 * not have been created or may have been deleted, at any time, by
17483 * the genlist. <b>Do not modify this object</b> (move, resize,
17484 * show, hide, etc.), as the genlist is controlling it. This
17485 * function is for querying, emitting custom signals or hooking
17486 * lower level callbacks for events on that object. Do not delete
17487 * this object under any circumstances.
17489 * @see elm_genlist_item_data_get()
17493 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17495 * Update the contents of an item
17497 * @param it The item
17499 * This updates an item by calling all the item class functions again
17500 * to get the icons, labels and states. Use this when the original
17501 * item data has changed and the changes are desired to be reflected.
17503 * Use elm_genlist_realized_items_update() to update all already realized
17506 * @see elm_genlist_realized_items_update()
17510 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17512 * Update the item class of an item
17514 * @param it The item
17515 * @param itc The item class for the item
17517 * This sets another class fo the item, changing the way that it is
17518 * displayed. After changing the item class, elm_genlist_item_update() is
17519 * called on the item @p it.
17523 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17524 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17526 * Set the text to be shown in a given genlist item's tooltips.
17528 * @param item The genlist item
17529 * @param text The text to set in the content
17531 * This call will setup the text to be used as tooltip to that item
17532 * (analogous to elm_object_tooltip_text_set(), but being item
17533 * tooltips with higher precedence than object tooltips). It can
17534 * have only one tooltip at a time, so any previous tooltip data
17535 * will get removed.
17537 * In order to set an icon or something else as a tooltip, look at
17538 * elm_genlist_item_tooltip_content_cb_set().
17542 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17544 * Set the content to be shown in a given genlist item's tooltips
17546 * @param item The genlist item.
17547 * @param func The function returning the tooltip contents.
17548 * @param data What to provide to @a func as callback data/context.
17549 * @param del_cb Called when data is not needed anymore, either when
17550 * another callback replaces @p func, the tooltip is unset with
17551 * elm_genlist_item_tooltip_unset() or the owner @p item
17552 * dies. This callback receives as its first parameter the
17553 * given @p data, being @c event_info the item handle.
17555 * This call will setup the tooltip's contents to @p item
17556 * (analogous to elm_object_tooltip_content_cb_set(), but being
17557 * item tooltips with higher precedence than object tooltips). It
17558 * can have only one tooltip at a time, so any previous tooltip
17559 * content will get removed. @p func (with @p data) will be called
17560 * every time Elementary needs to show the tooltip and it should
17561 * return a valid Evas object, which will be fully managed by the
17562 * tooltip system, getting deleted when the tooltip is gone.
17564 * In order to set just a text as a tooltip, look at
17565 * elm_genlist_item_tooltip_text_set().
17569 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);
17571 * Unset a tooltip from a given genlist item
17573 * @param item genlist item to remove a previously set tooltip from.
17575 * This call removes any tooltip set on @p item. The callback
17576 * provided as @c del_cb to
17577 * elm_genlist_item_tooltip_content_cb_set() will be called to
17578 * notify it is not used anymore (and have resources cleaned, if
17581 * @see elm_genlist_item_tooltip_content_cb_set()
17585 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17587 * Set a different @b style for a given genlist item's tooltip.
17589 * @param item genlist item with tooltip set
17590 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17591 * "default", @c "transparent", etc)
17593 * Tooltips can have <b>alternate styles</b> to be displayed on,
17594 * which are defined by the theme set on Elementary. This function
17595 * works analogously as elm_object_tooltip_style_set(), but here
17596 * applied only to genlist item objects. The default style for
17597 * tooltips is @c "default".
17599 * @note before you set a style you should define a tooltip with
17600 * elm_genlist_item_tooltip_content_cb_set() or
17601 * elm_genlist_item_tooltip_text_set()
17603 * @see elm_genlist_item_tooltip_style_get()
17607 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17609 * Get the style set a given genlist item's tooltip.
17611 * @param item genlist item with tooltip already set on.
17612 * @return style the theme style in use, which defaults to
17613 * "default". If the object does not have a tooltip set,
17614 * then @c NULL is returned.
17616 * @see elm_genlist_item_tooltip_style_set() for more details
17620 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17622 * @brief Disable size restrictions on an object's tooltip
17623 * @param item The tooltip's anchor object
17624 * @param disable If EINA_TRUE, size restrictions are disabled
17625 * @return EINA_FALSE on failure, EINA_TRUE on success
17627 * This function allows a tooltip to expand beyond its parant window's canvas.
17628 * It will instead be limited only by the size of the display.
17630 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17632 * @brief Retrieve size restriction state of an object's tooltip
17633 * @param item The tooltip's anchor object
17634 * @return If EINA_TRUE, size restrictions are disabled
17636 * This function returns whether a tooltip is allowed to expand beyond
17637 * its parant window's canvas.
17638 * It will instead be limited only by the size of the display.
17640 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17642 * Set the type of mouse pointer/cursor decoration to be shown,
17643 * when the mouse pointer is over the given genlist widget item
17645 * @param item genlist item to customize cursor on
17646 * @param cursor the cursor type's name
17648 * This function works analogously as elm_object_cursor_set(), but
17649 * here the cursor's changing area is restricted to the item's
17650 * area, and not the whole widget's. Note that that item cursors
17651 * have precedence over widget cursors, so that a mouse over @p
17652 * item will always show cursor @p type.
17654 * If this function is called twice for an object, a previously set
17655 * cursor will be unset on the second call.
17657 * @see elm_object_cursor_set()
17658 * @see elm_genlist_item_cursor_get()
17659 * @see elm_genlist_item_cursor_unset()
17663 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17665 * Get the type of mouse pointer/cursor decoration set to be shown,
17666 * when the mouse pointer is over the given genlist widget item
17668 * @param item genlist item with custom cursor set
17669 * @return the cursor type's name or @c NULL, if no custom cursors
17670 * were set to @p item (and on errors)
17672 * @see elm_object_cursor_get()
17673 * @see elm_genlist_item_cursor_set() for more details
17674 * @see elm_genlist_item_cursor_unset()
17678 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17680 * Unset any custom mouse pointer/cursor decoration set to be
17681 * shown, when the mouse pointer is over the given genlist widget
17682 * item, thus making it show the @b default cursor again.
17684 * @param item a genlist item
17686 * Use this call to undo any custom settings on this item's cursor
17687 * decoration, bringing it back to defaults (no custom style set).
17689 * @see elm_object_cursor_unset()
17690 * @see elm_genlist_item_cursor_set() for more details
17694 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17696 * Set a different @b style for a given custom cursor set for a
17699 * @param item genlist item with custom cursor set
17700 * @param style the <b>theme style</b> to use (e.g. @c "default",
17701 * @c "transparent", etc)
17703 * This function only makes sense when one is using custom mouse
17704 * cursor decorations <b>defined in a theme file</b> , which can
17705 * have, given a cursor name/type, <b>alternate styles</b> on
17706 * it. It works analogously as elm_object_cursor_style_set(), but
17707 * here applied only to genlist item objects.
17709 * @warning Before you set a cursor style you should have defined a
17710 * custom cursor previously on the item, with
17711 * elm_genlist_item_cursor_set()
17713 * @see elm_genlist_item_cursor_engine_only_set()
17714 * @see elm_genlist_item_cursor_style_get()
17718 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17720 * Get the current @b style set for a given genlist item's custom
17723 * @param item genlist item with custom cursor set.
17724 * @return style the cursor style in use. If the object does not
17725 * have a cursor set, then @c NULL is returned.
17727 * @see elm_genlist_item_cursor_style_set() for more details
17731 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17733 * Set if the (custom) cursor for a given genlist item should be
17734 * searched in its theme, also, or should only rely on the
17735 * rendering engine.
17737 * @param item item with custom (custom) cursor already set on
17738 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17739 * only on those provided by the rendering engine, @c EINA_FALSE to
17740 * have them searched on the widget's theme, as well.
17742 * @note This call is of use only if you've set a custom cursor
17743 * for genlist items, with elm_genlist_item_cursor_set().
17745 * @note By default, cursors will only be looked for between those
17746 * provided by the rendering engine.
17750 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17752 * Get if the (custom) cursor for a given genlist item is being
17753 * searched in its theme, also, or is only relying on the rendering
17756 * @param item a genlist item
17757 * @return @c EINA_TRUE, if cursors are being looked for only on
17758 * those provided by the rendering engine, @c EINA_FALSE if they
17759 * are being searched on the widget's theme, as well.
17761 * @see elm_genlist_item_cursor_engine_only_set(), for more details
17765 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17767 * Update the contents of all realized items.
17769 * @param obj The genlist object.
17771 * This updates all realized items by calling all the item class functions again
17772 * to get the icons, labels and states. Use this when the original
17773 * item data has changed and the changes are desired to be reflected.
17775 * To update just one item, use elm_genlist_item_update().
17777 * @see elm_genlist_realized_items_get()
17778 * @see elm_genlist_item_update()
17782 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17784 * Activate a genlist mode on an item
17786 * @param item The genlist item
17787 * @param mode Mode name
17788 * @param mode_set Boolean to define set or unset mode.
17790 * A genlist mode is a different way of selecting an item. Once a mode is
17791 * activated on an item, any other selected item is immediately unselected.
17792 * This feature provides an easy way of implementing a new kind of animation
17793 * for selecting an item, without having to entirely rewrite the item style
17794 * theme. However, the elm_genlist_selected_* API can't be used to get what
17795 * item is activate for a mode.
17797 * The current item style will still be used, but applying a genlist mode to
17798 * an item will select it using a different kind of animation.
17800 * The current active item for a mode can be found by
17801 * elm_genlist_mode_item_get().
17803 * The characteristics of genlist mode are:
17804 * - Only one mode can be active at any time, and for only one item.
17805 * - Genlist handles deactivating other items when one item is activated.
17806 * - A mode is defined in the genlist theme (edc), and more modes can easily
17808 * - A mode style and the genlist item style are different things. They
17809 * can be combined to provide a default style to the item, with some kind
17810 * of animation for that item when the mode is activated.
17812 * When a mode is activated on an item, a new view for that item is created.
17813 * The theme of this mode defines the animation that will be used to transit
17814 * the item from the old view to the new view. This second (new) view will be
17815 * active for that item while the mode is active on the item, and will be
17816 * destroyed after the mode is totally deactivated from that item.
17818 * @see elm_genlist_mode_get()
17819 * @see elm_genlist_mode_item_get()
17823 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
17825 * Get the last (or current) genlist mode used.
17827 * @param obj The genlist object
17829 * This function just returns the name of the last used genlist mode. It will
17830 * be the current mode if it's still active.
17832 * @see elm_genlist_item_mode_set()
17833 * @see elm_genlist_mode_item_get()
17837 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17839 * Get active genlist mode item
17841 * @param obj The genlist object
17842 * @return The active item for that current mode. Or @c NULL if no item is
17843 * activated with any mode.
17845 * This function returns the item that was activated with a mode, by the
17846 * function elm_genlist_item_mode_set().
17848 * @see elm_genlist_item_mode_set()
17849 * @see elm_genlist_mode_get()
17853 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17858 * @param obj The genlist object
17859 * @param reorder_mode The reorder mode
17860 * (EINA_TRUE = on, EINA_FALSE = off)
17864 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
17867 * Get the reorder mode
17869 * @param obj The genlist object
17870 * @return The reorder mode
17871 * (EINA_TRUE = on, EINA_FALSE = off)
17875 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17882 * @defgroup Check Check
17884 * @image html img/widget/check/preview-00.png
17885 * @image latex img/widget/check/preview-00.eps
17886 * @image html img/widget/check/preview-01.png
17887 * @image latex img/widget/check/preview-01.eps
17888 * @image html img/widget/check/preview-02.png
17889 * @image latex img/widget/check/preview-02.eps
17891 * @brief The check widget allows for toggling a value between true and
17894 * Check objects are a lot like radio objects in layout and functionality
17895 * except they do not work as a group, but independently and only toggle the
17896 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
17897 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
17898 * returns the current state. For convenience, like the radio objects, you
17899 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
17900 * for it to modify.
17902 * Signals that you can add callbacks for are:
17903 * "changed" - This is called whenever the user changes the state of one of
17904 * the check object(event_info is NULL).
17906 * @ref tutorial_check should give you a firm grasp of how to use this widget.
17910 * @brief Add a new Check object
17912 * @param parent The parent object
17913 * @return The new object or NULL if it cannot be created
17915 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17917 * @brief Set the text label of the check object
17919 * @param obj The check object
17920 * @param label The text label string in UTF-8
17922 * @deprecated use elm_object_text_set() instead.
17924 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17926 * @brief Get the text label of the check object
17928 * @param obj The check object
17929 * @return The text label string in UTF-8
17931 * @deprecated use elm_object_text_get() instead.
17933 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17935 * @brief Set the icon object of the check object
17937 * @param obj The check object
17938 * @param icon The icon object
17940 * Once the icon object is set, a previously set one will be deleted.
17941 * If you want to keep that old content object, use the
17942 * elm_check_icon_unset() function.
17944 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17946 * @brief Get the icon object of the check object
17948 * @param obj The check object
17949 * @return The icon object
17951 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17953 * @brief Unset the icon used for the check object
17955 * @param obj The check object
17956 * @return The icon object that was being used
17958 * Unparent and return the icon object which was set for this widget.
17960 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17962 * @brief Set the on/off state of the check object
17964 * @param obj The check object
17965 * @param state The state to use (1 == on, 0 == off)
17967 * This sets the state of the check. If set
17968 * with elm_check_state_pointer_set() the state of that variable is also
17969 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
17971 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17973 * @brief Get the state of the check object
17975 * @param obj The check object
17976 * @return The boolean state
17978 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17980 * @brief Set a convenience pointer to a boolean to change
17982 * @param obj The check object
17983 * @param statep Pointer to the boolean to modify
17985 * This sets a pointer to a boolean, that, in addition to the check objects
17986 * state will also be modified directly. To stop setting the object pointed
17987 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
17988 * then when this is called, the check objects state will also be modified to
17989 * reflect the value of the boolean @p statep points to, just like calling
17990 * elm_check_state_set().
17992 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
17998 * @defgroup Radio Radio
18000 * @image html img/widget/radio/preview-00.png
18001 * @image latex img/widget/radio/preview-00.eps
18003 * @brief Radio is a widget that allows for 1 or more options to be displayed
18004 * and have the user choose only 1 of them.
18006 * A radio object contains an indicator, an optional Label and an optional
18007 * icon object. While it's possible to have a group of only one radio they,
18008 * are normally used in groups of 2 or more. To add a radio to a group use
18009 * elm_radio_group_add(). The radio object(s) will select from one of a set
18010 * of integer values, so any value they are configuring needs to be mapped to
18011 * a set of integers. To configure what value that radio object represents,
18012 * use elm_radio_state_value_set() to set the integer it represents. To set
18013 * the value the whole group(which one is currently selected) is to indicate
18014 * use elm_radio_value_set() on any group member, and to get the groups value
18015 * use elm_radio_value_get(). For convenience the radio objects are also able
18016 * to directly set an integer(int) to the value that is selected. To specify
18017 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18018 * The radio objects will modify this directly. That implies the pointer must
18019 * point to valid memory for as long as the radio objects exist.
18021 * Signals that you can add callbacks for are:
18022 * @li changed - This is called whenever the user changes the state of one of
18023 * the radio objects within the group of radio objects that work together.
18025 * @ref tutorial_radio show most of this API in action.
18029 * @brief Add a new radio to the parent
18031 * @param parent The parent object
18032 * @return The new object or NULL if it cannot be created
18034 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18036 * @brief Set the text label of the radio object
18038 * @param obj The radio object
18039 * @param label The text label string in UTF-8
18041 * @deprecated use elm_object_text_set() instead.
18043 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18045 * @brief Get the text label of the radio object
18047 * @param obj The radio object
18048 * @return The text label string in UTF-8
18050 * @deprecated use elm_object_text_set() instead.
18052 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18054 * @brief Set the icon object of the radio object
18056 * @param obj The radio object
18057 * @param icon The icon object
18059 * Once the icon object is set, a previously set one will be deleted. If you
18060 * want to keep that old content object, use the elm_radio_icon_unset()
18063 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18065 * @brief Get the icon object of the radio object
18067 * @param obj The radio object
18068 * @return The icon object
18070 * @see elm_radio_icon_set()
18072 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18074 * @brief Unset the icon used for the radio object
18076 * @param obj The radio object
18077 * @return The icon object that was being used
18079 * Unparent and return the icon object which was set for this widget.
18081 * @see elm_radio_icon_set()
18083 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18085 * @brief Add this radio to a group of other radio objects
18087 * @param obj The radio object
18088 * @param group Any object whose group the @p obj is to join.
18090 * Radio objects work in groups. Each member should have a different integer
18091 * value assigned. In order to have them work as a group, they need to know
18092 * about each other. This adds the given radio object to the group of which
18093 * the group object indicated is a member.
18095 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18097 * @brief Set the integer value that this radio object represents
18099 * @param obj The radio object
18100 * @param value The value to use if this radio object is selected
18102 * This sets the value of the radio.
18104 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18106 * @brief Get the integer value that this radio object represents
18108 * @param obj The radio object
18109 * @return The value used if this radio object is selected
18111 * This gets the value of the radio.
18113 * @see elm_radio_value_set()
18115 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18117 * @brief Set the value of the radio.
18119 * @param obj The radio object
18120 * @param value The value to use for the group
18122 * This sets the value of the radio group and will also set the value if
18123 * pointed to, to the value supplied, but will not call any callbacks.
18125 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18127 * @brief Get the state of the radio object
18129 * @param obj The radio object
18130 * @return The integer state
18132 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18134 * @brief Set a convenience pointer to a integer to change
18136 * @param obj The radio object
18137 * @param valuep Pointer to the integer to modify
18139 * This sets a pointer to a integer, that, in addition to the radio objects
18140 * state will also be modified directly. To stop setting the object pointed
18141 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18142 * when this is called, the radio objects state will also be modified to
18143 * reflect the value of the integer valuep points to, just like calling
18144 * elm_radio_value_set().
18146 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18152 * @defgroup Pager Pager
18154 * @image html img/widget/pager/preview-00.png
18155 * @image latex img/widget/pager/preview-00.eps
18157 * @brief Widget that allows flipping between 1 or more “pages” of objects.
18159 * The flipping between “pages” of objects is animated. All content in pager
18160 * is kept in a stack, the last content to be added will be on the top of the
18161 * stack(be visible).
18163 * Objects can be pushed or popped from the stack or deleted as normal.
18164 * Pushes and pops will animate (and a pop will delete the object once the
18165 * animation is finished). Any object already in the pager can be promoted to
18166 * the top(from its current stacking position) through the use of
18167 * elm_pager_content_promote(). Objects are pushed to the top with
18168 * elm_pager_content_push() and when the top item is no longer wanted, simply
18169 * pop it with elm_pager_content_pop() and it will also be deleted. If an
18170 * object is no longer needed and is not the top item, just delete it as
18171 * normal. You can query which objects are the top and bottom with
18172 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18174 * Signals that you can add callbacks for are:
18175 * "hide,finished" - when the previous page is hided
18177 * This widget has the following styles available:
18180 * @li fade_translucide
18181 * @li fade_invisible
18182 * @note This styles affect only the flipping animations, the appearance when
18183 * not animating is unaffected by styles.
18185 * @ref tutorial_pager gives a good overview of the usage of the API.
18189 * Add a new pager to the parent
18191 * @param parent The parent object
18192 * @return The new object or NULL if it cannot be created
18196 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18198 * @brief Push an object to the top of the pager stack (and show it).
18200 * @param obj The pager object
18201 * @param content The object to push
18203 * The object pushed becomes a child of the pager, it will be controlled and
18204 * deleted when the pager is deleted.
18206 * @note If the content is already in the stack use
18207 * elm_pager_content_promote().
18208 * @warning Using this function on @p content already in the stack results in
18209 * undefined behavior.
18211 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18213 * @brief Pop the object that is on top of the stack
18215 * @param obj The pager object
18217 * This pops the object that is on the top(visible) of the pager, makes it
18218 * disappear, then deletes the object. The object that was underneath it on
18219 * the stack will become visible.
18221 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18223 * @brief Moves an object already in the pager stack to the top of the stack.
18225 * @param obj The pager object
18226 * @param content The object to promote
18228 * This will take the @p content and move it to the top of the stack as
18229 * if it had been pushed there.
18231 * @note If the content isn't already in the stack use
18232 * elm_pager_content_push().
18233 * @warning Using this function on @p content not already in the stack
18234 * results in undefined behavior.
18236 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18238 * @brief Return the object at the bottom of the pager stack
18240 * @param obj The pager object
18241 * @return The bottom object or NULL if none
18243 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18245 * @brief Return the object at the top of the pager stack
18247 * @param obj The pager object
18248 * @return The top object or NULL if none
18250 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18256 * @defgroup Slideshow Slideshow
18258 * @image html img/widget/slideshow/preview-00.png
18259 * @image latex img/widget/slideshow/preview-00.eps
18261 * This widget, as the name indicates, is a pre-made image
18262 * slideshow panel, with API functions acting on (child) image
18263 * items presentation. Between those actions, are:
18264 * - advance to next/previous image
18265 * - select the style of image transition animation
18266 * - set the exhibition time for each image
18267 * - start/stop the slideshow
18269 * The transition animations are defined in the widget's theme,
18270 * consequently new animations can be added without having to
18271 * update the widget's code.
18273 * @section Slideshow_Items Slideshow items
18275 * For slideshow items, just like for @ref Genlist "genlist" ones,
18276 * the user defines a @b classes, specifying functions that will be
18277 * called on the item's creation and deletion times.
18279 * The #Elm_Slideshow_Item_Class structure contains the following
18282 * - @c func.get - When an item is displayed, this function is
18283 * called, and it's where one should create the item object, de
18284 * facto. For example, the object can be a pure Evas image object
18285 * or an Elementary @ref Photocam "photocam" widget. See
18286 * #SlideshowItemGetFunc.
18287 * - @c func.del - When an item is no more displayed, this function
18288 * is called, where the user must delete any data associated to
18289 * the item. See #SlideshowItemDelFunc.
18291 * @section Slideshow_Caching Slideshow caching
18293 * The slideshow provides facilities to have items adjacent to the
18294 * one being displayed <b>already "realized"</b> (i.e. loaded) for
18295 * you, so that the system does not have to decode image data
18296 * anymore at the time it has to actually switch images on its
18297 * viewport. The user is able to set the numbers of items to be
18298 * cached @b before and @b after the current item, in the widget's
18301 * Smart events one can add callbacks for are:
18303 * - @c "changed" - when the slideshow switches its view to a new
18306 * List of examples for the slideshow widget:
18307 * @li @ref slideshow_example
18311 * @addtogroup Slideshow
18315 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18316 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18317 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
18318 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18319 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18322 * @struct _Elm_Slideshow_Item_Class
18324 * Slideshow item class definition. See @ref Slideshow_Items for
18327 struct _Elm_Slideshow_Item_Class
18329 struct _Elm_Slideshow_Item_Class_Func
18331 SlideshowItemGetFunc get;
18332 SlideshowItemDelFunc del;
18334 }; /**< #Elm_Slideshow_Item_Class member definitions */
18337 * Add a new slideshow widget to the given parent Elementary
18338 * (container) object
18340 * @param parent The parent object
18341 * @return A new slideshow widget handle or @c NULL, on errors
18343 * This function inserts a new slideshow widget on the canvas.
18345 * @ingroup Slideshow
18347 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18350 * Add (append) a new item in a given slideshow widget.
18352 * @param obj The slideshow object
18353 * @param itc The item class for the item
18354 * @param data The item's data
18355 * @return A handle to the item added or @c NULL, on errors
18357 * Add a new item to @p obj's internal list of items, appending it.
18358 * The item's class must contain the function really fetching the
18359 * image object to show for this item, which could be an Evas image
18360 * object or an Elementary photo, for example. The @p data
18361 * parameter is going to be passed to both class functions of the
18364 * @see #Elm_Slideshow_Item_Class
18365 * @see elm_slideshow_item_sorted_insert()
18367 * @ingroup Slideshow
18369 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18372 * Insert a new item into the given slideshow widget, using the @p func
18373 * function to sort items (by item handles).
18375 * @param obj The slideshow object
18376 * @param itc The item class for the item
18377 * @param data The item's data
18378 * @param func The comparing function to be used to sort slideshow
18379 * items <b>by #Elm_Slideshow_Item item handles</b>
18380 * @return Returns The slideshow item handle, on success, or
18381 * @c NULL, on errors
18383 * Add a new item to @p obj's internal list of items, in a position
18384 * determined by the @p func comparing function. The item's class
18385 * must contain the function really fetching the image object to
18386 * show for this item, which could be an Evas image object or an
18387 * Elementary photo, for example. The @p data parameter is going to
18388 * be passed to both class functions of the item.
18390 * @see #Elm_Slideshow_Item_Class
18391 * @see elm_slideshow_item_add()
18393 * @ingroup Slideshow
18395 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);
18398 * Display a given slideshow widget's item, programmatically.
18400 * @param obj The slideshow object
18401 * @param item The item to display on @p obj's viewport
18403 * The change between the current item and @p item will use the
18404 * transition @p obj is set to use (@see
18405 * elm_slideshow_transition_set()).
18407 * @ingroup Slideshow
18409 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18412 * Slide to the @b next item, in a given slideshow widget
18414 * @param obj The slideshow object
18416 * The sliding animation @p obj is set to use will be the
18417 * transition effect used, after this call is issued.
18419 * @note If the end of the slideshow's internal list of items is
18420 * reached, it'll wrap around to the list's beginning, again.
18422 * @ingroup Slideshow
18424 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18427 * Slide to the @b previous item, in a given slideshow widget
18429 * @param obj The slideshow object
18431 * The sliding animation @p obj is set to use will be the
18432 * transition effect used, after this call is issued.
18434 * @note If the beginning of the slideshow's internal list of items
18435 * is reached, it'll wrap around to the list's end, again.
18437 * @ingroup Slideshow
18439 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18442 * Returns the list of sliding transition/effect names available, for a
18443 * given slideshow widget.
18445 * @param obj The slideshow object
18446 * @return The list of transitions (list of @b stringshared strings
18449 * The transitions, which come from @p obj's theme, must be an EDC
18450 * data item named @c "transitions" on the theme file, with (prefix)
18451 * names of EDC programs actually implementing them.
18453 * The available transitions for slideshows on the default theme are:
18454 * - @c "fade" - the current item fades out, while the new one
18455 * fades in to the slideshow's viewport.
18456 * - @c "black_fade" - the current item fades to black, and just
18457 * then, the new item will fade in.
18458 * - @c "horizontal" - the current item slides horizontally, until
18459 * it gets out of the slideshow's viewport, while the new item
18460 * comes from the left to take its place.
18461 * - @c "vertical" - the current item slides vertically, until it
18462 * gets out of the slideshow's viewport, while the new item comes
18463 * from the bottom to take its place.
18464 * - @c "square" - the new item starts to appear from the middle of
18465 * the current one, but with a tiny size, growing until its
18466 * target (full) size and covering the old one.
18468 * @warning The stringshared strings get no new references
18469 * exclusive to the user grabbing the list, here, so if you'd like
18470 * to use them out of this call's context, you'd better @c
18471 * eina_stringshare_ref() them.
18473 * @see elm_slideshow_transition_set()
18475 * @ingroup Slideshow
18477 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18480 * Set the current slide transition/effect in use for a given
18483 * @param obj The slideshow object
18484 * @param transition The new transition's name string
18486 * If @p transition is implemented in @p obj's theme (i.e., is
18487 * contained in the list returned by
18488 * elm_slideshow_transitions_get()), this new sliding effect will
18489 * be used on the widget.
18491 * @see elm_slideshow_transitions_get() for more details
18493 * @ingroup Slideshow
18495 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18498 * Get the current slide transition/effect in use for a given
18501 * @param obj The slideshow object
18502 * @return The current transition's name
18504 * @see elm_slideshow_transition_set() for more details
18506 * @ingroup Slideshow
18508 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18511 * Set the interval between each image transition on a given
18512 * slideshow widget, <b>and start the slideshow, itself</b>
18514 * @param obj The slideshow object
18515 * @param timeout The new displaying timeout for images
18517 * After this call, the slideshow widget will start cycling its
18518 * view, sequentially and automatically, with the images of the
18519 * items it has. The time between each new image displayed is going
18520 * to be @p timeout, in @b seconds. If a different timeout was set
18521 * previously and an slideshow was in progress, it will continue
18522 * with the new time between transitions, after this call.
18524 * @note A value less than or equal to 0 on @p timeout will disable
18525 * the widget's internal timer, thus halting any slideshow which
18526 * could be happening on @p obj.
18528 * @see elm_slideshow_timeout_get()
18530 * @ingroup Slideshow
18532 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18535 * Get the interval set for image transitions on a given slideshow
18538 * @param obj The slideshow object
18539 * @return Returns the timeout set on it
18541 * @see elm_slideshow_timeout_set() for more details
18543 * @ingroup Slideshow
18545 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18548 * Set if, after a slideshow is started, for a given slideshow
18549 * widget, its items should be displayed cyclically or not.
18551 * @param obj The slideshow object
18552 * @param loop Use @c EINA_TRUE to make it cycle through items or
18553 * @c EINA_FALSE for it to stop at the end of @p obj's internal
18556 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18557 * ignore what is set by this functions, i.e., they'll @b always
18558 * cycle through items. This affects only the "automatic"
18559 * slideshow, as set by elm_slideshow_timeout_set().
18561 * @see elm_slideshow_loop_get()
18563 * @ingroup Slideshow
18565 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18568 * Get if, after a slideshow is started, for a given slideshow
18569 * widget, its items are to be displayed cyclically or not.
18571 * @param obj The slideshow object
18572 * @return @c EINA_TRUE, if the items in @p obj will be cycled
18573 * through or @c EINA_FALSE, otherwise
18575 * @see elm_slideshow_loop_set() for more details
18577 * @ingroup Slideshow
18579 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18582 * Remove all items from a given slideshow widget
18584 * @param obj The slideshow object
18586 * This removes (and deletes) all items in @p obj, leaving it
18589 * @see elm_slideshow_item_del(), to remove just one item.
18591 * @ingroup Slideshow
18593 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18596 * Get the internal list of items in a given slideshow widget.
18598 * @param obj The slideshow object
18599 * @return The list of items (#Elm_Slideshow_Item as data) or
18600 * @c NULL on errors.
18602 * This list is @b not to be modified in any way and must not be
18603 * freed. Use the list members with functions like
18604 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18606 * @warning This list is only valid until @p obj object's internal
18607 * items list is changed. It should be fetched again with another
18608 * call to this function when changes happen.
18610 * @ingroup Slideshow
18612 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18615 * Delete a given item from a slideshow widget.
18617 * @param item The slideshow item
18619 * @ingroup Slideshow
18621 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18624 * Return the data associated with a given slideshow item
18626 * @param item The slideshow item
18627 * @return Returns the data associated to this item
18629 * @ingroup Slideshow
18631 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18634 * Returns the currently displayed item, in a given slideshow widget
18636 * @param obj The slideshow object
18637 * @return A handle to the item being displayed in @p obj or
18638 * @c NULL, if none is (and on errors)
18640 * @ingroup Slideshow
18642 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18645 * Get the real Evas object created to implement the view of a
18646 * given slideshow item
18648 * @param item The slideshow item.
18649 * @return the Evas object implementing this item's view.
18651 * This returns the actual Evas object used to implement the
18652 * specified slideshow item's view. This may be @c NULL, as it may
18653 * not have been created or may have been deleted, at any time, by
18654 * the slideshow. <b>Do not modify this object</b> (move, resize,
18655 * show, hide, etc.), as the slideshow is controlling it. This
18656 * function is for querying, emitting custom signals or hooking
18657 * lower level callbacks for events on that object. Do not delete
18658 * this object under any circumstances.
18660 * @see elm_slideshow_item_data_get()
18662 * @ingroup Slideshow
18664 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18667 * Get the the item, in a given slideshow widget, placed at
18668 * position @p nth, in its internal items list
18670 * @param obj The slideshow object
18671 * @param nth The number of the item to grab a handle to (0 being
18673 * @return The item stored in @p obj at position @p nth or @c NULL,
18674 * if there's no item with that index (and on errors)
18676 * @ingroup Slideshow
18678 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18681 * Set the current slide layout in use for a given slideshow widget
18683 * @param obj The slideshow object
18684 * @param layout The new layout's name string
18686 * If @p layout is implemented in @p obj's theme (i.e., is contained
18687 * in the list returned by elm_slideshow_layouts_get()), this new
18688 * images layout will be used on the widget.
18690 * @see elm_slideshow_layouts_get() for more details
18692 * @ingroup Slideshow
18694 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18697 * Get the current slide layout in use for a given slideshow widget
18699 * @param obj The slideshow object
18700 * @return The current layout's name
18702 * @see elm_slideshow_layout_set() for more details
18704 * @ingroup Slideshow
18706 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18709 * Returns the list of @b layout names available, for a given
18710 * slideshow widget.
18712 * @param obj The slideshow object
18713 * @return The list of layouts (list of @b stringshared strings
18716 * Slideshow layouts will change how the widget is to dispose each
18717 * image item in its viewport, with regard to cropping, scaling,
18720 * The layouts, which come from @p obj's theme, must be an EDC
18721 * data item name @c "layouts" on the theme file, with (prefix)
18722 * names of EDC programs actually implementing them.
18724 * The available layouts for slideshows on the default theme are:
18725 * - @c "fullscreen" - item images with original aspect, scaled to
18726 * touch top and down slideshow borders or, if the image's heigh
18727 * is not enough, left and right slideshow borders.
18728 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18729 * one, but always leaving 10% of the slideshow's dimensions of
18730 * distance between the item image's borders and the slideshow
18731 * borders, for each axis.
18733 * @warning The stringshared strings get no new references
18734 * exclusive to the user grabbing the list, here, so if you'd like
18735 * to use them out of this call's context, you'd better @c
18736 * eina_stringshare_ref() them.
18738 * @see elm_slideshow_layout_set()
18740 * @ingroup Slideshow
18742 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18745 * Set the number of items to cache, on a given slideshow widget,
18746 * <b>before the current item</b>
18748 * @param obj The slideshow object
18749 * @param count Number of items to cache before the current one
18751 * The default value for this property is @c 2. See
18752 * @ref Slideshow_Caching "slideshow caching" for more details.
18754 * @see elm_slideshow_cache_before_get()
18756 * @ingroup Slideshow
18758 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18761 * Retrieve the number of items to cache, on a given slideshow widget,
18762 * <b>before the current item</b>
18764 * @param obj The slideshow object
18765 * @return The number of items set to be cached before the current one
18767 * @see elm_slideshow_cache_before_set() for more details
18769 * @ingroup Slideshow
18771 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18774 * Set the number of items to cache, on a given slideshow widget,
18775 * <b>after the current item</b>
18777 * @param obj The slideshow object
18778 * @param count Number of items to cache after the current one
18780 * The default value for this property is @c 2. See
18781 * @ref Slideshow_Caching "slideshow caching" for more details.
18783 * @see elm_slideshow_cache_after_get()
18785 * @ingroup Slideshow
18787 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18790 * Retrieve the number of items to cache, on a given slideshow widget,
18791 * <b>after the current item</b>
18793 * @param obj The slideshow object
18794 * @return The number of items set to be cached after the current one
18796 * @see elm_slideshow_cache_after_set() for more details
18798 * @ingroup Slideshow
18800 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18803 * Get the number of items stored in a given slideshow widget
18805 * @param obj The slideshow object
18806 * @return The number of items on @p obj, at the moment of this call
18808 * @ingroup Slideshow
18810 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18817 * @defgroup Fileselector File Selector
18819 * @image html img/widget/fileselector/preview-00.png
18820 * @image latex img/widget/fileselector/preview-00.eps
18822 * A file selector is a widget that allows a user to navigate
18823 * through a file system, reporting file selections back via its
18826 * It contains shortcut buttons for home directory (@c ~) and to
18827 * jump one directory upwards (..), as well as cancel/ok buttons to
18828 * confirm/cancel a given selection. After either one of those two
18829 * former actions, the file selector will issue its @c "done" smart
18832 * There's a text entry on it, too, showing the name of the current
18833 * selection. There's the possibility of making it editable, so it
18834 * is useful on file saving dialogs on applications, where one
18835 * gives a file name to save contents to, in a given directory in
18836 * the system. This custom file name will be reported on the @c
18837 * "done" smart callback (explained in sequence).
18839 * Finally, it has a view to display file system items into in two
18844 * If Elementary is built with support of the Ethumb thumbnailing
18845 * library, the second form of view will display preview thumbnails
18846 * of files which it supports.
18848 * Smart callbacks one can register to:
18850 * - @c "selected" - the user has clicked on a file (when not in
18851 * folders-only mode) or directory (when in folders-only mode)
18852 * - @c "directory,open" - the list has been populated with new
18853 * content (@c event_info is a pointer to the directory's
18854 * path, a @b stringshared string)
18855 * - @c "done" - the user has clicked on the "ok" or "cancel"
18856 * buttons (@c event_info is a pointer to the selection's
18857 * path, a @b stringshared string)
18859 * Here is an example on its usage:
18860 * @li @ref fileselector_example
18864 * @addtogroup Fileselector
18869 * Defines how a file selector widget is to layout its contents
18870 * (file system entries).
18872 typedef enum _Elm_Fileselector_Mode
18874 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
18875 ELM_FILESELECTOR_GRID, /**< layout as a grid */
18876 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
18877 } Elm_Fileselector_Mode;
18880 * Add a new file selector widget to the given parent Elementary
18881 * (container) object
18883 * @param parent The parent object
18884 * @return a new file selector widget handle or @c NULL, on errors
18886 * This function inserts a new file selector widget on the canvas.
18888 * @ingroup Fileselector
18890 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18893 * Enable/disable the file name entry box where the user can type
18894 * in a name for a file, in a given file selector widget
18896 * @param obj The file selector object
18897 * @param is_save @c EINA_TRUE to make the file selector a "saving
18898 * dialog", @c EINA_FALSE otherwise
18900 * Having the entry editable is useful on file saving dialogs on
18901 * applications, where one gives a file name to save contents to,
18902 * in a given directory in the system. This custom file name will
18903 * be reported on the @c "done" smart callback.
18905 * @see elm_fileselector_is_save_get()
18907 * @ingroup Fileselector
18909 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
18912 * Get whether the given file selector is in "saving dialog" mode
18914 * @param obj The file selector object
18915 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
18916 * mode, @c EINA_FALSE otherwise (and on errors)
18918 * @see elm_fileselector_is_save_set() for more details
18920 * @ingroup Fileselector
18922 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18925 * Enable/disable folder-only view for a given file selector widget
18927 * @param obj The file selector object
18928 * @param only @c EINA_TRUE to make @p obj only display
18929 * directories, @c EINA_FALSE to make files to be displayed in it
18932 * If enabled, the widget's view will only display folder items,
18935 * @see elm_fileselector_folder_only_get()
18937 * @ingroup Fileselector
18939 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
18942 * Get whether folder-only view is set for a given file selector
18945 * @param obj The file selector object
18946 * @return only @c EINA_TRUE if @p obj is only displaying
18947 * directories, @c EINA_FALSE if files are being displayed in it
18948 * too (and on errors)
18950 * @see elm_fileselector_folder_only_get()
18952 * @ingroup Fileselector
18954 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18957 * Enable/disable the "ok" and "cancel" buttons on a given file
18960 * @param obj The file selector object
18961 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
18963 * @note A file selector without those buttons will never emit the
18964 * @c "done" smart event, and is only usable if one is just hooking
18965 * to the other two events.
18967 * @see elm_fileselector_buttons_ok_cancel_get()
18969 * @ingroup Fileselector
18971 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
18974 * Get whether the "ok" and "cancel" buttons on a given file
18975 * selector widget are being shown.
18977 * @param obj The file selector object
18978 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
18979 * otherwise (and on errors)
18981 * @see elm_fileselector_buttons_ok_cancel_set() for more details
18983 * @ingroup Fileselector
18985 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18988 * Enable/disable a tree view in the given file selector widget,
18989 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
18991 * @param obj The file selector object
18992 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
18995 * In a tree view, arrows are created on the sides of directories,
18996 * allowing them to expand in place.
18998 * @note If it's in other mode, the changes made by this function
18999 * will only be visible when one switches back to "list" mode.
19001 * @see elm_fileselector_expandable_get()
19003 * @ingroup Fileselector
19005 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19008 * Get whether tree view is enabled for the given file selector
19011 * @param obj The file selector object
19012 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19013 * otherwise (and or errors)
19015 * @see elm_fileselector_expandable_set() for more details
19017 * @ingroup Fileselector
19019 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19022 * Set, programmatically, the @b directory that a given file
19023 * selector widget will display contents from
19025 * @param obj The file selector object
19026 * @param path The path to display in @p obj
19028 * This will change the @b directory that @p obj is displaying. It
19029 * will also clear the text entry area on the @p obj object, which
19030 * displays select files' names.
19032 * @see elm_fileselector_path_get()
19034 * @ingroup Fileselector
19036 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19039 * Get the parent directory's path that a given file selector
19040 * widget is displaying
19042 * @param obj The file selector object
19043 * @return The (full) path of the directory the file selector is
19044 * displaying, a @b stringshared string
19046 * @see elm_fileselector_path_set()
19048 * @ingroup Fileselector
19050 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19053 * Set, programmatically, the currently selected file/directory in
19054 * the given file selector widget
19056 * @param obj The file selector object
19057 * @param path The (full) path to a file or directory
19058 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19059 * latter case occurs if the directory or file pointed to do not
19062 * @see elm_fileselector_selected_get()
19064 * @ingroup Fileselector
19066 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19069 * Get the currently selected item's (full) path, in the given file
19072 * @param obj The file selector object
19073 * @return The absolute path of the selected item, a @b
19074 * stringshared string
19076 * @note Custom editions on @p obj object's text entry, if made,
19077 * will appear on the return string of this function, naturally.
19079 * @see elm_fileselector_selected_set() for more details
19081 * @ingroup Fileselector
19083 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19086 * Set the mode in which a given file selector widget will display
19087 * (layout) file system entries in its view
19089 * @param obj The file selector object
19090 * @param mode The mode of the fileselector, being it one of
19091 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19092 * first one, naturally, will display the files in a list. The
19093 * latter will make the widget to display its entries in a grid
19096 * @note By using elm_fileselector_expandable_set(), the user may
19097 * trigger a tree view for that list.
19099 * @note If Elementary is built with support of the Ethumb
19100 * thumbnailing library, the second form of view will display
19101 * preview thumbnails of files which it supports. You must have
19102 * elm_need_ethumb() called in your Elementary for thumbnailing to
19105 * @see elm_fileselector_expandable_set().
19106 * @see elm_fileselector_mode_get().
19108 * @ingroup Fileselector
19110 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19113 * Get the mode in which a given file selector widget is displaying
19114 * (layouting) file system entries in its view
19116 * @param obj The fileselector object
19117 * @return The mode in which the fileselector is at
19119 * @see elm_fileselector_mode_set() for more details
19121 * @ingroup Fileselector
19123 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19130 * @defgroup Progressbar Progress bar
19132 * The progress bar is a widget for visually representing the
19133 * progress status of a given job/task.
19135 * A progress bar may be horizontal or vertical. It may display an
19136 * icon besides it, as well as primary and @b units labels. The
19137 * former is meant to label the widget as a whole, while the
19138 * latter, which is formatted with floating point values (and thus
19139 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19140 * units"</c>), is meant to label the widget's <b>progress
19141 * value</b>. Label, icon and unit strings/objects are @b optional
19142 * for progress bars.
19144 * A progress bar may be @b inverted, in which state it gets its
19145 * values inverted, with high values being on the left or top and
19146 * low values on the right or bottom, as opposed to normally have
19147 * the low values on the former and high values on the latter,
19148 * respectively, for horizontal and vertical modes.
19150 * The @b span of the progress, as set by
19151 * elm_progressbar_span_size_set(), is its length (horizontally or
19152 * vertically), unless one puts size hints on the widget to expand
19153 * on desired directions, by any container. That length will be
19154 * scaled by the object or applications scaling factor. At any
19155 * point code can query the progress bar for its value with
19156 * elm_progressbar_value_get().
19158 * Available widget styles for progress bars:
19160 * - @c "wheel" (simple style, no text, no progression, only
19161 * "pulse" effect is available)
19163 * Here is an example on its usage:
19164 * @li @ref progressbar_example
19168 * Add a new progress bar widget to the given parent Elementary
19169 * (container) object
19171 * @param parent The parent object
19172 * @return a new progress bar widget handle or @c NULL, on errors
19174 * This function inserts a new progress bar widget on the canvas.
19176 * @ingroup Progressbar
19178 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19181 * Set whether a given progress bar widget is at "pulsing mode" or
19184 * @param obj The progress bar object
19185 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19186 * @c EINA_FALSE to put it back to its default one
19188 * By default, progress bars will display values from the low to
19189 * high value boundaries. There are, though, contexts in which the
19190 * state of progression of a given task is @b unknown. For those,
19191 * one can set a progress bar widget to a "pulsing state", to give
19192 * the user an idea that some computation is being held, but
19193 * without exact progress values. In the default theme it will
19194 * animate its bar with the contents filling in constantly and back
19195 * to non-filled, in a loop. To start and stop this pulsing
19196 * animation, one has to explicitly call elm_progressbar_pulse().
19198 * @see elm_progressbar_pulse_get()
19199 * @see elm_progressbar_pulse()
19201 * @ingroup Progressbar
19203 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19206 * Get whether a given progress bar widget is at "pulsing mode" or
19209 * @param obj The progress bar object
19210 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19211 * if it's in the default one (and on errors)
19213 * @ingroup Progressbar
19215 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19218 * Start/stop a given progress bar "pulsing" animation, if its
19221 * @param obj The progress bar object
19222 * @param state @c EINA_TRUE, to @b start the pulsing animation,
19223 * @c EINA_FALSE to @b stop it
19225 * @note This call won't do anything if @p obj is not under "pulsing mode".
19227 * @see elm_progressbar_pulse_set() for more details.
19229 * @ingroup Progressbar
19231 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19234 * Set the progress value (in percentage) on a given progress bar
19237 * @param obj The progress bar object
19238 * @param val The progress value (@b must be between @c 0.0 and @c
19241 * Use this call to set progress bar levels.
19243 * @note If you passes a value out of the specified range for @p
19244 * val, it will be interpreted as the @b closest of the @b boundary
19245 * values in the range.
19247 * @ingroup Progressbar
19249 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19252 * Get the progress value (in percentage) on a given progress bar
19255 * @param obj The progress bar object
19256 * @return The value of the progressbar
19258 * @see elm_progressbar_value_set() for more details
19260 * @ingroup Progressbar
19262 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19265 * Set the label of a given progress bar widget
19267 * @param obj The progress bar object
19268 * @param label The text label string, in UTF-8
19270 * @ingroup Progressbar
19271 * @deprecated use elm_object_text_set() instead.
19273 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19276 * Get the label of a given progress bar widget
19278 * @param obj The progressbar object
19279 * @return The text label string, in UTF-8
19281 * @ingroup Progressbar
19282 * @deprecated use elm_object_text_set() instead.
19284 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19287 * Set the icon object of a given progress bar widget
19289 * @param obj The progress bar object
19290 * @param icon The icon object
19292 * Use this call to decorate @p obj with an icon next to it.
19294 * @note Once the icon object is set, a previously set one will be
19295 * deleted. If you want to keep that old content object, use the
19296 * elm_progressbar_icon_unset() function.
19298 * @see elm_progressbar_icon_get()
19300 * @ingroup Progressbar
19302 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19305 * Retrieve the icon object set for a given progress bar widget
19307 * @param obj The progress bar object
19308 * @return The icon object's handle, if @p obj had one set, or @c NULL,
19309 * otherwise (and on errors)
19311 * @see elm_progressbar_icon_set() for more details
19313 * @ingroup Progressbar
19315 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19318 * Unset an icon set on a given progress bar widget
19320 * @param obj The progress bar object
19321 * @return The icon object that was being used, if any was set, or
19322 * @c NULL, otherwise (and on errors)
19324 * This call will unparent and return the icon object which was set
19325 * for this widget, previously, on success.
19327 * @see elm_progressbar_icon_set() for more details
19329 * @ingroup Progressbar
19331 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19334 * Set the (exact) length of the bar region of a given progress bar
19337 * @param obj The progress bar object
19338 * @param size The length of the progress bar's bar region
19340 * This sets the minimum width (when in horizontal mode) or height
19341 * (when in vertical mode) of the actual bar area of the progress
19342 * bar @p obj. This in turn affects the object's minimum size. Use
19343 * this when you're not setting other size hints expanding on the
19344 * given direction (like weight and alignment hints) and you would
19345 * like it to have a specific size.
19347 * @note Icon, label and unit text around @p obj will require their
19348 * own space, which will make @p obj to require more the @p size,
19351 * @see elm_progressbar_span_size_get()
19353 * @ingroup Progressbar
19355 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19358 * Get the length set for the bar region of a given progress bar
19361 * @param obj The progress bar object
19362 * @return The length of the progress bar's bar region
19364 * If that size was not set previously, with
19365 * elm_progressbar_span_size_set(), this call will return @c 0.
19367 * @ingroup Progressbar
19369 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19372 * Set the format string for a given progress bar widget's units
19375 * @param obj The progress bar object
19376 * @param format The format string for @p obj's units label
19378 * If @c NULL is passed on @p format, it will make @p obj's units
19379 * area to be hidden completely. If not, it'll set the <b>format
19380 * string</b> for the units label's @b text. The units label is
19381 * provided a floating point value, so the units text is up display
19382 * at most one floating point falue. Note that the units label is
19383 * optional. Use a format string such as "%1.2f meters" for
19386 * @note The default format string for a progress bar is an integer
19387 * percentage, as in @c "%.0f %%".
19389 * @see elm_progressbar_unit_format_get()
19391 * @ingroup Progressbar
19393 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19396 * Retrieve the format string set for a given progress bar widget's
19399 * @param obj The progress bar object
19400 * @return The format set string for @p obj's units label or
19401 * @c NULL, if none was set (and on errors)
19403 * @see elm_progressbar_unit_format_set() for more details
19405 * @ingroup Progressbar
19407 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19410 * Set the orientation of a given progress bar widget
19412 * @param obj The progress bar object
19413 * @param horizontal Use @c EINA_TRUE to make @p obj to be
19414 * @b horizontal, @c EINA_FALSE to make it @b vertical
19416 * Use this function to change how your progress bar is to be
19417 * disposed: vertically or horizontally.
19419 * @see elm_progressbar_horizontal_get()
19421 * @ingroup Progressbar
19423 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19426 * Retrieve the orientation of a given progress bar widget
19428 * @param obj The progress bar object
19429 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19430 * @c EINA_FALSE if it's @b vertical (and on errors)
19432 * @see elm_progressbar_horizontal_set() for more details
19434 * @ingroup Progressbar
19436 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19439 * Invert a given progress bar widget's displaying values order
19441 * @param obj The progress bar object
19442 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19443 * @c EINA_FALSE to bring it back to default, non-inverted values.
19445 * A progress bar may be @b inverted, in which state it gets its
19446 * values inverted, with high values being on the left or top and
19447 * low values on the right or bottom, as opposed to normally have
19448 * the low values on the former and high values on the latter,
19449 * respectively, for horizontal and vertical modes.
19451 * @see elm_progressbar_inverted_get()
19453 * @ingroup Progressbar
19455 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19458 * Get whether a given progress bar widget's displaying values are
19461 * @param obj The progress bar object
19462 * @return @c EINA_TRUE, if @p obj has inverted values,
19463 * @c EINA_FALSE otherwise (and on errors)
19465 * @see elm_progressbar_inverted_set() for more details
19467 * @ingroup Progressbar
19469 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19472 * @defgroup Separator Separator
19474 * @brief Separator is a very thin object used to separate other objects.
19476 * A separator can be vertical or horizontal.
19478 * @ref tutorial_separator is a good example of how to use a separator.
19482 * @brief Add a separator object to @p parent
19484 * @param parent The parent object
19486 * @return The separator object, or NULL upon failure
19488 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19490 * @brief Set the horizontal mode of a separator object
19492 * @param obj The separator object
19493 * @param horizontal If true, the separator is horizontal
19495 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19497 * @brief Get the horizontal mode of a separator object
19499 * @param obj The separator object
19500 * @return If true, the separator is horizontal
19502 * @see elm_separator_horizontal_set()
19504 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19510 * @defgroup Spinner Spinner
19511 * @ingroup Elementary
19513 * @image html img/widget/spinner/preview-00.png
19514 * @image latex img/widget/spinner/preview-00.eps
19516 * A spinner is a widget which allows the user to increase or decrease
19517 * numeric values using arrow buttons, or edit values directly, clicking
19518 * over it and typing the new value.
19520 * By default the spinner will not wrap and has a label
19521 * of "%.0f" (just showing the integer value of the double).
19523 * A spinner has a label that is formatted with floating
19524 * point values and thus accepts a printf-style format string, like
19527 * It also allows specific values to be replaced by pre-defined labels.
19529 * Smart callbacks one can register to:
19531 * - "changed" - Whenever the spinner value is changed.
19532 * - "delay,changed" - A short time after the value is changed by the user.
19533 * This will be called only when the user stops dragging for a very short
19534 * period or when they release their finger/mouse, so it avoids possibly
19535 * expensive reactions to the value change.
19537 * Available styles for it:
19539 * - @c "vertical": up/down buttons at the right side and text left aligned.
19541 * Here is an example on its usage:
19542 * @ref spinner_example
19546 * @addtogroup Spinner
19551 * Add a new spinner widget to the given parent Elementary
19552 * (container) object.
19554 * @param parent The parent object.
19555 * @return a new spinner widget handle or @c NULL, on errors.
19557 * This function inserts a new spinner widget on the canvas.
19562 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19565 * Set the format string of the displayed label.
19567 * @param obj The spinner object.
19568 * @param fmt The format string for the label display.
19570 * If @c NULL, this sets the format to "%.0f". If not it sets the format
19571 * string for the label text. The label text is provided a floating point
19572 * value, so the label text can display up to 1 floating point value.
19573 * Note that this is optional.
19575 * Use a format string such as "%1.2f meters" for example, and it will
19576 * display values like: "3.14 meters" for a value equal to 3.14159.
19578 * Default is "%0.f".
19580 * @see elm_spinner_label_format_get()
19584 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19587 * Get the label format of the spinner.
19589 * @param obj The spinner object.
19590 * @return The text label format string in UTF-8.
19592 * @see elm_spinner_label_format_set() for details.
19596 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19599 * Set the minimum and maximum values for the spinner.
19601 * @param obj The spinner object.
19602 * @param min The minimum value.
19603 * @param max The maximum value.
19605 * Define the allowed range of values to be selected by the user.
19607 * If actual value is less than @p min, it will be updated to @p min. If it
19608 * is bigger then @p max, will be updated to @p max. Actual value can be
19609 * get with elm_spinner_value_get().
19611 * By default, min is equal to 0, and max is equal to 100.
19613 * @warning Maximum must be greater than minimum.
19615 * @see elm_spinner_min_max_get()
19619 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19622 * Get the minimum and maximum values of the spinner.
19624 * @param obj The spinner object.
19625 * @param min Pointer where to store the minimum value.
19626 * @param max Pointer where to store the maximum value.
19628 * @note If only one value is needed, the other pointer can be passed
19631 * @see elm_spinner_min_max_set() for details.
19635 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19638 * Set the step used to increment or decrement the spinner value.
19640 * @param obj The spinner object.
19641 * @param step The step value.
19643 * This value will be incremented or decremented to the displayed value.
19644 * It will be incremented while the user keep right or top arrow pressed,
19645 * and will be decremented while the user keep left or bottom arrow pressed.
19647 * The interval to increment / decrement can be set with
19648 * elm_spinner_interval_set().
19650 * By default step value is equal to 1.
19652 * @see elm_spinner_step_get()
19656 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19659 * Get the step used to increment or decrement the spinner value.
19661 * @param obj The spinner object.
19662 * @return The step value.
19664 * @see elm_spinner_step_get() for more details.
19668 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19671 * Set the value the spinner displays.
19673 * @param obj The spinner object.
19674 * @param val The value to be displayed.
19676 * Value will be presented on the label following format specified with
19677 * elm_spinner_format_set().
19679 * @warning The value must to be between min and max values. This values
19680 * are set by elm_spinner_min_max_set().
19682 * @see elm_spinner_value_get().
19683 * @see elm_spinner_format_set().
19684 * @see elm_spinner_min_max_set().
19688 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19691 * Get the value displayed by the spinner.
19693 * @param obj The spinner object.
19694 * @return The value displayed.
19696 * @see elm_spinner_value_set() for details.
19700 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19703 * Set whether the spinner should wrap when it reaches its
19704 * minimum or maximum value.
19706 * @param obj The spinner object.
19707 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19710 * Disabled by default. If disabled, when the user tries to increment the
19712 * but displayed value plus step value is bigger than maximum value,
19714 * won't allow it. The same happens when the user tries to decrement it,
19715 * but the value less step is less than minimum value.
19717 * When wrap is enabled, in such situations it will allow these changes,
19718 * but will get the value that would be less than minimum and subtracts
19719 * from maximum. Or add the value that would be more than maximum to
19723 * @li min value = 10
19724 * @li max value = 50
19725 * @li step value = 20
19726 * @li displayed value = 20
19728 * When the user decrement value (using left or bottom arrow), it will
19729 * displays @c 40, because max - (min - (displayed - step)) is
19730 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19732 * @see elm_spinner_wrap_get().
19736 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19739 * Get whether the spinner should wrap when it reaches its
19740 * minimum or maximum value.
19742 * @param obj The spinner object
19743 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19744 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19746 * @see elm_spinner_wrap_set() for details.
19750 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19753 * Set whether the spinner can be directly edited by the user or not.
19755 * @param obj The spinner object.
19756 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19757 * don't allow users to edit it directly.
19759 * Spinner objects can have edition @b disabled, in which state they will
19760 * be changed only by arrows.
19761 * Useful for contexts
19762 * where you don't want your users to interact with it writting the value.
19764 * when using special values, the user can see real value instead
19765 * of special label on edition.
19767 * It's enabled by default.
19769 * @see elm_spinner_editable_get()
19773 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19776 * Get whether the spinner can be directly edited by the user or not.
19778 * @param obj The spinner object.
19779 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19780 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19782 * @see elm_spinner_editable_set() for details.
19786 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19789 * Set a special string to display in the place of the numerical value.
19791 * @param obj The spinner object.
19792 * @param value The value to be replaced.
19793 * @param label The label to be used.
19795 * It's useful for cases when a user should select an item that is
19796 * better indicated by a label than a value. For example, weekdays or months.
19800 * sp = elm_spinner_add(win);
19801 * elm_spinner_min_max_set(sp, 1, 3);
19802 * elm_spinner_special_value_add(sp, 1, "January");
19803 * elm_spinner_special_value_add(sp, 2, "February");
19804 * elm_spinner_special_value_add(sp, 3, "March");
19805 * evas_object_show(sp);
19810 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
19813 * Set the interval on time updates for an user mouse button hold
19814 * on spinner widgets' arrows.
19816 * @param obj The spinner object.
19817 * @param interval The (first) interval value in seconds.
19819 * This interval value is @b decreased while the user holds the
19820 * mouse pointer either incrementing or decrementing spinner's value.
19822 * This helps the user to get to a given value distant from the
19823 * current one easier/faster, as it will start to change quicker and
19824 * quicker on mouse button holds.
19826 * The calculation for the next change interval value, starting from
19827 * the one set with this call, is the previous interval divided by
19828 * @c 1.05, so it decreases a little bit.
19830 * The default starting interval value for automatic changes is
19833 * @see elm_spinner_interval_get()
19837 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
19840 * Get the interval on time updates for an user mouse button hold
19841 * on spinner widgets' arrows.
19843 * @param obj The spinner object.
19844 * @return The (first) interval value, in seconds, set on it.
19846 * @see elm_spinner_interval_set() for more details.
19850 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19857 * @defgroup Index Index
19859 * @image html img/widget/index/preview-00.png
19860 * @image latex img/widget/index/preview-00.eps
19862 * An index widget gives you an index for fast access to whichever
19863 * group of other UI items one might have. It's a list of text
19864 * items (usually letters, for alphabetically ordered access).
19866 * Index widgets are by default hidden and just appear when the
19867 * user clicks over it's reserved area in the canvas. In its
19868 * default theme, it's an area one @ref Fingers "finger" wide on
19869 * the right side of the index widget's container.
19871 * When items on the index are selected, smart callbacks get
19872 * called, so that its user can make other container objects to
19873 * show a given area or child object depending on the index item
19874 * selected. You'd probably be using an index together with @ref
19875 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
19878 * Smart events one can add callbacks for are:
19879 * - @c "changed" - When the selected index item changes. @c
19880 * event_info is the selected item's data pointer.
19881 * - @c "delay,changed" - When the selected index item changes, but
19882 * after a small idling period. @c event_info is the selected
19883 * item's data pointer.
19884 * - @c "selected" - When the user releases a mouse button and
19885 * selects an item. @c event_info is the selected item's data
19887 * - @c "level,up" - when the user moves a finger from the first
19888 * level to the second level
19889 * - @c "level,down" - when the user moves a finger from the second
19890 * level to the first level
19892 * The @c "delay,changed" event is so that it'll wait a small time
19893 * before actually reporting those events and, moreover, just the
19894 * last event happening on those time frames will actually be
19897 * Here are some examples on its usage:
19898 * @li @ref index_example_01
19899 * @li @ref index_example_02
19903 * @addtogroup Index
19907 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
19910 * Add a new index widget to the given parent Elementary
19911 * (container) object
19913 * @param parent The parent object
19914 * @return a new index widget handle or @c NULL, on errors
19916 * This function inserts a new index widget on the canvas.
19920 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19923 * Set whether a given index widget is or not visible,
19926 * @param obj The index object
19927 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
19929 * Not to be confused with visible as in @c evas_object_show() --
19930 * visible with regard to the widget's auto hiding feature.
19932 * @see elm_index_active_get()
19936 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
19939 * Get whether a given index widget is currently visible or not.
19941 * @param obj The index object
19942 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
19944 * @see elm_index_active_set() for more details
19948 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19951 * Set the items level for a given index widget.
19953 * @param obj The index object.
19954 * @param level @c 0 or @c 1, the currently implemented levels.
19956 * @see elm_index_item_level_get()
19960 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
19963 * Get the items level set for a given index widget.
19965 * @param obj The index object.
19966 * @return @c 0 or @c 1, which are the levels @p obj might be at.
19968 * @see elm_index_item_level_set() for more information
19972 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19975 * Returns the last selected item's data, for a given index widget.
19977 * @param obj The index object.
19978 * @return The item @b data associated to the last selected item on
19979 * @p obj (or @c NULL, on errors).
19981 * @warning The returned value is @b not an #Elm_Index_Item item
19982 * handle, but the data associated to it (see the @c item parameter
19983 * in elm_index_item_append(), as an example).
19987 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
19990 * Append a new item on a given index widget.
19992 * @param obj The index object.
19993 * @param letter Letter under which the item should be indexed
19994 * @param item The item data to set for the index's item
19996 * Despite the most common usage of the @p letter argument is for
19997 * single char strings, one could use arbitrary strings as index
20000 * @c item will be the pointer returned back on @c "changed", @c
20001 * "delay,changed" and @c "selected" smart events.
20005 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20008 * Prepend a new item on a given index widget.
20010 * @param obj The index object.
20011 * @param letter Letter under which the item should be indexed
20012 * @param item The item data to set for the index's item
20014 * Despite the most common usage of the @p letter argument is for
20015 * single char strings, one could use arbitrary strings as index
20018 * @c item will be the pointer returned back on @c "changed", @c
20019 * "delay,changed" and @c "selected" smart events.
20023 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20026 * Append a new item, on a given index widget, <b>after the item
20027 * having @p relative as data</b>.
20029 * @param obj The index object.
20030 * @param letter Letter under which the item should be indexed
20031 * @param item The item data to set for the index's item
20032 * @param relative The item data of the index item to be the
20033 * predecessor of this new one
20035 * Despite the most common usage of the @p letter argument is for
20036 * single char strings, one could use arbitrary strings as index
20039 * @c item will be the pointer returned back on @c "changed", @c
20040 * "delay,changed" and @c "selected" smart events.
20042 * @note If @p relative is @c NULL or if it's not found to be data
20043 * set on any previous item on @p obj, this function will behave as
20044 * elm_index_item_append().
20048 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20051 * Prepend a new item, on a given index widget, <b>after the item
20052 * having @p relative as data</b>.
20054 * @param obj The index object.
20055 * @param letter Letter under which the item should be indexed
20056 * @param item The item data to set for the index's item
20057 * @param relative The item data of the index item to be the
20058 * successor of this new one
20060 * Despite the most common usage of the @p letter argument is for
20061 * single char strings, one could use arbitrary strings as index
20064 * @c item will be the pointer returned back on @c "changed", @c
20065 * "delay,changed" and @c "selected" smart events.
20067 * @note If @p relative is @c NULL or if it's not found to be data
20068 * set on any previous item on @p obj, this function will behave as
20069 * elm_index_item_prepend().
20073 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20076 * Insert a new item into the given index widget, using @p cmp_func
20077 * function to sort items (by item handles).
20079 * @param obj The index object.
20080 * @param letter Letter under which the item should be indexed
20081 * @param item The item data to set for the index's item
20082 * @param cmp_func The comparing function to be used to sort index
20083 * items <b>by #Elm_Index_Item item handles</b>
20084 * @param cmp_data_func A @b fallback function to be called for the
20085 * sorting of index items <b>by item data</b>). It will be used
20086 * when @p cmp_func returns @c 0 (equality), which means an index
20087 * item with provided item data already exists. To decide which
20088 * data item should be pointed to by the index item in question, @p
20089 * cmp_data_func will be used. If @p cmp_data_func returns a
20090 * non-negative value, the previous index item data will be
20091 * replaced by the given @p item pointer. If the previous data need
20092 * to be freed, it should be done by the @p cmp_data_func function,
20093 * because all references to it will be lost. If this function is
20094 * not provided (@c NULL is given), index items will be @b
20095 * duplicated, if @p cmp_func returns @c 0.
20097 * Despite the most common usage of the @p letter argument is for
20098 * single char strings, one could use arbitrary strings as index
20101 * @c item will be the pointer returned back on @c "changed", @c
20102 * "delay,changed" and @c "selected" smart events.
20106 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);
20109 * Remove an item from a given index widget, <b>to be referenced by
20110 * it's data value</b>.
20112 * @param obj The index object
20113 * @param item The item's data pointer for the item to be removed
20116 * If a deletion callback is set, via elm_index_item_del_cb_set(),
20117 * that callback function will be called by this one.
20119 * @warning The item to be removed from @p obj will be found via
20120 * its item data pointer, and not by an #Elm_Index_Item handle.
20124 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20127 * Find a given index widget's item, <b>using item data</b>.
20129 * @param obj The index object
20130 * @param item The item data pointed to by the desired index item
20131 * @return The index item handle, if found, or @c NULL otherwise
20135 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20138 * Removes @b all items from a given index widget.
20140 * @param obj The index object.
20142 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20143 * that callback function will be called for each item in @p obj.
20147 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20150 * Go to a given items level on a index widget
20152 * @param obj The index object
20153 * @param level The index level (one of @c 0 or @c 1)
20157 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20160 * Return the data associated with a given index widget item
20162 * @param it The index widget item handle
20163 * @return The data associated with @p it
20165 * @see elm_index_item_data_set()
20169 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20172 * Set the data associated with a given index widget item
20174 * @param it The index widget item handle
20175 * @param data The new data pointer to set to @p it
20177 * This sets new item data on @p it.
20179 * @warning The old data pointer won't be touched by this function, so
20180 * the user had better to free that old data himself/herself.
20184 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20187 * Set the function to be called when a given index widget item is freed.
20189 * @param it The item to set the callback on
20190 * @param func The function to call on the item's deletion
20192 * When called, @p func will have both @c data and @c event_info
20193 * arguments with the @p it item's data value and, naturally, the
20194 * @c obj argument with a handle to the parent index widget.
20198 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20201 * Get the letter (string) set on a given index widget item.
20203 * @param it The index item handle
20204 * @return The letter string set on @p it
20208 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20215 * @defgroup Photocam Photocam
20217 * @image html img/widget/photocam/preview-00.png
20218 * @image latex img/widget/photocam/preview-00.eps
20220 * This is a widget specifically for displaying high-resolution digital
20221 * camera photos giving speedy feedback (fast load), low memory footprint
20222 * and zooming and panning as well as fitting logic. It is entirely focused
20223 * on jpeg images, and takes advantage of properties of the jpeg format (via
20224 * evas loader features in the jpeg loader).
20226 * Signals that you can add callbacks for are:
20227 * @li "clicked" - This is called when a user has clicked the photo without
20229 * @li "press" - This is called when a user has pressed down on the photo.
20230 * @li "longpressed" - This is called when a user has pressed down on the
20231 * photo for a long time without dragging around.
20232 * @li "clicked,double" - This is called when a user has double-clicked the
20234 * @li "load" - Photo load begins.
20235 * @li "loaded" - This is called when the image file load is complete for the
20236 * first view (low resolution blurry version).
20237 * @li "load,detail" - Photo detailed data load begins.
20238 * @li "loaded,detail" - This is called when the image file load is complete
20239 * for the detailed image data (full resolution needed).
20240 * @li "zoom,start" - Zoom animation started.
20241 * @li "zoom,stop" - Zoom animation stopped.
20242 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20243 * @li "scroll" - the content has been scrolled (moved)
20244 * @li "scroll,anim,start" - scrolling animation has started
20245 * @li "scroll,anim,stop" - scrolling animation has stopped
20246 * @li "scroll,drag,start" - dragging the contents around has started
20247 * @li "scroll,drag,stop" - dragging the contents around has stopped
20249 * @ref tutorial_photocam shows the API in action.
20253 * @brief Types of zoom available.
20255 typedef enum _Elm_Photocam_Zoom_Mode
20257 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20258 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20259 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20260 ELM_PHOTOCAM_ZOOM_MODE_LAST
20261 } Elm_Photocam_Zoom_Mode;
20263 * @brief Add a new Photocam object
20265 * @param parent The parent object
20266 * @return The new object or NULL if it cannot be created
20268 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20270 * @brief Set the photo file to be shown
20272 * @param obj The photocam object
20273 * @param file The photo file
20274 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20276 * This sets (and shows) the specified file (with a relative or absolute
20277 * path) and will return a load error (same error that
20278 * evas_object_image_load_error_get() will return). The image will change and
20279 * adjust its size at this point and begin a background load process for this
20280 * photo that at some time in the future will be displayed at the full
20283 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20285 * @brief Returns the path of the current image file
20287 * @param obj The photocam object
20288 * @return Returns the path
20290 * @see elm_photocam_file_set()
20292 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20294 * @brief Set the zoom level of the photo
20296 * @param obj The photocam object
20297 * @param zoom The zoom level to set
20299 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20300 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20301 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20302 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20305 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20307 * @brief Get the zoom level of the photo
20309 * @param obj The photocam object
20310 * @return The current zoom level
20312 * This returns the current zoom level of the photocam object. Note that if
20313 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20314 * (which is the default), the zoom level may be changed at any time by the
20315 * photocam object itself to account for photo size and photocam viewpoer
20318 * @see elm_photocam_zoom_set()
20319 * @see elm_photocam_zoom_mode_set()
20321 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20323 * @brief Set the zoom mode
20325 * @param obj The photocam object
20326 * @param mode The desired mode
20328 * This sets the zoom mode to manual or one of several automatic levels.
20329 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20330 * elm_photocam_zoom_set() and will stay at that level until changed by code
20331 * or until zoom mode is changed. This is the default mode. The Automatic
20332 * modes will allow the photocam object to automatically adjust zoom mode
20333 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20334 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20335 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20336 * pixels within the frame are left unfilled.
20338 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20340 * @brief Get the zoom mode
20342 * @param obj The photocam object
20343 * @return The current zoom mode
20345 * This gets the current zoom mode of the photocam object.
20347 * @see elm_photocam_zoom_mode_set()
20349 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20351 * @brief Get the current image pixel width and height
20353 * @param obj The photocam object
20354 * @param w A pointer to the width return
20355 * @param h A pointer to the height return
20357 * This gets the current photo pixel width and height (for the original).
20358 * The size will be returned in the integers @p w and @p h that are pointed
20361 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20363 * @brief Get the area of the image that is currently shown
20366 * @param x A pointer to the X-coordinate of region
20367 * @param y A pointer to the Y-coordinate of region
20368 * @param w A pointer to the width
20369 * @param h A pointer to the height
20371 * @see elm_photocam_image_region_show()
20372 * @see elm_photocam_image_region_bring_in()
20374 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20376 * @brief Set the viewed portion of the image
20378 * @param obj The photocam object
20379 * @param x X-coordinate of region in image original pixels
20380 * @param y Y-coordinate of region in image original pixels
20381 * @param w Width of region in image original pixels
20382 * @param h Height of region in image original pixels
20384 * This shows the region of the image without using animation.
20386 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20388 * @brief Bring in the viewed portion of the image
20390 * @param obj The photocam object
20391 * @param x X-coordinate of region in image original pixels
20392 * @param y Y-coordinate of region in image original pixels
20393 * @param w Width of region in image original pixels
20394 * @param h Height of region in image original pixels
20396 * This shows the region of the image using animation.
20398 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20400 * @brief Set the paused state for photocam
20402 * @param obj The photocam object
20403 * @param paused The pause state to set
20405 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20406 * photocam. The default is off. This will stop zooming using animation on
20407 * zoom levels changes and change instantly. This will stop any existing
20408 * animations that are running.
20410 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20412 * @brief Get the paused state for photocam
20414 * @param obj The photocam object
20415 * @return The current paused state
20417 * This gets the current paused state for the photocam object.
20419 * @see elm_photocam_paused_set()
20421 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20423 * @brief Get the internal low-res image used for photocam
20425 * @param obj The photocam object
20426 * @return The internal image object handle, or NULL if none exists
20428 * This gets the internal image object inside photocam. Do not modify it. It
20429 * is for inspection only, and hooking callbacks to. Nothing else. It may be
20430 * deleted at any time as well.
20432 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20434 * @brief Set the photocam scrolling bouncing.
20436 * @param obj The photocam object
20437 * @param h_bounce bouncing for horizontal
20438 * @param v_bounce bouncing for vertical
20440 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20442 * @brief Get the photocam scrolling bouncing.
20444 * @param obj The photocam object
20445 * @param h_bounce bouncing for horizontal
20446 * @param v_bounce bouncing for vertical
20448 * @see elm_photocam_bounce_set()
20450 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20456 * @defgroup Map Map
20457 * @ingroup Elementary
20459 * @image html img/widget/map/preview-00.png
20460 * @image latex img/widget/map/preview-00.eps
20462 * This is a widget specifically for displaying a map. It uses basically
20463 * OpenStreetMap provider http://www.openstreetmap.org/,
20464 * but custom providers can be added.
20466 * It supports some basic but yet nice features:
20467 * @li zoom and scroll
20468 * @li markers with content to be displayed when user clicks over it
20469 * @li group of markers
20472 * Smart callbacks one can listen to:
20474 * - "clicked" - This is called when a user has clicked the map without
20476 * - "press" - This is called when a user has pressed down on the map.
20477 * - "longpressed" - This is called when a user has pressed down on the map
20478 * for a long time without dragging around.
20479 * - "clicked,double" - This is called when a user has double-clicked
20481 * - "load,detail" - Map detailed data load begins.
20482 * - "loaded,detail" - This is called when all currently visible parts of
20483 * the map are loaded.
20484 * - "zoom,start" - Zoom animation started.
20485 * - "zoom,stop" - Zoom animation stopped.
20486 * - "zoom,change" - Zoom changed when using an auto zoom mode.
20487 * - "scroll" - the content has been scrolled (moved).
20488 * - "scroll,anim,start" - scrolling animation has started.
20489 * - "scroll,anim,stop" - scrolling animation has stopped.
20490 * - "scroll,drag,start" - dragging the contents around has started.
20491 * - "scroll,drag,stop" - dragging the contents around has stopped.
20492 * - "downloaded" - This is called when all currently required map images
20494 * - "route,load" - This is called when route request begins.
20495 * - "route,loaded" - This is called when route request ends.
20496 * - "name,load" - This is called when name request begins.
20497 * - "name,loaded- This is called when name request ends.
20499 * Available style for map widget:
20502 * Available style for markers:
20507 * Available style for marker bubble:
20510 * List of examples:
20511 * @li @ref map_example_01
20512 * @li @ref map_example_02
20513 * @li @ref map_example_03
20522 * @enum _Elm_Map_Zoom_Mode
20523 * @typedef Elm_Map_Zoom_Mode
20525 * Set map's zoom behavior. It can be set to manual or automatic.
20527 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20529 * Values <b> don't </b> work as bitmask, only one can be choosen.
20531 * @note Valid sizes are 2^zoom, consequently the map may be smaller
20532 * than the scroller view.
20534 * @see elm_map_zoom_mode_set()
20535 * @see elm_map_zoom_mode_get()
20539 typedef enum _Elm_Map_Zoom_Mode
20541 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20542 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20543 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20544 ELM_MAP_ZOOM_MODE_LAST
20545 } Elm_Map_Zoom_Mode;
20548 * @enum _Elm_Map_Route_Sources
20549 * @typedef Elm_Map_Route_Sources
20551 * Set route service to be used. By default used source is
20552 * #ELM_MAP_ROUTE_SOURCE_YOURS.
20554 * @see elm_map_route_source_set()
20555 * @see elm_map_route_source_get()
20559 typedef enum _Elm_Map_Route_Sources
20561 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20562 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. */
20563 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20564 ELM_MAP_ROUTE_SOURCE_LAST
20565 } Elm_Map_Route_Sources;
20567 typedef enum _Elm_Map_Name_Sources
20569 ELM_MAP_NAME_SOURCE_NOMINATIM,
20570 ELM_MAP_NAME_SOURCE_LAST
20571 } Elm_Map_Name_Sources;
20574 * @enum _Elm_Map_Route_Type
20575 * @typedef Elm_Map_Route_Type
20577 * Set type of transport used on route.
20579 * @see elm_map_route_add()
20583 typedef enum _Elm_Map_Route_Type
20585 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20586 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20587 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20588 ELM_MAP_ROUTE_TYPE_LAST
20589 } Elm_Map_Route_Type;
20592 * @enum _Elm_Map_Route_Method
20593 * @typedef Elm_Map_Route_Method
20595 * Set the routing method, what should be priorized, time or distance.
20597 * @see elm_map_route_add()
20601 typedef enum _Elm_Map_Route_Method
20603 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20604 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20605 ELM_MAP_ROUTE_METHOD_LAST
20606 } Elm_Map_Route_Method;
20608 typedef enum _Elm_Map_Name_Method
20610 ELM_MAP_NAME_METHOD_SEARCH,
20611 ELM_MAP_NAME_METHOD_REVERSE,
20612 ELM_MAP_NAME_METHOD_LAST
20613 } Elm_Map_Name_Method;
20615 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(). */
20616 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(). */
20617 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(). */
20618 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(). */
20619 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
20620 typedef struct _Elm_Map_Track Elm_Map_Track;
20622 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. */
20623 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20624 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20625 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20627 typedef char *(*ElmMapModuleSourceFunc) (void);
20628 typedef int (*ElmMapModuleZoomMinFunc) (void);
20629 typedef int (*ElmMapModuleZoomMaxFunc) (void);
20630 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20631 typedef int (*ElmMapModuleRouteSourceFunc) (void);
20632 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20633 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20634 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20635 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20638 * Add a new map widget to the given parent Elementary (container) object.
20640 * @param parent The parent object.
20641 * @return a new map widget handle or @c NULL, on errors.
20643 * This function inserts a new map widget on the canvas.
20647 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20650 * Set the zoom level of the map.
20652 * @param obj The map object.
20653 * @param zoom The zoom level to set.
20655 * This sets the zoom level.
20657 * It will respect limits defined by elm_map_source_zoom_min_set() and
20658 * elm_map_source_zoom_max_set().
20660 * By default these values are 0 (world map) and 18 (maximum zoom).
20662 * This function should be used when zoom mode is set to
20663 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20664 * with elm_map_zoom_mode_set().
20666 * @see elm_map_zoom_mode_set().
20667 * @see elm_map_zoom_get().
20671 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20674 * Get the zoom level of the map.
20676 * @param obj The map object.
20677 * @return The current zoom level.
20679 * This returns the current zoom level of the map object.
20681 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20682 * (which is the default), the zoom level may be changed at any time by the
20683 * map object itself to account for map size and map viewport size.
20685 * @see elm_map_zoom_set() for details.
20689 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20692 * Set the zoom mode used by the map object.
20694 * @param obj The map object.
20695 * @param mode The zoom mode of the map, being it one of
20696 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20697 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20699 * This sets the zoom mode to manual or one of the automatic levels.
20700 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20701 * elm_map_zoom_set() and will stay at that level until changed by code
20702 * or until zoom mode is changed. This is the default mode.
20704 * The Automatic modes will allow the map object to automatically
20705 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20706 * adjust zoom so the map fits inside the scroll frame with no pixels
20707 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20708 * ensure no pixels within the frame are left unfilled. Do not forget that
20709 * the valid sizes are 2^zoom, consequently the map may be smaller than
20710 * the scroller view.
20712 * @see elm_map_zoom_set()
20716 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20719 * Get the zoom mode used by the map object.
20721 * @param obj The map object.
20722 * @return The zoom mode of the map, being it one of
20723 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20724 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20726 * This function returns the current zoom mode used by the map object.
20728 * @see elm_map_zoom_mode_set() for more details.
20732 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20735 * Get the current coordinates of the map.
20737 * @param obj The map object.
20738 * @param lon Pointer where to store longitude.
20739 * @param lat Pointer where to store latitude.
20741 * This gets the current center coordinates of the map object. It can be
20742 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20744 * @see elm_map_geo_region_bring_in()
20745 * @see elm_map_geo_region_show()
20749 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20752 * Animatedly bring in given coordinates to the center of the map.
20754 * @param obj The map object.
20755 * @param lon Longitude to center at.
20756 * @param lat Latitude to center at.
20758 * This causes map to jump to the given @p lat and @p lon coordinates
20759 * and show it (by scrolling) in the center of the viewport, if it is not
20760 * already centered. This will use animation to do so and take a period
20761 * of time to complete.
20763 * @see elm_map_geo_region_show() for a function to avoid animation.
20764 * @see elm_map_geo_region_get()
20768 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20771 * Show the given coordinates at the center of the map, @b immediately.
20773 * @param obj The map object.
20774 * @param lon Longitude to center at.
20775 * @param lat Latitude to center at.
20777 * This causes map to @b redraw its viewport's contents to the
20778 * region contining the given @p lat and @p lon, that will be moved to the
20779 * center of the map.
20781 * @see elm_map_geo_region_bring_in() for a function to move with animation.
20782 * @see elm_map_geo_region_get()
20786 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20789 * Pause or unpause the map.
20791 * @param obj The map object.
20792 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20795 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20798 * The default is off.
20800 * This will stop zooming using animation, changing zoom levels will
20801 * change instantly. This will stop any existing animations that are running.
20803 * @see elm_map_paused_get()
20807 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20810 * Get a value whether map is paused or not.
20812 * @param obj The map object.
20813 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
20814 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
20816 * This gets the current paused state for the map object.
20818 * @see elm_map_paused_set() for details.
20822 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20825 * Set to show markers during zoom level changes or not.
20827 * @param obj The map object.
20828 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
20831 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20834 * The default is off.
20836 * This will stop zooming using animation, changing zoom levels will
20837 * change instantly. This will stop any existing animations that are running.
20839 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20842 * The default is off.
20844 * Enabling it will force the map to stop displaying the markers during
20845 * zoom level changes. Set to on if you have a large number of markers.
20847 * @see elm_map_paused_markers_get()
20851 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20854 * Get a value whether markers will be displayed on zoom level changes or not
20856 * @param obj The map object.
20857 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
20858 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
20860 * This gets the current markers paused state for the map object.
20862 * @see elm_map_paused_markers_set() for details.
20866 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20869 * Get the information of downloading status.
20871 * @param obj The map object.
20872 * @param try_num Pointer where to store number of tiles being downloaded.
20873 * @param finish_num Pointer where to store number of tiles successfully
20876 * This gets the current downloading status for the map object, the number
20877 * of tiles being downloaded and the number of tiles already downloaded.
20881 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
20884 * Convert a pixel coordinate (x,y) into a geographic coordinate
20885 * (longitude, latitude).
20887 * @param obj The map object.
20888 * @param x the coordinate.
20889 * @param y the coordinate.
20890 * @param size the size in pixels of the map.
20891 * The map is a square and generally his size is : pow(2.0, zoom)*256.
20892 * @param lon Pointer where to store the longitude that correspond to x.
20893 * @param lat Pointer where to store the latitude that correspond to y.
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_geo_into_coord() if you need the inverse.
20902 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);
20905 * Convert a geographic coordinate (longitude, latitude) into a pixel
20906 * coordinate (x, y).
20908 * @param obj The map object.
20909 * @param lon the longitude.
20910 * @param lat the latitude.
20911 * @param size the size in pixels of the map. The map is a square
20912 * and generally his size is : pow(2.0, zoom)*256.
20913 * @param x Pointer where to store the horizontal pixel coordinate that
20914 * correspond to the longitude.
20915 * @param y Pointer where to store the vertical pixel coordinate that
20916 * correspond to the latitude.
20918 * @note Origin pixel point is the top left corner of the viewport.
20919 * Map zoom and size are taken on account.
20921 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
20925 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);
20928 * Convert a geographic coordinate (longitude, latitude) into a name
20931 * @param obj The map object.
20932 * @param lon the longitude.
20933 * @param lat the latitude.
20934 * @return name A #Elm_Map_Name handle for this coordinate.
20936 * To get the string for this address, elm_map_name_address_get()
20939 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
20943 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20946 * Convert a name (address) into a geographic coordinate
20947 * (longitude, latitude).
20949 * @param obj The map object.
20950 * @param name The address.
20951 * @return name A #Elm_Map_Name handle for this address.
20953 * To get the longitude and latitude, elm_map_name_region_get()
20956 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
20960 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
20963 * Convert a pixel coordinate into a rotated pixel coordinate.
20965 * @param obj The map object.
20966 * @param x horizontal coordinate of the point to rotate.
20967 * @param y vertical coordinate of the point to rotate.
20968 * @param cx rotation's center horizontal position.
20969 * @param cy rotation's center vertical position.
20970 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
20971 * @param xx Pointer where to store rotated x.
20972 * @param yy Pointer where to store rotated y.
20976 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);
20979 * Add a new marker to the map object.
20981 * @param obj The map object.
20982 * @param lon The longitude of the marker.
20983 * @param lat The latitude of the marker.
20984 * @param clas The class, to use when marker @b isn't grouped to others.
20985 * @param clas_group The class group, to use when marker is grouped to others
20986 * @param data The data passed to the callbacks.
20988 * @return The created marker or @c NULL upon failure.
20990 * A marker will be created and shown in a specific point of the map, defined
20991 * by @p lon and @p lat.
20993 * It will be displayed using style defined by @p class when this marker
20994 * is displayed alone (not grouped). A new class can be created with
20995 * elm_map_marker_class_new().
20997 * If the marker is grouped to other markers, it will be displayed with
20998 * style defined by @p class_group. Markers with the same group are grouped
20999 * if they are close. A new group class can be created with
21000 * elm_map_marker_group_class_new().
21002 * Markers created with this method can be deleted with
21003 * elm_map_marker_remove().
21005 * A marker can have associated content to be displayed by a bubble,
21006 * when a user click over it, as well as an icon. These objects will
21007 * be fetch using class' callback functions.
21009 * @see elm_map_marker_class_new()
21010 * @see elm_map_marker_group_class_new()
21011 * @see elm_map_marker_remove()
21015 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);
21018 * Set the maximum numbers of markers' content to be displayed in a group.
21020 * @param obj The map object.
21021 * @param max The maximum numbers of items displayed in a bubble.
21023 * A bubble will be displayed when the user clicks over the group,
21024 * and will place the content of markers that belong to this group
21027 * A group can have a long list of markers, consequently the creation
21028 * of the content of the bubble can be very slow.
21030 * In order to avoid this, a maximum number of items is displayed
21033 * By default this number is 30.
21035 * Marker with the same group class are grouped if they are close.
21037 * @see elm_map_marker_add()
21041 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21044 * Remove a marker from the map.
21046 * @param marker The marker to remove.
21048 * @see elm_map_marker_add()
21052 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21055 * Get the current coordinates of the marker.
21057 * @param marker marker.
21058 * @param lat Pointer where to store the marker's latitude.
21059 * @param lon Pointer where to store the marker's longitude.
21061 * These values are set when adding markers, with function
21062 * elm_map_marker_add().
21064 * @see elm_map_marker_add()
21068 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21071 * Animatedly bring in given marker to the center of the map.
21073 * @param marker The marker to center at.
21075 * This causes map to jump to the given @p marker's coordinates
21076 * and show it (by scrolling) in the center of the viewport, if it is not
21077 * already centered. This will use animation to do so and take a period
21078 * of time to complete.
21080 * @see elm_map_marker_show() for a function to avoid animation.
21081 * @see elm_map_marker_region_get()
21085 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21088 * Show the given marker at the center of the map, @b immediately.
21090 * @param marker The marker to center at.
21092 * This causes map to @b redraw its viewport's contents to the
21093 * region contining the given @p marker's coordinates, that will be
21094 * moved to the center of the map.
21096 * @see elm_map_marker_bring_in() for a function to move with animation.
21097 * @see elm_map_markers_list_show() if more than one marker need to be
21099 * @see elm_map_marker_region_get()
21103 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21106 * Move and zoom the map to display a list of markers.
21108 * @param markers A list of #Elm_Map_Marker handles.
21110 * The map will be centered on the center point of the markers in the list.
21111 * Then the map will be zoomed in order to fit the markers using the maximum
21112 * zoom which allows display of all the markers.
21114 * @warning All the markers should belong to the same map object.
21116 * @see elm_map_marker_show() to show a single marker.
21117 * @see elm_map_marker_bring_in()
21121 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21124 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21126 * @param marker The marker wich content should be returned.
21127 * @return Return the evas object if it exists, else @c NULL.
21129 * To set callback function #ElmMapMarkerGetFunc for the marker class,
21130 * elm_map_marker_class_get_cb_set() should be used.
21132 * This content is what will be inside the bubble that will be displayed
21133 * when an user clicks over the marker.
21135 * This returns the actual Evas object used to be placed inside
21136 * the bubble. This may be @c NULL, as it may
21137 * not have been created or may have been deleted, at any time, by
21138 * the map. <b>Do not modify this object</b> (move, resize,
21139 * show, hide, etc.), as the map is controlling it. This
21140 * function is for querying, emitting custom signals or hooking
21141 * lower level callbacks for events on that object. Do not delete
21142 * this object under any circumstances.
21146 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21149 * Update the marker
21151 * @param marker The marker to be updated.
21153 * If a content is set to this marker, it will call function to delete it,
21154 * #ElmMapMarkerDelFunc, and then will fetch the content again with
21155 * #ElmMapMarkerGetFunc.
21157 * These functions are set for the marker class with
21158 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21162 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21165 * Close all the bubbles opened by the user.
21167 * @param obj The map object.
21169 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21170 * when the user clicks on a marker.
21172 * This functions is set for the marker class with
21173 * elm_map_marker_class_get_cb_set().
21177 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21180 * Create a new group class.
21182 * @param obj The map object.
21183 * @return Returns the new group class.
21185 * Each marker must be associated to a group class. Markers in the same
21186 * group are grouped if they are close.
21188 * The group class defines the style of the marker when a marker is grouped
21189 * to others markers. When it is alone, another class will be used.
21191 * A group class will need to be provided when creating a marker with
21192 * elm_map_marker_add().
21194 * Some properties and functions can be set by class, as:
21195 * - style, with elm_map_group_class_style_set()
21196 * - data - to be associated to the group class. It can be set using
21197 * elm_map_group_class_data_set().
21198 * - min zoom to display markers, set with
21199 * elm_map_group_class_zoom_displayed_set().
21200 * - max zoom to group markers, set using
21201 * elm_map_group_class_zoom_grouped_set().
21202 * - visibility - set if markers will be visible or not, set with
21203 * elm_map_group_class_hide_set().
21204 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21205 * It can be set using elm_map_group_class_icon_cb_set().
21207 * @see elm_map_marker_add()
21208 * @see elm_map_group_class_style_set()
21209 * @see elm_map_group_class_data_set()
21210 * @see elm_map_group_class_zoom_displayed_set()
21211 * @see elm_map_group_class_zoom_grouped_set()
21212 * @see elm_map_group_class_hide_set()
21213 * @see elm_map_group_class_icon_cb_set()
21217 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21220 * Set the marker's style of a group class.
21222 * @param clas The group class.
21223 * @param style The style to be used by markers.
21225 * Each marker must be associated to a group class, and will use the style
21226 * defined by such class when grouped to other markers.
21228 * The following styles are provided by default theme:
21229 * @li @c radio - blue circle
21230 * @li @c radio2 - green circle
21233 * @see elm_map_group_class_new() for more details.
21234 * @see elm_map_marker_add()
21238 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21241 * Set the icon callback function of a group class.
21243 * @param clas The group class.
21244 * @param icon_get The callback function that will return the icon.
21246 * Each marker must be associated to a group class, and it can display a
21247 * custom icon. The function @p icon_get must return this icon.
21249 * @see elm_map_group_class_new() for more details.
21250 * @see elm_map_marker_add()
21254 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21257 * Set the data associated to the group class.
21259 * @param clas The group class.
21260 * @param data The new user data.
21262 * This data will be passed for callback functions, like icon get callback,
21263 * that can be set with elm_map_group_class_icon_cb_set().
21265 * If a data was previously set, the object will lose the pointer for it,
21266 * so if needs to be freed, you must do it yourself.
21268 * @see elm_map_group_class_new() for more details.
21269 * @see elm_map_group_class_icon_cb_set()
21270 * @see elm_map_marker_add()
21274 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21277 * Set the minimum zoom from where the markers are displayed.
21279 * @param clas The group class.
21280 * @param zoom The minimum zoom.
21282 * Markers only will be displayed when the map is displayed at @p zoom
21285 * @see elm_map_group_class_new() for more details.
21286 * @see elm_map_marker_add()
21290 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21293 * Set the zoom from where the markers are no more grouped.
21295 * @param clas The group class.
21296 * @param zoom The maximum zoom.
21298 * Markers only will be grouped when the map is displayed at
21299 * less than @p zoom.
21301 * @see elm_map_group_class_new() for more details.
21302 * @see elm_map_marker_add()
21306 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21309 * Set if the markers associated to the group class @clas are hidden or not.
21311 * @param clas The group class.
21312 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21315 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21320 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21323 * Create a new marker class.
21325 * @param obj The map object.
21326 * @return Returns the new group class.
21328 * Each marker must be associated to a class.
21330 * The marker class defines the style of the marker when a marker is
21331 * displayed alone, i.e., not grouped to to others markers. When grouped
21332 * it will use group class style.
21334 * A marker class will need to be provided when creating a marker with
21335 * elm_map_marker_add().
21337 * Some properties and functions can be set by class, as:
21338 * - style, with elm_map_marker_class_style_set()
21339 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21340 * It can be set using elm_map_marker_class_icon_cb_set().
21341 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21342 * Set using elm_map_marker_class_get_cb_set().
21343 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21344 * Set using elm_map_marker_class_del_cb_set().
21346 * @see elm_map_marker_add()
21347 * @see elm_map_marker_class_style_set()
21348 * @see elm_map_marker_class_icon_cb_set()
21349 * @see elm_map_marker_class_get_cb_set()
21350 * @see elm_map_marker_class_del_cb_set()
21354 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21357 * Set the marker's style of a marker class.
21359 * @param clas The marker class.
21360 * @param style The style to be used by markers.
21362 * Each marker must be associated to a marker class, and will use the style
21363 * defined by such class when alone, i.e., @b not grouped to other markers.
21365 * The following styles are provided by default theme:
21370 * @see elm_map_marker_class_new() for more details.
21371 * @see elm_map_marker_add()
21375 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21378 * Set the icon callback function of a marker class.
21380 * @param clas The marker class.
21381 * @param icon_get The callback function that will return the icon.
21383 * Each marker must be associated to a marker class, and it can display a
21384 * custom icon. The function @p icon_get must return this icon.
21386 * @see elm_map_marker_class_new() for more details.
21387 * @see elm_map_marker_add()
21391 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21394 * Set the bubble content callback function of a marker class.
21396 * @param clas The marker class.
21397 * @param get The callback function that will return the content.
21399 * Each marker must be associated to a marker class, and it can display a
21400 * a content on a bubble that opens when the user click over the marker.
21401 * The function @p get must return this content object.
21403 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21406 * @see elm_map_marker_class_new() for more details.
21407 * @see elm_map_marker_class_del_cb_set()
21408 * @see elm_map_marker_add()
21412 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21415 * Set the callback function used to delete bubble content of a marker class.
21417 * @param clas The marker class.
21418 * @param del The callback function that will delete the content.
21420 * Each marker must be associated to a marker class, and it can display a
21421 * a content on a bubble that opens when the user click over the marker.
21422 * The function to return such content can be set with
21423 * elm_map_marker_class_get_cb_set().
21425 * If this content must be freed, a callback function need to be
21426 * set for that task with this function.
21428 * If this callback is defined it will have to delete (or not) the
21429 * object inside, but if the callback is not defined the object will be
21430 * destroyed with evas_object_del().
21432 * @see elm_map_marker_class_new() for more details.
21433 * @see elm_map_marker_class_get_cb_set()
21434 * @see elm_map_marker_add()
21438 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21441 * Get the list of available sources.
21443 * @param obj The map object.
21444 * @return The source names list.
21446 * It will provide a list with all available sources, that can be set as
21447 * current source with elm_map_source_name_set(), or get with
21448 * elm_map_source_name_get().
21450 * Available sources:
21456 * @see elm_map_source_name_set() for more details.
21457 * @see elm_map_source_name_get()
21461 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21464 * Set the source of the map.
21466 * @param obj The map object.
21467 * @param source The source to be used.
21469 * Map widget retrieves images that composes the map from a web service.
21470 * This web service can be set with this method.
21472 * A different service can return a different maps with different
21473 * information and it can use different zoom values.
21475 * The @p source_name need to match one of the names provided by
21476 * elm_map_source_names_get().
21478 * The current source can be get using elm_map_source_name_get().
21480 * @see elm_map_source_names_get()
21481 * @see elm_map_source_name_get()
21486 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21489 * Get the name of currently used source.
21491 * @param obj The map object.
21492 * @return Returns the name of the source in use.
21494 * @see elm_map_source_name_set() for more details.
21498 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21501 * Set the source of the route service to be used by the map.
21503 * @param obj The map object.
21504 * @param source The route service to be used, being it one of
21505 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21506 * and #ELM_MAP_ROUTE_SOURCE_ORS.
21508 * Each one has its own algorithm, so the route retrieved may
21509 * differ depending on the source route. Now, only the default is working.
21511 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21512 * http://www.yournavigation.org/.
21514 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21515 * assumptions. Its routing core is based on Contraction Hierarchies.
21517 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21519 * @see elm_map_route_source_get().
21523 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21526 * Get the current route source.
21528 * @param obj The map object.
21529 * @return The source of the route service used by the map.
21531 * @see elm_map_route_source_set() for details.
21535 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21538 * Set the minimum zoom of the source.
21540 * @param obj The map object.
21541 * @param zoom New minimum zoom value to be used.
21543 * By default, it's 0.
21547 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21550 * Get the minimum zoom of the source.
21552 * @param obj The map object.
21553 * @return Returns the minimum zoom of the source.
21555 * @see elm_map_source_zoom_min_set() for details.
21559 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21562 * Set the maximum zoom of the source.
21564 * @param obj The map object.
21565 * @param zoom New maximum zoom value to be used.
21567 * By default, it's 18.
21571 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21574 * Get the maximum zoom of the source.
21576 * @param obj The map object.
21577 * @return Returns the maximum zoom of the source.
21579 * @see elm_map_source_zoom_min_set() for details.
21583 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21586 * Set the user agent used by the map object to access routing services.
21588 * @param obj The map object.
21589 * @param user_agent The user agent to be used by the map.
21591 * User agent is a client application implementing a network protocol used
21592 * in communications within a client–server distributed computing system
21594 * The @p user_agent identification string will transmitted in a header
21595 * field @c User-Agent.
21597 * @see elm_map_user_agent_get()
21601 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21604 * Get the user agent used by the map object.
21606 * @param obj The map object.
21607 * @return The user agent identification string used by the map.
21609 * @see elm_map_user_agent_set() for details.
21613 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21616 * Add a new route to the map object.
21618 * @param obj The map object.
21619 * @param type The type of transport to be considered when tracing a route.
21620 * @param method The routing method, what should be priorized.
21621 * @param flon The start longitude.
21622 * @param flat The start latitude.
21623 * @param tlon The destination longitude.
21624 * @param tlat The destination latitude.
21626 * @return The created route or @c NULL upon failure.
21628 * A route will be traced by point on coordinates (@p flat, @p flon)
21629 * to point on coordinates (@p tlat, @p tlon), using the route service
21630 * set with elm_map_route_source_set().
21632 * It will take @p type on consideration to define the route,
21633 * depending if the user will be walking or driving, the route may vary.
21634 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21635 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21637 * Another parameter is what the route should priorize, the minor distance
21638 * or the less time to be spend on the route. So @p method should be one
21639 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21641 * Routes created with this method can be deleted with
21642 * elm_map_route_remove(), colored with elm_map_route_color_set(),
21643 * and distance can be get with elm_map_route_distance_get().
21645 * @see elm_map_route_remove()
21646 * @see elm_map_route_color_set()
21647 * @see elm_map_route_distance_get()
21648 * @see elm_map_route_source_set()
21652 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);
21655 * Remove a route from the map.
21657 * @param route The route to remove.
21659 * @see elm_map_route_add()
21663 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21666 * Set the route color.
21668 * @param route The route object.
21669 * @param r Red channel value, from 0 to 255.
21670 * @param g Green channel value, from 0 to 255.
21671 * @param b Blue channel value, from 0 to 255.
21672 * @param a Alpha channel value, from 0 to 255.
21674 * It uses an additive color model, so each color channel represents
21675 * how much of each primary colors must to be used. 0 represents
21676 * ausence of this color, so if all of the three are set to 0,
21677 * the color will be black.
21679 * These component values should be integers in the range 0 to 255,
21680 * (single 8-bit byte).
21682 * This sets the color used for the route. By default, it is set to
21683 * solid red (r = 255, g = 0, b = 0, a = 255).
21685 * For alpha channel, 0 represents completely transparent, and 255, opaque.
21687 * @see elm_map_route_color_get()
21691 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21694 * Get the route color.
21696 * @param route The route object.
21697 * @param r Pointer where to store the red channel value.
21698 * @param g Pointer where to store the green channel value.
21699 * @param b Pointer where to store the blue channel value.
21700 * @param a Pointer where to store the alpha channel value.
21702 * @see elm_map_route_color_set() for details.
21706 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21709 * Get the route distance in kilometers.
21711 * @param route The route object.
21712 * @return The distance of route (unit : km).
21716 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21719 * Get the information of route nodes.
21721 * @param route The route object.
21722 * @return Returns a string with the nodes of route.
21726 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21729 * Get the information of route waypoint.
21731 * @param route the route object.
21732 * @return Returns a string with information about waypoint of route.
21736 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21739 * Get the address of the name.
21741 * @param name The name handle.
21742 * @return Returns the address string of @p name.
21744 * This gets the coordinates of the @p name, created with one of the
21745 * conversion functions.
21747 * @see elm_map_utils_convert_name_into_coord()
21748 * @see elm_map_utils_convert_coord_into_name()
21752 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21755 * Get the current coordinates of the name.
21757 * @param name The name handle.
21758 * @param lat Pointer where to store the latitude.
21759 * @param lon Pointer where to store The longitude.
21761 * This gets the coordinates of the @p name, created with one of the
21762 * conversion functions.
21764 * @see elm_map_utils_convert_name_into_coord()
21765 * @see elm_map_utils_convert_coord_into_name()
21769 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21772 * Remove a name from the map.
21774 * @param name The name to remove.
21776 * Basically the struct handled by @p name will be freed, so convertions
21777 * between address and coordinates will be lost.
21779 * @see elm_map_utils_convert_name_into_coord()
21780 * @see elm_map_utils_convert_coord_into_name()
21784 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21789 * @param obj The map object.
21790 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21791 * @param cx Rotation's center horizontal position.
21792 * @param cy Rotation's center vertical position.
21794 * @see elm_map_rotate_get()
21798 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
21801 * Get the rotate degree of the map
21803 * @param obj The map object
21804 * @param degree Pointer where to store degrees from 0.0 to 360.0
21805 * to rotate arount Z axis.
21806 * @param cx Pointer where to store rotation's center horizontal position.
21807 * @param cy Pointer where to store rotation's center vertical position.
21809 * @see elm_map_rotate_set() to set map rotation.
21813 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);
21816 * Enable or disable mouse wheel to be used to zoom in / out the map.
21818 * @param obj The map object.
21819 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
21822 * Mouse wheel can be used for the user to zoom in or zoom out the map.
21824 * It's disabled by default.
21826 * @see elm_map_wheel_disabled_get()
21830 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
21833 * Get a value whether mouse wheel is enabled or not.
21835 * @param obj The map object.
21836 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
21837 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21839 * Mouse wheel can be used for the user to zoom in or zoom out the map.
21841 * @see elm_map_wheel_disabled_set() for details.
21845 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21849 * Add a track on the map
21851 * @param obj The map object.
21852 * @param emap The emap route object.
21853 * @return The route object. This is an elm object of type Route.
21855 * @see elm_route_add() for details.
21859 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
21863 * Remove a track from the map
21865 * @param obj The map object.
21866 * @param route The track to remove.
21870 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
21877 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
21879 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
21881 EAPI double elm_route_lon_min_get(Evas_Object *obj);
21882 EAPI double elm_route_lat_min_get(Evas_Object *obj);
21883 EAPI double elm_route_lon_max_get(Evas_Object *obj);
21884 EAPI double elm_route_lat_max_get(Evas_Object *obj);
21888 * @defgroup Panel Panel
21890 * @image html img/widget/panel/preview-00.png
21891 * @image latex img/widget/panel/preview-00.eps
21893 * @brief A panel is a type of animated container that contains subobjects.
21894 * It can be expanded or contracted by clicking the button on it's edge.
21896 * Orientations are as follows:
21897 * @li ELM_PANEL_ORIENT_TOP
21898 * @li ELM_PANEL_ORIENT_LEFT
21899 * @li ELM_PANEL_ORIENT_RIGHT
21901 * @ref tutorial_panel shows one way to use this widget.
21904 typedef enum _Elm_Panel_Orient
21906 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
21907 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
21908 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
21909 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
21910 } Elm_Panel_Orient;
21912 * @brief Adds a panel object
21914 * @param parent The parent object
21916 * @return The panel object, or NULL on failure
21918 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21920 * @brief Sets the orientation of the panel
21922 * @param parent The parent object
21923 * @param orient The panel orientation. Can be one of the following:
21924 * @li ELM_PANEL_ORIENT_TOP
21925 * @li ELM_PANEL_ORIENT_LEFT
21926 * @li ELM_PANEL_ORIENT_RIGHT
21928 * Sets from where the panel will (dis)appear.
21930 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
21932 * @brief Get the orientation of the panel.
21934 * @param obj The panel object
21935 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
21937 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21939 * @brief Set the content of the panel.
21941 * @param obj The panel object
21942 * @param content The panel content
21944 * Once the content object is set, a previously set one will be deleted.
21945 * If you want to keep that old content object, use the
21946 * elm_panel_content_unset() function.
21948 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21950 * @brief Get the content of the panel.
21952 * @param obj The panel object
21953 * @return The content that is being used
21955 * Return the content object which is set for this widget.
21957 * @see elm_panel_content_set()
21959 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21961 * @brief Unset the content of the panel.
21963 * @param obj The panel object
21964 * @return The content that was being used
21966 * Unparent and return the content object which was set for this widget.
21968 * @see elm_panel_content_set()
21970 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21972 * @brief Set the state of the panel.
21974 * @param obj The panel object
21975 * @param hidden If true, the panel will run the animation to contract
21977 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
21979 * @brief Get the state of the panel.
21981 * @param obj The panel object
21982 * @param hidden If true, the panel is in the "hide" state
21984 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21986 * @brief Toggle the hidden state of the panel from code
21988 * @param obj The panel object
21990 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
21996 * @defgroup Panes Panes
21997 * @ingroup Elementary
21999 * @image html img/widget/panes/preview-00.png
22000 * @image latex img/widget/panes/preview-00.eps width=\textwidth
22002 * @image html img/panes.png
22003 * @image latex img/panes.eps width=\textwidth
22005 * The panes adds a dragable bar between two contents. When dragged
22006 * this bar will resize contents size.
22008 * Panes can be displayed vertically or horizontally, and contents
22009 * size proportion can be customized (homogeneous by default).
22011 * Smart callbacks one can listen to:
22012 * - "press" - The panes has been pressed (button wasn't released yet).
22013 * - "unpressed" - The panes was released after being pressed.
22014 * - "clicked" - The panes has been clicked>
22015 * - "clicked,double" - The panes has been double clicked
22017 * Available styles for it:
22020 * Here is an example on its usage:
22021 * @li @ref panes_example
22025 * @addtogroup Panes
22030 * Add a new panes widget to the given parent Elementary
22031 * (container) object.
22033 * @param parent The parent object.
22034 * @return a new panes widget handle or @c NULL, on errors.
22036 * This function inserts a new panes widget on the canvas.
22040 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22043 * Set the left content of the panes widget.
22045 * @param obj The panes object.
22046 * @param content The new left content object.
22048 * Once the content object is set, a previously set one will be deleted.
22049 * If you want to keep that old content object, use the
22050 * elm_panes_content_left_unset() function.
22052 * If panes is displayed vertically, left content will be displayed at
22055 * @see elm_panes_content_left_get()
22056 * @see elm_panes_content_right_set() to set content on the other side.
22060 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22063 * Set the right content of the panes widget.
22065 * @param obj The panes object.
22066 * @param content The new right content object.
22068 * Once the content object is set, a previously set one will be deleted.
22069 * If you want to keep that old content object, use the
22070 * elm_panes_content_right_unset() function.
22072 * If panes is displayed vertically, left content will be displayed at
22075 * @see elm_panes_content_right_get()
22076 * @see elm_panes_content_left_set() to set content on the other side.
22080 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22083 * Get the left content of the panes.
22085 * @param obj The panes object.
22086 * @return The left content object that is being used.
22088 * Return the left content object which is set for this widget.
22090 * @see elm_panes_content_left_set() for details.
22094 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22097 * Get the right content of the panes.
22099 * @param obj The panes object
22100 * @return The right content object that is being used
22102 * Return the right content object which is set for this widget.
22104 * @see elm_panes_content_right_set() for details.
22108 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22111 * Unset the left content used for the panes.
22113 * @param obj The panes object.
22114 * @return The left content object that was being used.
22116 * Unparent and return the left content object which was set for this widget.
22118 * @see elm_panes_content_left_set() for details.
22119 * @see elm_panes_content_left_get().
22123 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22126 * Unset the right content used for the panes.
22128 * @param obj The panes object.
22129 * @return The right content object that was being used.
22131 * Unparent and return the right content object which was set for this
22134 * @see elm_panes_content_right_set() for details.
22135 * @see elm_panes_content_right_get().
22139 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22142 * Get the size proportion of panes widget's left side.
22144 * @param obj The panes object.
22145 * @return float value between 0.0 and 1.0 representing size proportion
22148 * @see elm_panes_content_left_size_set() for more details.
22152 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22155 * Set the size proportion of panes widget's left side.
22157 * @param obj The panes object.
22158 * @param size Value between 0.0 and 1.0 representing size proportion
22161 * By default it's homogeneous, i.e., both sides have the same size.
22163 * If something different is required, it can be set with this function.
22164 * For example, if the left content should be displayed over
22165 * 75% of the panes size, @p size should be passed as @c 0.75.
22166 * This way, right content will be resized to 25% of panes size.
22168 * If displayed vertically, left content is displayed at top, and
22169 * right content at bottom.
22171 * @note This proportion will change when user drags the panes bar.
22173 * @see elm_panes_content_left_size_get()
22177 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22180 * Set the orientation of a given panes widget.
22182 * @param obj The panes object.
22183 * @param horizontal Use @c EINA_TRUE to make @p obj to be
22184 * @b horizontal, @c EINA_FALSE to make it @b vertical.
22186 * Use this function to change how your panes is to be
22187 * disposed: vertically or horizontally.
22189 * By default it's displayed horizontally.
22191 * @see elm_panes_horizontal_get()
22195 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22198 * Retrieve the orientation of a given panes widget.
22200 * @param obj The panes object.
22201 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22202 * @c EINA_FALSE if it's @b vertical (and on errors).
22204 * @see elm_panes_horizontal_set() for more details.
22208 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22215 * @defgroup Flip Flip
22217 * @image html img/widget/flip/preview-00.png
22218 * @image latex img/widget/flip/preview-00.eps
22220 * This widget holds 2 content objects(Evas_Object): one on the front and one
22221 * on the back. It allows you to flip from front to back and vice-versa using
22222 * various animations.
22224 * If either the front or back contents are not set the flip will treat that
22225 * as transparent. So if you wore to set the front content but not the back,
22226 * and then call elm_flip_go() you would see whatever is below the flip.
22228 * For a list of supported animations see elm_flip_go().
22230 * Signals that you can add callbacks for are:
22231 * "animate,begin" - when a flip animation was started
22232 * "animate,done" - when a flip animation is finished
22234 * @ref tutorial_flip show how to use most of the API.
22238 typedef enum _Elm_Flip_Mode
22240 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22241 ELM_FLIP_ROTATE_X_CENTER_AXIS,
22242 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22243 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22244 ELM_FLIP_CUBE_LEFT,
22245 ELM_FLIP_CUBE_RIGHT,
22247 ELM_FLIP_CUBE_DOWN,
22248 ELM_FLIP_PAGE_LEFT,
22249 ELM_FLIP_PAGE_RIGHT,
22253 typedef enum _Elm_Flip_Interaction
22255 ELM_FLIP_INTERACTION_NONE,
22256 ELM_FLIP_INTERACTION_ROTATE,
22257 ELM_FLIP_INTERACTION_CUBE,
22258 ELM_FLIP_INTERACTION_PAGE
22259 } Elm_Flip_Interaction;
22260 typedef enum _Elm_Flip_Direction
22262 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22263 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22264 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22265 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22266 } Elm_Flip_Direction;
22268 * @brief Add a new flip to the parent
22270 * @param parent The parent object
22271 * @return The new object or NULL if it cannot be created
22273 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22275 * @brief Set the front content of the flip widget.
22277 * @param obj The flip object
22278 * @param content The new front content object
22280 * Once the content object is set, a previously set one will be deleted.
22281 * If you want to keep that old content object, use the
22282 * elm_flip_content_front_unset() function.
22284 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22286 * @brief Set the back content of the flip widget.
22288 * @param obj The flip object
22289 * @param content The new back content object
22291 * Once the content object is set, a previously set one will be deleted.
22292 * If you want to keep that old content object, use the
22293 * elm_flip_content_back_unset() function.
22295 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22297 * @brief Get the front content used for the flip
22299 * @param obj The flip object
22300 * @return The front content object that is being used
22302 * Return the front content object which is set for this widget.
22304 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22306 * @brief Get the back content used for the flip
22308 * @param obj The flip object
22309 * @return The back content object that is being used
22311 * Return the back content object which is set for this widget.
22313 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22315 * @brief Unset the front content used for the flip
22317 * @param obj The flip object
22318 * @return The front content object that was being used
22320 * Unparent and return the front content object which was set for this widget.
22322 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22324 * @brief Unset the back content used for the flip
22326 * @param obj The flip object
22327 * @return The back content object that was being used
22329 * Unparent and return the back content object which was set for this widget.
22331 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22333 * @brief Get flip front visibility state
22335 * @param obj The flip objct
22336 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22339 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22341 * @brief Set flip perspective
22343 * @param obj The flip object
22344 * @param foc The coordinate to set the focus on
22345 * @param x The X coordinate
22346 * @param y The Y coordinate
22348 * @warning This function currently does nothing.
22350 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22352 * @brief Runs the flip animation
22354 * @param obj The flip object
22355 * @param mode The mode type
22357 * Flips the front and back contents using the @p mode animation. This
22358 * efectively hides the currently visible content and shows the hidden one.
22360 * There a number of possible animations to use for the flipping:
22361 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22362 * around a horizontal axis in the middle of its height, the other content
22363 * is shown as the other side of the flip.
22364 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22365 * around a vertical axis in the middle of its width, the other content is
22366 * shown as the other side of the flip.
22367 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22368 * around a diagonal axis in the middle of its width, the other content is
22369 * shown as the other side of the flip.
22370 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22371 * around a diagonal axis in the middle of its height, the other content is
22372 * shown as the other side of the flip.
22373 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22374 * as if the flip was a cube, the other content is show as the right face of
22376 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22377 * right as if the flip was a cube, the other content is show as the left
22378 * face of the cube.
22379 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22380 * flip was a cube, the other content is show as the bottom face of the cube.
22381 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22382 * the flip was a cube, the other content is show as the upper face of the
22384 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22385 * if the flip was a book, the other content is shown as the page below that.
22386 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22387 * as if the flip was a book, the other content is shown as the page below
22389 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22390 * flip was a book, the other content is shown as the page below that.
22391 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22392 * flip was a book, the other content is shown as the page below that.
22394 * @image html elm_flip.png
22395 * @image latex elm_flip.eps width=\textwidth
22397 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22399 * @brief Set the interactive flip mode
22401 * @param obj The flip object
22402 * @param mode The interactive flip mode to use
22404 * This sets if the flip should be interactive (allow user to click and
22405 * drag a side of the flip to reveal the back page and cause it to flip).
22406 * By default a flip is not interactive. You may also need to set which
22407 * sides of the flip are "active" for flipping and how much space they use
22408 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22409 * and elm_flip_interacton_direction_hitsize_set()
22411 * The four avilable mode of interaction are:
22412 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22413 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22414 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22415 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22417 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22418 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22419 * happen, those can only be acheived with elm_flip_go();
22421 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22423 * @brief Get the interactive flip mode
22425 * @param obj The flip object
22426 * @return The interactive flip mode
22428 * Returns the interactive flip mode set by elm_flip_interaction_set()
22430 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22432 * @brief Set which directions of the flip respond to interactive flip
22434 * @param obj The flip object
22435 * @param dir The direction to change
22436 * @param enabled If that direction is enabled or not
22438 * By default all directions are disabled, so you may want to enable the
22439 * desired directions for flipping if you need interactive flipping. You must
22440 * call this function once for each direction that should be enabled.
22442 * @see elm_flip_interaction_set()
22444 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22446 * @brief Get the enabled state of that flip direction
22448 * @param obj The flip object
22449 * @param dir The direction to check
22450 * @return If that direction is enabled or not
22452 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22454 * @see elm_flip_interaction_set()
22456 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22458 * @brief Set the amount of the flip that is sensitive to interactive flip
22460 * @param obj The flip object
22461 * @param dir The direction to modify
22462 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22464 * Set the amount of the flip that is sensitive to interactive flip, with 0
22465 * representing no area in the flip and 1 representing the entire flip. There
22466 * is however a consideration to be made in that the area will never be
22467 * smaller than the finger size set(as set in your Elementary configuration).
22469 * @see elm_flip_interaction_set()
22471 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22473 * @brief Get the amount of the flip that is sensitive to interactive flip
22475 * @param obj The flip object
22476 * @param dir The direction to check
22477 * @return The size set for that direction
22479 * Returns the amount os sensitive area set by
22480 * elm_flip_interacton_direction_hitsize_set().
22482 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22487 /* scrolledentry */
22488 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22489 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22490 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22491 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22492 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22493 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22494 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22495 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22496 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22497 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22498 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22499 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22500 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22501 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22502 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22503 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22504 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22505 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22506 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22507 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22508 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22509 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22510 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22511 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22512 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22513 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22514 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22515 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22516 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22517 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22518 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22519 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22520 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22521 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22522 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22523 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);
22524 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22525 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22526 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);
22527 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22528 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);
22529 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22530 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22531 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22532 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22533 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22534 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22535 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22536 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22537 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);
22538 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);
22539 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);
22540 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);
22541 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);
22542 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);
22543 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22544 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22545 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22546 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22547 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22548 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22549 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22552 * @defgroup Conformant Conformant
22553 * @ingroup Elementary
22555 * @image html img/widget/conformant/preview-00.png
22556 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22558 * @image html img/conformant.png
22559 * @image latex img/conformant.eps width=\textwidth
22561 * The aim is to provide a widget that can be used in elementary apps to
22562 * account for space taken up by the indicator, virtual keypad & softkey
22563 * windows when running the illume2 module of E17.
22565 * So conformant content will be sized and positioned considering the
22566 * space required for such stuff, and when they popup, as a keyboard
22567 * shows when an entry is selected, conformant content won't change.
22569 * Available styles for it:
22572 * See how to use this widget in this example:
22573 * @ref conformant_example
22577 * @addtogroup Conformant
22582 * Add a new conformant widget to the given parent Elementary
22583 * (container) object.
22585 * @param parent The parent object.
22586 * @return A new conformant widget handle or @c NULL, on errors.
22588 * This function inserts a new conformant widget on the canvas.
22590 * @ingroup Conformant
22592 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22595 * Set the content of the conformant widget.
22597 * @param obj The conformant object.
22598 * @param content The content to be displayed by the conformant.
22600 * Content will be sized and positioned considering the space required
22601 * to display a virtual keyboard. So it won't fill all the conformant
22602 * size. This way is possible to be sure that content won't resize
22603 * or be re-positioned after the keyboard is displayed.
22605 * Once the content object is set, a previously set one will be deleted.
22606 * If you want to keep that old content object, use the
22607 * elm_conformat_content_unset() function.
22609 * @see elm_conformant_content_unset()
22610 * @see elm_conformant_content_get()
22612 * @ingroup Conformant
22614 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22617 * Get the content of the conformant widget.
22619 * @param obj The conformant object.
22620 * @return The content that is being used.
22622 * Return the content object which is set for this widget.
22623 * It won't be unparent from conformant. For that, use
22624 * elm_conformant_content_unset().
22626 * @see elm_conformant_content_set() for more details.
22627 * @see elm_conformant_content_unset()
22629 * @ingroup Conformant
22631 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22634 * Unset the content of the conformant widget.
22636 * @param obj The conformant object.
22637 * @return The content that was being used.
22639 * Unparent and return the content object which was set for this widget.
22641 * @see elm_conformant_content_set() for more details.
22643 * @ingroup Conformant
22645 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22648 * Returns the Evas_Object that represents the content area.
22650 * @param obj The conformant object.
22651 * @return The content area of the widget.
22653 * @ingroup Conformant
22655 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22662 * @defgroup Mapbuf Mapbuf
22663 * @ingroup Elementary
22665 * @image html img/widget/mapbuf/preview-00.png
22666 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22668 * This holds one content object and uses an Evas Map of transformation
22669 * points to be later used with this content. So the content will be
22670 * moved, resized, etc as a single image. So it will improve performance
22671 * when you have a complex interafce, with a lot of elements, and will
22672 * need to resize or move it frequently (the content object and its
22675 * See how to use this widget in this example:
22676 * @ref mapbuf_example
22680 * @addtogroup Mapbuf
22685 * Add a new mapbuf widget to the given parent Elementary
22686 * (container) object.
22688 * @param parent The parent object.
22689 * @return A new mapbuf widget handle or @c NULL, on errors.
22691 * This function inserts a new mapbuf widget on the canvas.
22695 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22698 * Set the content of the mapbuf.
22700 * @param obj The mapbuf object.
22701 * @param content The content that will be filled in this mapbuf object.
22703 * Once the content object is set, a previously set one will be deleted.
22704 * If you want to keep that old content object, use the
22705 * elm_mapbuf_content_unset() function.
22707 * To enable map, elm_mapbuf_enabled_set() should be used.
22711 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22714 * Get the content of the mapbuf.
22716 * @param obj The mapbuf object.
22717 * @return The content that is being used.
22719 * Return the content object which is set for this widget.
22721 * @see elm_mapbuf_content_set() for details.
22725 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22728 * Unset the content of the mapbuf.
22730 * @param obj The mapbuf object.
22731 * @return The content that was being used.
22733 * Unparent and return the content object which was set for this widget.
22735 * @see elm_mapbuf_content_set() for details.
22739 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22742 * Enable or disable the map.
22744 * @param obj The mapbuf object.
22745 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22747 * This enables the map that is set or disables it. On enable, the object
22748 * geometry will be saved, and the new geometry will change (position and
22749 * size) to reflect the map geometry set.
22751 * Also, when enabled, alpha and smooth states will be used, so if the
22752 * content isn't solid, alpha should be enabled, for example, otherwise
22753 * a black retangle will fill the content.
22755 * When disabled, the stored map will be freed and geometry prior to
22756 * enabling the map will be restored.
22758 * It's disabled by default.
22760 * @see elm_mapbuf_alpha_set()
22761 * @see elm_mapbuf_smooth_set()
22765 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22768 * Get a value whether map is enabled or not.
22770 * @param obj The mapbuf object.
22771 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22772 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22774 * @see elm_mapbuf_enabled_set() for details.
22778 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22781 * Enable or disable smooth map rendering.
22783 * @param obj The mapbuf object.
22784 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22787 * This sets smoothing for map rendering. If the object is a type that has
22788 * its own smoothing settings, then both the smooth settings for this object
22789 * and the map must be turned off.
22791 * By default smooth maps are enabled.
22795 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22798 * Get a value whether smooth map rendering is enabled or not.
22800 * @param obj The mapbuf object.
22801 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
22802 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22804 * @see elm_mapbuf_smooth_set() for details.
22808 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22811 * Set or unset alpha flag for map rendering.
22813 * @param obj The mapbuf object.
22814 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
22817 * This sets alpha flag for map rendering. If the object is a type that has
22818 * its own alpha settings, then this will take precedence. Only image objects
22819 * have this currently. It stops alpha blending of the map area, and is
22820 * useful if you know the object and/or all sub-objects is 100% solid.
22822 * Alpha is enabled by default.
22826 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
22829 * Get a value whether alpha blending is enabled or not.
22831 * @param obj The mapbuf object.
22832 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
22833 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22835 * @see elm_mapbuf_alpha_set() for details.
22839 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22846 * @defgroup Flipselector Flip Selector
22848 * @image html img/widget/flipselector/preview-00.png
22849 * @image latex img/widget/flipselector/preview-00.eps
22851 * A flip selector is a widget to show a set of @b text items, one
22852 * at a time, with the same sheet switching style as the @ref Clock
22853 * "clock" widget, when one changes the current displaying sheet
22854 * (thus, the "flip" in the name).
22856 * User clicks to flip sheets which are @b held for some time will
22857 * make the flip selector to flip continuosly and automatically for
22858 * the user. The interval between flips will keep growing in time,
22859 * so that it helps the user to reach an item which is distant from
22860 * the current selection.
22862 * Smart callbacks one can register to:
22863 * - @c "selected" - when the widget's selected text item is changed
22864 * - @c "overflowed" - when the widget's current selection is changed
22865 * from the first item in its list to the last
22866 * - @c "underflowed" - when the widget's current selection is changed
22867 * from the last item in its list to the first
22869 * Available styles for it:
22872 * Here is an example on its usage:
22873 * @li @ref flipselector_example
22877 * @addtogroup Flipselector
22881 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
22884 * Add a new flip selector widget to the given parent Elementary
22885 * (container) widget
22887 * @param parent The parent object
22888 * @return a new flip selector widget handle or @c NULL, on errors
22890 * This function inserts a new flip selector widget on the canvas.
22892 * @ingroup Flipselector
22894 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22897 * Programmatically select the next item of a flip selector widget
22899 * @param obj The flipselector object
22901 * @note The selection will be animated. Also, if it reaches the
22902 * end of its list of member items, it will continue with the first
22905 * @ingroup Flipselector
22907 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22910 * Programmatically select the previous item of a flip selector
22913 * @param obj The flipselector object
22915 * @note The selection will be animated. Also, if it reaches the
22916 * beginning of its list of member items, it will continue with the
22917 * last one backwards.
22919 * @ingroup Flipselector
22921 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22924 * Append a (text) item to a flip selector widget
22926 * @param obj The flipselector object
22927 * @param label The (text) label of the new item
22928 * @param func Convenience callback function to take place when
22930 * @param data Data passed to @p func, above
22931 * @return A handle to the item added or @c NULL, on errors
22933 * The widget's list of labels to show will be appended with the
22934 * given value. If the user wishes so, a callback function pointer
22935 * can be passed, which will get called when this same item is
22938 * @note The current selection @b won't be modified by appending an
22939 * element to the list.
22941 * @note The maximum length of the text label is going to be
22942 * determined <b>by the widget's theme</b>. Strings larger than
22943 * that value are going to be @b truncated.
22945 * @ingroup Flipselector
22947 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
22950 * Prepend a (text) item to a flip selector widget
22952 * @param obj The flipselector object
22953 * @param label The (text) label of the new item
22954 * @param func Convenience callback function to take place when
22956 * @param data Data passed to @p func, above
22957 * @return A handle to the item added or @c NULL, on errors
22959 * The widget's list of labels to show will be prepended with the
22960 * given value. If the user wishes so, a callback function pointer
22961 * can be passed, which will get called when this same item is
22964 * @note The current selection @b won't be modified by prepending
22965 * an element to the list.
22967 * @note The maximum length of the text label is going to be
22968 * determined <b>by the widget's theme</b>. Strings larger than
22969 * that value are going to be @b truncated.
22971 * @ingroup Flipselector
22973 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
22976 * Get the internal list of items in a given flip selector widget.
22978 * @param obj The flipselector object
22979 * @return The list of items (#Elm_Flipselector_Item as data) or
22980 * @c NULL on errors.
22982 * This list is @b not to be modified in any way and must not be
22983 * freed. Use the list members with functions like
22984 * elm_flipselector_item_label_set(),
22985 * elm_flipselector_item_label_get(),
22986 * elm_flipselector_item_del(),
22987 * elm_flipselector_item_selected_get(),
22988 * elm_flipselector_item_selected_set().
22990 * @warning This list is only valid until @p obj object's internal
22991 * items list is changed. It should be fetched again with another
22992 * call to this function when changes happen.
22994 * @ingroup Flipselector
22996 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22999 * Get the first item in the given flip selector widget's list of
23002 * @param obj The flipselector object
23003 * @return The first item or @c NULL, if it has no items (and on
23006 * @see elm_flipselector_item_append()
23007 * @see elm_flipselector_last_item_get()
23009 * @ingroup Flipselector
23011 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23014 * Get the last item in the given flip selector widget's list of
23017 * @param obj The flipselector object
23018 * @return The last item or @c NULL, if it has no items (and on
23021 * @see elm_flipselector_item_prepend()
23022 * @see elm_flipselector_first_item_get()
23024 * @ingroup Flipselector
23026 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23029 * Get the currently selected item in a flip selector widget.
23031 * @param obj The flipselector object
23032 * @return The selected item or @c NULL, if the widget has no items
23035 * @ingroup Flipselector
23037 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23040 * Set whether a given flip selector widget's item should be the
23041 * currently selected one.
23043 * @param item The flip selector item
23044 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23046 * This sets whether @p item is or not the selected (thus, under
23047 * display) one. If @p item is different than one under display,
23048 * the latter will be unselected. If the @p item is set to be
23049 * unselected, on the other hand, the @b first item in the widget's
23050 * internal members list will be the new selected one.
23052 * @see elm_flipselector_item_selected_get()
23054 * @ingroup Flipselector
23056 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23059 * Get whether a given flip selector widget's item is the currently
23062 * @param item The flip selector item
23063 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23066 * @see elm_flipselector_item_selected_set()
23068 * @ingroup Flipselector
23070 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23073 * Delete a given item from a flip selector widget.
23075 * @param item The item to delete
23077 * @ingroup Flipselector
23079 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23082 * Get the label of a given flip selector widget's item.
23084 * @param item The item to get label from
23085 * @return The text label of @p item or @c NULL, on errors
23087 * @see elm_flipselector_item_label_set()
23089 * @ingroup Flipselector
23091 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23094 * Set the label of a given flip selector widget's item.
23096 * @param item The item to set label on
23097 * @param label The text label string, in UTF-8 encoding
23099 * @see elm_flipselector_item_label_get()
23101 * @ingroup Flipselector
23103 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23106 * Gets the item before @p item in a flip selector widget's
23107 * internal list of items.
23109 * @param item The item to fetch previous from
23110 * @return The item before the @p item, in its parent's list. If
23111 * there is no previous item for @p item or there's an
23112 * error, @c NULL is returned.
23114 * @see elm_flipselector_item_next_get()
23116 * @ingroup Flipselector
23118 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23121 * Gets the item after @p item in a flip selector widget's
23122 * internal list of items.
23124 * @param item The item to fetch next from
23125 * @return The item after the @p item, in its parent's list. If
23126 * there is no next item for @p item or there's an
23127 * error, @c NULL is returned.
23129 * @see elm_flipselector_item_next_get()
23131 * @ingroup Flipselector
23133 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23136 * Set the interval on time updates for an user mouse button hold
23137 * on a flip selector widget.
23139 * @param obj The flip selector object
23140 * @param interval The (first) interval value in seconds
23142 * This interval value is @b decreased while the user holds the
23143 * mouse pointer either flipping up or flipping doww a given flip
23146 * This helps the user to get to a given item distant from the
23147 * current one easier/faster, as it will start to flip quicker and
23148 * quicker on mouse button holds.
23150 * The calculation for the next flip interval value, starting from
23151 * the one set with this call, is the previous interval divided by
23152 * 1.05, so it decreases a little bit.
23154 * The default starting interval value for automatic flips is
23157 * @see elm_flipselector_interval_get()
23159 * @ingroup Flipselector
23161 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23164 * Get the interval on time updates for an user mouse button hold
23165 * on a flip selector widget.
23167 * @param obj The flip selector object
23168 * @return The (first) interval value, in seconds, set on it
23170 * @see elm_flipselector_interval_set() for more details
23172 * @ingroup Flipselector
23174 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23180 * @addtogroup Calendar
23185 * @enum _Elm_Calendar_Mark_Repeat
23186 * @typedef Elm_Calendar_Mark_Repeat
23188 * Event periodicity, used to define if a mark should be repeated
23189 * @b beyond event's day. It's set when a mark is added.
23191 * So, for a mark added to 13th May with periodicity set to WEEKLY,
23192 * there will be marks every week after this date. Marks will be displayed
23193 * at 13th, 20th, 27th, 3rd June ...
23195 * Values don't work as bitmask, only one can be choosen.
23197 * @see elm_calendar_mark_add()
23199 * @ingroup Calendar
23201 typedef enum _Elm_Calendar_Mark_Repeat
23203 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23204 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23205 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23206 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*/
23207 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. */
23208 } Elm_Calendar_Mark_Repeat;
23210 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(). */
23213 * Add a new calendar widget to the given parent Elementary
23214 * (container) object.
23216 * @param parent The parent object.
23217 * @return a new calendar widget handle or @c NULL, on errors.
23219 * This function inserts a new calendar widget on the canvas.
23221 * @ref calendar_example_01
23223 * @ingroup Calendar
23225 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23228 * Get weekdays names displayed by the calendar.
23230 * @param obj The calendar object.
23231 * @return Array of seven strings to be used as weekday names.
23233 * By default, weekdays abbreviations get from system are displayed:
23234 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23235 * The first string is related to Sunday, the second to Monday...
23237 * @see elm_calendar_weekdays_name_set()
23239 * @ref calendar_example_05
23241 * @ingroup Calendar
23243 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23246 * Set weekdays names to be displayed by the calendar.
23248 * @param obj The calendar object.
23249 * @param weekdays Array of seven strings to be used as weekday names.
23250 * @warning It must have 7 elements, or it will access invalid memory.
23251 * @warning The strings must be NULL terminated ('@\0').
23253 * By default, weekdays abbreviations get from system are displayed:
23254 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23256 * The first string should be related to Sunday, the second to Monday...
23258 * The usage should be like this:
23260 * const char *weekdays[] =
23262 * "Sunday", "Monday", "Tuesday", "Wednesday",
23263 * "Thursday", "Friday", "Saturday"
23265 * elm_calendar_weekdays_names_set(calendar, weekdays);
23268 * @see elm_calendar_weekdays_name_get()
23270 * @ref calendar_example_02
23272 * @ingroup Calendar
23274 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23277 * Set the minimum and maximum values for the year
23279 * @param obj The calendar object
23280 * @param min The minimum year, greater than 1901;
23281 * @param max The maximum year;
23283 * Maximum must be greater than minimum, except if you don't wan't to set
23285 * Default values are 1902 and -1.
23287 * If the maximum year is a negative value, it will be limited depending
23288 * on the platform architecture (year 2037 for 32 bits);
23290 * @see elm_calendar_min_max_year_get()
23292 * @ref calendar_example_03
23294 * @ingroup Calendar
23296 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23299 * Get the minimum and maximum values for the year
23301 * @param obj The calendar object.
23302 * @param min The minimum year.
23303 * @param max The maximum year.
23305 * Default values are 1902 and -1.
23307 * @see elm_calendar_min_max_year_get() for more details.
23309 * @ref calendar_example_05
23311 * @ingroup Calendar
23313 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23316 * Enable or disable day selection
23318 * @param obj The calendar object.
23319 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23322 * Enabled by default. If disabled, the user still can select months,
23323 * but not days. Selected days are highlighted on calendar.
23324 * It should be used if you won't need such selection for the widget usage.
23326 * When a day is selected, or month is changed, smart callbacks for
23327 * signal "changed" will be called.
23329 * @see elm_calendar_day_selection_enable_get()
23331 * @ref calendar_example_04
23333 * @ingroup Calendar
23335 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23338 * Get a value whether day selection is enabled or not.
23340 * @see elm_calendar_day_selection_enable_set() for details.
23342 * @param obj The calendar object.
23343 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23344 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23346 * @ref calendar_example_05
23348 * @ingroup Calendar
23350 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23354 * Set selected date to be highlighted on calendar.
23356 * @param obj The calendar object.
23357 * @param selected_time A @b tm struct to represent the selected date.
23359 * Set the selected date, changing the displayed month if needed.
23360 * Selected date changes when the user goes to next/previous month or
23361 * select a day pressing over it on calendar.
23363 * @see elm_calendar_selected_time_get()
23365 * @ref calendar_example_04
23367 * @ingroup Calendar
23369 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23372 * Get selected date.
23374 * @param obj The calendar object
23375 * @param selected_time A @b tm struct to point to selected date
23376 * @return EINA_FALSE means an error ocurred and returned time shouldn't
23379 * Get date selected by the user or set by function
23380 * elm_calendar_selected_time_set().
23381 * Selected date changes when the user goes to next/previous month or
23382 * select a day pressing over it on calendar.
23384 * @see elm_calendar_selected_time_get()
23386 * @ref calendar_example_05
23388 * @ingroup Calendar
23390 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23393 * Set a function to format the string that will be used to display
23396 * @param obj The calendar object
23397 * @param format_function Function to set the month-year string given
23398 * the selected date
23400 * By default it uses strftime with "%B %Y" format string.
23401 * It should allocate the memory that will be used by the string,
23402 * that will be freed by the widget after usage.
23403 * A pointer to the string and a pointer to the time struct will be provided.
23408 * _format_month_year(struct tm *selected_time)
23411 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23412 * return strdup(buf);
23415 * elm_calendar_format_function_set(calendar, _format_month_year);
23418 * @ref calendar_example_02
23420 * @ingroup Calendar
23422 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23425 * Add a new mark to the calendar
23427 * @param obj The calendar object
23428 * @param mark_type A string used to define the type of mark. It will be
23429 * emitted to the theme, that should display a related modification on these
23430 * days representation.
23431 * @param mark_time A time struct to represent the date of inclusion of the
23432 * mark. For marks that repeats it will just be displayed after the inclusion
23433 * date in the calendar.
23434 * @param repeat Repeat the event following this periodicity. Can be a unique
23435 * mark (that don't repeat), daily, weekly, monthly or annually.
23436 * @return The created mark or @p NULL upon failure.
23438 * Add a mark that will be drawn in the calendar respecting the insertion
23439 * time and periodicity. It will emit the type as signal to the widget theme.
23440 * Default theme supports "holiday" and "checked", but it can be extended.
23442 * It won't immediately update the calendar, drawing the marks.
23443 * For this, call elm_calendar_marks_draw(). However, when user selects
23444 * next or previous month calendar forces marks drawn.
23446 * Marks created with this method can be deleted with
23447 * elm_calendar_mark_del().
23451 * struct tm selected_time;
23452 * time_t current_time;
23454 * current_time = time(NULL) + 5 * 84600;
23455 * localtime_r(¤t_time, &selected_time);
23456 * elm_calendar_mark_add(cal, "holiday", selected_time,
23457 * ELM_CALENDAR_ANNUALLY);
23459 * current_time = time(NULL) + 1 * 84600;
23460 * localtime_r(¤t_time, &selected_time);
23461 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23463 * elm_calendar_marks_draw(cal);
23466 * @see elm_calendar_marks_draw()
23467 * @see elm_calendar_mark_del()
23469 * @ref calendar_example_06
23471 * @ingroup Calendar
23473 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);
23476 * Delete mark from the calendar.
23478 * @param mark The mark to be deleted.
23480 * If deleting all calendar marks is required, elm_calendar_marks_clear()
23481 * should be used instead of getting marks list and deleting each one.
23483 * @see elm_calendar_mark_add()
23485 * @ref calendar_example_06
23487 * @ingroup Calendar
23489 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23492 * Remove all calendar's marks
23494 * @param obj The calendar object.
23496 * @see elm_calendar_mark_add()
23497 * @see elm_calendar_mark_del()
23499 * @ingroup Calendar
23501 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23505 * Get a list of all the calendar marks.
23507 * @param obj The calendar object.
23508 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23510 * @see elm_calendar_mark_add()
23511 * @see elm_calendar_mark_del()
23512 * @see elm_calendar_marks_clear()
23514 * @ingroup Calendar
23516 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23519 * Draw calendar marks.
23521 * @param obj The calendar object.
23523 * Should be used after adding, removing or clearing marks.
23524 * It will go through the entire marks list updating the calendar.
23525 * If lots of marks will be added, add all the marks and then call
23528 * When the month is changed, i.e. user selects next or previous month,
23529 * marks will be drawed.
23531 * @see elm_calendar_mark_add()
23532 * @see elm_calendar_mark_del()
23533 * @see elm_calendar_marks_clear()
23535 * @ref calendar_example_06
23537 * @ingroup Calendar
23539 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23542 * Set a day text color to the same that represents Saturdays.
23544 * @param obj The calendar object.
23545 * @param pos The text position. Position is the cell counter, from left
23546 * to right, up to down. It starts on 0 and ends on 41.
23548 * @deprecated use elm_calendar_mark_add() instead like:
23551 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23552 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23555 * @see elm_calendar_mark_add()
23557 * @ingroup Calendar
23559 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23562 * Set a day text color to the same that represents Sundays.
23564 * @param obj The calendar object.
23565 * @param pos The text position. Position is the cell counter, from left
23566 * to right, up to down. It starts on 0 and ends on 41.
23568 * @deprecated use elm_calendar_mark_add() instead like:
23571 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23572 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23575 * @see elm_calendar_mark_add()
23577 * @ingroup Calendar
23579 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23582 * Set a day text color to the same that represents Weekdays.
23584 * @param obj The calendar object
23585 * @param pos The text position. Position is the cell counter, from left
23586 * to right, up to down. It starts on 0 and ends on 41.
23588 * @deprecated use elm_calendar_mark_add() instead like:
23591 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23593 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23594 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23595 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23596 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23597 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23598 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23599 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23600 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23601 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23604 * @see elm_calendar_mark_add()
23606 * @ingroup Calendar
23608 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23611 * Set the interval on time updates for an user mouse button hold
23612 * on calendar widgets' month selection.
23614 * @param obj The calendar object
23615 * @param interval The (first) interval value in seconds
23617 * This interval value is @b decreased while the user holds the
23618 * mouse pointer either selecting next or previous month.
23620 * This helps the user to get to a given month distant from the
23621 * current one easier/faster, as it will start to change quicker and
23622 * quicker on mouse button holds.
23624 * The calculation for the next change interval value, starting from
23625 * the one set with this call, is the previous interval divided by
23626 * 1.05, so it decreases a little bit.
23628 * The default starting interval value for automatic changes is
23631 * @see elm_calendar_interval_get()
23633 * @ingroup Calendar
23635 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23638 * Get the interval on time updates for an user mouse button hold
23639 * on calendar widgets' month selection.
23641 * @param obj The calendar object
23642 * @return The (first) interval value, in seconds, set on it
23644 * @see elm_calendar_interval_set() for more details
23646 * @ingroup Calendar
23648 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23655 * @defgroup Diskselector Diskselector
23656 * @ingroup Elementary
23658 * @image html img/widget/diskselector/preview-00.png
23659 * @image latex img/widget/diskselector/preview-00.eps
23661 * A diskselector is a kind of list widget. It scrolls horizontally,
23662 * and can contain label and icon objects. Three items are displayed
23663 * with the selected one in the middle.
23665 * It can act like a circular list with round mode and labels can be
23666 * reduced for a defined length for side items.
23668 * Smart callbacks one can listen to:
23669 * - "selected" - when item is selected, i.e. scroller stops.
23671 * Available styles for it:
23674 * List of examples:
23675 * @li @ref diskselector_example_01
23676 * @li @ref diskselector_example_02
23680 * @addtogroup Diskselector
23684 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(). */
23687 * Add a new diskselector widget to the given parent Elementary
23688 * (container) object.
23690 * @param parent The parent object.
23691 * @return a new diskselector widget handle or @c NULL, on errors.
23693 * This function inserts a new diskselector widget on the canvas.
23695 * @ingroup Diskselector
23697 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23700 * Enable or disable round mode.
23702 * @param obj The diskselector object.
23703 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23706 * Disabled by default. If round mode is enabled the items list will
23707 * work like a circle list, so when the user reaches the last item,
23708 * the first one will popup.
23710 * @see elm_diskselector_round_get()
23712 * @ingroup Diskselector
23714 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23717 * Get a value whether round mode is enabled or not.
23719 * @see elm_diskselector_round_set() for details.
23721 * @param obj The diskselector object.
23722 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23723 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23725 * @ingroup Diskselector
23727 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23730 * Get the side labels max length.
23732 * @deprecated use elm_diskselector_side_label_length_get() instead:
23734 * @param obj The diskselector object.
23735 * @return The max length defined for side labels, or 0 if not a valid
23738 * @ingroup Diskselector
23740 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23743 * Set the side labels max length.
23745 * @deprecated use elm_diskselector_side_label_length_set() instead:
23747 * @param obj The diskselector object.
23748 * @param len The max length defined for side labels.
23750 * @ingroup Diskselector
23752 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23755 * Get the side labels max length.
23757 * @see elm_diskselector_side_label_length_set() for details.
23759 * @param obj The diskselector object.
23760 * @return The max length defined for side labels, or 0 if not a valid
23763 * @ingroup Diskselector
23765 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23768 * Set the side labels max length.
23770 * @param obj The diskselector object.
23771 * @param len The max length defined for side labels.
23773 * Length is the number of characters of items' label that will be
23774 * visible when it's set on side positions. It will just crop
23775 * the string after defined size. E.g.:
23777 * An item with label "January" would be displayed on side position as
23778 * "Jan" if max length is set to 3, or "Janu", if this property
23781 * When it's selected, the entire label will be displayed, except for
23782 * width restrictions. In this case label will be cropped and "..."
23783 * will be concatenated.
23785 * Default side label max length is 3.
23787 * This property will be applyed over all items, included before or
23788 * later this function call.
23790 * @ingroup Diskselector
23792 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23795 * Set the number of items to be displayed.
23797 * @param obj The diskselector object.
23798 * @param num The number of items the diskselector will display.
23800 * Default value is 3, and also it's the minimun. If @p num is less
23801 * than 3, it will be set to 3.
23803 * Also, it can be set on theme, using data item @c display_item_num
23804 * on group "elm/diskselector/item/X", where X is style set.
23807 * group { name: "elm/diskselector/item/X";
23809 * item: "display_item_num" "5";
23812 * @ingroup Diskselector
23814 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
23817 * Set bouncing behaviour when the scrolled content reaches an edge.
23819 * Tell the internal scroller object whether it should bounce or not
23820 * when it reaches the respective edges for each axis.
23822 * @param obj The diskselector object.
23823 * @param h_bounce Whether to bounce or not in the horizontal axis.
23824 * @param v_bounce Whether to bounce or not in the vertical axis.
23826 * @see elm_scroller_bounce_set()
23828 * @ingroup Diskselector
23830 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23833 * Get the bouncing behaviour of the internal scroller.
23835 * Get whether the internal scroller should bounce when the edge of each
23836 * axis is reached scrolling.
23838 * @param obj The diskselector object.
23839 * @param h_bounce Pointer where to store the bounce state of the horizontal
23841 * @param v_bounce Pointer where to store the bounce state of the vertical
23844 * @see elm_scroller_bounce_get()
23845 * @see elm_diskselector_bounce_set()
23847 * @ingroup Diskselector
23849 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23852 * Get the scrollbar policy.
23854 * @see elm_diskselector_scroller_policy_get() for details.
23856 * @param obj The diskselector object.
23857 * @param policy_h Pointer where to store horizontal scrollbar policy.
23858 * @param policy_v Pointer where to store vertical scrollbar policy.
23860 * @ingroup Diskselector
23862 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);
23865 * Set the scrollbar policy.
23867 * @param obj The diskselector object.
23868 * @param policy_h Horizontal scrollbar policy.
23869 * @param policy_v Vertical scrollbar policy.
23871 * This sets the scrollbar visibility policy for the given scroller.
23872 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
23873 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
23874 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
23875 * This applies respectively for the horizontal and vertical scrollbars.
23877 * The both are disabled by default, i.e., are set to
23878 * #ELM_SCROLLER_POLICY_OFF.
23880 * @ingroup Diskselector
23882 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
23885 * Remove all diskselector's items.
23887 * @param obj The diskselector object.
23889 * @see elm_diskselector_item_del()
23890 * @see elm_diskselector_item_append()
23892 * @ingroup Diskselector
23894 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23897 * Get a list of all the diskselector items.
23899 * @param obj The diskselector object.
23900 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
23901 * or @c NULL on failure.
23903 * @see elm_diskselector_item_append()
23904 * @see elm_diskselector_item_del()
23905 * @see elm_diskselector_clear()
23907 * @ingroup Diskselector
23909 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23912 * Appends a new item to the diskselector object.
23914 * @param obj The diskselector object.
23915 * @param label The label of the diskselector item.
23916 * @param icon The icon object to use at left side of the item. An
23917 * icon can be any Evas object, but usually it is an icon created
23918 * with elm_icon_add().
23919 * @param func The function to call when the item is selected.
23920 * @param data The data to associate with the item for related callbacks.
23922 * @return The created item or @c NULL upon failure.
23924 * A new item will be created and appended to the diskselector, i.e., will
23925 * be set as last item. Also, if there is no selected item, it will
23926 * be selected. This will always happens for the first appended item.
23928 * If no icon is set, label will be centered on item position, otherwise
23929 * the icon will be placed at left of the label, that will be shifted
23932 * Items created with this method can be deleted with
23933 * elm_diskselector_item_del().
23935 * Associated @p data can be properly freed when item is deleted if a
23936 * callback function is set with elm_diskselector_item_del_cb_set().
23938 * If a function is passed as argument, it will be called everytime this item
23939 * is selected, i.e., the user stops the diskselector with this
23940 * item on center position. If such function isn't needed, just passing
23941 * @c NULL as @p func is enough. The same should be done for @p data.
23943 * Simple example (with no function callback or data associated):
23945 * disk = elm_diskselector_add(win);
23946 * ic = elm_icon_add(win);
23947 * elm_icon_file_set(ic, "path/to/image", NULL);
23948 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23949 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
23952 * @see elm_diskselector_item_del()
23953 * @see elm_diskselector_item_del_cb_set()
23954 * @see elm_diskselector_clear()
23955 * @see elm_icon_add()
23957 * @ingroup Diskselector
23959 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);
23963 * Delete them item from the diskselector.
23965 * @param it The item of diskselector to be deleted.
23967 * If deleting all diskselector items is required, elm_diskselector_clear()
23968 * should be used instead of getting items list and deleting each one.
23970 * @see elm_diskselector_clear()
23971 * @see elm_diskselector_item_append()
23972 * @see elm_diskselector_item_del_cb_set()
23974 * @ingroup Diskselector
23976 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
23979 * Set the function called when a diskselector item is freed.
23981 * @param it The item to set the callback on
23982 * @param func The function called
23984 * If there is a @p func, then it will be called prior item's memory release.
23985 * That will be called with the following arguments:
23987 * @li item's Evas object;
23990 * This way, a data associated to a diskselector item could be properly
23993 * @ingroup Diskselector
23995 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23998 * Get the data associated to the item.
24000 * @param it The diskselector item
24001 * @return The data associated to @p it
24003 * The return value is a pointer to data associated to @p item when it was
24004 * created, with function elm_diskselector_item_append(). If no data
24005 * was passed as argument, it will return @c NULL.
24007 * @see elm_diskselector_item_append()
24009 * @ingroup Diskselector
24011 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24014 * Set the icon associated to the item.
24016 * @param it The diskselector item
24017 * @param icon The icon object to associate with @p it
24019 * The icon object to use at left side of the item. An
24020 * icon can be any Evas object, but usually it is an icon created
24021 * with elm_icon_add().
24023 * Once the icon object is set, a previously set one will be deleted.
24024 * @warning Setting the same icon for two items will cause the icon to
24025 * dissapear from the first item.
24027 * If an icon was passed as argument on item creation, with function
24028 * elm_diskselector_item_append(), it will be already
24029 * associated to the item.
24031 * @see elm_diskselector_item_append()
24032 * @see elm_diskselector_item_icon_get()
24034 * @ingroup Diskselector
24036 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24039 * Get the icon associated to the item.
24041 * @param it The diskselector item
24042 * @return The icon associated to @p it
24044 * The return value is a pointer to the icon associated to @p item when it was
24045 * created, with function elm_diskselector_item_append(), or later
24046 * with function elm_diskselector_item_icon_set. If no icon
24047 * was passed as argument, it will return @c NULL.
24049 * @see elm_diskselector_item_append()
24050 * @see elm_diskselector_item_icon_set()
24052 * @ingroup Diskselector
24054 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24057 * Set the label of item.
24059 * @param it The item of diskselector.
24060 * @param label The label of item.
24062 * The label to be displayed by the item.
24064 * If no icon is set, label will be centered on item position, otherwise
24065 * the icon will be placed at left of the label, that will be shifted
24068 * An item with label "January" would be displayed on side position as
24069 * "Jan" if max length is set to 3 with function
24070 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24073 * When this @p item is selected, the entire label will be displayed,
24074 * except for width restrictions.
24075 * In this case label will be cropped and "..." will be concatenated,
24076 * but only for display purposes. It will keep the entire string, so
24077 * if diskselector is resized the remaining characters will be displayed.
24079 * If a label was passed as argument on item creation, with function
24080 * elm_diskselector_item_append(), it will be already
24081 * displayed by the item.
24083 * @see elm_diskselector_side_label_lenght_set()
24084 * @see elm_diskselector_item_label_get()
24085 * @see elm_diskselector_item_append()
24087 * @ingroup Diskselector
24089 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24092 * Get the label of item.
24094 * @param it The item of diskselector.
24095 * @return The label of item.
24097 * The return value is a pointer to the label associated to @p item when it was
24098 * created, with function elm_diskselector_item_append(), or later
24099 * with function elm_diskselector_item_label_set. If no label
24100 * was passed as argument, it will return @c NULL.
24102 * @see elm_diskselector_item_label_set() for more details.
24103 * @see elm_diskselector_item_append()
24105 * @ingroup Diskselector
24107 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24110 * Get the selected item.
24112 * @param obj The diskselector object.
24113 * @return The selected diskselector item.
24115 * The selected item can be unselected with function
24116 * elm_diskselector_item_selected_set(), and the first item of
24117 * diskselector will be selected.
24119 * The selected item always will be centered on diskselector, with
24120 * full label displayed, i.e., max lenght set to side labels won't
24121 * apply on the selected item. More details on
24122 * elm_diskselector_side_label_length_set().
24124 * @ingroup Diskselector
24126 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24129 * Set the selected state of an item.
24131 * @param it The diskselector item
24132 * @param selected The selected state
24134 * This sets the selected state of the given item @p it.
24135 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24137 * If a new item is selected the previosly selected will be unselected.
24138 * Previoulsy selected item can be get with function
24139 * elm_diskselector_selected_item_get().
24141 * If the item @p it is unselected, the first item of diskselector will
24144 * Selected items will be visible on center position of diskselector.
24145 * So if it was on another position before selected, or was invisible,
24146 * diskselector will animate items until the selected item reaches center
24149 * @see elm_diskselector_item_selected_get()
24150 * @see elm_diskselector_selected_item_get()
24152 * @ingroup Diskselector
24154 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24157 * Get whether the @p item is selected or not.
24159 * @param it The diskselector item.
24160 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24161 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24163 * @see elm_diskselector_selected_item_set() for details.
24164 * @see elm_diskselector_item_selected_get()
24166 * @ingroup Diskselector
24168 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24171 * Get the first item of the diskselector.
24173 * @param obj The diskselector object.
24174 * @return The first item, or @c NULL if none.
24176 * The list of items follows append order. So it will return the first
24177 * item appended to the widget that wasn't deleted.
24179 * @see elm_diskselector_item_append()
24180 * @see elm_diskselector_items_get()
24182 * @ingroup Diskselector
24184 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24187 * Get the last item of the diskselector.
24189 * @param obj The diskselector object.
24190 * @return The last item, or @c NULL if none.
24192 * The list of items follows append order. So it will return last first
24193 * item appended to the widget that wasn't deleted.
24195 * @see elm_diskselector_item_append()
24196 * @see elm_diskselector_items_get()
24198 * @ingroup Diskselector
24200 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24203 * Get the item before @p item in diskselector.
24205 * @param it The diskselector item.
24206 * @return The item before @p item, or @c NULL if none or on failure.
24208 * The list of items follows append order. So it will return item appended
24209 * just before @p item and that wasn't deleted.
24211 * If it is the first item, @c NULL will be returned.
24212 * First item can be get by elm_diskselector_first_item_get().
24214 * @see elm_diskselector_item_append()
24215 * @see elm_diskselector_items_get()
24217 * @ingroup Diskselector
24219 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24222 * Get the item after @p item in diskselector.
24224 * @param it The diskselector item.
24225 * @return The item after @p item, or @c NULL if none or on failure.
24227 * The list of items follows append order. So it will return item appended
24228 * just after @p item and that wasn't deleted.
24230 * If it is the last item, @c NULL will be returned.
24231 * Last item can be get by elm_diskselector_last_item_get().
24233 * @see elm_diskselector_item_append()
24234 * @see elm_diskselector_items_get()
24236 * @ingroup Diskselector
24238 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24241 * Set the text to be shown in the diskselector item.
24243 * @param item Target item
24244 * @param text The text to set in the content
24246 * Setup the text as tooltip to object. The item can have only one tooltip,
24247 * so any previous tooltip data is removed.
24249 * @see elm_object_tooltip_text_set() for more details.
24251 * @ingroup Diskselector
24253 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24256 * Set the content to be shown in the tooltip item.
24258 * Setup the tooltip to item. The item can have only one tooltip,
24259 * so any previous tooltip data is removed. @p func(with @p data) will
24260 * be called every time that need show the tooltip and it should
24261 * return a valid Evas_Object. This object is then managed fully by
24262 * tooltip system and is deleted when the tooltip is gone.
24264 * @param item the diskselector item being attached a tooltip.
24265 * @param func the function used to create the tooltip contents.
24266 * @param data what to provide to @a func as callback data/context.
24267 * @param del_cb called when data is not needed anymore, either when
24268 * another callback replaces @p func, the tooltip is unset with
24269 * elm_diskselector_item_tooltip_unset() or the owner @a item
24270 * dies. This callback receives as the first parameter the
24271 * given @a data, and @c event_info is the item.
24273 * @see elm_object_tooltip_content_cb_set() for more details.
24275 * @ingroup Diskselector
24277 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);
24280 * Unset tooltip from item.
24282 * @param item diskselector item to remove previously set tooltip.
24284 * Remove tooltip from item. The callback provided as del_cb to
24285 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24286 * it is not used anymore.
24288 * @see elm_object_tooltip_unset() for more details.
24289 * @see elm_diskselector_item_tooltip_content_cb_set()
24291 * @ingroup Diskselector
24293 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24297 * Sets a different style for this item tooltip.
24299 * @note before you set a style you should define a tooltip with
24300 * elm_diskselector_item_tooltip_content_cb_set() or
24301 * elm_diskselector_item_tooltip_text_set()
24303 * @param item diskselector item with tooltip already set.
24304 * @param style the theme style to use (default, transparent, ...)
24306 * @see elm_object_tooltip_style_set() for more details.
24308 * @ingroup Diskselector
24310 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24313 * Get the style for this item tooltip.
24315 * @param item diskselector item with tooltip already set.
24316 * @return style the theme style in use, defaults to "default". If the
24317 * object does not have a tooltip set, then NULL is returned.
24319 * @see elm_object_tooltip_style_get() for more details.
24320 * @see elm_diskselector_item_tooltip_style_set()
24322 * @ingroup Diskselector
24324 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24327 * Set the cursor to be shown when mouse is over the diskselector item
24329 * @param item Target item
24330 * @param cursor the cursor name to be used.
24332 * @see elm_object_cursor_set() for more details.
24334 * @ingroup Diskselector
24336 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24339 * Get the cursor to be shown when mouse is over the diskselector item
24341 * @param item diskselector item with cursor already set.
24342 * @return the cursor name.
24344 * @see elm_object_cursor_get() for more details.
24345 * @see elm_diskselector_cursor_set()
24347 * @ingroup Diskselector
24349 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24353 * Unset the cursor to be shown when mouse is over the diskselector item
24355 * @param item Target item
24357 * @see elm_object_cursor_unset() for more details.
24358 * @see elm_diskselector_cursor_set()
24360 * @ingroup Diskselector
24362 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24365 * Sets a different style for this item cursor.
24367 * @note before you set a style you should define a cursor with
24368 * elm_diskselector_item_cursor_set()
24370 * @param item diskselector item with cursor already set.
24371 * @param style the theme style to use (default, transparent, ...)
24373 * @see elm_object_cursor_style_set() for more details.
24375 * @ingroup Diskselector
24377 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24381 * Get the style for this item cursor.
24383 * @param item diskselector item with cursor already set.
24384 * @return style the theme style in use, defaults to "default". If the
24385 * object does not have a cursor set, then @c NULL is returned.
24387 * @see elm_object_cursor_style_get() for more details.
24388 * @see elm_diskselector_item_cursor_style_set()
24390 * @ingroup Diskselector
24392 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24396 * Set if the cursor set should be searched on the theme or should use
24397 * the provided by the engine, only.
24399 * @note before you set if should look on theme you should define a cursor
24400 * with elm_diskselector_item_cursor_set().
24401 * By default it will only look for cursors provided by the engine.
24403 * @param item widget item with cursor already set.
24404 * @param engine_only boolean to define if cursors set with
24405 * elm_diskselector_item_cursor_set() should be searched only
24406 * between cursors provided by the engine or searched on widget's
24409 * @see elm_object_cursor_engine_only_set() for more details.
24411 * @ingroup Diskselector
24413 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24416 * Get the cursor engine only usage for this item cursor.
24418 * @param item widget item with cursor already set.
24419 * @return engine_only boolean to define it cursors should be looked only
24420 * between the provided by the engine or searched on widget's theme as well.
24421 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24423 * @see elm_object_cursor_engine_only_get() for more details.
24424 * @see elm_diskselector_item_cursor_engine_only_set()
24426 * @ingroup Diskselector
24428 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24435 * @defgroup Colorselector Colorselector
24439 * @image html img/widget/colorselector/preview-00.png
24440 * @image latex img/widget/colorselector/preview-00.eps
24442 * @brief Widget for user to select a color.
24444 * Signals that you can add callbacks for are:
24445 * "changed" - When the color value changes(event_info is NULL).
24447 * See @ref tutorial_colorselector.
24450 * @brief Add a new colorselector to the parent
24452 * @param parent The parent object
24453 * @return The new object or NULL if it cannot be created
24455 * @ingroup Colorselector
24457 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24459 * Set a color for the colorselector
24461 * @param obj Colorselector object
24462 * @param r r-value of color
24463 * @param g g-value of color
24464 * @param b b-value of color
24465 * @param a a-value of color
24467 * @ingroup Colorselector
24469 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24471 * Get a color from the colorselector
24473 * @param obj Colorselector object
24474 * @param r integer pointer for r-value of color
24475 * @param g integer pointer for g-value of color
24476 * @param b integer pointer for b-value of color
24477 * @param a integer pointer for a-value of color
24479 * @ingroup Colorselector
24481 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24487 * @defgroup Ctxpopup Ctxpopup
24489 * @image html img/widget/ctxpopup/preview-00.png
24490 * @image latex img/widget/ctxpopup/preview-00.eps
24492 * @brief Context popup widet.
24494 * A ctxpopup is a widget that, when shown, pops up a list of items.
24495 * It automatically chooses an area inside its parent object's view
24496 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24497 * optimally fit into it. In the default theme, it will also point an
24498 * arrow to it's top left position at the time one shows it. Ctxpopup
24499 * items have a label and/or an icon. It is intended for a small
24500 * number of items (hence the use of list, not genlist).
24502 * @note Ctxpopup is a especialization of @ref Hover.
24504 * Signals that you can add callbacks for are:
24505 * "dismissed" - the ctxpopup was dismissed
24507 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24510 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
24512 typedef enum _Elm_Ctxpopup_Direction
24514 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24516 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24517 the clicked area */
24518 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24519 the clicked area */
24520 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24522 } Elm_Ctxpopup_Direction;
24525 * @brief Add a new Ctxpopup object to the parent.
24527 * @param parent Parent object
24528 * @return New object or @c NULL, if it cannot be created
24530 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24532 * @brief Set the Ctxpopup's parent
24534 * @param obj The ctxpopup object
24535 * @param area The parent to use
24537 * Set the parent object.
24539 * @note elm_ctxpopup_add() will automatically call this function
24540 * with its @c parent argument.
24542 * @see elm_ctxpopup_add()
24543 * @see elm_hover_parent_set()
24545 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24547 * @brief Get the Ctxpopup's parent
24549 * @param obj The ctxpopup object
24551 * @see elm_ctxpopup_hover_parent_set() for more information
24553 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24555 * @brief Clear all items in the given ctxpopup object.
24557 * @param obj Ctxpopup object
24559 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24561 * @brief Change the ctxpopup's orientation to horizontal or vertical.
24563 * @param obj Ctxpopup object
24564 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24566 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24568 * @brief Get the value of current ctxpopup object's orientation.
24570 * @param obj Ctxpopup object
24571 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24573 * @see elm_ctxpopup_horizontal_set()
24575 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24577 * @brief Add a new item to a ctxpopup object.
24579 * @param obj Ctxpopup object
24580 * @param icon Icon to be set on new item
24581 * @param label The Label of the new item
24582 * @param func Convenience function called when item selected
24583 * @param data Data passed to @p func
24584 * @return A handle to the item added or @c NULL, on errors
24586 * @warning Ctxpopup can't hold both an item list and a content at the same
24587 * time. When an item is added, any previous content will be removed.
24589 * @see elm_ctxpopup_content_set()
24591 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);
24593 * @brief Delete the given item in a ctxpopup object.
24595 * @param item Ctxpopup item to be deleted
24597 * @see elm_ctxpopup_item_append()
24599 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
24601 * @brief Set the ctxpopup item's state as disabled or enabled.
24603 * @param item Ctxpopup item to be enabled/disabled
24604 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24606 * When disabled the item is greyed out to indicate it's state.
24608 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24610 * @brief Get the ctxpopup item's disabled/enabled state.
24612 * @param item Ctxpopup item to be enabled/disabled
24613 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24615 * @see elm_ctxpopup_item_disabled_set()
24617 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24619 * @brief Get the icon object for the given ctxpopup item.
24621 * @param item Ctxpopup item
24622 * @return icon object or @c NULL, if the item does not have icon or an error
24625 * @see elm_ctxpopup_item_append()
24626 * @see elm_ctxpopup_item_icon_set()
24628 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24630 * @brief Sets the side icon associated with the ctxpopup item
24632 * @param item Ctxpopup item
24633 * @param icon Icon object to be set
24635 * Once the icon object is set, a previously set one will be deleted.
24636 * @warning Setting the same icon for two items will cause the icon to
24637 * dissapear from the first item.
24639 * @see elm_ctxpopup_item_append()
24641 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24643 * @brief Get the label for the given ctxpopup item.
24645 * @param item Ctxpopup item
24646 * @return label string or @c NULL, if the item does not have label or an
24649 * @see elm_ctxpopup_item_append()
24650 * @see elm_ctxpopup_item_label_set()
24652 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24654 * @brief (Re)set the label on the given ctxpopup item.
24656 * @param item Ctxpopup item
24657 * @param label String to set as label
24659 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
24661 * @brief Set an elm widget as the content of the ctxpopup.
24663 * @param obj Ctxpopup object
24664 * @param content Content to be swallowed
24666 * If the content object is already set, a previous one will bedeleted. If
24667 * you want to keep that old content object, use the
24668 * elm_ctxpopup_content_unset() function.
24670 * @deprecated use elm_object_content_set()
24672 * @warning Ctxpopup can't hold both a item list and a content at the same
24673 * time. When a content is set, any previous items will be removed.
24675 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24677 * @brief Unset the ctxpopup content
24679 * @param obj Ctxpopup object
24680 * @return The content that was being used
24682 * Unparent and return the content object which was set for this widget.
24684 * @deprecated use elm_object_content_unset()
24686 * @see elm_ctxpopup_content_set()
24688 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24690 * @brief Set the direction priority of a ctxpopup.
24692 * @param obj Ctxpopup object
24693 * @param first 1st priority of direction
24694 * @param second 2nd priority of direction
24695 * @param third 3th priority of direction
24696 * @param fourth 4th priority of direction
24698 * This functions gives a chance to user to set the priority of ctxpopup
24699 * showing direction. This doesn't guarantee the ctxpopup will appear in the
24700 * requested direction.
24702 * @see Elm_Ctxpopup_Direction
24704 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);
24706 * @brief Get the direction priority of a ctxpopup.
24708 * @param obj Ctxpopup object
24709 * @param first 1st priority of direction to be returned
24710 * @param second 2nd priority of direction to be returned
24711 * @param third 3th priority of direction to be returned
24712 * @param fourth 4th priority of direction to be returned
24714 * @see elm_ctxpopup_direction_priority_set() for more information.
24716 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);
24724 * @defgroup Transit Transit
24725 * @ingroup Elementary
24727 * Transit is designed to apply various animated transition effects to @c
24728 * Evas_Object, such like translation, rotation, etc. For using these
24729 * effects, create an @ref Elm_Transit and add the desired transition effects.
24731 * Once the effects are added into transit, they will be automatically
24732 * managed (their callback will be called until the duration is ended, and
24733 * they will be deleted on completion).
24737 * Elm_Transit *trans = elm_transit_add();
24738 * elm_transit_object_add(trans, obj);
24739 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24740 * elm_transit_duration_set(transit, 1);
24741 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24742 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24743 * elm_transit_repeat_times_set(transit, 3);
24746 * Some transition effects are used to change the properties of objects. They
24748 * @li @ref elm_transit_effect_translation_add
24749 * @li @ref elm_transit_effect_color_add
24750 * @li @ref elm_transit_effect_rotation_add
24751 * @li @ref elm_transit_effect_wipe_add
24752 * @li @ref elm_transit_effect_zoom_add
24753 * @li @ref elm_transit_effect_resizing_add
24755 * Other transition effects are used to make one object disappear and another
24756 * object appear on its old place. These effects are:
24758 * @li @ref elm_transit_effect_flip_add
24759 * @li @ref elm_transit_effect_resizable_flip_add
24760 * @li @ref elm_transit_effect_fade_add
24761 * @li @ref elm_transit_effect_blend_add
24763 * It's also possible to make a transition chain with @ref
24764 * elm_transit_chain_transit_add.
24766 * @warning We strongly recommend to use elm_transit just when edje can not do
24767 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24768 * animations can be manipulated inside the theme.
24770 * List of examples:
24771 * @li @ref transit_example_01_explained
24772 * @li @ref transit_example_02_explained
24773 * @li @ref transit_example_03_c
24774 * @li @ref transit_example_04_c
24780 * @enum Elm_Transit_Tween_Mode
24782 * The type of acceleration used in the transition.
24786 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24787 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24788 over time, then decrease again
24790 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24792 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24794 } Elm_Transit_Tween_Mode;
24797 * @enum Elm_Transit_Effect_Flip_Axis
24799 * The axis where flip effect should be applied.
24803 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
24804 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
24805 } Elm_Transit_Effect_Flip_Axis;
24807 * @enum Elm_Transit_Effect_Wipe_Dir
24809 * The direction where the wipe effect should occur.
24813 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
24814 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
24815 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
24816 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
24817 } Elm_Transit_Effect_Wipe_Dir;
24818 /** @enum Elm_Transit_Effect_Wipe_Type
24820 * Whether the wipe effect should show or hide the object.
24824 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
24826 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
24828 } Elm_Transit_Effect_Wipe_Type;
24831 * @typedef Elm_Transit
24833 * The Transit created with elm_transit_add(). This type has the information
24834 * about the objects which the transition will be applied, and the
24835 * transition effects that will be used. It also contains info about
24836 * duration, number of repetitions, auto-reverse, etc.
24838 typedef struct _Elm_Transit Elm_Transit;
24839 typedef void Elm_Transit_Effect;
24841 * @typedef Elm_Transit_Effect_Transition_Cb
24843 * Transition callback called for this effect on each transition iteration.
24845 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
24847 * Elm_Transit_Effect_End_Cb
24849 * Transition callback called for this effect when the transition is over.
24851 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
24854 * Elm_Transit_Del_Cb
24856 * A callback called when the transit is deleted.
24858 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
24863 * @note Is not necessary to delete the transit object, it will be deleted at
24864 * the end of its operation.
24865 * @note The transit will start playing when the program enter in the main loop, is not
24866 * necessary to give a start to the transit.
24868 * @return The transit object.
24872 EAPI Elm_Transit *elm_transit_add(void);
24875 * Stops the animation and delete the @p transit object.
24877 * Call this function if you wants to stop the animation before the duration
24878 * time. Make sure the @p transit object is still alive with
24879 * elm_transit_del_cb_set() function.
24880 * All added effects will be deleted, calling its repective data_free_cb
24881 * functions. The function setted by elm_transit_del_cb_set() will be called.
24883 * @see elm_transit_del_cb_set()
24885 * @param transit The transit object to be deleted.
24888 * @warning Just call this function if you are sure the transit is alive.
24890 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
24893 * Add a new effect to the transit.
24895 * @note The cb function and the data are the key to the effect. If you try to
24896 * add an already added effect, nothing is done.
24897 * @note After the first addition of an effect in @p transit, if its
24898 * effect list become empty again, the @p transit will be killed by
24899 * elm_transit_del(transit) function.
24903 * Elm_Transit *transit = elm_transit_add();
24904 * elm_transit_effect_add(transit,
24905 * elm_transit_effect_blend_op,
24906 * elm_transit_effect_blend_context_new(),
24907 * elm_transit_effect_blend_context_free);
24910 * @param transit The transit object.
24911 * @param transition_cb The operation function. It is called when the
24912 * animation begins, it is the function that actually performs the animation.
24913 * It is called with the @p data, @p transit and the time progression of the
24914 * animation (a double value between 0.0 and 1.0).
24915 * @param effect The context data of the effect.
24916 * @param end_cb The function to free the context data, it will be called
24917 * at the end of the effect, it must finalize the animation and free the
24921 * @warning The transit free the context data at the and of the transition with
24922 * the data_free_cb function, do not use the context data in another transit.
24924 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);
24927 * Delete an added effect.
24929 * This function will remove the effect from the @p transit, calling the
24930 * data_free_cb to free the @p data.
24932 * @see elm_transit_effect_add()
24934 * @note If the effect is not found, nothing is done.
24935 * @note If the effect list become empty, this function will call
24936 * elm_transit_del(transit), that is, it will kill the @p transit.
24938 * @param transit The transit object.
24939 * @param transition_cb The operation function.
24940 * @param effect The context data of the effect.
24944 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);
24947 * Add new object to apply the effects.
24949 * @note After the first addition of an object in @p transit, if its
24950 * object list become empty again, the @p transit will be killed by
24951 * elm_transit_del(transit) function.
24952 * @note If the @p obj belongs to another transit, the @p obj will be
24953 * removed from it and it will only belong to the @p transit. If the old
24954 * transit stays without objects, it will die.
24955 * @note When you add an object into the @p transit, its state from
24956 * evas_object_pass_events_get(obj) is saved, and it is applied when the
24957 * transit ends, if you change this state whith evas_object_pass_events_set()
24958 * after add the object, this state will change again when @p transit stops to
24961 * @param transit The transit object.
24962 * @param obj Object to be animated.
24965 * @warning It is not allowed to add a new object after transit begins to go.
24967 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
24970 * Removes an added object from the transit.
24972 * @note If the @p obj is not in the @p transit, nothing is done.
24973 * @note If the list become empty, this function will call
24974 * elm_transit_del(transit), that is, it will kill the @p transit.
24976 * @param transit The transit object.
24977 * @param obj Object to be removed from @p transit.
24980 * @warning It is not allowed to remove objects after transit begins to go.
24982 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
24985 * Get the objects of the transit.
24987 * @param transit The transit object.
24988 * @return a Eina_List with the objects from the transit.
24992 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
24995 * Enable/disable keeping up the objects states.
24996 * If it is not kept, the objects states will be reset when transition ends.
24998 * @note @p transit can not be NULL.
24999 * @note One state includes geometry, color, map data.
25001 * @param transit The transit object.
25002 * @param state_keep Keeping or Non Keeping.
25006 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25009 * Get a value whether the objects states will be reset or not.
25011 * @note @p transit can not be NULL
25013 * @see elm_transit_objects_final_state_keep_set()
25015 * @param transit The transit object.
25016 * @return EINA_TRUE means the states of the objects will be reset.
25017 * If @p transit is NULL, EINA_FALSE is returned
25021 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25024 * Set the event enabled when transit is operating.
25026 * If @p enabled is EINA_TRUE, the objects of the transit will receives
25027 * events from mouse and keyboard during the animation.
25028 * @note When you add an object with elm_transit_object_add(), its state from
25029 * evas_object_pass_events_get(obj) is saved, and it is applied when the
25030 * transit ends, if you change this state with evas_object_pass_events_set()
25031 * after adding the object, this state will change again when @p transit stops
25034 * @param transit The transit object.
25035 * @param enabled Events are received when enabled is @c EINA_TRUE, and
25036 * ignored otherwise.
25040 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25043 * Get the value of event enabled status.
25045 * @see elm_transit_event_enabled_set()
25047 * @param transit The Transit object
25048 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25049 * EINA_FALSE is returned
25053 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25056 * Set the user-callback function when the transit is deleted.
25058 * @note Using this function twice will overwrite the first function setted.
25059 * @note the @p transit object will be deleted after call @p cb function.
25061 * @param transit The transit object.
25062 * @param cb Callback function pointer. This function will be called before
25063 * the deletion of the transit.
25064 * @param data Callback funtion user data. It is the @p op parameter.
25068 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25071 * Set reverse effect automatically.
25073 * If auto reverse is setted, after running the effects with the progress
25074 * parameter from 0 to 1, it will call the effecs again with the progress
25075 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25076 * where the duration was setted with the function elm_transit_add and
25077 * the repeat with the function elm_transit_repeat_times_set().
25079 * @param transit The transit object.
25080 * @param reverse EINA_TRUE means the auto_reverse is on.
25084 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25087 * Get if the auto reverse is on.
25089 * @see elm_transit_auto_reverse_set()
25091 * @param transit The transit object.
25092 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25093 * EINA_FALSE is returned
25097 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25100 * Set the transit repeat count. Effect will be repeated by repeat count.
25102 * This function sets the number of repetition the transit will run after
25103 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25104 * If the @p repeat is a negative number, it will repeat infinite times.
25106 * @note If this function is called during the transit execution, the transit
25107 * will run @p repeat times, ignoring the times it already performed.
25109 * @param transit The transit object
25110 * @param repeat Repeat count
25114 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25117 * Get the transit repeat count.
25119 * @see elm_transit_repeat_times_set()
25121 * @param transit The Transit object.
25122 * @return The repeat count. If @p transit is NULL
25127 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25130 * Set the transit animation acceleration type.
25132 * This function sets the tween mode of the transit that can be:
25133 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25134 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25135 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25136 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25138 * @param transit The transit object.
25139 * @param tween_mode The tween type.
25143 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25146 * Get the transit animation acceleration type.
25148 * @note @p transit can not be NULL
25150 * @param transit The transit object.
25151 * @return The tween type. If @p transit is NULL
25152 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25156 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25159 * Set the transit animation time
25161 * @note @p transit can not be NULL
25163 * @param transit The transit object.
25164 * @param duration The animation time.
25168 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25171 * Get the transit animation time
25173 * @note @p transit can not be NULL
25175 * @param transit The transit object.
25177 * @return The transit animation time.
25181 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25184 * Starts the transition.
25185 * Once this API is called, the transit begins to measure the time.
25187 * @note @p transit can not be NULL
25189 * @param transit The transit object.
25193 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25196 * Pause/Resume the transition.
25198 * If you call elm_transit_go again, the transit will be started from the
25199 * beginning, and will be unpaused.
25201 * @note @p transit can not be NULL
25203 * @param transit The transit object.
25204 * @param paused Whether the transition should be paused or not.
25208 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25211 * Get the value of paused status.
25213 * @see elm_transit_paused_set()
25215 * @note @p transit can not be NULL
25217 * @param transit The transit object.
25218 * @return EINA_TRUE means transition is paused. If @p transit is NULL
25219 * EINA_FALSE is returned
25223 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25226 * Get the time progression of the animation (a double value between 0.0 and 1.0).
25228 * The value returned is a fraction (current time / total time). It
25229 * represents the progression position relative to the total.
25231 * @note @p transit can not be NULL
25233 * @param transit The transit object.
25235 * @return The time progression value. If @p transit is NULL
25240 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25243 * Makes the chain relationship between two transits.
25245 * @note @p transit can not be NULL. Transit would have multiple chain transits.
25246 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25248 * @param transit The transit object.
25249 * @param chain_transit The chain transit object. This transit will be operated
25250 * after transit is done.
25252 * This function adds @p chain_transit transition to a chain after the @p
25253 * transit, and will be started as soon as @p transit ends. See @ref
25254 * transit_example_02_explained for a full example.
25258 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25261 * Cut off the chain relationship between two transits.
25263 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25264 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25266 * @param transit The transit object.
25267 * @param chain_transit The chain transit object.
25269 * This function remove the @p chain_transit transition from the @p transit.
25273 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25276 * Get the current chain transit list.
25278 * @note @p transit can not be NULL.
25280 * @param transit The transit object.
25281 * @return chain transit list.
25285 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
25288 * Add the Resizing Effect to Elm_Transit.
25290 * @note This API is one of the facades. It creates resizing effect context
25291 * and add it's required APIs to elm_transit_effect_add.
25293 * @see elm_transit_effect_add()
25295 * @param transit Transit object.
25296 * @param from_w Object width size when effect begins.
25297 * @param from_h Object height size when effect begins.
25298 * @param to_w Object width size when effect ends.
25299 * @param to_h Object height size when effect ends.
25300 * @return Resizing effect context data.
25304 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);
25307 * Add the Translation Effect to Elm_Transit.
25309 * @note This API is one of the facades. It creates translation 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_dx X Position variation when effect begins.
25316 * @param from_dy Y Position variation when effect begins.
25317 * @param to_dx X Position variation when effect ends.
25318 * @param to_dy Y Position variation when effect ends.
25319 * @return Translation effect context data.
25322 * @warning It is highly recommended just create a transit with this effect when
25323 * the window that the objects of the transit belongs has already been created.
25324 * This is because this effect needs the geometry information about the objects,
25325 * and if the window was not created yet, it can get a wrong information.
25327 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);
25330 * Add the Zoom Effect to Elm_Transit.
25332 * @note This API is one of the facades. It creates zoom effect context
25333 * and add it's required APIs to elm_transit_effect_add.
25335 * @see elm_transit_effect_add()
25337 * @param transit Transit object.
25338 * @param from_rate Scale rate when effect begins (1 is current rate).
25339 * @param to_rate Scale rate when effect ends.
25340 * @return Zoom effect context data.
25343 * @warning It is highly recommended just create a transit with this effect when
25344 * the window that the objects of the transit belongs has already been created.
25345 * This is because this effect needs the geometry information about the objects,
25346 * and if the window was not created yet, it can get a wrong information.
25348 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25351 * Add the Flip Effect to Elm_Transit.
25353 * @note This API is one of the facades. It creates flip effect context
25354 * and add it's required APIs to elm_transit_effect_add.
25355 * @note This effect is applied to each pair of objects in the order they are listed
25356 * in the transit list of objects. The first object in the pair will be the
25357 * "front" object and the second will be the "back" object.
25359 * @see elm_transit_effect_add()
25361 * @param transit Transit object.
25362 * @param axis Flipping Axis(X or Y).
25363 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25364 * @return Flip effect context data.
25367 * @warning It is highly recommended just create a transit with this effect when
25368 * the window that the objects of the transit belongs has already been created.
25369 * This is because this effect needs the geometry information about the objects,
25370 * and if the window was not created yet, it can get a wrong information.
25372 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25375 * Add the Resizable Flip Effect to Elm_Transit.
25377 * @note This API is one of the facades. It creates resizable flip effect context
25378 * and add it's required APIs to elm_transit_effect_add.
25379 * @note This effect is applied to each pair of objects in the order they are listed
25380 * in the transit list of objects. The first object in the pair will be the
25381 * "front" object and the second will be the "back" object.
25383 * @see elm_transit_effect_add()
25385 * @param transit Transit object.
25386 * @param axis Flipping Axis(X or Y).
25387 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25388 * @return Resizable flip effect context data.
25391 * @warning It is highly recommended just create a transit with this effect when
25392 * the window that the objects of the transit belongs has already been created.
25393 * This is because this effect needs the geometry information about the objects,
25394 * and if the window was not created yet, it can get a wrong information.
25396 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25399 * Add the Wipe Effect to Elm_Transit.
25401 * @note This API is one of the facades. It creates wipe effect context
25402 * and add it's required APIs to elm_transit_effect_add.
25404 * @see elm_transit_effect_add()
25406 * @param transit Transit object.
25407 * @param type Wipe type. Hide or show.
25408 * @param dir Wipe Direction.
25409 * @return Wipe effect context data.
25412 * @warning It is highly recommended just create a transit with this effect when
25413 * the window that the objects of the transit belongs has already been created.
25414 * This is because this effect needs the geometry information about the objects,
25415 * and if the window was not created yet, it can get a wrong information.
25417 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25420 * Add the Color Effect to Elm_Transit.
25422 * @note This API is one of the facades. It creates color effect context
25423 * and add it's required APIs to elm_transit_effect_add.
25425 * @see elm_transit_effect_add()
25427 * @param transit Transit object.
25428 * @param from_r RGB R when effect begins.
25429 * @param from_g RGB G when effect begins.
25430 * @param from_b RGB B when effect begins.
25431 * @param from_a RGB A when effect begins.
25432 * @param to_r RGB R when effect ends.
25433 * @param to_g RGB G when effect ends.
25434 * @param to_b RGB B when effect ends.
25435 * @param to_a RGB A when effect ends.
25436 * @return Color effect context data.
25440 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);
25443 * Add the Fade Effect to Elm_Transit.
25445 * @note This API is one of the facades. It creates fade effect context
25446 * and add it's required APIs to elm_transit_effect_add.
25447 * @note This effect is applied to each pair of objects in the order they are listed
25448 * in the transit list of objects. The first object in the pair will be the
25449 * "before" object and the second will be the "after" object.
25451 * @see elm_transit_effect_add()
25453 * @param transit Transit object.
25454 * @return Fade effect context data.
25457 * @warning It is highly recommended just create a transit with this effect when
25458 * the window that the objects of the transit belongs has already been created.
25459 * This is because this effect needs the color information about the objects,
25460 * and if the window was not created yet, it can get a wrong information.
25462 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25465 * Add the Blend Effect to Elm_Transit.
25467 * @note This API is one of the facades. It creates blend effect context
25468 * and add it's required APIs to elm_transit_effect_add.
25469 * @note This effect is applied to each pair of objects in the order they are listed
25470 * in the transit list of objects. The first object in the pair will be the
25471 * "before" object and the second will be the "after" object.
25473 * @see elm_transit_effect_add()
25475 * @param transit Transit object.
25476 * @return Blend effect context data.
25479 * @warning It is highly recommended just create a transit with this effect when
25480 * the window that the objects of the transit belongs has already been created.
25481 * This is because this effect needs the color information about the objects,
25482 * and if the window was not created yet, it can get a wrong information.
25484 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25487 * Add the Rotation Effect to Elm_Transit.
25489 * @note This API is one of the facades. It creates rotation effect context
25490 * and add it's required APIs to elm_transit_effect_add.
25492 * @see elm_transit_effect_add()
25494 * @param transit Transit object.
25495 * @param from_degree Degree when effect begins.
25496 * @param to_degree Degree when effect is ends.
25497 * @return Rotation effect context data.
25500 * @warning It is highly recommended just create a transit with this effect when
25501 * the window that the objects of the transit belongs has already been created.
25502 * This is because this effect needs the geometry information about the objects,
25503 * and if the window was not created yet, it can get a wrong information.
25505 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25508 * Add the ImageAnimation Effect to Elm_Transit.
25510 * @note This API is one of the facades. It creates image animation effect context
25511 * and add it's required APIs to elm_transit_effect_add.
25512 * The @p images parameter is a list images paths. This list and
25513 * its contents will be deleted at the end of the effect by
25514 * elm_transit_effect_image_animation_context_free() function.
25518 * char buf[PATH_MAX];
25519 * Eina_List *images = NULL;
25520 * Elm_Transit *transi = elm_transit_add();
25522 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25523 * images = eina_list_append(images, eina_stringshare_add(buf));
25525 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25526 * images = eina_list_append(images, eina_stringshare_add(buf));
25527 * elm_transit_effect_image_animation_add(transi, images);
25531 * @see elm_transit_effect_add()
25533 * @param transit Transit object.
25534 * @param images Eina_List of images file paths. This list and
25535 * its contents will be deleted at the end of the effect by
25536 * elm_transit_effect_image_animation_context_free() function.
25537 * @return Image Animation effect context data.
25541 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25546 typedef struct _Elm_Store Elm_Store;
25547 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
25548 typedef struct _Elm_Store_Item Elm_Store_Item;
25549 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
25550 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
25551 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25552 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
25553 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
25554 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
25555 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
25556 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
25558 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25559 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25560 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25561 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25565 ELM_STORE_ITEM_MAPPING_NONE = 0,
25566 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25567 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25568 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25569 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25570 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25571 // can add more here as needed by common apps
25572 ELM_STORE_ITEM_MAPPING_LAST
25573 } Elm_Store_Item_Mapping_Type;
25575 struct _Elm_Store_Item_Mapping_Icon
25577 // FIXME: allow edje file icons
25579 Elm_Icon_Lookup_Order lookup_order;
25580 Eina_Bool standard_name : 1;
25581 Eina_Bool no_scale : 1;
25582 Eina_Bool smooth : 1;
25583 Eina_Bool scale_up : 1;
25584 Eina_Bool scale_down : 1;
25587 struct _Elm_Store_Item_Mapping_Empty
25592 struct _Elm_Store_Item_Mapping_Photo
25597 struct _Elm_Store_Item_Mapping_Custom
25599 Elm_Store_Item_Mapping_Cb func;
25602 struct _Elm_Store_Item_Mapping
25604 Elm_Store_Item_Mapping_Type type;
25609 Elm_Store_Item_Mapping_Empty empty;
25610 Elm_Store_Item_Mapping_Icon icon;
25611 Elm_Store_Item_Mapping_Photo photo;
25612 Elm_Store_Item_Mapping_Custom custom;
25613 // add more types here
25617 struct _Elm_Store_Item_Info
25619 Elm_Genlist_Item_Class *item_class;
25620 const Elm_Store_Item_Mapping *mapping;
25625 struct _Elm_Store_Item_Info_Filesystem
25627 Elm_Store_Item_Info base;
25631 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25632 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25634 EAPI void elm_store_free(Elm_Store *st);
25636 EAPI Elm_Store *elm_store_filesystem_new(void);
25637 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25638 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25639 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25641 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25643 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25644 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25645 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25646 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25647 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25648 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25650 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25651 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25652 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25653 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25654 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25655 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25656 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25659 * @defgroup SegmentControl SegmentControl
25660 * @ingroup Elementary
25662 * @image html img/widget/segment_control/preview-00.png
25663 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25665 * @image html img/segment_control.png
25666 * @image latex img/segment_control.eps width=\textwidth
25668 * Segment control widget is a horizontal control made of multiple segment
25669 * items, each segment item functioning similar to discrete two state button.
25670 * A segment control groups the items together and provides compact
25671 * single button with multiple equal size segments.
25673 * Segment item size is determined by base widget
25674 * size and the number of items added.
25675 * Only one segment item can be at selected state. A segment item can display
25676 * combination of Text and any Evas_Object like Images or other widget.
25678 * Smart callbacks one can listen to:
25679 * - "changed" - When the user clicks on a segment item which is not
25680 * previously selected and get selected. The event_info parameter is the
25681 * segment item index.
25683 * Available styles for it:
25686 * Here is an example on its usage:
25687 * @li @ref segment_control_example
25691 * @addtogroup SegmentControl
25695 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25698 * Add a new segment control widget to the given parent Elementary
25699 * (container) object.
25701 * @param parent The parent object.
25702 * @return a new segment control widget handle or @c NULL, on errors.
25704 * This function inserts a new segment control widget on the canvas.
25706 * @ingroup SegmentControl
25708 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25711 * Append a new item to the segment control object.
25713 * @param obj The segment control object.
25714 * @param icon The icon object to use for the left side of the item. An
25715 * icon can be any Evas object, but usually it is an icon created
25716 * with elm_icon_add().
25717 * @param label The label of the item.
25718 * Note that, NULL is different from empty string "".
25719 * @return The created item or @c NULL upon failure.
25721 * A new item will be created and appended to the segment control, i.e., will
25722 * be set as @b last item.
25724 * If it should be inserted at another position,
25725 * elm_segment_control_item_insert_at() should be used instead.
25727 * Items created with this function can be deleted with function
25728 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25730 * @note @p label set to @c NULL is different from empty string "".
25732 * only has icon, it will be displayed bigger and centered. If it has
25733 * icon and label, even that an empty string, icon will be smaller and
25734 * positioned at left.
25738 * sc = elm_segment_control_add(win);
25739 * ic = elm_icon_add(win);
25740 * elm_icon_file_set(ic, "path/to/image", NULL);
25741 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25742 * elm_segment_control_item_add(sc, ic, "label");
25743 * evas_object_show(sc);
25746 * @see elm_segment_control_item_insert_at()
25747 * @see elm_segment_control_item_del()
25749 * @ingroup SegmentControl
25751 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25754 * Insert a new item to the segment control object at specified position.
25756 * @param obj The segment control object.
25757 * @param icon The icon object to use for the left side of the item. An
25758 * icon can be any Evas object, but usually it is an icon created
25759 * with elm_icon_add().
25760 * @param label The label of the item.
25761 * @param index Item position. Value should be between 0 and items count.
25762 * @return The created item or @c NULL upon failure.
25764 * Index values must be between @c 0, when item will be prepended to
25765 * segment control, and items count, that can be get with
25766 * elm_segment_control_item_count_get(), case when item will be appended
25767 * to segment control, just like elm_segment_control_item_add().
25769 * Items created with this function can be deleted with function
25770 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25772 * @note @p label set to @c NULL is different from empty string "".
25774 * only has icon, it will be displayed bigger and centered. If it has
25775 * icon and label, even that an empty string, icon will be smaller and
25776 * positioned at left.
25778 * @see elm_segment_control_item_add()
25779 * @see elm_segment_control_count_get()
25780 * @see elm_segment_control_item_del()
25782 * @ingroup SegmentControl
25784 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);
25787 * Remove a segment control item from its parent, deleting it.
25789 * @param it The item to be removed.
25791 * Items can be added with elm_segment_control_item_add() or
25792 * elm_segment_control_item_insert_at().
25794 * @ingroup SegmentControl
25796 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25799 * Remove a segment control item at given index from its parent,
25802 * @param obj The segment control object.
25803 * @param index The position of the segment control item to be deleted.
25805 * Items can be added with elm_segment_control_item_add() or
25806 * elm_segment_control_item_insert_at().
25808 * @ingroup SegmentControl
25810 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25813 * Get the Segment items count from segment control.
25815 * @param obj The segment control object.
25816 * @return Segment items count.
25818 * It will just return the number of items added to segment control @p obj.
25820 * @ingroup SegmentControl
25822 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25825 * Get the item placed at specified index.
25827 * @param obj The segment control object.
25828 * @param index The index of the segment item.
25829 * @return The segment control item or @c NULL on failure.
25831 * Index is the position of an item in segment control widget. Its
25832 * range is from @c 0 to <tt> count - 1 </tt>.
25833 * Count is the number of items, that can be get with
25834 * elm_segment_control_item_count_get().
25836 * @ingroup SegmentControl
25838 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25841 * Get the label of item.
25843 * @param obj The segment control object.
25844 * @param index The index of the segment item.
25845 * @return The label of the item at @p index.
25847 * The return value is a pointer to the label associated to the item when
25848 * it was created, with function elm_segment_control_item_add(), or later
25849 * with function elm_segment_control_item_label_set. If no label
25850 * was passed as argument, it will return @c NULL.
25852 * @see elm_segment_control_item_label_set() for more details.
25853 * @see elm_segment_control_item_add()
25855 * @ingroup SegmentControl
25857 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25860 * Set the label of item.
25862 * @param it The item of segment control.
25863 * @param text The label of item.
25865 * The label to be displayed by the item.
25866 * Label will be at right of the icon (if set).
25868 * If a label was passed as argument on item creation, with function
25869 * elm_control_segment_item_add(), it will be already
25870 * displayed by the item.
25872 * @see elm_segment_control_item_label_get()
25873 * @see elm_segment_control_item_add()
25875 * @ingroup SegmentControl
25877 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
25880 * Get the icon associated to the item.
25882 * @param obj The segment control object.
25883 * @param index The index of the segment item.
25884 * @return The left side icon associated to the item at @p index.
25886 * The return value is a pointer to the icon associated to the item when
25887 * it was created, with function elm_segment_control_item_add(), or later
25888 * with function elm_segment_control_item_icon_set(). If no icon
25889 * was passed as argument, it will return @c NULL.
25891 * @see elm_segment_control_item_add()
25892 * @see elm_segment_control_item_icon_set()
25894 * @ingroup SegmentControl
25896 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25899 * Set the icon associated to the item.
25901 * @param it The segment control item.
25902 * @param icon The icon object to associate with @p it.
25904 * The icon object to use at left side of the item. An
25905 * icon can be any Evas object, but usually it is an icon created
25906 * with elm_icon_add().
25908 * Once the icon object is set, a previously set one will be deleted.
25909 * @warning Setting the same icon for two items will cause the icon to
25910 * dissapear from the first item.
25912 * If an icon was passed as argument on item creation, with function
25913 * elm_segment_control_item_add(), it will be already
25914 * associated to the item.
25916 * @see elm_segment_control_item_add()
25917 * @see elm_segment_control_item_icon_get()
25919 * @ingroup SegmentControl
25921 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25924 * Get the index of an item.
25926 * @param it The segment control item.
25927 * @return The position of item in segment control widget.
25929 * Index is the position of an item in segment control widget. Its
25930 * range is from @c 0 to <tt> count - 1 </tt>.
25931 * Count is the number of items, that can be get with
25932 * elm_segment_control_item_count_get().
25934 * @ingroup SegmentControl
25936 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25939 * Get the base object of the item.
25941 * @param it The segment control item.
25942 * @return The base object associated with @p it.
25944 * Base object is the @c Evas_Object that represents that item.
25946 * @ingroup SegmentControl
25948 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25951 * Get the selected item.
25953 * @param obj The segment control object.
25954 * @return The selected item or @c NULL if none of segment items is
25957 * The selected item can be unselected with function
25958 * elm_segment_control_item_selected_set().
25960 * The selected item always will be highlighted on segment control.
25962 * @ingroup SegmentControl
25964 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25967 * Set the selected state of an item.
25969 * @param it The segment control item
25970 * @param select The selected state
25972 * This sets the selected state of the given item @p it.
25973 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25975 * If a new item is selected the previosly selected will be unselected.
25976 * Previoulsy selected item can be get with function
25977 * elm_segment_control_item_selected_get().
25979 * The selected item always will be highlighted on segment control.
25981 * @see elm_segment_control_item_selected_get()
25983 * @ingroup SegmentControl
25985 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
25992 * @defgroup Grid Grid
25994 * The grid is a grid layout widget that lays out a series of children as a
25995 * fixed "grid" of widgets using a given percentage of the grid width and
25996 * height each using the child object.
25998 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
25999 * widgets size itself. The default is 100 x 100, so that means the
26000 * position and sizes of children will effectively be percentages (0 to 100)
26001 * of the width or height of the grid widget
26007 * Add a new grid to the parent
26009 * @param parent The parent object
26010 * @return The new object or NULL if it cannot be created
26014 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26017 * Set the virtual size of the grid
26019 * @param obj The grid object
26020 * @param w The virtual width of the grid
26021 * @param h The virtual height of the grid
26025 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
26028 * Get the virtual size of the grid
26030 * @param obj The grid object
26031 * @param w Pointer to integer to store the virtual width of the grid
26032 * @param h Pointer to integer to store the virtual height of the grid
26036 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26039 * Pack child at given position and size
26041 * @param obj The grid object
26042 * @param subobj The child to pack
26043 * @param x The virtual x coord at which to pack it
26044 * @param y The virtual y coord at which to pack it
26045 * @param w The virtual width at which to pack it
26046 * @param h The virtual height at which to pack it
26050 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26053 * Unpack a child from a grid object
26055 * @param obj The grid object
26056 * @param subobj The child to unpack
26060 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26063 * Faster way to remove all child objects from a grid object.
26065 * @param obj The grid object
26066 * @param clear If true, it will delete just removed children
26070 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26073 * Set packing of an existing child at to position and size
26075 * @param subobj The child to set packing of
26076 * @param x The virtual x coord at which to pack it
26077 * @param y The virtual y coord at which to pack it
26078 * @param w The virtual width at which to pack it
26079 * @param h The virtual height at which to pack it
26083 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26086 * get packing of a child
26088 * @param subobj The child to query
26089 * @param x Pointer to integer to store the virtual x coord
26090 * @param y Pointer to integer to store the virtual y coord
26091 * @param w Pointer to integer to store the virtual width
26092 * @param h Pointer to integer to store the virtual height
26096 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26102 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26103 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26104 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26106 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26107 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26108 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26109 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26110 EAPI void elm_video_play(Evas_Object *video);
26111 EAPI void elm_video_pause(Evas_Object *video);
26112 EAPI void elm_video_stop(Evas_Object *video);
26113 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26114 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26115 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26116 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26117 EAPI double elm_video_audio_level_get(Evas_Object *video);
26118 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26119 EAPI double elm_video_play_position_get(Evas_Object *video);
26120 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26121 EAPI double elm_video_play_length_get(Evas_Object *video);
26122 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26123 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26124 EAPI const char *elm_video_title_get(Evas_Object *video);
26126 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26127 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26130 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26131 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);
26132 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26133 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26134 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26135 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26136 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26137 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26138 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26139 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26140 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26141 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26142 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26143 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26144 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26147 * @defgroup Video Video
26149 * This object display an player that let you control an Elm_Video
26150 * object. It take care of updating it's content according to what is
26151 * going on inside the Emotion object. It does activate the remember
26152 * function on the linked Elm_Video object.
26154 * Signals that you cann add callback for are :
26156 * "forward,clicked" - the user clicked the forward button.
26157 * "info,clicked" - the user clicked the info button.
26158 * "next,clicked" - the user clicked the next button.
26159 * "pause,clicked" - the user clicked the pause button.
26160 * "play,clicked" - the user clicked the play button.
26161 * "prev,clicked" - the user clicked the prev button.
26162 * "rewind,clicked" - the user clicked the rewind button.
26163 * "stop,clicked" - the user clicked the stop button.