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);
874 EAPI Eina_Bool elm_need_ethumb(void);
877 * Set a new policy's value (for a given policy group/identifier).
879 * @param policy policy identifier, as in @ref Elm_Policy.
880 * @param value policy value, which depends on the identifier
882 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
884 * Elementary policies define applications' behavior,
885 * somehow. These behaviors are divided in policy groups (see
886 * #Elm_Policy enumeration). This call will emit the Ecore event
887 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
888 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
891 * @note Currently, we have only one policy identifier/group
892 * (#ELM_POLICY_QUIT), which has two possible values.
896 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
899 * Gets the policy value set for given policy identifier.
901 * @param policy policy identifier, as in #Elm_Policy.
902 * @return The currently set policy value, for that
903 * identifier. Will be @c 0 if @p policy passed is invalid.
907 EAPI int elm_policy_get(unsigned int policy);
910 * Set a label of an object
912 * @param obj The Elementary object
913 * @param part The text part name to set (NULL for the default label)
914 * @param label The new text of the label
916 * @note Elementary objects may have many labels (e.g. Action Slider)
920 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
922 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
925 * Get a label of an object
927 * @param obj The Elementary object
928 * @param part The text part name to get (NULL for the default label)
929 * @return text of the label or NULL for any error
931 * @note Elementary objects may have many labels (e.g. Action Slider)
935 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
937 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
940 * Set a content of an object
942 * @param obj The Elementary object
943 * @param part The content part name to set (NULL for the default content)
944 * @param content The new content of the object
946 * @note Elementary objects may have many contents
950 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
952 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
955 * Get a content of an object
957 * @param obj The Elementary object
958 * @param item The content part name to get (NULL for the default content)
959 * @return content of the object or NULL for any error
961 * @note Elementary objects may have many contents
965 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
967 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
970 * Unset a content of an object
972 * @param obj The Elementary object
973 * @param item The content part name to unset (NULL for the default content)
975 * @note Elementary objects may have many contents
979 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
981 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
984 * Set a content of an object item
986 * @param it The Elementary object item
987 * @param part The content part name to unset (NULL for the default content)
988 * @param content The new content of the object item
990 * @note Elementary object items may have many contents
994 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
996 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
999 * Get a content of an object item
1001 * @param it The Elementary object item
1002 * @param part The content part name to unset (NULL for the default content)
1003 * @return content of the object item or NULL for any error
1005 * @note Elementary object items may have many contents
1009 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1011 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1014 * Unset a content of an object item
1016 * @param it The Elementary object item
1017 * @param part The content part name to unset (NULL for the default content)
1019 * @note Elementary object items may have many contents
1023 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1025 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1028 * Set a label of an objec itemt
1030 * @param it The Elementary object item
1031 * @param part The text part name to set (NULL for the default label)
1032 * @param label The new text of the label
1034 * @note Elementary object items may have many labels
1038 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1040 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1043 * Get a label of an object
1045 * @param it The Elementary object item
1046 * @param part The text part name to get (NULL for the default label)
1047 * @return text of the label or NULL for any error
1049 * @note Elementary object items may have many labels
1053 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1055 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1061 EAPI void elm_all_flush(void);
1062 EAPI int elm_cache_flush_interval_get(void);
1063 EAPI void elm_cache_flush_interval_set(int size);
1064 EAPI void elm_cache_flush_interval_all_set(int size);
1065 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1066 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1067 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1068 EAPI int elm_font_cache_get(void);
1069 EAPI void elm_font_cache_set(int size);
1070 EAPI void elm_font_cache_all_set(int size);
1071 EAPI int elm_image_cache_get(void);
1072 EAPI void elm_image_cache_set(int size);
1073 EAPI void elm_image_cache_all_set(int size);
1074 EAPI int elm_edje_file_cache_get(void);
1075 EAPI void elm_edje_file_cache_set(int size);
1076 EAPI void elm_edje_file_cache_all_set(int size);
1077 EAPI int elm_edje_collection_cache_get(void);
1078 EAPI void elm_edje_collection_cache_set(int size);
1079 EAPI void elm_edje_collection_cache_all_set(int size);
1082 * @defgroup Scaling Selective Widget Scaling
1084 * Different widgets can be scaled independently. These functions
1085 * allow you to manipulate this scaling on a per-widget basis. The
1086 * object and all its children get their scaling factors multiplied
1087 * by the scale factor set. This is multiplicative, in that if a
1088 * child also has a scale size set it is in turn multiplied by its
1089 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1090 * double size, @c 0.5 is half, etc.
1092 * @ref general_functions_example_page "This" example contemplates
1093 * some of these functions.
1097 * Set the scaling factor for a given Elementary object
1099 * @param obj The Elementary to operate on
1100 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1105 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1108 * Get the scaling factor for a given Elementary object
1110 * @param obj The object
1111 * @return The scaling factor set by elm_object_scale_set()
1115 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1116 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1117 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1118 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1119 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1121 * Set the style to use by a widget
1123 * Sets the style name that will define the appearance of a widget. Styles
1124 * vary from widget to widget and may also be defined by other themes
1125 * by means of extensions and overlays.
1127 * @param obj The Elementary widget to style
1128 * @param style The style name to use
1130 * @see elm_theme_extension_add()
1131 * @see elm_theme_overlay_add()
1135 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1137 * Get the style used by the widget
1139 * This gets the style being used for that widget. Note that the string
1140 * pointer is only valid as longas the object is valid and the style doesn't
1143 * @param obj The Elementary widget to query for its style
1144 * @return The style name used
1146 * @see elm_object_style_set()
1150 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1153 * @defgroup Styles Styles
1155 * Widgets can have different styles of look. These generic API's
1156 * set styles of widgets, if they support them (and if the theme(s)
1159 * @ref general_functions_example_page "This" example contemplates
1160 * some of these functions.
1164 * Set the disabled state of an Elementary object.
1166 * @param obj The Elementary object to operate on
1167 * @param disabled The state to put in in: @c EINA_TRUE for
1168 * disabled, @c EINA_FALSE for enabled
1170 * Elementary objects can be @b disabled, in which state they won't
1171 * receive input and, in general, will be themed differently from
1172 * their normal state, usually greyed out. Useful for contexts
1173 * where you don't want your users to interact with some of the
1174 * parts of you interface.
1176 * This sets the state for the widget, either disabling it or
1181 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1184 * Get the disabled state of an Elementary object.
1186 * @param obj The Elementary object to operate on
1187 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1188 * if it's enabled (or on errors)
1190 * This gets the state of the widget, which might be enabled or disabled.
1194 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1197 * @defgroup WidgetNavigation Widget Tree Navigation.
1199 * How to check if an Evas Object is an Elementary widget? How to
1200 * get the first elementary widget that is parent of the given
1201 * object? These are all covered in widget tree navigation.
1203 * @ref general_functions_example_page "This" example contemplates
1204 * some of these functions.
1207 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1210 * Get the first parent of the given object that is an Elementary
1213 * @param obj the Elementary object to query parent from.
1214 * @return the parent object that is an Elementary widget, or @c
1215 * NULL, if it was not found.
1217 * Use this to query for an object's parent widget.
1219 * @note Most of Elementary users wouldn't be mixing non-Elementary
1220 * smart objects in the objects tree of an application, as this is
1221 * an advanced usage of Elementary with Evas. So, except for the
1222 * application's window, which is the root of that tree, all other
1223 * objects would have valid Elementary widget parents.
1225 * @ingroup WidgetNavigation
1227 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1228 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1229 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1231 EAPI double elm_scale_get(void);
1232 EAPI void elm_scale_set(double scale);
1233 EAPI void elm_scale_all_set(double scale);
1235 EAPI Eina_Bool elm_mirrored_get(void);
1236 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1238 EAPI Eina_Bool elm_config_save(void);
1239 EAPI void elm_config_reload(void);
1241 EAPI const char *elm_profile_current_get(void);
1242 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1243 EAPI void elm_profile_dir_free(const char *p_dir);
1244 EAPI Eina_List *elm_profile_list_get(void);
1245 EAPI void elm_profile_list_free(Eina_List *l);
1246 EAPI void elm_profile_set(const char *profile);
1247 EAPI void elm_profile_all_set(const char *profile);
1249 EAPI const char *elm_engine_current_get(void);
1250 EAPI void elm_engine_set(const char *engine);
1252 typedef struct _Elm_Text_Class
1258 typedef struct _Elm_Font_Overlay
1260 const char *text_class;
1262 Evas_Font_Size size;
1265 typedef struct _Elm_Font_Properties
1269 } Elm_Font_Properties;
1271 EAPI const Eina_List *elm_text_classes_list_get(void);
1272 EAPI void elm_text_classes_list_free(const Eina_List *list);
1274 EAPI const Eina_List *elm_font_overlay_list_get(void);
1275 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1276 EAPI void elm_font_overlay_unset(const char *text_class);
1277 EAPI void elm_font_overlay_apply(void);
1278 EAPI void elm_font_overlay_all_apply(void);
1280 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1281 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1282 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1283 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1284 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1285 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1288 * @defgroup Fingers Fingers
1290 * Elementary is designed to be finger-friendly for touchscreens,
1291 * and so in addition to scaling for display resolution, it can
1292 * also scale based on finger "resolution" (or size). You can then
1293 * customize the granularity of the areas meant to receive clicks
1296 * Different profiles may have pre-set values for finger sizes.
1298 * @ref general_functions_example_page "This" example contemplates
1299 * some of these functions.
1303 * Get the configured "finger size"
1305 * @return The finger size
1307 * This gets the globally configured finger size, <b>in pixels</b>
1311 EAPI Evas_Coord elm_finger_size_get(void);
1312 EAPI void elm_finger_size_set(Evas_Coord size);
1313 EAPI void elm_finger_size_all_set(Evas_Coord size);
1316 * @defgroup Focus Focus
1318 * An Elementary application has, at all times, one (and only one)
1319 * @b focused object. This is what determines where the input
1320 * events go to within the application's window. Also, focused
1321 * objects can be decorated differently, in order to signal to the
1322 * user where the input is, at a given moment.
1324 * Elementary applications also have the concept of <b>focus
1325 * chain</b>: one can cycle through all the windows' focusable
1326 * objects by input (tab key) or programmatically. The default
1327 * focus chain for an application is the one define by the order in
1328 * which the widgets where added in code. One will cycle through
1329 * top level widgets, and, for each one containg sub-objects, cycle
1330 * through them all, before returning to the level
1331 * above. Elementary also allows one to set @b custom focus chains
1332 * for their applications.
1334 * Besides the focused decoration a widget may exhibit, when it
1335 * gets focus, Elementary has a @b global focus highlight object
1336 * that can be enabled for a window. If one chooses to do so, this
1337 * extra highlight effect will surround the current focused object,
1340 * @note Some Elementary widgets are @b unfocusable, after
1341 * creation, by their very nature: they are not meant to be
1342 * interacted with input events, but are there just for visual
1345 * @ref general_functions_example_page "This" example contemplates
1346 * some of these functions.
1349 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1350 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1351 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1352 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1355 * Get the whether an Elementary object has the focus or not.
1357 * @param obj The Elementary object to get the information from
1358 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1359 * not (and on errors).
1361 * @see elm_object_focus_set()
1365 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1368 * Set/unset focus to a given Elementary object.
1370 * @param obj The Elementary object to operate on.
1371 * @param enable @c EINA_TRUE Set focus to a given object,
1372 * @c EINA_FALSE Unset focus to a given object.
1374 * @note When you set focus to this object, if it can handle focus, will
1375 * take the focus away from the one who had it previously and will, for
1376 * now on, be the one receiving input events. Unsetting focus will remove
1377 * the focus from @p obj, passing it back to the previous element in the
1380 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1384 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1387 * Make a given Elementary object the focused one.
1389 * @param obj The Elementary object to make focused.
1391 * @note This object, if it can handle focus, will take the focus
1392 * away from the one who had it previously and will, for now on, be
1393 * the one receiving input events.
1395 * @see elm_object_focus_get()
1396 * @deprecated use elm_object_focus_set() instead.
1400 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1403 * Remove the focus from an Elementary object
1405 * @param obj The Elementary to take focus from
1407 * This removes the focus from @p obj, passing it back to the
1408 * previous element in the focus chain list.
1410 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1411 * @deprecated use elm_object_focus_set() instead.
1415 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1418 * Set the ability for an Element object to be focused
1420 * @param obj The Elementary object to operate on
1421 * @param enable @c EINA_TRUE if the object can be focused, @c
1422 * EINA_FALSE if not (and on errors)
1424 * This sets whether the object @p obj is able to take focus or
1425 * not. Unfocusable objects do nothing when programmatically
1426 * focused, being the nearest focusable parent object the one
1427 * really getting focus. Also, when they receive mouse input, they
1428 * will get the event, but not take away the focus from where it
1433 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1436 * Get whether an Elementary object is focusable or not
1438 * @param obj The Elementary object to operate on
1439 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1440 * EINA_FALSE if not (and on errors)
1442 * @note Objects which are meant to be interacted with by input
1443 * events are created able to be focused, by default. All the
1448 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1450 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1451 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1452 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1453 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1454 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1455 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1456 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1459 * Make the elementary object and its children to be unfocusable (or focusable).
1461 * @param obj The Elementary object to operate on
1462 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1463 * @c EINA_FALSE for focusable.
1465 * This sets whether the object @p obj and its children objects
1466 * are able to take focus or not. If the tree is set as unfocusable,
1467 * newest focused object which is not in this tree will get focus.
1468 * This API can be helpful for an object to be deleted.
1469 * When an object will be deleted soon, it and its children may not
1470 * want to get focus (by focus reverting or by other focus controls).
1471 * Then, just use this API before deleting.
1473 * @see elm_object_tree_unfocusable_get()
1477 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1480 * Get whether an Elementary object and its children are unfocusable or not.
1482 * @param obj The Elementary object to get the information from
1483 * @return @c EINA_TRUE, if the tree is unfocussable,
1484 * @c EINA_FALSE if not (and on errors).
1486 * @see elm_object_tree_unfocusable_set()
1490 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1492 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1493 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1494 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1495 EAPI double elm_scroll_bounce_friction_get(void);
1496 EAPI void elm_scroll_bounce_friction_set(double friction);
1497 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1498 EAPI double elm_scroll_page_scroll_friction_get(void);
1499 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1500 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1501 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1502 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1503 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1504 EAPI double elm_scroll_zoom_friction_get(void);
1505 EAPI void elm_scroll_zoom_friction_set(double friction);
1506 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1507 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1508 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1509 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1510 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1511 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1512 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1513 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1514 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1515 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1516 EAPI double elm_scroll_thumbscroll_friction_get(void);
1517 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1518 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1519 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1520 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1521 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1523 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1524 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1525 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1526 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1527 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1528 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1529 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1530 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1532 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1533 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);
1534 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);
1536 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1537 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1540 * Adjust size of an element for finger usage.
1542 * @param times_w How many fingers should fit horizontally
1543 * @param w Pointer to the width size to adjust
1544 * @param times_h How many fingers should fit vertically
1545 * @param h Pointer to the height size to adjust
1547 * This takes width and height sizes (in pixels) as input and a
1548 * size multiple (which is how many fingers you want to place
1549 * within the area, being "finger" the size set by
1550 * elm_finger_size_set()), and adjusts the size to be large enough
1551 * to accommodate the resulting size -- if it doesn't already
1552 * accommodate it. On return the @p w and @p h sizes pointed to by
1553 * these parameters will be modified, on those conditions.
1555 * @note This is kind of a low level Elementary call, most useful
1556 * on size evaluation times for widgets. An external user wouldn't
1557 * be calling, most of the time.
1561 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1563 EAPI double elm_longpress_timeout_get(void);
1564 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1567 * don't use it unless you are sure
1569 EAPI void elm_object_tree_dump(const Evas_Object *top);
1570 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1575 * @defgroup Theme Theme
1577 * Elementary uses Edje to theme its widgets, naturally. But for the most
1578 * part this is hidden behind a simpler interface that lets the user set
1579 * extensions and choose the style of widgets in a much easier way.
1581 * Instead of thinking in terms of paths to Edje files and their groups
1582 * each time you want to change the appearance of a widget, Elementary
1583 * works so you can add any theme file with extensions or replace the
1584 * main theme at one point in the application, and then just set the style
1585 * of widgets with elm_object_style_set() and related functions. Elementary
1586 * will then look in its list of themes for a matching group and apply it,
1587 * and when the theme changes midway through the application, all widgets
1588 * will be updated accordingly.
1590 * There are three concepts you need to know to understand how Elementary
1591 * theming works: default theme, extensions and overlays.
1593 * Default theme, obviously enough, is the one that provides the default
1594 * look of all widgets. End users can change the theme used by Elementary
1595 * by setting the @c ELM_THEME environment variable before running an
1596 * application, or globally for all programs using the @c elementary_config
1597 * utility. Applications can change the default theme using elm_theme_set(),
1598 * but this can go against the user wishes, so it's not an adviced practice.
1600 * Ideally, applications should find everything they need in the already
1601 * provided theme, but there may be occasions when that's not enough and
1602 * custom styles are required to correctly express the idea. For this
1603 * cases, Elementary has extensions.
1605 * Extensions allow the application developer to write styles of its own
1606 * to apply to some widgets. This requires knowledge of how each widget
1607 * is themed, as extensions will always replace the entire group used by
1608 * the widget, so important signals and parts need to be there for the
1609 * object to behave properly (see documentation of Edje for details).
1610 * Once the theme for the extension is done, the application needs to add
1611 * it to the list of themes Elementary will look into, using
1612 * elm_theme_extension_add(), and set the style of the desired widgets as
1613 * he would normally with elm_object_style_set().
1615 * Overlays, on the other hand, can replace the look of all widgets by
1616 * overriding the default style. Like extensions, it's up to the application
1617 * developer to write the theme for the widgets it wants, the difference
1618 * being that when looking for the theme, Elementary will check first the
1619 * list of overlays, then the set theme and lastly the list of extensions,
1620 * so with overlays it's possible to replace the default view and every
1621 * widget will be affected. This is very much alike to setting the whole
1622 * theme for the application and will probably clash with the end user
1623 * options, not to mention the risk of ending up with not matching styles
1624 * across the program. Unless there's a very special reason to use them,
1625 * overlays should be avoided for the resons exposed before.
1627 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1628 * keeps one default internally and every function that receives one of
1629 * these can be called with NULL to refer to this default (except for
1630 * elm_theme_free()). It's possible to create a new instance of a
1631 * ::Elm_Theme to set other theme for a specific widget (and all of its
1632 * children), but this is as discouraged, if not even more so, than using
1633 * overlays. Don't use this unless you really know what you are doing.
1635 * But to be less negative about things, you can look at the following
1637 * @li @ref theme_example_01 "Using extensions"
1638 * @li @ref theme_example_02 "Using overlays"
1643 * @typedef Elm_Theme
1645 * Opaque handler for the list of themes Elementary looks for when
1646 * rendering widgets.
1648 * Stay out of this unless you really know what you are doing. For most
1649 * cases, sticking to the default is all a developer needs.
1651 typedef struct _Elm_Theme Elm_Theme;
1654 * Create a new specific theme
1656 * This creates an empty specific theme that only uses the default theme. A
1657 * specific theme has its own private set of extensions and overlays too
1658 * (which are empty by default). Specific themes do not fall back to themes
1659 * of parent objects. They are not intended for this use. Use styles, overlays
1660 * and extensions when needed, but avoid specific themes unless there is no
1661 * other way (example: you want to have a preview of a new theme you are
1662 * selecting in a "theme selector" window. The preview is inside a scroller
1663 * and should display what the theme you selected will look like, but not
1664 * actually apply it yet. The child of the scroller will have a specific
1665 * theme set to show this preview before the user decides to apply it to all
1668 EAPI Elm_Theme *elm_theme_new(void);
1670 * Free a specific theme
1672 * @param th The theme to free
1674 * This frees a theme created with elm_theme_new().
1676 EAPI void elm_theme_free(Elm_Theme *th);
1678 * Copy the theme fom the source to the destination theme
1680 * @param th The source theme to copy from
1681 * @param thdst The destination theme to copy data to
1683 * This makes a one-time static copy of all the theme config, extensions
1684 * and overlays from @p th to @p thdst. If @p th references a theme, then
1685 * @p thdst is also set to reference it, with all the theme settings,
1686 * overlays and extensions that @p th had.
1688 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1690 * Tell the source theme to reference the ref theme
1692 * @param th The theme that will do the referencing
1693 * @param thref The theme that is the reference source
1695 * This clears @p th to be empty and then sets it to refer to @p thref
1696 * so @p th acts as an override to @p thref, but where its overrides
1697 * don't apply, it will fall through to @p thref for configuration.
1699 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1701 * Return the theme referred to
1703 * @param th The theme to get the reference from
1704 * @return The referenced theme handle
1706 * This gets the theme set as the reference theme by elm_theme_ref_set().
1707 * If no theme is set as a reference, NULL is returned.
1709 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1711 * Return the default theme
1713 * @return The default theme handle
1715 * This returns the internal default theme setup handle that all widgets
1716 * use implicitly unless a specific theme is set. This is also often use
1717 * as a shorthand of NULL.
1719 EAPI Elm_Theme *elm_theme_default_get(void);
1721 * Prepends a theme overlay to the list of overlays
1723 * @param th The theme to add to, or if NULL, the default theme
1724 * @param item The Edje file path to be used
1726 * Use this if your application needs to provide some custom overlay theme
1727 * (An Edje file that replaces some default styles of widgets) where adding
1728 * new styles, or changing system theme configuration is not possible. Do
1729 * NOT use this instead of a proper system theme configuration. Use proper
1730 * configuration files, profiles, environment variables etc. to set a theme
1731 * so that the theme can be altered by simple confiugration by a user. Using
1732 * this call to achieve that effect is abusing the API and will create lots
1735 * @see elm_theme_extension_add()
1737 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1739 * Delete a theme overlay from the list of overlays
1741 * @param th The theme to delete from, or if NULL, the default theme
1742 * @param item The name of the theme overlay
1744 * @see elm_theme_overlay_add()
1746 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1748 * Appends a theme extension to the list of extensions.
1750 * @param th The theme to add to, or if NULL, the default theme
1751 * @param item The Edje file path to be used
1753 * This is intended when an application needs more styles of widgets or new
1754 * widget themes that the default does not provide (or may not provide). The
1755 * application has "extended" usage by coming up with new custom style names
1756 * for widgets for specific uses, but as these are not "standard", they are
1757 * not guaranteed to be provided by a default theme. This means the
1758 * application is required to provide these extra elements itself in specific
1759 * Edje files. This call adds one of those Edje files to the theme search
1760 * path to be search after the default theme. The use of this call is
1761 * encouraged when default styles do not meet the needs of the application.
1762 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1764 * @see elm_object_style_set()
1766 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1768 * Deletes a theme extension from the list of extensions.
1770 * @param th The theme to delete from, or if NULL, the default theme
1771 * @param item The name of the theme extension
1773 * @see elm_theme_extension_add()
1775 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1777 * Set the theme search order for the given theme
1779 * @param th The theme to set the search order, or if NULL, the default theme
1780 * @param theme Theme search string
1782 * This sets the search string for the theme in path-notation from first
1783 * theme to search, to last, delimited by the : character. Example:
1785 * "shiny:/path/to/file.edj:default"
1787 * See the ELM_THEME environment variable for more information.
1789 * @see elm_theme_get()
1790 * @see elm_theme_list_get()
1792 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1794 * Return the theme search order
1796 * @param th The theme to get the search order, or if NULL, the default theme
1797 * @return The internal search order path
1799 * This function returns a colon separated string of theme elements as
1800 * returned by elm_theme_list_get().
1802 * @see elm_theme_set()
1803 * @see elm_theme_list_get()
1805 EAPI const char *elm_theme_get(Elm_Theme *th);
1807 * Return a list of theme elements to be used in a theme.
1809 * @param th Theme to get the list of theme elements from.
1810 * @return The internal list of theme elements
1812 * This returns the internal list of theme elements (will only be valid as
1813 * long as the theme is not modified by elm_theme_set() or theme is not
1814 * freed by elm_theme_free(). This is a list of strings which must not be
1815 * altered as they are also internal. If @p th is NULL, then the default
1816 * theme element list is returned.
1818 * A theme element can consist of a full or relative path to a .edj file,
1819 * or a name, without extension, for a theme to be searched in the known
1820 * theme paths for Elemementary.
1822 * @see elm_theme_set()
1823 * @see elm_theme_get()
1825 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1827 * Return the full patrh for a theme element
1829 * @param f The theme element name
1830 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1831 * @return The full path to the file found.
1833 * This returns a string you should free with free() on success, NULL on
1834 * failure. This will search for the given theme element, and if it is a
1835 * full or relative path element or a simple searchable name. The returned
1836 * path is the full path to the file, if searched, and the file exists, or it
1837 * is simply the full path given in the element or a resolved path if
1838 * relative to home. The @p in_search_path boolean pointed to is set to
1839 * EINA_TRUE if the file was a searchable file andis in the search path,
1840 * and EINA_FALSE otherwise.
1842 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1844 * Flush the current theme.
1846 * @param th Theme to flush
1848 * This flushes caches that let elementary know where to find theme elements
1849 * in the given theme. If @p th is NULL, then the default theme is flushed.
1850 * Call this function if source theme data has changed in such a way as to
1851 * make any caches Elementary kept invalid.
1853 EAPI void elm_theme_flush(Elm_Theme *th);
1855 * This flushes all themes (default and specific ones).
1857 * This will flush all themes in the current application context, by calling
1858 * elm_theme_flush() on each of them.
1860 EAPI void elm_theme_full_flush(void);
1862 * Set the theme for all elementary using applications on the current display
1864 * @param theme The name of the theme to use. Format same as the ELM_THEME
1865 * environment variable.
1867 EAPI void elm_theme_all_set(const char *theme);
1869 * Return a list of theme elements in the theme search path
1871 * @return A list of strings that are the theme element names.
1873 * This lists all available theme files in the standard Elementary search path
1874 * for theme elements, and returns them in alphabetical order as theme
1875 * element names in a list of strings. Free this with
1876 * elm_theme_name_available_list_free() when you are done with the list.
1878 EAPI Eina_List *elm_theme_name_available_list_new(void);
1880 * Free the list returned by elm_theme_name_available_list_new()
1882 * This frees the list of themes returned by
1883 * elm_theme_name_available_list_new(). Once freed the list should no longer
1884 * be used. a new list mys be created.
1886 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1888 * Set a specific theme to be used for this object and its children
1890 * @param obj The object to set the theme on
1891 * @param th The theme to set
1893 * This sets a specific theme that will be used for the given object and any
1894 * child objects it has. If @p th is NULL then the theme to be used is
1895 * cleared and the object will inherit its theme from its parent (which
1896 * ultimately will use the default theme if no specific themes are set).
1898 * Use special themes with great care as this will annoy users and make
1899 * configuration difficult. Avoid any custom themes at all if it can be
1902 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1904 * Get the specific theme to be used
1906 * @param obj The object to get the specific theme from
1907 * @return The specifc theme set.
1909 * This will return a specific theme set, or NULL if no specific theme is
1910 * set on that object. It will not return inherited themes from parents, only
1911 * the specific theme set for that specific object. See elm_object_theme_set()
1912 * for more information.
1914 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1920 /** @defgroup Win Win
1922 * @image html img/widget/win/preview-00.png
1923 * @image latex img/widget/win/preview-00.eps
1925 * The window class of Elementary. Contains functions to manipulate
1926 * windows. The Evas engine used to render the window contents is specified
1927 * in the system or user elementary config files (whichever is found last),
1928 * and can be overridden with the ELM_ENGINE environment variable for
1929 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1930 * compilation setup and modules actually installed at runtime) are (listed
1931 * in order of best supported and most likely to be complete and work to
1934 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1935 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1937 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1939 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1941 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1943 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1944 * rendering using SDL as the buffer)
1945 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1946 * GDI with software)
1947 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1948 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1949 * grayscale using dedicated 8bit software engine in X11)
1950 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1951 * X11 using 16bit software engine)
1952 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1953 * (Windows CE rendering via GDI with 16bit software renderer)
1954 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1955 * buffer with 16bit software renderer)
1957 * All engines use a simple string to select the engine to render, EXCEPT
1958 * the "shot" engine. This actually encodes the output of the virtual
1959 * screenshot and how long to delay in the engine string. The engine string
1960 * is encoded in the following way:
1962 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1964 * Where options are separated by a ":" char if more than one option is
1965 * given, with delay, if provided being the first option and file the last
1966 * (order is important). The delay specifies how long to wait after the
1967 * window is shown before doing the virtual "in memory" rendering and then
1968 * save the output to the file specified by the file option (and then exit).
1969 * If no delay is given, the default is 0.5 seconds. If no file is given the
1970 * default output file is "out.png". Repeat option is for continous
1971 * capturing screenshots. Repeat range is from 1 to 999 and filename is
1972 * fixed to "out001.png" Some examples of using the shot engine:
1974 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1975 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1976 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1977 * ELM_ENGINE="shot:delay=2.0" elementary_test
1978 * ELM_ENGINE="shot:" elementary_test
1980 * Signals that you can add callbacks for are:
1982 * @li "delete,request": the user requested to close the window. See
1983 * elm_win_autodel_set().
1984 * @li "focus,in": window got focus
1985 * @li "focus,out": window lost focus
1986 * @li "moved": window that holds the canvas was moved
1989 * @li @ref win_example_01
1994 * Defines the types of window that can be created
1996 * These are hints set on the window so that a running Window Manager knows
1997 * how the window should be handled and/or what kind of decorations it
2000 * Currently, only the X11 backed engines use them.
2002 typedef enum _Elm_Win_Type
2004 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
2005 window. Almost every window will be created with this
2007 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
2008 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
2009 window holding desktop icons. */
2010 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
2011 be kept on top of any other window by the Window
2013 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
2015 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
2016 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
2018 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
2019 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
2020 entry in a menubar is clicked. Typically used
2021 with elm_win_override_set(). This hint exists
2022 for completion only, as the EFL way of
2023 implementing a menu would not normally use a
2024 separate window for its contents. */
2025 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
2026 triggered by right-clicking an object. */
2027 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
2028 explanatory text that typically appear after the
2029 mouse cursor hovers over an object for a while.
2030 Typically used with elm_win_override_set() and also
2031 not very commonly used in the EFL. */
2032 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
2033 battery life or a new E-Mail received. */
2034 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
2035 usually used in the EFL. */
2036 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
2037 object being dragged across different windows, or even
2038 applications. Typically used with
2039 elm_win_override_set(). */
2040 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
2041 buffer. No actual window is created for this
2042 type, instead the window and all of its
2043 contents will be rendered to an image buffer.
2044 This allows to have children window inside a
2045 parent one just like any other object would
2046 be, and do other things like applying @c
2047 Evas_Map effects to it. This is the only type
2048 of window that requires the @c parent
2049 parameter of elm_win_add() to be a valid @c
2054 * The differents layouts that can be requested for the virtual keyboard.
2056 * When the application window is being managed by Illume, it may request
2057 * any of the following layouts for the virtual keyboard.
2059 typedef enum _Elm_Win_Keyboard_Mode
2061 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
2062 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
2063 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
2064 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
2065 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
2066 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
2067 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
2068 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
2069 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
2070 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
2071 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
2072 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
2073 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
2074 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
2075 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
2076 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
2077 } Elm_Win_Keyboard_Mode;
2080 * Available commands that can be sent to the Illume manager.
2082 * When running under an Illume session, a window may send commands to the
2083 * Illume manager to perform different actions.
2085 typedef enum _Elm_Illume_Command
2087 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
2089 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
2091 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
2093 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
2094 } Elm_Illume_Command;
2097 * Adds a window object. If this is the first window created, pass NULL as
2100 * @param parent Parent object to add the window to, or NULL
2101 * @param name The name of the window
2102 * @param type The window type, one of #Elm_Win_Type.
2104 * The @p parent paramter can be @c NULL for every window @p type except
2105 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
2106 * which the image object will be created.
2108 * @return The created object, or NULL on failure
2110 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
2112 * Add @p subobj as a resize object of window @p obj.
2115 * Setting an object as a resize object of the window means that the
2116 * @p subobj child's size and position will be controlled by the window
2117 * directly. That is, the object will be resized to match the window size
2118 * and should never be moved or resized manually by the developer.
2120 * In addition, resize objects of the window control what the minimum size
2121 * of it will be, as well as whether it can or not be resized by the user.
2123 * For the end user to be able to resize a window by dragging the handles
2124 * or borders provided by the Window Manager, or using any other similar
2125 * mechanism, all of the resize objects in the window should have their
2126 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
2128 * @param obj The window object
2129 * @param subobj The resize object to add
2131 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2133 * Delete @p subobj as a resize object of window @p obj.
2135 * This function removes the object @p subobj from the resize objects of
2136 * the window @p obj. It will not delete the object itself, which will be
2137 * left unmanaged and should be deleted by the developer, manually handled
2138 * or set as child of some other container.
2140 * @param obj The window object
2141 * @param subobj The resize object to add
2143 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2145 * Set the title of the window
2147 * @param obj The window object
2148 * @param title The title to set
2150 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2152 * Get the title of the window
2154 * The returned string is an internal one and should not be freed or
2155 * modified. It will also be rendered invalid if a new title is set or if
2156 * the window is destroyed.
2158 * @param obj The window object
2161 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2163 * Set the window's autodel state.
2165 * When closing the window in any way outside of the program control, like
2166 * pressing the X button in the titlebar or using a command from the
2167 * Window Manager, a "delete,request" signal is emitted to indicate that
2168 * this event occurred and the developer can take any action, which may
2169 * include, or not, destroying the window object.
2171 * When the @p autodel parameter is set, the window will be automatically
2172 * destroyed when this event occurs, after the signal is emitted.
2173 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
2174 * and is up to the program to do so when it's required.
2176 * @param obj The window object
2177 * @param autodel If true, the window will automatically delete itself when
2180 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
2182 * Get the window's autodel state.
2184 * @param obj The window object
2185 * @return If the window will automatically delete itself when closed
2187 * @see elm_win_autodel_set()
2189 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2191 * Activate a window object.
2193 * This function sends a request to the Window Manager to activate the
2194 * window pointed by @p obj. If honored by the WM, the window will receive
2195 * the keyboard focus.
2197 * @note This is just a request that a Window Manager may ignore, so calling
2198 * this function does not ensure in any way that the window will be the
2199 * active one after it.
2201 * @param obj The window object
2203 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2205 * Lower a window object.
2207 * Places the window pointed by @p obj at the bottom of the stack, so that
2208 * no other window is covered by it.
2210 * If elm_win_override_set() is not set, the Window Manager may ignore this
2213 * @param obj The window object
2215 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2217 * Raise a window object.
2219 * Places the window pointed by @p obj at the top of the stack, so that it's
2220 * not covered by any other window.
2222 * If elm_win_override_set() is not set, the Window Manager may ignore this
2225 * @param obj The window object
2227 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2229 * Set the borderless state of a window.
2231 * This function requests the Window Manager to not draw any decoration
2232 * around the window.
2234 * @param obj The window object
2235 * @param borderless If true, the window is borderless
2237 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2239 * Get the borderless state of a window.
2241 * @param obj The window object
2242 * @return If true, the window is borderless
2244 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2246 * Set the shaped state of a window.
2248 * Shaped windows, when supported, will render the parts of the window that
2249 * has no content, transparent.
2251 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2252 * background object or cover the entire window in any other way, or the
2253 * parts of the canvas that have no data will show framebuffer artifacts.
2255 * @param obj The window object
2256 * @param shaped If true, the window is shaped
2258 * @see elm_win_alpha_set()
2260 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2262 * Get the shaped state of a window.
2264 * @param obj The window object
2265 * @return If true, the window is shaped
2267 * @see elm_win_shaped_set()
2269 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2271 * Set the alpha channel state of a window.
2273 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2274 * possibly making parts of the window completely or partially transparent.
2275 * This is also subject to the underlying system supporting it, like for
2276 * example, running under a compositing manager. If no compositing is
2277 * available, enabling this option will instead fallback to using shaped
2278 * windows, with elm_win_shaped_set().
2280 * @param obj The window object
2281 * @param alpha If true, the window has an alpha channel
2283 * @see elm_win_alpha_set()
2285 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2287 * Get the transparency state of a window.
2289 * @param obj The window object
2290 * @return If true, the window is transparent
2292 * @see elm_win_transparent_set()
2294 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2296 * Set the transparency state of a window.
2298 * Use elm_win_alpha_set() instead.
2300 * @param obj The window object
2301 * @param transparent If true, the window is transparent
2303 * @see elm_win_alpha_set()
2305 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2307 * Get the alpha channel state of a window.
2309 * @param obj The window object
2310 * @return If true, the window has an alpha channel
2312 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2314 * Set the override state of a window.
2316 * A window with @p override set to EINA_TRUE will not be managed by the
2317 * Window Manager. This means that no decorations of any kind will be shown
2318 * for it, moving and resizing must be handled by the application, as well
2319 * as the window visibility.
2321 * This should not be used for normal windows, and even for not so normal
2322 * ones, it should only be used when there's a good reason and with a lot
2323 * of care. Mishandling override windows may result situations that
2324 * disrupt the normal workflow of the end user.
2326 * @param obj The window object
2327 * @param override If true, the window is overridden
2329 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2331 * Get the override state of a window.
2333 * @param obj The window object
2334 * @return If true, the window is overridden
2336 * @see elm_win_override_set()
2338 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2340 * Set the fullscreen state of a window.
2342 * @param obj The window object
2343 * @param fullscreen If true, the window is fullscreen
2345 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2347 * Get the fullscreen state of a window.
2349 * @param obj The window object
2350 * @return If true, the window is fullscreen
2352 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2354 * Set the maximized state of a window.
2356 * @param obj The window object
2357 * @param maximized If true, the window is maximized
2359 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2361 * Get the maximized state of a window.
2363 * @param obj The window object
2364 * @return If true, the window is maximized
2366 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2368 * Set the iconified state of a window.
2370 * @param obj The window object
2371 * @param iconified If true, the window is iconified
2373 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2375 * Get the iconified state of a window.
2377 * @param obj The window object
2378 * @return If true, the window is iconified
2380 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2382 * Set the layer of the window.
2384 * What this means exactly will depend on the underlying engine used.
2386 * In the case of X11 backed engines, the value in @p layer has the
2387 * following meanings:
2388 * @li < 3: The window will be placed below all others.
2389 * @li > 5: The window will be placed above all others.
2390 * @li other: The window will be placed in the default layer.
2392 * @param obj The window object
2393 * @param layer The layer of the window
2395 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2397 * Get the layer of the window.
2399 * @param obj The window object
2400 * @return The layer of the window
2402 * @see elm_win_layer_set()
2404 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2406 * Set the rotation of the window.
2408 * Most engines only work with multiples of 90.
2410 * This function is used to set the orientation of the window @p obj to
2411 * match that of the screen. The window itself will be resized to adjust
2412 * to the new geometry of its contents. If you want to keep the window size,
2413 * see elm_win_rotation_with_resize_set().
2415 * @param obj The window object
2416 * @param rotation The rotation of the window, in degrees (0-360),
2417 * counter-clockwise.
2419 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2421 * Rotates the window and resizes it.
2423 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2424 * that they fit inside the current window geometry.
2426 * @param obj The window object
2427 * @param layer The rotation of the window in degrees (0-360),
2428 * counter-clockwise.
2430 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2432 * Get the rotation of the window.
2434 * @param obj The window object
2435 * @return The rotation of the window in degrees (0-360)
2437 * @see elm_win_rotation_set()
2438 * @see elm_win_rotation_with_resize_set()
2440 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2442 * Set the sticky state of the window.
2444 * Hints the Window Manager that the window in @p obj should be left fixed
2445 * at its position even when the virtual desktop it's on moves or changes.
2447 * @param obj The window object
2448 * @param sticky If true, the window's sticky state is enabled
2450 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2452 * Get the sticky state of the window.
2454 * @param obj The window object
2455 * @return If true, the window's sticky state is enabled
2457 * @see elm_win_sticky_set()
2459 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2461 * Set if this window is an illume conformant window
2463 * @param obj The window object
2464 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2466 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2468 * Get if this window is an illume conformant window
2470 * @param obj The window object
2471 * @return A boolean if this window is illume conformant or not
2473 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2475 * Set a window to be an illume quickpanel window
2477 * By default window objects are not quickpanel windows.
2479 * @param obj The window object
2480 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2482 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2484 * Get if this window is a quickpanel or not
2486 * @param obj The window object
2487 * @return A boolean if this window is a quickpanel or not
2489 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2491 * Set the major priority of a quickpanel window
2493 * @param obj The window object
2494 * @param priority The major priority for this quickpanel
2496 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2498 * Get the major priority of a quickpanel window
2500 * @param obj The window object
2501 * @return The major priority of this quickpanel
2503 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2505 * Set the minor priority of a quickpanel window
2507 * @param obj The window object
2508 * @param priority The minor priority for this quickpanel
2510 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2512 * Get the minor priority of a quickpanel window
2514 * @param obj The window object
2515 * @return The minor priority of this quickpanel
2517 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2519 * Set which zone this quickpanel should appear in
2521 * @param obj The window object
2522 * @param zone The requested zone for this quickpanel
2524 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2526 * Get which zone this quickpanel should appear in
2528 * @param obj The window object
2529 * @return The requested zone for this quickpanel
2531 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2533 * Set the window to be skipped by keyboard focus
2535 * This sets the window to be skipped by normal keyboard input. This means
2536 * a window manager will be asked to not focus this window as well as omit
2537 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2539 * Call this and enable it on a window BEFORE you show it for the first time,
2540 * otherwise it may have no effect.
2542 * Use this for windows that have only output information or might only be
2543 * interacted with by the mouse or fingers, and never for typing input.
2544 * Be careful that this may have side-effects like making the window
2545 * non-accessible in some cases unless the window is specially handled. Use
2548 * @param obj The window object
2549 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2551 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2553 * Send a command to the windowing environment
2555 * This is intended to work in touchscreen or small screen device
2556 * environments where there is a more simplistic window management policy in
2557 * place. This uses the window object indicated to select which part of the
2558 * environment to control (the part that this window lives in), and provides
2559 * a command and an optional parameter structure (use NULL for this if not
2562 * @param obj The window object that lives in the environment to control
2563 * @param command The command to send
2564 * @param params Optional parameters for the command
2566 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2568 * Get the inlined image object handle
2570 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2571 * then the window is in fact an evas image object inlined in the parent
2572 * canvas. You can get this object (be careful to not manipulate it as it
2573 * is under control of elementary), and use it to do things like get pixel
2574 * data, save the image to a file, etc.
2576 * @param obj The window object to get the inlined image from
2577 * @return The inlined image object, or NULL if none exists
2579 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2581 * Set the enabled status for the focus highlight in a window
2583 * This function will enable or disable the focus highlight only for the
2584 * given window, regardless of the global setting for it
2586 * @param obj The window where to enable the highlight
2587 * @param enabled The enabled value for the highlight
2589 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2591 * Get the enabled value of the focus highlight for this window
2593 * @param obj The window in which to check if the focus highlight is enabled
2595 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2597 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2599 * Set the style for the focus highlight on this window
2601 * Sets the style to use for theming the highlight of focused objects on
2602 * the given window. If @p style is NULL, the default will be used.
2604 * @param obj The window where to set the style
2605 * @param style The style to set
2607 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2609 * Get the style set for the focus highlight object
2611 * Gets the style set for this windows highilght object, or NULL if none
2614 * @param obj The window to retrieve the highlights style from
2616 * @return The style set or NULL if none was. Default is used in that case.
2618 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2620 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2621 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2622 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2623 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2624 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2625 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2626 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2628 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2629 * (blank mouse, private mouse obj, defaultmouse)
2633 * Sets the keyboard mode of the window.
2635 * @param obj The window object
2636 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2638 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2640 * Gets the keyboard mode of the window.
2642 * @param obj The window object
2643 * @return The mode, one of #Elm_Win_Keyboard_Mode
2645 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2647 * Sets whether the window is a keyboard.
2649 * @param obj The window object
2650 * @param is_keyboard If true, the window is a virtual keyboard
2652 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2654 * Gets whether the window is a keyboard.
2656 * @param obj The window object
2657 * @return If the window is a virtual keyboard
2659 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2662 * Get the screen position of a window.
2664 * @param obj The window object
2665 * @param x The int to store the x coordinate to
2666 * @param y The int to store the y coordinate to
2668 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2674 * @defgroup Inwin Inwin
2676 * @image html img/widget/inwin/preview-00.png
2677 * @image latex img/widget/inwin/preview-00.eps
2678 * @image html img/widget/inwin/preview-01.png
2679 * @image latex img/widget/inwin/preview-01.eps
2680 * @image html img/widget/inwin/preview-02.png
2681 * @image latex img/widget/inwin/preview-02.eps
2683 * An inwin is a window inside a window that is useful for a quick popup.
2684 * It does not hover.
2686 * It works by creating an object that will occupy the entire window, so it
2687 * must be created using an @ref Win "elm_win" as parent only. The inwin
2688 * object can be hidden or restacked below every other object if it's
2689 * needed to show what's behind it without destroying it. If this is done,
2690 * the elm_win_inwin_activate() function can be used to bring it back to
2691 * full visibility again.
2693 * There are three styles available in the default theme. These are:
2694 * @li default: The inwin is sized to take over most of the window it's
2696 * @li minimal: The size of the inwin will be the minimum necessary to show
2698 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2699 * possible, but it's sized vertically the most it needs to fit its\
2702 * Some examples of Inwin can be found in the following:
2703 * @li @ref inwin_example_01
2708 * Adds an inwin to the current window
2710 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2711 * Never call this function with anything other than the top-most window
2712 * as its parameter, unless you are fond of undefined behavior.
2714 * After creating the object, the widget will set itself as resize object
2715 * for the window with elm_win_resize_object_add(), so when shown it will
2716 * appear to cover almost the entire window (how much of it depends on its
2717 * content and the style used). It must not be added into other container
2718 * objects and it needs not be moved or resized manually.
2720 * @param parent The parent object
2721 * @return The new object or NULL if it cannot be created
2723 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2725 * Activates an inwin object, ensuring its visibility
2727 * This function will make sure that the inwin @p obj is completely visible
2728 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2729 * to the front. It also sets the keyboard focus to it, which will be passed
2732 * The object's theme will also receive the signal "elm,action,show" with
2735 * @param obj The inwin to activate
2737 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2739 * Set the content of an inwin object.
2741 * Once the content object is set, a previously set one will be deleted.
2742 * If you want to keep that old content object, use the
2743 * elm_win_inwin_content_unset() function.
2745 * @param obj The inwin object
2746 * @param content The object to set as content
2748 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2750 * Get the content of an inwin object.
2752 * Return the content object which is set for this widget.
2754 * The returned object is valid as long as the inwin is still alive and no
2755 * other content is set on it. Deleting the object will notify the inwin
2756 * about it and this one will be left empty.
2758 * If you need to remove an inwin's content to be reused somewhere else,
2759 * see elm_win_inwin_content_unset().
2761 * @param obj The inwin object
2762 * @return The content that is being used
2764 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2766 * Unset the content of an inwin object.
2768 * Unparent and return the content object which was set for this widget.
2770 * @param obj The inwin object
2771 * @return The content that was being used
2773 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2777 /* X specific calls - won't work on non-x engines (return 0) */
2778 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2779 /* smart callbacks called:
2780 * "delete,request" - the user requested to delete the window
2781 * "focus,in" - window got focus
2782 * "focus,out" - window lost focus
2783 * "moved" - window that holds the canvas was moved
2789 * @image html img/widget/bg/preview-00.png
2790 * @image latex img/widget/bg/preview-00.eps
2792 * @brief Background object, used for setting a solid color, image or Edje
2793 * group as background to a window or any container object.
2795 * The bg object is used for setting a solid background to a window or
2796 * packing into any container object. It works just like an image, but has
2797 * some properties useful to a background, like setting it to tiled,
2798 * centered, scaled or stretched.
2800 * Here is some sample code using it:
2801 * @li @ref bg_01_example_page
2802 * @li @ref bg_02_example_page
2803 * @li @ref bg_03_example_page
2807 typedef enum _Elm_Bg_Option
2809 ELM_BG_OPTION_CENTER, /**< center the background */
2810 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2811 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2812 ELM_BG_OPTION_TILE /**< tile background at its original size */
2816 * Add a new background to the parent
2818 * @param parent The parent object
2819 * @return The new object or NULL if it cannot be created
2823 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2826 * Set the file (image or edje) used for the background
2828 * @param obj The bg object
2829 * @param file The file path
2830 * @param group Optional key (group in Edje) within the file
2832 * This sets the image file used in the background object. The image (or edje)
2833 * will be stretched (retaining aspect if its an image file) to completely fill
2834 * the bg object. This may mean some parts are not visible.
2836 * @note Once the image of @p obj is set, a previously set one will be deleted,
2837 * even if @p file is NULL.
2841 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2844 * Get the file (image or edje) used for the background
2846 * @param obj The bg object
2847 * @param file The file path
2848 * @param group Optional key (group in Edje) within the file
2852 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2855 * Set the option used for the background image
2857 * @param obj The bg object
2858 * @param option The desired background option (TILE, SCALE)
2860 * This sets the option used for manipulating the display of the background
2861 * image. The image can be tiled or scaled.
2865 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2868 * Get the option used for the background image
2870 * @param obj The bg object
2871 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2875 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2877 * Set the option used for the background color
2879 * @param obj The bg object
2884 * This sets the color used for the background rectangle. Its range goes
2889 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2891 * Get the option used for the background color
2893 * @param obj The bg object
2900 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2903 * Set the overlay object used for the background object.
2905 * @param obj The bg object
2906 * @param overlay The overlay object
2908 * This provides a way for elm_bg to have an 'overlay' that will be on top
2909 * of the bg. Once the over object is set, a previously set one will be
2910 * deleted, even if you set the new one to NULL. If you want to keep that
2911 * old content object, use the elm_bg_overlay_unset() function.
2916 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2919 * Get the overlay object used for the background object.
2921 * @param obj The bg object
2922 * @return The content that is being used
2924 * Return the content object which is set for this widget
2928 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2931 * Get the overlay object used for the background object.
2933 * @param obj The bg object
2934 * @return The content that was being used
2936 * Unparent and return the overlay object which was set for this widget
2940 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2943 * Set the size of the pixmap representation of the image.
2945 * This option just makes sense if an image is going to be set in the bg.
2947 * @param obj The bg object
2948 * @param w The new width of the image pixmap representation.
2949 * @param h The new height of the image pixmap representation.
2951 * This function sets a new size for pixmap representation of the given bg
2952 * image. It allows the image to be loaded already in the specified size,
2953 * reducing the memory usage and load time when loading a big image with load
2954 * size set to a smaller size.
2956 * NOTE: this is just a hint, the real size of the pixmap may differ
2957 * depending on the type of image being loaded, being bigger than requested.
2961 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2962 /* smart callbacks called:
2966 * @defgroup Icon Icon
2968 * @image html img/widget/icon/preview-00.png
2969 * @image latex img/widget/icon/preview-00.eps
2971 * An object that provides standard icon images (delete, edit, arrows, etc.)
2972 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2974 * The icon image requested can be in the elementary theme, or in the
2975 * freedesktop.org paths. It's possible to set the order of preference from
2976 * where the image will be used.
2978 * This API is very similar to @ref Image, but with ready to use images.
2980 * Default images provided by the theme are described below.
2982 * The first list contains icons that were first intended to be used in
2983 * toolbars, but can be used in many other places too:
2999 * Now some icons that were designed to be used in menus (but again, you can
3000 * use them anywhere else):
3005 * @li menu/arrow_down
3006 * @li menu/arrow_left
3007 * @li menu/arrow_right
3016 * And here we have some media player specific icons:
3017 * @li media_player/forward
3018 * @li media_player/info
3019 * @li media_player/next
3020 * @li media_player/pause
3021 * @li media_player/play
3022 * @li media_player/prev
3023 * @li media_player/rewind
3024 * @li media_player/stop
3026 * Signals that you can add callbacks for are:
3028 * "clicked" - This is called when a user has clicked the icon
3030 * An example of usage for this API follows:
3031 * @li @ref tutorial_icon
3039 typedef enum _Elm_Icon_Type
3046 * @enum _Elm_Icon_Lookup_Order
3047 * @typedef Elm_Icon_Lookup_Order
3049 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
3050 * theme, FDO paths, or both?
3054 typedef enum _Elm_Icon_Lookup_Order
3056 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
3057 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
3058 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
3059 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
3060 } Elm_Icon_Lookup_Order;
3063 * Add a new icon object to the parent.
3065 * @param parent The parent object
3066 * @return The new object or NULL if it cannot be created
3068 * @see elm_icon_file_set()
3072 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3074 * Set the file that will be used as icon.
3076 * @param obj The icon object
3077 * @param file The path to file that will be used as icon image
3078 * @param group The group that the icon belongs to in edje file
3080 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3082 * @note The icon image set by this function can be changed by
3083 * elm_icon_standard_set().
3085 * @see elm_icon_file_get()
3089 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3091 * Set a location in memory to be used as an icon
3093 * @param obj The icon object
3094 * @param img The binary data that will be used as an image
3095 * @param size The size of binary data @p img
3096 * @param format Optional format of @p img to pass to the image loader
3097 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
3099 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3101 * @note The icon image set by this function can be changed by
3102 * elm_icon_standard_set().
3106 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);
3108 * Get the file that will be used as icon.
3110 * @param obj The icon object
3111 * @param file The path to file that will be used as icon icon image
3112 * @param group The group that the icon belongs to in edje file
3114 * @see elm_icon_file_set()
3118 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3119 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3121 * Set the icon by icon standards names.
3123 * @param obj The icon object
3124 * @param name The icon name
3126 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3128 * For example, freedesktop.org defines standard icon names such as "home",
3129 * "network", etc. There can be different icon sets to match those icon
3130 * keys. The @p name given as parameter is one of these "keys", and will be
3131 * used to look in the freedesktop.org paths and elementary theme. One can
3132 * change the lookup order with elm_icon_order_lookup_set().
3134 * If name is not found in any of the expected locations and it is the
3135 * absolute path of an image file, this image will be used.
3137 * @note The icon image set by this function can be changed by
3138 * elm_icon_file_set().
3140 * @see elm_icon_standard_get()
3141 * @see elm_icon_file_set()
3145 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
3147 * Get the icon name set by icon standard names.
3149 * @param obj The icon object
3150 * @return The icon name
3152 * If the icon image was set using elm_icon_file_set() instead of
3153 * elm_icon_standard_set(), then this function will return @c NULL.
3155 * @see elm_icon_standard_set()
3159 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3161 * Set the smooth effect for an icon object.
3163 * @param obj The icon object
3164 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3165 * otherwise. Default is @c EINA_TRUE.
3167 * Set the scaling algorithm to be used when scaling the icon image. Smooth
3168 * scaling provides a better resulting image, but is slower.
3170 * The smooth scaling should be disabled when making animations that change
3171 * the icon size, since they will be faster. Animations that don't require
3172 * resizing of the icon can keep the smooth scaling enabled (even if the icon
3173 * is already scaled, since the scaled icon image will be cached).
3175 * @see elm_icon_smooth_get()
3179 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3181 * Get the smooth effect for an icon object.
3183 * @param obj The icon object
3184 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3186 * @see elm_icon_smooth_set()
3190 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3192 * Disable scaling of this object.
3194 * @param obj The icon object.
3195 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3196 * otherwise. Default is @c EINA_FALSE.
3198 * This function disables scaling of the icon object through the function
3199 * elm_object_scale_set(). However, this does not affect the object
3200 * size/resize in any way. For that effect, take a look at
3201 * elm_icon_scale_set().
3203 * @see elm_icon_no_scale_get()
3204 * @see elm_icon_scale_set()
3205 * @see elm_object_scale_set()
3209 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3211 * Get whether scaling is disabled on the object.
3213 * @param obj The icon object
3214 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3216 * @see elm_icon_no_scale_set()
3220 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3222 * Set if the object is (up/down) resizeable.
3224 * @param obj The icon object
3225 * @param scale_up A bool to set if the object is resizeable up. Default is
3227 * @param scale_down A bool to set if the object is resizeable down. Default
3230 * This function limits the icon object resize ability. If @p scale_up is set to
3231 * @c EINA_FALSE, the object can't have its height or width resized to a value
3232 * higher than the original icon size. Same is valid for @p scale_down.
3234 * @see elm_icon_scale_get()
3238 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3240 * Get if the object is (up/down) resizeable.
3242 * @param obj The icon object
3243 * @param scale_up A bool to set if the object is resizeable up
3244 * @param scale_down A bool to set if the object is resizeable down
3246 * @see elm_icon_scale_set()
3250 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3252 * Get the object's image size
3254 * @param obj The icon object
3255 * @param w A pointer to store the width in
3256 * @param h A pointer to store the height in
3260 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3262 * Set if the icon fill the entire object area.
3264 * @param obj The icon object
3265 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3266 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3268 * When the icon object is resized to a different aspect ratio from the
3269 * original icon image, the icon image will still keep its aspect. This flag
3270 * tells how the image should fill the object's area. They are: keep the
3271 * entire icon inside the limits of height and width of the object (@p
3272 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3273 * of the object, and the icon will fill the entire object (@p fill_outside
3276 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3277 * retain property to false. Thus, the icon image will always keep its
3278 * original aspect ratio.
3280 * @see elm_icon_fill_outside_get()
3281 * @see elm_image_fill_outside_set()
3285 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3287 * Get if the object is filled outside.
3289 * @param obj The icon object
3290 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3292 * @see elm_icon_fill_outside_set()
3296 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3298 * Set the prescale size for the icon.
3300 * @param obj The icon object
3301 * @param size The prescale size. This value is used for both width and
3304 * This function sets a new size for pixmap representation of the given
3305 * icon. It allows the icon to be loaded already in the specified size,
3306 * reducing the memory usage and load time when loading a big icon with load
3307 * size set to a smaller size.
3309 * It's equivalent to the elm_bg_load_size_set() function for bg.
3311 * @note this is just a hint, the real size of the pixmap may differ
3312 * depending on the type of icon being loaded, being bigger than requested.
3314 * @see elm_icon_prescale_get()
3315 * @see elm_bg_load_size_set()
3319 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3321 * Get the prescale size for the icon.
3323 * @param obj The icon object
3324 * @return The prescale size
3326 * @see elm_icon_prescale_set()
3330 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3332 * Sets the icon lookup order used by elm_icon_standard_set().
3334 * @param obj The icon object
3335 * @param order The icon lookup order (can be one of
3336 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3337 * or ELM_ICON_LOOKUP_THEME)
3339 * @see elm_icon_order_lookup_get()
3340 * @see Elm_Icon_Lookup_Order
3344 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3346 * Gets the icon lookup order.
3348 * @param obj The icon object
3349 * @return The icon lookup order
3351 * @see elm_icon_order_lookup_set()
3352 * @see Elm_Icon_Lookup_Order
3356 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3363 * @defgroup Image Image
3365 * @image html img/widget/image/preview-00.png
3366 * @image latex img/widget/image/preview-00.eps
3368 * An object that allows one to load an image file to it. It can be used
3369 * anywhere like any other elementary widget.
3371 * This widget provides most of the functionality provided from @ref Bg or @ref
3372 * Icon, but with a slightly different API (use the one that fits better your
3375 * The features not provided by those two other image widgets are:
3376 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3377 * @li change the object orientation with elm_image_orient_set();
3378 * @li and turning the image editable with elm_image_editable_set().
3380 * Signals that you can add callbacks for are:
3382 * @li @c "clicked" - This is called when a user has clicked the image
3384 * An example of usage for this API follows:
3385 * @li @ref tutorial_image
3394 * @enum _Elm_Image_Orient
3395 * @typedef Elm_Image_Orient
3397 * Possible orientation options for elm_image_orient_set().
3399 * @image html elm_image_orient_set.png
3400 * @image latex elm_image_orient_set.eps width=\textwidth
3404 typedef enum _Elm_Image_Orient
3406 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3407 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3408 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3409 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3410 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3411 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3412 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3413 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3417 * Add a new image to the parent.
3419 * @param parent The parent object
3420 * @return The new object or NULL if it cannot be created
3422 * @see elm_image_file_set()
3426 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3428 * Set the file that will be used as image.
3430 * @param obj The image object
3431 * @param file The path to file that will be used as image
3432 * @param group The group that the image belongs in edje file (if it's an
3435 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3437 * @see elm_image_file_get()
3441 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3443 * Get the file that will be used as image.
3445 * @param obj The image object
3446 * @param file The path to file
3447 * @param group The group that the image belongs in edje file
3449 * @see elm_image_file_set()
3453 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3455 * Set the smooth effect for an image.
3457 * @param obj The image object
3458 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3459 * otherwise. Default is @c EINA_TRUE.
3461 * Set the scaling algorithm to be used when scaling the image. Smooth
3462 * scaling provides a better resulting image, but is slower.
3464 * The smooth scaling should be disabled when making animations that change
3465 * the image size, since it will be faster. Animations that don't require
3466 * resizing of the image can keep the smooth scaling enabled (even if the
3467 * image is already scaled, since the scaled image will be cached).
3469 * @see elm_image_smooth_get()
3473 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3475 * Get the smooth effect for an image.
3477 * @param obj The image object
3478 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3480 * @see elm_image_smooth_get()
3484 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3486 * Gets the current size of the image.
3488 * @param obj The image object.
3489 * @param w Pointer to store width, or NULL.
3490 * @param h Pointer to store height, or NULL.
3492 * This is the real size of the image, not the size of the object.
3494 * On error, neither w or h will be written.
3498 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3500 * Disable scaling of this object.
3502 * @param obj The image object.
3503 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3504 * otherwise. Default is @c EINA_FALSE.
3506 * This function disables scaling of the elm_image widget through the
3507 * function elm_object_scale_set(). However, this does not affect the widget
3508 * size/resize in any way. For that effect, take a look at
3509 * elm_image_scale_set().
3511 * @see elm_image_no_scale_get()
3512 * @see elm_image_scale_set()
3513 * @see elm_object_scale_set()
3517 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3519 * Get whether scaling is disabled on the object.
3521 * @param obj The image object
3522 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3524 * @see elm_image_no_scale_set()
3528 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3530 * Set if the object is (up/down) resizeable.
3532 * @param obj The image object
3533 * @param scale_up A bool to set if the object is resizeable up. Default is
3535 * @param scale_down A bool to set if the object is resizeable down. Default
3538 * This function limits the image resize ability. If @p scale_up is set to
3539 * @c EINA_FALSE, the object can't have its height or width resized to a value
3540 * higher than the original image size. Same is valid for @p scale_down.
3542 * @see elm_image_scale_get()
3546 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3548 * Get if the object is (up/down) resizeable.
3550 * @param obj The image object
3551 * @param scale_up A bool to set if the object is resizeable up
3552 * @param scale_down A bool to set if the object is resizeable down
3554 * @see elm_image_scale_set()
3558 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3560 * Set if the image fill the entire object area when keeping the aspect ratio.
3562 * @param obj The image object
3563 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3564 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3566 * When the image should keep its aspect ratio even if resized to another
3567 * aspect ratio, there are two possibilities to resize it: keep the entire
3568 * image inside the limits of height and width of the object (@p fill_outside
3569 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3570 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3572 * @note This option will have no effect if
3573 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3575 * @see elm_image_fill_outside_get()
3576 * @see elm_image_aspect_ratio_retained_set()
3580 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3582 * Get if the object is filled outside
3584 * @param obj The image object
3585 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3587 * @see elm_image_fill_outside_set()
3591 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3593 * Set the prescale size for the image
3595 * @param obj The image object
3596 * @param size The prescale size. This value is used for both width and
3599 * This function sets a new size for pixmap representation of the given
3600 * image. It allows the image to be loaded already in the specified size,
3601 * reducing the memory usage and load time when loading a big image with load
3602 * size set to a smaller size.
3604 * It's equivalent to the elm_bg_load_size_set() function for bg.
3606 * @note this is just a hint, the real size of the pixmap may differ
3607 * depending on the type of image being loaded, being bigger than requested.
3609 * @see elm_image_prescale_get()
3610 * @see elm_bg_load_size_set()
3614 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3616 * Get the prescale size for the image
3618 * @param obj The image object
3619 * @return The prescale size
3621 * @see elm_image_prescale_set()
3625 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3627 * Set the image orientation.
3629 * @param obj The image object
3630 * @param orient The image orientation
3631 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3632 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3633 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3634 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3635 * Default is #ELM_IMAGE_ORIENT_NONE.
3637 * This function allows to rotate or flip the given image.
3639 * @see elm_image_orient_get()
3640 * @see @ref Elm_Image_Orient
3644 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3646 * Get the image orientation.
3648 * @param obj The image object
3649 * @return The image orientation
3650 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3651 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3652 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3653 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3655 * @see elm_image_orient_set()
3656 * @see @ref Elm_Image_Orient
3660 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3662 * Make the image 'editable'.
3664 * @param obj Image object.
3665 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3667 * This means the image is a valid drag target for drag and drop, and can be
3668 * cut or pasted too.
3672 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3674 * Make the image 'editable'.
3676 * @param obj Image object.
3677 * @return Editability.
3679 * This means the image is a valid drag target for drag and drop, and can be
3680 * cut or pasted too.
3684 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3686 * Get the basic Evas_Image object from this object (widget).
3688 * @param obj The image object to get the inlined image from
3689 * @return The inlined image object, or NULL if none exists
3691 * This function allows one to get the underlying @c Evas_Object of type
3692 * Image from this elementary widget. It can be useful to do things like get
3693 * the pixel data, save the image to a file, etc.
3695 * @note Be careful to not manipulate it, as it is under control of
3700 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3702 * Set whether the original aspect ratio of the image should be kept on resize.
3704 * @param obj The image object.
3705 * @param retained @c EINA_TRUE if the image should retain the aspect,
3706 * @c EINA_FALSE otherwise.
3708 * The original aspect ratio (width / height) of the image is usually
3709 * distorted to match the object's size. Enabling this option will retain
3710 * this original aspect, and the way that the image is fit into the object's
3711 * area depends on the option set by elm_image_fill_outside_set().
3713 * @see elm_image_aspect_ratio_retained_get()
3714 * @see elm_image_fill_outside_set()
3718 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3720 * Get if the object retains the original aspect ratio.
3722 * @param obj The image object.
3723 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3728 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3730 /* smart callbacks called:
3731 * "clicked" - the user clicked the image
3739 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3741 typedef enum _Elm_GLView_Mode
3743 ELM_GLVIEW_ALPHA = 1,
3744 ELM_GLVIEW_DEPTH = 2,
3745 ELM_GLVIEW_STENCIL = 4
3749 * Defines a policy for the glview resizing.
3751 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3753 typedef enum _Elm_GLView_Resize_Policy
3755 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3756 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3757 } Elm_GLView_Resize_Policy;
3759 typedef enum _Elm_GLView_Render_Policy
3761 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3762 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3763 } Elm_GLView_Render_Policy;
3766 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3767 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3768 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3769 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3770 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3771 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3772 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3773 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3774 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3775 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3776 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3777 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3783 * @image html img/widget/box/preview-00.png
3784 * @image latex img/widget/box/preview-00.eps width=\textwidth
3786 * @image html img/box.png
3787 * @image latex img/box.eps width=\textwidth
3789 * A box arranges objects in a linear fashion, governed by a layout function
3790 * that defines the details of this arrangement.
3792 * By default, the box will use an internal function to set the layout to
3793 * a single row, either vertical or horizontal. This layout is affected
3794 * by a number of parameters, such as the homogeneous flag set by
3795 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3796 * elm_box_align_set() and the hints set to each object in the box.
3798 * For this default layout, it's possible to change the orientation with
3799 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3800 * placing its elements ordered from top to bottom. When horizontal is set,
3801 * the order will go from left to right. If the box is set to be
3802 * homogeneous, every object in it will be assigned the same space, that
3803 * of the largest object. Padding can be used to set some spacing between
3804 * the cell given to each object. The alignment of the box, set with
3805 * elm_box_align_set(), determines how the bounding box of all the elements
3806 * will be placed within the space given to the box widget itself.
3808 * The size hints of each object also affect how they are placed and sized
3809 * within the box. evas_object_size_hint_min_set() will give the minimum
3810 * size the object can have, and the box will use it as the basis for all
3811 * latter calculations. Elementary widgets set their own minimum size as
3812 * needed, so there's rarely any need to use it manually.
3814 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3815 * used to tell whether the object will be allocated the minimum size it
3816 * needs or if the space given to it should be expanded. It's important
3817 * to realize that expanding the size given to the object is not the same
3818 * thing as resizing the object. It could very well end being a small
3819 * widget floating in a much larger empty space. If not set, the weight
3820 * for objects will normally be 0.0 for both axis, meaning the widget will
3821 * not be expanded. To take as much space possible, set the weight to
3822 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3824 * Besides how much space each object is allocated, it's possible to control
3825 * how the widget will be placed within that space using
3826 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3827 * for both axis, meaning the object will be centered, but any value from
3828 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3829 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3830 * is -1.0, means the object will be resized to fill the entire space it
3833 * In addition, customized functions to define the layout can be set, which
3834 * allow the application developer to organize the objects within the box
3835 * in any number of ways.
3837 * The special elm_box_layout_transition() function can be used
3838 * to switch from one layout to another, animating the motion of the
3839 * children of the box.
3841 * @note Objects should not be added to box objects using _add() calls.
3843 * Some examples on how to use boxes follow:
3844 * @li @ref box_example_01
3845 * @li @ref box_example_02
3850 * @typedef Elm_Box_Transition
3852 * Opaque handler containing the parameters to perform an animated
3853 * transition of the layout the box uses.
3855 * @see elm_box_transition_new()
3856 * @see elm_box_layout_set()
3857 * @see elm_box_layout_transition()
3859 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3862 * Add a new box to the parent
3864 * By default, the box will be in vertical mode and non-homogeneous.
3866 * @param parent The parent object
3867 * @return The new object or NULL if it cannot be created
3869 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3871 * Set the horizontal orientation
3873 * By default, box object arranges their contents vertically from top to
3875 * By calling this function with @p horizontal as EINA_TRUE, the box will
3876 * become horizontal, arranging contents from left to right.
3878 * @note This flag is ignored if a custom layout function is set.
3880 * @param obj The box object
3881 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3882 * EINA_FALSE = vertical)
3884 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3886 * Get the horizontal orientation
3888 * @param obj The box object
3889 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3891 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3893 * Set the box to arrange its children homogeneously
3895 * If enabled, homogeneous layout makes all items the same size, according
3896 * to the size of the largest of its children.
3898 * @note This flag is ignored if a custom layout function is set.
3900 * @param obj The box object
3901 * @param homogeneous The homogeneous flag
3903 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3905 * Get whether the box is using homogeneous mode or not
3907 * @param obj The box object
3908 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3910 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3911 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3912 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3914 * Add an object to the beginning of the pack list
3916 * Pack @p subobj into the box @p obj, placing it first in the list of
3917 * children objects. The actual position the object will get on screen
3918 * depends on the layout used. If no custom layout is set, it will be at
3919 * the top or left, depending if the box is vertical or horizontal,
3922 * @param obj The box object
3923 * @param subobj The object to add to the box
3925 * @see elm_box_pack_end()
3926 * @see elm_box_pack_before()
3927 * @see elm_box_pack_after()
3928 * @see elm_box_unpack()
3929 * @see elm_box_unpack_all()
3930 * @see elm_box_clear()
3932 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3934 * Add an object at the end of the pack list
3936 * Pack @p subobj into the box @p obj, placing it last in the list of
3937 * children objects. The actual position the object will get on screen
3938 * depends on the layout used. If no custom layout is set, it will be at
3939 * the bottom or right, depending if the box is vertical or horizontal,
3942 * @param obj The box object
3943 * @param subobj The object to add to the box
3945 * @see elm_box_pack_start()
3946 * @see elm_box_pack_before()
3947 * @see elm_box_pack_after()
3948 * @see elm_box_unpack()
3949 * @see elm_box_unpack_all()
3950 * @see elm_box_clear()
3952 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3954 * Adds an object to the box before the indicated object
3956 * This will add the @p subobj to the box indicated before the object
3957 * indicated with @p before. If @p before is not already in the box, results
3958 * are undefined. Before means either to the left of the indicated object or
3959 * above it depending on orientation.
3961 * @param obj The box object
3962 * @param subobj The object to add to the box
3963 * @param before The object before which to add it
3965 * @see elm_box_pack_start()
3966 * @see elm_box_pack_end()
3967 * @see elm_box_pack_after()
3968 * @see elm_box_unpack()
3969 * @see elm_box_unpack_all()
3970 * @see elm_box_clear()
3972 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3974 * Adds an object to the box after the indicated object
3976 * This will add the @p subobj to the box indicated after the object
3977 * indicated with @p after. If @p after is not already in the box, results
3978 * are undefined. After means either to the right of the indicated object or
3979 * below it depending on orientation.
3981 * @param obj The box object
3982 * @param subobj The object to add to the box
3983 * @param after The object after which to add it
3985 * @see elm_box_pack_start()
3986 * @see elm_box_pack_end()
3987 * @see elm_box_pack_before()
3988 * @see elm_box_unpack()
3989 * @see elm_box_unpack_all()
3990 * @see elm_box_clear()
3992 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3994 * Clear the box of all children
3996 * Remove all the elements contained by the box, deleting the respective
3999 * @param obj The box object
4001 * @see elm_box_unpack()
4002 * @see elm_box_unpack_all()
4004 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4008 * Remove the object given by @p subobj from the box @p obj without
4011 * @param obj The box object
4013 * @see elm_box_unpack_all()
4014 * @see elm_box_clear()
4016 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4018 * Remove all items from the box, without deleting them
4020 * Clear the box from all children, but don't delete the respective objects.
4021 * If no other references of the box children exist, the objects will never
4022 * be deleted, and thus the application will leak the memory. Make sure
4023 * when using this function that you hold a reference to all the objects
4024 * in the box @p obj.
4026 * @param obj The box object
4028 * @see elm_box_clear()
4029 * @see elm_box_unpack()
4031 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4033 * Retrieve a list of the objects packed into the box
4035 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
4036 * The order of the list corresponds to the packing order the box uses.
4038 * You must free this list with eina_list_free() once you are done with it.
4040 * @param obj The box object
4042 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4044 * Set the space (padding) between the box's elements.
4046 * Extra space in pixels that will be added between a box child and its
4047 * neighbors after its containing cell has been calculated. This padding
4048 * is set for all elements in the box, besides any possible padding that
4049 * individual elements may have through their size hints.
4051 * @param obj The box object
4052 * @param horizontal The horizontal space between elements
4053 * @param vertical The vertical space between elements
4055 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4057 * Get the space (padding) between the box's elements.
4059 * @param obj The box object
4060 * @param horizontal The horizontal space between elements
4061 * @param vertical The vertical space between elements
4063 * @see elm_box_padding_set()
4065 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4067 * Set the alignment of the whole bouding box of contents.
4069 * Sets how the bounding box containing all the elements of the box, after
4070 * their sizes and position has been calculated, will be aligned within
4071 * the space given for the whole box widget.
4073 * @param obj The box object
4074 * @param horizontal The horizontal alignment of elements
4075 * @param vertical The vertical alignment of elements
4077 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
4079 * Get the alignment of the whole bouding box of contents.
4081 * @param obj The box object
4082 * @param horizontal The horizontal alignment of elements
4083 * @param vertical The vertical alignment of elements
4085 * @see elm_box_align_set()
4087 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
4090 * Set the layout defining function to be used by the box
4092 * Whenever anything changes that requires the box in @p obj to recalculate
4093 * the size and position of its elements, the function @p cb will be called
4094 * to determine what the layout of the children will be.
4096 * Once a custom function is set, everything about the children layout
4097 * is defined by it. The flags set by elm_box_horizontal_set() and
4098 * elm_box_homogeneous_set() no longer have any meaning, and the values
4099 * given by elm_box_padding_set() and elm_box_align_set() are up to this
4100 * layout function to decide if they are used and how. These last two
4101 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
4102 * passed to @p cb. The @c Evas_Object the function receives is not the
4103 * Elementary widget, but the internal Evas Box it uses, so none of the
4104 * functions described here can be used on it.
4106 * Any of the layout functions in @c Evas can be used here, as well as the
4107 * special elm_box_layout_transition().
4109 * The final @p data argument received by @p cb is the same @p data passed
4110 * here, and the @p free_data function will be called to free it
4111 * whenever the box is destroyed or another layout function is set.
4113 * Setting @p cb to NULL will revert back to the default layout function.
4115 * @param obj The box object
4116 * @param cb The callback function used for layout
4117 * @param data Data that will be passed to layout function
4118 * @param free_data Function called to free @p data
4120 * @see elm_box_layout_transition()
4122 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);
4124 * Special layout function that animates the transition from one layout to another
4126 * Normally, when switching the layout function for a box, this will be
4127 * reflected immediately on screen on the next render, but it's also
4128 * possible to do this through an animated transition.
4130 * This is done by creating an ::Elm_Box_Transition and setting the box
4131 * layout to this function.
4135 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
4136 * evas_object_box_layout_vertical, // start
4137 * NULL, // data for initial layout
4138 * NULL, // free function for initial data
4139 * evas_object_box_layout_horizontal, // end
4140 * NULL, // data for final layout
4141 * NULL, // free function for final data
4142 * anim_end, // will be called when animation ends
4143 * NULL); // data for anim_end function\
4144 * elm_box_layout_set(box, elm_box_layout_transition, t,
4145 * elm_box_transition_free);
4148 * @note This function can only be used with elm_box_layout_set(). Calling
4149 * it directly will not have the expected results.
4151 * @see elm_box_transition_new
4152 * @see elm_box_transition_free
4153 * @see elm_box_layout_set
4155 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
4157 * Create a new ::Elm_Box_Transition to animate the switch of layouts
4159 * If you want to animate the change from one layout to another, you need
4160 * to set the layout function of the box to elm_box_layout_transition(),
4161 * passing as user data to it an instance of ::Elm_Box_Transition with the
4162 * necessary information to perform this animation. The free function to
4163 * set for the layout is elm_box_transition_free().
4165 * The parameters to create an ::Elm_Box_Transition sum up to how long
4166 * will it be, in seconds, a layout function to describe the initial point,
4167 * another for the final position of the children and one function to be
4168 * called when the whole animation ends. This last function is useful to
4169 * set the definitive layout for the box, usually the same as the end
4170 * layout for the animation, but could be used to start another transition.
4172 * @param start_layout The layout function that will be used to start the animation
4173 * @param start_layout_data The data to be passed the @p start_layout function
4174 * @param start_layout_free_data Function to free @p start_layout_data
4175 * @param end_layout The layout function that will be used to end the animation
4176 * @param end_layout_free_data The data to be passed the @p end_layout function
4177 * @param end_layout_free_data Function to free @p end_layout_data
4178 * @param transition_end_cb Callback function called when animation ends
4179 * @param transition_end_data Data to be passed to @p transition_end_cb
4180 * @return An instance of ::Elm_Box_Transition
4182 * @see elm_box_transition_new
4183 * @see elm_box_layout_transition
4185 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);
4187 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
4189 * This function is mostly useful as the @c free_data parameter in
4190 * elm_box_layout_set() when elm_box_layout_transition().
4192 * @param data The Elm_Box_Transition instance to be freed.
4194 * @see elm_box_transition_new
4195 * @see elm_box_layout_transition
4197 EAPI void elm_box_transition_free(void *data);
4204 * @defgroup Button Button
4206 * @image html img/widget/button/preview-00.png
4207 * @image latex img/widget/button/preview-00.eps
4208 * @image html img/widget/button/preview-01.png
4209 * @image latex img/widget/button/preview-01.eps
4210 * @image html img/widget/button/preview-02.png
4211 * @image latex img/widget/button/preview-02.eps
4213 * This is a push-button. Press it and run some function. It can contain
4214 * a simple label and icon object and it also has an autorepeat feature.
4216 * This widgets emits the following signals:
4217 * @li "clicked": the user clicked the button (press/release).
4218 * @li "repeated": the user pressed the button without releasing it.
4219 * @li "pressed": button was pressed.
4220 * @li "unpressed": button was released after being pressed.
4221 * In all three cases, the @c event parameter of the callback will be
4224 * Also, defined in the default theme, the button has the following styles
4226 * @li default: a normal button.
4227 * @li anchor: Like default, but the button fades away when the mouse is not
4228 * over it, leaving only the text or icon.
4229 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4230 * continuous look across its options.
4231 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4233 * Follow through a complete example @ref button_example_01 "here".
4237 * Add a new button to the parent's canvas
4239 * @param parent The parent object
4240 * @return The new object or NULL if it cannot be created
4242 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4244 * Set the label used in the button
4246 * The passed @p label can be NULL to clean any existing text in it and
4247 * leave the button as an icon only object.
4249 * @param obj The button object
4250 * @param label The text will be written on the button
4251 * @deprecated use elm_object_text_set() instead.
4253 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4255 * Get the label set for the button
4257 * The string returned is an internal pointer and should not be freed or
4258 * altered. It will also become invalid when the button is destroyed.
4259 * The string returned, if not NULL, is a stringshare, so if you need to
4260 * keep it around even after the button is destroyed, you can use
4261 * eina_stringshare_ref().
4263 * @param obj The button object
4264 * @return The text set to the label, or NULL if nothing is set
4265 * @deprecated use elm_object_text_set() instead.
4267 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4269 * Set the icon used for the button
4271 * Setting a new icon will delete any other that was previously set, making
4272 * any reference to them invalid. If you need to maintain the previous
4273 * object alive, unset it first with elm_button_icon_unset().
4275 * @param obj The button object
4276 * @param icon The icon object for the button
4278 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4280 * Get the icon used for the button
4282 * Return the icon object which is set for this widget. If the button is
4283 * destroyed or another icon is set, the returned object will be deleted
4284 * and any reference to it will be invalid.
4286 * @param obj The button object
4287 * @return The icon object that is being used
4289 * @see elm_button_icon_unset()
4291 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4293 * Remove the icon set without deleting it and return the object
4295 * This function drops the reference the button holds of the icon object
4296 * and returns this last object. It is used in case you want to remove any
4297 * icon, or set another one, without deleting the actual object. The button
4298 * will be left without an icon set.
4300 * @param obj The button object
4301 * @return The icon object that was being used
4303 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4305 * Turn on/off the autorepeat event generated when the button is kept pressed
4307 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4308 * signal when they are clicked.
4310 * When on, keeping a button pressed will continuously emit a @c repeated
4311 * signal until the button is released. The time it takes until it starts
4312 * emitting the signal is given by
4313 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4314 * new emission by elm_button_autorepeat_gap_timeout_set().
4316 * @param obj The button object
4317 * @param on A bool to turn on/off the event
4319 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4321 * Get whether the autorepeat feature is enabled
4323 * @param obj The button object
4324 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4326 * @see elm_button_autorepeat_set()
4328 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 * Set the initial timeout before the autorepeat event is generated
4332 * Sets the timeout, in seconds, since the button is pressed until the
4333 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4334 * won't be any delay and the even will be fired the moment the button is
4337 * @param obj The button object
4338 * @param t Timeout in seconds
4340 * @see elm_button_autorepeat_set()
4341 * @see elm_button_autorepeat_gap_timeout_set()
4343 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4345 * Get the initial timeout before the autorepeat event is generated
4347 * @param obj The button object
4348 * @return Timeout in seconds
4350 * @see elm_button_autorepeat_initial_timeout_set()
4352 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354 * Set the interval between each generated autorepeat event
4356 * After the first @c repeated event is fired, all subsequent ones will
4357 * follow after a delay of @p t seconds for each.
4359 * @param obj The button object
4360 * @param t Interval in seconds
4362 * @see elm_button_autorepeat_initial_timeout_set()
4364 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4366 * Get the interval between each generated autorepeat event
4368 * @param obj The button object
4369 * @return Interval in seconds
4371 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4377 * @defgroup File_Selector_Button File Selector Button
4379 * @image html img/widget/fileselector_button/preview-00.png
4380 * @image latex img/widget/fileselector_button/preview-00.eps
4381 * @image html img/widget/fileselector_button/preview-01.png
4382 * @image latex img/widget/fileselector_button/preview-01.eps
4383 * @image html img/widget/fileselector_button/preview-02.png
4384 * @image latex img/widget/fileselector_button/preview-02.eps
4386 * This is a button that, when clicked, creates an Elementary
4387 * window (or inner window) <b> with a @ref Fileselector "file
4388 * selector widget" within</b>. When a file is chosen, the (inner)
4389 * window is closed and the button emits a signal having the
4390 * selected file as it's @c event_info.
4392 * This widget encapsulates operations on its internal file
4393 * selector on its own API. There is less control over its file
4394 * selector than that one would have instatiating one directly.
4396 * The following styles are available for this button:
4399 * @li @c "hoversel_vertical"
4400 * @li @c "hoversel_vertical_entry"
4402 * Smart callbacks one can register to:
4403 * - @c "file,chosen" - the user has selected a path, whose string
4404 * pointer comes as the @c event_info data (a stringshared
4407 * Here is an example on its usage:
4408 * @li @ref fileselector_button_example
4410 * @see @ref File_Selector_Entry for a similar widget.
4415 * Add a new file selector button widget to the given parent
4416 * Elementary (container) object
4418 * @param parent The parent object
4419 * @return a new file selector button widget handle or @c NULL, on
4422 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4425 * Set the label for a given file selector button widget
4427 * @param obj The file selector button widget
4428 * @param label The text label to be displayed on @p obj
4430 * @deprecated use elm_object_text_set() instead.
4432 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4435 * Get the label set for a given file selector button widget
4437 * @param obj The file selector button widget
4438 * @return The button label
4440 * @deprecated use elm_object_text_set() instead.
4442 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4445 * Set the icon on a given file selector button widget
4447 * @param obj The file selector button widget
4448 * @param icon The icon object for the button
4450 * Once the icon object is set, a previously set one will be
4451 * deleted. If you want to keep the latter, use the
4452 * elm_fileselector_button_icon_unset() function.
4454 * @see elm_fileselector_button_icon_get()
4456 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4459 * Get the icon set for a given file selector button widget
4461 * @param obj The file selector button widget
4462 * @return The icon object currently set on @p obj or @c NULL, if
4465 * @see elm_fileselector_button_icon_set()
4467 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4470 * Unset the icon used in a given file selector button widget
4472 * @param obj The file selector button widget
4473 * @return The icon object that was being used on @p obj or @c
4476 * Unparent and return the icon object which was set for this
4479 * @see elm_fileselector_button_icon_set()
4481 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4484 * Set the title for a given file selector button widget's window
4486 * @param obj The file selector button widget
4487 * @param title The title string
4489 * This will change the window's title, when the file selector pops
4490 * out after a click on the button. Those windows have the default
4491 * (unlocalized) value of @c "Select a file" as titles.
4493 * @note It will only take any effect if the file selector
4494 * button widget is @b not under "inwin mode".
4496 * @see elm_fileselector_button_window_title_get()
4498 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4501 * Get the title set for a given file selector button widget's
4504 * @param obj The file selector button widget
4505 * @return Title of the file selector button's window
4507 * @see elm_fileselector_button_window_title_get() for more details
4509 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4512 * Set the size of a given file selector button widget's window,
4513 * holding the file selector itself.
4515 * @param obj The file selector button widget
4516 * @param width The window's width
4517 * @param height The window's height
4519 * @note it will only take any effect if the file selector button
4520 * widget is @b not under "inwin mode". The default size for the
4521 * window (when applicable) is 400x400 pixels.
4523 * @see elm_fileselector_button_window_size_get()
4525 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4528 * Get the size of a given file selector button widget's window,
4529 * holding the file selector itself.
4531 * @param obj The file selector button widget
4532 * @param width Pointer into which to store the width value
4533 * @param height Pointer into which to store the height value
4535 * @note Use @c NULL pointers on the size values you're not
4536 * interested in: they'll be ignored by the function.
4538 * @see elm_fileselector_button_window_size_set(), for more details
4540 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4543 * Set the initial file system path for a given file selector
4546 * @param obj The file selector button widget
4547 * @param path The path string
4549 * It must be a <b>directory</b> path, which will have the contents
4550 * displayed initially in the file selector's view, when invoked
4551 * from @p obj. The default initial path is the @c "HOME"
4552 * environment variable's value.
4554 * @see elm_fileselector_button_path_get()
4556 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4559 * Get the initial file system path set for a given file selector
4562 * @param obj The file selector button widget
4563 * @return path The path string
4565 * @see elm_fileselector_button_path_set() for more details
4567 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4570 * Enable/disable a tree view in the given file selector button
4571 * widget's internal file selector
4573 * @param obj The file selector button widget
4574 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4577 * This has the same effect as elm_fileselector_expandable_set(),
4578 * but now applied to a file selector button's internal file
4581 * @note There's no way to put a file selector button's internal
4582 * file selector in "grid mode", as one may do with "pure" file
4585 * @see elm_fileselector_expandable_get()
4587 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4590 * Get whether tree view is enabled for the given file selector
4591 * button widget's internal file selector
4593 * @param obj The file selector button widget
4594 * @return @c EINA_TRUE if @p obj widget's internal file selector
4595 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4597 * @see elm_fileselector_expandable_set() for more details
4599 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4602 * Set whether a given file selector button widget's internal file
4603 * selector is to display folders only or the directory contents,
4606 * @param obj The file selector button widget
4607 * @param only @c EINA_TRUE to make @p obj widget's internal file
4608 * selector only display directories, @c EINA_FALSE to make files
4609 * to be displayed in it too
4611 * This has the same effect as elm_fileselector_folder_only_set(),
4612 * but now applied to a file selector button's internal file
4615 * @see elm_fileselector_folder_only_get()
4617 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4620 * Get whether a given file selector button widget's internal file
4621 * selector is displaying folders only or the directory contents,
4624 * @param obj The file selector button widget
4625 * @return @c EINA_TRUE if @p obj widget's internal file
4626 * selector is only displaying directories, @c EINA_FALSE if files
4627 * are being displayed in it too (and on errors)
4629 * @see elm_fileselector_button_folder_only_set() for more details
4631 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4634 * Enable/disable the file name entry box where the user can type
4635 * in a name for a file, in a given file selector button widget's
4636 * internal file selector.
4638 * @param obj The file selector button widget
4639 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4640 * file selector a "saving dialog", @c EINA_FALSE otherwise
4642 * This has the same effect as elm_fileselector_is_save_set(),
4643 * but now applied to a file selector button's internal file
4646 * @see elm_fileselector_is_save_get()
4648 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4651 * Get whether the given file selector button widget's internal
4652 * file selector is in "saving dialog" mode
4654 * @param obj The file selector button widget
4655 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4656 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4659 * @see elm_fileselector_button_is_save_set() for more details
4661 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4664 * Set whether a given file selector button widget's internal file
4665 * selector will raise an Elementary "inner window", instead of a
4666 * dedicated Elementary window. By default, it won't.
4668 * @param obj The file selector button widget
4669 * @param value @c EINA_TRUE to make it use an inner window, @c
4670 * EINA_TRUE to make it use a dedicated window
4672 * @see elm_win_inwin_add() for more information on inner windows
4673 * @see elm_fileselector_button_inwin_mode_get()
4675 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4678 * Get whether a given file selector button widget's internal file
4679 * selector will raise an Elementary "inner window", instead of a
4680 * dedicated Elementary window.
4682 * @param obj The file selector button widget
4683 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4684 * if it will use a dedicated window
4686 * @see elm_fileselector_button_inwin_mode_set() for more details
4688 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4695 * @defgroup File_Selector_Entry File Selector Entry
4697 * @image html img/widget/fileselector_entry/preview-00.png
4698 * @image latex img/widget/fileselector_entry/preview-00.eps
4700 * This is an entry made to be filled with or display a <b>file
4701 * system path string</b>. Besides the entry itself, the widget has
4702 * a @ref File_Selector_Button "file selector button" on its side,
4703 * which will raise an internal @ref Fileselector "file selector widget",
4704 * when clicked, for path selection aided by file system
4707 * This file selector may appear in an Elementary window or in an
4708 * inner window. When a file is chosen from it, the (inner) window
4709 * is closed and the selected file's path string is exposed both as
4710 * an smart event and as the new text on the entry.
4712 * This widget encapsulates operations on its internal file
4713 * selector on its own API. There is less control over its file
4714 * selector than that one would have instatiating one directly.
4716 * Smart callbacks one can register to:
4717 * - @c "changed" - The text within the entry was changed
4718 * - @c "activated" - The entry has had editing finished and
4719 * changes are to be "committed"
4720 * - @c "press" - The entry has been clicked
4721 * - @c "longpressed" - The entry has been clicked (and held) for a
4723 * - @c "clicked" - The entry has been clicked
4724 * - @c "clicked,double" - The entry has been double clicked
4725 * - @c "focused" - The entry has received focus
4726 * - @c "unfocused" - The entry has lost focus
4727 * - @c "selection,paste" - A paste action has occurred on the
4729 * - @c "selection,copy" - A copy action has occurred on the entry
4730 * - @c "selection,cut" - A cut action has occurred on the entry
4731 * - @c "unpressed" - The file selector entry's button was released
4732 * after being pressed.
4733 * - @c "file,chosen" - The user has selected a path via the file
4734 * selector entry's internal file selector, whose string pointer
4735 * comes as the @c event_info data (a stringshared string)
4737 * Here is an example on its usage:
4738 * @li @ref fileselector_entry_example
4740 * @see @ref File_Selector_Button for a similar widget.
4745 * Add a new file selector entry widget to the given parent
4746 * Elementary (container) object
4748 * @param parent The parent object
4749 * @return a new file selector entry widget handle or @c NULL, on
4752 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4755 * Set the label for a given file selector entry widget's button
4757 * @param obj The file selector entry widget
4758 * @param label The text label to be displayed on @p obj widget's
4761 * @deprecated use elm_object_text_set() instead.
4763 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4766 * Get the label set for a given file selector entry widget's button
4768 * @param obj The file selector entry widget
4769 * @return The widget button's label
4771 * @deprecated use elm_object_text_set() instead.
4773 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4776 * Set the icon on a given file selector entry widget's button
4778 * @param obj The file selector entry widget
4779 * @param icon The icon object for the entry's button
4781 * Once the icon object is set, a previously set one will be
4782 * deleted. If you want to keep the latter, use the
4783 * elm_fileselector_entry_button_icon_unset() function.
4785 * @see elm_fileselector_entry_button_icon_get()
4787 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4790 * Get the icon set for a given file selector entry widget's button
4792 * @param obj The file selector entry widget
4793 * @return The icon object currently set on @p obj widget's button
4794 * or @c NULL, if none is
4796 * @see elm_fileselector_entry_button_icon_set()
4798 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4801 * Unset the icon used in a given file selector entry widget's
4804 * @param obj The file selector entry widget
4805 * @return The icon object that was being used on @p obj widget's
4806 * button or @c NULL, on errors
4808 * Unparent and return the icon object which was set for this
4811 * @see elm_fileselector_entry_button_icon_set()
4813 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4816 * Set the title for a given file selector entry widget's window
4818 * @param obj The file selector entry widget
4819 * @param title The title string
4821 * This will change the window's title, when the file selector pops
4822 * out after a click on the entry's button. Those windows have the
4823 * default (unlocalized) value of @c "Select a file" as titles.
4825 * @note It will only take any effect if the file selector
4826 * entry widget is @b not under "inwin mode".
4828 * @see elm_fileselector_entry_window_title_get()
4830 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4833 * Get the title set for a given file selector entry widget's
4836 * @param obj The file selector entry widget
4837 * @return Title of the file selector entry's window
4839 * @see elm_fileselector_entry_window_title_get() for more details
4841 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4844 * Set the size of a given file selector entry widget's window,
4845 * holding the file selector itself.
4847 * @param obj The file selector entry widget
4848 * @param width The window's width
4849 * @param height The window's height
4851 * @note it will only take any effect if the file selector entry
4852 * widget is @b not under "inwin mode". The default size for the
4853 * window (when applicable) is 400x400 pixels.
4855 * @see elm_fileselector_entry_window_size_get()
4857 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4860 * Get the size of a given file selector entry widget's window,
4861 * holding the file selector itself.
4863 * @param obj The file selector entry widget
4864 * @param width Pointer into which to store the width value
4865 * @param height Pointer into which to store the height value
4867 * @note Use @c NULL pointers on the size values you're not
4868 * interested in: they'll be ignored by the function.
4870 * @see elm_fileselector_entry_window_size_set(), for more details
4872 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4875 * Set the initial file system path and the entry's path string for
4876 * a given file selector entry widget
4878 * @param obj The file selector entry widget
4879 * @param path The path string
4881 * It must be a <b>directory</b> path, which will have the contents
4882 * displayed initially in the file selector's view, when invoked
4883 * from @p obj. The default initial path is the @c "HOME"
4884 * environment variable's value.
4886 * @see elm_fileselector_entry_path_get()
4888 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4891 * Get the entry's path string for a given file selector entry
4894 * @param obj The file selector entry widget
4895 * @return path The path string
4897 * @see elm_fileselector_entry_path_set() for more details
4899 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4902 * Enable/disable a tree view in the given file selector entry
4903 * widget's internal file selector
4905 * @param obj The file selector entry widget
4906 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4909 * This has the same effect as elm_fileselector_expandable_set(),
4910 * but now applied to a file selector entry's internal file
4913 * @note There's no way to put a file selector entry's internal
4914 * file selector in "grid mode", as one may do with "pure" file
4917 * @see elm_fileselector_expandable_get()
4919 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4922 * Get whether tree view is enabled for the given file selector
4923 * entry widget's internal file selector
4925 * @param obj The file selector entry widget
4926 * @return @c EINA_TRUE if @p obj widget's internal file selector
4927 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4929 * @see elm_fileselector_expandable_set() for more details
4931 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4934 * Set whether a given file selector entry widget's internal file
4935 * selector is to display folders only or the directory contents,
4938 * @param obj The file selector entry widget
4939 * @param only @c EINA_TRUE to make @p obj widget's internal file
4940 * selector only display directories, @c EINA_FALSE to make files
4941 * to be displayed in it too
4943 * This has the same effect as elm_fileselector_folder_only_set(),
4944 * but now applied to a file selector entry's internal file
4947 * @see elm_fileselector_folder_only_get()
4949 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4952 * Get whether a given file selector entry widget's internal file
4953 * selector is displaying folders only or the directory contents,
4956 * @param obj The file selector entry widget
4957 * @return @c EINA_TRUE if @p obj widget's internal file
4958 * selector is only displaying directories, @c EINA_FALSE if files
4959 * are being displayed in it too (and on errors)
4961 * @see elm_fileselector_entry_folder_only_set() for more details
4963 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4966 * Enable/disable the file name entry box where the user can type
4967 * in a name for a file, in a given file selector entry widget's
4968 * internal file selector.
4970 * @param obj The file selector entry widget
4971 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4972 * file selector a "saving dialog", @c EINA_FALSE otherwise
4974 * This has the same effect as elm_fileselector_is_save_set(),
4975 * but now applied to a file selector entry's internal file
4978 * @see elm_fileselector_is_save_get()
4980 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4983 * Get whether the given file selector entry widget's internal
4984 * file selector is in "saving dialog" mode
4986 * @param obj The file selector entry widget
4987 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4988 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4991 * @see elm_fileselector_entry_is_save_set() for more details
4993 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4996 * Set whether a given file selector entry widget's internal file
4997 * selector will raise an Elementary "inner window", instead of a
4998 * dedicated Elementary window. By default, it won't.
5000 * @param obj The file selector entry widget
5001 * @param value @c EINA_TRUE to make it use an inner window, @c
5002 * EINA_TRUE to make it use a dedicated window
5004 * @see elm_win_inwin_add() for more information on inner windows
5005 * @see elm_fileselector_entry_inwin_mode_get()
5007 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5010 * Get whether a given file selector entry widget's internal file
5011 * selector will raise an Elementary "inner window", instead of a
5012 * dedicated Elementary window.
5014 * @param obj The file selector entry widget
5015 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
5016 * if it will use a dedicated window
5018 * @see elm_fileselector_entry_inwin_mode_set() for more details
5020 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5023 * Set the initial file system path for a given file selector entry
5026 * @param obj The file selector entry widget
5027 * @param path The path string
5029 * It must be a <b>directory</b> path, which will have the contents
5030 * displayed initially in the file selector's view, when invoked
5031 * from @p obj. The default initial path is the @c "HOME"
5032 * environment variable's value.
5034 * @see elm_fileselector_entry_path_get()
5036 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5039 * Get the parent directory's path to the latest file selection on
5040 * a given filer selector entry widget
5042 * @param obj The file selector object
5043 * @return The (full) path of the directory of the last selection
5044 * on @p obj widget, a @b stringshared string
5046 * @see elm_fileselector_entry_path_set()
5048 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5055 * @defgroup Scroller Scroller
5057 * A scroller holds a single object and "scrolls it around". This means that
5058 * it allows the user to use a scrollbar (or a finger) to drag the viewable
5059 * region around, allowing to move through a much larger object that is
5060 * contained in the scroller. The scroiller will always have a small minimum
5061 * size by default as it won't be limited by the contents of the scroller.
5063 * Signals that you can add callbacks for are:
5064 * @li "edge,left" - the left edge of the content has been reached
5065 * @li "edge,right" - the right edge of the content has been reached
5066 * @li "edge,top" - the top edge of the content has been reached
5067 * @li "edge,bottom" - the bottom edge of the content has been reached
5068 * @li "scroll" - the content has been scrolled (moved)
5069 * @li "scroll,anim,start" - scrolling animation has started
5070 * @li "scroll,anim,stop" - scrolling animation has stopped
5071 * @li "scroll,drag,start" - dragging the contents around has started
5072 * @li "scroll,drag,stop" - dragging the contents around has stopped
5073 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
5076 * @note When Elemementary is in embedded mode the scrollbars will not be
5077 * dragable, they appear merely as indicators of how much has been scrolled.
5078 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
5079 * fingerscroll) won't work.
5081 * In @ref tutorial_scroller you'll find an example of how to use most of
5086 * @brief Type that controls when scrollbars should appear.
5088 * @see elm_scroller_policy_set()
5090 typedef enum _Elm_Scroller_Policy
5092 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
5093 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
5094 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
5095 ELM_SCROLLER_POLICY_LAST
5096 } Elm_Scroller_Policy;
5098 * @brief Add a new scroller to the parent
5100 * @param parent The parent object
5101 * @return The new object or NULL if it cannot be created
5103 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5105 * @brief Set the content of the scroller widget (the object to be scrolled around).
5107 * @param obj The scroller object
5108 * @param content The new content object
5110 * Once the content object is set, a previously set one will be deleted.
5111 * If you want to keep that old content object, use the
5112 * elm_scroller_content_unset() function.
5114 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
5116 * @brief Get the content of the scroller widget
5118 * @param obj The slider object
5119 * @return The content that is being used
5121 * Return the content object which is set for this widget
5123 * @see elm_scroller_content_set()
5125 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5127 * @brief Unset the content of the scroller widget
5129 * @param obj The slider object
5130 * @return The content that was being used
5132 * Unparent and return the content object which was set for this widget
5134 * @see elm_scroller_content_set()
5136 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5138 * @brief Set custom theme elements for the scroller
5140 * @param obj The scroller object
5141 * @param widget The widget name to use (default is "scroller")
5142 * @param base The base name to use (default is "base")
5144 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
5146 * @brief Make the scroller minimum size limited to the minimum size of the content
5148 * @param obj The scroller object
5149 * @param w Enable limiting minimum size horizontally
5150 * @param h Enable limiting minimum size vertically
5152 * By default the scroller will be as small as its design allows,
5153 * irrespective of its content. This will make the scroller minimum size the
5154 * right size horizontally and/or vertically to perfectly fit its content in
5157 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
5159 * @brief Show a specific virtual region within the scroller content object
5161 * @param obj The scroller object
5162 * @param x X coordinate of the region
5163 * @param y Y coordinate of the region
5164 * @param w Width of the region
5165 * @param h Height of the region
5167 * This will ensure all (or part if it does not fit) of the designated
5168 * region in the virtual content object (0, 0 starting at the top-left of the
5169 * virtual content object) is shown within the scroller.
5171 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);
5173 * @brief Set the scrollbar visibility policy
5175 * @param obj The scroller object
5176 * @param policy_h Horizontal scrollbar policy
5177 * @param policy_v Vertical scrollbar policy
5179 * This sets the scrollbar visibility policy for the given scroller.
5180 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
5181 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
5182 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
5183 * respectively for the horizontal and vertical scrollbars.
5185 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5187 * @brief Gets scrollbar visibility policy
5189 * @param obj The scroller object
5190 * @param policy_h Horizontal scrollbar policy
5191 * @param policy_v Vertical scrollbar policy
5193 * @see elm_scroller_policy_set()
5195 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
5197 * @brief Get the currently visible content region
5199 * @param obj The scroller object
5200 * @param x X coordinate of the region
5201 * @param y Y coordinate of the region
5202 * @param w Width of the region
5203 * @param h Height of the region
5205 * This gets the current region in the content object that is visible through
5206 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
5207 * w, @p h values pointed to.
5209 * @note All coordinates are relative to the content.
5211 * @see elm_scroller_region_show()
5213 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);
5215 * @brief Get the size of the content object
5217 * @param obj The scroller object
5218 * @param w Width return
5219 * @param h Height return
5221 * This gets the size of the content object of the scroller.
5223 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5225 * @brief Set bouncing behavior
5227 * @param obj The scroller object
5228 * @param h_bounce Will the scroller bounce horizontally or not
5229 * @param v_bounce Will the scroller bounce vertically or not
5231 * When scrolling, the scroller may "bounce" when reaching an edge of the
5232 * content object. This is a visual way to indicate the end has been reached.
5233 * This is enabled by default for both axis. This will set if it is enabled
5234 * for that axis with the boolean parameters for each axis.
5236 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5238 * @brief Get the bounce mode
5240 * @param obj The Scroller object
5241 * @param h_bounce Allow bounce horizontally
5242 * @param v_bounce Allow bounce vertically
5244 * @see elm_scroller_bounce_set()
5246 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5248 * @brief Set scroll page size relative to viewport size.
5250 * @param obj The scroller object
5251 * @param h_pagerel The horizontal page relative size
5252 * @param v_pagerel The vertical page relative size
5254 * The scroller is capable of limiting scrolling by the user to "pages". That
5255 * is to jump by and only show a "whole page" at a time as if the continuous
5256 * area of the scroller content is split into page sized pieces. This sets
5257 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5258 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5259 * axis. This is mutually exclusive with page size
5260 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5261 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5262 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5265 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5267 * @brief Set scroll page size.
5269 * @param obj The scroller object
5270 * @param h_pagesize The horizontal page size
5271 * @param v_pagesize The vertical page size
5273 * This sets the page size to an absolute fixed value, with 0 turning it off
5276 * @see elm_scroller_page_relative_set()
5278 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5280 * @brief Show a specific virtual region within the scroller content object.
5282 * @param obj The scroller object
5283 * @param x X coordinate of the region
5284 * @param y Y coordinate of the region
5285 * @param w Width of the region
5286 * @param h Height of the region
5288 * This will ensure all (or part if it does not fit) of the designated
5289 * region in the virtual content object (0, 0 starting at the top-left of the
5290 * virtual content object) is shown within the scroller. Unlike
5291 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5292 * to this location (if configuration in general calls for transitions). It
5293 * may not jump immediately to the new location and make take a while and
5294 * show other content along the way.
5296 * @see elm_scroller_region_show()
5298 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);
5300 * @brief Set event propagation on a scroller
5302 * @param obj The scroller object
5303 * @param propagation If propagation is enabled or not
5305 * This enables or disabled event propagation from the scroller content to
5306 * the scroller and its parent. By default event propagation is disabled.
5308 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5310 * @brief Get event propagation for a scroller
5312 * @param obj The scroller object
5313 * @return The propagation state
5315 * This gets the event propagation for a scroller.
5317 * @see elm_scroller_propagate_events_set()
5319 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5325 * @defgroup Label Label
5327 * @image html img/widget/label/preview-00.png
5328 * @image latex img/widget/label/preview-00.eps
5330 * @brief Widget to display text, with simple html-like markup.
5332 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5333 * text doesn't fit the geometry of the label it will be ellipsized or be
5334 * cut. Elementary provides several themes for this widget:
5335 * @li default - No animation
5336 * @li marker - Centers the text in the label and make it bold by default
5337 * @li slide_long - The entire text appears from the right of the screen and
5338 * slides until it disappears in the left of the screen(reappering on the
5340 * @li slide_short - The text appears in the left of the label and slides to
5341 * the right to show the overflow. When all of the text has been shown the
5342 * position is reset.
5343 * @li slide_bounce - The text appears in the left of the label and slides to
5344 * the right to show the overflow. When all of the text has been shown the
5345 * animation reverses, moving the text to the left.
5347 * Custom themes can of course invent new markup tags and style them any way
5350 * See @ref tutorial_label for a demonstration of how to use a label widget.
5354 * @brief Add a new label to the parent
5356 * @param parent The parent object
5357 * @return The new object or NULL if it cannot be created
5359 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5361 * @brief Set the label on the label object
5363 * @param obj The label object
5364 * @param label The label will be used on the label object
5365 * @deprecated See elm_object_text_set()
5367 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 */
5369 * @brief Get the label used on the label object
5371 * @param obj The label object
5372 * @return The string inside the label
5373 * @deprecated See elm_object_text_get()
5375 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5377 * @brief Set the wrapping behavior of the label
5379 * @param obj The label object
5380 * @param wrap To wrap text or not
5382 * By default no wrapping is done. Possible values for @p wrap are:
5383 * @li ELM_WRAP_NONE - No wrapping
5384 * @li ELM_WRAP_CHAR - wrap between characters
5385 * @li ELM_WRAP_WORD - wrap between words
5386 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5388 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5390 * @brief Get the wrapping behavior of the label
5392 * @param obj The label object
5395 * @see elm_label_line_wrap_set()
5397 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5399 * @brief Set wrap width of the label
5401 * @param obj The label object
5402 * @param w The wrap width in pixels at a minimum where words need to wrap
5404 * This function sets the maximum width size hint of the label.
5406 * @warning This is only relevant if the label is inside a container.
5408 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5410 * @brief Get wrap width of the label
5412 * @param obj The label object
5413 * @return The wrap width in pixels at a minimum where words need to wrap
5415 * @see elm_label_wrap_width_set()
5417 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5419 * @brief Set wrap height of the label
5421 * @param obj The label object
5422 * @param h The wrap height in pixels at a minimum where words need to wrap
5424 * This function sets the maximum height size hint of the label.
5426 * @warning This is only relevant if the label is inside a container.
5428 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5430 * @brief get wrap width of the label
5432 * @param obj The label object
5433 * @return The wrap height in pixels at a minimum where words need to wrap
5435 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5437 * @brief Set the font size on the label object.
5439 * @param obj The label object
5440 * @param size font size
5442 * @warning NEVER use this. It is for hyper-special cases only. use styles
5443 * instead. e.g. "big", "medium", "small" - or better name them by use:
5444 * "title", "footnote", "quote" etc.
5446 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5448 * @brief Set the text color on the label object
5450 * @param obj The label object
5451 * @param r Red property background color of The label object
5452 * @param g Green property background color of The label object
5453 * @param b Blue property background color of The label object
5454 * @param a Alpha property background color of The label object
5456 * @warning NEVER use this. It is for hyper-special cases only. use styles
5457 * instead. e.g. "big", "medium", "small" - or better name them by use:
5458 * "title", "footnote", "quote" etc.
5460 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);
5462 * @brief Set the text align on the label object
5464 * @param obj The label object
5465 * @param align align mode ("left", "center", "right")
5467 * @warning NEVER use this. It is for hyper-special cases only. use styles
5468 * instead. e.g. "big", "medium", "small" - or better name them by use:
5469 * "title", "footnote", "quote" etc.
5471 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5473 * @brief Set background color of the label
5475 * @param obj The label object
5476 * @param r Red property background color of The label object
5477 * @param g Green property background color of The label object
5478 * @param b Blue property background color of The label object
5479 * @param a Alpha property background alpha of The label object
5481 * @warning NEVER use this. It is for hyper-special cases only. use styles
5482 * instead. e.g. "big", "medium", "small" - or better name them by use:
5483 * "title", "footnote", "quote" etc.
5485 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);
5487 * @brief Set the ellipsis behavior of the label
5489 * @param obj The label object
5490 * @param ellipsis To ellipsis text or not
5492 * If set to true and the text doesn't fit in the label an ellipsis("...")
5493 * will be shown at the end of the widget.
5495 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5496 * choosen wrap method was ELM_WRAP_WORD.
5498 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5500 * @brief Set the text slide of the label
5502 * @param obj The label object
5503 * @param slide To start slide or stop
5505 * If set to true the text of the label will slide throught the length of
5508 * @warning This only work with the themes "slide_short", "slide_long" and
5511 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5513 * @brief Get the text slide mode of the label
5515 * @param obj The label object
5516 * @return slide slide mode value
5518 * @see elm_label_slide_set()
5520 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5522 * @brief Set the slide duration(speed) of the label
5524 * @param obj The label object
5525 * @return The duration in seconds in moving text from slide begin position
5526 * to slide end position
5528 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5530 * @brief Get the slide duration(speed) of the label
5532 * @param obj The label object
5533 * @return The duration time in moving text from slide begin position to slide end position
5535 * @see elm_label_slide_duration_set()
5537 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5543 * @defgroup Toggle Toggle
5545 * @image html img/widget/toggle/preview-00.png
5546 * @image latex img/widget/toggle/preview-00.eps
5548 * @brief A toggle is a slider which can be used to toggle between
5549 * two values. It has two states: on and off.
5551 * Signals that you can add callbacks for are:
5552 * @li "changed" - Whenever the toggle value has been changed. Is not called
5553 * until the toggle is released by the cursor (assuming it
5554 * has been triggered by the cursor in the first place).
5556 * @ref tutorial_toggle show how to use a toggle.
5560 * @brief Add a toggle to @p parent.
5562 * @param parent The parent object
5564 * @return The toggle object
5566 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5568 * @brief Sets the label to be displayed with the toggle.
5570 * @param obj The toggle object
5571 * @param label The label to be displayed
5573 * @deprecated use elm_object_text_set() instead.
5575 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5577 * @brief Gets the label of the toggle
5579 * @param obj toggle object
5580 * @return The label of the toggle
5582 * @deprecated use elm_object_text_get() instead.
5584 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5586 * @brief Set the icon used for the toggle
5588 * @param obj The toggle object
5589 * @param icon The icon object for the button
5591 * Once the icon object is set, a previously set one will be deleted
5592 * If you want to keep that old content object, use the
5593 * elm_toggle_icon_unset() function.
5595 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5597 * @brief Get the icon used for the toggle
5599 * @param obj The toggle object
5600 * @return The icon object that is being used
5602 * Return the icon object which is set for this widget.
5604 * @see elm_toggle_icon_set()
5606 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5608 * @brief Unset the icon used for the toggle
5610 * @param obj The toggle object
5611 * @return The icon object that was being used
5613 * Unparent and return the icon object which was set for this widget.
5615 * @see elm_toggle_icon_set()
5617 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5619 * @brief Sets the labels to be associated with the on and off states of the toggle.
5621 * @param obj The toggle object
5622 * @param onlabel The label displayed when the toggle is in the "on" state
5623 * @param offlabel The label displayed when the toggle is in the "off" state
5625 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5627 * @brief Gets the labels associated with the on and off states of the toggle.
5629 * @param obj The toggle object
5630 * @param onlabel A char** to place the onlabel of @p obj into
5631 * @param offlabel A char** to place the offlabel of @p obj into
5633 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5635 * @brief Sets the state of the toggle to @p state.
5637 * @param obj The toggle object
5638 * @param state The state of @p obj
5640 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5642 * @brief Gets the state of the toggle to @p state.
5644 * @param obj The toggle object
5645 * @return The state of @p obj
5647 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5649 * @brief Sets the state pointer of the toggle to @p statep.
5651 * @param obj The toggle object
5652 * @param statep The state pointer of @p obj
5654 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5660 * @defgroup Frame Frame
5662 * @image html img/widget/frame/preview-00.png
5663 * @image latex img/widget/frame/preview-00.eps
5665 * @brief Frame is a widget that holds some content and has a title.
5667 * The default look is a frame with a title, but Frame supports multple
5675 * @li outdent_bottom
5677 * Of all this styles only default shows the title. Frame emits no signals.
5679 * For a detailed example see the @ref tutorial_frame.
5684 * @brief Add a new frame to the parent
5686 * @param parent The parent object
5687 * @return The new object or NULL if it cannot be created
5689 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5691 * @brief Set the frame label
5693 * @param obj The frame object
5694 * @param label The label of this frame object
5696 * @deprecated use elm_object_text_set() instead.
5698 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5700 * @brief Get the frame label
5702 * @param obj The frame object
5704 * @return The label of this frame objet or NULL if unable to get frame
5706 * @deprecated use elm_object_text_get() instead.
5708 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5710 * @brief Set the content of the frame widget
5712 * Once the content object is set, a previously set one will be deleted.
5713 * If you want to keep that old content object, use the
5714 * elm_frame_content_unset() function.
5716 * @param obj The frame object
5717 * @param content The content will be filled in this frame object
5719 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5721 * @brief Get the content of the frame widget
5723 * Return the content object which is set for this widget
5725 * @param obj The frame object
5726 * @return The content that is being used
5728 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5730 * @brief Unset the content of the frame widget
5732 * Unparent and return the content object which was set for this widget
5734 * @param obj The frame object
5735 * @return The content that was being used
5737 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5743 * @defgroup Table Table
5745 * A container widget to arrange other widgets in a table where items can
5746 * also span multiple columns or rows - even overlap (and then be raised or
5747 * lowered accordingly to adjust stacking if they do overlap).
5749 * The followin are examples of how to use a table:
5750 * @li @ref tutorial_table_01
5751 * @li @ref tutorial_table_02
5756 * @brief Add a new table to the parent
5758 * @param parent The parent object
5759 * @return The new object or NULL if it cannot be created
5761 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5763 * @brief Set the homogeneous layout in the table
5765 * @param obj The layout object
5766 * @param homogeneous A boolean to set if the layout is homogeneous in the
5767 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5769 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5771 * @brief Get the current table homogeneous mode.
5773 * @param obj The table object
5774 * @return A boolean to indicating if the layout is homogeneous in the table
5775 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5777 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5779 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5781 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5783 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5785 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5787 * @brief Set padding between cells.
5789 * @param obj The layout object.
5790 * @param horizontal set the horizontal padding.
5791 * @param vertical set the vertical padding.
5793 * Default value is 0.
5795 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5797 * @brief Get padding between cells.
5799 * @param obj The layout object.
5800 * @param horizontal set the horizontal padding.
5801 * @param vertical set the vertical padding.
5803 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5805 * @brief Add a subobject on the table with the coordinates passed
5807 * @param obj The table object
5808 * @param subobj The subobject to be added to the table
5809 * @param x Row number
5810 * @param y Column number
5814 * @note All positioning inside the table is relative to rows and columns, so
5815 * a value of 0 for x and y, means the top left cell of the table, and a
5816 * value of 1 for w and h means @p subobj only takes that 1 cell.
5818 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5820 * @brief Remove child from table.
5822 * @param obj The table object
5823 * @param subobj The subobject
5825 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5827 * @brief Faster way to remove all child objects from a table object.
5829 * @param obj The table object
5830 * @param clear If true, will delete children, else just remove from table.
5832 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5834 * @brief Set the packing location of an existing child of the table
5836 * @param subobj The subobject to be modified in the table
5837 * @param x Row number
5838 * @param y Column number
5842 * Modifies the position of an object already in the table.
5844 * @note All positioning inside the table is relative to rows and columns, so
5845 * a value of 0 for x and y, means the top left cell of the table, and a
5846 * value of 1 for w and h means @p subobj only takes that 1 cell.
5848 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5850 * @brief Get the packing location of an existing child of the table
5852 * @param subobj The subobject to be modified in the table
5853 * @param x Row number
5854 * @param y Column number
5858 * @see elm_table_pack_set()
5860 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5866 * @defgroup Gengrid Gengrid (Generic grid)
5868 * This widget aims to position objects in a grid layout while
5869 * actually creating and rendering only the visible ones, using the
5870 * same idea as the @ref Genlist "genlist": the user defines a @b
5871 * class for each item, specifying functions that will be called at
5872 * object creation, deletion, etc. When those items are selected by
5873 * the user, a callback function is issued. Users may interact with
5874 * a gengrid via the mouse (by clicking on items to select them and
5875 * clicking on the grid's viewport and swiping to pan the whole
5876 * view) or via the keyboard, navigating through item with the
5879 * @section Gengrid_Layouts Gengrid layouts
5881 * Gengrids may layout its items in one of two possible layouts:
5885 * When in "horizontal mode", items will be placed in @b columns,
5886 * from top to bottom and, when the space for a column is filled,
5887 * another one is started on the right, thus expanding the grid
5888 * horizontally, making for horizontal scrolling. When in "vertical
5889 * mode" , though, items will be placed in @b rows, from left to
5890 * right and, when the space for a row is filled, another one is
5891 * started below, thus expanding the grid vertically (and making
5892 * for vertical scrolling).
5894 * @section Gengrid_Items Gengrid items
5896 * An item in a gengrid can have 0 or more text labels (they can be
5897 * regular text or textblock Evas objects - that's up to the style
5898 * to determine), 0 or more icons (which are simply objects
5899 * swallowed into the gengrid item's theming Edje object) and 0 or
5900 * more <b>boolean states</b>, which have the behavior left to the
5901 * user to define. The Edje part names for each of these properties
5902 * will be looked up, in the theme file for the gengrid, under the
5903 * Edje (string) data items named @c "labels", @c "icons" and @c
5904 * "states", respectively. For each of those properties, if more
5905 * than one part is provided, they must have names listed separated
5906 * by spaces in the data fields. For the default gengrid item
5907 * theme, we have @b one label part (@c "elm.text"), @b two icon
5908 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5911 * A gengrid item may be at one of several styles. Elementary
5912 * provides one by default - "default", but this can be extended by
5913 * system or application custom themes/overlays/extensions (see
5914 * @ref Theme "themes" for more details).
5916 * @section Gengrid_Item_Class Gengrid item classes
5918 * In order to have the ability to add and delete items on the fly,
5919 * gengrid implements a class (callback) system where the
5920 * application provides a structure with information about that
5921 * type of item (gengrid may contain multiple different items with
5922 * different classes, states and styles). Gengrid will call the
5923 * functions in this struct (methods) when an item is "realized"
5924 * (i.e., created dynamically, while the user is scrolling the
5925 * grid). All objects will simply be deleted when no longer needed
5926 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5927 * contains the following members:
5928 * - @c item_style - This is a constant string and simply defines
5929 * the name of the item style. It @b must be specified and the
5930 * default should be @c "default".
5931 * - @c func.label_get - This function is called when an item
5932 * object is actually created. The @c data parameter will point to
5933 * the same data passed to elm_gengrid_item_append() and related
5934 * item creation functions. The @c obj parameter is the gengrid
5935 * object itself, while the @c part one is the name string of one
5936 * of the existing text parts in the Edje group implementing the
5937 * item's theme. This function @b must return a strdup'()ed string,
5938 * as the caller will free() it when done. See
5939 * #Elm_Gengrid_Item_Label_Get_Cb.
5940 * - @c func.icon_get - This function is called when an item object
5941 * is actually created. The @c data parameter will point to the
5942 * same data passed to elm_gengrid_item_append() and related item
5943 * creation functions. The @c obj parameter is the gengrid object
5944 * itself, while the @c part one is the name string of one of the
5945 * existing (icon) swallow parts in the Edje group implementing the
5946 * item's theme. It must return @c NULL, when no icon is desired,
5947 * or a valid object handle, otherwise. The object will be deleted
5948 * by the gengrid on its deletion or when the item is "unrealized".
5949 * See #Elm_Gengrid_Item_Icon_Get_Cb.
5950 * - @c func.state_get - This function is called when an item
5951 * object is actually created. The @c data parameter will point to
5952 * the same data passed to elm_gengrid_item_append() and related
5953 * item creation functions. The @c obj parameter is the gengrid
5954 * object itself, while the @c part one is the name string of one
5955 * of the state parts in the Edje group implementing the item's
5956 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5957 * true/on. Gengrids will emit a signal to its theming Edje object
5958 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5959 * "source" arguments, respectively, when the state is true (the
5960 * default is false), where @c XXX is the name of the (state) part.
5961 * See #Elm_Gengrid_Item_State_Get_Cb.
5962 * - @c func.del - This is called when elm_gengrid_item_del() is
5963 * called on an item or elm_gengrid_clear() is called on the
5964 * gengrid. This is intended for use when gengrid items are
5965 * deleted, so any data attached to the item (e.g. its data
5966 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
5968 * @section Gengrid_Usage_Hints Usage hints
5970 * If the user wants to have multiple items selected at the same
5971 * time, elm_gengrid_multi_select_set() will permit it. If the
5972 * gengrid is single-selection only (the default), then
5973 * elm_gengrid_select_item_get() will return the selected item or
5974 * @c NULL, if none is selected. If the gengrid is under
5975 * multi-selection, then elm_gengrid_selected_items_get() will
5976 * return a list (that is only valid as long as no items are
5977 * modified (added, deleted, selected or unselected) of child items
5980 * If an item changes (internal (boolean) state, label or icon
5981 * changes), then use elm_gengrid_item_update() to have gengrid
5982 * update the item with the new state. A gengrid will re-"realize"
5983 * the item, thus calling the functions in the
5984 * #Elm_Gengrid_Item_Class set for that item.
5986 * To programmatically (un)select an item, use
5987 * elm_gengrid_item_selected_set(). To get its selected state use
5988 * elm_gengrid_item_selected_get(). To make an item disabled
5989 * (unable to be selected and appear differently) use
5990 * elm_gengrid_item_disabled_set() to set this and
5991 * elm_gengrid_item_disabled_get() to get the disabled state.
5993 * Grid cells will only have their selection smart callbacks called
5994 * when firstly getting selected. Any further clicks will do
5995 * nothing, unless you enable the "always select mode", with
5996 * elm_gengrid_always_select_mode_set(), thus making every click to
5997 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5998 * turn off the ability to select items entirely in the widget and
5999 * they will neither appear selected nor call the selection smart
6002 * Remember that you can create new styles and add your own theme
6003 * augmentation per application with elm_theme_extension_add(). If
6004 * you absolutely must have a specific style that overrides any
6005 * theme the user or system sets up you can use
6006 * elm_theme_overlay_add() to add such a file.
6008 * @section Gengrid_Smart_Events Gengrid smart events
6010 * Smart events that you can add callbacks for are:
6011 * - @c "activated" - The user has double-clicked or pressed
6012 * (enter|return|spacebar) on an item. The @c event_info parameter
6013 * is the gengrid item that was activated.
6014 * - @c "clicked,double" - The user has double-clicked an item.
6015 * The @c event_info parameter is the gengrid item that was double-clicked.
6016 * - @c "selected" - The user has made an item selected. The
6017 * @c event_info parameter is the gengrid item that was selected.
6018 * - @c "unselected" - The user has made an item unselected. The
6019 * @c event_info parameter is the gengrid item that was unselected.
6020 * - @c "realized" - This is called when the item in the gengrid
6021 * has its implementing Evas object instantiated, de facto. @c
6022 * event_info is the gengrid item that was created. The object
6023 * may be deleted at any time, so it is highly advised to the
6024 * caller @b not to use the object pointer returned from
6025 * elm_gengrid_item_object_get(), because it may point to freed
6027 * - @c "unrealized" - This is called when the implementing Evas
6028 * object for this item is deleted. @c event_info is the gengrid
6029 * item that was deleted.
6030 * - @c "changed" - Called when an item is added, removed, resized
6031 * or moved and when the gengrid is resized or gets "horizontal"
6033 * - @c "drag,start,up" - Called when the item in the gengrid has
6034 * been dragged (not scrolled) up.
6035 * - @c "drag,start,down" - Called when the item in the gengrid has
6036 * been dragged (not scrolled) down.
6037 * - @c "drag,start,left" - Called when the item in the gengrid has
6038 * been dragged (not scrolled) left.
6039 * - @c "drag,start,right" - Called when the item in the gengrid has
6040 * been dragged (not scrolled) right.
6041 * - @c "drag,stop" - Called when the item in the gengrid has
6042 * stopped being dragged.
6043 * - @c "drag" - Called when the item in the gengrid is being
6045 * - @c "scroll" - called when the content has been scrolled
6047 * - @c "scroll,drag,start" - called when dragging the content has
6049 * - @c "scroll,drag,stop" - called when dragging the content has
6052 * List of gendrid examples:
6053 * @li @ref gengrid_example
6057 * @addtogroup Gengrid
6061 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
6062 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
6063 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
6064 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
6065 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. */
6066 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. */
6067 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
6069 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
6070 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
6071 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
6072 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
6075 * @struct _Elm_Gengrid_Item_Class
6077 * Gengrid item class definition. See @ref Gengrid_Item_Class for
6080 struct _Elm_Gengrid_Item_Class
6082 const char *item_style;
6083 struct _Elm_Gengrid_Item_Class_Func
6085 Elm_Gengrid_Item_Label_Get_Cb label_get;
6086 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
6087 Elm_Gengrid_Item_State_Get_Cb state_get;
6088 Elm_Gengrid_Item_Del_Cb del;
6090 }; /**< #Elm_Gengrid_Item_Class member definitions */
6093 * Add a new gengrid widget to the given parent Elementary
6094 * (container) object
6096 * @param parent The parent object
6097 * @return a new gengrid widget handle or @c NULL, on errors
6099 * This function inserts a new gengrid widget on the canvas.
6101 * @see elm_gengrid_item_size_set()
6102 * @see elm_gengrid_horizontal_set()
6103 * @see elm_gengrid_item_append()
6104 * @see elm_gengrid_item_del()
6105 * @see elm_gengrid_clear()
6109 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6112 * Set the size for the items of a given gengrid widget
6114 * @param obj The gengrid object.
6115 * @param w The items' width.
6116 * @param h The items' height;
6118 * A gengrid, after creation, has still no information on the size
6119 * to give to each of its cells. So, you most probably will end up
6120 * with squares one @ref Fingers "finger" wide, the default
6121 * size. Use this function to force a custom size for you items,
6122 * making them as big as you wish.
6124 * @see elm_gengrid_item_size_get()
6128 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
6131 * Get the size set for the items of a given gengrid widget
6133 * @param obj The gengrid object.
6134 * @param w Pointer to a variable where to store the items' width.
6135 * @param h Pointer to a variable where to store the items' height.
6137 * @note Use @c NULL pointers on the size values you're not
6138 * interested in: they'll be ignored by the function.
6140 * @see elm_gengrid_item_size_get() for more details
6144 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6147 * Set the items grid's alignment within a given gengrid widget
6149 * @param obj The gengrid object.
6150 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
6151 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
6153 * This sets the alignment of the whole grid of items of a gengrid
6154 * within its given viewport. By default, those values are both
6155 * 0.5, meaning that the gengrid will have its items grid placed
6156 * exactly in the middle of its viewport.
6158 * @note If given alignment values are out of the cited ranges,
6159 * they'll be changed to the nearest boundary values on the valid
6162 * @see elm_gengrid_align_get()
6166 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
6169 * Get the items grid's alignment values within a given gengrid
6172 * @param obj The gengrid object.
6173 * @param align_x Pointer to a variable where to store the
6174 * horizontal alignment.
6175 * @param align_y Pointer to a variable where to store the vertical
6178 * @note Use @c NULL pointers on the alignment values you're not
6179 * interested in: they'll be ignored by the function.
6181 * @see elm_gengrid_align_set() for more details
6185 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
6188 * Set whether a given gengrid widget is or not able have items
6191 * @param obj The gengrid object
6192 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
6193 * @c EINA_FALSE to turn it off
6195 * If a gengrid is set to allow reordering, a click held for more
6196 * than 0.5 over a given item will highlight it specially,
6197 * signalling the gengrid has entered the reordering state. From
6198 * that time on, the user will be able to, while still holding the
6199 * mouse button down, move the item freely in the gengrid's
6200 * viewport, replacing to said item to the locations it goes to.
6201 * The replacements will be animated and, whenever the user
6202 * releases the mouse button, the item being replaced gets a new
6203 * definitive place in the grid.
6205 * @see elm_gengrid_reorder_mode_get()
6209 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6212 * Get whether a given gengrid widget is or not able have items
6215 * @param obj The gengrid object
6216 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6219 * @see elm_gengrid_reorder_mode_set() for more details
6223 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6226 * Append a new item in a given gengrid widget.
6228 * @param obj The gengrid object.
6229 * @param gic The item class for the item.
6230 * @param data The item data.
6231 * @param func Convenience function called when the item is
6233 * @param func_data Data to be passed to @p func.
6234 * @return A handle to the item added or @c NULL, on errors.
6236 * This adds an item to the beginning of the gengrid.
6238 * @see elm_gengrid_item_prepend()
6239 * @see elm_gengrid_item_insert_before()
6240 * @see elm_gengrid_item_insert_after()
6241 * @see elm_gengrid_item_del()
6245 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);
6248 * Prepend a new item in a given gengrid widget.
6250 * @param obj The gengrid object.
6251 * @param gic The item class for the item.
6252 * @param data The item data.
6253 * @param func Convenience function called when the item is
6255 * @param func_data Data to be passed to @p func.
6256 * @return A handle to the item added or @c NULL, on errors.
6258 * This adds an item to the end of the gengrid.
6260 * @see elm_gengrid_item_append()
6261 * @see elm_gengrid_item_insert_before()
6262 * @see elm_gengrid_item_insert_after()
6263 * @see elm_gengrid_item_del()
6267 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);
6270 * Insert an item before another in a gengrid widget
6272 * @param obj The gengrid object.
6273 * @param gic The item class for the item.
6274 * @param data The item data.
6275 * @param relative The item to place this new one before.
6276 * @param func Convenience function called when the item is
6278 * @param func_data Data to be passed to @p func.
6279 * @return A handle to the item added or @c NULL, on errors.
6281 * This inserts an item before another in the gengrid.
6283 * @see elm_gengrid_item_append()
6284 * @see elm_gengrid_item_prepend()
6285 * @see elm_gengrid_item_insert_after()
6286 * @see elm_gengrid_item_del()
6290 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);
6293 * Insert an item after another in a gengrid widget
6295 * @param obj The gengrid object.
6296 * @param gic The item class for the item.
6297 * @param data The item data.
6298 * @param relative The item to place this new one after.
6299 * @param func Convenience function called when the item is
6301 * @param func_data Data to be passed to @p func.
6302 * @return A handle to the item added or @c NULL, on errors.
6304 * This inserts an item after another in the gengrid.
6306 * @see elm_gengrid_item_append()
6307 * @see elm_gengrid_item_prepend()
6308 * @see elm_gengrid_item_insert_after()
6309 * @see elm_gengrid_item_del()
6313 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);
6315 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);
6317 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);
6320 * Set whether items on a given gengrid widget are to get their
6321 * selection callbacks issued for @b every subsequent selection
6322 * click on them or just for the first click.
6324 * @param obj The gengrid object
6325 * @param always_select @c EINA_TRUE to make items "always
6326 * selected", @c EINA_FALSE, otherwise
6328 * By default, grid items will only call their selection callback
6329 * function when firstly getting selected, any subsequent further
6330 * clicks will do nothing. With this call, you make those
6331 * subsequent clicks also to issue the selection callbacks.
6333 * @note <b>Double clicks</b> will @b always be reported on items.
6335 * @see elm_gengrid_always_select_mode_get()
6339 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6342 * Get whether items on a given gengrid widget have their selection
6343 * callbacks issued for @b every subsequent selection click on them
6344 * or just for the first click.
6346 * @param obj The gengrid object.
6347 * @return @c EINA_TRUE if the gengrid items are "always selected",
6348 * @c EINA_FALSE, otherwise
6350 * @see elm_gengrid_always_select_mode_set() for more details
6354 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6357 * Set whether items on a given gengrid widget can be selected or not.
6359 * @param obj The gengrid object
6360 * @param no_select @c EINA_TRUE to make items selectable,
6361 * @c EINA_FALSE otherwise
6363 * This will make items in @p obj selectable or not. In the latter
6364 * case, any user interacion on the gendrid items will neither make
6365 * them appear selected nor them call their selection callback
6368 * @see elm_gengrid_no_select_mode_get()
6372 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6375 * Get whether items on a given gengrid widget can be selected or
6378 * @param obj The gengrid object
6379 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6382 * @see elm_gengrid_no_select_mode_set() for more details
6386 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6389 * Enable or disable multi-selection in a given gengrid widget
6391 * @param obj The gengrid object.
6392 * @param multi @c EINA_TRUE, to enable multi-selection,
6393 * @c EINA_FALSE to disable it.
6395 * Multi-selection is the ability for one to have @b more than one
6396 * item selected, on a given gengrid, simultaneously. When it is
6397 * enabled, a sequence of clicks on different items will make them
6398 * all selected, progressively. A click on an already selected item
6399 * will unselect it. If interecting via the keyboard,
6400 * multi-selection is enabled while holding the "Shift" key.
6402 * @note By default, multi-selection is @b disabled on gengrids
6404 * @see elm_gengrid_multi_select_get()
6408 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6411 * Get whether multi-selection is enabled or disabled for a given
6414 * @param obj The gengrid object.
6415 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6416 * EINA_FALSE otherwise
6418 * @see elm_gengrid_multi_select_set() for more details
6422 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6425 * Enable or disable bouncing effect for a given gengrid widget
6427 * @param obj The gengrid object
6428 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6429 * @c EINA_FALSE to disable it
6430 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6431 * @c EINA_FALSE to disable it
6433 * The bouncing effect occurs whenever one reaches the gengrid's
6434 * edge's while panning it -- it will scroll past its limits a
6435 * little bit and return to the edge again, in a animated for,
6438 * @note By default, gengrids have bouncing enabled on both axis
6440 * @see elm_gengrid_bounce_get()
6444 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6447 * Get whether bouncing effects are enabled or disabled, for a
6448 * given gengrid widget, on each axis
6450 * @param obj The gengrid object
6451 * @param h_bounce Pointer to a variable where to store the
6452 * horizontal bouncing flag.
6453 * @param v_bounce Pointer to a variable where to store the
6454 * vertical bouncing flag.
6456 * @see elm_gengrid_bounce_set() for more details
6460 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6463 * Set a given gengrid widget's scrolling page size, relative to
6464 * its viewport size.
6466 * @param obj The gengrid object
6467 * @param h_pagerel The horizontal page (relative) size
6468 * @param v_pagerel The vertical page (relative) size
6470 * The gengrid's scroller is capable of binding scrolling by the
6471 * user to "pages". It means that, while scrolling and, specially
6472 * after releasing the mouse button, the grid will @b snap to the
6473 * nearest displaying page's area. When page sizes are set, the
6474 * grid's continuous content area is split into (equal) page sized
6477 * This function sets the size of a page <b>relatively to the
6478 * viewport dimensions</b> of the gengrid, for each axis. A value
6479 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6480 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6481 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6482 * 1.0. Values beyond those will make it behave behave
6483 * inconsistently. If you only want one axis to snap to pages, use
6484 * the value @c 0.0 for the other one.
6486 * There is a function setting page size values in @b absolute
6487 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6488 * is mutually exclusive to this one.
6490 * @see elm_gengrid_page_relative_get()
6494 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6497 * Get a given gengrid widget's scrolling page size, relative to
6498 * its viewport size.
6500 * @param obj The gengrid object
6501 * @param h_pagerel Pointer to a variable where to store the
6502 * horizontal page (relative) size
6503 * @param v_pagerel Pointer to a variable where to store the
6504 * vertical page (relative) size
6506 * @see elm_gengrid_page_relative_set() for more details
6510 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6513 * Set a given gengrid widget's scrolling page size
6515 * @param obj The gengrid object
6516 * @param h_pagerel The horizontal page size, in pixels
6517 * @param v_pagerel The vertical page size, in pixels
6519 * The gengrid's scroller is capable of binding scrolling by the
6520 * user to "pages". It means that, while scrolling and, specially
6521 * after releasing the mouse button, the grid will @b snap to the
6522 * nearest displaying page's area. When page sizes are set, the
6523 * grid's continuous content area is split into (equal) page sized
6526 * This function sets the size of a page of the gengrid, in pixels,
6527 * for each axis. Sane usable values are, between @c 0 and the
6528 * dimensions of @p obj, for each axis. Values beyond those will
6529 * make it behave behave inconsistently. If you only want one axis
6530 * to snap to pages, use the value @c 0 for the other one.
6532 * There is a function setting page size values in @b relative
6533 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6534 * use is mutually exclusive to this one.
6538 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6541 * Set for what direction a given gengrid widget will expand while
6542 * placing its items.
6544 * @param obj The gengrid object.
6545 * @param setting @c EINA_TRUE to make the gengrid expand
6546 * horizontally, @c EINA_FALSE to expand vertically.
6548 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6549 * in @b columns, from top to bottom and, when the space for a
6550 * column is filled, another one is started on the right, thus
6551 * expanding the grid horizontally. When in "vertical mode"
6552 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6553 * to right and, when the space for a row is filled, another one is
6554 * started below, thus expanding the grid vertically.
6556 * @see elm_gengrid_horizontal_get()
6560 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6563 * Get for what direction a given gengrid widget will expand while
6564 * placing its items.
6566 * @param obj The gengrid object.
6567 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6568 * @c EINA_FALSE if it's set to expand vertically.
6570 * @see elm_gengrid_horizontal_set() for more detais
6574 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6577 * Get the first item in a given gengrid widget
6579 * @param obj The gengrid object
6580 * @return The first item's handle or @c NULL, if there are no
6581 * items in @p obj (and on errors)
6583 * This returns the first item in the @p obj's internal list of
6586 * @see elm_gengrid_last_item_get()
6590 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6593 * Get the last item in a given gengrid widget
6595 * @param obj The gengrid object
6596 * @return The last item's handle or @c NULL, if there are no
6597 * items in @p obj (and on errors)
6599 * This returns the last item in the @p obj's internal list of
6602 * @see elm_gengrid_first_item_get()
6606 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6609 * Get the @b next item in a gengrid widget's internal list of items,
6610 * given a handle to one of those items.
6612 * @param item The gengrid item to fetch next from
6613 * @return The item after @p item, or @c NULL if there's none (and
6616 * This returns the item placed after the @p item, on the container
6619 * @see elm_gengrid_item_prev_get()
6623 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6626 * Get the @b previous item in a gengrid widget's internal list of items,
6627 * given a handle to one of those items.
6629 * @param item The gengrid item to fetch previous from
6630 * @return The item before @p item, or @c NULL if there's none (and
6633 * This returns the item placed before the @p item, on the container
6636 * @see elm_gengrid_item_next_get()
6640 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6643 * Get the gengrid object's handle which contains a given gengrid
6646 * @param item The item to fetch the container from
6647 * @return The gengrid (parent) object
6649 * This returns the gengrid object itself that an item belongs to.
6653 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6656 * Remove a gengrid item from the its parent, deleting it.
6658 * @param item The item to be removed.
6659 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6661 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6666 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6669 * Update the contents of a given gengrid item
6671 * @param item The gengrid item
6673 * This updates an item by calling all the item class functions
6674 * again to get the icons, labels and states. Use this when the
6675 * original item data has changed and you want thta changes to be
6680 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6681 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6682 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6685 * Return the data associated to a given gengrid item
6687 * @param item The gengrid item.
6688 * @return the data associated to this item.
6690 * This returns the @c data value passed on the
6691 * elm_gengrid_item_append() and related item addition calls.
6693 * @see elm_gengrid_item_append()
6694 * @see elm_gengrid_item_data_set()
6698 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6701 * Set the data associated to a given gengrid item
6703 * @param item The gengrid item
6704 * @param data The new data pointer to set on it
6706 * This @b overrides the @c data value passed on the
6707 * elm_gengrid_item_append() and related item addition calls. This
6708 * function @b won't call elm_gengrid_item_update() automatically,
6709 * so you'd issue it afterwards if you want to hove the item
6710 * updated to reflect the that new data.
6712 * @see elm_gengrid_item_data_get()
6716 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6719 * Get a given gengrid item's position, relative to the whole
6720 * gengrid's grid area.
6722 * @param item The Gengrid item.
6723 * @param x Pointer to variable where to store the item's <b>row
6725 * @param y Pointer to variable where to store the item's <b>column
6728 * This returns the "logical" position of the item whithin the
6729 * gengrid. For example, @c (0, 1) would stand for first row,
6734 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6737 * Set whether a given gengrid item is selected or not
6739 * @param item The gengrid item
6740 * @param selected Use @c EINA_TRUE, to make it selected, @c
6741 * EINA_FALSE to make it unselected
6743 * This sets the selected state of an item. If multi selection is
6744 * not enabled on the containing gengrid and @p selected is @c
6745 * EINA_TRUE, any other previously selected items will get
6746 * unselected in favor of this new one.
6748 * @see elm_gengrid_item_selected_get()
6752 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6755 * Get whether a given gengrid item is selected or not
6757 * @param item The gengrid item
6758 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6760 * @see elm_gengrid_item_selected_set() for more details
6764 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6767 * Get the real Evas object created to implement the view of a
6768 * given gengrid item
6770 * @param item The gengrid item.
6771 * @return the Evas object implementing this item's view.
6773 * This returns the actual Evas object used to implement the
6774 * specified gengrid item's view. This may be @c NULL, as it may
6775 * not have been created or may have been deleted, at any time, by
6776 * the gengrid. <b>Do not modify this object</b> (move, resize,
6777 * show, hide, etc.), as the gengrid is controlling it. This
6778 * function is for querying, emitting custom signals or hooking
6779 * lower level callbacks for events on that object. Do not delete
6780 * this object under any circumstances.
6782 * @see elm_gengrid_item_data_get()
6786 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6789 * Show the portion of a gengrid's internal grid containing a given
6790 * item, @b immediately.
6792 * @param item The item to display
6794 * This causes gengrid to @b redraw its viewport's contents to the
6795 * region contining the given @p item item, if it is not fully
6798 * @see elm_gengrid_item_bring_in()
6802 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6805 * Animatedly bring in, to the visible are of a gengrid, a given
6808 * @param item The gengrid item to display
6810 * This causes gengrig to jump to the given @p item item and show
6811 * it (by scrolling), if it is not fully visible. This will use
6812 * animation to do so and take a period of time to complete.
6814 * @see elm_gengrid_item_show()
6818 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6821 * Set whether a given gengrid item is disabled or not.
6823 * @param item The gengrid item
6824 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6825 * to enable it back.
6827 * A disabled item cannot be selected or unselected. It will also
6828 * change its appearance, to signal the user it's disabled.
6830 * @see elm_gengrid_item_disabled_get()
6834 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6837 * Get whether a given gengrid item is disabled or not.
6839 * @param item The gengrid item
6840 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6843 * @see elm_gengrid_item_disabled_set() for more details
6847 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6850 * Set the text to be shown in a given gengrid item's tooltips.
6852 * @param item The gengrid item
6853 * @param text The text to set in the content
6855 * This call will setup the text to be used as tooltip to that item
6856 * (analogous to elm_object_tooltip_text_set(), but being item
6857 * tooltips with higher precedence than object tooltips). It can
6858 * have only one tooltip at a time, so any previous tooltip data
6863 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6866 * Set the content to be shown in a given gengrid item's tooltips
6868 * @param item The gengrid item.
6869 * @param func The function returning the tooltip contents.
6870 * @param data What to provide to @a func as callback data/context.
6871 * @param del_cb Called when data is not needed anymore, either when
6872 * another callback replaces @p func, the tooltip is unset with
6873 * elm_gengrid_item_tooltip_unset() or the owner @p item
6874 * dies. This callback receives as its first parameter the
6875 * given @p data, being @c event_info the item handle.
6877 * This call will setup the tooltip's contents to @p item
6878 * (analogous to elm_object_tooltip_content_cb_set(), but being
6879 * item tooltips with higher precedence than object tooltips). It
6880 * can have only one tooltip at a time, so any previous tooltip
6881 * content will get removed. @p func (with @p data) will be called
6882 * every time Elementary needs to show the tooltip and it should
6883 * return a valid Evas object, which will be fully managed by the
6884 * tooltip system, getting deleted when the tooltip is gone.
6888 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);
6891 * Unset a tooltip from a given gengrid item
6893 * @param item gengrid item to remove a previously set tooltip from.
6895 * This call removes any tooltip set on @p item. The callback
6896 * provided as @c del_cb to
6897 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6898 * notify it is not used anymore (and have resources cleaned, if
6901 * @see elm_gengrid_item_tooltip_content_cb_set()
6905 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6908 * Set a different @b style for a given gengrid item's tooltip.
6910 * @param item gengrid item with tooltip set
6911 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6912 * "default", @c "transparent", etc)
6914 * Tooltips can have <b>alternate styles</b> to be displayed on,
6915 * which are defined by the theme set on Elementary. This function
6916 * works analogously as elm_object_tooltip_style_set(), but here
6917 * applied only to gengrid item objects. The default style for
6918 * tooltips is @c "default".
6920 * @note before you set a style you should define a tooltip with
6921 * elm_gengrid_item_tooltip_content_cb_set() or
6922 * elm_gengrid_item_tooltip_text_set()
6924 * @see elm_gengrid_item_tooltip_style_get()
6928 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6931 * Get the style set a given gengrid item's tooltip.
6933 * @param item gengrid item with tooltip already set on.
6934 * @return style the theme style in use, which defaults to
6935 * "default". If the object does not have a tooltip set,
6936 * then @c NULL is returned.
6938 * @see elm_gengrid_item_tooltip_style_set() for more details
6942 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6944 * @brief Disable size restrictions on an object's tooltip
6945 * @param item The tooltip's anchor object
6946 * @param disable If EINA_TRUE, size restrictions are disabled
6947 * @return EINA_FALSE on failure, EINA_TRUE on success
6949 * This function allows a tooltip to expand beyond its parant window's canvas.
6950 * It will instead be limited only by the size of the display.
6952 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6954 * @brief Retrieve size restriction state of an object's tooltip
6955 * @param item The tooltip's anchor object
6956 * @return If EINA_TRUE, size restrictions are disabled
6958 * This function returns whether a tooltip is allowed to expand beyond
6959 * its parant window's canvas.
6960 * It will instead be limited only by the size of the display.
6962 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6964 * Set the type of mouse pointer/cursor decoration to be shown,
6965 * when the mouse pointer is over the given gengrid widget item
6967 * @param item gengrid item to customize cursor on
6968 * @param cursor the cursor type's name
6970 * This function works analogously as elm_object_cursor_set(), but
6971 * here the cursor's changing area is restricted to the item's
6972 * area, and not the whole widget's. Note that that item cursors
6973 * have precedence over widget cursors, so that a mouse over @p
6974 * item will always show cursor @p type.
6976 * If this function is called twice for an object, a previously set
6977 * cursor will be unset on the second call.
6979 * @see elm_object_cursor_set()
6980 * @see elm_gengrid_item_cursor_get()
6981 * @see elm_gengrid_item_cursor_unset()
6985 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6988 * Get the type of mouse pointer/cursor decoration set to be shown,
6989 * when the mouse pointer is over the given gengrid widget item
6991 * @param item gengrid item with custom cursor set
6992 * @return the cursor type's name or @c NULL, if no custom cursors
6993 * were set to @p item (and on errors)
6995 * @see elm_object_cursor_get()
6996 * @see elm_gengrid_item_cursor_set() for more details
6997 * @see elm_gengrid_item_cursor_unset()
7001 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7004 * Unset any custom mouse pointer/cursor decoration set to be
7005 * shown, when the mouse pointer is over the given gengrid widget
7006 * item, thus making it show the @b default cursor again.
7008 * @param item a gengrid item
7010 * Use this call to undo any custom settings on this item's cursor
7011 * decoration, bringing it back to defaults (no custom style set).
7013 * @see elm_object_cursor_unset()
7014 * @see elm_gengrid_item_cursor_set() for more details
7018 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7021 * Set a different @b style for a given custom cursor set for a
7024 * @param item gengrid item with custom cursor set
7025 * @param style the <b>theme style</b> to use (e.g. @c "default",
7026 * @c "transparent", etc)
7028 * This function only makes sense when one is using custom mouse
7029 * cursor decorations <b>defined in a theme file</b> , which can
7030 * have, given a cursor name/type, <b>alternate styles</b> on
7031 * it. It works analogously as elm_object_cursor_style_set(), but
7032 * here applied only to gengrid item objects.
7034 * @warning Before you set a cursor style you should have defined a
7035 * custom cursor previously on the item, with
7036 * elm_gengrid_item_cursor_set()
7038 * @see elm_gengrid_item_cursor_engine_only_set()
7039 * @see elm_gengrid_item_cursor_style_get()
7043 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
7046 * Get the current @b style set for a given gengrid item's custom
7049 * @param item gengrid item with custom cursor set.
7050 * @return style the cursor style in use. If the object does not
7051 * have a cursor set, then @c NULL is returned.
7053 * @see elm_gengrid_item_cursor_style_set() for more details
7057 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7060 * Set if the (custom) cursor for a given gengrid item should be
7061 * searched in its theme, also, or should only rely on the
7064 * @param item item with custom (custom) cursor already set on
7065 * @param engine_only Use @c EINA_TRUE to have cursors looked for
7066 * only on those provided by the rendering engine, @c EINA_FALSE to
7067 * have them searched on the widget's theme, as well.
7069 * @note This call is of use only if you've set a custom cursor
7070 * for gengrid items, with elm_gengrid_item_cursor_set().
7072 * @note By default, cursors will only be looked for between those
7073 * provided by the rendering engine.
7077 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7080 * Get if the (custom) cursor for a given gengrid item is being
7081 * searched in its theme, also, or is only relying on the rendering
7084 * @param item a gengrid item
7085 * @return @c EINA_TRUE, if cursors are being looked for only on
7086 * those provided by the rendering engine, @c EINA_FALSE if they
7087 * are being searched on the widget's theme, as well.
7089 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
7093 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7096 * Remove all items from a given gengrid widget
7098 * @param obj The gengrid object.
7100 * This removes (and deletes) all items in @p obj, leaving it
7103 * @see elm_gengrid_item_del(), to remove just one item.
7107 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7110 * Get the selected item in a given gengrid widget
7112 * @param obj The gengrid object.
7113 * @return The selected item's handleor @c NULL, if none is
7114 * selected at the moment (and on errors)
7116 * This returns the selected item in @p obj. If multi selection is
7117 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
7118 * the first item in the list is selected, which might not be very
7119 * useful. For that case, see elm_gengrid_selected_items_get().
7123 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7126 * Get <b>a list</b> of selected items in a given gengrid
7128 * @param obj The gengrid object.
7129 * @return The list of selected items or @c NULL, if none is
7130 * selected at the moment (and on errors)
7132 * This returns a list of the selected items, in the order that
7133 * they appear in the grid. This list is only valid as long as no
7134 * more items are selected or unselected (or unselected implictly
7135 * by deletion). The list contains #Elm_Gengrid_Item pointers as
7138 * @see elm_gengrid_selected_item_get()
7142 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7149 * @defgroup Clock Clock
7151 * @image html img/widget/clock/preview-00.png
7152 * @image latex img/widget/clock/preview-00.eps
7154 * This is a @b digital clock widget. In its default theme, it has a
7155 * vintage "flipping numbers clock" appearance, which will animate
7156 * sheets of individual algarisms individually as time goes by.
7158 * A newly created clock will fetch system's time (already
7159 * considering local time adjustments) to start with, and will tick
7160 * accondingly. It may or may not show seconds.
7162 * Clocks have an @b edition mode. When in it, the sheets will
7163 * display extra arrow indications on the top and bottom and the
7164 * user may click on them to raise or lower the time values. After
7165 * it's told to exit edition mode, it will keep ticking with that
7166 * new time set (it keeps the difference from local time).
7168 * Also, when under edition mode, user clicks on the cited arrows
7169 * which are @b held for some time will make the clock to flip the
7170 * sheet, thus editing the time, continuosly and automatically for
7171 * the user. The interval between sheet flips will keep growing in
7172 * time, so that it helps the user to reach a time which is distant
7175 * The time display is, by default, in military mode (24h), but an
7176 * am/pm indicator may be optionally shown, too, when it will
7179 * Smart callbacks one can register to:
7180 * - "changed" - the clock's user changed the time
7182 * Here is an example on its usage:
7183 * @li @ref clock_example
7192 * Identifiers for which clock digits should be editable, when a
7193 * clock widget is in edition mode. Values may be ORed together to
7194 * make a mask, naturally.
7196 * @see elm_clock_edit_set()
7197 * @see elm_clock_digit_edit_set()
7199 typedef enum _Elm_Clock_Digedit
7201 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
7202 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
7203 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
7204 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
7205 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
7206 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
7207 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
7208 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
7209 } Elm_Clock_Digedit;
7212 * Add a new clock widget to the given parent Elementary
7213 * (container) object
7215 * @param parent The parent object
7216 * @return a new clock widget handle or @c NULL, on errors
7218 * This function inserts a new clock widget on the canvas.
7222 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7225 * Set a clock widget's time, programmatically
7227 * @param obj The clock widget object
7228 * @param hrs The hours to set
7229 * @param min The minutes to set
7230 * @param sec The secondes to set
7232 * This function updates the time that is showed by the clock
7235 * Values @b must be set within the following ranges:
7236 * - 0 - 23, for hours
7237 * - 0 - 59, for minutes
7238 * - 0 - 59, for seconds,
7240 * even if the clock is not in "military" mode.
7242 * @warning The behavior for values set out of those ranges is @b
7247 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7250 * Get a clock widget's time values
7252 * @param obj The clock object
7253 * @param[out] hrs Pointer to the variable to get the hours value
7254 * @param[out] min Pointer to the variable to get the minutes value
7255 * @param[out] sec Pointer to the variable to get the seconds value
7257 * This function gets the time set for @p obj, returning
7258 * it on the variables passed as the arguments to function
7260 * @note Use @c NULL pointers on the time values you're not
7261 * interested in: they'll be ignored by the function.
7265 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7268 * Set whether a given clock widget is under <b>edition mode</b> or
7269 * under (default) displaying-only mode.
7271 * @param obj The clock object
7272 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7273 * put it back to "displaying only" mode
7275 * This function makes a clock's time to be editable or not <b>by
7276 * user interaction</b>. When in edition mode, clocks @b stop
7277 * ticking, until one brings them back to canonical mode. The
7278 * elm_clock_digit_edit_set() function will influence which digits
7279 * of the clock will be editable. By default, all of them will be
7280 * (#ELM_CLOCK_NONE).
7282 * @note am/pm sheets, if being shown, will @b always be editable
7283 * under edition mode.
7285 * @see elm_clock_edit_get()
7289 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7292 * Retrieve whether a given clock widget is under <b>edition
7293 * mode</b> or under (default) displaying-only mode.
7295 * @param obj The clock object
7296 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7299 * This function retrieves whether the clock's time can be edited
7300 * or not by user interaction.
7302 * @see elm_clock_edit_set() for more details
7306 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7309 * Set what digits of the given clock widget should be editable
7310 * when in edition mode.
7312 * @param obj The clock object
7313 * @param digedit Bit mask indicating the digits to be editable
7314 * (values in #Elm_Clock_Digedit).
7316 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7317 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7320 * @see elm_clock_digit_edit_get()
7324 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7327 * Retrieve what digits of the given clock widget should be
7328 * editable when in edition mode.
7330 * @param obj The clock object
7331 * @return Bit mask indicating the digits to be editable
7332 * (values in #Elm_Clock_Digedit).
7334 * @see elm_clock_digit_edit_set() for more details
7338 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7341 * Set if the given clock widget must show hours in military or
7344 * @param obj The clock object
7345 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7348 * This function sets if the clock must show hours in military or
7349 * am/pm mode. In some countries like Brazil the military mode
7350 * (00-24h-format) is used, in opposition to the USA, where the
7351 * am/pm mode is more commonly used.
7353 * @see elm_clock_show_am_pm_get()
7357 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7360 * Get if the given clock widget shows hours in military or am/pm
7363 * @param obj The clock object
7364 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7367 * This function gets if the clock shows hours in military or am/pm
7370 * @see elm_clock_show_am_pm_set() for more details
7374 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7377 * Set if the given clock widget must show time with seconds or not
7379 * @param obj The clock object
7380 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7382 * This function sets if the given clock must show or not elapsed
7383 * seconds. By default, they are @b not shown.
7385 * @see elm_clock_show_seconds_get()
7389 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7392 * Get whether the given clock widget is showing time with seconds
7395 * @param obj The clock object
7396 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7398 * This function gets whether @p obj is showing or not the elapsed
7401 * @see elm_clock_show_seconds_set()
7405 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7408 * Set the interval on time updates for an user mouse button hold
7409 * on clock widgets' time edition.
7411 * @param obj The clock object
7412 * @param interval The (first) interval value in seconds
7414 * This interval value is @b decreased while the user holds the
7415 * mouse pointer either incrementing or decrementing a given the
7416 * clock digit's value.
7418 * This helps the user to get to a given time distant from the
7419 * current one easier/faster, as it will start to flip quicker and
7420 * quicker on mouse button holds.
7422 * The calculation for the next flip interval value, starting from
7423 * the one set with this call, is the previous interval divided by
7424 * 1.05, so it decreases a little bit.
7426 * The default starting interval value for automatic flips is
7429 * @see elm_clock_interval_get()
7433 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7436 * Get the interval on time updates for an user mouse button hold
7437 * on clock widgets' time edition.
7439 * @param obj The clock object
7440 * @return The (first) interval value, in seconds, set on it
7442 * @see elm_clock_interval_set() for more details
7446 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7453 * @defgroup Layout Layout
7455 * @image html img/widget/layout/preview-00.png
7456 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7458 * @image html img/layout-predefined.png
7459 * @image latex img/layout-predefined.eps width=\textwidth
7461 * This is a container widget that takes a standard Edje design file and
7462 * wraps it very thinly in a widget.
7464 * An Edje design (theme) file has a very wide range of possibilities to
7465 * describe the behavior of elements added to the Layout. Check out the Edje
7466 * documentation and the EDC reference to get more information about what can
7467 * be done with Edje.
7469 * Just like @ref List, @ref Box, and other container widgets, any
7470 * object added to the Layout will become its child, meaning that it will be
7471 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7473 * The Layout widget can contain as many Contents, Boxes or Tables as
7474 * described in its theme file. For instance, objects can be added to
7475 * different Tables by specifying the respective Table part names. The same
7476 * is valid for Content and Box.
7478 * The objects added as child of the Layout will behave as described in the
7479 * part description where they were added. There are 3 possible types of
7480 * parts where a child can be added:
7482 * @section secContent Content (SWALLOW part)
7484 * Only one object can be added to the @c SWALLOW part (but you still can
7485 * have many @c SWALLOW parts and one object on each of them). Use the @c
7486 * elm_layout_content_* set of functions to set, retrieve and unset objects
7487 * as content of the @c SWALLOW. After being set to this part, the object
7488 * size, position, visibility, clipping and other description properties
7489 * will be totally controled by the description of the given part (inside
7490 * the Edje theme file).
7492 * One can use @c evas_object_size_hint_* functions on the child to have some
7493 * kind of control over its behavior, but the resulting behavior will still
7494 * depend heavily on the @c SWALLOW part description.
7496 * The Edje theme also can change the part description, based on signals or
7497 * scripts running inside the theme. This change can also be animated. All of
7498 * this will affect the child object set as content accordingly. The object
7499 * size will be changed if the part size is changed, it will animate move if
7500 * the part is moving, and so on.
7502 * The following picture demonstrates a Layout widget with a child object
7503 * added to its @c SWALLOW:
7505 * @image html layout_swallow.png
7506 * @image latex layout_swallow.eps width=\textwidth
7508 * @section secBox Box (BOX part)
7510 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7511 * allows one to add objects to the box and have them distributed along its
7512 * area, accordingly to the specified @a layout property (now by @a layout we
7513 * mean the chosen layouting design of the Box, not the Layout widget
7516 * A similar effect for having a box with its position, size and other things
7517 * controled by the Layout theme would be to create an Elementary @ref Box
7518 * widget and add it as a Content in the @c SWALLOW part.
7520 * The main difference of using the Layout Box is that its behavior, the box
7521 * properties like layouting format, padding, align, etc. will be all
7522 * controled by the theme. This means, for example, that a signal could be
7523 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7524 * handled the signal by changing the box padding, or align, or both. Using
7525 * the Elementary @ref Box widget is not necessarily harder or easier, it
7526 * just depends on the circunstances and requirements.
7528 * The Layout Box can be used through the @c elm_layout_box_* set of
7531 * The following picture demonstrates a Layout widget with many child objects
7532 * added to its @c BOX part:
7534 * @image html layout_box.png
7535 * @image latex layout_box.eps width=\textwidth
7537 * @section secTable Table (TABLE part)
7539 * Just like the @ref secBox, the Layout Table is very similar to the
7540 * Elementary @ref Table widget. It allows one to add objects to the Table
7541 * specifying the row and column where the object should be added, and any
7542 * column or row span if necessary.
7544 * Again, we could have this design by adding a @ref Table widget to the @c
7545 * SWALLOW part using elm_layout_content_set(). The same difference happens
7546 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7547 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7549 * The Layout Table can be used through the @c elm_layout_table_* set of
7552 * The following picture demonstrates a Layout widget with many child objects
7553 * added to its @c TABLE part:
7555 * @image html layout_table.png
7556 * @image latex layout_table.eps width=\textwidth
7558 * @section secPredef Predefined Layouts
7560 * Another interesting thing about the Layout widget is that it offers some
7561 * predefined themes that come with the default Elementary theme. These
7562 * themes can be set by the call elm_layout_theme_set(), and provide some
7563 * basic functionality depending on the theme used.
7565 * Most of them already send some signals, some already provide a toolbar or
7566 * back and next buttons.
7568 * These are available predefined theme layouts. All of them have class = @c
7569 * layout, group = @c application, and style = one of the following options:
7571 * @li @c toolbar-content - application with toolbar and main content area
7572 * @li @c toolbar-content-back - application with toolbar and main content
7573 * area with a back button and title area
7574 * @li @c toolbar-content-back-next - application with toolbar and main
7575 * content area with a back and next buttons and title area
7576 * @li @c content-back - application with a main content area with a back
7577 * button and title area
7578 * @li @c content-back-next - application with a main content area with a
7579 * back and next buttons and title area
7580 * @li @c toolbar-vbox - application with toolbar and main content area as a
7582 * @li @c toolbar-table - application with toolbar and main content area as a
7585 * @section secExamples Examples
7587 * Some examples of the Layout widget can be found here:
7588 * @li @ref layout_example_01
7589 * @li @ref layout_example_02
7590 * @li @ref layout_example_03
7591 * @li @ref layout_example_edc
7596 * Add a new layout to the parent
7598 * @param parent The parent object
7599 * @return The new object or NULL if it cannot be created
7601 * @see elm_layout_file_set()
7602 * @see elm_layout_theme_set()
7606 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7608 * Set the file that will be used as layout
7610 * @param obj The layout object
7611 * @param file The path to file (edj) that will be used as layout
7612 * @param group The group that the layout belongs in edje file
7614 * @return (1 = success, 0 = error)
7618 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7620 * Set the edje group from the elementary theme that will be used as layout
7622 * @param obj The layout object
7623 * @param clas the clas of the group
7624 * @param group the group
7625 * @param style the style to used
7627 * @return (1 = success, 0 = error)
7631 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7633 * Set the layout content.
7635 * @param obj The layout object
7636 * @param swallow The swallow part name in the edje file
7637 * @param content The child that will be added in this layout object
7639 * Once the content object is set, a previously set one will be deleted.
7640 * If you want to keep that old content object, use the
7641 * elm_layout_content_unset() function.
7643 * @note In an Edje theme, the part used as a content container is called @c
7644 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7645 * expected to be a part name just like the second parameter of
7646 * elm_layout_box_append().
7648 * @see elm_layout_box_append()
7649 * @see elm_layout_content_get()
7650 * @see elm_layout_content_unset()
7655 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7657 * Get the child object in the given content part.
7659 * @param obj The layout object
7660 * @param swallow The SWALLOW part to get its content
7662 * @return The swallowed object or NULL if none or an error occurred
7664 * @see elm_layout_content_set()
7668 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7670 * Unset the layout content.
7672 * @param obj The layout object
7673 * @param swallow The swallow part name in the edje file
7674 * @return The content that was being used
7676 * Unparent and return the content object which was set for this part.
7678 * @see elm_layout_content_set()
7682 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7684 * Set the text of the given part
7686 * @param obj The layout object
7687 * @param part The TEXT part where to set the text
7688 * @param text The text to set
7691 * @deprecated use elm_object_text_* instead.
7693 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7695 * Get the text set in the given part
7697 * @param obj The layout object
7698 * @param part The TEXT part to retrieve the text off
7700 * @return The text set in @p part
7703 * @deprecated use elm_object_text_* instead.
7705 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7707 * Append child to layout box part.
7709 * @param obj the layout object
7710 * @param part the box part to which the object will be appended.
7711 * @param child the child object to append to box.
7713 * Once the object is appended, it will become child of the layout. Its
7714 * lifetime will be bound to the layout, whenever the layout dies the child
7715 * will be deleted automatically. One should use elm_layout_box_remove() to
7716 * make this layout forget about the object.
7718 * @see elm_layout_box_prepend()
7719 * @see elm_layout_box_insert_before()
7720 * @see elm_layout_box_insert_at()
7721 * @see elm_layout_box_remove()
7725 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7727 * Prepend child to layout box part.
7729 * @param obj the layout object
7730 * @param part the box part to prepend.
7731 * @param child the child object to prepend to box.
7733 * Once the object is prepended, it will become child of the layout. Its
7734 * lifetime will be bound to the layout, whenever the layout dies the child
7735 * will be deleted automatically. One should use elm_layout_box_remove() to
7736 * make this layout forget about the object.
7738 * @see elm_layout_box_append()
7739 * @see elm_layout_box_insert_before()
7740 * @see elm_layout_box_insert_at()
7741 * @see elm_layout_box_remove()
7745 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7747 * Insert child to layout box part before a reference object.
7749 * @param obj the layout object
7750 * @param part the box part to insert.
7751 * @param child the child object to insert into box.
7752 * @param reference another reference object to insert before in box.
7754 * Once the object is inserted, it will become child of the layout. Its
7755 * lifetime will be bound to the layout, whenever the layout dies the child
7756 * will be deleted automatically. One should use elm_layout_box_remove() to
7757 * make this layout forget about the object.
7759 * @see elm_layout_box_append()
7760 * @see elm_layout_box_prepend()
7761 * @see elm_layout_box_insert_before()
7762 * @see elm_layout_box_remove()
7766 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7768 * Insert child to layout box part at a given position.
7770 * @param obj the layout object
7771 * @param part the box part to insert.
7772 * @param child the child object to insert into box.
7773 * @param pos the numeric position >=0 to insert the child.
7775 * Once the object is inserted, it will become child of the layout. Its
7776 * lifetime will be bound to the layout, whenever the layout dies the child
7777 * will be deleted automatically. One should use elm_layout_box_remove() to
7778 * make this layout forget about the object.
7780 * @see elm_layout_box_append()
7781 * @see elm_layout_box_prepend()
7782 * @see elm_layout_box_insert_before()
7783 * @see elm_layout_box_remove()
7787 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7789 * Remove a child of the given part box.
7791 * @param obj The layout object
7792 * @param part The box part name to remove child.
7793 * @param child The object to remove from box.
7794 * @return The object that was being used, or NULL if not found.
7796 * The object will be removed from the box part and its lifetime will
7797 * not be handled by the layout anymore. This is equivalent to
7798 * elm_layout_content_unset() for box.
7800 * @see elm_layout_box_append()
7801 * @see elm_layout_box_remove_all()
7805 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7807 * Remove all child of the given part box.
7809 * @param obj The layout object
7810 * @param part The box part name to remove child.
7811 * @param clear If EINA_TRUE, then all objects will be deleted as
7812 * well, otherwise they will just be removed and will be
7813 * dangling on the canvas.
7815 * The objects will be removed from the box part and their lifetime will
7816 * not be handled by the layout anymore. This is equivalent to
7817 * elm_layout_box_remove() for all box children.
7819 * @see elm_layout_box_append()
7820 * @see elm_layout_box_remove()
7824 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7826 * Insert child to layout table part.
7828 * @param obj the layout object
7829 * @param part the box part to pack child.
7830 * @param child_obj the child object to pack into table.
7831 * @param col the column to which the child should be added. (>= 0)
7832 * @param row the row to which the child should be added. (>= 0)
7833 * @param colspan how many columns should be used to store this object. (>=
7835 * @param rowspan how many rows should be used to store this object. (>= 1)
7837 * Once the object is inserted, it will become child of the table. Its
7838 * lifetime will be bound to the layout, and whenever the layout dies the
7839 * child will be deleted automatically. One should use
7840 * elm_layout_table_remove() to make this layout forget about the object.
7842 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7843 * more space than a single cell. For instance, the following code:
7845 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7848 * Would result in an object being added like the following picture:
7850 * @image html layout_colspan.png
7851 * @image latex layout_colspan.eps width=\textwidth
7853 * @see elm_layout_table_unpack()
7854 * @see elm_layout_table_clear()
7858 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);
7860 * Unpack (remove) a child of the given part table.
7862 * @param obj The layout object
7863 * @param part The table part name to remove child.
7864 * @param child_obj The object to remove from table.
7865 * @return The object that was being used, or NULL if not found.
7867 * The object will be unpacked from the table part and its lifetime
7868 * will not be handled by the layout anymore. This is equivalent to
7869 * elm_layout_content_unset() for table.
7871 * @see elm_layout_table_pack()
7872 * @see elm_layout_table_clear()
7876 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7878 * Remove all child of the given part table.
7880 * @param obj The layout object
7881 * @param part The table part name to remove child.
7882 * @param clear If EINA_TRUE, then all objects will be deleted as
7883 * well, otherwise they will just be removed and will be
7884 * dangling on the canvas.
7886 * The objects will be removed from the table part and their lifetime will
7887 * not be handled by the layout anymore. This is equivalent to
7888 * elm_layout_table_unpack() for all table children.
7890 * @see elm_layout_table_pack()
7891 * @see elm_layout_table_unpack()
7895 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7897 * Get the edje layout
7899 * @param obj The layout object
7901 * @return A Evas_Object with the edje layout settings loaded
7902 * with function elm_layout_file_set
7904 * This returns the edje object. It is not expected to be used to then
7905 * swallow objects via edje_object_part_swallow() for example. Use
7906 * elm_layout_content_set() instead so child object handling and sizing is
7909 * @note This function should only be used if you really need to call some
7910 * low level Edje function on this edje object. All the common stuff (setting
7911 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7912 * with proper elementary functions.
7914 * @see elm_object_signal_callback_add()
7915 * @see elm_object_signal_emit()
7916 * @see elm_object_text_part_set()
7917 * @see elm_layout_content_set()
7918 * @see elm_layout_box_append()
7919 * @see elm_layout_table_pack()
7920 * @see elm_layout_data_get()
7924 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7926 * Get the edje data from the given layout
7928 * @param obj The layout object
7929 * @param key The data key
7931 * @return The edje data string
7933 * This function fetches data specified inside the edje theme of this layout.
7934 * This function return NULL if data is not found.
7936 * In EDC this comes from a data block within the group block that @p
7937 * obj was loaded from. E.g.
7944 * item: "key1" "value1";
7945 * item: "key2" "value2";
7953 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7957 * @param obj The layout object
7959 * Manually forces a sizing re-evaluation. This is useful when the minimum
7960 * size required by the edje theme of this layout has changed. The change on
7961 * the minimum size required by the edje theme is not immediately reported to
7962 * the elementary layout, so one needs to call this function in order to tell
7963 * the widget (layout) that it needs to reevaluate its own size.
7965 * The minimum size of the theme is calculated based on minimum size of
7966 * parts, the size of elements inside containers like box and table, etc. All
7967 * of this can change due to state changes, and that's when this function
7970 * Also note that a standard signal of "size,eval" "elm" emitted from the
7971 * edje object will cause this to happen too.
7975 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7976 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7977 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7978 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7979 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7980 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7981 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);
7982 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7984 * @def elm_layout_icon_set
7985 * Convienience macro to set the icon object in a layout that follows the
7986 * Elementary naming convention for its parts.
7990 #define elm_layout_icon_set(_ly, _obj) \
7993 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7994 if ((_obj)) sig = "elm,state,icon,visible"; \
7995 else sig = "elm,state,icon,hidden"; \
7996 elm_object_signal_emit((_ly), sig, "elm"); \
8000 * @def elm_layout_icon_get
8001 * Convienience macro to get the icon object from a layout that follows the
8002 * Elementary naming convention for its parts.
8006 #define elm_layout_icon_get(_ly) \
8007 elm_layout_content_get((_ly), "elm.swallow.icon")
8010 * @def elm_layout_end_set
8011 * Convienience macro to set the end object in a layout that follows the
8012 * Elementary naming convention for its parts.
8016 #define elm_layout_end_set(_ly, _obj) \
8019 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
8020 if ((_obj)) sig = "elm,state,end,visible"; \
8021 else sig = "elm,state,end,hidden"; \
8022 elm_object_signal_emit((_ly), sig, "elm"); \
8026 * @def elm_layout_end_get
8027 * Convienience macro to get the end object in a layout that follows the
8028 * Elementary naming convention for its parts.
8032 #define elm_layout_end_get(_ly) \
8033 elm_layout_content_get((_ly), "elm.swallow.end")
8036 * @def elm_layout_label_set
8037 * Convienience macro to set the label in a layout that follows the
8038 * Elementary naming convention for its parts.
8041 * @deprecated use elm_object_text_* instead.
8043 #define elm_layout_label_set(_ly, _txt) \
8044 elm_layout_text_set((_ly), "elm.text", (_txt))
8047 * @def elm_layout_label_get
8048 * Convienience macro to get the label in a layout that follows the
8049 * Elementary naming convention for its parts.
8052 * @deprecated use elm_object_text_* instead.
8054 #define elm_layout_label_get(_ly) \
8055 elm_layout_text_get((_ly), "elm.text")
8057 /* smart callbacks called:
8058 * "theme,changed" - when elm theme is changed.
8062 * @defgroup Notify Notify
8064 * @image html img/widget/notify/preview-00.png
8065 * @image latex img/widget/notify/preview-00.eps
8067 * Display a container in a particular region of the parent(top, bottom,
8068 * etc. A timeout can be set to automatically hide the notify. This is so
8069 * that, after an evas_object_show() on a notify object, if a timeout was set
8070 * on it, it will @b automatically get hidden after that time.
8072 * Signals that you can add callbacks for are:
8073 * @li "timeout" - when timeout happens on notify and it's hidden
8074 * @li "block,clicked" - when a click outside of the notify happens
8076 * @ref tutorial_notify show usage of the API.
8081 * @brief Possible orient values for notify.
8083 * This values should be used in conjunction to elm_notify_orient_set() to
8084 * set the position in which the notify should appear(relative to its parent)
8085 * and in conjunction with elm_notify_orient_get() to know where the notify
8088 typedef enum _Elm_Notify_Orient
8090 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
8091 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
8092 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
8093 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
8094 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
8095 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
8096 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
8097 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
8098 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
8099 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
8100 } Elm_Notify_Orient;
8102 * @brief Add a new notify to the parent
8104 * @param parent The parent object
8105 * @return The new object or NULL if it cannot be created
8107 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8109 * @brief Set the content of the notify widget
8111 * @param obj The notify object
8112 * @param content The content will be filled in this notify object
8114 * Once the content object is set, a previously set one will be deleted. If
8115 * you want to keep that old content object, use the
8116 * elm_notify_content_unset() function.
8118 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8120 * @brief Unset the content of the notify widget
8122 * @param obj The notify object
8123 * @return The content that was being used
8125 * Unparent and return the content object which was set for this widget
8127 * @see elm_notify_content_set()
8129 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8131 * @brief Return the content of the notify widget
8133 * @param obj The notify object
8134 * @return The content that is being used
8136 * @see elm_notify_content_set()
8138 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8140 * @brief Set the notify parent
8142 * @param obj The notify object
8143 * @param content The new parent
8145 * Once the parent object is set, a previously set one will be disconnected
8148 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8150 * @brief Get the notify parent
8152 * @param obj The notify object
8153 * @return The parent
8155 * @see elm_notify_parent_set()
8157 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8159 * @brief Set the orientation
8161 * @param obj The notify object
8162 * @param orient The new orientation
8164 * Sets the position in which the notify will appear in its parent.
8166 * @see @ref Elm_Notify_Orient for possible values.
8168 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
8170 * @brief Return the orientation
8171 * @param obj The notify object
8172 * @return The orientation of the notification
8174 * @see elm_notify_orient_set()
8175 * @see Elm_Notify_Orient
8177 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8179 * @brief Set the time interval after which the notify window is going to be
8182 * @param obj The notify object
8183 * @param time The timeout in seconds
8185 * This function sets a timeout and starts the timer controlling when the
8186 * notify is hidden. Since calling evas_object_show() on a notify restarts
8187 * the timer controlling when the notify is hidden, setting this before the
8188 * notify is shown will in effect mean starting the timer when the notify is
8191 * @note Set a value <= 0.0 to disable a running timer.
8193 * @note If the value > 0.0 and the notify is previously visible, the
8194 * timer will be started with this value, canceling any running timer.
8196 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
8198 * @brief Return the timeout value (in seconds)
8199 * @param obj the notify object
8201 * @see elm_notify_timeout_set()
8203 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8205 * @brief Sets whether events should be passed to by a click outside
8208 * @param obj The notify object
8209 * @param repeats EINA_TRUE Events are repeats, else no
8211 * When true if the user clicks outside the window the events will be caught
8212 * by the others widgets, else the events are blocked.
8214 * @note The default value is EINA_TRUE.
8216 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8218 * @brief Return true if events are repeat below the notify object
8219 * @param obj the notify object
8221 * @see elm_notify_repeat_events_set()
8223 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8229 * @defgroup Hover Hover
8231 * @image html img/widget/hover/preview-00.png
8232 * @image latex img/widget/hover/preview-00.eps
8234 * A Hover object will hover over its @p parent object at the @p target
8235 * location. Anything in the background will be given a darker coloring to
8236 * indicate that the hover object is on top (at the default theme). When the
8237 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8238 * clicked that @b doesn't cause the hover to be dismissed.
8240 * @note The hover object will take up the entire space of @p target
8243 * Elementary has the following styles for the hover widget:
8247 * @li hoversel_vertical
8249 * The following are the available position for content:
8261 * Signals that you can add callbacks for are:
8262 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8263 * @li "smart,changed" - a content object placed under the "smart"
8264 * policy was replaced to a new slot direction.
8266 * See @ref tutorial_hover for more information.
8270 typedef enum _Elm_Hover_Axis
8272 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8273 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8274 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8275 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8278 * @brief Adds a hover object to @p parent
8280 * @param parent The parent object
8281 * @return The hover object or NULL if one could not be created
8283 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8285 * @brief Sets the target object for the hover.
8287 * @param obj The hover object
8288 * @param target The object to center the hover onto. The hover
8290 * This function will cause the hover to be centered on the target object.
8292 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8294 * @brief Gets the target object for the hover.
8296 * @param obj The hover object
8297 * @param parent The object to locate the hover over.
8299 * @see elm_hover_target_set()
8301 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8303 * @brief Sets the parent object for the hover.
8305 * @param obj The hover object
8306 * @param parent The object to locate the hover over.
8308 * This function will cause the hover to take up the entire space that the
8309 * parent object fills.
8311 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8313 * @brief Gets the parent object for the hover.
8315 * @param obj The hover object
8316 * @return The parent object to locate the hover over.
8318 * @see elm_hover_parent_set()
8320 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8322 * @brief Sets the content of the hover object and the direction in which it
8325 * @param obj The hover object
8326 * @param swallow The direction that the object will be displayed
8327 * at. Accepted values are "left", "top-left", "top", "top-right",
8328 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8330 * @param content The content to place at @p swallow
8332 * Once the content object is set for a given direction, a previously
8333 * set one (on the same direction) will be deleted. If you want to
8334 * keep that old content object, use the elm_hover_content_unset()
8337 * All directions may have contents at the same time, except for
8338 * "smart". This is a special placement hint and its use case
8339 * independs of the calculations coming from
8340 * elm_hover_best_content_location_get(). Its use is for cases when
8341 * one desires only one hover content, but with a dinamic special
8342 * placement within the hover area. The content's geometry, whenever
8343 * it changes, will be used to decide on a best location not
8344 * extrapolating the hover's parent object view to show it in (still
8345 * being the hover's target determinant of its medium part -- move and
8346 * resize it to simulate finger sizes, for example). If one of the
8347 * directions other than "smart" are used, a previously content set
8348 * using it will be deleted, and vice-versa.
8350 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8352 * @brief Get the content of the hover object, in a given direction.
8354 * Return the content object which was set for this widget in the
8355 * @p swallow direction.
8357 * @param obj The hover object
8358 * @param swallow The direction that the object was display at.
8359 * @return The content that was being used
8361 * @see elm_hover_content_set()
8363 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8365 * @brief Unset the content of the hover object, in a given direction.
8367 * Unparent and return the content object set at @p swallow direction.
8369 * @param obj The hover object
8370 * @param swallow The direction that the object was display at.
8371 * @return The content that was being used.
8373 * @see elm_hover_content_set()
8375 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8377 * @brief Returns the best swallow location for content in the hover.
8379 * @param obj The hover object
8380 * @param pref_axis The preferred orientation axis for the hover object to use
8381 * @return The edje location to place content into the hover or @c
8384 * Best is defined here as the location at which there is the most available
8387 * @p pref_axis may be one of
8388 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8389 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8390 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8391 * - @c ELM_HOVER_AXIS_BOTH -- both
8393 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8394 * nescessarily be along the horizontal axis("left" or "right"). If
8395 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8396 * be along the vertical axis("top" or "bottom"). Chossing
8397 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8398 * returned position may be in either axis.
8400 * @see elm_hover_content_set()
8402 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8409 * @defgroup Entry Entry
8411 * @image html img/widget/entry/preview-00.png
8412 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8413 * @image html img/widget/entry/preview-01.png
8414 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8415 * @image html img/widget/entry/preview-02.png
8416 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8417 * @image html img/widget/entry/preview-03.png
8418 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8420 * An entry is a convenience widget which shows a box that the user can
8421 * enter text into. Entries by default don't scroll, so they grow to
8422 * accomodate the entire text, resizing the parent window as needed. This
8423 * can be changed with the elm_entry_scrollable_set() function.
8425 * They can also be single line or multi line (the default) and when set
8426 * to multi line mode they support text wrapping in any of the modes
8427 * indicated by #Elm_Wrap_Type.
8429 * Other features include password mode, filtering of inserted text with
8430 * elm_entry_text_filter_append() and related functions, inline "items" and
8431 * formatted markup text.
8433 * @section entry-markup Formatted text
8435 * The markup tags supported by the Entry are defined by the theme, but
8436 * even when writing new themes or extensions it's a good idea to stick to
8437 * a sane default, to maintain coherency and avoid application breakages.
8438 * Currently defined by the default theme are the following tags:
8439 * @li \<br\>: Inserts a line break.
8440 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8442 * @li \<tab\>: Inserts a tab.
8443 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8445 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8446 * @li \<link\>...\</link\>: Underlines the enclosed text.
8447 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8449 * @section entry-special Special markups
8451 * Besides those used to format text, entries support two special markup
8452 * tags used to insert clickable portions of text or items inlined within
8455 * @subsection entry-anchors Anchors
8457 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8458 * \</a\> tags and an event will be generated when this text is clicked,
8462 * This text is outside <a href=anc-01>but this one is an anchor</a>
8465 * The @c href attribute in the opening tag gives the name that will be
8466 * used to identify the anchor and it can be any valid utf8 string.
8468 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8469 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8470 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8471 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8474 * @subsection entry-items Items
8476 * Inlined in the text, any other @c Evas_Object can be inserted by using
8477 * \<item\> tags this way:
8480 * <item size=16x16 vsize=full href=emoticon/haha></item>
8483 * Just like with anchors, the @c href identifies each item, but these need,
8484 * in addition, to indicate their size, which is done using any one of
8485 * @c size, @c absize or @c relsize attributes. These attributes take their
8486 * value in the WxH format, where W is the width and H the height of the
8489 * @li absize: Absolute pixel size for the item. Whatever value is set will
8490 * be the item's size regardless of any scale value the object may have
8491 * been set to. The final line height will be adjusted to fit larger items.
8492 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8494 * @li relsize: Size is adjusted for the item to fit within the current
8497 * Besides their size, items are specificed a @c vsize value that affects
8498 * how their final size and position are calculated. The possible values
8500 * @li ascent: Item will be placed within the line's baseline and its
8501 * ascent. That is, the height between the line where all characters are
8502 * positioned and the highest point in the line. For @c size and @c absize
8503 * items, the descent value will be added to the total line height to make
8504 * them fit. @c relsize items will be adjusted to fit within this space.
8505 * @li full: Items will be placed between the descent and ascent, or the
8506 * lowest point in the line and its highest.
8508 * The next image shows different configurations of items and how they
8509 * are the previously mentioned options affect their sizes. In all cases,
8510 * the green line indicates the ascent, blue for the baseline and red for
8513 * @image html entry_item.png
8514 * @image latex entry_item.eps width=\textwidth
8516 * And another one to show how size differs from absize. In the first one,
8517 * the scale value is set to 1.0, while the second one is using one of 2.0.
8519 * @image html entry_item_scale.png
8520 * @image latex entry_item_scale.eps width=\textwidth
8522 * After the size for an item is calculated, the entry will request an
8523 * object to place in its space. For this, the functions set with
8524 * elm_entry_item_provider_append() and related functions will be called
8525 * in order until one of them returns a @c non-NULL value. If no providers
8526 * are available, or all of them return @c NULL, then the entry falls back
8527 * to one of the internal defaults, provided the name matches with one of
8530 * All of the following are currently supported:
8533 * - emoticon/angry-shout
8534 * - emoticon/crazy-laugh
8535 * - emoticon/evil-laugh
8537 * - emoticon/goggle-smile
8539 * - emoticon/grumpy-smile
8541 * - emoticon/guilty-smile
8543 * - emoticon/half-smile
8544 * - emoticon/happy-panting
8546 * - emoticon/indifferent
8548 * - emoticon/knowing-grin
8550 * - emoticon/little-bit-sorry
8551 * - emoticon/love-lots
8553 * - emoticon/minimal-smile
8554 * - emoticon/not-happy
8555 * - emoticon/not-impressed
8557 * - emoticon/opensmile
8560 * - emoticon/squint-laugh
8561 * - emoticon/surprised
8562 * - emoticon/suspicious
8563 * - emoticon/tongue-dangling
8564 * - emoticon/tongue-poke
8566 * - emoticon/unhappy
8567 * - emoticon/very-sorry
8570 * - emoticon/worried
8573 * Alternatively, an item may reference an image by its path, using
8574 * the URI form @c file:///path/to/an/image.png and the entry will then
8575 * use that image for the item.
8577 * @section entry-files Loading and saving files
8579 * Entries have convinience functions to load text from a file and save
8580 * changes back to it after a short delay. The automatic saving is enabled
8581 * by default, but can be disabled with elm_entry_autosave_set() and files
8582 * can be loaded directly as plain text or have any markup in them
8583 * recognized. See elm_entry_file_set() for more details.
8585 * @section entry-signals Emitted signals
8587 * This widget emits the following signals:
8589 * @li "changed": The text within the entry was changed.
8590 * @li "changed,user": The text within the entry was changed because of user interaction.
8591 * @li "activated": The enter key was pressed on a single line entry.
8592 * @li "press": A mouse button has been pressed on the entry.
8593 * @li "longpressed": A mouse button has been pressed and held for a couple
8595 * @li "clicked": The entry has been clicked (mouse press and release).
8596 * @li "clicked,double": The entry has been double clicked.
8597 * @li "clicked,triple": The entry has been triple clicked.
8598 * @li "focused": The entry has received focus.
8599 * @li "unfocused": The entry has lost focus.
8600 * @li "selection,paste": A paste of the clipboard contents was requested.
8601 * @li "selection,copy": A copy of the selected text into the clipboard was
8603 * @li "selection,cut": A cut of the selected text into the clipboard was
8605 * @li "selection,start": A selection has begun and no previous selection
8607 * @li "selection,changed": The current selection has changed.
8608 * @li "selection,cleared": The current selection has been cleared.
8609 * @li "cursor,changed": The cursor has changed position.
8610 * @li "anchor,clicked": An anchor has been clicked. The event_info
8611 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8612 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8613 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8614 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8615 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8616 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8617 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8618 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8619 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8620 * @li "preedit,changed": The preedit string has changed.
8622 * @section entry-examples
8624 * An overview of the Entry API can be seen in @ref entry_example_01
8629 * @typedef Elm_Entry_Anchor_Info
8631 * The info sent in the callback for the "anchor,clicked" signals emitted
8634 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8636 * @struct _Elm_Entry_Anchor_Info
8638 * The info sent in the callback for the "anchor,clicked" signals emitted
8641 struct _Elm_Entry_Anchor_Info
8643 const char *name; /**< The name of the anchor, as stated in its href */
8644 int button; /**< The mouse button used to click on it */
8645 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8646 y, /**< Anchor geometry, relative to canvas */
8647 w, /**< Anchor geometry, relative to canvas */
8648 h; /**< Anchor geometry, relative to canvas */
8651 * @typedef Elm_Entry_Filter_Cb
8652 * This callback type is used by entry filters to modify text.
8653 * @param data The data specified as the last param when adding the filter
8654 * @param entry The entry object
8655 * @param text A pointer to the location of the text being filtered. This data can be modified,
8656 * but any additional allocations must be managed by the user.
8657 * @see elm_entry_text_filter_append
8658 * @see elm_entry_text_filter_prepend
8660 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8663 * This adds an entry to @p parent object.
8665 * By default, entries are:
8669 * @li autosave is enabled
8671 * @param parent The parent object
8672 * @return The new object or NULL if it cannot be created
8674 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8676 * Sets the entry to single line mode.
8678 * In single line mode, entries don't ever wrap when the text reaches the
8679 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8680 * key will generate an @c "activate" event instead of adding a new line.
8682 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8683 * and pressing enter will break the text into a different line
8684 * without generating any events.
8686 * @param obj The entry object
8687 * @param single_line If true, the text in the entry
8688 * will be on a single line.
8690 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8692 * Gets whether the entry is set to be single line.
8694 * @param obj The entry object
8695 * @return single_line If true, the text in the entry is set to display
8698 * @see elm_entry_single_line_set()
8700 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8702 * Sets the entry to password mode.
8704 * In password mode, entries are implicitly single line and the display of
8705 * any text in them is replaced with asterisks (*).
8707 * @param obj The entry object
8708 * @param password If true, password mode is enabled.
8710 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8712 * Gets whether the entry is set to password mode.
8714 * @param obj The entry object
8715 * @return If true, the entry is set to display all characters
8718 * @see elm_entry_password_set()
8720 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8722 * This sets the text displayed within the entry to @p entry.
8724 * @param obj The entry object
8725 * @param entry The text to be displayed
8727 * @deprecated Use elm_object_text_set() instead.
8729 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8731 * This returns the text currently shown in object @p entry.
8732 * See also elm_entry_entry_set().
8734 * @param obj The entry object
8735 * @return The currently displayed text or NULL on failure
8737 * @deprecated Use elm_object_text_get() instead.
8739 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8741 * Appends @p entry to the text of the entry.
8743 * Adds the text in @p entry to the end of any text already present in the
8746 * The appended text is subject to any filters set for the widget.
8748 * @param obj The entry object
8749 * @param entry The text to be displayed
8751 * @see elm_entry_text_filter_append()
8753 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8755 * Gets whether the entry is empty.
8757 * Empty means no text at all. If there are any markup tags, like an item
8758 * tag for which no provider finds anything, and no text is displayed, this
8759 * function still returns EINA_FALSE.
8761 * @param obj The entry object
8762 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8764 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8766 * Gets any selected text within the entry.
8768 * If there's any selected text in the entry, this function returns it as
8769 * a string in markup format. NULL is returned if no selection exists or
8770 * if an error occurred.
8772 * The returned value points to an internal string and should not be freed
8773 * or modified in any way. If the @p entry object is deleted or its
8774 * contents are changed, the returned pointer should be considered invalid.
8776 * @param obj The entry object
8777 * @return The selected text within the entry or NULL on failure
8779 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8781 * Inserts the given text into the entry at the current cursor position.
8783 * This inserts text at the cursor position as if it was typed
8784 * by the user (note that this also allows markup which a user
8785 * can't just "type" as it would be converted to escaped text, so this
8786 * call can be used to insert things like emoticon items or bold push/pop
8787 * tags, other font and color change tags etc.)
8789 * If any selection exists, it will be replaced by the inserted text.
8791 * The inserted text is subject to any filters set for the widget.
8793 * @param obj The entry object
8794 * @param entry The text to insert
8796 * @see elm_entry_text_filter_append()
8798 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8800 * Set the line wrap type to use on multi-line entries.
8802 * Sets the wrap type used by the entry to any of the specified in
8803 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8804 * line (without inserting a line break or paragraph separator) when it
8805 * reaches the far edge of the widget.
8807 * Note that this only makes sense for multi-line entries. A widget set
8808 * to be single line will never wrap.
8810 * @param obj The entry object
8811 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8813 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8815 * Gets the wrap mode the entry was set to use.
8817 * @param obj The entry object
8820 * @see also elm_entry_line_wrap_set()
8822 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8824 * Sets if the entry is to be editable or not.
8826 * By default, entries are editable and when focused, any text input by the
8827 * user will be inserted at the current cursor position. But calling this
8828 * function with @p editable as EINA_FALSE will prevent the user from
8829 * inputting text into the entry.
8831 * The only way to change the text of a non-editable entry is to use
8832 * elm_object_text_set(), elm_entry_entry_insert() and other related
8835 * @param obj The entry object
8836 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8837 * if not, the entry is read-only and no user input is allowed.
8839 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8841 * Gets whether the entry is editable or not.
8843 * @param obj The entry object
8844 * @return If true, the entry is editable by the user.
8845 * If false, it is not editable by the user
8847 * @see elm_entry_editable_set()
8849 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8851 * This drops any existing text selection within the entry.
8853 * @param obj The entry object
8855 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8857 * This selects all text within the entry.
8859 * @param obj The entry object
8861 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8863 * This moves the cursor one place to the right within the entry.
8865 * @param obj The entry object
8866 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8868 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8870 * This moves the cursor one place to the left within the entry.
8872 * @param obj The entry object
8873 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8875 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8877 * This moves the cursor one line up within the entry.
8879 * @param obj The entry object
8880 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8882 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8884 * This moves the cursor one line down within the entry.
8886 * @param obj The entry object
8887 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8889 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8891 * This moves the cursor to the beginning of the entry.
8893 * @param obj The entry object
8895 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8897 * This moves the cursor to the end of the entry.
8899 * @param obj The entry object
8901 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8903 * This moves the cursor to the beginning of the current line.
8905 * @param obj The entry object
8907 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8909 * This moves the cursor to the end of the current line.
8911 * @param obj The entry object
8913 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8915 * This begins a selection within the entry as though
8916 * the user were holding down the mouse button to make a selection.
8918 * @param obj The entry object
8920 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8922 * This ends a selection within the entry as though
8923 * the user had just released the mouse button while making a selection.
8925 * @param obj The entry object
8927 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8929 * Gets whether a format node exists at the current cursor position.
8931 * A format node is anything that defines how the text is rendered. It can
8932 * be a visible format node, such as a line break or a paragraph separator,
8933 * or an invisible one, such as bold begin or end tag.
8934 * This function returns whether any format node exists at the current
8937 * @param obj The entry object
8938 * @return EINA_TRUE if the current cursor position contains a format node,
8939 * EINA_FALSE otherwise.
8941 * @see elm_entry_cursor_is_visible_format_get()
8943 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8945 * Gets if the current cursor position holds a visible format node.
8947 * @param obj The entry object
8948 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8949 * if it's an invisible one or no format exists.
8951 * @see elm_entry_cursor_is_format_get()
8953 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8955 * Gets the character pointed by the cursor at its current position.
8957 * This function returns a string with the utf8 character stored at the
8958 * current cursor position.
8959 * Only the text is returned, any format that may exist will not be part
8960 * of the return value.
8962 * @param obj The entry object
8963 * @return The text pointed by the cursors.
8965 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8967 * This function returns the geometry of the cursor.
8969 * It's useful if you want to draw something on the cursor (or where it is),
8970 * or for example in the case of scrolled entry where you want to show the
8973 * @param obj The entry object
8974 * @param x returned geometry
8975 * @param y returned geometry
8976 * @param w returned geometry
8977 * @param h returned geometry
8978 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8980 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);
8982 * Sets the cursor position in the entry to the given value
8984 * The value in @p pos is the index of the character position within the
8985 * contents of the string as returned by elm_entry_cursor_pos_get().
8987 * @param obj The entry object
8988 * @param pos The position of the cursor
8990 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8992 * Retrieves the current position of the cursor in the entry
8994 * @param obj The entry object
8995 * @return The cursor position
8997 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8999 * This executes a "cut" action on the selected text in the entry.
9001 * @param obj The entry object
9003 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
9005 * This executes a "copy" action on the selected text in the entry.
9007 * @param obj The entry object
9009 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
9011 * This executes a "paste" action in the entry.
9013 * @param obj The entry object
9015 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
9017 * This clears and frees the items in a entry's contextual (longpress)
9020 * @param obj The entry object
9022 * @see elm_entry_context_menu_item_add()
9024 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9026 * This adds an item to the entry's contextual menu.
9028 * A longpress on an entry will make the contextual menu show up, if this
9029 * hasn't been disabled with elm_entry_context_menu_disabled_set().
9030 * By default, this menu provides a few options like enabling selection mode,
9031 * which is useful on embedded devices that need to be explicit about it,
9032 * and when a selection exists it also shows the copy and cut actions.
9034 * With this function, developers can add other options to this menu to
9035 * perform any action they deem necessary.
9037 * @param obj The entry object
9038 * @param label The item's text label
9039 * @param icon_file The item's icon file
9040 * @param icon_type The item's icon type
9041 * @param func The callback to execute when the item is clicked
9042 * @param data The data to associate with the item for related functions
9044 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);
9046 * This disables the entry's contextual (longpress) menu.
9048 * @param obj The entry object
9049 * @param disabled If true, the menu is disabled
9051 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9053 * This returns whether the entry's contextual (longpress) menu is
9056 * @param obj The entry object
9057 * @return If true, the menu is disabled
9059 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9061 * This appends a custom item provider to the list for that entry
9063 * This appends the given callback. The list is walked from beginning to end
9064 * with each function called given the item href string in the text. If the
9065 * function returns an object handle other than NULL (it should create an
9066 * object to do this), then this object is used to replace that item. If
9067 * not the next provider is called until one provides an item object, or the
9068 * default provider in entry does.
9070 * @param obj The entry object
9071 * @param func The function called to provide the item object
9072 * @param data The data passed to @p func
9074 * @see @ref entry-items
9076 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);
9078 * This prepends a custom item provider to the list for that entry
9080 * This prepends the given callback. See elm_entry_item_provider_append() for
9083 * @param obj The entry object
9084 * @param func The function called to provide the item object
9085 * @param data The data passed to @p func
9087 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);
9089 * This removes a custom item provider to the list for that entry
9091 * This removes the given callback. See elm_entry_item_provider_append() for
9094 * @param obj The entry object
9095 * @param func The function called to provide the item object
9096 * @param data The data passed to @p func
9098 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);
9100 * Append a filter function for text inserted in the entry
9102 * Append the given callback to the list. This functions will be called
9103 * whenever any text is inserted into the entry, with the text to be inserted
9104 * as a parameter. The callback function is free to alter the text in any way
9105 * it wants, but it must remember to free the given pointer and update it.
9106 * If the new text is to be discarded, the function can free it and set its
9107 * text parameter to NULL. This will also prevent any following filters from
9110 * @param obj The entry object
9111 * @param func The function to use as text filter
9112 * @param data User data to pass to @p func
9114 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9116 * Prepend a filter function for text insdrted in the entry
9118 * Prepend the given callback to the list. See elm_entry_text_filter_append()
9119 * for more information
9121 * @param obj The entry object
9122 * @param func The function to use as text filter
9123 * @param data User data to pass to @p func
9125 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9127 * Remove a filter from the list
9129 * Removes the given callback from the filter list. See
9130 * elm_entry_text_filter_append() for more information.
9132 * @param obj The entry object
9133 * @param func The filter function to remove
9134 * @param data The user data passed when adding the function
9136 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9138 * This converts a markup (HTML-like) string into UTF-8.
9140 * The returned string is a malloc'ed buffer and it should be freed when
9141 * not needed anymore.
9143 * @param s The string (in markup) to be converted
9144 * @return The converted string (in UTF-8). It should be freed.
9146 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9148 * This converts a UTF-8 string into markup (HTML-like).
9150 * The returned string is a malloc'ed buffer and it should be freed when
9151 * not needed anymore.
9153 * @param s The string (in UTF-8) to be converted
9154 * @return The converted string (in markup). It should be freed.
9156 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9158 * This sets the file (and implicitly loads it) for the text to display and
9159 * then edit. All changes are written back to the file after a short delay if
9160 * the entry object is set to autosave (which is the default).
9162 * If the entry had any other file set previously, any changes made to it
9163 * will be saved if the autosave feature is enabled, otherwise, the file
9164 * will be silently discarded and any non-saved changes will be lost.
9166 * @param obj The entry object
9167 * @param file The path to the file to load and save
9168 * @param format The file format
9170 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
9172 * Gets the file being edited by the entry.
9174 * This function can be used to retrieve any file set on the entry for
9175 * edition, along with the format used to load and save it.
9177 * @param obj The entry object
9178 * @param file The path to the file to load and save
9179 * @param format The file format
9181 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
9183 * This function writes any changes made to the file set with
9184 * elm_entry_file_set()
9186 * @param obj The entry object
9188 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
9190 * This sets the entry object to 'autosave' the loaded text file or not.
9192 * @param obj The entry object
9193 * @param autosave Autosave the loaded file or not
9195 * @see elm_entry_file_set()
9197 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
9199 * This gets the entry object's 'autosave' status.
9201 * @param obj The entry object
9202 * @return Autosave the loaded file or not
9204 * @see elm_entry_file_set()
9206 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9208 * Control pasting of text and images for the widget.
9210 * Normally the entry allows both text and images to be pasted. By setting
9211 * textonly to be true, this prevents images from being pasted.
9213 * Note this only changes the behaviour of text.
9215 * @param obj The entry object
9216 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9219 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9221 * Getting elm_entry text paste/drop mode.
9223 * In textonly mode, only text may be pasted or dropped into the widget.
9225 * @param obj The entry object
9226 * @return If the widget only accepts text from pastes.
9228 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9230 * Enable or disable scrolling in entry
9232 * Normally the entry is not scrollable unless you enable it with this call.
9234 * @param obj The entry object
9235 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9237 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9239 * Get the scrollable state of the entry
9241 * Normally the entry is not scrollable. This gets the scrollable state
9242 * of the entry. See elm_entry_scrollable_set() for more information.
9244 * @param obj The entry object
9245 * @return The scrollable state
9247 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9249 * This sets a widget to be displayed to the left of a scrolled entry.
9251 * @param obj The scrolled entry object
9252 * @param icon The widget to display on the left side of the scrolled
9255 * @note A previously set widget will be destroyed.
9256 * @note If the object being set does not have minimum size hints set,
9257 * it won't get properly displayed.
9259 * @see elm_entry_end_set()
9261 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9263 * Gets the leftmost widget of the scrolled entry. This object is
9264 * owned by the scrolled entry and should not be modified.
9266 * @param obj The scrolled entry object
9267 * @return the left widget inside the scroller
9269 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9271 * Unset the leftmost widget of the scrolled entry, unparenting and
9274 * @param obj The scrolled entry object
9275 * @return the previously set icon sub-object of this entry, on
9278 * @see elm_entry_icon_set()
9280 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9282 * Sets the visibility of the left-side widget of the scrolled entry,
9283 * set by elm_entry_icon_set().
9285 * @param obj The scrolled entry object
9286 * @param setting EINA_TRUE if the object should be displayed,
9287 * EINA_FALSE if not.
9289 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9291 * This sets a widget to be displayed to the end of a scrolled entry.
9293 * @param obj The scrolled entry object
9294 * @param end The widget to display on the right side of the scrolled
9297 * @note A previously set widget will be destroyed.
9298 * @note If the object being set does not have minimum size hints set,
9299 * it won't get properly displayed.
9301 * @see elm_entry_icon_set
9303 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9305 * Gets the endmost widget of the scrolled entry. This object is owned
9306 * by the scrolled entry and should not be modified.
9308 * @param obj The scrolled entry object
9309 * @return the right widget inside the scroller
9311 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9313 * Unset the endmost widget of the scrolled entry, unparenting and
9316 * @param obj The scrolled entry object
9317 * @return the previously set icon sub-object of this entry, on
9320 * @see elm_entry_icon_set()
9322 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9324 * Sets the visibility of the end widget of the scrolled entry, set by
9325 * elm_entry_end_set().
9327 * @param obj The scrolled entry object
9328 * @param setting EINA_TRUE if the object should be displayed,
9329 * EINA_FALSE if not.
9331 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9333 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9336 * Setting an entry to single-line mode with elm_entry_single_line_set()
9337 * will automatically disable the display of scrollbars when the entry
9338 * moves inside its scroller.
9340 * @param obj The scrolled entry object
9341 * @param h The horizontal scrollbar policy to apply
9342 * @param v The vertical scrollbar policy to apply
9344 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9346 * This enables/disables bouncing within the entry.
9348 * This function sets whether the entry will bounce when scrolling reaches
9349 * the end of the contained entry.
9351 * @param obj The scrolled entry object
9352 * @param h The horizontal bounce state
9353 * @param v The vertical bounce state
9355 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9357 * Get the bounce mode
9359 * @param obj The Entry object
9360 * @param h_bounce Allow bounce horizontally
9361 * @param v_bounce Allow bounce vertically
9363 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9365 /* pre-made filters for entries */
9367 * @typedef Elm_Entry_Filter_Limit_Size
9369 * Data for the elm_entry_filter_limit_size() entry filter.
9371 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9373 * @struct _Elm_Entry_Filter_Limit_Size
9375 * Data for the elm_entry_filter_limit_size() entry filter.
9377 struct _Elm_Entry_Filter_Limit_Size
9379 int max_char_count; /**< The maximum number of characters allowed. */
9380 int max_byte_count; /**< The maximum number of bytes allowed*/
9383 * Filter inserted text based on user defined character and byte limits
9385 * Add this filter to an entry to limit the characters that it will accept
9386 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9387 * The funtion works on the UTF-8 representation of the string, converting
9388 * it from the set markup, thus not accounting for any format in it.
9390 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9391 * it as data when setting the filter. In it, it's possible to set limits
9392 * by character count or bytes (any of them is disabled if 0), and both can
9393 * be set at the same time. In that case, it first checks for characters,
9396 * The function will cut the inserted text in order to allow only the first
9397 * number of characters that are still allowed. The cut is made in
9398 * characters, even when limiting by bytes, in order to always contain
9399 * valid ones and avoid half unicode characters making it in.
9401 * This filter, like any others, does not apply when setting the entry text
9402 * directly with elm_object_text_set() (or the deprecated
9403 * elm_entry_entry_set()).
9405 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9407 * @typedef Elm_Entry_Filter_Accept_Set
9409 * Data for the elm_entry_filter_accept_set() entry filter.
9411 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9413 * @struct _Elm_Entry_Filter_Accept_Set
9415 * Data for the elm_entry_filter_accept_set() entry filter.
9417 struct _Elm_Entry_Filter_Accept_Set
9419 const char *accepted; /**< Set of characters accepted in the entry. */
9420 const char *rejected; /**< Set of characters rejected from the entry. */
9423 * Filter inserted text based on accepted or rejected sets of characters
9425 * Add this filter to an entry to restrict the set of accepted characters
9426 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9427 * This structure contains both accepted and rejected sets, but they are
9428 * mutually exclusive.
9430 * The @c accepted set takes preference, so if it is set, the filter will
9431 * only work based on the accepted characters, ignoring anything in the
9432 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9434 * In both cases, the function filters by matching utf8 characters to the
9435 * raw markup text, so it can be used to remove formatting tags.
9437 * This filter, like any others, does not apply when setting the entry text
9438 * directly with elm_object_text_set() (or the deprecated
9439 * elm_entry_entry_set()).
9441 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9446 /* composite widgets - these basically put together basic widgets above
9447 * in convenient packages that do more than basic stuff */
9451 * @defgroup Anchorview Anchorview
9453 * @image html img/widget/anchorview/preview-00.png
9454 * @image latex img/widget/anchorview/preview-00.eps
9456 * Anchorview is for displaying text that contains markup with anchors
9457 * like <c>\<a href=1234\>something\</\></c> in it.
9459 * Besides being styled differently, the anchorview widget provides the
9460 * necessary functionality so that clicking on these anchors brings up a
9461 * popup with user defined content such as "call", "add to contacts" or
9462 * "open web page". This popup is provided using the @ref Hover widget.
9464 * This widget is very similar to @ref Anchorblock, so refer to that
9465 * widget for an example. The only difference Anchorview has is that the
9466 * widget is already provided with scrolling functionality, so if the
9467 * text set to it is too large to fit in the given space, it will scroll,
9468 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9469 * text can be displayed.
9471 * This widget emits the following signals:
9472 * @li "anchor,clicked": will be called when an anchor is clicked. The
9473 * @p event_info parameter on the callback will be a pointer of type
9474 * ::Elm_Entry_Anchorview_Info.
9476 * See @ref Anchorblock for an example on how to use both of them.
9485 * @typedef Elm_Entry_Anchorview_Info
9487 * The info sent in the callback for "anchor,clicked" signals emitted by
9488 * the Anchorview widget.
9490 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9492 * @struct _Elm_Entry_Anchorview_Info
9494 * The info sent in the callback for "anchor,clicked" signals emitted by
9495 * the Anchorview widget.
9497 struct _Elm_Entry_Anchorview_Info
9499 const char *name; /**< Name of the anchor, as indicated in its href
9501 int button; /**< The mouse button used to click on it */
9502 Evas_Object *hover; /**< The hover object to use for the popup */
9504 Evas_Coord x, y, w, h;
9505 } anchor, /**< Geometry selection of text used as anchor */
9506 hover_parent; /**< Geometry of the object used as parent by the
9508 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9509 for content on the left side of
9510 the hover. Before calling the
9511 callback, the widget will make the
9512 necessary calculations to check
9513 which sides are fit to be set with
9514 content, based on the position the
9515 hover is activated and its distance
9516 to the edges of its parent object
9518 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9519 the right side of the hover.
9520 See @ref hover_left */
9521 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9522 of the hover. See @ref hover_left */
9523 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9524 below the hover. See @ref
9528 * Add a new Anchorview object
9530 * @param parent The parent object
9531 * @return The new object or NULL if it cannot be created
9533 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9535 * Set the text to show in the anchorview
9537 * Sets the text of the anchorview to @p text. This text can include markup
9538 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9539 * text that will be specially styled and react to click events, ended with
9540 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9541 * "anchor,clicked" signal that you can attach a callback to with
9542 * evas_object_smart_callback_add(). The name of the anchor given in the
9543 * event info struct will be the one set in the href attribute, in this
9546 * Other markup can be used to style the text in different ways, but it's
9547 * up to the style defined in the theme which tags do what.
9548 * @deprecated use elm_object_text_set() instead.
9550 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9552 * Get the markup text set for the anchorview
9554 * Retrieves the text set on the anchorview, with markup tags included.
9556 * @param obj The anchorview object
9557 * @return The markup text set or @c NULL if nothing was set or an error
9559 * @deprecated use elm_object_text_set() instead.
9561 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9563 * Set the parent of the hover popup
9565 * Sets the parent object to use by the hover created by the anchorview
9566 * when an anchor is clicked. See @ref Hover for more details on this.
9567 * If no parent is set, the same anchorview object will be used.
9569 * @param obj The anchorview object
9570 * @param parent The object to use as parent for the hover
9572 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9574 * Get the parent of the hover popup
9576 * Get the object used as parent for the hover created by the anchorview
9577 * widget. See @ref Hover for more details on this.
9579 * @param obj The anchorview object
9580 * @return The object used as parent for the hover, NULL if none is set.
9582 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9584 * Set the style that the hover should use
9586 * When creating the popup hover, anchorview will request that it's
9587 * themed according to @p style.
9589 * @param obj The anchorview object
9590 * @param style The style to use for the underlying hover
9592 * @see elm_object_style_set()
9594 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9596 * Get the style that the hover should use
9598 * Get the style the hover created by anchorview will use.
9600 * @param obj The anchorview object
9601 * @return The style to use by the hover. NULL means the default is used.
9603 * @see elm_object_style_set()
9605 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9607 * Ends the hover popup in the anchorview
9609 * When an anchor is clicked, the anchorview widget will create a hover
9610 * object to use as a popup with user provided content. This function
9611 * terminates this popup, returning the anchorview to its normal state.
9613 * @param obj The anchorview object
9615 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9617 * Set bouncing behaviour when the scrolled content reaches an edge
9619 * Tell the internal scroller object whether it should bounce or not
9620 * when it reaches the respective edges for each axis.
9622 * @param obj The anchorview object
9623 * @param h_bounce Whether to bounce or not in the horizontal axis
9624 * @param v_bounce Whether to bounce or not in the vertical axis
9626 * @see elm_scroller_bounce_set()
9628 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9630 * Get the set bouncing behaviour of the internal scroller
9632 * Get whether the internal scroller should bounce when the edge of each
9633 * axis is reached scrolling.
9635 * @param obj The anchorview object
9636 * @param h_bounce Pointer where to store the bounce state of the horizontal
9638 * @param v_bounce Pointer where to store the bounce state of the vertical
9641 * @see elm_scroller_bounce_get()
9643 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9645 * Appends a custom item provider to the given anchorview
9647 * Appends the given function to the list of items providers. This list is
9648 * called, one function at a time, with the given @p data pointer, the
9649 * anchorview object and, in the @p item parameter, the item name as
9650 * referenced in its href string. Following functions in the list will be
9651 * called in order until one of them returns something different to NULL,
9652 * which should be an Evas_Object which will be used in place of the item
9655 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9656 * href=item/name\>\</item\>
9658 * @param obj The anchorview object
9659 * @param func The function to add to the list of providers
9660 * @param data User data that will be passed to the callback function
9662 * @see elm_entry_item_provider_append()
9664 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);
9666 * Prepend a custom item provider to the given anchorview
9668 * Like elm_anchorview_item_provider_append(), but it adds the function
9669 * @p func to the beginning of the list, instead of the end.
9671 * @param obj The anchorview object
9672 * @param func The function to add to the list of providers
9673 * @param data User data that will be passed to the callback function
9675 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);
9677 * Remove a custom item provider from the list of the given anchorview
9679 * Removes the function and data pairing that matches @p func and @p data.
9680 * That is, unless the same function and same user data are given, the
9681 * function will not be removed from the list. This allows us to add the
9682 * same callback several times, with different @p data pointers and be
9683 * able to remove them later without conflicts.
9685 * @param obj The anchorview object
9686 * @param func The function to remove from the list
9687 * @param data The data matching the function to remove from the list
9689 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);
9696 * @defgroup Anchorblock Anchorblock
9698 * @image html img/widget/anchorblock/preview-00.png
9699 * @image latex img/widget/anchorblock/preview-00.eps
9701 * Anchorblock is for displaying text that contains markup with anchors
9702 * like <c>\<a href=1234\>something\</\></c> in it.
9704 * Besides being styled differently, the anchorblock widget provides the
9705 * necessary functionality so that clicking on these anchors brings up a
9706 * popup with user defined content such as "call", "add to contacts" or
9707 * "open web page". This popup is provided using the @ref Hover widget.
9709 * This widget emits the following signals:
9710 * @li "anchor,clicked": will be called when an anchor is clicked. The
9711 * @p event_info parameter on the callback will be a pointer of type
9712 * ::Elm_Entry_Anchorblock_Info.
9718 * Since examples are usually better than plain words, we might as well
9719 * try @ref tutorial_anchorblock_example "one".
9722 * @addtogroup Anchorblock
9726 * @typedef Elm_Entry_Anchorblock_Info
9728 * The info sent in the callback for "anchor,clicked" signals emitted by
9729 * the Anchorblock widget.
9731 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9733 * @struct _Elm_Entry_Anchorblock_Info
9735 * The info sent in the callback for "anchor,clicked" signals emitted by
9736 * the Anchorblock widget.
9738 struct _Elm_Entry_Anchorblock_Info
9740 const char *name; /**< Name of the anchor, as indicated in its href
9742 int button; /**< The mouse button used to click on it */
9743 Evas_Object *hover; /**< The hover object to use for the popup */
9745 Evas_Coord x, y, w, h;
9746 } anchor, /**< Geometry selection of text used as anchor */
9747 hover_parent; /**< Geometry of the object used as parent by the
9749 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9750 for content on the left side of
9751 the hover. Before calling the
9752 callback, the widget will make the
9753 necessary calculations to check
9754 which sides are fit to be set with
9755 content, based on the position the
9756 hover is activated and its distance
9757 to the edges of its parent object
9759 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9760 the right side of the hover.
9761 See @ref hover_left */
9762 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9763 of the hover. See @ref hover_left */
9764 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9765 below the hover. See @ref
9769 * Add a new Anchorblock object
9771 * @param parent The parent object
9772 * @return The new object or NULL if it cannot be created
9774 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9776 * Set the text to show in the anchorblock
9778 * Sets the text of the anchorblock to @p text. This text can include markup
9779 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9780 * of text that will be specially styled and react to click events, ended
9781 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9782 * "anchor,clicked" signal that you can attach a callback to with
9783 * evas_object_smart_callback_add(). The name of the anchor given in the
9784 * event info struct will be the one set in the href attribute, in this
9787 * Other markup can be used to style the text in different ways, but it's
9788 * up to the style defined in the theme which tags do what.
9789 * @deprecated use elm_object_text_set() instead.
9791 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9793 * Get the markup text set for the anchorblock
9795 * Retrieves the text set on the anchorblock, with markup tags included.
9797 * @param obj The anchorblock object
9798 * @return The markup text set or @c NULL if nothing was set or an error
9800 * @deprecated use elm_object_text_set() instead.
9802 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9804 * Set the parent of the hover popup
9806 * Sets the parent object to use by the hover created by the anchorblock
9807 * when an anchor is clicked. See @ref Hover for more details on this.
9809 * @param obj The anchorblock object
9810 * @param parent The object to use as parent for the hover
9812 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9814 * Get the parent of the hover popup
9816 * Get the object used as parent for the hover created by the anchorblock
9817 * widget. See @ref Hover for more details on this.
9818 * If no parent is set, the same anchorblock object will be used.
9820 * @param obj The anchorblock object
9821 * @return The object used as parent for the hover, NULL if none is set.
9823 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9825 * Set the style that the hover should use
9827 * When creating the popup hover, anchorblock will request that it's
9828 * themed according to @p style.
9830 * @param obj The anchorblock object
9831 * @param style The style to use for the underlying hover
9833 * @see elm_object_style_set()
9835 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9837 * Get the style that the hover should use
9839 * Get the style the hover created by anchorblock will use.
9841 * @param obj The anchorblock object
9842 * @return The style to use by the hover. NULL means the default is used.
9844 * @see elm_object_style_set()
9846 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9848 * Ends the hover popup in the anchorblock
9850 * When an anchor is clicked, the anchorblock widget will create a hover
9851 * object to use as a popup with user provided content. This function
9852 * terminates this popup, returning the anchorblock to its normal state.
9854 * @param obj The anchorblock object
9856 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9858 * Appends a custom item provider to the given anchorblock
9860 * Appends the given function to the list of items providers. This list is
9861 * called, one function at a time, with the given @p data pointer, the
9862 * anchorblock object and, in the @p item parameter, the item name as
9863 * referenced in its href string. Following functions in the list will be
9864 * called in order until one of them returns something different to NULL,
9865 * which should be an Evas_Object which will be used in place of the item
9868 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9869 * href=item/name\>\</item\>
9871 * @param obj The anchorblock object
9872 * @param func The function to add to the list of providers
9873 * @param data User data that will be passed to the callback function
9875 * @see elm_entry_item_provider_append()
9877 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);
9879 * Prepend a custom item provider to the given anchorblock
9881 * Like elm_anchorblock_item_provider_append(), but it adds the function
9882 * @p func to the beginning of the list, instead of the end.
9884 * @param obj The anchorblock object
9885 * @param func The function to add to the list of providers
9886 * @param data User data that will be passed to the callback function
9888 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);
9890 * Remove a custom item provider from the list of the given anchorblock
9892 * Removes the function and data pairing that matches @p func and @p data.
9893 * That is, unless the same function and same user data are given, the
9894 * function will not be removed from the list. This allows us to add the
9895 * same callback several times, with different @p data pointers and be
9896 * able to remove them later without conflicts.
9898 * @param obj The anchorblock object
9899 * @param func The function to remove from the list
9900 * @param data The data matching the function to remove from the list
9902 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);
9908 * @defgroup Bubble Bubble
9910 * @image html img/widget/bubble/preview-00.png
9911 * @image latex img/widget/bubble/preview-00.eps
9912 * @image html img/widget/bubble/preview-01.png
9913 * @image latex img/widget/bubble/preview-01.eps
9914 * @image html img/widget/bubble/preview-02.png
9915 * @image latex img/widget/bubble/preview-02.eps
9917 * @brief The Bubble is a widget to show text similarly to how speech is
9918 * represented in comics.
9920 * The bubble widget contains 5 important visual elements:
9921 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9922 * @li The @p icon is an image to which the frame's arrow points to.
9923 * @li The @p label is a text which appears to the right of the icon if the
9924 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9926 * @li The @p info is a text which appears to the right of the label. Info's
9927 * font is of a ligther color than label.
9928 * @li The @p content is an evas object that is shown inside the frame.
9930 * The position of the arrow, icon, label and info depends on which corner is
9931 * selected. The four available corners are:
9932 * @li "top_left" - Default
9935 * @li "bottom_right"
9937 * Signals that you can add callbacks for are:
9938 * @li "clicked" - This is called when a user has clicked the bubble.
9940 * For an example of using a buble see @ref bubble_01_example_page "this".
9945 * Add a new bubble to the parent
9947 * @param parent The parent object
9948 * @return The new object or NULL if it cannot be created
9950 * This function adds a text bubble to the given parent evas object.
9952 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9954 * Set the label of the bubble
9956 * @param obj The bubble object
9957 * @param label The string to set in the label
9959 * This function sets the title of the bubble. Where this appears depends on
9960 * the selected corner.
9961 * @deprecated use elm_object_text_set() instead.
9963 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9965 * Get the label of the bubble
9967 * @param obj The bubble object
9968 * @return The string of set in the label
9970 * This function gets the title of the bubble.
9971 * @deprecated use elm_object_text_get() instead.
9973 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9975 * Set the info of the bubble
9977 * @param obj The bubble object
9978 * @param info The given info about the bubble
9980 * This function sets the info of the bubble. Where this appears depends on
9981 * the selected corner.
9982 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
9984 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9986 * Get the info of the bubble
9988 * @param obj The bubble object
9990 * @return The "info" string of the bubble
9992 * This function gets the info text.
9993 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
9995 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9997 * Set the content to be shown in the bubble
9999 * Once the content object is set, a previously set one will be deleted.
10000 * If you want to keep the old content object, use the
10001 * elm_bubble_content_unset() function.
10003 * @param obj The bubble object
10004 * @param content The given content of the bubble
10006 * This function sets the content shown on the middle of the bubble.
10008 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10010 * Get the content shown in the bubble
10012 * Return the content object which is set for this widget.
10014 * @param obj The bubble object
10015 * @return The content that is being used
10017 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10019 * Unset the content shown in the bubble
10021 * Unparent and return the content object which was set for this widget.
10023 * @param obj The bubble object
10024 * @return The content that was being used
10026 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10028 * Set the icon of the bubble
10030 * Once the icon object is set, a previously set one will be deleted.
10031 * If you want to keep the old content object, use the
10032 * elm_icon_content_unset() function.
10034 * @param obj The bubble object
10035 * @param icon The given icon for the bubble
10037 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10039 * Get the icon of the bubble
10041 * @param obj The bubble object
10042 * @return The icon for the bubble
10044 * This function gets the icon shown on the top left of bubble.
10046 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10048 * Unset the icon of the bubble
10050 * Unparent and return the icon object which was set for this widget.
10052 * @param obj The bubble object
10053 * @return The icon that was being used
10055 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10057 * Set the corner of the bubble
10059 * @param obj The bubble object.
10060 * @param corner The given corner for the bubble.
10062 * This function sets the corner of the bubble. The corner will be used to
10063 * determine where the arrow in the frame points to and where label, icon and
10066 * Possible values for corner are:
10067 * @li "top_left" - Default
10069 * @li "bottom_left"
10070 * @li "bottom_right"
10072 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
10074 * Get the corner of the bubble
10076 * @param obj The bubble object.
10077 * @return The given corner for the bubble.
10079 * This function gets the selected corner of the bubble.
10081 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10087 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10088 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
10089 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
10090 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
10091 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
10092 /* smart callbacks called:
10093 * "clicked" - the user clicked the icon
10094 * "drag,start" - Someone started dragging the image out of the object
10095 * "drag,end" - Dragged item was dropped (somewhere)
10098 /* gesture layer */
10100 * @defgroup Elm_Gesture_Layer Gesture Layer
10101 * Gesture Layer Usage:
10103 * Use Gesture Layer to detect gestures.
10104 * The advantage is that you don't have to implement
10105 * gesture detection, just set callbacks of gesture state.
10106 * By using gesture layer we make standard interface.
10108 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
10109 * with a parent object parameter.
10110 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
10111 * call. Usually with same object as target (2nd parameter).
10113 * Now you need to tell gesture layer what gestures you follow.
10114 * This is done with @ref elm_gesture_layer_cb_set call.
10115 * By setting the callback you actually saying to gesture layer:
10116 * I would like to know when the gesture @ref Elm_Gesture_Types
10117 * switches to state @ref Elm_Gesture_State.
10119 * Next, you need to implement the actual action that follows the input
10120 * in your callback.
10122 * Note that if you like to stop being reported about a gesture, just set
10123 * all callbacks referring this gesture to NULL.
10124 * (again with @ref elm_gesture_layer_cb_set)
10126 * The information reported by gesture layer to your callback is depending
10127 * on @ref Elm_Gesture_Types:
10128 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
10129 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
10130 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
10132 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
10133 * @ref ELM_GESTURE_MOMENTUM.
10135 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
10136 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
10137 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
10138 * Note that we consider a flick as a line-gesture that should be completed
10139 * in flick-time-limit as defined in @ref Config.
10141 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
10143 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
10147 * @enum _Elm_Gesture_Types
10148 * Enum of supported gesture types.
10149 * @ingroup Elm_Gesture_Layer
10151 enum _Elm_Gesture_Types
10153 ELM_GESTURE_FIRST = 0,
10155 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
10156 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
10157 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
10158 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
10160 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
10162 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
10163 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
10165 ELM_GESTURE_ZOOM, /**< Zoom */
10166 ELM_GESTURE_ROTATE, /**< Rotate */
10172 * @typedef Elm_Gesture_Types
10173 * gesture types enum
10174 * @ingroup Elm_Gesture_Layer
10176 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
10179 * @enum _Elm_Gesture_State
10180 * Enum of gesture states.
10181 * @ingroup Elm_Gesture_Layer
10183 enum _Elm_Gesture_State
10185 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
10186 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
10187 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
10188 ELM_GESTURE_STATE_END, /**< Gesture completed */
10189 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
10193 * @typedef Elm_Gesture_State
10194 * gesture states enum
10195 * @ingroup Elm_Gesture_Layer
10197 typedef enum _Elm_Gesture_State Elm_Gesture_State;
10200 * @struct _Elm_Gesture_Taps_Info
10201 * Struct holds taps info for user
10202 * @ingroup Elm_Gesture_Layer
10204 struct _Elm_Gesture_Taps_Info
10206 Evas_Coord x, y; /**< Holds center point between fingers */
10207 unsigned int n; /**< Number of fingers tapped */
10208 unsigned int timestamp; /**< event timestamp */
10212 * @typedef Elm_Gesture_Taps_Info
10213 * holds taps info for user
10214 * @ingroup Elm_Gesture_Layer
10216 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10219 * @struct _Elm_Gesture_Momentum_Info
10220 * Struct holds momentum info for user
10221 * x1 and y1 are not necessarily in sync
10222 * x1 holds x value of x direction starting point
10223 * and same holds for y1.
10224 * This is noticeable when doing V-shape movement
10225 * @ingroup Elm_Gesture_Layer
10227 struct _Elm_Gesture_Momentum_Info
10228 { /* Report line ends, timestamps, and momentum computed */
10229 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10230 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10231 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10232 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10234 unsigned int tx; /**< Timestamp of start of final x-swipe */
10235 unsigned int ty; /**< Timestamp of start of final y-swipe */
10237 Evas_Coord mx; /**< Momentum on X */
10238 Evas_Coord my; /**< Momentum on Y */
10242 * @typedef Elm_Gesture_Momentum_Info
10243 * holds momentum info for user
10244 * @ingroup Elm_Gesture_Layer
10246 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10249 * @struct _Elm_Gesture_Line_Info
10250 * Struct holds line info for user
10251 * @ingroup Elm_Gesture_Layer
10253 struct _Elm_Gesture_Line_Info
10254 { /* Report line ends, timestamps, and momentum computed */
10255 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10256 unsigned int n; /**< Number of fingers (lines) */
10257 /* FIXME should be radians, bot degrees */
10258 double angle; /**< Angle (direction) of lines */
10262 * @typedef Elm_Gesture_Line_Info
10263 * Holds line info for user
10264 * @ingroup Elm_Gesture_Layer
10266 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10269 * @struct _Elm_Gesture_Zoom_Info
10270 * Struct holds zoom info for user
10271 * @ingroup Elm_Gesture_Layer
10273 struct _Elm_Gesture_Zoom_Info
10275 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10276 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10277 double zoom; /**< Zoom value: 1.0 means no zoom */
10278 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10282 * @typedef Elm_Gesture_Zoom_Info
10283 * Holds zoom info for user
10284 * @ingroup Elm_Gesture_Layer
10286 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10289 * @struct _Elm_Gesture_Rotate_Info
10290 * Struct holds rotation info for user
10291 * @ingroup Elm_Gesture_Layer
10293 struct _Elm_Gesture_Rotate_Info
10295 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10296 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10297 double base_angle; /**< Holds start-angle */
10298 double angle; /**< Rotation value: 0.0 means no rotation */
10299 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10303 * @typedef Elm_Gesture_Rotate_Info
10304 * Holds rotation info for user
10305 * @ingroup Elm_Gesture_Layer
10307 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10310 * @typedef Elm_Gesture_Event_Cb
10311 * User callback used to stream gesture info from gesture layer
10312 * @param data user data
10313 * @param event_info gesture report info
10314 * Returns a flag field to be applied on the causing event.
10315 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10316 * upon the event, in an irreversible way.
10318 * @ingroup Elm_Gesture_Layer
10320 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10323 * Use function to set callbacks to be notified about
10324 * change of state of gesture.
10325 * When a user registers a callback with this function
10326 * this means this gesture has to be tested.
10328 * When ALL callbacks for a gesture are set to NULL
10329 * it means user isn't interested in gesture-state
10330 * and it will not be tested.
10332 * @param obj Pointer to gesture-layer.
10333 * @param idx The gesture you would like to track its state.
10334 * @param cb callback function pointer.
10335 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10336 * @param data user info to be sent to callback (usually, Smart Data)
10338 * @ingroup Elm_Gesture_Layer
10340 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);
10343 * Call this function to get repeat-events settings.
10345 * @param obj Pointer to gesture-layer.
10347 * @return repeat events settings.
10348 * @see elm_gesture_layer_hold_events_set()
10349 * @ingroup Elm_Gesture_Layer
10351 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10354 * This function called in order to make gesture-layer repeat events.
10355 * Set this of you like to get the raw events only if gestures were not detected.
10356 * Clear this if you like gesture layer to fwd events as testing gestures.
10358 * @param obj Pointer to gesture-layer.
10359 * @param r Repeat: TRUE/FALSE
10361 * @ingroup Elm_Gesture_Layer
10363 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10366 * This function sets step-value for zoom action.
10367 * Set step to any positive value.
10368 * Cancel step setting by setting to 0.0
10370 * @param obj Pointer to gesture-layer.
10371 * @param s new zoom step value.
10373 * @ingroup Elm_Gesture_Layer
10375 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10378 * This function sets step-value for rotate action.
10379 * Set step to any positive value.
10380 * Cancel step setting by setting to 0.0
10382 * @param obj Pointer to gesture-layer.
10383 * @param s new roatate step value.
10385 * @ingroup Elm_Gesture_Layer
10387 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10390 * This function called to attach gesture-layer to an Evas_Object.
10391 * @param obj Pointer to gesture-layer.
10392 * @param t Pointer to underlying object (AKA Target)
10394 * @return TRUE, FALSE on success, failure.
10396 * @ingroup Elm_Gesture_Layer
10398 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10401 * Call this function to construct a new gesture-layer object.
10402 * This does not activate the gesture layer. You have to
10403 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10405 * @param parent the parent object.
10407 * @return Pointer to new gesture-layer object.
10409 * @ingroup Elm_Gesture_Layer
10411 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10414 * @defgroup Thumb Thumb
10416 * @image html img/widget/thumb/preview-00.png
10417 * @image latex img/widget/thumb/preview-00.eps
10419 * A thumb object is used for displaying the thumbnail of an image or video.
10420 * You must have compiled Elementary with Ethumb_Client support and the DBus
10421 * service must be present and auto-activated in order to have thumbnails to
10424 * Once the thumbnail object becomes visible, it will check if there is a
10425 * previously generated thumbnail image for the file set on it. If not, it
10426 * will start generating this thumbnail.
10428 * Different config settings will cause different thumbnails to be generated
10429 * even on the same file.
10431 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10432 * Ethumb documentation to change this path, and to see other configuration
10435 * Signals that you can add callbacks for are:
10437 * - "clicked" - This is called when a user has clicked the thumb without dragging
10439 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10440 * - "press" - This is called when a user has pressed down the thumb.
10441 * - "generate,start" - The thumbnail generation started.
10442 * - "generate,stop" - The generation process stopped.
10443 * - "generate,error" - The generation failed.
10444 * - "load,error" - The thumbnail image loading failed.
10446 * available styles:
10450 * An example of use of thumbnail:
10452 * - @ref thumb_example_01
10456 * @addtogroup Thumb
10461 * @enum _Elm_Thumb_Animation_Setting
10462 * @typedef Elm_Thumb_Animation_Setting
10464 * Used to set if a video thumbnail is animating or not.
10468 typedef enum _Elm_Thumb_Animation_Setting
10470 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10471 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10472 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10473 ELM_THUMB_ANIMATION_LAST
10474 } Elm_Thumb_Animation_Setting;
10477 * Add a new thumb object to the parent.
10479 * @param parent The parent object.
10480 * @return The new object or NULL if it cannot be created.
10482 * @see elm_thumb_file_set()
10483 * @see elm_thumb_ethumb_client_get()
10487 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10489 * Reload thumbnail if it was generated before.
10491 * @param obj The thumb object to reload
10493 * This is useful if the ethumb client configuration changed, like its
10494 * size, aspect or any other property one set in the handle returned
10495 * by elm_thumb_ethumb_client_get().
10497 * If the options didn't change, the thumbnail won't be generated again, but
10498 * the old one will still be used.
10500 * @see elm_thumb_file_set()
10504 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10506 * Set the file that will be used as thumbnail.
10508 * @param obj The thumb object.
10509 * @param file The path to file that will be used as thumb.
10510 * @param key The key used in case of an EET file.
10512 * The file can be an image or a video (in that case, acceptable extensions are:
10513 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10514 * function elm_thumb_animate().
10516 * @see elm_thumb_file_get()
10517 * @see elm_thumb_reload()
10518 * @see elm_thumb_animate()
10522 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10524 * Get the image or video path and key used to generate the thumbnail.
10526 * @param obj The thumb object.
10527 * @param file Pointer to filename.
10528 * @param key Pointer to key.
10530 * @see elm_thumb_file_set()
10531 * @see elm_thumb_path_get()
10535 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10537 * Get the path and key to the image or video generated by ethumb.
10539 * One just need to make sure that the thumbnail was generated before getting
10540 * its path; otherwise, the path will be NULL. One way to do that is by asking
10541 * for the path when/after the "generate,stop" smart callback is called.
10543 * @param obj The thumb object.
10544 * @param file Pointer to thumb path.
10545 * @param key Pointer to thumb key.
10547 * @see elm_thumb_file_get()
10551 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10553 * Set the animation state for the thumb object. If its content is an animated
10554 * video, you may start/stop the animation or tell it to play continuously and
10557 * @param obj The thumb object.
10558 * @param setting The animation setting.
10560 * @see elm_thumb_file_set()
10564 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10566 * Get the animation state for the thumb object.
10568 * @param obj The thumb object.
10569 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10572 * @see elm_thumb_animate_set()
10576 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10578 * Get the ethumb_client handle so custom configuration can be made.
10580 * @return Ethumb_Client instance or NULL.
10582 * This must be called before the objects are created to be sure no object is
10583 * visible and no generation started.
10585 * Example of usage:
10588 * #include <Elementary.h>
10589 * #ifndef ELM_LIB_QUICKLAUNCH
10591 * elm_main(int argc, char **argv)
10593 * Ethumb_Client *client;
10595 * elm_need_ethumb();
10599 * client = elm_thumb_ethumb_client_get();
10602 * ERR("could not get ethumb_client");
10605 * ethumb_client_size_set(client, 100, 100);
10606 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10609 * // Create elm_thumb objects here
10619 * @note There's only one client handle for Ethumb, so once a configuration
10620 * change is done to it, any other request for thumbnails (for any thumbnail
10621 * object) will use that configuration. Thus, this configuration is global.
10625 EAPI void *elm_thumb_ethumb_client_get(void);
10627 * Get the ethumb_client connection state.
10629 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10632 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10634 * Make the thumbnail 'editable'.
10636 * @param obj Thumb object.
10637 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10639 * This means the thumbnail is a valid drag target for drag and drop, and can be
10640 * cut or pasted too.
10642 * @see elm_thumb_editable_get()
10646 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10648 * Make the thumbnail 'editable'.
10650 * @param obj Thumb object.
10651 * @return Editability.
10653 * This means the thumbnail is a valid drag target for drag and drop, and can be
10654 * cut or pasted too.
10656 * @see elm_thumb_editable_set()
10660 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10667 * @defgroup Hoversel Hoversel
10669 * @image html img/widget/hoversel/preview-00.png
10670 * @image latex img/widget/hoversel/preview-00.eps
10672 * A hoversel is a button that pops up a list of items (automatically
10673 * choosing the direction to display) that have a label and, optionally, an
10674 * icon to select from. It is a convenience widget to avoid the need to do
10675 * all the piecing together yourself. It is intended for a small number of
10676 * items in the hoversel menu (no more than 8), though is capable of many
10679 * Signals that you can add callbacks for are:
10680 * "clicked" - the user clicked the hoversel button and popped up the sel
10681 * "selected" - an item in the hoversel list is selected. event_info is the item
10682 * "dismissed" - the hover is dismissed
10684 * See @ref tutorial_hoversel for an example.
10687 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10689 * @brief Add a new Hoversel object
10691 * @param parent The parent object
10692 * @return The new object or NULL if it cannot be created
10694 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10696 * @brief This sets the hoversel to expand horizontally.
10698 * @param obj The hoversel object
10699 * @param horizontal If true, the hover will expand horizontally to the
10702 * @note The initial button will display horizontally regardless of this
10705 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10707 * @brief This returns whether the hoversel is set to expand horizontally.
10709 * @param obj The hoversel object
10710 * @return If true, the hover will expand horizontally to the right.
10712 * @see elm_hoversel_horizontal_set()
10714 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10716 * @brief Set the Hover parent
10718 * @param obj The hoversel object
10719 * @param parent The parent to use
10721 * Sets the hover parent object, the area that will be darkened when the
10722 * hoversel is clicked. Should probably be the window that the hoversel is
10723 * in. See @ref Hover objects for more information.
10725 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10727 * @brief Get the Hover parent
10729 * @param obj The hoversel object
10730 * @return The used parent
10732 * Gets the hover parent object.
10734 * @see elm_hoversel_hover_parent_set()
10736 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10738 * @brief Set the hoversel button label
10740 * @param obj The hoversel object
10741 * @param label The label text.
10743 * This sets the label of the button that is always visible (before it is
10744 * clicked and expanded).
10746 * @deprecated elm_object_text_set()
10748 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10750 * @brief Get the hoversel button label
10752 * @param obj The hoversel object
10753 * @return The label text.
10755 * @deprecated elm_object_text_get()
10757 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10759 * @brief Set the icon of the hoversel button
10761 * @param obj The hoversel object
10762 * @param icon The icon object
10764 * Sets the icon of the button that is always visible (before it is clicked
10765 * and expanded). Once the icon object is set, a previously set one will be
10766 * deleted, if you want to keep that old content object, use the
10767 * elm_hoversel_icon_unset() function.
10769 * @see elm_button_icon_set()
10771 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10773 * @brief Get the icon of the hoversel button
10775 * @param obj The hoversel object
10776 * @return The icon object
10778 * Get the icon of the button that is always visible (before it is clicked
10779 * and expanded). Also see elm_button_icon_get().
10781 * @see elm_hoversel_icon_set()
10783 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10785 * @brief Get and unparent the icon of the hoversel button
10787 * @param obj The hoversel object
10788 * @return The icon object that was being used
10790 * Unparent and return the icon of the button that is always visible
10791 * (before it is clicked and expanded).
10793 * @see elm_hoversel_icon_set()
10794 * @see elm_button_icon_unset()
10796 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10798 * @brief This triggers the hoversel popup from code, the same as if the user
10799 * had clicked the button.
10801 * @param obj The hoversel object
10803 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10805 * @brief This dismisses the hoversel popup as if the user had clicked
10806 * outside the hover.
10808 * @param obj The hoversel object
10810 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10812 * @brief Returns whether the hoversel is expanded.
10814 * @param obj The hoversel object
10815 * @return This will return EINA_TRUE if the hoversel is expanded or
10816 * EINA_FALSE if it is not expanded.
10818 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10820 * @brief This will remove all the children items from the hoversel.
10822 * @param obj The hoversel object
10824 * @warning Should @b not be called while the hoversel is active; use
10825 * elm_hoversel_expanded_get() to check first.
10827 * @see elm_hoversel_item_del_cb_set()
10828 * @see elm_hoversel_item_del()
10830 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10832 * @brief Get the list of items within the given hoversel.
10834 * @param obj The hoversel object
10835 * @return Returns a list of Elm_Hoversel_Item*
10837 * @see elm_hoversel_item_add()
10839 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10841 * @brief Add an item to the hoversel button
10843 * @param obj The hoversel object
10844 * @param label The text label to use for the item (NULL if not desired)
10845 * @param icon_file An image file path on disk to use for the icon or standard
10846 * icon name (NULL if not desired)
10847 * @param icon_type The icon type if relevant
10848 * @param func Convenience function to call when this item is selected
10849 * @param data Data to pass to item-related functions
10850 * @return A handle to the item added.
10852 * This adds an item to the hoversel to show when it is clicked. Note: if you
10853 * need to use an icon from an edje file then use
10854 * elm_hoversel_item_icon_set() right after the this function, and set
10855 * icon_file to NULL here.
10857 * For more information on what @p icon_file and @p icon_type are see the
10858 * @ref Icon "icon documentation".
10860 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);
10862 * @brief Delete an item from the hoversel
10864 * @param item The item to delete
10866 * This deletes the item from the hoversel (should not be called while the
10867 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10869 * @see elm_hoversel_item_add()
10870 * @see elm_hoversel_item_del_cb_set()
10872 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10874 * @brief Set the function to be called when an item from the hoversel is
10877 * @param item The item to set the callback on
10878 * @param func The function called
10880 * That function will receive these parameters:
10881 * @li void *item_data
10882 * @li Evas_Object *the_item_object
10883 * @li Elm_Hoversel_Item *the_object_struct
10885 * @see elm_hoversel_item_add()
10887 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10889 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10890 * that will be passed to associated function callbacks.
10892 * @param item The item to get the data from
10893 * @return The data pointer set with elm_hoversel_item_add()
10895 * @see elm_hoversel_item_add()
10897 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10899 * @brief This returns the label text of the given hoversel item.
10901 * @param item The item to get the label
10902 * @return The label text of the hoversel item
10904 * @see elm_hoversel_item_add()
10906 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10908 * @brief This sets the icon for the given hoversel item.
10910 * @param item The item to set the icon
10911 * @param icon_file An image file path on disk to use for the icon or standard
10913 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10914 * to NULL if the icon is not an edje file
10915 * @param icon_type The icon type
10917 * The icon can be loaded from the standard set, from an image file, or from
10920 * @see elm_hoversel_item_add()
10922 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);
10924 * @brief Get the icon object of the hoversel item
10926 * @param item The item to get the icon from
10927 * @param icon_file The image file path on disk used for the icon or standard
10929 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10930 * if the icon is not an edje file
10931 * @param icon_type The icon type
10933 * @see elm_hoversel_item_icon_set()
10934 * @see elm_hoversel_item_add()
10936 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);
10942 * @defgroup Toolbar Toolbar
10943 * @ingroup Elementary
10945 * @image html img/widget/toolbar/preview-00.png
10946 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10948 * @image html img/toolbar.png
10949 * @image latex img/toolbar.eps width=\textwidth
10951 * A toolbar is a widget that displays a list of items inside
10952 * a box. It can be scrollable, show a menu with items that don't fit
10953 * to toolbar size or even crop them.
10955 * Only one item can be selected at a time.
10957 * Items can have multiple states, or show menus when selected by the user.
10959 * Smart callbacks one can listen to:
10960 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10962 * Available styles for it:
10964 * - @c "transparent" - no background or shadow, just show the content
10966 * List of examples:
10967 * @li @ref toolbar_example_01
10968 * @li @ref toolbar_example_02
10969 * @li @ref toolbar_example_03
10973 * @addtogroup Toolbar
10978 * @enum _Elm_Toolbar_Shrink_Mode
10979 * @typedef Elm_Toolbar_Shrink_Mode
10981 * Set toolbar's items display behavior, it can be scrollabel,
10982 * show a menu with exceeding items, or simply hide them.
10984 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10987 * Values <b> don't </b> work as bitmask, only one can be choosen.
10989 * @see elm_toolbar_mode_shrink_set()
10990 * @see elm_toolbar_mode_shrink_get()
10994 typedef enum _Elm_Toolbar_Shrink_Mode
10996 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10997 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10998 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10999 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
11000 } Elm_Toolbar_Shrink_Mode;
11002 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(). */
11004 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(). */
11007 * Add a new toolbar widget to the given parent Elementary
11008 * (container) object.
11010 * @param parent The parent object.
11011 * @return a new toolbar widget handle or @c NULL, on errors.
11013 * This function inserts a new toolbar widget on the canvas.
11017 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11020 * Set the icon size, in pixels, to be used by toolbar items.
11022 * @param obj The toolbar object
11023 * @param icon_size The icon size in pixels
11025 * @note Default value is @c 32. It reads value from elm config.
11027 * @see elm_toolbar_icon_size_get()
11031 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
11034 * Get the icon size, in pixels, to be used by toolbar items.
11036 * @param obj The toolbar object.
11037 * @return The icon size in pixels.
11039 * @see elm_toolbar_icon_size_set() for details.
11043 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11046 * Sets icon lookup order, for toolbar items' icons.
11048 * @param obj The toolbar object.
11049 * @param order The icon lookup order.
11051 * Icons added before calling this function will not be affected.
11052 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
11054 * @see elm_toolbar_icon_order_lookup_get()
11058 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
11061 * Gets the icon lookup order.
11063 * @param obj The toolbar object.
11064 * @return The icon lookup order.
11066 * @see elm_toolbar_icon_order_lookup_set() for details.
11070 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11073 * Set whether the toolbar items' should be selected by the user or not.
11075 * @param obj The toolbar object.
11076 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
11079 * This will turn off the ability to select items entirely and they will
11080 * neither appear selected nor emit selected signals. The clicked
11081 * callback function will still be called.
11083 * Selection is enabled by default.
11085 * @see elm_toolbar_no_select_mode_get().
11089 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
11092 * Set whether the toolbar items' should be selected by the user or not.
11094 * @param obj The toolbar object.
11095 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
11096 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
11098 * @see elm_toolbar_no_select_mode_set() for details.
11102 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11105 * Append item to the toolbar.
11107 * @param obj The toolbar object.
11108 * @param icon A string with icon name or the absolute path of an image file.
11109 * @param label The label of the item.
11110 * @param func The function to call when the item is clicked.
11111 * @param data The data to associate with the item for related callbacks.
11112 * @return The created item or @c NULL upon failure.
11114 * A new item will be created and appended to the toolbar, i.e., will
11115 * be set as @b last item.
11117 * Items created with this method can be deleted with
11118 * elm_toolbar_item_del().
11120 * Associated @p data can be properly freed when item is deleted if a
11121 * callback function is set with elm_toolbar_item_del_cb_set().
11123 * If a function is passed as argument, it will be called everytime this item
11124 * is selected, i.e., the user clicks over an unselected item.
11125 * If such function isn't needed, just passing
11126 * @c NULL as @p func is enough. The same should be done for @p data.
11128 * Toolbar will load icon image from fdo or current theme.
11129 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11130 * If an absolute path is provided it will load it direct from a file.
11132 * @see elm_toolbar_item_icon_set()
11133 * @see elm_toolbar_item_del()
11134 * @see elm_toolbar_item_del_cb_set()
11138 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);
11141 * Prepend item to the toolbar.
11143 * @param obj The toolbar object.
11144 * @param icon A string with icon name or the absolute path of an image file.
11145 * @param label The label of the item.
11146 * @param func The function to call when the item is clicked.
11147 * @param data The data to associate with the item for related callbacks.
11148 * @return The created item or @c NULL upon failure.
11150 * A new item will be created and prepended to the toolbar, i.e., will
11151 * be set as @b first item.
11153 * Items created with this method can be deleted with
11154 * elm_toolbar_item_del().
11156 * Associated @p data can be properly freed when item is deleted if a
11157 * callback function is set with elm_toolbar_item_del_cb_set().
11159 * If a function is passed as argument, it will be called everytime this item
11160 * is selected, i.e., the user clicks over an unselected item.
11161 * If such function isn't needed, just passing
11162 * @c NULL as @p func is enough. The same should be done for @p data.
11164 * Toolbar will load icon image from fdo or current theme.
11165 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11166 * If an absolute path is provided it will load it direct from a file.
11168 * @see elm_toolbar_item_icon_set()
11169 * @see elm_toolbar_item_del()
11170 * @see elm_toolbar_item_del_cb_set()
11174 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);
11177 * Insert a new item into the toolbar object before item @p before.
11179 * @param obj The toolbar object.
11180 * @param before The toolbar item to insert before.
11181 * @param icon A string with icon name or the absolute path of an image file.
11182 * @param label The label of the item.
11183 * @param func The function to call when the item is clicked.
11184 * @param data The data to associate with the item for related callbacks.
11185 * @return The created item or @c NULL upon failure.
11187 * A new item will be created and added to the toolbar. Its position in
11188 * this toolbar will be just before item @p before.
11190 * Items created with this method can be deleted with
11191 * elm_toolbar_item_del().
11193 * Associated @p data can be properly freed when item is deleted if a
11194 * callback function is set with elm_toolbar_item_del_cb_set().
11196 * If a function is passed as argument, it will be called everytime this item
11197 * is selected, i.e., the user clicks over an unselected item.
11198 * If such function isn't needed, just passing
11199 * @c NULL as @p func is enough. The same should be done for @p data.
11201 * Toolbar will load icon image from fdo or current theme.
11202 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11203 * If an absolute path is provided it will load it direct from a file.
11205 * @see elm_toolbar_item_icon_set()
11206 * @see elm_toolbar_item_del()
11207 * @see elm_toolbar_item_del_cb_set()
11211 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);
11214 * Insert a new item into the toolbar object after item @p after.
11216 * @param obj The toolbar object.
11217 * @param before The toolbar item to insert before.
11218 * @param icon A string with icon name or the absolute path of an image file.
11219 * @param label The label of the item.
11220 * @param func The function to call when the item is clicked.
11221 * @param data The data to associate with the item for related callbacks.
11222 * @return The created item or @c NULL upon failure.
11224 * A new item will be created and added to the toolbar. Its position in
11225 * this toolbar will be just after item @p after.
11227 * Items created with this method can be deleted with
11228 * elm_toolbar_item_del().
11230 * Associated @p data can be properly freed when item is deleted if a
11231 * callback function is set with elm_toolbar_item_del_cb_set().
11233 * If a function is passed as argument, it will be called everytime this item
11234 * is selected, i.e., the user clicks over an unselected item.
11235 * If such function isn't needed, just passing
11236 * @c NULL as @p func is enough. The same should be done for @p data.
11238 * Toolbar will load icon image from fdo or current theme.
11239 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11240 * If an absolute path is provided it will load it direct from a file.
11242 * @see elm_toolbar_item_icon_set()
11243 * @see elm_toolbar_item_del()
11244 * @see elm_toolbar_item_del_cb_set()
11248 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);
11251 * Get the first item in the given toolbar widget's list of
11254 * @param obj The toolbar object
11255 * @return The first item or @c NULL, if it has no items (and on
11258 * @see elm_toolbar_item_append()
11259 * @see elm_toolbar_last_item_get()
11263 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11266 * Get the last item in the given toolbar widget's list of
11269 * @param obj The toolbar object
11270 * @return The last item or @c NULL, if it has no items (and on
11273 * @see elm_toolbar_item_prepend()
11274 * @see elm_toolbar_first_item_get()
11278 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11281 * Get the item after @p item in toolbar.
11283 * @param item The toolbar item.
11284 * @return The item after @p item, or @c NULL if none or on failure.
11286 * @note If it is the last item, @c NULL will be returned.
11288 * @see elm_toolbar_item_append()
11292 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11295 * Get the item before @p item in toolbar.
11297 * @param item The toolbar item.
11298 * @return The item before @p item, or @c NULL if none or on failure.
11300 * @note If it is the first item, @c NULL will be returned.
11302 * @see elm_toolbar_item_prepend()
11306 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11309 * Get the toolbar object from an item.
11311 * @param item The item.
11312 * @return The toolbar object.
11314 * This returns the toolbar object itself that an item belongs to.
11318 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11321 * Set the priority of a toolbar item.
11323 * @param item The toolbar item.
11324 * @param priority The item priority. The default is zero.
11326 * This is used only when the toolbar shrink mode is set to
11327 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11328 * When space is less than required, items with low priority
11329 * will be removed from the toolbar and added to a dynamically-created menu,
11330 * while items with higher priority will remain on the toolbar,
11331 * with the same order they were added.
11333 * @see elm_toolbar_item_priority_get()
11337 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11340 * Get the priority of a toolbar item.
11342 * @param item The toolbar item.
11343 * @return The @p item priority, or @c 0 on failure.
11345 * @see elm_toolbar_item_priority_set() for details.
11349 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11352 * Get the label of item.
11354 * @param item The item of toolbar.
11355 * @return The label of item.
11357 * The return value is a pointer to the label associated to @p item when
11358 * it was created, with function elm_toolbar_item_append() or similar,
11360 * with function elm_toolbar_item_label_set. If no label
11361 * was passed as argument, it will return @c NULL.
11363 * @see elm_toolbar_item_label_set() for more details.
11364 * @see elm_toolbar_item_append()
11368 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11371 * Set the label of item.
11373 * @param item The item of toolbar.
11374 * @param text The label of item.
11376 * The label to be displayed by the item.
11377 * Label will be placed at icons bottom (if set).
11379 * If a label was passed as argument on item creation, with function
11380 * elm_toolbar_item_append() or similar, it will be already
11381 * displayed by the item.
11383 * @see elm_toolbar_item_label_get()
11384 * @see elm_toolbar_item_append()
11388 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11391 * Return the data associated with a given toolbar widget item.
11393 * @param item The toolbar widget item handle.
11394 * @return The data associated with @p item.
11396 * @see elm_toolbar_item_data_set()
11400 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11403 * Set the data associated with a given toolbar widget item.
11405 * @param item The toolbar widget item handle.
11406 * @param data The new data pointer to set to @p item.
11408 * This sets new item data on @p item.
11410 * @warning The old data pointer won't be touched by this function, so
11411 * the user had better to free that old data himself/herself.
11415 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11418 * Returns a pointer to a toolbar item by its label.
11420 * @param obj The toolbar object.
11421 * @param label The label of the item to find.
11423 * @return The pointer to the toolbar item matching @p label or @c NULL
11428 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11431 * Get whether the @p item is selected or not.
11433 * @param item The toolbar item.
11434 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11435 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11437 * @see elm_toolbar_selected_item_set() for details.
11438 * @see elm_toolbar_item_selected_get()
11442 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11445 * Set the selected state of an item.
11447 * @param item The toolbar item
11448 * @param selected The selected state
11450 * This sets the selected state of the given item @p it.
11451 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11453 * If a new item is selected the previosly selected will be unselected.
11454 * Previoulsy selected item can be get with function
11455 * elm_toolbar_selected_item_get().
11457 * Selected items will be highlighted.
11459 * @see elm_toolbar_item_selected_get()
11460 * @see elm_toolbar_selected_item_get()
11464 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11467 * Get the selected item.
11469 * @param obj The toolbar object.
11470 * @return The selected toolbar item.
11472 * The selected item can be unselected with function
11473 * elm_toolbar_item_selected_set().
11475 * The selected item always will be highlighted on toolbar.
11477 * @see elm_toolbar_selected_items_get()
11481 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11484 * Set the icon associated with @p item.
11486 * @param obj The parent of this item.
11487 * @param item The toolbar item.
11488 * @param icon A string with icon name or the absolute path of an image file.
11490 * Toolbar will load icon image from fdo or current theme.
11491 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11492 * If an absolute path is provided it will load it direct from a file.
11494 * @see elm_toolbar_icon_order_lookup_set()
11495 * @see elm_toolbar_icon_order_lookup_get()
11499 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11502 * Get the string used to set the icon of @p item.
11504 * @param item The toolbar item.
11505 * @return The string associated with the icon object.
11507 * @see elm_toolbar_item_icon_set() for details.
11511 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11514 * Delete them item from the toolbar.
11516 * @param item The item of toolbar to be deleted.
11518 * @see elm_toolbar_item_append()
11519 * @see elm_toolbar_item_del_cb_set()
11523 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11526 * Set the function called when a toolbar item is freed.
11528 * @param item The item to set the callback on.
11529 * @param func The function called.
11531 * If there is a @p func, then it will be called prior item's memory release.
11532 * That will be called with the following arguments:
11534 * @li item's Evas object;
11537 * This way, a data associated to a toolbar item could be properly freed.
11541 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11544 * Get a value whether toolbar item is disabled or not.
11546 * @param item The item.
11547 * @return The disabled state.
11549 * @see elm_toolbar_item_disabled_set() for more details.
11553 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11556 * Sets the disabled/enabled state of a toolbar item.
11558 * @param item The item.
11559 * @param disabled The disabled state.
11561 * A disabled item cannot be selected or unselected. It will also
11562 * change its appearance (generally greyed out). This sets the
11563 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11568 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11571 * Set or unset item as a separator.
11573 * @param item The toolbar item.
11574 * @param setting @c EINA_TRUE to set item @p item as separator or
11575 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11577 * Items aren't set as separator by default.
11579 * If set as separator it will display separator theme, so won't display
11582 * @see elm_toolbar_item_separator_get()
11586 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11589 * Get a value whether item is a separator or not.
11591 * @param item The toolbar item.
11592 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11593 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11595 * @see elm_toolbar_item_separator_set() for details.
11599 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11602 * Set the shrink state of toolbar @p obj.
11604 * @param obj The toolbar object.
11605 * @param shrink_mode Toolbar's items display behavior.
11607 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11608 * but will enforce a minimun size so all the items will fit, won't scroll
11609 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11610 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11611 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11615 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11618 * Get the shrink mode of toolbar @p obj.
11620 * @param obj The toolbar object.
11621 * @return Toolbar's items display behavior.
11623 * @see elm_toolbar_mode_shrink_set() for details.
11627 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11630 * Enable/disable homogenous mode.
11632 * @param obj The toolbar object
11633 * @param homogeneous Assume the items within the toolbar are of the
11634 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11636 * This will enable the homogeneous mode where items are of the same size.
11637 * @see elm_toolbar_homogeneous_get()
11641 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11644 * Get whether the homogenous mode is enabled.
11646 * @param obj The toolbar object.
11647 * @return Assume the items within the toolbar are of the same height
11648 * and width (EINA_TRUE = on, EINA_FALSE = off).
11650 * @see elm_toolbar_homogeneous_set()
11654 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11657 * Enable/disable homogenous mode.
11659 * @param obj The toolbar object
11660 * @param homogeneous Assume the items within the toolbar are of the
11661 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11663 * This will enable the homogeneous mode where items are of the same size.
11664 * @see elm_toolbar_homogeneous_get()
11666 * @deprecated use elm_toolbar_homogeneous_set() instead.
11670 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11673 * Get whether the homogenous mode is enabled.
11675 * @param obj The toolbar object.
11676 * @return Assume the items within the toolbar are of the same height
11677 * and width (EINA_TRUE = on, EINA_FALSE = off).
11679 * @see elm_toolbar_homogeneous_set()
11680 * @deprecated use elm_toolbar_homogeneous_get() instead.
11684 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11687 * Set the parent object of the toolbar items' menus.
11689 * @param obj The toolbar object.
11690 * @param parent The parent of the menu objects.
11692 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11694 * For more details about setting the parent for toolbar menus, see
11695 * elm_menu_parent_set().
11697 * @see elm_menu_parent_set() for details.
11698 * @see elm_toolbar_item_menu_set() for details.
11702 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11705 * Get the parent object of the toolbar items' menus.
11707 * @param obj The toolbar object.
11708 * @return The parent of the menu objects.
11710 * @see elm_toolbar_menu_parent_set() for details.
11714 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11717 * Set the alignment of the items.
11719 * @param obj The toolbar object.
11720 * @param align The new alignment, a float between <tt> 0.0 </tt>
11721 * and <tt> 1.0 </tt>.
11723 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11724 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11727 * Centered items by default.
11729 * @see elm_toolbar_align_get()
11733 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11736 * Get the alignment of the items.
11738 * @param obj The toolbar object.
11739 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11742 * @see elm_toolbar_align_set() for details.
11746 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11749 * Set whether the toolbar item opens a menu.
11751 * @param item The toolbar item.
11752 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11754 * A toolbar item can be set to be a menu, using this function.
11756 * Once it is set to be a menu, it can be manipulated through the
11757 * menu-like function elm_toolbar_menu_parent_set() and the other
11758 * elm_menu functions, using the Evas_Object @c menu returned by
11759 * elm_toolbar_item_menu_get().
11761 * So, items to be displayed in this item's menu should be added with
11762 * elm_menu_item_add().
11764 * The following code exemplifies the most basic usage:
11766 * tb = elm_toolbar_add(win)
11767 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11768 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11769 * elm_toolbar_menu_parent_set(tb, win);
11770 * menu = elm_toolbar_item_menu_get(item);
11771 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11772 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11776 * @see elm_toolbar_item_menu_get()
11780 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11783 * Get toolbar item's menu.
11785 * @param item The toolbar item.
11786 * @return Item's menu object or @c NULL on failure.
11788 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11789 * this function will set it.
11791 * @see elm_toolbar_item_menu_set() for details.
11795 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11798 * Add a new state to @p item.
11800 * @param item The item.
11801 * @param icon A string with icon name or the absolute path of an image file.
11802 * @param label The label of the new state.
11803 * @param func The function to call when the item is clicked when this
11804 * state is selected.
11805 * @param data The data to associate with the state.
11806 * @return The toolbar item state, or @c NULL upon failure.
11808 * Toolbar will load icon image from fdo or current theme.
11809 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11810 * If an absolute path is provided it will load it direct from a file.
11812 * States created with this function can be removed with
11813 * elm_toolbar_item_state_del().
11815 * @see elm_toolbar_item_state_del()
11816 * @see elm_toolbar_item_state_sel()
11817 * @see elm_toolbar_item_state_get()
11821 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);
11824 * Delete a previoulsy added state to @p item.
11826 * @param item The toolbar item.
11827 * @param state The state to be deleted.
11828 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11830 * @see elm_toolbar_item_state_add()
11832 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11835 * Set @p state as the current state of @p it.
11837 * @param it The item.
11838 * @param state The state to use.
11839 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11841 * If @p state is @c NULL, it won't select any state and the default item's
11842 * icon and label will be used. It's the same behaviour than
11843 * elm_toolbar_item_state_unser().
11845 * @see elm_toolbar_item_state_unset()
11849 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11852 * Unset the state of @p it.
11854 * @param it The item.
11856 * The default icon and label from this item will be displayed.
11858 * @see elm_toolbar_item_state_set() for more details.
11862 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11865 * Get the current state of @p it.
11867 * @param item The item.
11868 * @return The selected state or @c NULL if none is selected or on failure.
11870 * @see elm_toolbar_item_state_set() for details.
11871 * @see elm_toolbar_item_state_unset()
11872 * @see elm_toolbar_item_state_add()
11876 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11879 * Get the state after selected state in toolbar's @p item.
11881 * @param it The toolbar item to change state.
11882 * @return The state after current state, or @c NULL on failure.
11884 * If last state is selected, this function will return first state.
11886 * @see elm_toolbar_item_state_set()
11887 * @see elm_toolbar_item_state_add()
11891 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11894 * Get the state before selected state in toolbar's @p item.
11896 * @param it The toolbar item to change state.
11897 * @return The state before current state, or @c NULL on failure.
11899 * If first state is selected, this function will return last state.
11901 * @see elm_toolbar_item_state_set()
11902 * @see elm_toolbar_item_state_add()
11906 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11909 * Set the text to be shown in a given toolbar item's tooltips.
11911 * @param item Target item.
11912 * @param text The text to set in the content.
11914 * Setup the text as tooltip to object. The item can have only one tooltip,
11915 * so any previous tooltip data - set with this function or
11916 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11918 * @see elm_object_tooltip_text_set() for more details.
11922 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11925 * Set the content to be shown in the tooltip item.
11927 * Setup the tooltip to item. The item can have only one tooltip,
11928 * so any previous tooltip data is removed. @p func(with @p data) will
11929 * be called every time that need show the tooltip and it should
11930 * return a valid Evas_Object. This object is then managed fully by
11931 * tooltip system and is deleted when the tooltip is gone.
11933 * @param item the toolbar item being attached a tooltip.
11934 * @param func the function used to create the tooltip contents.
11935 * @param data what to provide to @a func as callback data/context.
11936 * @param del_cb called when data is not needed anymore, either when
11937 * another callback replaces @a func, the tooltip is unset with
11938 * elm_toolbar_item_tooltip_unset() or the owner @a item
11939 * dies. This callback receives as the first parameter the
11940 * given @a data, and @c event_info is the item.
11942 * @see elm_object_tooltip_content_cb_set() for more details.
11946 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);
11949 * Unset tooltip from item.
11951 * @param item toolbar item to remove previously set tooltip.
11953 * Remove tooltip from item. The callback provided as del_cb to
11954 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11955 * it is not used anymore.
11957 * @see elm_object_tooltip_unset() for more details.
11958 * @see elm_toolbar_item_tooltip_content_cb_set()
11962 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11965 * Sets a different style for this item tooltip.
11967 * @note before you set a style you should define a tooltip with
11968 * elm_toolbar_item_tooltip_content_cb_set() or
11969 * elm_toolbar_item_tooltip_text_set()
11971 * @param item toolbar item with tooltip already set.
11972 * @param style the theme style to use (default, transparent, ...)
11974 * @see elm_object_tooltip_style_set() for more details.
11978 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11981 * Get the style for this item tooltip.
11983 * @param item toolbar item with tooltip already set.
11984 * @return style the theme style in use, defaults to "default". If the
11985 * object does not have a tooltip set, then NULL is returned.
11987 * @see elm_object_tooltip_style_get() for more details.
11988 * @see elm_toolbar_item_tooltip_style_set()
11992 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11995 * Set the type of mouse pointer/cursor decoration to be shown,
11996 * when the mouse pointer is over the given toolbar widget item
11998 * @param item toolbar item to customize cursor on
11999 * @param cursor the cursor type's name
12001 * This function works analogously as elm_object_cursor_set(), but
12002 * here the cursor's changing area is restricted to the item's
12003 * area, and not the whole widget's. Note that that item cursors
12004 * have precedence over widget cursors, so that a mouse over an
12005 * item with custom cursor set will always show @b that cursor.
12007 * If this function is called twice for an object, a previously set
12008 * cursor will be unset on the second call.
12010 * @see elm_object_cursor_set()
12011 * @see elm_toolbar_item_cursor_get()
12012 * @see elm_toolbar_item_cursor_unset()
12016 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
12019 * Get the type of mouse pointer/cursor decoration set to be shown,
12020 * when the mouse pointer is over the given toolbar widget item
12022 * @param item toolbar item with custom cursor set
12023 * @return the cursor type's name or @c NULL, if no custom cursors
12024 * were set to @p item (and on errors)
12026 * @see elm_object_cursor_get()
12027 * @see elm_toolbar_item_cursor_set()
12028 * @see elm_toolbar_item_cursor_unset()
12032 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12035 * Unset any custom mouse pointer/cursor decoration set to be
12036 * shown, when the mouse pointer is over the given toolbar widget
12037 * item, thus making it show the @b default cursor again.
12039 * @param item a toolbar item
12041 * Use this call to undo any custom settings on this item's cursor
12042 * decoration, bringing it back to defaults (no custom style set).
12044 * @see elm_object_cursor_unset()
12045 * @see elm_toolbar_item_cursor_set()
12049 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12052 * Set a different @b style for a given custom cursor set for a
12055 * @param item toolbar item with custom cursor set
12056 * @param style the <b>theme style</b> to use (e.g. @c "default",
12057 * @c "transparent", etc)
12059 * This function only makes sense when one is using custom mouse
12060 * cursor decorations <b>defined in a theme file</b>, which can have,
12061 * given a cursor name/type, <b>alternate styles</b> on it. It
12062 * works analogously as elm_object_cursor_style_set(), but here
12063 * applyed only to toolbar item objects.
12065 * @warning Before you set a cursor style you should have definen a
12066 * custom cursor previously on the item, with
12067 * elm_toolbar_item_cursor_set()
12069 * @see elm_toolbar_item_cursor_engine_only_set()
12070 * @see elm_toolbar_item_cursor_style_get()
12074 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12077 * Get the current @b style set for a given toolbar item's custom
12080 * @param item toolbar item with custom cursor set.
12081 * @return style the cursor style in use. If the object does not
12082 * have a cursor set, then @c NULL is returned.
12084 * @see elm_toolbar_item_cursor_style_set() for more details
12088 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12091 * Set if the (custom)cursor for a given toolbar item should be
12092 * searched in its theme, also, or should only rely on the
12093 * rendering engine.
12095 * @param item item with custom (custom) cursor already set on
12096 * @param engine_only Use @c EINA_TRUE to have cursors looked for
12097 * only on those provided by the rendering engine, @c EINA_FALSE to
12098 * have them searched on the widget's theme, as well.
12100 * @note This call is of use only if you've set a custom cursor
12101 * for toolbar items, with elm_toolbar_item_cursor_set().
12103 * @note By default, cursors will only be looked for between those
12104 * provided by the rendering engine.
12108 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12111 * Get if the (custom) cursor for a given toolbar item is being
12112 * searched in its theme, also, or is only relying on the rendering
12115 * @param item a toolbar item
12116 * @return @c EINA_TRUE, if cursors are being looked for only on
12117 * those provided by the rendering engine, @c EINA_FALSE if they
12118 * are being searched on the widget's theme, as well.
12120 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
12124 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12127 * Change a toolbar's orientation
12128 * @param obj The toolbar object
12129 * @param vertical If @c EINA_TRUE, the toolbar is vertical
12130 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
12133 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
12136 * Get a toolbar's orientation
12137 * @param obj The toolbar object
12138 * @return If @c EINA_TRUE, the toolbar is vertical
12139 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
12142 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12149 EAPI double elm_tooltip_delay_get(void);
12150 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
12151 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
12152 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
12153 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
12154 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);
12155 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12156 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12157 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12158 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
12159 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12160 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12161 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12162 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12163 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12164 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12165 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
12166 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
12169 EAPI int elm_cursor_engine_only_get(void);
12170 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
12173 * @defgroup Menu Menu
12175 * @image html img/widget/menu/preview-00.png
12176 * @image latex img/widget/menu/preview-00.eps
12178 * A menu is a list of items displayed above its parent. When the menu is
12179 * showing its parent is darkened. Each item can have a sub-menu. The menu
12180 * object can be used to display a menu on a right click event, in a toolbar,
12183 * Signals that you can add callbacks for are:
12184 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
12185 * event_info is NULL.
12187 * @see @ref tutorial_menu
12190 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
12192 * @brief Add a new menu to the parent
12194 * @param parent The parent object.
12195 * @return The new object or NULL if it cannot be created.
12197 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12199 * @brief Set the parent for the given menu widget
12201 * @param obj The menu object.
12202 * @param parent The new parent.
12204 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12206 * @brief Get the parent for the given menu widget
12208 * @param obj The menu object.
12209 * @return The parent.
12211 * @see elm_menu_parent_set()
12213 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12215 * @brief Move the menu to a new position
12217 * @param obj The menu object.
12218 * @param x The new position.
12219 * @param y The new position.
12221 * Sets the top-left position of the menu to (@p x,@p y).
12223 * @note @p x and @p y coordinates are relative to parent.
12225 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12227 * @brief Close a opened menu
12229 * @param obj the menu object
12232 * Hides the menu and all it's sub-menus.
12234 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12236 * @brief Returns a list of @p item's items.
12238 * @param obj The menu object
12239 * @return An Eina_List* of @p item's items
12241 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12243 * @brief Get the Evas_Object of an Elm_Menu_Item
12245 * @param item The menu item object.
12246 * @return The edje object containing the swallowed content
12248 * @warning Don't manipulate this object!
12250 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12252 * @brief Add an item at the end of the given menu widget
12254 * @param obj The menu object.
12255 * @param parent The parent menu item (optional)
12256 * @param icon A icon display on the item. The icon will be destryed by the menu.
12257 * @param label The label of the item.
12258 * @param func Function called when the user select the item.
12259 * @param data Data sent by the callback.
12260 * @return Returns the new item.
12262 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);
12264 * @brief Add an object swallowed in an item at the end of the given menu
12267 * @param obj The menu object.
12268 * @param parent The parent menu item (optional)
12269 * @param subobj The object to swallow
12270 * @param func Function called when the user select the item.
12271 * @param data Data sent by the callback.
12272 * @return Returns the new item.
12274 * Add an evas object as an item to the menu.
12276 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);
12278 * @brief Set the label of a menu item
12280 * @param item The menu item object.
12281 * @param label The label to set for @p item
12283 * @warning Don't use this funcion on items created with
12284 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12286 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12288 * @brief Get the label of a menu item
12290 * @param item The menu item object.
12291 * @return The label of @p item
12293 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12295 * @brief Set the icon of a menu item to the standard icon with name @p icon
12297 * @param item The menu item object.
12298 * @param icon The icon object to set for the content of @p item
12300 * Once this icon is set, any previously set icon will be deleted.
12302 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12304 * @brief Get the string representation from the icon of a menu item
12306 * @param item The menu item object.
12307 * @return The string representation of @p item's icon or NULL
12309 * @see elm_menu_item_object_icon_name_set()
12311 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12313 * @brief Set the content object of a menu item
12315 * @param item The menu item object
12316 * @param The content object or NULL
12317 * @return EINA_TRUE on success, else EINA_FALSE
12319 * Use this function to change the object swallowed by a menu item, deleting
12320 * any previously swallowed object.
12322 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12324 * @brief Get the content object of a menu item
12326 * @param item The menu item object
12327 * @return The content object or NULL
12328 * @note If @p item was added with elm_menu_item_add_object, this
12329 * function will return the object passed, else it will return the
12332 * @see elm_menu_item_object_content_set()
12334 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12336 * @brief Set the selected state of @p item.
12338 * @param item The menu item object.
12339 * @param selected The selected/unselected state of the item
12341 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12343 * @brief Get the selected state of @p item.
12345 * @param item The menu item object.
12346 * @return The selected/unselected state of the item
12348 * @see elm_menu_item_selected_set()
12350 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12352 * @brief Set the disabled state of @p item.
12354 * @param item The menu item object.
12355 * @param disabled The enabled/disabled state of the item
12357 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12359 * @brief Get the disabled state of @p item.
12361 * @param item The menu item object.
12362 * @return The enabled/disabled state of the item
12364 * @see elm_menu_item_disabled_set()
12366 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12368 * @brief Add a separator item to menu @p obj under @p parent.
12370 * @param obj The menu object
12371 * @param parent The item to add the separator under
12372 * @return The created item or NULL on failure
12374 * This is item is a @ref Separator.
12376 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12378 * @brief Returns whether @p item is a separator.
12380 * @param item The item to check
12381 * @return If true, @p item is a separator
12383 * @see elm_menu_item_separator_add()
12385 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12387 * @brief Deletes an item from the menu.
12389 * @param item The item to delete.
12391 * @see elm_menu_item_add()
12393 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12395 * @brief Set the function called when a menu item is deleted.
12397 * @param item The item to set the callback on
12398 * @param func The function called
12400 * @see elm_menu_item_add()
12401 * @see elm_menu_item_del()
12403 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12405 * @brief Returns the data associated with menu item @p item.
12407 * @param item The item
12408 * @return The data associated with @p item or NULL if none was set.
12410 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12412 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12414 * @brief Sets the data to be associated with menu item @p item.
12416 * @param item The item
12417 * @param data The data to be associated with @p item
12419 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12421 * @brief Returns a list of @p item's subitems.
12423 * @param item The item
12424 * @return An Eina_List* of @p item's subitems
12426 * @see elm_menu_add()
12428 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12430 * @brief Get the position of a menu item
12432 * @param item The menu item
12433 * @return The item's index
12435 * This function returns the index position of a menu item in a menu.
12436 * For a sub-menu, this number is relative to the first item in the sub-menu.
12438 * @note Index values begin with 0
12440 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12442 * @brief @brief Return a menu item's owner menu
12444 * @param item The menu item
12445 * @return The menu object owning @p item, or NULL on failure
12447 * Use this function to get the menu object owning an item.
12449 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12451 * @brief Get the selected item in the menu
12453 * @param obj The menu object
12454 * @return The selected item, or NULL if none
12456 * @see elm_menu_item_selected_get()
12457 * @see elm_menu_item_selected_set()
12459 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12461 * @brief Get the last item in the menu
12463 * @param obj The menu object
12464 * @return The last item, or NULL if none
12466 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12468 * @brief Get the first item in the menu
12470 * @param obj The menu object
12471 * @return The first item, or NULL if none
12473 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12475 * @brief Get the next item in the menu.
12477 * @param item The menu item object.
12478 * @return The item after it, or NULL if none
12480 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12482 * @brief Get the previous item in the menu.
12484 * @param item The menu item object.
12485 * @return The item before it, or NULL if none
12487 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12493 * @defgroup List List
12494 * @ingroup Elementary
12496 * @image html img/widget/list/preview-00.png
12497 * @image latex img/widget/list/preview-00.eps width=\textwidth
12499 * @image html img/list.png
12500 * @image latex img/list.eps width=\textwidth
12502 * A list widget is a container whose children are displayed vertically or
12503 * horizontally, in order, and can be selected.
12504 * The list can accept only one or multiple items selection. Also has many
12505 * modes of items displaying.
12507 * A list is a very simple type of list widget. For more robust
12508 * lists, @ref Genlist should probably be used.
12510 * Smart callbacks one can listen to:
12511 * - @c "activated" - The user has double-clicked or pressed
12512 * (enter|return|spacebar) on an item. The @c event_info parameter
12513 * is the item that was activated.
12514 * - @c "clicked,double" - The user has double-clicked an item.
12515 * The @c event_info parameter is the item that was double-clicked.
12516 * - "selected" - when the user selected an item
12517 * - "unselected" - when the user unselected an item
12518 * - "longpressed" - an item in the list is long-pressed
12519 * - "scroll,edge,top" - the list is scrolled until the top edge
12520 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12521 * - "scroll,edge,left" - the list is scrolled until the left edge
12522 * - "scroll,edge,right" - the list is scrolled until the right edge
12524 * Available styles for it:
12527 * List of examples:
12528 * @li @ref list_example_01
12529 * @li @ref list_example_02
12530 * @li @ref list_example_03
12539 * @enum _Elm_List_Mode
12540 * @typedef Elm_List_Mode
12542 * Set list's resize behavior, transverse axis scroll and
12543 * items cropping. See each mode's description for more details.
12545 * @note Default value is #ELM_LIST_SCROLL.
12547 * Values <b> don't </b> work as bitmask, only one can be choosen.
12549 * @see elm_list_mode_set()
12550 * @see elm_list_mode_get()
12554 typedef enum _Elm_List_Mode
12556 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. */
12557 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). */
12558 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. */
12559 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. */
12560 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12563 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(). */
12566 * Add a new list widget to the given parent Elementary
12567 * (container) object.
12569 * @param parent The parent object.
12570 * @return a new list widget handle or @c NULL, on errors.
12572 * This function inserts a new list widget on the canvas.
12576 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12581 * @param obj The list object
12583 * @note Call before running show() on the list object.
12584 * @warning If not called, it won't display the list properly.
12587 * li = elm_list_add(win);
12588 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12589 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12591 * evas_object_show(li);
12596 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12599 * Enable or disable multiple items selection on the list object.
12601 * @param obj The list object
12602 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12605 * Disabled by default. If disabled, the user can select a single item of
12606 * the list each time. Selected items are highlighted on list.
12607 * If enabled, many items can be selected.
12609 * If a selected item is selected again, it will be unselected.
12611 * @see elm_list_multi_select_get()
12615 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12618 * Get a value whether multiple items selection is enabled or not.
12620 * @see elm_list_multi_select_set() for details.
12622 * @param obj The list object.
12623 * @return @c EINA_TRUE means multiple items selection is enabled.
12624 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12625 * @c EINA_FALSE is returned.
12629 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12632 * Set which mode to use for the list object.
12634 * @param obj The list object
12635 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12636 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12638 * Set list's resize behavior, transverse axis scroll and
12639 * items cropping. See each mode's description for more details.
12641 * @note Default value is #ELM_LIST_SCROLL.
12643 * Only one can be set, if a previous one was set, it will be changed
12644 * by the new mode set. Bitmask won't work as well.
12646 * @see elm_list_mode_get()
12650 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12653 * Get the mode the list is at.
12655 * @param obj The list object
12656 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12657 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12659 * @note see elm_list_mode_set() for more information.
12663 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12666 * Enable or disable horizontal mode on the list object.
12668 * @param obj The list object.
12669 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12670 * disable it, i.e., to enable vertical mode.
12672 * @note Vertical mode is set by default.
12674 * On horizontal mode items are displayed on list from left to right,
12675 * instead of from top to bottom. Also, the list will scroll horizontally.
12676 * Each item will presents left icon on top and right icon, or end, at
12679 * @see elm_list_horizontal_get()
12683 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12686 * Get a value whether horizontal mode is enabled or not.
12688 * @param obj The list object.
12689 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12690 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12691 * @c EINA_FALSE is returned.
12693 * @see elm_list_horizontal_set() for details.
12697 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12700 * Enable or disable always select mode on the list object.
12702 * @param obj The list object
12703 * @param always_select @c EINA_TRUE to enable always select mode or
12704 * @c EINA_FALSE to disable it.
12706 * @note Always select mode is disabled by default.
12708 * Default behavior of list items is to only call its callback function
12709 * the first time it's pressed, i.e., when it is selected. If a selected
12710 * item is pressed again, and multi-select is disabled, it won't call
12711 * this function (if multi-select is enabled it will unselect the item).
12713 * If always select is enabled, it will call the callback function
12714 * everytime a item is pressed, so it will call when the item is selected,
12715 * and again when a selected item is pressed.
12717 * @see elm_list_always_select_mode_get()
12718 * @see elm_list_multi_select_set()
12722 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12725 * Get a value whether always select mode is enabled or not, meaning that
12726 * an item will always call its callback function, even if already selected.
12728 * @param obj The list object
12729 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12730 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12731 * @c EINA_FALSE is returned.
12733 * @see elm_list_always_select_mode_set() for details.
12737 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12740 * Set bouncing behaviour when the scrolled content reaches an edge.
12742 * Tell the internal scroller object whether it should bounce or not
12743 * when it reaches the respective edges for each axis.
12745 * @param obj The list object
12746 * @param h_bounce Whether to bounce or not in the horizontal axis.
12747 * @param v_bounce Whether to bounce or not in the vertical axis.
12749 * @see elm_scroller_bounce_set()
12753 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12756 * Get the bouncing behaviour of the internal scroller.
12758 * Get whether the internal scroller should bounce when the edge of each
12759 * axis is reached scrolling.
12761 * @param obj The list object.
12762 * @param h_bounce Pointer where to store the bounce state of the horizontal
12764 * @param v_bounce Pointer where to store the bounce state of the vertical
12767 * @see elm_scroller_bounce_get()
12768 * @see elm_list_bounce_set()
12772 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12775 * Set the scrollbar policy.
12777 * @param obj The list object
12778 * @param policy_h Horizontal scrollbar policy.
12779 * @param policy_v Vertical scrollbar policy.
12781 * This sets the scrollbar visibility policy for the given scroller.
12782 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12783 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12784 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12785 * This applies respectively for the horizontal and vertical scrollbars.
12787 * The both are disabled by default, i.e., are set to
12788 * #ELM_SCROLLER_POLICY_OFF.
12792 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12795 * Get the scrollbar policy.
12797 * @see elm_list_scroller_policy_get() for details.
12799 * @param obj The list object.
12800 * @param policy_h Pointer where to store horizontal scrollbar policy.
12801 * @param policy_v Pointer where to store vertical scrollbar policy.
12805 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);
12808 * Append a new item to the list object.
12810 * @param obj The list object.
12811 * @param label The label of the list item.
12812 * @param icon The icon object to use for the left side of the item. An
12813 * icon can be any Evas object, but usually it is an icon created
12814 * with elm_icon_add().
12815 * @param end The icon object to use for the right side of the item. An
12816 * icon can be any Evas object.
12817 * @param func The function to call when the item is clicked.
12818 * @param data The data to associate with the item for related callbacks.
12820 * @return The created item or @c NULL upon failure.
12822 * A new item will be created and appended to the list, i.e., will
12823 * be set as @b last item.
12825 * Items created with this method can be deleted with
12826 * elm_list_item_del().
12828 * Associated @p data can be properly freed when item is deleted if a
12829 * callback function is set with elm_list_item_del_cb_set().
12831 * If a function is passed as argument, it will be called everytime this item
12832 * is selected, i.e., the user clicks over an unselected item.
12833 * If always select is enabled it will call this function every time
12834 * user clicks over an item (already selected or not).
12835 * If such function isn't needed, just passing
12836 * @c NULL as @p func is enough. The same should be done for @p data.
12838 * Simple example (with no function callback or data associated):
12840 * li = elm_list_add(win);
12841 * ic = elm_icon_add(win);
12842 * elm_icon_file_set(ic, "path/to/image", NULL);
12843 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12844 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12846 * evas_object_show(li);
12849 * @see elm_list_always_select_mode_set()
12850 * @see elm_list_item_del()
12851 * @see elm_list_item_del_cb_set()
12852 * @see elm_list_clear()
12853 * @see elm_icon_add()
12857 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);
12860 * Prepend a new item to the list object.
12862 * @param obj The list object.
12863 * @param label The label of the list item.
12864 * @param icon The icon object to use for the left side of the item. An
12865 * icon can be any Evas object, but usually it is an icon created
12866 * with elm_icon_add().
12867 * @param end The icon object to use for the right side of the item. An
12868 * icon can be any Evas object.
12869 * @param func The function to call when the item is clicked.
12870 * @param data The data to associate with the item for related callbacks.
12872 * @return The created item or @c NULL upon failure.
12874 * A new item will be created and prepended to the list, i.e., will
12875 * be set as @b first item.
12877 * Items created with this method can be deleted with
12878 * elm_list_item_del().
12880 * Associated @p data can be properly freed when item is deleted if a
12881 * callback function is set with elm_list_item_del_cb_set().
12883 * If a function is passed as argument, it will be called everytime this item
12884 * is selected, i.e., the user clicks over an unselected item.
12885 * If always select is enabled it will call this function every time
12886 * user clicks over an item (already selected or not).
12887 * If such function isn't needed, just passing
12888 * @c NULL as @p func is enough. The same should be done for @p data.
12890 * @see elm_list_item_append() for a simple code example.
12891 * @see elm_list_always_select_mode_set()
12892 * @see elm_list_item_del()
12893 * @see elm_list_item_del_cb_set()
12894 * @see elm_list_clear()
12895 * @see elm_icon_add()
12899 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);
12902 * Insert a new item into the list object before item @p before.
12904 * @param obj The list object.
12905 * @param before The list item to insert before.
12906 * @param label The label of the list item.
12907 * @param icon The icon object to use for the left side of the item. An
12908 * icon can be any Evas object, but usually it is an icon created
12909 * with elm_icon_add().
12910 * @param end The icon object to use for the right side of the item. An
12911 * icon can be any Evas object.
12912 * @param func The function to call when the item is clicked.
12913 * @param data The data to associate with the item for related callbacks.
12915 * @return The created item or @c NULL upon failure.
12917 * A new item will be created and added to the list. Its position in
12918 * this list will be just before item @p before.
12920 * Items created with this method can be deleted with
12921 * elm_list_item_del().
12923 * Associated @p data can be properly freed when item is deleted if a
12924 * callback function is set with elm_list_item_del_cb_set().
12926 * If a function is passed as argument, it will be called everytime this item
12927 * is selected, i.e., the user clicks over an unselected item.
12928 * If always select is enabled it will call this function every time
12929 * user clicks over an item (already selected or not).
12930 * If such function isn't needed, just passing
12931 * @c NULL as @p func is enough. The same should be done for @p data.
12933 * @see elm_list_item_append() for a simple code example.
12934 * @see elm_list_always_select_mode_set()
12935 * @see elm_list_item_del()
12936 * @see elm_list_item_del_cb_set()
12937 * @see elm_list_clear()
12938 * @see elm_icon_add()
12942 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);
12945 * Insert a new item into the list object after item @p after.
12947 * @param obj The list object.
12948 * @param after The list item to insert after.
12949 * @param label The label of the list item.
12950 * @param icon The icon object to use for the left side of the item. An
12951 * icon can be any Evas object, but usually it is an icon created
12952 * with elm_icon_add().
12953 * @param end The icon object to use for the right side of the item. An
12954 * icon can be any Evas object.
12955 * @param func The function to call when the item is clicked.
12956 * @param data The data to associate with the item for related callbacks.
12958 * @return The created item or @c NULL upon failure.
12960 * A new item will be created and added to the list. Its position in
12961 * this list will be just after item @p after.
12963 * Items created with this method can be deleted with
12964 * elm_list_item_del().
12966 * Associated @p data can be properly freed when item is deleted if a
12967 * callback function is set with elm_list_item_del_cb_set().
12969 * If a function is passed as argument, it will be called everytime this item
12970 * is selected, i.e., the user clicks over an unselected item.
12971 * If always select is enabled it will call this function every time
12972 * user clicks over an item (already selected or not).
12973 * If such function isn't needed, just passing
12974 * @c NULL as @p func is enough. The same should be done for @p data.
12976 * @see elm_list_item_append() for a simple code example.
12977 * @see elm_list_always_select_mode_set()
12978 * @see elm_list_item_del()
12979 * @see elm_list_item_del_cb_set()
12980 * @see elm_list_clear()
12981 * @see elm_icon_add()
12985 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);
12988 * Insert a new item into the sorted list object.
12990 * @param obj The list object.
12991 * @param label The label of the list item.
12992 * @param icon The icon object to use for the left side of the item. An
12993 * icon can be any Evas object, but usually it is an icon created
12994 * with elm_icon_add().
12995 * @param end The icon object to use for the right side of the item. An
12996 * icon can be any Evas object.
12997 * @param func The function to call when the item is clicked.
12998 * @param data The data to associate with the item for related callbacks.
12999 * @param cmp_func The comparing function to be used to sort list
13000 * items <b>by #Elm_List_Item item handles</b>. This function will
13001 * receive two items and compare them, returning a non-negative integer
13002 * if the second item should be place after the first, or negative value
13003 * if should be placed before.
13005 * @return The created item or @c NULL upon failure.
13007 * @note This function inserts values into a list object assuming it was
13008 * sorted and the result will be sorted.
13010 * A new item will be created and added to the list. Its position in
13011 * this list will be found comparing the new item with previously inserted
13012 * items using function @p cmp_func.
13014 * Items created with this method can be deleted with
13015 * elm_list_item_del().
13017 * Associated @p data can be properly freed when item is deleted if a
13018 * callback function is set with elm_list_item_del_cb_set().
13020 * If a function is passed as argument, it will be called everytime this item
13021 * is selected, i.e., the user clicks over an unselected item.
13022 * If always select is enabled it will call this function every time
13023 * user clicks over an item (already selected or not).
13024 * If such function isn't needed, just passing
13025 * @c NULL as @p func is enough. The same should be done for @p data.
13027 * @see elm_list_item_append() for a simple code example.
13028 * @see elm_list_always_select_mode_set()
13029 * @see elm_list_item_del()
13030 * @see elm_list_item_del_cb_set()
13031 * @see elm_list_clear()
13032 * @see elm_icon_add()
13036 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);
13039 * Remove all list's items.
13041 * @param obj The list object
13043 * @see elm_list_item_del()
13044 * @see elm_list_item_append()
13048 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13051 * Get a list of all the list items.
13053 * @param obj The list object
13054 * @return An @c Eina_List of list items, #Elm_List_Item,
13055 * or @c NULL on failure.
13057 * @see elm_list_item_append()
13058 * @see elm_list_item_del()
13059 * @see elm_list_clear()
13063 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13066 * Get the selected item.
13068 * @param obj The list object.
13069 * @return The selected list item.
13071 * The selected item can be unselected with function
13072 * elm_list_item_selected_set().
13074 * The selected item always will be highlighted on list.
13076 * @see elm_list_selected_items_get()
13080 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13083 * Return a list of the currently selected list items.
13085 * @param obj The list object.
13086 * @return An @c Eina_List of list items, #Elm_List_Item,
13087 * or @c NULL on failure.
13089 * Multiple items can be selected if multi select is enabled. It can be
13090 * done with elm_list_multi_select_set().
13092 * @see elm_list_selected_item_get()
13093 * @see elm_list_multi_select_set()
13097 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13100 * Set the selected state of an item.
13102 * @param item The list item
13103 * @param selected The selected state
13105 * This sets the selected state of the given item @p it.
13106 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13108 * If a new item is selected the previosly selected will be unselected,
13109 * unless multiple selection is enabled with elm_list_multi_select_set().
13110 * Previoulsy selected item can be get with function
13111 * elm_list_selected_item_get().
13113 * Selected items will be highlighted.
13115 * @see elm_list_item_selected_get()
13116 * @see elm_list_selected_item_get()
13117 * @see elm_list_multi_select_set()
13121 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13124 * Get whether the @p item is selected or not.
13126 * @param item The list item.
13127 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13128 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13130 * @see elm_list_selected_item_set() for details.
13131 * @see elm_list_item_selected_get()
13135 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13138 * Set or unset item as a separator.
13140 * @param it The list item.
13141 * @param setting @c EINA_TRUE to set item @p it as separator or
13142 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13144 * Items aren't set as separator by default.
13146 * If set as separator it will display separator theme, so won't display
13149 * @see elm_list_item_separator_get()
13153 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
13156 * Get a value whether item is a separator or not.
13158 * @see elm_list_item_separator_set() for details.
13160 * @param it The list item.
13161 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13162 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13166 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13169 * Show @p item in the list view.
13171 * @param item The list item to be shown.
13173 * It won't animate list until item is visible. If such behavior is wanted,
13174 * use elm_list_bring_in() intead.
13178 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13181 * Bring in the given item to list view.
13183 * @param item The item.
13185 * This causes list to jump to the given item @p item and show it
13186 * (by scrolling), if it is not fully visible.
13188 * This may use animation to do so and take a period of time.
13190 * If animation isn't wanted, elm_list_item_show() can be used.
13194 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13197 * Delete them item from the list.
13199 * @param item The item of list to be deleted.
13201 * If deleting all list items is required, elm_list_clear()
13202 * should be used instead of getting items list and deleting each one.
13204 * @see elm_list_clear()
13205 * @see elm_list_item_append()
13206 * @see elm_list_item_del_cb_set()
13210 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13213 * Set the function called when a list item is freed.
13215 * @param item The item to set the callback on
13216 * @param func The function called
13218 * If there is a @p func, then it will be called prior item's memory release.
13219 * That will be called with the following arguments:
13221 * @li item's Evas object;
13224 * This way, a data associated to a list item could be properly freed.
13228 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13231 * Get the data associated to the item.
13233 * @param item The list item
13234 * @return The data associated to @p item
13236 * The return value is a pointer to data associated to @p item when it was
13237 * created, with function elm_list_item_append() or similar. If no data
13238 * was passed as argument, it will return @c NULL.
13240 * @see elm_list_item_append()
13244 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13247 * Get the left side icon associated to the item.
13249 * @param item The list item
13250 * @return The left side icon associated to @p item
13252 * The return value is a pointer to the icon associated to @p item when
13254 * created, with function elm_list_item_append() or similar, or later
13255 * with function elm_list_item_icon_set(). If no icon
13256 * was passed as argument, it will return @c NULL.
13258 * @see elm_list_item_append()
13259 * @see elm_list_item_icon_set()
13263 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13266 * Set the left side icon associated to the item.
13268 * @param item The list item
13269 * @param icon The left side icon object to associate with @p item
13271 * The icon object to use at left side of the item. An
13272 * icon can be any Evas object, but usually it is an icon created
13273 * with elm_icon_add().
13275 * Once the icon object is set, a previously set one will be deleted.
13276 * @warning Setting the same icon for two items will cause the icon to
13277 * dissapear from the first item.
13279 * If an icon was passed as argument on item creation, with function
13280 * elm_list_item_append() or similar, it will be already
13281 * associated to the item.
13283 * @see elm_list_item_append()
13284 * @see elm_list_item_icon_get()
13288 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13291 * Get the right side icon associated to the item.
13293 * @param item The list item
13294 * @return The right side icon associated to @p item
13296 * The return value is a pointer to the icon associated to @p item when
13298 * created, with function elm_list_item_append() or similar, or later
13299 * with function elm_list_item_icon_set(). If no icon
13300 * was passed as argument, it will return @c NULL.
13302 * @see elm_list_item_append()
13303 * @see elm_list_item_icon_set()
13307 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13310 * Set the right side icon associated to the item.
13312 * @param item The list item
13313 * @param end The right side icon object to associate with @p item
13315 * The icon object to use at right side of the item. An
13316 * icon can be any Evas object, but usually it is an icon created
13317 * with elm_icon_add().
13319 * Once the icon object is set, a previously set one will be deleted.
13320 * @warning Setting the same icon for two items will cause the icon to
13321 * dissapear from the first item.
13323 * If an icon was passed as argument on item creation, with function
13324 * elm_list_item_append() or similar, it will be already
13325 * associated to the item.
13327 * @see elm_list_item_append()
13328 * @see elm_list_item_end_get()
13332 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13335 * Gets the base object of the item.
13337 * @param item The list item
13338 * @return The base object associated with @p item
13340 * Base object is the @c Evas_Object that represents that item.
13344 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13347 * Get the label of item.
13349 * @param item The item of list.
13350 * @return The label of item.
13352 * The return value is a pointer to the label associated to @p item when
13353 * it was created, with function elm_list_item_append(), or later
13354 * with function elm_list_item_label_set. If no label
13355 * was passed as argument, it will return @c NULL.
13357 * @see elm_list_item_label_set() for more details.
13358 * @see elm_list_item_append()
13362 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13365 * Set the label of item.
13367 * @param item The item of list.
13368 * @param text The label of item.
13370 * The label to be displayed by the item.
13371 * Label will be placed between left and right side icons (if set).
13373 * If a label was passed as argument on item creation, with function
13374 * elm_list_item_append() or similar, it will be already
13375 * displayed by the item.
13377 * @see elm_list_item_label_get()
13378 * @see elm_list_item_append()
13382 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13386 * Get the item before @p it in list.
13388 * @param it The list item.
13389 * @return The item before @p it, or @c NULL if none or on failure.
13391 * @note If it is the first item, @c NULL will be returned.
13393 * @see elm_list_item_append()
13394 * @see elm_list_items_get()
13398 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13401 * Get the item after @p it in list.
13403 * @param it The list item.
13404 * @return The item after @p it, or @c NULL if none or on failure.
13406 * @note If it is the last item, @c NULL will be returned.
13408 * @see elm_list_item_append()
13409 * @see elm_list_items_get()
13413 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13416 * Sets the disabled/enabled state of a list item.
13418 * @param it The item.
13419 * @param disabled The disabled state.
13421 * A disabled item cannot be selected or unselected. It will also
13422 * change its appearance (generally greyed out). This sets the
13423 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13428 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13431 * Get a value whether list item is disabled or not.
13433 * @param it The item.
13434 * @return The disabled state.
13436 * @see elm_list_item_disabled_set() for more details.
13440 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13443 * Set the text to be shown in a given list item's tooltips.
13445 * @param item Target item.
13446 * @param text The text to set in the content.
13448 * Setup the text as tooltip to object. The item can have only one tooltip,
13449 * so any previous tooltip data - set with this function or
13450 * elm_list_item_tooltip_content_cb_set() - is removed.
13452 * @see elm_object_tooltip_text_set() for more details.
13456 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13460 * @brief Disable size restrictions on an object's tooltip
13461 * @param item The tooltip's anchor object
13462 * @param disable If EINA_TRUE, size restrictions are disabled
13463 * @return EINA_FALSE on failure, EINA_TRUE on success
13465 * This function allows a tooltip to expand beyond its parant window's canvas.
13466 * It will instead be limited only by the size of the display.
13468 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13470 * @brief Retrieve size restriction state of an object's tooltip
13471 * @param obj The tooltip's anchor object
13472 * @return If EINA_TRUE, size restrictions are disabled
13474 * This function returns whether a tooltip is allowed to expand beyond
13475 * its parant window's canvas.
13476 * It will instead be limited only by the size of the display.
13478 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13481 * Set the content to be shown in the tooltip item.
13483 * Setup the tooltip to item. The item can have only one tooltip,
13484 * so any previous tooltip data is removed. @p func(with @p data) will
13485 * be called every time that need show the tooltip and it should
13486 * return a valid Evas_Object. This object is then managed fully by
13487 * tooltip system and is deleted when the tooltip is gone.
13489 * @param item the list item being attached a tooltip.
13490 * @param func the function used to create the tooltip contents.
13491 * @param data what to provide to @a func as callback data/context.
13492 * @param del_cb called when data is not needed anymore, either when
13493 * another callback replaces @a func, the tooltip is unset with
13494 * elm_list_item_tooltip_unset() or the owner @a item
13495 * dies. This callback receives as the first parameter the
13496 * given @a data, and @c event_info is the item.
13498 * @see elm_object_tooltip_content_cb_set() for more details.
13502 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);
13505 * Unset tooltip from item.
13507 * @param item list item to remove previously set tooltip.
13509 * Remove tooltip from item. The callback provided as del_cb to
13510 * elm_list_item_tooltip_content_cb_set() will be called to notify
13511 * it is not used anymore.
13513 * @see elm_object_tooltip_unset() for more details.
13514 * @see elm_list_item_tooltip_content_cb_set()
13518 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13521 * Sets a different style for this item tooltip.
13523 * @note before you set a style you should define a tooltip with
13524 * elm_list_item_tooltip_content_cb_set() or
13525 * elm_list_item_tooltip_text_set()
13527 * @param item list item with tooltip already set.
13528 * @param style the theme style to use (default, transparent, ...)
13530 * @see elm_object_tooltip_style_set() for more details.
13534 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13537 * Get the style for this item tooltip.
13539 * @param item list item with tooltip already set.
13540 * @return style the theme style in use, defaults to "default". If the
13541 * object does not have a tooltip set, then NULL is returned.
13543 * @see elm_object_tooltip_style_get() for more details.
13544 * @see elm_list_item_tooltip_style_set()
13548 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13551 * Set the type of mouse pointer/cursor decoration to be shown,
13552 * when the mouse pointer is over the given list widget item
13554 * @param item list item to customize cursor on
13555 * @param cursor the cursor type's name
13557 * This function works analogously as elm_object_cursor_set(), but
13558 * here the cursor's changing area is restricted to the item's
13559 * area, and not the whole widget's. Note that that item cursors
13560 * have precedence over widget cursors, so that a mouse over an
13561 * item with custom cursor set will always show @b that cursor.
13563 * If this function is called twice for an object, a previously set
13564 * cursor will be unset on the second call.
13566 * @see elm_object_cursor_set()
13567 * @see elm_list_item_cursor_get()
13568 * @see elm_list_item_cursor_unset()
13572 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13575 * Get the type of mouse pointer/cursor decoration set to be shown,
13576 * when the mouse pointer is over the given list widget item
13578 * @param item list item with custom cursor set
13579 * @return the cursor type's name or @c NULL, if no custom cursors
13580 * were set to @p item (and on errors)
13582 * @see elm_object_cursor_get()
13583 * @see elm_list_item_cursor_set()
13584 * @see elm_list_item_cursor_unset()
13588 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13591 * Unset any custom mouse pointer/cursor decoration set to be
13592 * shown, when the mouse pointer is over the given list widget
13593 * item, thus making it show the @b default cursor again.
13595 * @param item a list item
13597 * Use this call to undo any custom settings on this item's cursor
13598 * decoration, bringing it back to defaults (no custom style set).
13600 * @see elm_object_cursor_unset()
13601 * @see elm_list_item_cursor_set()
13605 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13608 * Set a different @b style for a given custom cursor set for a
13611 * @param item list item with custom cursor set
13612 * @param style the <b>theme style</b> to use (e.g. @c "default",
13613 * @c "transparent", etc)
13615 * This function only makes sense when one is using custom mouse
13616 * cursor decorations <b>defined in a theme file</b>, which can have,
13617 * given a cursor name/type, <b>alternate styles</b> on it. It
13618 * works analogously as elm_object_cursor_style_set(), but here
13619 * applyed only to list item objects.
13621 * @warning Before you set a cursor style you should have definen a
13622 * custom cursor previously on the item, with
13623 * elm_list_item_cursor_set()
13625 * @see elm_list_item_cursor_engine_only_set()
13626 * @see elm_list_item_cursor_style_get()
13630 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13633 * Get the current @b style set for a given list item's custom
13636 * @param item list item with custom cursor set.
13637 * @return style the cursor style in use. If the object does not
13638 * have a cursor set, then @c NULL is returned.
13640 * @see elm_list_item_cursor_style_set() for more details
13644 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13647 * Set if the (custom)cursor for a given list item should be
13648 * searched in its theme, also, or should only rely on the
13649 * rendering engine.
13651 * @param item item with custom (custom) cursor already set on
13652 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13653 * only on those provided by the rendering engine, @c EINA_FALSE to
13654 * have them searched on the widget's theme, as well.
13656 * @note This call is of use only if you've set a custom cursor
13657 * for list items, with elm_list_item_cursor_set().
13659 * @note By default, cursors will only be looked for between those
13660 * provided by the rendering engine.
13664 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13667 * Get if the (custom) cursor for a given list item is being
13668 * searched in its theme, also, or is only relying on the rendering
13671 * @param item a list item
13672 * @return @c EINA_TRUE, if cursors are being looked for only on
13673 * those provided by the rendering engine, @c EINA_FALSE if they
13674 * are being searched on the widget's theme, as well.
13676 * @see elm_list_item_cursor_engine_only_set(), for more details
13680 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13687 * @defgroup Slider Slider
13688 * @ingroup Elementary
13690 * @image html img/widget/slider/preview-00.png
13691 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13693 * The slider adds a dragable “slider” widget for selecting the value of
13694 * something within a range.
13696 * A slider can be horizontal or vertical. It can contain an Icon and has a
13697 * primary label as well as a units label (that is formatted with floating
13698 * point values and thus accepts a printf-style format string, like
13699 * “%1.2f units”. There is also an indicator string that may be somewhere
13700 * else (like on the slider itself) that also accepts a format string like
13701 * units. Label, Icon Unit and Indicator strings/objects are optional.
13703 * A slider may be inverted which means values invert, with high vales being
13704 * on the left or top and low values on the right or bottom (as opposed to
13705 * normally being low on the left or top and high on the bottom and right).
13707 * The slider should have its minimum and maximum values set by the
13708 * application with elm_slider_min_max_set() and value should also be set by
13709 * the application before use with elm_slider_value_set(). The span of the
13710 * slider is its length (horizontally or vertically). This will be scaled by
13711 * the object or applications scaling factor. At any point code can query the
13712 * slider for its value with elm_slider_value_get().
13714 * Smart callbacks one can listen to:
13715 * - "changed" - Whenever the slider value is changed by the user.
13716 * - "slider,drag,start" - dragging the slider indicator around has started.
13717 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13718 * - "delay,changed" - A short time after the value is changed by the user.
13719 * This will be called only when the user stops dragging for
13720 * a very short period or when they release their
13721 * finger/mouse, so it avoids possibly expensive reactions to
13722 * the value change.
13724 * Available styles for it:
13727 * Here is an example on its usage:
13728 * @li @ref slider_example
13732 * @addtogroup Slider
13737 * Add a new slider widget to the given parent Elementary
13738 * (container) object.
13740 * @param parent The parent object.
13741 * @return a new slider widget handle or @c NULL, on errors.
13743 * This function inserts a new slider widget on the canvas.
13747 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13750 * Set the label of a given slider widget
13752 * @param obj The progress bar object
13753 * @param label The text label string, in UTF-8
13756 * @deprecated use elm_object_text_set() instead.
13758 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13761 * Get the label of a given slider widget
13763 * @param obj The progressbar object
13764 * @return The text label string, in UTF-8
13767 * @deprecated use elm_object_text_get() instead.
13769 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13772 * Set the icon object of the slider object.
13774 * @param obj The slider object.
13775 * @param icon The icon object.
13777 * On horizontal mode, icon is placed at left, and on vertical mode,
13780 * @note Once the icon object is set, a previously set one will be deleted.
13781 * If you want to keep that old content object, use the
13782 * elm_slider_icon_unset() function.
13784 * @warning If the object being set does not have minimum size hints set,
13785 * it won't get properly displayed.
13789 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13792 * Unset an icon set on a given slider widget.
13794 * @param obj The slider object.
13795 * @return The icon object that was being used, if any was set, or
13796 * @c NULL, otherwise (and on errors).
13798 * On horizontal mode, icon is placed at left, and on vertical mode,
13801 * This call will unparent and return the icon object which was set
13802 * for this widget, previously, on success.
13804 * @see elm_slider_icon_set() for more details
13805 * @see elm_slider_icon_get()
13809 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13812 * Retrieve the icon object set for a given slider widget.
13814 * @param obj The slider object.
13815 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13816 * otherwise (and on errors).
13818 * On horizontal mode, icon is placed at left, and on vertical mode,
13821 * @see elm_slider_icon_set() for more details
13822 * @see elm_slider_icon_unset()
13826 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13829 * Set the end object of the slider object.
13831 * @param obj The slider object.
13832 * @param end The end object.
13834 * On horizontal mode, end is placed at left, and on vertical mode,
13835 * placed at bottom.
13837 * @note Once the icon object is set, a previously set one will be deleted.
13838 * If you want to keep that old content object, use the
13839 * elm_slider_end_unset() function.
13841 * @warning If the object being set does not have minimum size hints set,
13842 * it won't get properly displayed.
13846 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13849 * Unset an end object set on a given slider widget.
13851 * @param obj The slider object.
13852 * @return The end object that was being used, if any was set, or
13853 * @c NULL, otherwise (and on errors).
13855 * On horizontal mode, end is placed at left, and on vertical mode,
13856 * placed at bottom.
13858 * This call will unparent and return the icon object which was set
13859 * for this widget, previously, on success.
13861 * @see elm_slider_end_set() for more details.
13862 * @see elm_slider_end_get()
13866 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13869 * Retrieve the end object set for a given slider widget.
13871 * @param obj The slider object.
13872 * @return The end object's handle, if @p obj had one set, or @c NULL,
13873 * otherwise (and on errors).
13875 * On horizontal mode, icon is placed at right, and on vertical mode,
13876 * placed at bottom.
13878 * @see elm_slider_end_set() for more details.
13879 * @see elm_slider_end_unset()
13883 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13886 * Set the (exact) length of the bar region of a given slider widget.
13888 * @param obj The slider object.
13889 * @param size The length of the slider's bar region.
13891 * This sets the minimum width (when in horizontal mode) or height
13892 * (when in vertical mode) of the actual bar area of the slider
13893 * @p obj. This in turn affects the object's minimum size. Use
13894 * this when you're not setting other size hints expanding on the
13895 * given direction (like weight and alignment hints) and you would
13896 * like it to have a specific size.
13898 * @note Icon, end, label, indicator and unit text around @p obj
13899 * will require their
13900 * own space, which will make @p obj to require more the @p size,
13903 * @see elm_slider_span_size_get()
13907 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13910 * Get the length set for the bar region of a given slider widget
13912 * @param obj The slider object.
13913 * @return The length of the slider's bar region.
13915 * If that size was not set previously, with
13916 * elm_slider_span_size_set(), this call will return @c 0.
13920 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13923 * Set the format string for the unit label.
13925 * @param obj The slider object.
13926 * @param format The format string for the unit display.
13928 * Unit label is displayed all the time, if set, after slider's bar.
13929 * In horizontal mode, at right and in vertical mode, at bottom.
13931 * If @c NULL, unit label won't be visible. If not it sets the format
13932 * string for the label text. To the label text is provided a floating point
13933 * value, so the label text can display up to 1 floating point value.
13934 * Note that this is optional.
13936 * Use a format string such as "%1.2f meters" for example, and it will
13937 * display values like: "3.14 meters" for a value equal to 3.14159.
13939 * Default is unit label disabled.
13941 * @see elm_slider_indicator_format_get()
13945 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13948 * Get the unit label format of the slider.
13950 * @param obj The slider object.
13951 * @return The unit label format string in UTF-8.
13953 * Unit label is displayed all the time, if set, after slider's bar.
13954 * In horizontal mode, at right and in vertical mode, at bottom.
13956 * @see elm_slider_unit_format_set() for more
13957 * information on how this works.
13961 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13964 * Set the format string for the indicator label.
13966 * @param obj The slider object.
13967 * @param indicator The format string for the indicator display.
13969 * The slider may display its value somewhere else then unit label,
13970 * for example, above the slider knob that is dragged around. This function
13971 * sets the format string used for this.
13973 * If @c NULL, indicator label won't be visible. If not it sets the format
13974 * string for the label text. To the label text is provided a floating point
13975 * value, so the label text can display up to 1 floating point value.
13976 * Note that this is optional.
13978 * Use a format string such as "%1.2f meters" for example, and it will
13979 * display values like: "3.14 meters" for a value equal to 3.14159.
13981 * Default is indicator label disabled.
13983 * @see elm_slider_indicator_format_get()
13987 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13990 * Get the indicator label format of the slider.
13992 * @param obj The slider object.
13993 * @return The indicator label format string in UTF-8.
13995 * The slider may display its value somewhere else then unit label,
13996 * for example, above the slider knob that is dragged around. This function
13997 * gets the format string used for this.
13999 * @see elm_slider_indicator_format_set() for more
14000 * information on how this works.
14004 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14007 * Set the format function pointer for the indicator label
14009 * @param obj The slider object.
14010 * @param func The indicator format function.
14011 * @param free_func The freeing function for the format string.
14013 * Set the callback function to format the indicator string.
14015 * @see elm_slider_indicator_format_set() for more info on how this works.
14019 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);
14022 * Set the format function pointer for the units label
14024 * @param obj The slider object.
14025 * @param func The units format function.
14026 * @param free_func The freeing function for the format string.
14028 * Set the callback function to format the indicator string.
14030 * @see elm_slider_units_format_set() for more info on how this works.
14034 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);
14037 * Set the orientation of a given slider widget.
14039 * @param obj The slider object.
14040 * @param horizontal Use @c EINA_TRUE to make @p obj to be
14041 * @b horizontal, @c EINA_FALSE to make it @b vertical.
14043 * Use this function to change how your slider is to be
14044 * disposed: vertically or horizontally.
14046 * By default it's displayed horizontally.
14048 * @see elm_slider_horizontal_get()
14052 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14055 * Retrieve the orientation of a given slider widget
14057 * @param obj The slider object.
14058 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
14059 * @c EINA_FALSE if it's @b vertical (and on errors).
14061 * @see elm_slider_horizontal_set() for more details.
14065 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14068 * Set the minimum and maximum values for the slider.
14070 * @param obj The slider object.
14071 * @param min The minimum value.
14072 * @param max The maximum value.
14074 * Define the allowed range of values to be selected by the user.
14076 * If actual value is less than @p min, it will be updated to @p min. If it
14077 * is bigger then @p max, will be updated to @p max. Actual value can be
14078 * get with elm_slider_value_get().
14080 * By default, min is equal to 0.0, and max is equal to 1.0.
14082 * @warning Maximum must be greater than minimum, otherwise behavior
14085 * @see elm_slider_min_max_get()
14089 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
14092 * Get the minimum and maximum values of the slider.
14094 * @param obj The slider object.
14095 * @param min Pointer where to store the minimum value.
14096 * @param max Pointer where to store the maximum value.
14098 * @note If only one value is needed, the other pointer can be passed
14101 * @see elm_slider_min_max_set() for details.
14105 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
14108 * Set the value the slider displays.
14110 * @param obj The slider object.
14111 * @param val The value to be displayed.
14113 * Value will be presented on the unit label following format specified with
14114 * elm_slider_unit_format_set() and on indicator with
14115 * elm_slider_indicator_format_set().
14117 * @warning The value must to be between min and max values. This values
14118 * are set by elm_slider_min_max_set().
14120 * @see elm_slider_value_get()
14121 * @see elm_slider_unit_format_set()
14122 * @see elm_slider_indicator_format_set()
14123 * @see elm_slider_min_max_set()
14127 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
14130 * Get the value displayed by the spinner.
14132 * @param obj The spinner object.
14133 * @return The value displayed.
14135 * @see elm_spinner_value_set() for details.
14139 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14142 * Invert a given slider widget's displaying values order
14144 * @param obj The slider object.
14145 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
14146 * @c EINA_FALSE to bring it back to default, non-inverted values.
14148 * A slider may be @b inverted, in which state it gets its
14149 * values inverted, with high vales being on the left or top and
14150 * low values on the right or bottom, as opposed to normally have
14151 * the low values on the former and high values on the latter,
14152 * respectively, for horizontal and vertical modes.
14154 * @see elm_slider_inverted_get()
14158 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
14161 * Get whether a given slider widget's displaying values are
14164 * @param obj The slider object.
14165 * @return @c EINA_TRUE, if @p obj has inverted values,
14166 * @c EINA_FALSE otherwise (and on errors).
14168 * @see elm_slider_inverted_set() for more details.
14172 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14175 * Set whether to enlarge slider indicator (augmented knob) or not.
14177 * @param obj The slider object.
14178 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
14179 * let the knob always at default size.
14181 * By default, indicator will be bigger while dragged by the user.
14183 * @warning It won't display values set with
14184 * elm_slider_indicator_format_set() if you disable indicator.
14188 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
14191 * Get whether a given slider widget's enlarging indicator or not.
14193 * @param obj The slider object.
14194 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
14195 * @c EINA_FALSE otherwise (and on errors).
14197 * @see elm_slider_indicator_show_set() for details.
14201 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14208 * @addtogroup Actionslider Actionslider
14210 * @image html img/widget/actionslider/preview-00.png
14211 * @image latex img/widget/actionslider/preview-00.eps
14213 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
14214 * properties. The indicator is the element the user drags to choose a label.
14215 * When the position is set with magnet, when released the indicator will be
14216 * moved to it if it's nearest the magnetized position.
14218 * @note By default all positions are set as enabled.
14220 * Signals that you can add callbacks for are:
14222 * "selected" - when user selects an enabled position (the label is passed
14225 * "pos_changed" - when the indicator reaches any of the positions("left",
14226 * "right" or "center").
14228 * See an example of actionslider usage @ref actionslider_example_page "here"
14231 typedef enum _Elm_Actionslider_Pos
14233 ELM_ACTIONSLIDER_NONE = 0,
14234 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14235 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14236 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14237 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14238 } Elm_Actionslider_Pos;
14241 * Add a new actionslider to the parent.
14243 * @param parent The parent object
14244 * @return The new actionslider object or NULL if it cannot be created
14246 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14248 * Set actionslider labels.
14250 * @param obj The actionslider object
14251 * @param left_label The label to be set on the left.
14252 * @param center_label The label to be set on the center.
14253 * @param right_label The label to be set on the right.
14254 * @deprecated use elm_object_text_set() instead.
14256 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);
14258 * Get actionslider labels.
14260 * @param obj The actionslider object
14261 * @param left_label A char** to place the left_label of @p obj into.
14262 * @param center_label A char** to place the center_label of @p obj into.
14263 * @param right_label A char** to place the right_label of @p obj into.
14264 * @deprecated use elm_object_text_set() instead.
14266 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);
14268 * Get actionslider selected label.
14270 * @param obj The actionslider object
14271 * @return The selected label
14273 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14275 * Set actionslider indicator position.
14277 * @param obj The actionslider object.
14278 * @param pos The position of the indicator.
14280 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14282 * Get actionslider indicator position.
14284 * @param obj The actionslider object.
14285 * @return The position of the indicator.
14287 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14289 * Set actionslider magnet position. To make multiple positions magnets @c or
14290 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14292 * @param obj The actionslider object.
14293 * @param pos Bit mask indicating the magnet positions.
14295 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14297 * Get actionslider magnet position.
14299 * @param obj The actionslider object.
14300 * @return The positions with magnet property.
14302 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14304 * Set actionslider enabled position. To set multiple positions as enabled @c or
14305 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14307 * @note All the positions are enabled by default.
14309 * @param obj The actionslider object.
14310 * @param pos Bit mask indicating the enabled positions.
14312 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14314 * Get actionslider enabled position.
14316 * @param obj The actionslider object.
14317 * @return The enabled positions.
14319 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14321 * Set the label used on the indicator.
14323 * @param obj The actionslider object
14324 * @param label The label to be set on the indicator.
14325 * @deprecated use elm_object_text_set() instead.
14327 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14329 * Get the label used on the indicator object.
14331 * @param obj The actionslider object
14332 * @return The indicator label
14333 * @deprecated use elm_object_text_get() instead.
14335 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14341 * @defgroup Genlist Genlist
14343 * @image html img/widget/genlist/preview-00.png
14344 * @image latex img/widget/genlist/preview-00.eps
14345 * @image html img/genlist.png
14346 * @image latex img/genlist.eps
14348 * This widget aims to have more expansive list than the simple list in
14349 * Elementary that could have more flexible items and allow many more entries
14350 * while still being fast and low on memory usage. At the same time it was
14351 * also made to be able to do tree structures. But the price to pay is more
14352 * complexity when it comes to usage. If all you want is a simple list with
14353 * icons and a single label, use the normal @ref List object.
14355 * Genlist has a fairly large API, mostly because it's relatively complex,
14356 * trying to be both expansive, powerful and efficient. First we will begin
14357 * an overview on the theory behind genlist.
14359 * @section Genlist_Item_Class Genlist item classes - creating items
14361 * In order to have the ability to add and delete items on the fly, genlist
14362 * implements a class (callback) system where the application provides a
14363 * structure with information about that type of item (genlist may contain
14364 * multiple different items with different classes, states and styles).
14365 * Genlist will call the functions in this struct (methods) when an item is
14366 * "realized" (i.e., created dynamically, while the user is scrolling the
14367 * grid). All objects will simply be deleted when no longer needed with
14368 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14369 * following members:
14370 * - @c item_style - This is a constant string and simply defines the name
14371 * of the item style. It @b must be specified and the default should be @c
14373 * - @c mode_item_style - This is a constant string and simply defines the
14374 * name of the style that will be used for mode animations. It can be left
14375 * as @c NULL if you don't plan to use Genlist mode. See
14376 * elm_genlist_item_mode_set() for more info.
14378 * - @c func - A struct with pointers to functions that will be called when
14379 * an item is going to be actually created. All of them receive a @c data
14380 * parameter that will point to the same data passed to
14381 * elm_genlist_item_append() and related item creation functions, and a @c
14382 * obj parameter that points to the genlist object itself.
14384 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14385 * state_get and @c del. The 3 first functions also receive a @c part
14386 * parameter described below. A brief description of these functions follows:
14388 * - @c label_get - The @c part parameter is the name string of one of the
14389 * existing text parts in the Edje group implementing the item's theme.
14390 * This function @b must return a strdup'()ed string, as the caller will
14391 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
14392 * - @c icon_get - The @c part parameter is the name string of one of the
14393 * existing (icon) swallow parts in the Edje group implementing the item's
14394 * theme. It must return @c NULL, when no icon is desired, or a valid
14395 * object handle, otherwise. The object will be deleted by the genlist on
14396 * its deletion or when the item is "unrealized". See
14397 * #Elm_Genlist_Item_Icon_Get_Cb.
14398 * - @c func.state_get - The @c part parameter is the name string of one of
14399 * the state parts in the Edje group implementing the item's theme. Return
14400 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14401 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14402 * and @c "elm" as "emission" and "source" arguments, respectively, when
14403 * the state is true (the default is false), where @c XXX is the name of
14404 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
14405 * - @c func.del - This is intended for use when genlist items are deleted,
14406 * so any data attached to the item (e.g. its data parameter on creation)
14407 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
14409 * available item styles:
14411 * - default_style - The text part is a textblock
14413 * @image html img/widget/genlist/preview-04.png
14414 * @image latex img/widget/genlist/preview-04.eps
14418 * @image html img/widget/genlist/preview-01.png
14419 * @image latex img/widget/genlist/preview-01.eps
14421 * - icon_top_text_bottom
14423 * @image html img/widget/genlist/preview-02.png
14424 * @image latex img/widget/genlist/preview-02.eps
14428 * @image html img/widget/genlist/preview-03.png
14429 * @image latex img/widget/genlist/preview-03.eps
14431 * @section Genlist_Items Structure of items
14433 * An item in a genlist can have 0 or more text labels (they can be regular
14434 * text or textblock Evas objects - that's up to the style to determine), 0
14435 * or more icons (which are simply objects swallowed into the genlist item's
14436 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14437 * behavior left to the user to define. The Edje part names for each of
14438 * these properties will be looked up, in the theme file for the genlist,
14439 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14440 * "states", respectively. For each of those properties, if more than one
14441 * part is provided, they must have names listed separated by spaces in the
14442 * data fields. For the default genlist item theme, we have @b one label
14443 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14444 * "elm.swallow.end") and @b no state parts.
14446 * A genlist item may be at one of several styles. Elementary provides one
14447 * by default - "default", but this can be extended by system or application
14448 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14451 * @section Genlist_Manipulation Editing and Navigating
14453 * Items can be added by several calls. All of them return a @ref
14454 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14455 * They all take a data parameter that is meant to be used for a handle to
14456 * the applications internal data (eg the struct with the original item
14457 * data). The parent parameter is the parent genlist item this belongs to if
14458 * it is a tree or an indexed group, and NULL if there is no parent. The
14459 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14460 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14461 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14462 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14463 * is set then this item is group index item that is displayed at the top
14464 * until the next group comes. The func parameter is a convenience callback
14465 * that is called when the item is selected and the data parameter will be
14466 * the func_data parameter, obj be the genlist object and event_info will be
14467 * the genlist item.
14469 * elm_genlist_item_append() adds an item to the end of the list, or if
14470 * there is a parent, to the end of all the child items of the parent.
14471 * elm_genlist_item_prepend() is the same but adds to the beginning of
14472 * the list or children list. elm_genlist_item_insert_before() inserts at
14473 * item before another item and elm_genlist_item_insert_after() inserts after
14474 * the indicated item.
14476 * The application can clear the list with elm_genlist_clear() which deletes
14477 * all the items in the list and elm_genlist_item_del() will delete a specific
14478 * item. elm_genlist_item_subitems_clear() will clear all items that are
14479 * children of the indicated parent item.
14481 * To help inspect list items you can jump to the item at the top of the list
14482 * with elm_genlist_first_item_get() which will return the item pointer, and
14483 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14484 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14485 * and previous items respectively relative to the indicated item. Using
14486 * these calls you can walk the entire item list/tree. Note that as a tree
14487 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14488 * let you know which item is the parent (and thus know how to skip them if
14491 * @section Genlist_Muti_Selection Multi-selection
14493 * If the application wants multiple items to be able to be selected,
14494 * elm_genlist_multi_select_set() can enable this. If the list is
14495 * single-selection only (the default), then elm_genlist_selected_item_get()
14496 * will return the selected item, if any, or NULL I none is selected. If the
14497 * list is multi-select then elm_genlist_selected_items_get() will return a
14498 * list (that is only valid as long as no items are modified (added, deleted,
14499 * selected or unselected)).
14501 * @section Genlist_Usage_Hints Usage hints
14503 * There are also convenience functions. elm_genlist_item_genlist_get() will
14504 * return the genlist object the item belongs to. elm_genlist_item_show()
14505 * will make the scroller scroll to show that specific item so its visible.
14506 * elm_genlist_item_data_get() returns the data pointer set by the item
14507 * creation functions.
14509 * If an item changes (state of boolean changes, label or icons change),
14510 * then use elm_genlist_item_update() to have genlist update the item with
14511 * the new state. Genlist will re-realize the item thus call the functions
14512 * in the _Elm_Genlist_Item_Class for that item.
14514 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14515 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14516 * to expand/contract an item and get its expanded state, use
14517 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14518 * again to make an item disabled (unable to be selected and appear
14519 * differently) use elm_genlist_item_disabled_set() to set this and
14520 * elm_genlist_item_disabled_get() to get the disabled state.
14522 * In general to indicate how the genlist should expand items horizontally to
14523 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14524 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14525 * mode means that if items are too wide to fit, the scroller will scroll
14526 * horizontally. Otherwise items are expanded to fill the width of the
14527 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14528 * to the viewport width and limited to that size. This can be combined with
14529 * a different style that uses edjes' ellipsis feature (cutting text off like
14532 * Items will only call their selection func and callback when first becoming
14533 * selected. Any further clicks will do nothing, unless you enable always
14534 * select with elm_genlist_always_select_mode_set(). This means even if
14535 * selected, every click will make the selected callbacks be called.
14536 * elm_genlist_no_select_mode_set() will turn off the ability to select
14537 * items entirely and they will neither appear selected nor call selected
14538 * callback functions.
14540 * Remember that you can create new styles and add your own theme augmentation
14541 * per application with elm_theme_extension_add(). If you absolutely must
14542 * have a specific style that overrides any theme the user or system sets up
14543 * you can use elm_theme_overlay_add() to add such a file.
14545 * @section Genlist_Implementation Implementation
14547 * Evas tracks every object you create. Every time it processes an event
14548 * (mouse move, down, up etc.) it needs to walk through objects and find out
14549 * what event that affects. Even worse every time it renders display updates,
14550 * in order to just calculate what to re-draw, it needs to walk through many
14551 * many many objects. Thus, the more objects you keep active, the more
14552 * overhead Evas has in just doing its work. It is advisable to keep your
14553 * active objects to the minimum working set you need. Also remember that
14554 * object creation and deletion carries an overhead, so there is a
14555 * middle-ground, which is not easily determined. But don't keep massive lists
14556 * of objects you can't see or use. Genlist does this with list objects. It
14557 * creates and destroys them dynamically as you scroll around. It groups them
14558 * into blocks so it can determine the visibility etc. of a whole block at
14559 * once as opposed to having to walk the whole list. This 2-level list allows
14560 * for very large numbers of items to be in the list (tests have used up to
14561 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14562 * may be different sizes, every item added needs to be calculated as to its
14563 * size and thus this presents a lot of overhead on populating the list, this
14564 * genlist employs a queue. Any item added is queued and spooled off over
14565 * time, actually appearing some time later, so if your list has many members
14566 * you may find it takes a while for them to all appear, with your process
14567 * consuming a lot of CPU while it is busy spooling.
14569 * Genlist also implements a tree structure, but it does so with callbacks to
14570 * the application, with the application filling in tree structures when
14571 * requested (allowing for efficient building of a very deep tree that could
14572 * even be used for file-management). See the above smart signal callbacks for
14575 * @section Genlist_Smart_Events Genlist smart events
14577 * Signals that you can add callbacks for are:
14578 * - @c "activated" - The user has double-clicked or pressed
14579 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14580 * item that was activated.
14581 * - @c "clicked,double" - The user has double-clicked an item. The @c
14582 * event_info parameter is the item that was double-clicked.
14583 * - @c "selected" - This is called when a user has made an item selected.
14584 * The event_info parameter is the genlist item that was selected.
14585 * - @c "unselected" - This is called when a user has made an item
14586 * unselected. The event_info parameter is the genlist item that was
14588 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14589 * called and the item is now meant to be expanded. The event_info
14590 * parameter is the genlist item that was indicated to expand. It is the
14591 * job of this callback to then fill in the child items.
14592 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14593 * called and the item is now meant to be contracted. The event_info
14594 * parameter is the genlist item that was indicated to contract. It is the
14595 * job of this callback to then delete the child items.
14596 * - @c "expand,request" - This is called when a user has indicated they want
14597 * to expand a tree branch item. The callback should decide if the item can
14598 * expand (has any children) and then call elm_genlist_item_expanded_set()
14599 * appropriately to set the state. The event_info parameter is the genlist
14600 * item that was indicated to expand.
14601 * - @c "contract,request" - This is called when a user has indicated they
14602 * want to contract a tree branch item. The callback should decide if the
14603 * item can contract (has any children) and then call
14604 * elm_genlist_item_expanded_set() appropriately to set the state. The
14605 * event_info parameter is the genlist item that was indicated to contract.
14606 * - @c "realized" - This is called when the item in the list is created as a
14607 * real evas object. event_info parameter is the genlist item that was
14608 * created. The object may be deleted at any time, so it is up to the
14609 * caller to not use the object pointer from elm_genlist_item_object_get()
14610 * in a way where it may point to freed objects.
14611 * - @c "unrealized" - This is called just before an item is unrealized.
14612 * After this call icon objects provided will be deleted and the item
14613 * object itself delete or be put into a floating cache.
14614 * - @c "drag,start,up" - This is called when the item in the list has been
14615 * dragged (not scrolled) up.
14616 * - @c "drag,start,down" - This is called when the item in the list has been
14617 * dragged (not scrolled) down.
14618 * - @c "drag,start,left" - This is called when the item in the list has been
14619 * dragged (not scrolled) left.
14620 * - @c "drag,start,right" - This is called when the item in the list has
14621 * been dragged (not scrolled) right.
14622 * - @c "drag,stop" - This is called when the item in the list has stopped
14624 * - @c "drag" - This is called when the item in the list is being dragged.
14625 * - @c "longpressed" - This is called when the item is pressed for a certain
14626 * amount of time. By default it's 1 second.
14627 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14629 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14630 * until the bottom edge.
14631 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14632 * until the left edge.
14633 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14634 * until the right edge.
14635 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14637 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14639 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14641 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14643 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14644 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14645 * multi-touch pinched in.
14646 * - @c "swipe" - This is called when the genlist is swiped.
14648 * @section Genlist_Examples Examples
14650 * Here is a list of examples that use the genlist, trying to show some of
14651 * its capabilities:
14652 * - @ref genlist_example_01
14653 * - @ref genlist_example_02
14654 * - @ref genlist_example_03
14655 * - @ref genlist_example_04
14656 * - @ref genlist_example_05
14660 * @addtogroup Genlist
14665 * @enum _Elm_Genlist_Item_Flags
14666 * @typedef Elm_Genlist_Item_Flags
14668 * Defines if the item is of any special type (has subitems or it's the
14669 * index of a group), or is just a simple item.
14673 typedef enum _Elm_Genlist_Item_Flags
14675 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14676 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14677 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14678 } Elm_Genlist_Item_Flags;
14679 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14680 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14681 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14682 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14683 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. */
14684 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. */
14685 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14686 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
14688 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
14689 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
14690 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
14691 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
14694 * @struct _Elm_Genlist_Item_Class
14696 * Genlist item class definition structs.
14698 * This struct contains the style and fetching functions that will define the
14699 * contents of each item.
14701 * @see @ref Genlist_Item_Class
14703 struct _Elm_Genlist_Item_Class
14705 const char *item_style; /**< style of this class. */
14708 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
14709 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
14710 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
14711 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
14712 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14714 const char *mode_item_style;
14718 * Add a new genlist widget to the given parent Elementary
14719 * (container) object
14721 * @param parent The parent object
14722 * @return a new genlist widget handle or @c NULL, on errors
14724 * This function inserts a new genlist widget on the canvas.
14726 * @see elm_genlist_item_append()
14727 * @see elm_genlist_item_del()
14728 * @see elm_genlist_clear()
14732 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14734 * Remove all items from a given genlist widget.
14736 * @param obj The genlist object
14738 * This removes (and deletes) all items in @p obj, leaving it empty.
14740 * @see elm_genlist_item_del(), to remove just one item.
14744 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14746 * Enable or disable multi-selection in the genlist
14748 * @param obj The genlist object
14749 * @param multi Multi-select enable/disable. Default is disabled.
14751 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14752 * the list. This allows more than 1 item to be selected. To retrieve the list
14753 * of selected items, use elm_genlist_selected_items_get().
14755 * @see elm_genlist_selected_items_get()
14756 * @see elm_genlist_multi_select_get()
14760 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14762 * Gets if multi-selection in genlist is enabled or disabled.
14764 * @param obj The genlist object
14765 * @return Multi-select enabled/disabled
14766 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14768 * @see elm_genlist_multi_select_set()
14772 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14774 * This sets the horizontal stretching mode.
14776 * @param obj The genlist object
14777 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14779 * This sets the mode used for sizing items horizontally. Valid modes
14780 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14781 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14782 * the scroller will scroll horizontally. Otherwise items are expanded
14783 * to fill the width of the viewport of the scroller. If it is
14784 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14785 * limited to that size.
14787 * @see elm_genlist_horizontal_get()
14791 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14792 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14794 * Gets the horizontal stretching mode.
14796 * @param obj The genlist object
14797 * @return The mode to use
14798 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14800 * @see elm_genlist_horizontal_set()
14804 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14805 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14807 * Set the always select mode.
14809 * @param obj The genlist object
14810 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14811 * EINA_FALSE = off). Default is @c EINA_FALSE.
14813 * Items will only call their selection func and callback when first
14814 * becoming selected. Any further clicks will do nothing, unless you
14815 * enable always select with elm_genlist_always_select_mode_set().
14816 * This means that, even if selected, every click will make the selected
14817 * callbacks be called.
14819 * @see elm_genlist_always_select_mode_get()
14823 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14825 * Get the always select mode.
14827 * @param obj The genlist object
14828 * @return The always select mode
14829 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14831 * @see elm_genlist_always_select_mode_set()
14835 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14837 * Enable/disable the no select mode.
14839 * @param obj The genlist object
14840 * @param no_select The no select mode
14841 * (EINA_TRUE = on, EINA_FALSE = off)
14843 * This will turn off the ability to select items entirely and they
14844 * will neither appear selected nor call selected callback functions.
14846 * @see elm_genlist_no_select_mode_get()
14850 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14852 * Gets whether the no select mode is enabled.
14854 * @param obj The genlist object
14855 * @return The no select mode
14856 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14858 * @see elm_genlist_no_select_mode_set()
14862 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14864 * Enable/disable compress mode.
14866 * @param obj The genlist object
14867 * @param compress The compress mode
14868 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14870 * This will enable the compress mode where items are "compressed"
14871 * horizontally to fit the genlist scrollable viewport width. This is
14872 * special for genlist. Do not rely on
14873 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14874 * work as genlist needs to handle it specially.
14876 * @see elm_genlist_compress_mode_get()
14880 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14882 * Get whether the compress mode is enabled.
14884 * @param obj The genlist object
14885 * @return The compress mode
14886 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14888 * @see elm_genlist_compress_mode_set()
14892 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14894 * Enable/disable height-for-width mode.
14896 * @param obj The genlist object
14897 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14898 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14900 * With height-for-width mode the item width will be fixed (restricted
14901 * to a minimum of) to the list width when calculating its size in
14902 * order to allow the height to be calculated based on it. This allows,
14903 * for instance, text block to wrap lines if the Edje part is
14904 * configured with "text.min: 0 1".
14906 * @note This mode will make list resize slower as it will have to
14907 * recalculate every item height again whenever the list width
14910 * @note When height-for-width mode is enabled, it also enables
14911 * compress mode (see elm_genlist_compress_mode_set()) and
14912 * disables homogeneous (see elm_genlist_homogeneous_set()).
14916 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14918 * Get whether the height-for-width mode is enabled.
14920 * @param obj The genlist object
14921 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14926 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14928 * Enable/disable horizontal and vertical bouncing effect.
14930 * @param obj The genlist object
14931 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14932 * EINA_FALSE = off). Default is @c EINA_FALSE.
14933 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14934 * EINA_FALSE = off). Default is @c EINA_TRUE.
14936 * This will enable or disable the scroller bouncing effect for the
14937 * genlist. See elm_scroller_bounce_set() for details.
14939 * @see elm_scroller_bounce_set()
14940 * @see elm_genlist_bounce_get()
14944 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14946 * Get whether the horizontal and vertical bouncing effect is enabled.
14948 * @param obj The genlist object
14949 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14951 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14954 * @see elm_genlist_bounce_set()
14958 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14960 * Enable/disable homogenous mode.
14962 * @param obj The genlist object
14963 * @param homogeneous Assume the items within the genlist are of the
14964 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14967 * This will enable the homogeneous mode where items are of the same
14968 * height and width so that genlist may do the lazy-loading at its
14969 * maximum (which increases the performance for scrolling the list). This
14970 * implies 'compressed' mode.
14972 * @see elm_genlist_compress_mode_set()
14973 * @see elm_genlist_homogeneous_get()
14977 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14979 * Get whether the homogenous mode is enabled.
14981 * @param obj The genlist object
14982 * @return Assume the items within the genlist are of the same height
14983 * and width (EINA_TRUE = on, EINA_FALSE = off)
14985 * @see elm_genlist_homogeneous_set()
14989 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14991 * Set the maximum number of items within an item block
14993 * @param obj The genlist object
14994 * @param n Maximum number of items within an item block. Default is 32.
14996 * This will configure the block count to tune to the target with
14997 * particular performance matrix.
14999 * A block of objects will be used to reduce the number of operations due to
15000 * many objects in the screen. It can determine the visibility, or if the
15001 * object has changed, it theme needs to be updated, etc. doing this kind of
15002 * calculation to the entire block, instead of per object.
15004 * The default value for the block count is enough for most lists, so unless
15005 * you know you will have a lot of objects visible in the screen at the same
15006 * time, don't try to change this.
15008 * @see elm_genlist_block_count_get()
15009 * @see @ref Genlist_Implementation
15013 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
15015 * Get the maximum number of items within an item block
15017 * @param obj The genlist object
15018 * @return Maximum number of items within an item block
15020 * @see elm_genlist_block_count_set()
15024 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15026 * Set the timeout in seconds for the longpress event.
15028 * @param obj The genlist object
15029 * @param timeout timeout in seconds. Default is 1.
15031 * This option will change how long it takes to send an event "longpressed"
15032 * after the mouse down signal is sent to the list. If this event occurs, no
15033 * "clicked" event will be sent.
15035 * @see elm_genlist_longpress_timeout_set()
15039 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
15041 * Get the timeout in seconds for the longpress event.
15043 * @param obj The genlist object
15044 * @return timeout in seconds
15046 * @see elm_genlist_longpress_timeout_get()
15050 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15052 * Append a new item in a given genlist widget.
15054 * @param obj The genlist object
15055 * @param itc The item class for the item
15056 * @param data The item data
15057 * @param parent The parent item, or NULL if none
15058 * @param flags Item flags
15059 * @param func Convenience function called when the item is selected
15060 * @param func_data Data passed to @p func above.
15061 * @return A handle to the item added or @c NULL if not possible
15063 * This adds the given item to the end of the list or the end of
15064 * the children list if the @p parent is given.
15066 * @see elm_genlist_item_prepend()
15067 * @see elm_genlist_item_insert_before()
15068 * @see elm_genlist_item_insert_after()
15069 * @see elm_genlist_item_del()
15073 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);
15075 * Prepend a new item in a given genlist widget.
15077 * @param obj The genlist object
15078 * @param itc The item class for the item
15079 * @param data The item data
15080 * @param parent The parent item, or NULL if none
15081 * @param flags Item flags
15082 * @param func Convenience function called when the item is selected
15083 * @param func_data Data passed to @p func above.
15084 * @return A handle to the item added or NULL if not possible
15086 * This adds an item to the beginning of the list or beginning of the
15087 * children of the parent if given.
15089 * @see elm_genlist_item_append()
15090 * @see elm_genlist_item_insert_before()
15091 * @see elm_genlist_item_insert_after()
15092 * @see elm_genlist_item_del()
15096 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);
15098 * Insert an item before another in a genlist widget
15100 * @param obj The genlist object
15101 * @param itc The item class for the item
15102 * @param data The item data
15103 * @param before The item to place this new one before.
15104 * @param flags Item flags
15105 * @param func Convenience function called when the item is selected
15106 * @param func_data Data passed to @p func above.
15107 * @return A handle to the item added or @c NULL if not possible
15109 * This inserts an item before another in the list. It will be in the
15110 * same tree level or group as the item it is inserted before.
15112 * @see elm_genlist_item_append()
15113 * @see elm_genlist_item_prepend()
15114 * @see elm_genlist_item_insert_after()
15115 * @see elm_genlist_item_del()
15119 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);
15121 * Insert an item after another in a genlist widget
15123 * @param obj The genlist object
15124 * @param itc The item class for the item
15125 * @param data The item data
15126 * @param after The item to place this new one after.
15127 * @param flags Item flags
15128 * @param func Convenience function called when the item is selected
15129 * @param func_data Data passed to @p func above.
15130 * @return A handle to the item added or @c NULL if not possible
15132 * This inserts an item after another in the list. It will be in the
15133 * same tree level or group as the item it is inserted after.
15135 * @see elm_genlist_item_append()
15136 * @see elm_genlist_item_prepend()
15137 * @see elm_genlist_item_insert_before()
15138 * @see elm_genlist_item_del()
15142 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);
15144 * Insert a new item into the sorted genlist object
15146 * @param obj The genlist object
15147 * @param itc The item class for the item
15148 * @param data The item data
15149 * @param parent The parent item, or NULL if none
15150 * @param flags Item flags
15151 * @param comp The function called for the sort
15152 * @param func Convenience function called when item selected
15153 * @param func_data Data passed to @p func above.
15154 * @return A handle to the item added or NULL if not possible
15158 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);
15159 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);
15160 /* operations to retrieve existing items */
15162 * Get the selectd item in the genlist.
15164 * @param obj The genlist object
15165 * @return The selected item, or NULL if none is selected.
15167 * This gets the selected item in the list (if multi-selection is enabled, only
15168 * the item that was first selected in the list is returned - which is not very
15169 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
15172 * If no item is selected, NULL is returned.
15174 * @see elm_genlist_selected_items_get()
15178 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15180 * Get a list of selected items in the genlist.
15182 * @param obj The genlist object
15183 * @return The list of selected items, or NULL if none are selected.
15185 * It returns a list of the selected items. This list pointer is only valid so
15186 * long as the selection doesn't change (no items are selected or unselected, or
15187 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
15188 * pointers. The order of the items in this list is the order which they were
15189 * selected, i.e. the first item in this list is the first item that was
15190 * selected, and so on.
15192 * @note If not in multi-select mode, consider using function
15193 * elm_genlist_selected_item_get() instead.
15195 * @see elm_genlist_multi_select_set()
15196 * @see elm_genlist_selected_item_get()
15200 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15202 * Get a list of realized items in genlist
15204 * @param obj The genlist object
15205 * @return The list of realized items, nor NULL if none are realized.
15207 * This returns a list of the realized items in the genlist. The list
15208 * contains Elm_Genlist_Item pointers. The list must be freed by the
15209 * caller when done with eina_list_free(). The item pointers in the
15210 * list are only valid so long as those items are not deleted or the
15211 * genlist is not deleted.
15213 * @see elm_genlist_realized_items_update()
15217 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15219 * Get the item that is at the x, y canvas coords.
15221 * @param obj The gelinst object.
15222 * @param x The input x coordinate
15223 * @param y The input y coordinate
15224 * @param posret The position relative to the item returned here
15225 * @return The item at the coordinates or NULL if none
15227 * This returns the item at the given coordinates (which are canvas
15228 * relative, not object-relative). If an item is at that coordinate,
15229 * that item handle is returned, and if @p posret is not NULL, the
15230 * integer pointed to is set to a value of -1, 0 or 1, depending if
15231 * the coordinate is on the upper portion of that item (-1), on the
15232 * middle section (0) or on the lower part (1). If NULL is returned as
15233 * an item (no item found there), then posret may indicate -1 or 1
15234 * based if the coordinate is above or below all items respectively in
15239 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);
15241 * Get the first item in the genlist
15243 * This returns the first item in the list.
15245 * @param obj The genlist object
15246 * @return The first item, or NULL if none
15250 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15252 * Get the last item in the genlist
15254 * This returns the last item in the list.
15256 * @return The last item, or NULL if none
15260 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15262 * Set the scrollbar policy
15264 * @param obj The genlist object
15265 * @param policy_h Horizontal scrollbar policy.
15266 * @param policy_v Vertical scrollbar policy.
15268 * This sets the scrollbar visibility policy for the given genlist
15269 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15270 * made visible if it is needed, and otherwise kept hidden.
15271 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15272 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15273 * respectively for the horizontal and vertical scrollbars. Default is
15274 * #ELM_SMART_SCROLLER_POLICY_AUTO
15276 * @see elm_genlist_scroller_policy_get()
15280 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15282 * Get the scrollbar policy
15284 * @param obj The genlist object
15285 * @param policy_h Pointer to store the horizontal scrollbar policy.
15286 * @param policy_v Pointer to store the vertical scrollbar policy.
15288 * @see elm_genlist_scroller_policy_set()
15292 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);
15294 * Get the @b next item in a genlist widget's internal list of items,
15295 * given a handle to one of those items.
15297 * @param item The genlist item to fetch next from
15298 * @return The item after @p item, or @c NULL if there's none (and
15301 * This returns the item placed after the @p item, on the container
15304 * @see elm_genlist_item_prev_get()
15308 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15310 * Get the @b previous item in a genlist widget's internal list of items,
15311 * given a handle to one of those items.
15313 * @param item The genlist item to fetch previous from
15314 * @return The item before @p item, or @c NULL if there's none (and
15317 * This returns the item placed before the @p item, on the container
15320 * @see elm_genlist_item_next_get()
15324 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15326 * Get the genlist object's handle which contains a given genlist
15329 * @param item The item to fetch the container from
15330 * @return The genlist (parent) object
15332 * This returns the genlist object itself that an item belongs to.
15336 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15338 * Get the parent item of the given item
15340 * @param it The item
15341 * @return The parent of the item or @c NULL if it has no parent.
15343 * This returns the item that was specified as parent of the item @p it on
15344 * elm_genlist_item_append() and insertion related functions.
15348 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15350 * Remove all sub-items (children) of the given item
15352 * @param it The item
15354 * This removes all items that are children (and their descendants) of the
15355 * given item @p it.
15357 * @see elm_genlist_clear()
15358 * @see elm_genlist_item_del()
15362 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15364 * Set whether a given genlist item is selected or not
15366 * @param it The item
15367 * @param selected Use @c EINA_TRUE, to make it selected, @c
15368 * EINA_FALSE to make it unselected
15370 * This sets the selected state of an item. If multi selection is
15371 * not enabled on the containing genlist and @p selected is @c
15372 * EINA_TRUE, any other previously selected items will get
15373 * unselected in favor of this new one.
15375 * @see elm_genlist_item_selected_get()
15379 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15381 * Get whether a given genlist item is selected or not
15383 * @param it The item
15384 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15386 * @see elm_genlist_item_selected_set() for more details
15390 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15392 * Sets the expanded state of an item.
15394 * @param it The item
15395 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15397 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15400 * The theme will respond to this change visually, and a signal "expanded" or
15401 * "contracted" will be sent from the genlist with a pointer to the item that
15402 * has been expanded/contracted.
15404 * Calling this function won't show or hide any child of this item (if it is
15405 * a parent). You must manually delete and create them on the callbacks fo
15406 * the "expanded" or "contracted" signals.
15408 * @see elm_genlist_item_expanded_get()
15412 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15414 * Get the expanded state of an item
15416 * @param it The item
15417 * @return The expanded state
15419 * This gets the expanded state of an item.
15421 * @see elm_genlist_item_expanded_set()
15425 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15427 * Get the depth of expanded item
15429 * @param it The genlist item object
15430 * @return The depth of expanded item
15434 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15436 * Set whether a given genlist item is disabled or not.
15438 * @param it The item
15439 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15440 * to enable it back.
15442 * A disabled item cannot be selected or unselected. It will also
15443 * change its appearance, to signal the user it's disabled.
15445 * @see elm_genlist_item_disabled_get()
15449 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15451 * Get whether a given genlist item is disabled or not.
15453 * @param it The item
15454 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15457 * @see elm_genlist_item_disabled_set() for more details
15461 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15463 * Sets the display only state of an item.
15465 * @param it The item
15466 * @param display_only @c EINA_TRUE if the item is display only, @c
15467 * EINA_FALSE otherwise.
15469 * A display only item cannot be selected or unselected. It is for
15470 * display only and not selecting or otherwise clicking, dragging
15471 * etc. by the user, thus finger size rules will not be applied to
15474 * It's good to set group index items to display only state.
15476 * @see elm_genlist_item_display_only_get()
15480 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15482 * Get the display only state of an item
15484 * @param it The item
15485 * @return @c EINA_TRUE if the item is display only, @c
15486 * EINA_FALSE otherwise.
15488 * @see elm_genlist_item_display_only_set()
15492 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15494 * Show the portion of a genlist's internal list containing a given
15495 * item, immediately.
15497 * @param it The item to display
15499 * This causes genlist to jump to the given item @p it and show it (by
15500 * immediately scrolling to that position), if it is not fully visible.
15502 * @see elm_genlist_item_bring_in()
15503 * @see elm_genlist_item_top_show()
15504 * @see elm_genlist_item_middle_show()
15508 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15510 * Animatedly bring in, to the visible are of a genlist, a given
15513 * @param it The item to display
15515 * This causes genlist to jump to the given item @p it and show it (by
15516 * animatedly scrolling), if it is not fully visible. This may use animation
15517 * to do so and take a period of time
15519 * @see elm_genlist_item_show()
15520 * @see elm_genlist_item_top_bring_in()
15521 * @see elm_genlist_item_middle_bring_in()
15525 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15527 * Show the portion of a genlist's internal list containing a given
15528 * item, immediately.
15530 * @param it The item to display
15532 * This causes genlist to jump to the given item @p it and show it (by
15533 * immediately scrolling to that position), if it is not fully visible.
15535 * The item will be positioned at the top of the genlist viewport.
15537 * @see elm_genlist_item_show()
15538 * @see elm_genlist_item_top_bring_in()
15542 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15544 * Animatedly bring in, to the visible are of a genlist, a given
15547 * @param it The item
15549 * This causes genlist to jump to the given item @p it and show it (by
15550 * animatedly scrolling), if it is not fully visible. This may use animation
15551 * to do so and take a period of time
15553 * The item will be positioned at the top of the genlist viewport.
15555 * @see elm_genlist_item_bring_in()
15556 * @see elm_genlist_item_top_show()
15560 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15562 * Show the portion of a genlist's internal list containing a given
15563 * item, immediately.
15565 * @param it The item to display
15567 * This causes genlist to jump to the given item @p it and show it (by
15568 * immediately scrolling to that position), if it is not fully visible.
15570 * The item will be positioned at the middle of the genlist viewport.
15572 * @see elm_genlist_item_show()
15573 * @see elm_genlist_item_middle_bring_in()
15577 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15579 * Animatedly bring in, to the visible are of a genlist, a given
15582 * @param it The item
15584 * This causes genlist to jump to the given item @p it and show it (by
15585 * animatedly scrolling), if it is not fully visible. This may use animation
15586 * to do so and take a period of time
15588 * The item will be positioned at the middle of the genlist viewport.
15590 * @see elm_genlist_item_bring_in()
15591 * @see elm_genlist_item_middle_show()
15595 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15597 * Remove a genlist item from the its parent, deleting it.
15599 * @param item The item to be removed.
15600 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15602 * @see elm_genlist_clear(), to remove all items in a genlist at
15607 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15609 * Return the data associated to a given genlist item
15611 * @param item The genlist item.
15612 * @return the data associated to this item.
15614 * This returns the @c data value passed on the
15615 * elm_genlist_item_append() and related item addition calls.
15617 * @see elm_genlist_item_append()
15618 * @see elm_genlist_item_data_set()
15622 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15624 * Set the data associated to a given genlist item
15626 * @param item The genlist item
15627 * @param data The new data pointer to set on it
15629 * This @b overrides the @c data value passed on the
15630 * elm_genlist_item_append() and related item addition calls. This
15631 * function @b won't call elm_genlist_item_update() automatically,
15632 * so you'd issue it afterwards if you want to hove the item
15633 * updated to reflect the that new data.
15635 * @see elm_genlist_item_data_get()
15639 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15641 * Tells genlist to "orphan" icons fetchs by the item class
15643 * @param it The item
15645 * This instructs genlist to release references to icons in the item,
15646 * meaning that they will no longer be managed by genlist and are
15647 * floating "orphans" that can be re-used elsewhere if the user wants
15652 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15654 * Get the real Evas object created to implement the view of a
15655 * given genlist item
15657 * @param item The genlist item.
15658 * @return the Evas object implementing this item's view.
15660 * This returns the actual Evas object used to implement the
15661 * specified genlist item's view. This may be @c NULL, as it may
15662 * not have been created or may have been deleted, at any time, by
15663 * the genlist. <b>Do not modify this object</b> (move, resize,
15664 * show, hide, etc.), as the genlist is controlling it. This
15665 * function is for querying, emitting custom signals or hooking
15666 * lower level callbacks for events on that object. Do not delete
15667 * this object under any circumstances.
15669 * @see elm_genlist_item_data_get()
15673 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15675 * Update the contents of an item
15677 * @param it The item
15679 * This updates an item by calling all the item class functions again
15680 * to get the icons, labels and states. Use this when the original
15681 * item data has changed and the changes are desired to be reflected.
15683 * Use elm_genlist_realized_items_update() to update all already realized
15686 * @see elm_genlist_realized_items_update()
15690 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15692 * Update the item class of an item
15694 * @param it The item
15695 * @param itc The item class for the item
15697 * This sets another class fo the item, changing the way that it is
15698 * displayed. After changing the item class, elm_genlist_item_update() is
15699 * called on the item @p it.
15703 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15704 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15706 * Set the text to be shown in a given genlist item's tooltips.
15708 * @param item The genlist item
15709 * @param text The text to set in the content
15711 * This call will setup the text to be used as tooltip to that item
15712 * (analogous to elm_object_tooltip_text_set(), but being item
15713 * tooltips with higher precedence than object tooltips). It can
15714 * have only one tooltip at a time, so any previous tooltip data
15715 * will get removed.
15717 * In order to set an icon or something else as a tooltip, look at
15718 * elm_genlist_item_tooltip_content_cb_set().
15722 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15724 * Set the content to be shown in a given genlist item's tooltips
15726 * @param item The genlist item.
15727 * @param func The function returning the tooltip contents.
15728 * @param data What to provide to @a func as callback data/context.
15729 * @param del_cb Called when data is not needed anymore, either when
15730 * another callback replaces @p func, the tooltip is unset with
15731 * elm_genlist_item_tooltip_unset() or the owner @p item
15732 * dies. This callback receives as its first parameter the
15733 * given @p data, being @c event_info the item handle.
15735 * This call will setup the tooltip's contents to @p item
15736 * (analogous to elm_object_tooltip_content_cb_set(), but being
15737 * item tooltips with higher precedence than object tooltips). It
15738 * can have only one tooltip at a time, so any previous tooltip
15739 * content will get removed. @p func (with @p data) will be called
15740 * every time Elementary needs to show the tooltip and it should
15741 * return a valid Evas object, which will be fully managed by the
15742 * tooltip system, getting deleted when the tooltip is gone.
15744 * In order to set just a text as a tooltip, look at
15745 * elm_genlist_item_tooltip_text_set().
15749 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);
15751 * Unset a tooltip from a given genlist item
15753 * @param item genlist item to remove a previously set tooltip from.
15755 * This call removes any tooltip set on @p item. The callback
15756 * provided as @c del_cb to
15757 * elm_genlist_item_tooltip_content_cb_set() will be called to
15758 * notify it is not used anymore (and have resources cleaned, if
15761 * @see elm_genlist_item_tooltip_content_cb_set()
15765 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15767 * Set a different @b style for a given genlist item's tooltip.
15769 * @param item genlist item with tooltip set
15770 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15771 * "default", @c "transparent", etc)
15773 * Tooltips can have <b>alternate styles</b> to be displayed on,
15774 * which are defined by the theme set on Elementary. This function
15775 * works analogously as elm_object_tooltip_style_set(), but here
15776 * applied only to genlist item objects. The default style for
15777 * tooltips is @c "default".
15779 * @note before you set a style you should define a tooltip with
15780 * elm_genlist_item_tooltip_content_cb_set() or
15781 * elm_genlist_item_tooltip_text_set()
15783 * @see elm_genlist_item_tooltip_style_get()
15787 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15789 * Get the style set a given genlist item's tooltip.
15791 * @param item genlist item with tooltip already set on.
15792 * @return style the theme style in use, which defaults to
15793 * "default". If the object does not have a tooltip set,
15794 * then @c NULL is returned.
15796 * @see elm_genlist_item_tooltip_style_set() for more details
15800 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15802 * @brief Disable size restrictions on an object's tooltip
15803 * @param item The tooltip's anchor object
15804 * @param disable If EINA_TRUE, size restrictions are disabled
15805 * @return EINA_FALSE on failure, EINA_TRUE on success
15807 * This function allows a tooltip to expand beyond its parant window's canvas.
15808 * It will instead be limited only by the size of the display.
15810 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15812 * @brief Retrieve size restriction state of an object's tooltip
15813 * @param item The tooltip's anchor object
15814 * @return If EINA_TRUE, size restrictions are disabled
15816 * This function returns whether a tooltip is allowed to expand beyond
15817 * its parant window's canvas.
15818 * It will instead be limited only by the size of the display.
15820 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15822 * Set the type of mouse pointer/cursor decoration to be shown,
15823 * when the mouse pointer is over the given genlist widget item
15825 * @param item genlist item to customize cursor on
15826 * @param cursor the cursor type's name
15828 * This function works analogously as elm_object_cursor_set(), but
15829 * here the cursor's changing area is restricted to the item's
15830 * area, and not the whole widget's. Note that that item cursors
15831 * have precedence over widget cursors, so that a mouse over @p
15832 * item will always show cursor @p type.
15834 * If this function is called twice for an object, a previously set
15835 * cursor will be unset on the second call.
15837 * @see elm_object_cursor_set()
15838 * @see elm_genlist_item_cursor_get()
15839 * @see elm_genlist_item_cursor_unset()
15843 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15845 * Get the type of mouse pointer/cursor decoration set to be shown,
15846 * when the mouse pointer is over the given genlist widget item
15848 * @param item genlist item with custom cursor set
15849 * @return the cursor type's name or @c NULL, if no custom cursors
15850 * were set to @p item (and on errors)
15852 * @see elm_object_cursor_get()
15853 * @see elm_genlist_item_cursor_set() for more details
15854 * @see elm_genlist_item_cursor_unset()
15858 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15860 * Unset any custom mouse pointer/cursor decoration set to be
15861 * shown, when the mouse pointer is over the given genlist widget
15862 * item, thus making it show the @b default cursor again.
15864 * @param item a genlist item
15866 * Use this call to undo any custom settings on this item's cursor
15867 * decoration, bringing it back to defaults (no custom style set).
15869 * @see elm_object_cursor_unset()
15870 * @see elm_genlist_item_cursor_set() for more details
15874 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15876 * Set a different @b style for a given custom cursor set for a
15879 * @param item genlist item with custom cursor set
15880 * @param style the <b>theme style</b> to use (e.g. @c "default",
15881 * @c "transparent", etc)
15883 * This function only makes sense when one is using custom mouse
15884 * cursor decorations <b>defined in a theme file</b> , which can
15885 * have, given a cursor name/type, <b>alternate styles</b> on
15886 * it. It works analogously as elm_object_cursor_style_set(), but
15887 * here applied only to genlist item objects.
15889 * @warning Before you set a cursor style you should have defined a
15890 * custom cursor previously on the item, with
15891 * elm_genlist_item_cursor_set()
15893 * @see elm_genlist_item_cursor_engine_only_set()
15894 * @see elm_genlist_item_cursor_style_get()
15898 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15900 * Get the current @b style set for a given genlist item's custom
15903 * @param item genlist item with custom cursor set.
15904 * @return style the cursor style in use. If the object does not
15905 * have a cursor set, then @c NULL is returned.
15907 * @see elm_genlist_item_cursor_style_set() for more details
15911 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15913 * Set if the (custom) cursor for a given genlist item should be
15914 * searched in its theme, also, or should only rely on the
15915 * rendering engine.
15917 * @param item item with custom (custom) cursor already set on
15918 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15919 * only on those provided by the rendering engine, @c EINA_FALSE to
15920 * have them searched on the widget's theme, as well.
15922 * @note This call is of use only if you've set a custom cursor
15923 * for genlist items, with elm_genlist_item_cursor_set().
15925 * @note By default, cursors will only be looked for between those
15926 * provided by the rendering engine.
15930 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15932 * Get if the (custom) cursor for a given genlist item is being
15933 * searched in its theme, also, or is only relying on the rendering
15936 * @param item a genlist item
15937 * @return @c EINA_TRUE, if cursors are being looked for only on
15938 * those provided by the rendering engine, @c EINA_FALSE if they
15939 * are being searched on the widget's theme, as well.
15941 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15945 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15947 * Update the contents of all realized items.
15949 * @param obj The genlist object.
15951 * This updates all realized items by calling all the item class functions again
15952 * to get the icons, labels and states. Use this when the original
15953 * item data has changed and the changes are desired to be reflected.
15955 * To update just one item, use elm_genlist_item_update().
15957 * @see elm_genlist_realized_items_get()
15958 * @see elm_genlist_item_update()
15962 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15964 * Activate a genlist mode on an item
15966 * @param item The genlist item
15967 * @param mode Mode name
15968 * @param mode_set Boolean to define set or unset mode.
15970 * A genlist mode is a different way of selecting an item. Once a mode is
15971 * activated on an item, any other selected item is immediately unselected.
15972 * This feature provides an easy way of implementing a new kind of animation
15973 * for selecting an item, without having to entirely rewrite the item style
15974 * theme. However, the elm_genlist_selected_* API can't be used to get what
15975 * item is activate for a mode.
15977 * The current item style will still be used, but applying a genlist mode to
15978 * an item will select it using a different kind of animation.
15980 * The current active item for a mode can be found by
15981 * elm_genlist_mode_item_get().
15983 * The characteristics of genlist mode are:
15984 * - Only one mode can be active at any time, and for only one item.
15985 * - Genlist handles deactivating other items when one item is activated.
15986 * - A mode is defined in the genlist theme (edc), and more modes can easily
15988 * - A mode style and the genlist item style are different things. They
15989 * can be combined to provide a default style to the item, with some kind
15990 * of animation for that item when the mode is activated.
15992 * When a mode is activated on an item, a new view for that item is created.
15993 * The theme of this mode defines the animation that will be used to transit
15994 * the item from the old view to the new view. This second (new) view will be
15995 * active for that item while the mode is active on the item, and will be
15996 * destroyed after the mode is totally deactivated from that item.
15998 * @see elm_genlist_mode_get()
15999 * @see elm_genlist_mode_item_get()
16003 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
16005 * Get the last (or current) genlist mode used.
16007 * @param obj The genlist object
16009 * This function just returns the name of the last used genlist mode. It will
16010 * be the current mode if it's still active.
16012 * @see elm_genlist_item_mode_set()
16013 * @see elm_genlist_mode_item_get()
16017 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16019 * Get active genlist mode item
16021 * @param obj The genlist object
16022 * @return The active item for that current mode. Or @c NULL if no item is
16023 * activated with any mode.
16025 * This function returns the item that was activated with a mode, by the
16026 * function elm_genlist_item_mode_set().
16028 * @see elm_genlist_item_mode_set()
16029 * @see elm_genlist_mode_get()
16033 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16034 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
16035 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16042 * @defgroup Check Check
16044 * @image html img/widget/check/preview-00.png
16045 * @image latex img/widget/check/preview-00.eps
16046 * @image html img/widget/check/preview-01.png
16047 * @image latex img/widget/check/preview-01.eps
16048 * @image html img/widget/check/preview-02.png
16049 * @image latex img/widget/check/preview-02.eps
16051 * @brief The check widget allows for toggling a value between true and
16054 * Check objects are a lot like radio objects in layout and functionality
16055 * except they do not work as a group, but independently and only toggle the
16056 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
16057 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
16058 * returns the current state. For convenience, like the radio objects, you
16059 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
16060 * for it to modify.
16062 * Signals that you can add callbacks for are:
16063 * "changed" - This is called whenever the user changes the state of one of
16064 * the check object(event_info is NULL).
16066 * @ref tutorial_check should give you a firm grasp of how to use this widget.
16070 * @brief Add a new Check object
16072 * @param parent The parent object
16073 * @return The new object or NULL if it cannot be created
16075 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16077 * @brief Set the text label of the check object
16079 * @param obj The check object
16080 * @param label The text label string in UTF-8
16082 * @deprecated use elm_object_text_set() instead.
16084 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16086 * @brief Get the text label of the check object
16088 * @param obj The check object
16089 * @return The text label string in UTF-8
16091 * @deprecated use elm_object_text_get() instead.
16093 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16095 * @brief Set the icon object of the check object
16097 * @param obj The check object
16098 * @param icon The icon object
16100 * Once the icon object is set, a previously set one will be deleted.
16101 * If you want to keep that old content object, use the
16102 * elm_check_icon_unset() function.
16104 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16106 * @brief Get the icon object of the check object
16108 * @param obj The check object
16109 * @return The icon object
16111 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16113 * @brief Unset the icon used for the check object
16115 * @param obj The check object
16116 * @return The icon object that was being used
16118 * Unparent and return the icon object which was set for this widget.
16120 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16122 * @brief Set the on/off state of the check object
16124 * @param obj The check object
16125 * @param state The state to use (1 == on, 0 == off)
16127 * This sets the state of the check. If set
16128 * with elm_check_state_pointer_set() the state of that variable is also
16129 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
16131 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
16133 * @brief Get the state of the check object
16135 * @param obj The check object
16136 * @return The boolean state
16138 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16140 * @brief Set a convenience pointer to a boolean to change
16142 * @param obj The check object
16143 * @param statep Pointer to the boolean to modify
16145 * This sets a pointer to a boolean, that, in addition to the check objects
16146 * state will also be modified directly. To stop setting the object pointed
16147 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
16148 * then when this is called, the check objects state will also be modified to
16149 * reflect the value of the boolean @p statep points to, just like calling
16150 * elm_check_state_set().
16152 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
16158 * @defgroup Radio Radio
16160 * @image html img/widget/radio/preview-00.png
16161 * @image latex img/widget/radio/preview-00.eps
16163 * @brief Radio is a widget that allows for 1 or more options to be displayed
16164 * and have the user choose only 1 of them.
16166 * A radio object contains an indicator, an optional Label and an optional
16167 * icon object. While it's possible to have a group of only one radio they,
16168 * are normally used in groups of 2 or more. To add a radio to a group use
16169 * elm_radio_group_add(). The radio object(s) will select from one of a set
16170 * of integer values, so any value they are configuring needs to be mapped to
16171 * a set of integers. To configure what value that radio object represents,
16172 * use elm_radio_state_value_set() to set the integer it represents. To set
16173 * the value the whole group(which one is currently selected) is to indicate
16174 * use elm_radio_value_set() on any group member, and to get the groups value
16175 * use elm_radio_value_get(). For convenience the radio objects are also able
16176 * to directly set an integer(int) to the value that is selected. To specify
16177 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
16178 * The radio objects will modify this directly. That implies the pointer must
16179 * point to valid memory for as long as the radio objects exist.
16181 * Signals that you can add callbacks for are:
16182 * @li changed - This is called whenever the user changes the state of one of
16183 * the radio objects within the group of radio objects that work together.
16185 * @ref tutorial_radio show most of this API in action.
16189 * @brief Add a new radio to the parent
16191 * @param parent The parent object
16192 * @return The new object or NULL if it cannot be created
16194 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16196 * @brief Set the text label of the radio object
16198 * @param obj The radio object
16199 * @param label The text label string in UTF-8
16201 * @deprecated use elm_object_text_set() instead.
16203 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16205 * @brief Get the text label of the radio object
16207 * @param obj The radio object
16208 * @return The text label string in UTF-8
16210 * @deprecated use elm_object_text_set() instead.
16212 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16214 * @brief Set the icon object of the radio object
16216 * @param obj The radio object
16217 * @param icon The icon object
16219 * Once the icon object is set, a previously set one will be deleted. If you
16220 * want to keep that old content object, use the elm_radio_icon_unset()
16223 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16225 * @brief Get the icon object of the radio object
16227 * @param obj The radio object
16228 * @return The icon object
16230 * @see elm_radio_icon_set()
16232 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16234 * @brief Unset the icon used for the radio object
16236 * @param obj The radio object
16237 * @return The icon object that was being used
16239 * Unparent and return the icon object which was set for this widget.
16241 * @see elm_radio_icon_set()
16243 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16245 * @brief Add this radio to a group of other radio objects
16247 * @param obj The radio object
16248 * @param group Any object whose group the @p obj is to join.
16250 * Radio objects work in groups. Each member should have a different integer
16251 * value assigned. In order to have them work as a group, they need to know
16252 * about each other. This adds the given radio object to the group of which
16253 * the group object indicated is a member.
16255 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16257 * @brief Set the integer value that this radio object represents
16259 * @param obj The radio object
16260 * @param value The value to use if this radio object is selected
16262 * This sets the value of the radio.
16264 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16266 * @brief Get the integer value that this radio object represents
16268 * @param obj The radio object
16269 * @return The value used if this radio object is selected
16271 * This gets the value of the radio.
16273 * @see elm_radio_value_set()
16275 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16277 * @brief Set the value of the radio.
16279 * @param obj The radio object
16280 * @param value The value to use for the group
16282 * This sets the value of the radio group and will also set the value if
16283 * pointed to, to the value supplied, but will not call any callbacks.
16285 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16287 * @brief Get the state of the radio object
16289 * @param obj The radio object
16290 * @return The integer state
16292 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16294 * @brief Set a convenience pointer to a integer to change
16296 * @param obj The radio object
16297 * @param valuep Pointer to the integer to modify
16299 * This sets a pointer to a integer, that, in addition to the radio objects
16300 * state will also be modified directly. To stop setting the object pointed
16301 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16302 * when this is called, the radio objects state will also be modified to
16303 * reflect the value of the integer valuep points to, just like calling
16304 * elm_radio_value_set().
16306 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16312 * @defgroup Pager Pager
16314 * @image html img/widget/pager/preview-00.png
16315 * @image latex img/widget/pager/preview-00.eps
16317 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16319 * The flipping between “pages” of objects is animated. All content in pager
16320 * is kept in a stack, the last content to be added will be on the top of the
16321 * stack(be visible).
16323 * Objects can be pushed or popped from the stack or deleted as normal.
16324 * Pushes and pops will animate (and a pop will delete the object once the
16325 * animation is finished). Any object already in the pager can be promoted to
16326 * the top(from its current stacking position) through the use of
16327 * elm_pager_content_promote(). Objects are pushed to the top with
16328 * elm_pager_content_push() and when the top item is no longer wanted, simply
16329 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16330 * object is no longer needed and is not the top item, just delete it as
16331 * normal. You can query which objects are the top and bottom with
16332 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16334 * Signals that you can add callbacks for are:
16335 * "hide,finished" - when the previous page is hided
16337 * This widget has the following styles available:
16340 * @li fade_translucide
16341 * @li fade_invisible
16342 * @note This styles affect only the flipping animations, the appearance when
16343 * not animating is unaffected by styles.
16345 * @ref tutorial_pager gives a good overview of the usage of the API.
16349 * Add a new pager to the parent
16351 * @param parent The parent object
16352 * @return The new object or NULL if it cannot be created
16356 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16358 * @brief Push an object to the top of the pager stack (and show it).
16360 * @param obj The pager object
16361 * @param content The object to push
16363 * The object pushed becomes a child of the pager, it will be controlled and
16364 * deleted when the pager is deleted.
16366 * @note If the content is already in the stack use
16367 * elm_pager_content_promote().
16368 * @warning Using this function on @p content already in the stack results in
16369 * undefined behavior.
16371 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16373 * @brief Pop the object that is on top of the stack
16375 * @param obj The pager object
16377 * This pops the object that is on the top(visible) of the pager, makes it
16378 * disappear, then deletes the object. The object that was underneath it on
16379 * the stack will become visible.
16381 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16383 * @brief Moves an object already in the pager stack to the top of the stack.
16385 * @param obj The pager object
16386 * @param content The object to promote
16388 * This will take the @p content and move it to the top of the stack as
16389 * if it had been pushed there.
16391 * @note If the content isn't already in the stack use
16392 * elm_pager_content_push().
16393 * @warning Using this function on @p content not already in the stack
16394 * results in undefined behavior.
16396 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16398 * @brief Return the object at the bottom of the pager stack
16400 * @param obj The pager object
16401 * @return The bottom object or NULL if none
16403 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16405 * @brief Return the object at the top of the pager stack
16407 * @param obj The pager object
16408 * @return The top object or NULL if none
16410 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16416 * @defgroup Slideshow Slideshow
16418 * @image html img/widget/slideshow/preview-00.png
16419 * @image latex img/widget/slideshow/preview-00.eps
16421 * This widget, as the name indicates, is a pre-made image
16422 * slideshow panel, with API functions acting on (child) image
16423 * items presentation. Between those actions, are:
16424 * - advance to next/previous image
16425 * - select the style of image transition animation
16426 * - set the exhibition time for each image
16427 * - start/stop the slideshow
16429 * The transition animations are defined in the widget's theme,
16430 * consequently new animations can be added without having to
16431 * update the widget's code.
16433 * @section Slideshow_Items Slideshow items
16435 * For slideshow items, just like for @ref Genlist "genlist" ones,
16436 * the user defines a @b classes, specifying functions that will be
16437 * called on the item's creation and deletion times.
16439 * The #Elm_Slideshow_Item_Class structure contains the following
16442 * - @c func.get - When an item is displayed, this function is
16443 * called, and it's where one should create the item object, de
16444 * facto. For example, the object can be a pure Evas image object
16445 * or an Elementary @ref Photocam "photocam" widget. See
16446 * #SlideshowItemGetFunc.
16447 * - @c func.del - When an item is no more displayed, this function
16448 * is called, where the user must delete any data associated to
16449 * the item. See #SlideshowItemDelFunc.
16451 * @section Slideshow_Caching Slideshow caching
16453 * The slideshow provides facilities to have items adjacent to the
16454 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16455 * you, so that the system does not have to decode image data
16456 * anymore at the time it has to actually switch images on its
16457 * viewport. The user is able to set the numbers of items to be
16458 * cached @b before and @b after the current item, in the widget's
16461 * Smart events one can add callbacks for are:
16463 * - @c "changed" - when the slideshow switches its view to a new
16466 * List of examples for the slideshow widget:
16467 * @li @ref slideshow_example
16471 * @addtogroup Slideshow
16475 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16476 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16477 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16478 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16479 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16482 * @struct _Elm_Slideshow_Item_Class
16484 * Slideshow item class definition. See @ref Slideshow_Items for
16487 struct _Elm_Slideshow_Item_Class
16489 struct _Elm_Slideshow_Item_Class_Func
16491 SlideshowItemGetFunc get;
16492 SlideshowItemDelFunc del;
16494 }; /**< #Elm_Slideshow_Item_Class member definitions */
16497 * Add a new slideshow widget to the given parent Elementary
16498 * (container) object
16500 * @param parent The parent object
16501 * @return A new slideshow widget handle or @c NULL, on errors
16503 * This function inserts a new slideshow widget on the canvas.
16505 * @ingroup Slideshow
16507 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16510 * Add (append) a new item in a given slideshow widget.
16512 * @param obj The slideshow object
16513 * @param itc The item class for the item
16514 * @param data The item's data
16515 * @return A handle to the item added or @c NULL, on errors
16517 * Add a new item to @p obj's internal list of items, appending it.
16518 * The item's class must contain the function really fetching the
16519 * image object to show for this item, which could be an Evas image
16520 * object or an Elementary photo, for example. The @p data
16521 * parameter is going to be passed to both class functions of the
16524 * @see #Elm_Slideshow_Item_Class
16525 * @see elm_slideshow_item_sorted_insert()
16527 * @ingroup Slideshow
16529 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16532 * Insert a new item into the given slideshow widget, using the @p func
16533 * function to sort items (by item handles).
16535 * @param obj The slideshow object
16536 * @param itc The item class for the item
16537 * @param data The item's data
16538 * @param func The comparing function to be used to sort slideshow
16539 * items <b>by #Elm_Slideshow_Item item handles</b>
16540 * @return Returns The slideshow item handle, on success, or
16541 * @c NULL, on errors
16543 * Add a new item to @p obj's internal list of items, in a position
16544 * determined by the @p func comparing function. The item's class
16545 * must contain the function really fetching the image object to
16546 * show for this item, which could be an Evas image object or an
16547 * Elementary photo, for example. The @p data parameter is going to
16548 * be passed to both class functions of the item.
16550 * @see #Elm_Slideshow_Item_Class
16551 * @see elm_slideshow_item_add()
16553 * @ingroup Slideshow
16555 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);
16558 * Display a given slideshow widget's item, programmatically.
16560 * @param obj The slideshow object
16561 * @param item The item to display on @p obj's viewport
16563 * The change between the current item and @p item will use the
16564 * transition @p obj is set to use (@see
16565 * elm_slideshow_transition_set()).
16567 * @ingroup Slideshow
16569 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16572 * Slide to the @b next item, in a given slideshow widget
16574 * @param obj The slideshow object
16576 * The sliding animation @p obj is set to use will be the
16577 * transition effect used, after this call is issued.
16579 * @note If the end of the slideshow's internal list of items is
16580 * reached, it'll wrap around to the list's beginning, again.
16582 * @ingroup Slideshow
16584 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16587 * Slide to the @b previous item, in a given slideshow widget
16589 * @param obj The slideshow object
16591 * The sliding animation @p obj is set to use will be the
16592 * transition effect used, after this call is issued.
16594 * @note If the beginning of the slideshow's internal list of items
16595 * is reached, it'll wrap around to the list's end, again.
16597 * @ingroup Slideshow
16599 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16602 * Returns the list of sliding transition/effect names available, for a
16603 * given slideshow widget.
16605 * @param obj The slideshow object
16606 * @return The list of transitions (list of @b stringshared strings
16609 * The transitions, which come from @p obj's theme, must be an EDC
16610 * data item named @c "transitions" on the theme file, with (prefix)
16611 * names of EDC programs actually implementing them.
16613 * The available transitions for slideshows on the default theme are:
16614 * - @c "fade" - the current item fades out, while the new one
16615 * fades in to the slideshow's viewport.
16616 * - @c "black_fade" - the current item fades to black, and just
16617 * then, the new item will fade in.
16618 * - @c "horizontal" - the current item slides horizontally, until
16619 * it gets out of the slideshow's viewport, while the new item
16620 * comes from the left to take its place.
16621 * - @c "vertical" - the current item slides vertically, until it
16622 * gets out of the slideshow's viewport, while the new item comes
16623 * from the bottom to take its place.
16624 * - @c "square" - the new item starts to appear from the middle of
16625 * the current one, but with a tiny size, growing until its
16626 * target (full) size and covering the old one.
16628 * @warning The stringshared strings get no new references
16629 * exclusive to the user grabbing the list, here, so if you'd like
16630 * to use them out of this call's context, you'd better @c
16631 * eina_stringshare_ref() them.
16633 * @see elm_slideshow_transition_set()
16635 * @ingroup Slideshow
16637 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16640 * Set the current slide transition/effect in use for a given
16643 * @param obj The slideshow object
16644 * @param transition The new transition's name string
16646 * If @p transition is implemented in @p obj's theme (i.e., is
16647 * contained in the list returned by
16648 * elm_slideshow_transitions_get()), this new sliding effect will
16649 * be used on the widget.
16651 * @see elm_slideshow_transitions_get() for more details
16653 * @ingroup Slideshow
16655 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16658 * Get the current slide transition/effect in use for a given
16661 * @param obj The slideshow object
16662 * @return The current transition's name
16664 * @see elm_slideshow_transition_set() for more details
16666 * @ingroup Slideshow
16668 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16671 * Set the interval between each image transition on a given
16672 * slideshow widget, <b>and start the slideshow, itself</b>
16674 * @param obj The slideshow object
16675 * @param timeout The new displaying timeout for images
16677 * After this call, the slideshow widget will start cycling its
16678 * view, sequentially and automatically, with the images of the
16679 * items it has. The time between each new image displayed is going
16680 * to be @p timeout, in @b seconds. If a different timeout was set
16681 * previously and an slideshow was in progress, it will continue
16682 * with the new time between transitions, after this call.
16684 * @note A value less than or equal to 0 on @p timeout will disable
16685 * the widget's internal timer, thus halting any slideshow which
16686 * could be happening on @p obj.
16688 * @see elm_slideshow_timeout_get()
16690 * @ingroup Slideshow
16692 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16695 * Get the interval set for image transitions on a given slideshow
16698 * @param obj The slideshow object
16699 * @return Returns the timeout set on it
16701 * @see elm_slideshow_timeout_set() for more details
16703 * @ingroup Slideshow
16705 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16708 * Set if, after a slideshow is started, for a given slideshow
16709 * widget, its items should be displayed cyclically or not.
16711 * @param obj The slideshow object
16712 * @param loop Use @c EINA_TRUE to make it cycle through items or
16713 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16716 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16717 * ignore what is set by this functions, i.e., they'll @b always
16718 * cycle through items. This affects only the "automatic"
16719 * slideshow, as set by elm_slideshow_timeout_set().
16721 * @see elm_slideshow_loop_get()
16723 * @ingroup Slideshow
16725 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16728 * Get if, after a slideshow is started, for a given slideshow
16729 * widget, its items are to be displayed cyclically or not.
16731 * @param obj The slideshow object
16732 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16733 * through or @c EINA_FALSE, otherwise
16735 * @see elm_slideshow_loop_set() for more details
16737 * @ingroup Slideshow
16739 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16742 * Remove all items from a given slideshow widget
16744 * @param obj The slideshow object
16746 * This removes (and deletes) all items in @p obj, leaving it
16749 * @see elm_slideshow_item_del(), to remove just one item.
16751 * @ingroup Slideshow
16753 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16756 * Get the internal list of items in a given slideshow widget.
16758 * @param obj The slideshow object
16759 * @return The list of items (#Elm_Slideshow_Item as data) or
16760 * @c NULL on errors.
16762 * This list is @b not to be modified in any way and must not be
16763 * freed. Use the list members with functions like
16764 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16766 * @warning This list is only valid until @p obj object's internal
16767 * items list is changed. It should be fetched again with another
16768 * call to this function when changes happen.
16770 * @ingroup Slideshow
16772 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16775 * Delete a given item from a slideshow widget.
16777 * @param item The slideshow item
16779 * @ingroup Slideshow
16781 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16784 * Return the data associated with a given slideshow item
16786 * @param item The slideshow item
16787 * @return Returns the data associated to this item
16789 * @ingroup Slideshow
16791 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16794 * Returns the currently displayed item, in a given slideshow widget
16796 * @param obj The slideshow object
16797 * @return A handle to the item being displayed in @p obj or
16798 * @c NULL, if none is (and on errors)
16800 * @ingroup Slideshow
16802 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16805 * Get the real Evas object created to implement the view of a
16806 * given slideshow item
16808 * @param item The slideshow item.
16809 * @return the Evas object implementing this item's view.
16811 * This returns the actual Evas object used to implement the
16812 * specified slideshow item's view. This may be @c NULL, as it may
16813 * not have been created or may have been deleted, at any time, by
16814 * the slideshow. <b>Do not modify this object</b> (move, resize,
16815 * show, hide, etc.), as the slideshow is controlling it. This
16816 * function is for querying, emitting custom signals or hooking
16817 * lower level callbacks for events on that object. Do not delete
16818 * this object under any circumstances.
16820 * @see elm_slideshow_item_data_get()
16822 * @ingroup Slideshow
16824 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16827 * Get the the item, in a given slideshow widget, placed at
16828 * position @p nth, in its internal items list
16830 * @param obj The slideshow object
16831 * @param nth The number of the item to grab a handle to (0 being
16833 * @return The item stored in @p obj at position @p nth or @c NULL,
16834 * if there's no item with that index (and on errors)
16836 * @ingroup Slideshow
16838 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16841 * Set the current slide layout in use for a given slideshow widget
16843 * @param obj The slideshow object
16844 * @param layout The new layout's name string
16846 * If @p layout is implemented in @p obj's theme (i.e., is contained
16847 * in the list returned by elm_slideshow_layouts_get()), this new
16848 * images layout will be used on the widget.
16850 * @see elm_slideshow_layouts_get() for more details
16852 * @ingroup Slideshow
16854 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16857 * Get the current slide layout in use for a given slideshow widget
16859 * @param obj The slideshow object
16860 * @return The current layout's name
16862 * @see elm_slideshow_layout_set() for more details
16864 * @ingroup Slideshow
16866 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16869 * Returns the list of @b layout names available, for a given
16870 * slideshow widget.
16872 * @param obj The slideshow object
16873 * @return The list of layouts (list of @b stringshared strings
16876 * Slideshow layouts will change how the widget is to dispose each
16877 * image item in its viewport, with regard to cropping, scaling,
16880 * The layouts, which come from @p obj's theme, must be an EDC
16881 * data item name @c "layouts" on the theme file, with (prefix)
16882 * names of EDC programs actually implementing them.
16884 * The available layouts for slideshows on the default theme are:
16885 * - @c "fullscreen" - item images with original aspect, scaled to
16886 * touch top and down slideshow borders or, if the image's heigh
16887 * is not enough, left and right slideshow borders.
16888 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16889 * one, but always leaving 10% of the slideshow's dimensions of
16890 * distance between the item image's borders and the slideshow
16891 * borders, for each axis.
16893 * @warning The stringshared strings get no new references
16894 * exclusive to the user grabbing the list, here, so if you'd like
16895 * to use them out of this call's context, you'd better @c
16896 * eina_stringshare_ref() them.
16898 * @see elm_slideshow_layout_set()
16900 * @ingroup Slideshow
16902 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16905 * Set the number of items to cache, on a given slideshow widget,
16906 * <b>before the current item</b>
16908 * @param obj The slideshow object
16909 * @param count Number of items to cache before the current one
16911 * The default value for this property is @c 2. See
16912 * @ref Slideshow_Caching "slideshow caching" for more details.
16914 * @see elm_slideshow_cache_before_get()
16916 * @ingroup Slideshow
16918 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16921 * Retrieve the number of items to cache, on a given slideshow widget,
16922 * <b>before the current item</b>
16924 * @param obj The slideshow object
16925 * @return The number of items set to be cached before the current one
16927 * @see elm_slideshow_cache_before_set() for more details
16929 * @ingroup Slideshow
16931 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16934 * Set the number of items to cache, on a given slideshow widget,
16935 * <b>after the current item</b>
16937 * @param obj The slideshow object
16938 * @param count Number of items to cache after the current one
16940 * The default value for this property is @c 2. See
16941 * @ref Slideshow_Caching "slideshow caching" for more details.
16943 * @see elm_slideshow_cache_after_get()
16945 * @ingroup Slideshow
16947 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16950 * Retrieve the number of items to cache, on a given slideshow widget,
16951 * <b>after the current item</b>
16953 * @param obj The slideshow object
16954 * @return The number of items set to be cached after the current one
16956 * @see elm_slideshow_cache_after_set() for more details
16958 * @ingroup Slideshow
16960 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16963 * Get the number of items stored in a given slideshow widget
16965 * @param obj The slideshow object
16966 * @return The number of items on @p obj, at the moment of this call
16968 * @ingroup Slideshow
16970 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16977 * @defgroup Fileselector File Selector
16979 * @image html img/widget/fileselector/preview-00.png
16980 * @image latex img/widget/fileselector/preview-00.eps
16982 * A file selector is a widget that allows a user to navigate
16983 * through a file system, reporting file selections back via its
16986 * It contains shortcut buttons for home directory (@c ~) and to
16987 * jump one directory upwards (..), as well as cancel/ok buttons to
16988 * confirm/cancel a given selection. After either one of those two
16989 * former actions, the file selector will issue its @c "done" smart
16992 * There's a text entry on it, too, showing the name of the current
16993 * selection. There's the possibility of making it editable, so it
16994 * is useful on file saving dialogs on applications, where one
16995 * gives a file name to save contents to, in a given directory in
16996 * the system. This custom file name will be reported on the @c
16997 * "done" smart callback (explained in sequence).
16999 * Finally, it has a view to display file system items into in two
17004 * If Elementary is built with support of the Ethumb thumbnailing
17005 * library, the second form of view will display preview thumbnails
17006 * of files which it supports.
17008 * Smart callbacks one can register to:
17010 * - @c "selected" - the user has clicked on a file (when not in
17011 * folders-only mode) or directory (when in folders-only mode)
17012 * - @c "directory,open" - the list has been populated with new
17013 * content (@c event_info is a pointer to the directory's
17014 * path, a @b stringshared string)
17015 * - @c "done" - the user has clicked on the "ok" or "cancel"
17016 * buttons (@c event_info is a pointer to the selection's
17017 * path, a @b stringshared string)
17019 * Here is an example on its usage:
17020 * @li @ref fileselector_example
17024 * @addtogroup Fileselector
17029 * Defines how a file selector widget is to layout its contents
17030 * (file system entries).
17032 typedef enum _Elm_Fileselector_Mode
17034 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
17035 ELM_FILESELECTOR_GRID, /**< layout as a grid */
17036 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
17037 } Elm_Fileselector_Mode;
17040 * Add a new file selector widget to the given parent Elementary
17041 * (container) object
17043 * @param parent The parent object
17044 * @return a new file selector widget handle or @c NULL, on errors
17046 * This function inserts a new file selector widget on the canvas.
17048 * @ingroup Fileselector
17050 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17053 * Enable/disable the file name entry box where the user can type
17054 * in a name for a file, in a given file selector widget
17056 * @param obj The file selector object
17057 * @param is_save @c EINA_TRUE to make the file selector a "saving
17058 * dialog", @c EINA_FALSE otherwise
17060 * Having the entry editable is useful on file saving dialogs on
17061 * applications, where one gives a file name to save contents to,
17062 * in a given directory in the system. This custom file name will
17063 * be reported on the @c "done" smart callback.
17065 * @see elm_fileselector_is_save_get()
17067 * @ingroup Fileselector
17069 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
17072 * Get whether the given file selector is in "saving dialog" mode
17074 * @param obj The file selector object
17075 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
17076 * mode, @c EINA_FALSE otherwise (and on errors)
17078 * @see elm_fileselector_is_save_set() for more details
17080 * @ingroup Fileselector
17082 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17085 * Enable/disable folder-only view for a given file selector widget
17087 * @param obj The file selector object
17088 * @param only @c EINA_TRUE to make @p obj only display
17089 * directories, @c EINA_FALSE to make files to be displayed in it
17092 * If enabled, the widget's view will only display folder items,
17095 * @see elm_fileselector_folder_only_get()
17097 * @ingroup Fileselector
17099 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
17102 * Get whether folder-only view is set for a given file selector
17105 * @param obj The file selector object
17106 * @return only @c EINA_TRUE if @p obj is only displaying
17107 * directories, @c EINA_FALSE if files are being displayed in it
17108 * too (and on errors)
17110 * @see elm_fileselector_folder_only_get()
17112 * @ingroup Fileselector
17114 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17117 * Enable/disable the "ok" and "cancel" buttons on a given file
17120 * @param obj The file selector object
17121 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
17123 * @note A file selector without those buttons will never emit the
17124 * @c "done" smart event, and is only usable if one is just hooking
17125 * to the other two events.
17127 * @see elm_fileselector_buttons_ok_cancel_get()
17129 * @ingroup Fileselector
17131 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
17134 * Get whether the "ok" and "cancel" buttons on a given file
17135 * selector widget are being shown.
17137 * @param obj The file selector object
17138 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
17139 * otherwise (and on errors)
17141 * @see elm_fileselector_buttons_ok_cancel_set() for more details
17143 * @ingroup Fileselector
17145 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17148 * Enable/disable a tree view in the given file selector widget,
17149 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
17151 * @param obj The file selector object
17152 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
17155 * In a tree view, arrows are created on the sides of directories,
17156 * allowing them to expand in place.
17158 * @note If it's in other mode, the changes made by this function
17159 * will only be visible when one switches back to "list" mode.
17161 * @see elm_fileselector_expandable_get()
17163 * @ingroup Fileselector
17165 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
17168 * Get whether tree view is enabled for the given file selector
17171 * @param obj The file selector object
17172 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
17173 * otherwise (and or errors)
17175 * @see elm_fileselector_expandable_set() for more details
17177 * @ingroup Fileselector
17179 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17182 * Set, programmatically, the @b directory that a given file
17183 * selector widget will display contents from
17185 * @param obj The file selector object
17186 * @param path The path to display in @p obj
17188 * This will change the @b directory that @p obj is displaying. It
17189 * will also clear the text entry area on the @p obj object, which
17190 * displays select files' names.
17192 * @see elm_fileselector_path_get()
17194 * @ingroup Fileselector
17196 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17199 * Get the parent directory's path that a given file selector
17200 * widget is displaying
17202 * @param obj The file selector object
17203 * @return The (full) path of the directory the file selector is
17204 * displaying, a @b stringshared string
17206 * @see elm_fileselector_path_set()
17208 * @ingroup Fileselector
17210 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17213 * Set, programmatically, the currently selected file/directory in
17214 * the given file selector widget
17216 * @param obj The file selector object
17217 * @param path The (full) path to a file or directory
17218 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
17219 * latter case occurs if the directory or file pointed to do not
17222 * @see elm_fileselector_selected_get()
17224 * @ingroup Fileselector
17226 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17229 * Get the currently selected item's (full) path, in the given file
17232 * @param obj The file selector object
17233 * @return The absolute path of the selected item, a @b
17234 * stringshared string
17236 * @note Custom editions on @p obj object's text entry, if made,
17237 * will appear on the return string of this function, naturally.
17239 * @see elm_fileselector_selected_set() for more details
17241 * @ingroup Fileselector
17243 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17246 * Set the mode in which a given file selector widget will display
17247 * (layout) file system entries in its view
17249 * @param obj The file selector object
17250 * @param mode The mode of the fileselector, being it one of
17251 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17252 * first one, naturally, will display the files in a list. The
17253 * latter will make the widget to display its entries in a grid
17256 * @note By using elm_fileselector_expandable_set(), the user may
17257 * trigger a tree view for that list.
17259 * @note If Elementary is built with support of the Ethumb
17260 * thumbnailing library, the second form of view will display
17261 * preview thumbnails of files which it supports. You must have
17262 * elm_need_ethumb() called in your Elementary for thumbnailing to
17265 * @see elm_fileselector_expandable_set().
17266 * @see elm_fileselector_mode_get().
17268 * @ingroup Fileselector
17270 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17273 * Get the mode in which a given file selector widget is displaying
17274 * (layouting) file system entries in its view
17276 * @param obj The fileselector object
17277 * @return The mode in which the fileselector is at
17279 * @see elm_fileselector_mode_set() for more details
17281 * @ingroup Fileselector
17283 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17290 * @defgroup Progressbar Progress bar
17292 * The progress bar is a widget for visually representing the
17293 * progress status of a given job/task.
17295 * A progress bar may be horizontal or vertical. It may display an
17296 * icon besides it, as well as primary and @b units labels. The
17297 * former is meant to label the widget as a whole, while the
17298 * latter, which is formatted with floating point values (and thus
17299 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17300 * units"</c>), is meant to label the widget's <b>progress
17301 * value</b>. Label, icon and unit strings/objects are @b optional
17302 * for progress bars.
17304 * A progress bar may be @b inverted, in which state it gets its
17305 * values inverted, with high values being on the left or top and
17306 * low values on the right or bottom, as opposed to normally have
17307 * the low values on the former and high values on the latter,
17308 * respectively, for horizontal and vertical modes.
17310 * The @b span of the progress, as set by
17311 * elm_progressbar_span_size_set(), is its length (horizontally or
17312 * vertically), unless one puts size hints on the widget to expand
17313 * on desired directions, by any container. That length will be
17314 * scaled by the object or applications scaling factor. At any
17315 * point code can query the progress bar for its value with
17316 * elm_progressbar_value_get().
17318 * Available widget styles for progress bars:
17320 * - @c "wheel" (simple style, no text, no progression, only
17321 * "pulse" effect is available)
17323 * Here is an example on its usage:
17324 * @li @ref progressbar_example
17328 * Add a new progress bar widget to the given parent Elementary
17329 * (container) object
17331 * @param parent The parent object
17332 * @return a new progress bar widget handle or @c NULL, on errors
17334 * This function inserts a new progress bar widget on the canvas.
17336 * @ingroup Progressbar
17338 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17341 * Set whether a given progress bar widget is at "pulsing mode" or
17344 * @param obj The progress bar object
17345 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17346 * @c EINA_FALSE to put it back to its default one
17348 * By default, progress bars will display values from the low to
17349 * high value boundaries. There are, though, contexts in which the
17350 * state of progression of a given task is @b unknown. For those,
17351 * one can set a progress bar widget to a "pulsing state", to give
17352 * the user an idea that some computation is being held, but
17353 * without exact progress values. In the default theme it will
17354 * animate its bar with the contents filling in constantly and back
17355 * to non-filled, in a loop. To start and stop this pulsing
17356 * animation, one has to explicitly call elm_progressbar_pulse().
17358 * @see elm_progressbar_pulse_get()
17359 * @see elm_progressbar_pulse()
17361 * @ingroup Progressbar
17363 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17366 * Get whether a given progress bar widget is at "pulsing mode" or
17369 * @param obj The progress bar object
17370 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17371 * if it's in the default one (and on errors)
17373 * @ingroup Progressbar
17375 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17378 * Start/stop a given progress bar "pulsing" animation, if its
17381 * @param obj The progress bar object
17382 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17383 * @c EINA_FALSE to @b stop it
17385 * @note This call won't do anything if @p obj is not under "pulsing mode".
17387 * @see elm_progressbar_pulse_set() for more details.
17389 * @ingroup Progressbar
17391 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17394 * Set the progress value (in percentage) on a given progress bar
17397 * @param obj The progress bar object
17398 * @param val The progress value (@b must be between @c 0.0 and @c
17401 * Use this call to set progress bar levels.
17403 * @note If you passes a value out of the specified range for @p
17404 * val, it will be interpreted as the @b closest of the @b boundary
17405 * values in the range.
17407 * @ingroup Progressbar
17409 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17412 * Get the progress value (in percentage) on a given progress bar
17415 * @param obj The progress bar object
17416 * @return The value of the progressbar
17418 * @see elm_progressbar_value_set() for more details
17420 * @ingroup Progressbar
17422 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17425 * Set the label of a given progress bar widget
17427 * @param obj The progress bar object
17428 * @param label The text label string, in UTF-8
17430 * @ingroup Progressbar
17431 * @deprecated use elm_object_text_set() instead.
17433 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17436 * Get the label of a given progress bar widget
17438 * @param obj The progressbar object
17439 * @return The text label string, in UTF-8
17441 * @ingroup Progressbar
17442 * @deprecated use elm_object_text_set() instead.
17444 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17447 * Set the icon object of a given progress bar widget
17449 * @param obj The progress bar object
17450 * @param icon The icon object
17452 * Use this call to decorate @p obj with an icon next to it.
17454 * @note Once the icon object is set, a previously set one will be
17455 * deleted. If you want to keep that old content object, use the
17456 * elm_progressbar_icon_unset() function.
17458 * @see elm_progressbar_icon_get()
17460 * @ingroup Progressbar
17462 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17465 * Retrieve the icon object set for a given progress bar widget
17467 * @param obj The progress bar object
17468 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17469 * otherwise (and on errors)
17471 * @see elm_progressbar_icon_set() for more details
17473 * @ingroup Progressbar
17475 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17478 * Unset an icon set on a given progress bar widget
17480 * @param obj The progress bar object
17481 * @return The icon object that was being used, if any was set, or
17482 * @c NULL, otherwise (and on errors)
17484 * This call will unparent and return the icon object which was set
17485 * for this widget, previously, on success.
17487 * @see elm_progressbar_icon_set() for more details
17489 * @ingroup Progressbar
17491 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17494 * Set the (exact) length of the bar region of a given progress bar
17497 * @param obj The progress bar object
17498 * @param size The length of the progress bar's bar region
17500 * This sets the minimum width (when in horizontal mode) or height
17501 * (when in vertical mode) of the actual bar area of the progress
17502 * bar @p obj. This in turn affects the object's minimum size. Use
17503 * this when you're not setting other size hints expanding on the
17504 * given direction (like weight and alignment hints) and you would
17505 * like it to have a specific size.
17507 * @note Icon, label and unit text around @p obj will require their
17508 * own space, which will make @p obj to require more the @p size,
17511 * @see elm_progressbar_span_size_get()
17513 * @ingroup Progressbar
17515 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17518 * Get the length set for the bar region of a given progress bar
17521 * @param obj The progress bar object
17522 * @return The length of the progress bar's bar region
17524 * If that size was not set previously, with
17525 * elm_progressbar_span_size_set(), this call will return @c 0.
17527 * @ingroup Progressbar
17529 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17532 * Set the format string for a given progress bar widget's units
17535 * @param obj The progress bar object
17536 * @param format The format string for @p obj's units label
17538 * If @c NULL is passed on @p format, it will make @p obj's units
17539 * area to be hidden completely. If not, it'll set the <b>format
17540 * string</b> for the units label's @b text. The units label is
17541 * provided a floating point value, so the units text is up display
17542 * at most one floating point falue. Note that the units label is
17543 * optional. Use a format string such as "%1.2f meters" for
17546 * @note The default format string for a progress bar is an integer
17547 * percentage, as in @c "%.0f %%".
17549 * @see elm_progressbar_unit_format_get()
17551 * @ingroup Progressbar
17553 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17556 * Retrieve the format string set for a given progress bar widget's
17559 * @param obj The progress bar object
17560 * @return The format set string for @p obj's units label or
17561 * @c NULL, if none was set (and on errors)
17563 * @see elm_progressbar_unit_format_set() for more details
17565 * @ingroup Progressbar
17567 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17570 * Set the orientation of a given progress bar widget
17572 * @param obj The progress bar object
17573 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17574 * @b horizontal, @c EINA_FALSE to make it @b vertical
17576 * Use this function to change how your progress bar is to be
17577 * disposed: vertically or horizontally.
17579 * @see elm_progressbar_horizontal_get()
17581 * @ingroup Progressbar
17583 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17586 * Retrieve the orientation of a given progress bar widget
17588 * @param obj The progress bar object
17589 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17590 * @c EINA_FALSE if it's @b vertical (and on errors)
17592 * @see elm_progressbar_horizontal_set() for more details
17594 * @ingroup Progressbar
17596 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17599 * Invert a given progress bar widget's displaying values order
17601 * @param obj The progress bar object
17602 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17603 * @c EINA_FALSE to bring it back to default, non-inverted values.
17605 * A progress bar may be @b inverted, in which state it gets its
17606 * values inverted, with high values being on the left or top and
17607 * low values on the right or bottom, as opposed to normally have
17608 * the low values on the former and high values on the latter,
17609 * respectively, for horizontal and vertical modes.
17611 * @see elm_progressbar_inverted_get()
17613 * @ingroup Progressbar
17615 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17618 * Get whether a given progress bar widget's displaying values are
17621 * @param obj The progress bar object
17622 * @return @c EINA_TRUE, if @p obj has inverted values,
17623 * @c EINA_FALSE otherwise (and on errors)
17625 * @see elm_progressbar_inverted_set() for more details
17627 * @ingroup Progressbar
17629 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17632 * @defgroup Separator Separator
17634 * @brief Separator is a very thin object used to separate other objects.
17636 * A separator can be vertical or horizontal.
17638 * @ref tutorial_separator is a good example of how to use a separator.
17642 * @brief Add a separator object to @p parent
17644 * @param parent The parent object
17646 * @return The separator object, or NULL upon failure
17648 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17650 * @brief Set the horizontal mode of a separator object
17652 * @param obj The separator object
17653 * @param horizontal If true, the separator is horizontal
17655 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17657 * @brief Get the horizontal mode of a separator object
17659 * @param obj The separator object
17660 * @return If true, the separator is horizontal
17662 * @see elm_separator_horizontal_set()
17664 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17670 * @defgroup Spinner Spinner
17671 * @ingroup Elementary
17673 * @image html img/widget/spinner/preview-00.png
17674 * @image latex img/widget/spinner/preview-00.eps
17676 * A spinner is a widget which allows the user to increase or decrease
17677 * numeric values using arrow buttons, or edit values directly, clicking
17678 * over it and typing the new value.
17680 * By default the spinner will not wrap and has a label
17681 * of "%.0f" (just showing the integer value of the double).
17683 * A spinner has a label that is formatted with floating
17684 * point values and thus accepts a printf-style format string, like
17687 * It also allows specific values to be replaced by pre-defined labels.
17689 * Smart callbacks one can register to:
17691 * - "changed" - Whenever the spinner value is changed.
17692 * - "delay,changed" - A short time after the value is changed by the user.
17693 * This will be called only when the user stops dragging for a very short
17694 * period or when they release their finger/mouse, so it avoids possibly
17695 * expensive reactions to the value change.
17697 * Available styles for it:
17699 * - @c "vertical": up/down buttons at the right side and text left aligned.
17701 * Here is an example on its usage:
17702 * @ref spinner_example
17706 * @addtogroup Spinner
17711 * Add a new spinner widget to the given parent Elementary
17712 * (container) object.
17714 * @param parent The parent object.
17715 * @return a new spinner widget handle or @c NULL, on errors.
17717 * This function inserts a new spinner widget on the canvas.
17722 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17725 * Set the format string of the displayed label.
17727 * @param obj The spinner object.
17728 * @param fmt The format string for the label display.
17730 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17731 * string for the label text. The label text is provided a floating point
17732 * value, so the label text can display up to 1 floating point value.
17733 * Note that this is optional.
17735 * Use a format string such as "%1.2f meters" for example, and it will
17736 * display values like: "3.14 meters" for a value equal to 3.14159.
17738 * Default is "%0.f".
17740 * @see elm_spinner_label_format_get()
17744 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17747 * Get the label format of the spinner.
17749 * @param obj The spinner object.
17750 * @return The text label format string in UTF-8.
17752 * @see elm_spinner_label_format_set() for details.
17756 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17759 * Set the minimum and maximum values for the spinner.
17761 * @param obj The spinner object.
17762 * @param min The minimum value.
17763 * @param max The maximum value.
17765 * Define the allowed range of values to be selected by the user.
17767 * If actual value is less than @p min, it will be updated to @p min. If it
17768 * is bigger then @p max, will be updated to @p max. Actual value can be
17769 * get with elm_spinner_value_get().
17771 * By default, min is equal to 0, and max is equal to 100.
17773 * @warning Maximum must be greater than minimum.
17775 * @see elm_spinner_min_max_get()
17779 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17782 * Get the minimum and maximum values of the spinner.
17784 * @param obj The spinner object.
17785 * @param min Pointer where to store the minimum value.
17786 * @param max Pointer where to store the maximum value.
17788 * @note If only one value is needed, the other pointer can be passed
17791 * @see elm_spinner_min_max_set() for details.
17795 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17798 * Set the step used to increment or decrement the spinner value.
17800 * @param obj The spinner object.
17801 * @param step The step value.
17803 * This value will be incremented or decremented to the displayed value.
17804 * It will be incremented while the user keep right or top arrow pressed,
17805 * and will be decremented while the user keep left or bottom arrow pressed.
17807 * The interval to increment / decrement can be set with
17808 * elm_spinner_interval_set().
17810 * By default step value is equal to 1.
17812 * @see elm_spinner_step_get()
17816 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17819 * Get the step used to increment or decrement the spinner value.
17821 * @param obj The spinner object.
17822 * @return The step value.
17824 * @see elm_spinner_step_get() for more details.
17828 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17831 * Set the value the spinner displays.
17833 * @param obj The spinner object.
17834 * @param val The value to be displayed.
17836 * Value will be presented on the label following format specified with
17837 * elm_spinner_format_set().
17839 * @warning The value must to be between min and max values. This values
17840 * are set by elm_spinner_min_max_set().
17842 * @see elm_spinner_value_get().
17843 * @see elm_spinner_format_set().
17844 * @see elm_spinner_min_max_set().
17848 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17851 * Get the value displayed by the spinner.
17853 * @param obj The spinner object.
17854 * @return The value displayed.
17856 * @see elm_spinner_value_set() for details.
17860 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17863 * Set whether the spinner should wrap when it reaches its
17864 * minimum or maximum value.
17866 * @param obj The spinner object.
17867 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17870 * Disabled by default. If disabled, when the user tries to increment the
17872 * but displayed value plus step value is bigger than maximum value,
17874 * won't allow it. The same happens when the user tries to decrement it,
17875 * but the value less step is less than minimum value.
17877 * When wrap is enabled, in such situations it will allow these changes,
17878 * but will get the value that would be less than minimum and subtracts
17879 * from maximum. Or add the value that would be more than maximum to
17883 * @li min value = 10
17884 * @li max value = 50
17885 * @li step value = 20
17886 * @li displayed value = 20
17888 * When the user decrement value (using left or bottom arrow), it will
17889 * displays @c 40, because max - (min - (displayed - step)) is
17890 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17892 * @see elm_spinner_wrap_get().
17896 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17899 * Get whether the spinner should wrap when it reaches its
17900 * minimum or maximum value.
17902 * @param obj The spinner object
17903 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17904 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17906 * @see elm_spinner_wrap_set() for details.
17910 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17913 * Set whether the spinner can be directly edited by the user or not.
17915 * @param obj The spinner object.
17916 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17917 * don't allow users to edit it directly.
17919 * Spinner objects can have edition @b disabled, in which state they will
17920 * be changed only by arrows.
17921 * Useful for contexts
17922 * where you don't want your users to interact with it writting the value.
17924 * when using special values, the user can see real value instead
17925 * of special label on edition.
17927 * It's enabled by default.
17929 * @see elm_spinner_editable_get()
17933 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17936 * Get whether the spinner can be directly edited by the user or not.
17938 * @param obj The spinner object.
17939 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17940 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17942 * @see elm_spinner_editable_set() for details.
17946 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17949 * Set a special string to display in the place of the numerical value.
17951 * @param obj The spinner object.
17952 * @param value The value to be replaced.
17953 * @param label The label to be used.
17955 * It's useful for cases when a user should select an item that is
17956 * better indicated by a label than a value. For example, weekdays or months.
17960 * sp = elm_spinner_add(win);
17961 * elm_spinner_min_max_set(sp, 1, 3);
17962 * elm_spinner_special_value_add(sp, 1, "January");
17963 * elm_spinner_special_value_add(sp, 2, "February");
17964 * elm_spinner_special_value_add(sp, 3, "March");
17965 * evas_object_show(sp);
17970 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17973 * Set the interval on time updates for an user mouse button hold
17974 * on spinner widgets' arrows.
17976 * @param obj The spinner object.
17977 * @param interval The (first) interval value in seconds.
17979 * This interval value is @b decreased while the user holds the
17980 * mouse pointer either incrementing or decrementing spinner's value.
17982 * This helps the user to get to a given value distant from the
17983 * current one easier/faster, as it will start to change quicker and
17984 * quicker on mouse button holds.
17986 * The calculation for the next change interval value, starting from
17987 * the one set with this call, is the previous interval divided by
17988 * @c 1.05, so it decreases a little bit.
17990 * The default starting interval value for automatic changes is
17993 * @see elm_spinner_interval_get()
17997 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
18000 * Get the interval on time updates for an user mouse button hold
18001 * on spinner widgets' arrows.
18003 * @param obj The spinner object.
18004 * @return The (first) interval value, in seconds, set on it.
18006 * @see elm_spinner_interval_set() for more details.
18010 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18017 * @defgroup Index Index
18019 * @image html img/widget/index/preview-00.png
18020 * @image latex img/widget/index/preview-00.eps
18022 * An index widget gives you an index for fast access to whichever
18023 * group of other UI items one might have. It's a list of text
18024 * items (usually letters, for alphabetically ordered access).
18026 * Index widgets are by default hidden and just appear when the
18027 * user clicks over it's reserved area in the canvas. In its
18028 * default theme, it's an area one @ref Fingers "finger" wide on
18029 * the right side of the index widget's container.
18031 * When items on the index are selected, smart callbacks get
18032 * called, so that its user can make other container objects to
18033 * show a given area or child object depending on the index item
18034 * selected. You'd probably be using an index together with @ref
18035 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
18038 * Smart events one can add callbacks for are:
18039 * - @c "changed" - When the selected index item changes. @c
18040 * event_info is the selected item's data pointer.
18041 * - @c "delay,changed" - When the selected index item changes, but
18042 * after a small idling period. @c event_info is the selected
18043 * item's data pointer.
18044 * - @c "selected" - When the user releases a mouse button and
18045 * selects an item. @c event_info is the selected item's data
18047 * - @c "level,up" - when the user moves a finger from the first
18048 * level to the second level
18049 * - @c "level,down" - when the user moves a finger from the second
18050 * level to the first level
18052 * The @c "delay,changed" event is so that it'll wait a small time
18053 * before actually reporting those events and, moreover, just the
18054 * last event happening on those time frames will actually be
18057 * Here are some examples on its usage:
18058 * @li @ref index_example_01
18059 * @li @ref index_example_02
18063 * @addtogroup Index
18067 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
18070 * Add a new index widget to the given parent Elementary
18071 * (container) object
18073 * @param parent The parent object
18074 * @return a new index widget handle or @c NULL, on errors
18076 * This function inserts a new index widget on the canvas.
18080 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18083 * Set whether a given index widget is or not visible,
18086 * @param obj The index object
18087 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
18089 * Not to be confused with visible as in @c evas_object_show() --
18090 * visible with regard to the widget's auto hiding feature.
18092 * @see elm_index_active_get()
18096 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
18099 * Get whether a given index widget is currently visible or not.
18101 * @param obj The index object
18102 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
18104 * @see elm_index_active_set() for more details
18108 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18111 * Set the items level for a given index widget.
18113 * @param obj The index object.
18114 * @param level @c 0 or @c 1, the currently implemented levels.
18116 * @see elm_index_item_level_get()
18120 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18123 * Get the items level set for a given index widget.
18125 * @param obj The index object.
18126 * @return @c 0 or @c 1, which are the levels @p obj might be at.
18128 * @see elm_index_item_level_set() for more information
18132 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18135 * Returns the last selected item's data, for a given index widget.
18137 * @param obj The index object.
18138 * @return The item @b data associated to the last selected item on
18139 * @p obj (or @c NULL, on errors).
18141 * @warning The returned value is @b not an #Elm_Index_Item item
18142 * handle, but the data associated to it (see the @c item parameter
18143 * in elm_index_item_append(), as an example).
18147 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18150 * Append a new item on a given index widget.
18152 * @param obj The index object.
18153 * @param letter Letter under which the item should be indexed
18154 * @param item The item data to set for the index's item
18156 * Despite the most common usage of the @p letter argument is for
18157 * single char strings, one could use arbitrary strings as index
18160 * @c item will be the pointer returned back on @c "changed", @c
18161 * "delay,changed" and @c "selected" smart events.
18165 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18168 * Prepend a new item on a given index widget.
18170 * @param obj The index object.
18171 * @param letter Letter under which the item should be indexed
18172 * @param item The item data to set for the index's item
18174 * Despite the most common usage of the @p letter argument is for
18175 * single char strings, one could use arbitrary strings as index
18178 * @c item will be the pointer returned back on @c "changed", @c
18179 * "delay,changed" and @c "selected" smart events.
18183 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18186 * Append a new item, on a given index widget, <b>after the item
18187 * having @p relative as data</b>.
18189 * @param obj The index object.
18190 * @param letter Letter under which the item should be indexed
18191 * @param item The item data to set for the index's item
18192 * @param relative The item data of the index item to be the
18193 * predecessor of this new one
18195 * Despite the most common usage of the @p letter argument is for
18196 * single char strings, one could use arbitrary strings as index
18199 * @c item will be the pointer returned back on @c "changed", @c
18200 * "delay,changed" and @c "selected" smart events.
18202 * @note If @p relative is @c NULL or if it's not found to be data
18203 * set on any previous item on @p obj, this function will behave as
18204 * elm_index_item_append().
18208 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18211 * Prepend a new item, on a given index widget, <b>after the item
18212 * having @p relative as data</b>.
18214 * @param obj The index object.
18215 * @param letter Letter under which the item should be indexed
18216 * @param item The item data to set for the index's item
18217 * @param relative The item data of the index item to be the
18218 * successor of this new one
18220 * Despite the most common usage of the @p letter argument is for
18221 * single char strings, one could use arbitrary strings as index
18224 * @c item will be the pointer returned back on @c "changed", @c
18225 * "delay,changed" and @c "selected" smart events.
18227 * @note If @p relative is @c NULL or if it's not found to be data
18228 * set on any previous item on @p obj, this function will behave as
18229 * elm_index_item_prepend().
18233 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18236 * Insert a new item into the given index widget, using @p cmp_func
18237 * function to sort items (by item handles).
18239 * @param obj The index object.
18240 * @param letter Letter under which the item should be indexed
18241 * @param item The item data to set for the index's item
18242 * @param cmp_func The comparing function to be used to sort index
18243 * items <b>by #Elm_Index_Item item handles</b>
18244 * @param cmp_data_func A @b fallback function to be called for the
18245 * sorting of index items <b>by item data</b>). It will be used
18246 * when @p cmp_func returns @c 0 (equality), which means an index
18247 * item with provided item data already exists. To decide which
18248 * data item should be pointed to by the index item in question, @p
18249 * cmp_data_func will be used. If @p cmp_data_func returns a
18250 * non-negative value, the previous index item data will be
18251 * replaced by the given @p item pointer. If the previous data need
18252 * to be freed, it should be done by the @p cmp_data_func function,
18253 * because all references to it will be lost. If this function is
18254 * not provided (@c NULL is given), index items will be @b
18255 * duplicated, if @p cmp_func returns @c 0.
18257 * Despite the most common usage of the @p letter argument is for
18258 * single char strings, one could use arbitrary strings as index
18261 * @c item will be the pointer returned back on @c "changed", @c
18262 * "delay,changed" and @c "selected" smart events.
18266 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);
18269 * Remove an item from a given index widget, <b>to be referenced by
18270 * it's data value</b>.
18272 * @param obj The index object
18273 * @param item The item's data pointer for the item to be removed
18276 * If a deletion callback is set, via elm_index_item_del_cb_set(),
18277 * that callback function will be called by this one.
18279 * @warning The item to be removed from @p obj will be found via
18280 * its item data pointer, and not by an #Elm_Index_Item handle.
18284 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18287 * Find a given index widget's item, <b>using item data</b>.
18289 * @param obj The index object
18290 * @param item The item data pointed to by the desired index item
18291 * @return The index item handle, if found, or @c NULL otherwise
18295 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18298 * Removes @b all items from a given index widget.
18300 * @param obj The index object.
18302 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18303 * that callback function will be called for each item in @p obj.
18307 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18310 * Go to a given items level on a index widget
18312 * @param obj The index object
18313 * @param level The index level (one of @c 0 or @c 1)
18317 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18320 * Return the data associated with a given index widget item
18322 * @param it The index widget item handle
18323 * @return The data associated with @p it
18325 * @see elm_index_item_data_set()
18329 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18332 * Set the data associated with a given index widget item
18334 * @param it The index widget item handle
18335 * @param data The new data pointer to set to @p it
18337 * This sets new item data on @p it.
18339 * @warning The old data pointer won't be touched by this function, so
18340 * the user had better to free that old data himself/herself.
18344 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18347 * Set the function to be called when a given index widget item is freed.
18349 * @param it The item to set the callback on
18350 * @param func The function to call on the item's deletion
18352 * When called, @p func will have both @c data and @c event_info
18353 * arguments with the @p it item's data value and, naturally, the
18354 * @c obj argument with a handle to the parent index widget.
18358 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18361 * Get the letter (string) set on a given index widget item.
18363 * @param it The index item handle
18364 * @return The letter string set on @p it
18368 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18375 * @defgroup Photocam Photocam
18377 * @image html img/widget/photocam/preview-00.png
18378 * @image latex img/widget/photocam/preview-00.eps
18380 * This is a widget specifically for displaying high-resolution digital
18381 * camera photos giving speedy feedback (fast load), low memory footprint
18382 * and zooming and panning as well as fitting logic. It is entirely focused
18383 * on jpeg images, and takes advantage of properties of the jpeg format (via
18384 * evas loader features in the jpeg loader).
18386 * Signals that you can add callbacks for are:
18387 * @li "clicked" - This is called when a user has clicked the photo without
18389 * @li "press" - This is called when a user has pressed down on the photo.
18390 * @li "longpressed" - This is called when a user has pressed down on the
18391 * photo for a long time without dragging around.
18392 * @li "clicked,double" - This is called when a user has double-clicked the
18394 * @li "load" - Photo load begins.
18395 * @li "loaded" - This is called when the image file load is complete for the
18396 * first view (low resolution blurry version).
18397 * @li "load,detail" - Photo detailed data load begins.
18398 * @li "loaded,detail" - This is called when the image file load is complete
18399 * for the detailed image data (full resolution needed).
18400 * @li "zoom,start" - Zoom animation started.
18401 * @li "zoom,stop" - Zoom animation stopped.
18402 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18403 * @li "scroll" - the content has been scrolled (moved)
18404 * @li "scroll,anim,start" - scrolling animation has started
18405 * @li "scroll,anim,stop" - scrolling animation has stopped
18406 * @li "scroll,drag,start" - dragging the contents around has started
18407 * @li "scroll,drag,stop" - dragging the contents around has stopped
18409 * @ref tutorial_photocam shows the API in action.
18413 * @brief Types of zoom available.
18415 typedef enum _Elm_Photocam_Zoom_Mode
18417 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18418 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18419 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18420 ELM_PHOTOCAM_ZOOM_MODE_LAST
18421 } Elm_Photocam_Zoom_Mode;
18423 * @brief Add a new Photocam object
18425 * @param parent The parent object
18426 * @return The new object or NULL if it cannot be created
18428 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18430 * @brief Set the photo file to be shown
18432 * @param obj The photocam object
18433 * @param file The photo file
18434 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18436 * This sets (and shows) the specified file (with a relative or absolute
18437 * path) and will return a load error (same error that
18438 * evas_object_image_load_error_get() will return). The image will change and
18439 * adjust its size at this point and begin a background load process for this
18440 * photo that at some time in the future will be displayed at the full
18443 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18445 * @brief Returns the path of the current image file
18447 * @param obj The photocam object
18448 * @return Returns the path
18450 * @see elm_photocam_file_set()
18452 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18454 * @brief Set the zoom level of the photo
18456 * @param obj The photocam object
18457 * @param zoom The zoom level to set
18459 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18460 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18461 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18462 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18465 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18467 * @brief Get the zoom level of the photo
18469 * @param obj The photocam object
18470 * @return The current zoom level
18472 * This returns the current zoom level of the photocam object. Note that if
18473 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18474 * (which is the default), the zoom level may be changed at any time by the
18475 * photocam object itself to account for photo size and photocam viewpoer
18478 * @see elm_photocam_zoom_set()
18479 * @see elm_photocam_zoom_mode_set()
18481 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18483 * @brief Set the zoom mode
18485 * @param obj The photocam object
18486 * @param mode The desired mode
18488 * This sets the zoom mode to manual or one of several automatic levels.
18489 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18490 * elm_photocam_zoom_set() and will stay at that level until changed by code
18491 * or until zoom mode is changed. This is the default mode. The Automatic
18492 * modes will allow the photocam object to automatically adjust zoom mode
18493 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18494 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18495 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18496 * pixels within the frame are left unfilled.
18498 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18500 * @brief Get the zoom mode
18502 * @param obj The photocam object
18503 * @return The current zoom mode
18505 * This gets the current zoom mode of the photocam object.
18507 * @see elm_photocam_zoom_mode_set()
18509 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18511 * @brief Get the current image pixel width and height
18513 * @param obj The photocam object
18514 * @param w A pointer to the width return
18515 * @param h A pointer to the height return
18517 * This gets the current photo pixel width and height (for the original).
18518 * The size will be returned in the integers @p w and @p h that are pointed
18521 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18523 * @brief Get the area of the image that is currently shown
18526 * @param x A pointer to the X-coordinate of region
18527 * @param y A pointer to the Y-coordinate of region
18528 * @param w A pointer to the width
18529 * @param h A pointer to the height
18531 * @see elm_photocam_image_region_show()
18532 * @see elm_photocam_image_region_bring_in()
18534 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18536 * @brief Set the viewed portion of the image
18538 * @param obj The photocam object
18539 * @param x X-coordinate of region in image original pixels
18540 * @param y Y-coordinate of region in image original pixels
18541 * @param w Width of region in image original pixels
18542 * @param h Height of region in image original pixels
18544 * This shows the region of the image without using animation.
18546 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18548 * @brief Bring in the viewed portion of the image
18550 * @param obj The photocam object
18551 * @param x X-coordinate of region in image original pixels
18552 * @param y Y-coordinate of region in image original pixels
18553 * @param w Width of region in image original pixels
18554 * @param h Height of region in image original pixels
18556 * This shows the region of the image using animation.
18558 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18560 * @brief Set the paused state for photocam
18562 * @param obj The photocam object
18563 * @param paused The pause state to set
18565 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18566 * photocam. The default is off. This will stop zooming using animation on
18567 * zoom levels changes and change instantly. This will stop any existing
18568 * animations that are running.
18570 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18572 * @brief Get the paused state for photocam
18574 * @param obj The photocam object
18575 * @return The current paused state
18577 * This gets the current paused state for the photocam object.
18579 * @see elm_photocam_paused_set()
18581 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18583 * @brief Get the internal low-res image used for photocam
18585 * @param obj The photocam object
18586 * @return The internal image object handle, or NULL if none exists
18588 * This gets the internal image object inside photocam. Do not modify it. It
18589 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18590 * deleted at any time as well.
18592 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18594 * @brief Set the photocam scrolling bouncing.
18596 * @param obj The photocam object
18597 * @param h_bounce bouncing for horizontal
18598 * @param v_bounce bouncing for vertical
18600 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18602 * @brief Get the photocam scrolling bouncing.
18604 * @param obj The photocam object
18605 * @param h_bounce bouncing for horizontal
18606 * @param v_bounce bouncing for vertical
18608 * @see elm_photocam_bounce_set()
18610 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18616 * @defgroup Map Map
18617 * @ingroup Elementary
18619 * @image html img/widget/map/preview-00.png
18620 * @image latex img/widget/map/preview-00.eps
18622 * This is a widget specifically for displaying a map. It uses basically
18623 * OpenStreetMap provider http://www.openstreetmap.org/,
18624 * but custom providers can be added.
18626 * It supports some basic but yet nice features:
18627 * @li zoom and scroll
18628 * @li markers with content to be displayed when user clicks over it
18629 * @li group of markers
18632 * Smart callbacks one can listen to:
18634 * - "clicked" - This is called when a user has clicked the map without
18636 * - "press" - This is called when a user has pressed down on the map.
18637 * - "longpressed" - This is called when a user has pressed down on the map
18638 * for a long time without dragging around.
18639 * - "clicked,double" - This is called when a user has double-clicked
18641 * - "load,detail" - Map detailed data load begins.
18642 * - "loaded,detail" - This is called when all currently visible parts of
18643 * the map are loaded.
18644 * - "zoom,start" - Zoom animation started.
18645 * - "zoom,stop" - Zoom animation stopped.
18646 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18647 * - "scroll" - the content has been scrolled (moved).
18648 * - "scroll,anim,start" - scrolling animation has started.
18649 * - "scroll,anim,stop" - scrolling animation has stopped.
18650 * - "scroll,drag,start" - dragging the contents around has started.
18651 * - "scroll,drag,stop" - dragging the contents around has stopped.
18652 * - "downloaded" - This is called when all currently required map images
18654 * - "route,load" - This is called when route request begins.
18655 * - "route,loaded" - This is called when route request ends.
18656 * - "name,load" - This is called when name request begins.
18657 * - "name,loaded- This is called when name request ends.
18659 * Available style for map widget:
18662 * Available style for markers:
18667 * Available style for marker bubble:
18670 * List of examples:
18671 * @li @ref map_example_01
18672 * @li @ref map_example_02
18673 * @li @ref map_example_03
18682 * @enum _Elm_Map_Zoom_Mode
18683 * @typedef Elm_Map_Zoom_Mode
18685 * Set map's zoom behavior. It can be set to manual or automatic.
18687 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18689 * Values <b> don't </b> work as bitmask, only one can be choosen.
18691 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18692 * than the scroller view.
18694 * @see elm_map_zoom_mode_set()
18695 * @see elm_map_zoom_mode_get()
18699 typedef enum _Elm_Map_Zoom_Mode
18701 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18702 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18703 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18704 ELM_MAP_ZOOM_MODE_LAST
18705 } Elm_Map_Zoom_Mode;
18708 * @enum _Elm_Map_Route_Sources
18709 * @typedef Elm_Map_Route_Sources
18711 * Set route service to be used. By default used source is
18712 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18714 * @see elm_map_route_source_set()
18715 * @see elm_map_route_source_get()
18719 typedef enum _Elm_Map_Route_Sources
18721 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18722 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. */
18723 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18724 ELM_MAP_ROUTE_SOURCE_LAST
18725 } Elm_Map_Route_Sources;
18727 typedef enum _Elm_Map_Name_Sources
18729 ELM_MAP_NAME_SOURCE_NOMINATIM,
18730 ELM_MAP_NAME_SOURCE_LAST
18731 } Elm_Map_Name_Sources;
18734 * @enum _Elm_Map_Route_Type
18735 * @typedef Elm_Map_Route_Type
18737 * Set type of transport used on route.
18739 * @see elm_map_route_add()
18743 typedef enum _Elm_Map_Route_Type
18745 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18746 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18747 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18748 ELM_MAP_ROUTE_TYPE_LAST
18749 } Elm_Map_Route_Type;
18752 * @enum _Elm_Map_Route_Method
18753 * @typedef Elm_Map_Route_Method
18755 * Set the routing method, what should be priorized, time or distance.
18757 * @see elm_map_route_add()
18761 typedef enum _Elm_Map_Route_Method
18763 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18764 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18765 ELM_MAP_ROUTE_METHOD_LAST
18766 } Elm_Map_Route_Method;
18768 typedef enum _Elm_Map_Name_Method
18770 ELM_MAP_NAME_METHOD_SEARCH,
18771 ELM_MAP_NAME_METHOD_REVERSE,
18772 ELM_MAP_NAME_METHOD_LAST
18773 } Elm_Map_Name_Method;
18775 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(). */
18776 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(). */
18777 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(). */
18778 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(). */
18779 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18780 typedef struct _Elm_Map_Track Elm_Map_Track;
18782 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. */
18783 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18784 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18785 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18787 typedef char *(*ElmMapModuleSourceFunc) (void);
18788 typedef int (*ElmMapModuleZoomMinFunc) (void);
18789 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18790 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18791 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18792 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18793 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18794 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18795 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18798 * Add a new map widget to the given parent Elementary (container) object.
18800 * @param parent The parent object.
18801 * @return a new map widget handle or @c NULL, on errors.
18803 * This function inserts a new map widget on the canvas.
18807 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18810 * Set the zoom level of the map.
18812 * @param obj The map object.
18813 * @param zoom The zoom level to set.
18815 * This sets the zoom level.
18817 * It will respect limits defined by elm_map_source_zoom_min_set() and
18818 * elm_map_source_zoom_max_set().
18820 * By default these values are 0 (world map) and 18 (maximum zoom).
18822 * This function should be used when zoom mode is set to
18823 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18824 * with elm_map_zoom_mode_set().
18826 * @see elm_map_zoom_mode_set().
18827 * @see elm_map_zoom_get().
18831 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18834 * Get the zoom level of the map.
18836 * @param obj The map object.
18837 * @return The current zoom level.
18839 * This returns the current zoom level of the map object.
18841 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18842 * (which is the default), the zoom level may be changed at any time by the
18843 * map object itself to account for map size and map viewport size.
18845 * @see elm_map_zoom_set() for details.
18849 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18852 * Set the zoom mode used by the map object.
18854 * @param obj The map object.
18855 * @param mode The zoom mode of the map, being it one of
18856 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18857 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18859 * This sets the zoom mode to manual or one of the automatic levels.
18860 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18861 * elm_map_zoom_set() and will stay at that level until changed by code
18862 * or until zoom mode is changed. This is the default mode.
18864 * The Automatic modes will allow the map object to automatically
18865 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18866 * adjust zoom so the map fits inside the scroll frame with no pixels
18867 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18868 * ensure no pixels within the frame are left unfilled. Do not forget that
18869 * the valid sizes are 2^zoom, consequently the map may be smaller than
18870 * the scroller view.
18872 * @see elm_map_zoom_set()
18876 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18879 * Get the zoom mode used by the map object.
18881 * @param obj The map object.
18882 * @return The zoom mode of the map, being it one of
18883 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18884 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18886 * This function returns the current zoom mode used by the map object.
18888 * @see elm_map_zoom_mode_set() for more details.
18892 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18895 * Get the current coordinates of the map.
18897 * @param obj The map object.
18898 * @param lon Pointer where to store longitude.
18899 * @param lat Pointer where to store latitude.
18901 * This gets the current center coordinates of the map object. It can be
18902 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18904 * @see elm_map_geo_region_bring_in()
18905 * @see elm_map_geo_region_show()
18909 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18912 * Animatedly bring in given coordinates to the center of the map.
18914 * @param obj The map object.
18915 * @param lon Longitude to center at.
18916 * @param lat Latitude to center at.
18918 * This causes map to jump to the given @p lat and @p lon coordinates
18919 * and show it (by scrolling) in the center of the viewport, if it is not
18920 * already centered. This will use animation to do so and take a period
18921 * of time to complete.
18923 * @see elm_map_geo_region_show() for a function to avoid animation.
18924 * @see elm_map_geo_region_get()
18928 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18931 * Show the given coordinates at the center of the map, @b immediately.
18933 * @param obj The map object.
18934 * @param lon Longitude to center at.
18935 * @param lat Latitude to center at.
18937 * This causes map to @b redraw its viewport's contents to the
18938 * region contining the given @p lat and @p lon, that will be moved to the
18939 * center of the map.
18941 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18942 * @see elm_map_geo_region_get()
18946 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18949 * Pause or unpause the map.
18951 * @param obj The map object.
18952 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18955 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18958 * The default is off.
18960 * This will stop zooming using animation, changing zoom levels will
18961 * change instantly. This will stop any existing animations that are running.
18963 * @see elm_map_paused_get()
18967 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18970 * Get a value whether map is paused or not.
18972 * @param obj The map object.
18973 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18974 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18976 * This gets the current paused state for the map object.
18978 * @see elm_map_paused_set() for details.
18982 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18985 * Set to show markers during zoom level changes or not.
18987 * @param obj The map object.
18988 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18991 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18994 * The default is off.
18996 * This will stop zooming using animation, changing zoom levels will
18997 * change instantly. This will stop any existing animations that are running.
18999 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
19002 * The default is off.
19004 * Enabling it will force the map to stop displaying the markers during
19005 * zoom level changes. Set to on if you have a large number of markers.
19007 * @see elm_map_paused_markers_get()
19011 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
19014 * Get a value whether markers will be displayed on zoom level changes or not
19016 * @param obj The map object.
19017 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
19018 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
19020 * This gets the current markers paused state for the map object.
19022 * @see elm_map_paused_markers_set() for details.
19026 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19029 * Get the information of downloading status.
19031 * @param obj The map object.
19032 * @param try_num Pointer where to store number of tiles being downloaded.
19033 * @param finish_num Pointer where to store number of tiles successfully
19036 * This gets the current downloading status for the map object, the number
19037 * of tiles being downloaded and the number of tiles already downloaded.
19041 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
19044 * Convert a pixel coordinate (x,y) into a geographic coordinate
19045 * (longitude, latitude).
19047 * @param obj The map object.
19048 * @param x the coordinate.
19049 * @param y the coordinate.
19050 * @param size the size in pixels of the map.
19051 * The map is a square and generally his size is : pow(2.0, zoom)*256.
19052 * @param lon Pointer where to store the longitude that correspond to x.
19053 * @param lat Pointer where to store the latitude that correspond to y.
19055 * @note Origin pixel point is the top left corner of the viewport.
19056 * Map zoom and size are taken on account.
19058 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
19062 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);
19065 * Convert a geographic coordinate (longitude, latitude) into a pixel
19066 * coordinate (x, y).
19068 * @param obj The map object.
19069 * @param lon the longitude.
19070 * @param lat the latitude.
19071 * @param size the size in pixels of the map. The map is a square
19072 * and generally his size is : pow(2.0, zoom)*256.
19073 * @param x Pointer where to store the horizontal pixel coordinate that
19074 * correspond to the longitude.
19075 * @param y Pointer where to store the vertical pixel coordinate that
19076 * correspond to the latitude.
19078 * @note Origin pixel point is the top left corner of the viewport.
19079 * Map zoom and size are taken on account.
19081 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
19085 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);
19088 * Convert a geographic coordinate (longitude, latitude) into a name
19091 * @param obj The map object.
19092 * @param lon the longitude.
19093 * @param lat the latitude.
19094 * @return name A #Elm_Map_Name handle for this coordinate.
19096 * To get the string for this address, elm_map_name_address_get()
19099 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
19103 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
19106 * Convert a name (address) into a geographic coordinate
19107 * (longitude, latitude).
19109 * @param obj The map object.
19110 * @param name The address.
19111 * @return name A #Elm_Map_Name handle for this address.
19113 * To get the longitude and latitude, elm_map_name_region_get()
19116 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
19120 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
19123 * Convert a pixel coordinate into a rotated pixel coordinate.
19125 * @param obj The map object.
19126 * @param x horizontal coordinate of the point to rotate.
19127 * @param y vertical coordinate of the point to rotate.
19128 * @param cx rotation's center horizontal position.
19129 * @param cy rotation's center vertical position.
19130 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
19131 * @param xx Pointer where to store rotated x.
19132 * @param yy Pointer where to store rotated y.
19136 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);
19139 * Add a new marker to the map object.
19141 * @param obj The map object.
19142 * @param lon The longitude of the marker.
19143 * @param lat The latitude of the marker.
19144 * @param clas The class, to use when marker @b isn't grouped to others.
19145 * @param clas_group The class group, to use when marker is grouped to others
19146 * @param data The data passed to the callbacks.
19148 * @return The created marker or @c NULL upon failure.
19150 * A marker will be created and shown in a specific point of the map, defined
19151 * by @p lon and @p lat.
19153 * It will be displayed using style defined by @p class when this marker
19154 * is displayed alone (not grouped). A new class can be created with
19155 * elm_map_marker_class_new().
19157 * If the marker is grouped to other markers, it will be displayed with
19158 * style defined by @p class_group. Markers with the same group are grouped
19159 * if they are close. A new group class can be created with
19160 * elm_map_marker_group_class_new().
19162 * Markers created with this method can be deleted with
19163 * elm_map_marker_remove().
19165 * A marker can have associated content to be displayed by a bubble,
19166 * when a user click over it, as well as an icon. These objects will
19167 * be fetch using class' callback functions.
19169 * @see elm_map_marker_class_new()
19170 * @see elm_map_marker_group_class_new()
19171 * @see elm_map_marker_remove()
19175 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);
19178 * Set the maximum numbers of markers' content to be displayed in a group.
19180 * @param obj The map object.
19181 * @param max The maximum numbers of items displayed in a bubble.
19183 * A bubble will be displayed when the user clicks over the group,
19184 * and will place the content of markers that belong to this group
19187 * A group can have a long list of markers, consequently the creation
19188 * of the content of the bubble can be very slow.
19190 * In order to avoid this, a maximum number of items is displayed
19193 * By default this number is 30.
19195 * Marker with the same group class are grouped if they are close.
19197 * @see elm_map_marker_add()
19201 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
19204 * Remove a marker from the map.
19206 * @param marker The marker to remove.
19208 * @see elm_map_marker_add()
19212 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19215 * Get the current coordinates of the marker.
19217 * @param marker marker.
19218 * @param lat Pointer where to store the marker's latitude.
19219 * @param lon Pointer where to store the marker's longitude.
19221 * These values are set when adding markers, with function
19222 * elm_map_marker_add().
19224 * @see elm_map_marker_add()
19228 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19231 * Animatedly bring in given marker to the center of the map.
19233 * @param marker The marker to center at.
19235 * This causes map to jump to the given @p marker's coordinates
19236 * and show it (by scrolling) in the center of the viewport, if it is not
19237 * already centered. This will use animation to do so and take a period
19238 * of time to complete.
19240 * @see elm_map_marker_show() for a function to avoid animation.
19241 * @see elm_map_marker_region_get()
19245 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19248 * Show the given marker at the center of the map, @b immediately.
19250 * @param marker The marker to center at.
19252 * This causes map to @b redraw its viewport's contents to the
19253 * region contining the given @p marker's coordinates, that will be
19254 * moved to the center of the map.
19256 * @see elm_map_marker_bring_in() for a function to move with animation.
19257 * @see elm_map_markers_list_show() if more than one marker need to be
19259 * @see elm_map_marker_region_get()
19263 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19266 * Move and zoom the map to display a list of markers.
19268 * @param markers A list of #Elm_Map_Marker handles.
19270 * The map will be centered on the center point of the markers in the list.
19271 * Then the map will be zoomed in order to fit the markers using the maximum
19272 * zoom which allows display of all the markers.
19274 * @warning All the markers should belong to the same map object.
19276 * @see elm_map_marker_show() to show a single marker.
19277 * @see elm_map_marker_bring_in()
19281 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19284 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19286 * @param marker The marker wich content should be returned.
19287 * @return Return the evas object if it exists, else @c NULL.
19289 * To set callback function #ElmMapMarkerGetFunc for the marker class,
19290 * elm_map_marker_class_get_cb_set() should be used.
19292 * This content is what will be inside the bubble that will be displayed
19293 * when an user clicks over the marker.
19295 * This returns the actual Evas object used to be placed inside
19296 * the bubble. This may be @c NULL, as it may
19297 * not have been created or may have been deleted, at any time, by
19298 * the map. <b>Do not modify this object</b> (move, resize,
19299 * show, hide, etc.), as the map is controlling it. This
19300 * function is for querying, emitting custom signals or hooking
19301 * lower level callbacks for events on that object. Do not delete
19302 * this object under any circumstances.
19306 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19309 * Update the marker
19311 * @param marker The marker to be updated.
19313 * If a content is set to this marker, it will call function to delete it,
19314 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19315 * #ElmMapMarkerGetFunc.
19317 * These functions are set for the marker class with
19318 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19322 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19325 * Close all the bubbles opened by the user.
19327 * @param obj The map object.
19329 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19330 * when the user clicks on a marker.
19332 * This functions is set for the marker class with
19333 * elm_map_marker_class_get_cb_set().
19337 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19340 * Create a new group class.
19342 * @param obj The map object.
19343 * @return Returns the new group class.
19345 * Each marker must be associated to a group class. Markers in the same
19346 * group are grouped if they are close.
19348 * The group class defines the style of the marker when a marker is grouped
19349 * to others markers. When it is alone, another class will be used.
19351 * A group class will need to be provided when creating a marker with
19352 * elm_map_marker_add().
19354 * Some properties and functions can be set by class, as:
19355 * - style, with elm_map_group_class_style_set()
19356 * - data - to be associated to the group class. It can be set using
19357 * elm_map_group_class_data_set().
19358 * - min zoom to display markers, set with
19359 * elm_map_group_class_zoom_displayed_set().
19360 * - max zoom to group markers, set using
19361 * elm_map_group_class_zoom_grouped_set().
19362 * - visibility - set if markers will be visible or not, set with
19363 * elm_map_group_class_hide_set().
19364 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19365 * It can be set using elm_map_group_class_icon_cb_set().
19367 * @see elm_map_marker_add()
19368 * @see elm_map_group_class_style_set()
19369 * @see elm_map_group_class_data_set()
19370 * @see elm_map_group_class_zoom_displayed_set()
19371 * @see elm_map_group_class_zoom_grouped_set()
19372 * @see elm_map_group_class_hide_set()
19373 * @see elm_map_group_class_icon_cb_set()
19377 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19380 * Set the marker's style of a group class.
19382 * @param clas The group class.
19383 * @param style The style to be used by markers.
19385 * Each marker must be associated to a group class, and will use the style
19386 * defined by such class when grouped to other markers.
19388 * The following styles are provided by default theme:
19389 * @li @c radio - blue circle
19390 * @li @c radio2 - green circle
19393 * @see elm_map_group_class_new() for more details.
19394 * @see elm_map_marker_add()
19398 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19401 * Set the icon callback function of a group class.
19403 * @param clas The group class.
19404 * @param icon_get The callback function that will return the icon.
19406 * Each marker must be associated to a group class, and it can display a
19407 * custom icon. The function @p icon_get must return this icon.
19409 * @see elm_map_group_class_new() for more details.
19410 * @see elm_map_marker_add()
19414 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19417 * Set the data associated to the group class.
19419 * @param clas The group class.
19420 * @param data The new user data.
19422 * This data will be passed for callback functions, like icon get callback,
19423 * that can be set with elm_map_group_class_icon_cb_set().
19425 * If a data was previously set, the object will lose the pointer for it,
19426 * so if needs to be freed, you must do it yourself.
19428 * @see elm_map_group_class_new() for more details.
19429 * @see elm_map_group_class_icon_cb_set()
19430 * @see elm_map_marker_add()
19434 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19437 * Set the minimum zoom from where the markers are displayed.
19439 * @param clas The group class.
19440 * @param zoom The minimum zoom.
19442 * Markers only will be displayed when the map is displayed at @p zoom
19445 * @see elm_map_group_class_new() for more details.
19446 * @see elm_map_marker_add()
19450 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19453 * Set the zoom from where the markers are no more grouped.
19455 * @param clas The group class.
19456 * @param zoom The maximum zoom.
19458 * Markers only will be grouped when the map is displayed at
19459 * less than @p zoom.
19461 * @see elm_map_group_class_new() for more details.
19462 * @see elm_map_marker_add()
19466 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19469 * Set if the markers associated to the group class @clas are hidden or not.
19471 * @param clas The group class.
19472 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19475 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19480 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19483 * Create a new marker class.
19485 * @param obj The map object.
19486 * @return Returns the new group class.
19488 * Each marker must be associated to a class.
19490 * The marker class defines the style of the marker when a marker is
19491 * displayed alone, i.e., not grouped to to others markers. When grouped
19492 * it will use group class style.
19494 * A marker class will need to be provided when creating a marker with
19495 * elm_map_marker_add().
19497 * Some properties and functions can be set by class, as:
19498 * - style, with elm_map_marker_class_style_set()
19499 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19500 * It can be set using elm_map_marker_class_icon_cb_set().
19501 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19502 * Set using elm_map_marker_class_get_cb_set().
19503 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19504 * Set using elm_map_marker_class_del_cb_set().
19506 * @see elm_map_marker_add()
19507 * @see elm_map_marker_class_style_set()
19508 * @see elm_map_marker_class_icon_cb_set()
19509 * @see elm_map_marker_class_get_cb_set()
19510 * @see elm_map_marker_class_del_cb_set()
19514 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19517 * Set the marker's style of a marker class.
19519 * @param clas The marker class.
19520 * @param style The style to be used by markers.
19522 * Each marker must be associated to a marker class, and will use the style
19523 * defined by such class when alone, i.e., @b not grouped to other markers.
19525 * The following styles are provided by default theme:
19530 * @see elm_map_marker_class_new() for more details.
19531 * @see elm_map_marker_add()
19535 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19538 * Set the icon callback function of a marker class.
19540 * @param clas The marker class.
19541 * @param icon_get The callback function that will return the icon.
19543 * Each marker must be associated to a marker class, and it can display a
19544 * custom icon. The function @p icon_get must return this icon.
19546 * @see elm_map_marker_class_new() for more details.
19547 * @see elm_map_marker_add()
19551 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19554 * Set the bubble content callback function of a marker class.
19556 * @param clas The marker class.
19557 * @param get The callback function that will return the content.
19559 * Each marker must be associated to a marker class, and it can display a
19560 * a content on a bubble that opens when the user click over the marker.
19561 * The function @p get must return this content object.
19563 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19566 * @see elm_map_marker_class_new() for more details.
19567 * @see elm_map_marker_class_del_cb_set()
19568 * @see elm_map_marker_add()
19572 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19575 * Set the callback function used to delete bubble content of a marker class.
19577 * @param clas The marker class.
19578 * @param del The callback function that will delete the content.
19580 * Each marker must be associated to a marker class, and it can display a
19581 * a content on a bubble that opens when the user click over the marker.
19582 * The function to return such content can be set with
19583 * elm_map_marker_class_get_cb_set().
19585 * If this content must be freed, a callback function need to be
19586 * set for that task with this function.
19588 * If this callback is defined it will have to delete (or not) the
19589 * object inside, but if the callback is not defined the object will be
19590 * destroyed with evas_object_del().
19592 * @see elm_map_marker_class_new() for more details.
19593 * @see elm_map_marker_class_get_cb_set()
19594 * @see elm_map_marker_add()
19598 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19601 * Get the list of available sources.
19603 * @param obj The map object.
19604 * @return The source names list.
19606 * It will provide a list with all available sources, that can be set as
19607 * current source with elm_map_source_name_set(), or get with
19608 * elm_map_source_name_get().
19610 * Available sources:
19616 * @see elm_map_source_name_set() for more details.
19617 * @see elm_map_source_name_get()
19621 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19624 * Set the source of the map.
19626 * @param obj The map object.
19627 * @param source The source to be used.
19629 * Map widget retrieves images that composes the map from a web service.
19630 * This web service can be set with this method.
19632 * A different service can return a different maps with different
19633 * information and it can use different zoom values.
19635 * The @p source_name need to match one of the names provided by
19636 * elm_map_source_names_get().
19638 * The current source can be get using elm_map_source_name_get().
19640 * @see elm_map_source_names_get()
19641 * @see elm_map_source_name_get()
19646 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19649 * Get the name of currently used source.
19651 * @param obj The map object.
19652 * @return Returns the name of the source in use.
19654 * @see elm_map_source_name_set() for more details.
19658 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19661 * Set the source of the route service to be used by the map.
19663 * @param obj The map object.
19664 * @param source The route service to be used, being it one of
19665 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19666 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19668 * Each one has its own algorithm, so the route retrieved may
19669 * differ depending on the source route. Now, only the default is working.
19671 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19672 * http://www.yournavigation.org/.
19674 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19675 * assumptions. Its routing core is based on Contraction Hierarchies.
19677 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19679 * @see elm_map_route_source_get().
19683 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19686 * Get the current route source.
19688 * @param obj The map object.
19689 * @return The source of the route service used by the map.
19691 * @see elm_map_route_source_set() for details.
19695 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19698 * Set the minimum zoom of the source.
19700 * @param obj The map object.
19701 * @param zoom New minimum zoom value to be used.
19703 * By default, it's 0.
19707 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19710 * Get the minimum zoom of the source.
19712 * @param obj The map object.
19713 * @return Returns the minimum zoom of the source.
19715 * @see elm_map_source_zoom_min_set() for details.
19719 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19722 * Set the maximum zoom of the source.
19724 * @param obj The map object.
19725 * @param zoom New maximum zoom value to be used.
19727 * By default, it's 18.
19731 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19734 * Get the maximum zoom of the source.
19736 * @param obj The map object.
19737 * @return Returns the maximum zoom of the source.
19739 * @see elm_map_source_zoom_min_set() for details.
19743 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19746 * Set the user agent used by the map object to access routing services.
19748 * @param obj The map object.
19749 * @param user_agent The user agent to be used by the map.
19751 * User agent is a client application implementing a network protocol used
19752 * in communications within a client–server distributed computing system
19754 * The @p user_agent identification string will transmitted in a header
19755 * field @c User-Agent.
19757 * @see elm_map_user_agent_get()
19761 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19764 * Get the user agent used by the map object.
19766 * @param obj The map object.
19767 * @return The user agent identification string used by the map.
19769 * @see elm_map_user_agent_set() for details.
19773 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19776 * Add a new route to the map object.
19778 * @param obj The map object.
19779 * @param type The type of transport to be considered when tracing a route.
19780 * @param method The routing method, what should be priorized.
19781 * @param flon The start longitude.
19782 * @param flat The start latitude.
19783 * @param tlon The destination longitude.
19784 * @param tlat The destination latitude.
19786 * @return The created route or @c NULL upon failure.
19788 * A route will be traced by point on coordinates (@p flat, @p flon)
19789 * to point on coordinates (@p tlat, @p tlon), using the route service
19790 * set with elm_map_route_source_set().
19792 * It will take @p type on consideration to define the route,
19793 * depending if the user will be walking or driving, the route may vary.
19794 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19795 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19797 * Another parameter is what the route should priorize, the minor distance
19798 * or the less time to be spend on the route. So @p method should be one
19799 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19801 * Routes created with this method can be deleted with
19802 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19803 * and distance can be get with elm_map_route_distance_get().
19805 * @see elm_map_route_remove()
19806 * @see elm_map_route_color_set()
19807 * @see elm_map_route_distance_get()
19808 * @see elm_map_route_source_set()
19812 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);
19815 * Remove a route from the map.
19817 * @param route The route to remove.
19819 * @see elm_map_route_add()
19823 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19826 * Set the route color.
19828 * @param route The route object.
19829 * @param r Red channel value, from 0 to 255.
19830 * @param g Green channel value, from 0 to 255.
19831 * @param b Blue channel value, from 0 to 255.
19832 * @param a Alpha channel value, from 0 to 255.
19834 * It uses an additive color model, so each color channel represents
19835 * how much of each primary colors must to be used. 0 represents
19836 * ausence of this color, so if all of the three are set to 0,
19837 * the color will be black.
19839 * These component values should be integers in the range 0 to 255,
19840 * (single 8-bit byte).
19842 * This sets the color used for the route. By default, it is set to
19843 * solid red (r = 255, g = 0, b = 0, a = 255).
19845 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19847 * @see elm_map_route_color_get()
19851 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19854 * Get the route color.
19856 * @param route The route object.
19857 * @param r Pointer where to store the red channel value.
19858 * @param g Pointer where to store the green channel value.
19859 * @param b Pointer where to store the blue channel value.
19860 * @param a Pointer where to store the alpha channel value.
19862 * @see elm_map_route_color_set() for details.
19866 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19869 * Get the route distance in kilometers.
19871 * @param route The route object.
19872 * @return The distance of route (unit : km).
19876 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19879 * Get the information of route nodes.
19881 * @param route The route object.
19882 * @return Returns a string with the nodes of route.
19886 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19889 * Get the information of route waypoint.
19891 * @param route the route object.
19892 * @return Returns a string with information about waypoint of route.
19896 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19899 * Get the address of the name.
19901 * @param name The name handle.
19902 * @return Returns the address string of @p name.
19904 * This gets the coordinates of the @p name, created with one of the
19905 * conversion functions.
19907 * @see elm_map_utils_convert_name_into_coord()
19908 * @see elm_map_utils_convert_coord_into_name()
19912 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19915 * Get the current coordinates of the name.
19917 * @param name The name handle.
19918 * @param lat Pointer where to store the latitude.
19919 * @param lon Pointer where to store The longitude.
19921 * This gets the coordinates of the @p name, created with one of the
19922 * conversion functions.
19924 * @see elm_map_utils_convert_name_into_coord()
19925 * @see elm_map_utils_convert_coord_into_name()
19929 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19932 * Remove a name from the map.
19934 * @param name The name to remove.
19936 * Basically the struct handled by @p name will be freed, so convertions
19937 * between address and coordinates will be lost.
19939 * @see elm_map_utils_convert_name_into_coord()
19940 * @see elm_map_utils_convert_coord_into_name()
19944 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19949 * @param obj The map object.
19950 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19951 * @param cx Rotation's center horizontal position.
19952 * @param cy Rotation's center vertical position.
19954 * @see elm_map_rotate_get()
19958 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19961 * Get the rotate degree of the map
19963 * @param obj The map object
19964 * @param degree Pointer where to store degrees from 0.0 to 360.0
19965 * to rotate arount Z axis.
19966 * @param cx Pointer where to store rotation's center horizontal position.
19967 * @param cy Pointer where to store rotation's center vertical position.
19969 * @see elm_map_rotate_set() to set map rotation.
19973 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);
19976 * Enable or disable mouse wheel to be used to zoom in / out the map.
19978 * @param obj The map object.
19979 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19982 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19984 * It's disabled by default.
19986 * @see elm_map_wheel_disabled_get()
19990 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19993 * Get a value whether mouse wheel is enabled or not.
19995 * @param obj The map object.
19996 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19997 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19999 * Mouse wheel can be used for the user to zoom in or zoom out the map.
20001 * @see elm_map_wheel_disabled_set() for details.
20005 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20009 * Add a track on the map
20011 * @param obj The map object.
20012 * @param emap The emap route object.
20013 * @return The route object. This is an elm object of type Route.
20015 * @see elm_route_add() for details.
20019 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
20023 * Remove a track from the map
20025 * @param obj The map object.
20026 * @param route The track to remove.
20030 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
20037 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
20039 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
20041 EAPI double elm_route_lon_min_get(Evas_Object *obj);
20042 EAPI double elm_route_lat_min_get(Evas_Object *obj);
20043 EAPI double elm_route_lon_max_get(Evas_Object *obj);
20044 EAPI double elm_route_lat_max_get(Evas_Object *obj);
20048 * @defgroup Panel Panel
20050 * @image html img/widget/panel/preview-00.png
20051 * @image latex img/widget/panel/preview-00.eps
20053 * @brief A panel is a type of animated container that contains subobjects.
20054 * It can be expanded or contracted by clicking the button on it's edge.
20056 * Orientations are as follows:
20057 * @li ELM_PANEL_ORIENT_TOP
20058 * @li ELM_PANEL_ORIENT_LEFT
20059 * @li ELM_PANEL_ORIENT_RIGHT
20061 * @ref tutorial_panel shows one way to use this widget.
20064 typedef enum _Elm_Panel_Orient
20066 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
20067 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
20068 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
20069 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
20070 } Elm_Panel_Orient;
20072 * @brief Adds a panel object
20074 * @param parent The parent object
20076 * @return The panel object, or NULL on failure
20078 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20080 * @brief Sets the orientation of the panel
20082 * @param parent The parent object
20083 * @param orient The panel orientation. Can be one of the following:
20084 * @li ELM_PANEL_ORIENT_TOP
20085 * @li ELM_PANEL_ORIENT_LEFT
20086 * @li ELM_PANEL_ORIENT_RIGHT
20088 * Sets from where the panel will (dis)appear.
20090 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
20092 * @brief Get the orientation of the panel.
20094 * @param obj The panel object
20095 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
20097 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20099 * @brief Set the content of the panel.
20101 * @param obj The panel object
20102 * @param content The panel content
20104 * Once the content object is set, a previously set one will be deleted.
20105 * If you want to keep that old content object, use the
20106 * elm_panel_content_unset() function.
20108 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20110 * @brief Get the content of the panel.
20112 * @param obj The panel object
20113 * @return The content that is being used
20115 * Return the content object which is set for this widget.
20117 * @see elm_panel_content_set()
20119 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20121 * @brief Unset the content of the panel.
20123 * @param obj The panel object
20124 * @return The content that was being used
20126 * Unparent and return the content object which was set for this widget.
20128 * @see elm_panel_content_set()
20130 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20132 * @brief Set the state of the panel.
20134 * @param obj The panel object
20135 * @param hidden If true, the panel will run the animation to contract
20137 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
20139 * @brief Get the state of the panel.
20141 * @param obj The panel object
20142 * @param hidden If true, the panel is in the "hide" state
20144 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20146 * @brief Toggle the hidden state of the panel from code
20148 * @param obj The panel object
20150 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
20156 * @defgroup Panes Panes
20157 * @ingroup Elementary
20159 * @image html img/widget/panes/preview-00.png
20160 * @image latex img/widget/panes/preview-00.eps width=\textwidth
20162 * @image html img/panes.png
20163 * @image latex img/panes.eps width=\textwidth
20165 * The panes adds a dragable bar between two contents. When dragged
20166 * this bar will resize contents size.
20168 * Panes can be displayed vertically or horizontally, and contents
20169 * size proportion can be customized (homogeneous by default).
20171 * Smart callbacks one can listen to:
20172 * - "press" - The panes has been pressed (button wasn't released yet).
20173 * - "unpressed" - The panes was released after being pressed.
20174 * - "clicked" - The panes has been clicked>
20175 * - "clicked,double" - The panes has been double clicked
20177 * Available styles for it:
20180 * Here is an example on its usage:
20181 * @li @ref panes_example
20185 * @addtogroup Panes
20190 * Add a new panes widget to the given parent Elementary
20191 * (container) object.
20193 * @param parent The parent object.
20194 * @return a new panes widget handle or @c NULL, on errors.
20196 * This function inserts a new panes widget on the canvas.
20200 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20203 * Set the left content of the panes widget.
20205 * @param obj The panes object.
20206 * @param content The new left content object.
20208 * Once the content object is set, a previously set one will be deleted.
20209 * If you want to keep that old content object, use the
20210 * elm_panes_content_left_unset() function.
20212 * If panes is displayed vertically, left content will be displayed at
20215 * @see elm_panes_content_left_get()
20216 * @see elm_panes_content_right_set() to set content on the other side.
20220 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20223 * Set the right content of the panes widget.
20225 * @param obj The panes object.
20226 * @param content The new right content object.
20228 * Once the content object is set, a previously set one will be deleted.
20229 * If you want to keep that old content object, use the
20230 * elm_panes_content_right_unset() function.
20232 * If panes is displayed vertically, left content will be displayed at
20235 * @see elm_panes_content_right_get()
20236 * @see elm_panes_content_left_set() to set content on the other side.
20240 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20243 * Get the left content of the panes.
20245 * @param obj The panes object.
20246 * @return The left content object that is being used.
20248 * Return the left content object which is set for this widget.
20250 * @see elm_panes_content_left_set() for details.
20254 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20257 * Get the right content of the panes.
20259 * @param obj The panes object
20260 * @return The right content object that is being used
20262 * Return the right content object which is set for this widget.
20264 * @see elm_panes_content_right_set() for details.
20268 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20271 * Unset the left content used for the panes.
20273 * @param obj The panes object.
20274 * @return The left content object that was being used.
20276 * Unparent and return the left content object which was set for this widget.
20278 * @see elm_panes_content_left_set() for details.
20279 * @see elm_panes_content_left_get().
20283 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20286 * Unset the right content used for the panes.
20288 * @param obj The panes object.
20289 * @return The right content object that was being used.
20291 * Unparent and return the right content object which was set for this
20294 * @see elm_panes_content_right_set() for details.
20295 * @see elm_panes_content_right_get().
20299 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20302 * Get the size proportion of panes widget's left side.
20304 * @param obj The panes object.
20305 * @return float value between 0.0 and 1.0 representing size proportion
20308 * @see elm_panes_content_left_size_set() for more details.
20312 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20315 * Set the size proportion of panes widget's left side.
20317 * @param obj The panes object.
20318 * @param size Value between 0.0 and 1.0 representing size proportion
20321 * By default it's homogeneous, i.e., both sides have the same size.
20323 * If something different is required, it can be set with this function.
20324 * For example, if the left content should be displayed over
20325 * 75% of the panes size, @p size should be passed as @c 0.75.
20326 * This way, right content will be resized to 25% of panes size.
20328 * If displayed vertically, left content is displayed at top, and
20329 * right content at bottom.
20331 * @note This proportion will change when user drags the panes bar.
20333 * @see elm_panes_content_left_size_get()
20337 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20340 * Set the orientation of a given panes widget.
20342 * @param obj The panes object.
20343 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20344 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20346 * Use this function to change how your panes is to be
20347 * disposed: vertically or horizontally.
20349 * By default it's displayed horizontally.
20351 * @see elm_panes_horizontal_get()
20355 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20358 * Retrieve the orientation of a given panes widget.
20360 * @param obj The panes object.
20361 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20362 * @c EINA_FALSE if it's @b vertical (and on errors).
20364 * @see elm_panes_horizontal_set() for more details.
20368 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20375 * @defgroup Flip Flip
20377 * @image html img/widget/flip/preview-00.png
20378 * @image latex img/widget/flip/preview-00.eps
20380 * This widget holds 2 content objects(Evas_Object): one on the front and one
20381 * on the back. It allows you to flip from front to back and vice-versa using
20382 * various animations.
20384 * If either the front or back contents are not set the flip will treat that
20385 * as transparent. So if you wore to set the front content but not the back,
20386 * and then call elm_flip_go() you would see whatever is below the flip.
20388 * For a list of supported animations see elm_flip_go().
20390 * Signals that you can add callbacks for are:
20391 * "animate,begin" - when a flip animation was started
20392 * "animate,done" - when a flip animation is finished
20394 * @ref tutorial_flip show how to use most of the API.
20398 typedef enum _Elm_Flip_Mode
20400 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20401 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20402 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20403 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20404 ELM_FLIP_CUBE_LEFT,
20405 ELM_FLIP_CUBE_RIGHT,
20407 ELM_FLIP_CUBE_DOWN,
20408 ELM_FLIP_PAGE_LEFT,
20409 ELM_FLIP_PAGE_RIGHT,
20413 typedef enum _Elm_Flip_Interaction
20415 ELM_FLIP_INTERACTION_NONE,
20416 ELM_FLIP_INTERACTION_ROTATE,
20417 ELM_FLIP_INTERACTION_CUBE,
20418 ELM_FLIP_INTERACTION_PAGE
20419 } Elm_Flip_Interaction;
20420 typedef enum _Elm_Flip_Direction
20422 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20423 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20424 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20425 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20426 } Elm_Flip_Direction;
20428 * @brief Add a new flip to the parent
20430 * @param parent The parent object
20431 * @return The new object or NULL if it cannot be created
20433 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20435 * @brief Set the front content of the flip widget.
20437 * @param obj The flip object
20438 * @param content The new front content object
20440 * Once the content object is set, a previously set one will be deleted.
20441 * If you want to keep that old content object, use the
20442 * elm_flip_content_front_unset() function.
20444 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20446 * @brief Set the back content of the flip widget.
20448 * @param obj The flip object
20449 * @param content The new back content object
20451 * Once the content object is set, a previously set one will be deleted.
20452 * If you want to keep that old content object, use the
20453 * elm_flip_content_back_unset() function.
20455 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20457 * @brief Get the front content used for the flip
20459 * @param obj The flip object
20460 * @return The front content object that is being used
20462 * Return the front content object which is set for this widget.
20464 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20466 * @brief Get the back content used for the flip
20468 * @param obj The flip object
20469 * @return The back content object that is being used
20471 * Return the back content object which is set for this widget.
20473 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20475 * @brief Unset the front content used for the flip
20477 * @param obj The flip object
20478 * @return The front content object that was being used
20480 * Unparent and return the front content object which was set for this widget.
20482 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20484 * @brief Unset the back content used for the flip
20486 * @param obj The flip object
20487 * @return The back content object that was being used
20489 * Unparent and return the back content object which was set for this widget.
20491 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20493 * @brief Get flip front visibility state
20495 * @param obj The flip objct
20496 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20499 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20501 * @brief Set flip perspective
20503 * @param obj The flip object
20504 * @param foc The coordinate to set the focus on
20505 * @param x The X coordinate
20506 * @param y The Y coordinate
20508 * @warning This function currently does nothing.
20510 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20512 * @brief Runs the flip animation
20514 * @param obj The flip object
20515 * @param mode The mode type
20517 * Flips the front and back contents using the @p mode animation. This
20518 * efectively hides the currently visible content and shows the hidden one.
20520 * There a number of possible animations to use for the flipping:
20521 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20522 * around a horizontal axis in the middle of its height, the other content
20523 * is shown as the other side of the flip.
20524 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20525 * around a vertical axis in the middle of its width, the other content is
20526 * shown as the other side of the flip.
20527 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20528 * around a diagonal axis in the middle of its width, the other content is
20529 * shown as the other side of the flip.
20530 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20531 * around a diagonal axis in the middle of its height, the other content is
20532 * shown as the other side of the flip.
20533 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20534 * as if the flip was a cube, the other content is show as the right face of
20536 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20537 * right as if the flip was a cube, the other content is show as the left
20538 * face of the cube.
20539 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20540 * flip was a cube, the other content is show as the bottom face of the cube.
20541 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20542 * the flip was a cube, the other content is show as the upper face of the
20544 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20545 * if the flip was a book, the other content is shown as the page below that.
20546 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20547 * as if the flip was a book, the other content is shown as the page below
20549 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20550 * flip was a book, the other content is shown as the page below that.
20551 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20552 * flip was a book, the other content is shown as the page below that.
20554 * @image html elm_flip.png
20555 * @image latex elm_flip.eps width=\textwidth
20557 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20559 * @brief Set the interactive flip mode
20561 * @param obj The flip object
20562 * @param mode The interactive flip mode to use
20564 * This sets if the flip should be interactive (allow user to click and
20565 * drag a side of the flip to reveal the back page and cause it to flip).
20566 * By default a flip is not interactive. You may also need to set which
20567 * sides of the flip are "active" for flipping and how much space they use
20568 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20569 * and elm_flip_interacton_direction_hitsize_set()
20571 * The four avilable mode of interaction are:
20572 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20573 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20574 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20575 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20577 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20578 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20579 * happen, those can only be acheived with elm_flip_go();
20581 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20583 * @brief Get the interactive flip mode
20585 * @param obj The flip object
20586 * @return The interactive flip mode
20588 * Returns the interactive flip mode set by elm_flip_interaction_set()
20590 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20592 * @brief Set which directions of the flip respond to interactive flip
20594 * @param obj The flip object
20595 * @param dir The direction to change
20596 * @param enabled If that direction is enabled or not
20598 * By default all directions are disabled, so you may want to enable the
20599 * desired directions for flipping if you need interactive flipping. You must
20600 * call this function once for each direction that should be enabled.
20602 * @see elm_flip_interaction_set()
20604 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20606 * @brief Get the enabled state of that flip direction
20608 * @param obj The flip object
20609 * @param dir The direction to check
20610 * @return If that direction is enabled or not
20612 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20614 * @see elm_flip_interaction_set()
20616 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20618 * @brief Set the amount of the flip that is sensitive to interactive flip
20620 * @param obj The flip object
20621 * @param dir The direction to modify
20622 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20624 * Set the amount of the flip that is sensitive to interactive flip, with 0
20625 * representing no area in the flip and 1 representing the entire flip. There
20626 * is however a consideration to be made in that the area will never be
20627 * smaller than the finger size set(as set in your Elementary configuration).
20629 * @see elm_flip_interaction_set()
20631 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20633 * @brief Get the amount of the flip that is sensitive to interactive flip
20635 * @param obj The flip object
20636 * @param dir The direction to check
20637 * @return The size set for that direction
20639 * Returns the amount os sensitive area set by
20640 * elm_flip_interacton_direction_hitsize_set().
20642 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20647 /* scrolledentry */
20648 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20649 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20650 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20651 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20652 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20653 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20654 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20655 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20656 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20657 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20658 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20659 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20660 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20661 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20662 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20663 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20664 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20665 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20666 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20667 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20668 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20669 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20670 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20671 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20672 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20673 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20674 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20675 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20676 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20677 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20678 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20679 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20680 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20681 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20682 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20683 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);
20684 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20685 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20686 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);
20687 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20688 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);
20689 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20690 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20691 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20692 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20693 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20694 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20695 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20696 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20697 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);
20698 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);
20699 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);
20700 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);
20701 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);
20702 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);
20703 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20704 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20705 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20706 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20707 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20708 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20709 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20712 * @defgroup Conformant Conformant
20713 * @ingroup Elementary
20715 * @image html img/widget/conformant/preview-00.png
20716 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20718 * @image html img/conformant.png
20719 * @image latex img/conformant.eps width=\textwidth
20721 * The aim is to provide a widget that can be used in elementary apps to
20722 * account for space taken up by the indicator, virtual keypad & softkey
20723 * windows when running the illume2 module of E17.
20725 * So conformant content will be sized and positioned considering the
20726 * space required for such stuff, and when they popup, as a keyboard
20727 * shows when an entry is selected, conformant content won't change.
20729 * Available styles for it:
20732 * See how to use this widget in this example:
20733 * @ref conformant_example
20737 * @addtogroup Conformant
20742 * Add a new conformant widget to the given parent Elementary
20743 * (container) object.
20745 * @param parent The parent object.
20746 * @return A new conformant widget handle or @c NULL, on errors.
20748 * This function inserts a new conformant widget on the canvas.
20750 * @ingroup Conformant
20752 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20755 * Set the content of the conformant widget.
20757 * @param obj The conformant object.
20758 * @param content The content to be displayed by the conformant.
20760 * Content will be sized and positioned considering the space required
20761 * to display a virtual keyboard. So it won't fill all the conformant
20762 * size. This way is possible to be sure that content won't resize
20763 * or be re-positioned after the keyboard is displayed.
20765 * Once the content object is set, a previously set one will be deleted.
20766 * If you want to keep that old content object, use the
20767 * elm_conformat_content_unset() function.
20769 * @see elm_conformant_content_unset()
20770 * @see elm_conformant_content_get()
20772 * @ingroup Conformant
20774 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20777 * Get the content of the conformant widget.
20779 * @param obj The conformant object.
20780 * @return The content that is being used.
20782 * Return the content object which is set for this widget.
20783 * It won't be unparent from conformant. For that, use
20784 * elm_conformant_content_unset().
20786 * @see elm_conformant_content_set() for more details.
20787 * @see elm_conformant_content_unset()
20789 * @ingroup Conformant
20791 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20794 * Unset the content of the conformant widget.
20796 * @param obj The conformant object.
20797 * @return The content that was being used.
20799 * Unparent and return the content object which was set for this widget.
20801 * @see elm_conformant_content_set() for more details.
20803 * @ingroup Conformant
20805 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20808 * Returns the Evas_Object that represents the content area.
20810 * @param obj The conformant object.
20811 * @return The content area of the widget.
20813 * @ingroup Conformant
20815 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20822 * @defgroup Mapbuf Mapbuf
20823 * @ingroup Elementary
20825 * @image html img/widget/mapbuf/preview-00.png
20826 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20828 * This holds one content object and uses an Evas Map of transformation
20829 * points to be later used with this content. So the content will be
20830 * moved, resized, etc as a single image. So it will improve performance
20831 * when you have a complex interafce, with a lot of elements, and will
20832 * need to resize or move it frequently (the content object and its
20835 * See how to use this widget in this example:
20836 * @ref mapbuf_example
20840 * @addtogroup Mapbuf
20845 * Add a new mapbuf widget to the given parent Elementary
20846 * (container) object.
20848 * @param parent The parent object.
20849 * @return A new mapbuf widget handle or @c NULL, on errors.
20851 * This function inserts a new mapbuf widget on the canvas.
20855 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20858 * Set the content of the mapbuf.
20860 * @param obj The mapbuf object.
20861 * @param content The content that will be filled in this mapbuf object.
20863 * Once the content object is set, a previously set one will be deleted.
20864 * If you want to keep that old content object, use the
20865 * elm_mapbuf_content_unset() function.
20867 * To enable map, elm_mapbuf_enabled_set() should be used.
20871 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20874 * Get the content of the mapbuf.
20876 * @param obj The mapbuf object.
20877 * @return The content that is being used.
20879 * Return the content object which is set for this widget.
20881 * @see elm_mapbuf_content_set() for details.
20885 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20888 * Unset the content of the mapbuf.
20890 * @param obj The mapbuf object.
20891 * @return The content that was being used.
20893 * Unparent and return the content object which was set for this widget.
20895 * @see elm_mapbuf_content_set() for details.
20899 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20902 * Enable or disable the map.
20904 * @param obj The mapbuf object.
20905 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20907 * This enables the map that is set or disables it. On enable, the object
20908 * geometry will be saved, and the new geometry will change (position and
20909 * size) to reflect the map geometry set.
20911 * Also, when enabled, alpha and smooth states will be used, so if the
20912 * content isn't solid, alpha should be enabled, for example, otherwise
20913 * a black retangle will fill the content.
20915 * When disabled, the stored map will be freed and geometry prior to
20916 * enabling the map will be restored.
20918 * It's disabled by default.
20920 * @see elm_mapbuf_alpha_set()
20921 * @see elm_mapbuf_smooth_set()
20925 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20928 * Get a value whether map is enabled or not.
20930 * @param obj The mapbuf object.
20931 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20932 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20934 * @see elm_mapbuf_enabled_set() for details.
20938 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20941 * Enable or disable smooth map rendering.
20943 * @param obj The mapbuf object.
20944 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20947 * This sets smoothing for map rendering. If the object is a type that has
20948 * its own smoothing settings, then both the smooth settings for this object
20949 * and the map must be turned off.
20951 * By default smooth maps are enabled.
20955 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20958 * Get a value whether smooth map rendering is enabled or not.
20960 * @param obj The mapbuf object.
20961 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20962 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20964 * @see elm_mapbuf_smooth_set() for details.
20968 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20971 * Set or unset alpha flag for map rendering.
20973 * @param obj The mapbuf object.
20974 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20977 * This sets alpha flag for map rendering. If the object is a type that has
20978 * its own alpha settings, then this will take precedence. Only image objects
20979 * have this currently. It stops alpha blending of the map area, and is
20980 * useful if you know the object and/or all sub-objects is 100% solid.
20982 * Alpha is enabled by default.
20986 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20989 * Get a value whether alpha blending is enabled or not.
20991 * @param obj The mapbuf object.
20992 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20993 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20995 * @see elm_mapbuf_alpha_set() for details.
20999 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21006 * @defgroup Flipselector Flip Selector
21008 * @image html img/widget/flipselector/preview-00.png
21009 * @image latex img/widget/flipselector/preview-00.eps
21011 * A flip selector is a widget to show a set of @b text items, one
21012 * at a time, with the same sheet switching style as the @ref Clock
21013 * "clock" widget, when one changes the current displaying sheet
21014 * (thus, the "flip" in the name).
21016 * User clicks to flip sheets which are @b held for some time will
21017 * make the flip selector to flip continuosly and automatically for
21018 * the user. The interval between flips will keep growing in time,
21019 * so that it helps the user to reach an item which is distant from
21020 * the current selection.
21022 * Smart callbacks one can register to:
21023 * - @c "selected" - when the widget's selected text item is changed
21024 * - @c "overflowed" - when the widget's current selection is changed
21025 * from the first item in its list to the last
21026 * - @c "underflowed" - when the widget's current selection is changed
21027 * from the last item in its list to the first
21029 * Available styles for it:
21032 * Here is an example on its usage:
21033 * @li @ref flipselector_example
21037 * @addtogroup Flipselector
21041 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
21044 * Add a new flip selector widget to the given parent Elementary
21045 * (container) widget
21047 * @param parent The parent object
21048 * @return a new flip selector widget handle or @c NULL, on errors
21050 * This function inserts a new flip selector widget on the canvas.
21052 * @ingroup Flipselector
21054 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21057 * Programmatically select the next item of a flip selector widget
21059 * @param obj The flipselector object
21061 * @note The selection will be animated. Also, if it reaches the
21062 * end of its list of member items, it will continue with the first
21065 * @ingroup Flipselector
21067 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21070 * Programmatically select the previous item of a flip selector
21073 * @param obj The flipselector object
21075 * @note The selection will be animated. Also, if it reaches the
21076 * beginning of its list of member items, it will continue with the
21077 * last one backwards.
21079 * @ingroup Flipselector
21081 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
21084 * Append a (text) item to a flip selector widget
21086 * @param obj The flipselector object
21087 * @param label The (text) label of the new item
21088 * @param func Convenience callback function to take place when
21090 * @param data Data passed to @p func, above
21091 * @return A handle to the item added or @c NULL, on errors
21093 * The widget's list of labels to show will be appended with the
21094 * given value. If the user wishes so, a callback function pointer
21095 * can be passed, which will get called when this same item is
21098 * @note The current selection @b won't be modified by appending an
21099 * element to the list.
21101 * @note The maximum length of the text label is going to be
21102 * determined <b>by the widget's theme</b>. Strings larger than
21103 * that value are going to be @b truncated.
21105 * @ingroup Flipselector
21107 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21110 * Prepend a (text) item to a flip selector widget
21112 * @param obj The flipselector object
21113 * @param label The (text) label of the new item
21114 * @param func Convenience callback function to take place when
21116 * @param data Data passed to @p func, above
21117 * @return A handle to the item added or @c NULL, on errors
21119 * The widget's list of labels to show will be prepended with the
21120 * given value. If the user wishes so, a callback function pointer
21121 * can be passed, which will get called when this same item is
21124 * @note The current selection @b won't be modified by prepending
21125 * an element to the list.
21127 * @note The maximum length of the text label is going to be
21128 * determined <b>by the widget's theme</b>. Strings larger than
21129 * that value are going to be @b truncated.
21131 * @ingroup Flipselector
21133 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21136 * Get the internal list of items in a given flip selector widget.
21138 * @param obj The flipselector object
21139 * @return The list of items (#Elm_Flipselector_Item as data) or
21140 * @c NULL on errors.
21142 * This list is @b not to be modified in any way and must not be
21143 * freed. Use the list members with functions like
21144 * elm_flipselector_item_label_set(),
21145 * elm_flipselector_item_label_get(),
21146 * elm_flipselector_item_del(),
21147 * elm_flipselector_item_selected_get(),
21148 * elm_flipselector_item_selected_set().
21150 * @warning This list is only valid until @p obj object's internal
21151 * items list is changed. It should be fetched again with another
21152 * call to this function when changes happen.
21154 * @ingroup Flipselector
21156 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21159 * Get the first item in the given flip selector widget's list of
21162 * @param obj The flipselector object
21163 * @return The first item or @c NULL, if it has no items (and on
21166 * @see elm_flipselector_item_append()
21167 * @see elm_flipselector_last_item_get()
21169 * @ingroup Flipselector
21171 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21174 * Get the last item in the given flip selector widget's list of
21177 * @param obj The flipselector object
21178 * @return The last item or @c NULL, if it has no items (and on
21181 * @see elm_flipselector_item_prepend()
21182 * @see elm_flipselector_first_item_get()
21184 * @ingroup Flipselector
21186 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21189 * Get the currently selected item in a flip selector widget.
21191 * @param obj The flipselector object
21192 * @return The selected item or @c NULL, if the widget has no items
21195 * @ingroup Flipselector
21197 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21200 * Set whether a given flip selector widget's item should be the
21201 * currently selected one.
21203 * @param item The flip selector item
21204 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
21206 * This sets whether @p item is or not the selected (thus, under
21207 * display) one. If @p item is different than one under display,
21208 * the latter will be unselected. If the @p item is set to be
21209 * unselected, on the other hand, the @b first item in the widget's
21210 * internal members list will be the new selected one.
21212 * @see elm_flipselector_item_selected_get()
21214 * @ingroup Flipselector
21216 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
21219 * Get whether a given flip selector widget's item is the currently
21222 * @param item The flip selector item
21223 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
21226 * @see elm_flipselector_item_selected_set()
21228 * @ingroup Flipselector
21230 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21233 * Delete a given item from a flip selector widget.
21235 * @param item The item to delete
21237 * @ingroup Flipselector
21239 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21242 * Get the label of a given flip selector widget's item.
21244 * @param item The item to get label from
21245 * @return The text label of @p item or @c NULL, on errors
21247 * @see elm_flipselector_item_label_set()
21249 * @ingroup Flipselector
21251 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21254 * Set the label of a given flip selector widget's item.
21256 * @param item The item to set label on
21257 * @param label The text label string, in UTF-8 encoding
21259 * @see elm_flipselector_item_label_get()
21261 * @ingroup Flipselector
21263 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21266 * Gets the item before @p item in a flip selector widget's
21267 * internal list of items.
21269 * @param item The item to fetch previous from
21270 * @return The item before the @p item, in its parent's list. If
21271 * there is no previous item for @p item or there's an
21272 * error, @c NULL is returned.
21274 * @see elm_flipselector_item_next_get()
21276 * @ingroup Flipselector
21278 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21281 * Gets the item after @p item in a flip selector widget's
21282 * internal list of items.
21284 * @param item The item to fetch next from
21285 * @return The item after the @p item, in its parent's list. If
21286 * there is no next item for @p item or there's an
21287 * error, @c NULL is returned.
21289 * @see elm_flipselector_item_next_get()
21291 * @ingroup Flipselector
21293 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21296 * Set the interval on time updates for an user mouse button hold
21297 * on a flip selector widget.
21299 * @param obj The flip selector object
21300 * @param interval The (first) interval value in seconds
21302 * This interval value is @b decreased while the user holds the
21303 * mouse pointer either flipping up or flipping doww a given flip
21306 * This helps the user to get to a given item distant from the
21307 * current one easier/faster, as it will start to flip quicker and
21308 * quicker on mouse button holds.
21310 * The calculation for the next flip interval value, starting from
21311 * the one set with this call, is the previous interval divided by
21312 * 1.05, so it decreases a little bit.
21314 * The default starting interval value for automatic flips is
21317 * @see elm_flipselector_interval_get()
21319 * @ingroup Flipselector
21321 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21324 * Get the interval on time updates for an user mouse button hold
21325 * on a flip selector widget.
21327 * @param obj The flip selector object
21328 * @return The (first) interval value, in seconds, set on it
21330 * @see elm_flipselector_interval_set() for more details
21332 * @ingroup Flipselector
21334 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21340 * @addtogroup Calendar
21345 * @enum _Elm_Calendar_Mark_Repeat
21346 * @typedef Elm_Calendar_Mark_Repeat
21348 * Event periodicity, used to define if a mark should be repeated
21349 * @b beyond event's day. It's set when a mark is added.
21351 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21352 * there will be marks every week after this date. Marks will be displayed
21353 * at 13th, 20th, 27th, 3rd June ...
21355 * Values don't work as bitmask, only one can be choosen.
21357 * @see elm_calendar_mark_add()
21359 * @ingroup Calendar
21361 typedef enum _Elm_Calendar_Mark_Repeat
21363 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21364 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21365 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21366 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*/
21367 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. */
21368 } Elm_Calendar_Mark_Repeat;
21370 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(). */
21373 * Add a new calendar widget to the given parent Elementary
21374 * (container) object.
21376 * @param parent The parent object.
21377 * @return a new calendar widget handle or @c NULL, on errors.
21379 * This function inserts a new calendar widget on the canvas.
21381 * @ref calendar_example_01
21383 * @ingroup Calendar
21385 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21388 * Get weekdays names displayed by the calendar.
21390 * @param obj The calendar object.
21391 * @return Array of seven strings to be used as weekday names.
21393 * By default, weekdays abbreviations get from system are displayed:
21394 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21395 * The first string is related to Sunday, the second to Monday...
21397 * @see elm_calendar_weekdays_name_set()
21399 * @ref calendar_example_05
21401 * @ingroup Calendar
21403 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21406 * Set weekdays names to be displayed by the calendar.
21408 * @param obj The calendar object.
21409 * @param weekdays Array of seven strings to be used as weekday names.
21410 * @warning It must have 7 elements, or it will access invalid memory.
21411 * @warning The strings must be NULL terminated ('@\0').
21413 * By default, weekdays abbreviations get from system are displayed:
21414 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21416 * The first string should be related to Sunday, the second to Monday...
21418 * The usage should be like this:
21420 * const char *weekdays[] =
21422 * "Sunday", "Monday", "Tuesday", "Wednesday",
21423 * "Thursday", "Friday", "Saturday"
21425 * elm_calendar_weekdays_names_set(calendar, weekdays);
21428 * @see elm_calendar_weekdays_name_get()
21430 * @ref calendar_example_02
21432 * @ingroup Calendar
21434 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21437 * Set the minimum and maximum values for the year
21439 * @param obj The calendar object
21440 * @param min The minimum year, greater than 1901;
21441 * @param max The maximum year;
21443 * Maximum must be greater than minimum, except if you don't wan't to set
21445 * Default values are 1902 and -1.
21447 * If the maximum year is a negative value, it will be limited depending
21448 * on the platform architecture (year 2037 for 32 bits);
21450 * @see elm_calendar_min_max_year_get()
21452 * @ref calendar_example_03
21454 * @ingroup Calendar
21456 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21459 * Get the minimum and maximum values for the year
21461 * @param obj The calendar object.
21462 * @param min The minimum year.
21463 * @param max The maximum year.
21465 * Default values are 1902 and -1.
21467 * @see elm_calendar_min_max_year_get() for more details.
21469 * @ref calendar_example_05
21471 * @ingroup Calendar
21473 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21476 * Enable or disable day selection
21478 * @param obj The calendar object.
21479 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21482 * Enabled by default. If disabled, the user still can select months,
21483 * but not days. Selected days are highlighted on calendar.
21484 * It should be used if you won't need such selection for the widget usage.
21486 * When a day is selected, or month is changed, smart callbacks for
21487 * signal "changed" will be called.
21489 * @see elm_calendar_day_selection_enable_get()
21491 * @ref calendar_example_04
21493 * @ingroup Calendar
21495 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21498 * Get a value whether day selection is enabled or not.
21500 * @see elm_calendar_day_selection_enable_set() for details.
21502 * @param obj The calendar object.
21503 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21504 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21506 * @ref calendar_example_05
21508 * @ingroup Calendar
21510 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21514 * Set selected date to be highlighted on calendar.
21516 * @param obj The calendar object.
21517 * @param selected_time A @b tm struct to represent the selected date.
21519 * Set the selected date, changing the displayed month if needed.
21520 * Selected date changes when the user goes to next/previous month or
21521 * select a day pressing over it on calendar.
21523 * @see elm_calendar_selected_time_get()
21525 * @ref calendar_example_04
21527 * @ingroup Calendar
21529 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21532 * Get selected date.
21534 * @param obj The calendar object
21535 * @param selected_time A @b tm struct to point to selected date
21536 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21539 * Get date selected by the user or set by function
21540 * elm_calendar_selected_time_set().
21541 * Selected date changes when the user goes to next/previous month or
21542 * select a day pressing over it on calendar.
21544 * @see elm_calendar_selected_time_get()
21546 * @ref calendar_example_05
21548 * @ingroup Calendar
21550 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21553 * Set a function to format the string that will be used to display
21556 * @param obj The calendar object
21557 * @param format_function Function to set the month-year string given
21558 * the selected date
21560 * By default it uses strftime with "%B %Y" format string.
21561 * It should allocate the memory that will be used by the string,
21562 * that will be freed by the widget after usage.
21563 * A pointer to the string and a pointer to the time struct will be provided.
21568 * _format_month_year(struct tm *selected_time)
21571 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21572 * return strdup(buf);
21575 * elm_calendar_format_function_set(calendar, _format_month_year);
21578 * @ref calendar_example_02
21580 * @ingroup Calendar
21582 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21585 * Add a new mark to the calendar
21587 * @param obj The calendar object
21588 * @param mark_type A string used to define the type of mark. It will be
21589 * emitted to the theme, that should display a related modification on these
21590 * days representation.
21591 * @param mark_time A time struct to represent the date of inclusion of the
21592 * mark. For marks that repeats it will just be displayed after the inclusion
21593 * date in the calendar.
21594 * @param repeat Repeat the event following this periodicity. Can be a unique
21595 * mark (that don't repeat), daily, weekly, monthly or annually.
21596 * @return The created mark or @p NULL upon failure.
21598 * Add a mark that will be drawn in the calendar respecting the insertion
21599 * time and periodicity. It will emit the type as signal to the widget theme.
21600 * Default theme supports "holiday" and "checked", but it can be extended.
21602 * It won't immediately update the calendar, drawing the marks.
21603 * For this, call elm_calendar_marks_draw(). However, when user selects
21604 * next or previous month calendar forces marks drawn.
21606 * Marks created with this method can be deleted with
21607 * elm_calendar_mark_del().
21611 * struct tm selected_time;
21612 * time_t current_time;
21614 * current_time = time(NULL) + 5 * 84600;
21615 * localtime_r(¤t_time, &selected_time);
21616 * elm_calendar_mark_add(cal, "holiday", selected_time,
21617 * ELM_CALENDAR_ANNUALLY);
21619 * current_time = time(NULL) + 1 * 84600;
21620 * localtime_r(¤t_time, &selected_time);
21621 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21623 * elm_calendar_marks_draw(cal);
21626 * @see elm_calendar_marks_draw()
21627 * @see elm_calendar_mark_del()
21629 * @ref calendar_example_06
21631 * @ingroup Calendar
21633 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);
21636 * Delete mark from the calendar.
21638 * @param mark The mark to be deleted.
21640 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21641 * should be used instead of getting marks list and deleting each one.
21643 * @see elm_calendar_mark_add()
21645 * @ref calendar_example_06
21647 * @ingroup Calendar
21649 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21652 * Remove all calendar's marks
21654 * @param obj The calendar object.
21656 * @see elm_calendar_mark_add()
21657 * @see elm_calendar_mark_del()
21659 * @ingroup Calendar
21661 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21665 * Get a list of all the calendar marks.
21667 * @param obj The calendar object.
21668 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21670 * @see elm_calendar_mark_add()
21671 * @see elm_calendar_mark_del()
21672 * @see elm_calendar_marks_clear()
21674 * @ingroup Calendar
21676 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21679 * Draw calendar marks.
21681 * @param obj The calendar object.
21683 * Should be used after adding, removing or clearing marks.
21684 * It will go through the entire marks list updating the calendar.
21685 * If lots of marks will be added, add all the marks and then call
21688 * When the month is changed, i.e. user selects next or previous month,
21689 * marks will be drawed.
21691 * @see elm_calendar_mark_add()
21692 * @see elm_calendar_mark_del()
21693 * @see elm_calendar_marks_clear()
21695 * @ref calendar_example_06
21697 * @ingroup Calendar
21699 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21702 * Set a day text color to the same that represents Saturdays.
21704 * @param obj The calendar object.
21705 * @param pos The text position. Position is the cell counter, from left
21706 * to right, up to down. It starts on 0 and ends on 41.
21708 * @deprecated use elm_calendar_mark_add() instead like:
21711 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21712 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21715 * @see elm_calendar_mark_add()
21717 * @ingroup Calendar
21719 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21722 * Set a day text color to the same that represents Sundays.
21724 * @param obj The calendar object.
21725 * @param pos The text position. Position is the cell counter, from left
21726 * to right, up to down. It starts on 0 and ends on 41.
21728 * @deprecated use elm_calendar_mark_add() instead like:
21731 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21732 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21735 * @see elm_calendar_mark_add()
21737 * @ingroup Calendar
21739 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21742 * Set a day text color to the same that represents Weekdays.
21744 * @param obj The calendar object
21745 * @param pos The text position. Position is the cell counter, from left
21746 * to right, up to down. It starts on 0 and ends on 41.
21748 * @deprecated use elm_calendar_mark_add() instead like:
21751 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21753 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21754 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21755 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21756 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21757 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21758 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21759 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21760 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21761 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21764 * @see elm_calendar_mark_add()
21766 * @ingroup Calendar
21768 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21771 * Set the interval on time updates for an user mouse button hold
21772 * on calendar widgets' month selection.
21774 * @param obj The calendar object
21775 * @param interval The (first) interval value in seconds
21777 * This interval value is @b decreased while the user holds the
21778 * mouse pointer either selecting next or previous month.
21780 * This helps the user to get to a given month distant from the
21781 * current one easier/faster, as it will start to change quicker and
21782 * quicker on mouse button holds.
21784 * The calculation for the next change interval value, starting from
21785 * the one set with this call, is the previous interval divided by
21786 * 1.05, so it decreases a little bit.
21788 * The default starting interval value for automatic changes is
21791 * @see elm_calendar_interval_get()
21793 * @ingroup Calendar
21795 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21798 * Get the interval on time updates for an user mouse button hold
21799 * on calendar widgets' month selection.
21801 * @param obj The calendar object
21802 * @return The (first) interval value, in seconds, set on it
21804 * @see elm_calendar_interval_set() for more details
21806 * @ingroup Calendar
21808 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21815 * @defgroup Diskselector Diskselector
21816 * @ingroup Elementary
21818 * @image html img/widget/diskselector/preview-00.png
21819 * @image latex img/widget/diskselector/preview-00.eps
21821 * A diskselector is a kind of list widget. It scrolls horizontally,
21822 * and can contain label and icon objects. Three items are displayed
21823 * with the selected one in the middle.
21825 * It can act like a circular list with round mode and labels can be
21826 * reduced for a defined length for side items.
21828 * Smart callbacks one can listen to:
21829 * - "selected" - when item is selected, i.e. scroller stops.
21831 * Available styles for it:
21834 * List of examples:
21835 * @li @ref diskselector_example_01
21836 * @li @ref diskselector_example_02
21840 * @addtogroup Diskselector
21844 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(). */
21847 * Add a new diskselector widget to the given parent Elementary
21848 * (container) object.
21850 * @param parent The parent object.
21851 * @return a new diskselector widget handle or @c NULL, on errors.
21853 * This function inserts a new diskselector widget on the canvas.
21855 * @ingroup Diskselector
21857 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21860 * Enable or disable round mode.
21862 * @param obj The diskselector object.
21863 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21866 * Disabled by default. If round mode is enabled the items list will
21867 * work like a circle list, so when the user reaches the last item,
21868 * the first one will popup.
21870 * @see elm_diskselector_round_get()
21872 * @ingroup Diskselector
21874 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21877 * Get a value whether round mode is enabled or not.
21879 * @see elm_diskselector_round_set() for details.
21881 * @param obj The diskselector object.
21882 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21883 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21885 * @ingroup Diskselector
21887 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21890 * Get the side labels max length.
21892 * @deprecated use elm_diskselector_side_label_length_get() instead:
21894 * @param obj The diskselector object.
21895 * @return The max length defined for side labels, or 0 if not a valid
21898 * @ingroup Diskselector
21900 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21903 * Set the side labels max length.
21905 * @deprecated use elm_diskselector_side_label_length_set() instead:
21907 * @param obj The diskselector object.
21908 * @param len The max length defined for side labels.
21910 * @ingroup Diskselector
21912 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21915 * Get the side labels max length.
21917 * @see elm_diskselector_side_label_length_set() for details.
21919 * @param obj The diskselector object.
21920 * @return The max length defined for side labels, or 0 if not a valid
21923 * @ingroup Diskselector
21925 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21928 * Set the side labels max length.
21930 * @param obj The diskselector object.
21931 * @param len The max length defined for side labels.
21933 * Length is the number of characters of items' label that will be
21934 * visible when it's set on side positions. It will just crop
21935 * the string after defined size. E.g.:
21937 * An item with label "January" would be displayed on side position as
21938 * "Jan" if max length is set to 3, or "Janu", if this property
21941 * When it's selected, the entire label will be displayed, except for
21942 * width restrictions. In this case label will be cropped and "..."
21943 * will be concatenated.
21945 * Default side label max length is 3.
21947 * This property will be applyed over all items, included before or
21948 * later this function call.
21950 * @ingroup Diskselector
21952 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21955 * Set the number of items to be displayed.
21957 * @param obj The diskselector object.
21958 * @param num The number of items the diskselector will display.
21960 * Default value is 3, and also it's the minimun. If @p num is less
21961 * than 3, it will be set to 3.
21963 * Also, it can be set on theme, using data item @c display_item_num
21964 * on group "elm/diskselector/item/X", where X is style set.
21967 * group { name: "elm/diskselector/item/X";
21969 * item: "display_item_num" "5";
21972 * @ingroup Diskselector
21974 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
21977 * Set bouncing behaviour when the scrolled content reaches an edge.
21979 * Tell the internal scroller object whether it should bounce or not
21980 * when it reaches the respective edges for each axis.
21982 * @param obj The diskselector object.
21983 * @param h_bounce Whether to bounce or not in the horizontal axis.
21984 * @param v_bounce Whether to bounce or not in the vertical axis.
21986 * @see elm_scroller_bounce_set()
21988 * @ingroup Diskselector
21990 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21993 * Get the bouncing behaviour of the internal scroller.
21995 * Get whether the internal scroller should bounce when the edge of each
21996 * axis is reached scrolling.
21998 * @param obj The diskselector object.
21999 * @param h_bounce Pointer where to store the bounce state of the horizontal
22001 * @param v_bounce Pointer where to store the bounce state of the vertical
22004 * @see elm_scroller_bounce_get()
22005 * @see elm_diskselector_bounce_set()
22007 * @ingroup Diskselector
22009 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22012 * Get the scrollbar policy.
22014 * @see elm_diskselector_scroller_policy_get() for details.
22016 * @param obj The diskselector object.
22017 * @param policy_h Pointer where to store horizontal scrollbar policy.
22018 * @param policy_v Pointer where to store vertical scrollbar policy.
22020 * @ingroup Diskselector
22022 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);
22025 * Set the scrollbar policy.
22027 * @param obj The diskselector object.
22028 * @param policy_h Horizontal scrollbar policy.
22029 * @param policy_v Vertical scrollbar policy.
22031 * This sets the scrollbar visibility policy for the given scroller.
22032 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
22033 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
22034 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
22035 * This applies respectively for the horizontal and vertical scrollbars.
22037 * The both are disabled by default, i.e., are set to
22038 * #ELM_SCROLLER_POLICY_OFF.
22040 * @ingroup Diskselector
22042 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
22045 * Remove all diskselector's items.
22047 * @param obj The diskselector object.
22049 * @see elm_diskselector_item_del()
22050 * @see elm_diskselector_item_append()
22052 * @ingroup Diskselector
22054 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22057 * Get a list of all the diskselector items.
22059 * @param obj The diskselector object.
22060 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22061 * or @c NULL on failure.
22063 * @see elm_diskselector_item_append()
22064 * @see elm_diskselector_item_del()
22065 * @see elm_diskselector_clear()
22067 * @ingroup Diskselector
22069 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22072 * Appends a new item to the diskselector object.
22074 * @param obj The diskselector object.
22075 * @param label The label of the diskselector item.
22076 * @param icon The icon object to use at left side of the item. An
22077 * icon can be any Evas object, but usually it is an icon created
22078 * with elm_icon_add().
22079 * @param func The function to call when the item is selected.
22080 * @param data The data to associate with the item for related callbacks.
22082 * @return The created item or @c NULL upon failure.
22084 * A new item will be created and appended to the diskselector, i.e., will
22085 * be set as last item. Also, if there is no selected item, it will
22086 * be selected. This will always happens for the first appended item.
22088 * If no icon is set, label will be centered on item position, otherwise
22089 * the icon will be placed at left of the label, that will be shifted
22092 * Items created with this method can be deleted with
22093 * elm_diskselector_item_del().
22095 * Associated @p data can be properly freed when item is deleted if a
22096 * callback function is set with elm_diskselector_item_del_cb_set().
22098 * If a function is passed as argument, it will be called everytime this item
22099 * is selected, i.e., the user stops the diskselector with this
22100 * item on center position. If such function isn't needed, just passing
22101 * @c NULL as @p func is enough. The same should be done for @p data.
22103 * Simple example (with no function callback or data associated):
22105 * disk = elm_diskselector_add(win);
22106 * ic = elm_icon_add(win);
22107 * elm_icon_file_set(ic, "path/to/image", NULL);
22108 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22109 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22112 * @see elm_diskselector_item_del()
22113 * @see elm_diskselector_item_del_cb_set()
22114 * @see elm_diskselector_clear()
22115 * @see elm_icon_add()
22117 * @ingroup Diskselector
22119 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);
22123 * Delete them item from the diskselector.
22125 * @param it The item of diskselector to be deleted.
22127 * If deleting all diskselector items is required, elm_diskselector_clear()
22128 * should be used instead of getting items list and deleting each one.
22130 * @see elm_diskselector_clear()
22131 * @see elm_diskselector_item_append()
22132 * @see elm_diskselector_item_del_cb_set()
22134 * @ingroup Diskselector
22136 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22139 * Set the function called when a diskselector item is freed.
22141 * @param it The item to set the callback on
22142 * @param func The function called
22144 * If there is a @p func, then it will be called prior item's memory release.
22145 * That will be called with the following arguments:
22147 * @li item's Evas object;
22150 * This way, a data associated to a diskselector item could be properly
22153 * @ingroup Diskselector
22155 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22158 * Get the data associated to the item.
22160 * @param it The diskselector item
22161 * @return The data associated to @p it
22163 * The return value is a pointer to data associated to @p item when it was
22164 * created, with function elm_diskselector_item_append(). If no data
22165 * was passed as argument, it will return @c NULL.
22167 * @see elm_diskselector_item_append()
22169 * @ingroup Diskselector
22171 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22174 * Set the icon associated to the item.
22176 * @param it The diskselector item
22177 * @param icon The icon object to associate with @p it
22179 * The icon object to use at left side of the item. An
22180 * icon can be any Evas object, but usually it is an icon created
22181 * with elm_icon_add().
22183 * Once the icon object is set, a previously set one will be deleted.
22184 * @warning Setting the same icon for two items will cause the icon to
22185 * dissapear from the first item.
22187 * If an icon was passed as argument on item creation, with function
22188 * elm_diskselector_item_append(), it will be already
22189 * associated to the item.
22191 * @see elm_diskselector_item_append()
22192 * @see elm_diskselector_item_icon_get()
22194 * @ingroup Diskselector
22196 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22199 * Get the icon associated to the item.
22201 * @param it The diskselector item
22202 * @return The icon associated to @p it
22204 * The return value is a pointer to the icon associated to @p item when it was
22205 * created, with function elm_diskselector_item_append(), or later
22206 * with function elm_diskselector_item_icon_set. If no icon
22207 * was passed as argument, it will return @c NULL.
22209 * @see elm_diskselector_item_append()
22210 * @see elm_diskselector_item_icon_set()
22212 * @ingroup Diskselector
22214 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22217 * Set the label of item.
22219 * @param it The item of diskselector.
22220 * @param label The label of item.
22222 * The label to be displayed by the item.
22224 * If no icon is set, label will be centered on item position, otherwise
22225 * the icon will be placed at left of the label, that will be shifted
22228 * An item with label "January" would be displayed on side position as
22229 * "Jan" if max length is set to 3 with function
22230 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22233 * When this @p item is selected, the entire label will be displayed,
22234 * except for width restrictions.
22235 * In this case label will be cropped and "..." will be concatenated,
22236 * but only for display purposes. It will keep the entire string, so
22237 * if diskselector is resized the remaining characters will be displayed.
22239 * If a label was passed as argument on item creation, with function
22240 * elm_diskselector_item_append(), it will be already
22241 * displayed by the item.
22243 * @see elm_diskselector_side_label_lenght_set()
22244 * @see elm_diskselector_item_label_get()
22245 * @see elm_diskselector_item_append()
22247 * @ingroup Diskselector
22249 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22252 * Get the label of item.
22254 * @param it The item of diskselector.
22255 * @return The label of item.
22257 * The return value is a pointer to the label associated to @p item when it was
22258 * created, with function elm_diskselector_item_append(), or later
22259 * with function elm_diskselector_item_label_set. If no label
22260 * was passed as argument, it will return @c NULL.
22262 * @see elm_diskselector_item_label_set() for more details.
22263 * @see elm_diskselector_item_append()
22265 * @ingroup Diskselector
22267 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22270 * Get the selected item.
22272 * @param obj The diskselector object.
22273 * @return The selected diskselector item.
22275 * The selected item can be unselected with function
22276 * elm_diskselector_item_selected_set(), and the first item of
22277 * diskselector will be selected.
22279 * The selected item always will be centered on diskselector, with
22280 * full label displayed, i.e., max lenght set to side labels won't
22281 * apply on the selected item. More details on
22282 * elm_diskselector_side_label_length_set().
22284 * @ingroup Diskselector
22286 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22289 * Set the selected state of an item.
22291 * @param it The diskselector item
22292 * @param selected The selected state
22294 * This sets the selected state of the given item @p it.
22295 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22297 * If a new item is selected the previosly selected will be unselected.
22298 * Previoulsy selected item can be get with function
22299 * elm_diskselector_selected_item_get().
22301 * If the item @p it is unselected, the first item of diskselector will
22304 * Selected items will be visible on center position of diskselector.
22305 * So if it was on another position before selected, or was invisible,
22306 * diskselector will animate items until the selected item reaches center
22309 * @see elm_diskselector_item_selected_get()
22310 * @see elm_diskselector_selected_item_get()
22312 * @ingroup Diskselector
22314 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22317 * Get whether the @p item is selected or not.
22319 * @param it The diskselector item.
22320 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22321 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22323 * @see elm_diskselector_selected_item_set() for details.
22324 * @see elm_diskselector_item_selected_get()
22326 * @ingroup Diskselector
22328 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22331 * Get the first item of the diskselector.
22333 * @param obj The diskselector object.
22334 * @return The first item, or @c NULL if none.
22336 * The list of items follows append order. So it will return the first
22337 * item appended to the widget that wasn't deleted.
22339 * @see elm_diskselector_item_append()
22340 * @see elm_diskselector_items_get()
22342 * @ingroup Diskselector
22344 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22347 * Get the last item of the diskselector.
22349 * @param obj The diskselector object.
22350 * @return The last item, or @c NULL if none.
22352 * The list of items follows append order. So it will return last first
22353 * item appended to the widget that wasn't deleted.
22355 * @see elm_diskselector_item_append()
22356 * @see elm_diskselector_items_get()
22358 * @ingroup Diskselector
22360 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22363 * Get the item before @p item in diskselector.
22365 * @param it The diskselector item.
22366 * @return The item before @p item, or @c NULL if none or on failure.
22368 * The list of items follows append order. So it will return item appended
22369 * just before @p item and that wasn't deleted.
22371 * If it is the first item, @c NULL will be returned.
22372 * First item can be get by elm_diskselector_first_item_get().
22374 * @see elm_diskselector_item_append()
22375 * @see elm_diskselector_items_get()
22377 * @ingroup Diskselector
22379 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22382 * Get the item after @p item in diskselector.
22384 * @param it The diskselector item.
22385 * @return The item after @p item, or @c NULL if none or on failure.
22387 * The list of items follows append order. So it will return item appended
22388 * just after @p item and that wasn't deleted.
22390 * If it is the last item, @c NULL will be returned.
22391 * Last item can be get by elm_diskselector_last_item_get().
22393 * @see elm_diskselector_item_append()
22394 * @see elm_diskselector_items_get()
22396 * @ingroup Diskselector
22398 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22401 * Set the text to be shown in the diskselector item.
22403 * @param item Target item
22404 * @param text The text to set in the content
22406 * Setup the text as tooltip to object. The item can have only one tooltip,
22407 * so any previous tooltip data is removed.
22409 * @see elm_object_tooltip_text_set() for more details.
22411 * @ingroup Diskselector
22413 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22416 * Set the content to be shown in the tooltip item.
22418 * Setup the tooltip to item. The item can have only one tooltip,
22419 * so any previous tooltip data is removed. @p func(with @p data) will
22420 * be called every time that need show the tooltip and it should
22421 * return a valid Evas_Object. This object is then managed fully by
22422 * tooltip system and is deleted when the tooltip is gone.
22424 * @param item the diskselector item being attached a tooltip.
22425 * @param func the function used to create the tooltip contents.
22426 * @param data what to provide to @a func as callback data/context.
22427 * @param del_cb called when data is not needed anymore, either when
22428 * another callback replaces @p func, the tooltip is unset with
22429 * elm_diskselector_item_tooltip_unset() or the owner @a item
22430 * dies. This callback receives as the first parameter the
22431 * given @a data, and @c event_info is the item.
22433 * @see elm_object_tooltip_content_cb_set() for more details.
22435 * @ingroup Diskselector
22437 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);
22440 * Unset tooltip from item.
22442 * @param item diskselector item to remove previously set tooltip.
22444 * Remove tooltip from item. The callback provided as del_cb to
22445 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22446 * it is not used anymore.
22448 * @see elm_object_tooltip_unset() for more details.
22449 * @see elm_diskselector_item_tooltip_content_cb_set()
22451 * @ingroup Diskselector
22453 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22457 * Sets a different style for this item tooltip.
22459 * @note before you set a style you should define a tooltip with
22460 * elm_diskselector_item_tooltip_content_cb_set() or
22461 * elm_diskselector_item_tooltip_text_set()
22463 * @param item diskselector item with tooltip already set.
22464 * @param style the theme style to use (default, transparent, ...)
22466 * @see elm_object_tooltip_style_set() for more details.
22468 * @ingroup Diskselector
22470 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22473 * Get the style for this item tooltip.
22475 * @param item diskselector item with tooltip already set.
22476 * @return style the theme style in use, defaults to "default". If the
22477 * object does not have a tooltip set, then NULL is returned.
22479 * @see elm_object_tooltip_style_get() for more details.
22480 * @see elm_diskselector_item_tooltip_style_set()
22482 * @ingroup Diskselector
22484 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22487 * Set the cursor to be shown when mouse is over the diskselector item
22489 * @param item Target item
22490 * @param cursor the cursor name to be used.
22492 * @see elm_object_cursor_set() for more details.
22494 * @ingroup Diskselector
22496 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22499 * Get the cursor to be shown when mouse is over the diskselector item
22501 * @param item diskselector item with cursor already set.
22502 * @return the cursor name.
22504 * @see elm_object_cursor_get() for more details.
22505 * @see elm_diskselector_cursor_set()
22507 * @ingroup Diskselector
22509 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22513 * Unset the cursor to be shown when mouse is over the diskselector item
22515 * @param item Target item
22517 * @see elm_object_cursor_unset() for more details.
22518 * @see elm_diskselector_cursor_set()
22520 * @ingroup Diskselector
22522 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22525 * Sets a different style for this item cursor.
22527 * @note before you set a style you should define a cursor with
22528 * elm_diskselector_item_cursor_set()
22530 * @param item diskselector item with cursor already set.
22531 * @param style the theme style to use (default, transparent, ...)
22533 * @see elm_object_cursor_style_set() for more details.
22535 * @ingroup Diskselector
22537 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22541 * Get the style for this item cursor.
22543 * @param item diskselector item with cursor already set.
22544 * @return style the theme style in use, defaults to "default". If the
22545 * object does not have a cursor set, then @c NULL is returned.
22547 * @see elm_object_cursor_style_get() for more details.
22548 * @see elm_diskselector_item_cursor_style_set()
22550 * @ingroup Diskselector
22552 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22556 * Set if the cursor set should be searched on the theme or should use
22557 * the provided by the engine, only.
22559 * @note before you set if should look on theme you should define a cursor
22560 * with elm_diskselector_item_cursor_set().
22561 * By default it will only look for cursors provided by the engine.
22563 * @param item widget item with cursor already set.
22564 * @param engine_only boolean to define if cursors set with
22565 * elm_diskselector_item_cursor_set() should be searched only
22566 * between cursors provided by the engine or searched on widget's
22569 * @see elm_object_cursor_engine_only_set() for more details.
22571 * @ingroup Diskselector
22573 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22576 * Get the cursor engine only usage for this item cursor.
22578 * @param item widget item with cursor already set.
22579 * @return engine_only boolean to define it cursors should be looked only
22580 * between the provided by the engine or searched on widget's theme as well.
22581 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22583 * @see elm_object_cursor_engine_only_get() for more details.
22584 * @see elm_diskselector_item_cursor_engine_only_set()
22586 * @ingroup Diskselector
22588 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22595 * @defgroup Colorselector Colorselector
22599 * @image html img/widget/colorselector/preview-00.png
22600 * @image latex img/widget/colorselector/preview-00.eps
22602 * @brief Widget for user to select a color.
22604 * Signals that you can add callbacks for are:
22605 * "changed" - When the color value changes(event_info is NULL).
22607 * See @ref tutorial_colorselector.
22610 * @brief Add a new colorselector to the parent
22612 * @param parent The parent object
22613 * @return The new object or NULL if it cannot be created
22615 * @ingroup Colorselector
22617 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22619 * Set a color for the colorselector
22621 * @param obj Colorselector object
22622 * @param r r-value of color
22623 * @param g g-value of color
22624 * @param b b-value of color
22625 * @param a a-value of color
22627 * @ingroup Colorselector
22629 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22631 * Get a color from the colorselector
22633 * @param obj Colorselector object
22634 * @param r integer pointer for r-value of color
22635 * @param g integer pointer for g-value of color
22636 * @param b integer pointer for b-value of color
22637 * @param a integer pointer for a-value of color
22639 * @ingroup Colorselector
22641 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22647 * @defgroup Ctxpopup Ctxpopup
22649 * @image html img/widget/ctxpopup/preview-00.png
22650 * @image latex img/widget/ctxpopup/preview-00.eps
22652 * @brief Context popup widet.
22654 * A ctxpopup is a widget that, when shown, pops up a list of items.
22655 * It automatically chooses an area inside its parent object's view
22656 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22657 * optimally fit into it. In the default theme, it will also point an
22658 * arrow to it's top left position at the time one shows it. Ctxpopup
22659 * items have a label and/or an icon. It is intended for a small
22660 * number of items (hence the use of list, not genlist).
22662 * @note Ctxpopup is a especialization of @ref Hover.
22664 * Signals that you can add callbacks for are:
22665 * "dismissed" - the ctxpopup was dismissed
22667 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22670 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22672 typedef enum _Elm_Ctxpopup_Direction
22674 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22676 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22677 the clicked area */
22678 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22679 the clicked area */
22680 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22682 } Elm_Ctxpopup_Direction;
22685 * @brief Add a new Ctxpopup object to the parent.
22687 * @param parent Parent object
22688 * @return New object or @c NULL, if it cannot be created
22690 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22692 * @brief Set the Ctxpopup's parent
22694 * @param obj The ctxpopup object
22695 * @param area The parent to use
22697 * Set the parent object.
22699 * @note elm_ctxpopup_add() will automatically call this function
22700 * with its @c parent argument.
22702 * @see elm_ctxpopup_add()
22703 * @see elm_hover_parent_set()
22705 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22707 * @brief Get the Ctxpopup's parent
22709 * @param obj The ctxpopup object
22711 * @see elm_ctxpopup_hover_parent_set() for more information
22713 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22715 * @brief Clear all items in the given ctxpopup object.
22717 * @param obj Ctxpopup object
22719 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22721 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22723 * @param obj Ctxpopup object
22724 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22726 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22728 * @brief Get the value of current ctxpopup object's orientation.
22730 * @param obj Ctxpopup object
22731 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22733 * @see elm_ctxpopup_horizontal_set()
22735 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22737 * @brief Add a new item to a ctxpopup object.
22739 * @param obj Ctxpopup object
22740 * @param icon Icon to be set on new item
22741 * @param label The Label of the new item
22742 * @param func Convenience function called when item selected
22743 * @param data Data passed to @p func
22744 * @return A handle to the item added or @c NULL, on errors
22746 * @warning Ctxpopup can't hold both an item list and a content at the same
22747 * time. When an item is added, any previous content will be removed.
22749 * @see elm_ctxpopup_content_set()
22751 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);
22753 * @brief Delete the given item in a ctxpopup object.
22755 * @param item Ctxpopup item to be deleted
22757 * @see elm_ctxpopup_item_append()
22759 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22761 * @brief Set the ctxpopup item's state as disabled or enabled.
22763 * @param item Ctxpopup item to be enabled/disabled
22764 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22766 * When disabled the item is greyed out to indicate it's state.
22768 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22770 * @brief Get the ctxpopup item's disabled/enabled state.
22772 * @param item Ctxpopup item to be enabled/disabled
22773 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22775 * @see elm_ctxpopup_item_disabled_set()
22777 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22779 * @brief Get the icon object for the given ctxpopup item.
22781 * @param item Ctxpopup item
22782 * @return icon object or @c NULL, if the item does not have icon or an error
22785 * @see elm_ctxpopup_item_append()
22786 * @see elm_ctxpopup_item_icon_set()
22788 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22790 * @brief Sets the side icon associated with the ctxpopup item
22792 * @param item Ctxpopup item
22793 * @param icon Icon object to be set
22795 * Once the icon object is set, a previously set one will be deleted.
22796 * @warning Setting the same icon for two items will cause the icon to
22797 * dissapear from the first item.
22799 * @see elm_ctxpopup_item_append()
22801 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22803 * @brief Get the label for the given ctxpopup item.
22805 * @param item Ctxpopup item
22806 * @return label string or @c NULL, if the item does not have label or an
22809 * @see elm_ctxpopup_item_append()
22810 * @see elm_ctxpopup_item_label_set()
22812 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22814 * @brief (Re)set the label on the given ctxpopup item.
22816 * @param item Ctxpopup item
22817 * @param label String to set as label
22819 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22821 * @brief Set an elm widget as the content of the ctxpopup.
22823 * @param obj Ctxpopup object
22824 * @param content Content to be swallowed
22826 * If the content object is already set, a previous one will bedeleted. If
22827 * you want to keep that old content object, use the
22828 * elm_ctxpopup_content_unset() function.
22830 * @deprecated use elm_object_content_set()
22832 * @warning Ctxpopup can't hold both a item list and a content at the same
22833 * time. When a content is set, any previous items will be removed.
22835 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22837 * @brief Unset the ctxpopup content
22839 * @param obj Ctxpopup object
22840 * @return The content that was being used
22842 * Unparent and return the content object which was set for this widget.
22844 * @deprecated use elm_object_content_unset()
22846 * @see elm_ctxpopup_content_set()
22848 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22850 * @brief Set the direction priority of a ctxpopup.
22852 * @param obj Ctxpopup object
22853 * @param first 1st priority of direction
22854 * @param second 2nd priority of direction
22855 * @param third 3th priority of direction
22856 * @param fourth 4th priority of direction
22858 * This functions gives a chance to user to set the priority of ctxpopup
22859 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22860 * requested direction.
22862 * @see Elm_Ctxpopup_Direction
22864 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);
22866 * @brief Get the direction priority of a ctxpopup.
22868 * @param obj Ctxpopup object
22869 * @param first 1st priority of direction to be returned
22870 * @param second 2nd priority of direction to be returned
22871 * @param third 3th priority of direction to be returned
22872 * @param fourth 4th priority of direction to be returned
22874 * @see elm_ctxpopup_direction_priority_set() for more information.
22876 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);
22884 * @defgroup Transit Transit
22885 * @ingroup Elementary
22887 * Transit is designed to apply various animated transition effects to @c
22888 * Evas_Object, such like translation, rotation, etc. For using these
22889 * effects, create an @ref Elm_Transit and add the desired transition effects.
22891 * Once the effects are added into transit, they will be automatically
22892 * managed (their callback will be called until the duration is ended, and
22893 * they will be deleted on completion).
22897 * Elm_Transit *trans = elm_transit_add();
22898 * elm_transit_object_add(trans, obj);
22899 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22900 * elm_transit_duration_set(transit, 1);
22901 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22902 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22903 * elm_transit_repeat_times_set(transit, 3);
22906 * Some transition effects are used to change the properties of objects. They
22908 * @li @ref elm_transit_effect_translation_add
22909 * @li @ref elm_transit_effect_color_add
22910 * @li @ref elm_transit_effect_rotation_add
22911 * @li @ref elm_transit_effect_wipe_add
22912 * @li @ref elm_transit_effect_zoom_add
22913 * @li @ref elm_transit_effect_resizing_add
22915 * Other transition effects are used to make one object disappear and another
22916 * object appear on its old place. These effects are:
22918 * @li @ref elm_transit_effect_flip_add
22919 * @li @ref elm_transit_effect_resizable_flip_add
22920 * @li @ref elm_transit_effect_fade_add
22921 * @li @ref elm_transit_effect_blend_add
22923 * It's also possible to make a transition chain with @ref
22924 * elm_transit_chain_transit_add.
22926 * @warning We strongly recommend to use elm_transit just when edje can not do
22927 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22928 * animations can be manipulated inside the theme.
22930 * List of examples:
22931 * @li @ref transit_example_01_explained
22932 * @li @ref transit_example_02_explained
22933 * @li @ref transit_example_03_c
22934 * @li @ref transit_example_04_c
22940 * @enum Elm_Transit_Tween_Mode
22942 * The type of acceleration used in the transition.
22946 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22947 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22948 over time, then decrease again
22950 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22952 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22954 } Elm_Transit_Tween_Mode;
22957 * @enum Elm_Transit_Effect_Flip_Axis
22959 * The axis where flip effect should be applied.
22963 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22964 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22965 } Elm_Transit_Effect_Flip_Axis;
22967 * @enum Elm_Transit_Effect_Wipe_Dir
22969 * The direction where the wipe effect should occur.
22973 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22974 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22975 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22976 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
22977 } Elm_Transit_Effect_Wipe_Dir;
22978 /** @enum Elm_Transit_Effect_Wipe_Type
22980 * Whether the wipe effect should show or hide the object.
22984 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
22986 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
22988 } Elm_Transit_Effect_Wipe_Type;
22991 * @typedef Elm_Transit
22993 * The Transit created with elm_transit_add(). This type has the information
22994 * about the objects which the transition will be applied, and the
22995 * transition effects that will be used. It also contains info about
22996 * duration, number of repetitions, auto-reverse, etc.
22998 typedef struct _Elm_Transit Elm_Transit;
22999 typedef void Elm_Transit_Effect;
23001 * @typedef Elm_Transit_Effect_Transition_Cb
23003 * Transition callback called for this effect on each transition iteration.
23005 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
23007 * Elm_Transit_Effect_End_Cb
23009 * Transition callback called for this effect when the transition is over.
23011 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
23014 * Elm_Transit_Del_Cb
23016 * A callback called when the transit is deleted.
23018 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
23023 * @note Is not necessary to delete the transit object, it will be deleted at
23024 * the end of its operation.
23025 * @note The transit will start playing when the program enter in the main loop, is not
23026 * necessary to give a start to the transit.
23028 * @return The transit object.
23032 EAPI Elm_Transit *elm_transit_add(void);
23035 * Stops the animation and delete the @p transit object.
23037 * Call this function if you wants to stop the animation before the duration
23038 * time. Make sure the @p transit object is still alive with
23039 * elm_transit_del_cb_set() function.
23040 * All added effects will be deleted, calling its repective data_free_cb
23041 * functions. The function setted by elm_transit_del_cb_set() will be called.
23043 * @see elm_transit_del_cb_set()
23045 * @param transit The transit object to be deleted.
23048 * @warning Just call this function if you are sure the transit is alive.
23050 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23053 * Add a new effect to the transit.
23055 * @note The cb function and the data are the key to the effect. If you try to
23056 * add an already added effect, nothing is done.
23057 * @note After the first addition of an effect in @p transit, if its
23058 * effect list become empty again, the @p transit will be killed by
23059 * elm_transit_del(transit) function.
23063 * Elm_Transit *transit = elm_transit_add();
23064 * elm_transit_effect_add(transit,
23065 * elm_transit_effect_blend_op,
23066 * elm_transit_effect_blend_context_new(),
23067 * elm_transit_effect_blend_context_free);
23070 * @param transit The transit object.
23071 * @param transition_cb The operation function. It is called when the
23072 * animation begins, it is the function that actually performs the animation.
23073 * It is called with the @p data, @p transit and the time progression of the
23074 * animation (a double value between 0.0 and 1.0).
23075 * @param effect The context data of the effect.
23076 * @param end_cb The function to free the context data, it will be called
23077 * at the end of the effect, it must finalize the animation and free the
23081 * @warning The transit free the context data at the and of the transition with
23082 * the data_free_cb function, do not use the context data in another transit.
23084 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);
23087 * Delete an added effect.
23089 * This function will remove the effect from the @p transit, calling the
23090 * data_free_cb to free the @p data.
23092 * @see elm_transit_effect_add()
23094 * @note If the effect is not found, nothing is done.
23095 * @note If the effect list become empty, this function will call
23096 * elm_transit_del(transit), that is, it will kill the @p transit.
23098 * @param transit The transit object.
23099 * @param transition_cb The operation function.
23100 * @param effect The context data of the effect.
23104 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);
23107 * Add new object to apply the effects.
23109 * @note After the first addition of an object in @p transit, if its
23110 * object list become empty again, the @p transit will be killed by
23111 * elm_transit_del(transit) function.
23112 * @note If the @p obj belongs to another transit, the @p obj will be
23113 * removed from it and it will only belong to the @p transit. If the old
23114 * transit stays without objects, it will die.
23115 * @note When you add an object into the @p transit, its state from
23116 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23117 * transit ends, if you change this state whith evas_object_pass_events_set()
23118 * after add the object, this state will change again when @p transit stops to
23121 * @param transit The transit object.
23122 * @param obj Object to be animated.
23125 * @warning It is not allowed to add a new object after transit begins to go.
23127 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23130 * Removes an added object from the transit.
23132 * @note If the @p obj is not in the @p transit, nothing is done.
23133 * @note If the list become empty, this function will call
23134 * elm_transit_del(transit), that is, it will kill the @p transit.
23136 * @param transit The transit object.
23137 * @param obj Object to be removed from @p transit.
23140 * @warning It is not allowed to remove objects after transit begins to go.
23142 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23145 * Get the objects of the transit.
23147 * @param transit The transit object.
23148 * @return a Eina_List with the objects from the transit.
23152 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23155 * Enable/disable keeping up the objects states.
23156 * If it is not kept, the objects states will be reset when transition ends.
23158 * @note @p transit can not be NULL.
23159 * @note One state includes geometry, color, map data.
23161 * @param transit The transit object.
23162 * @param state_keep Keeping or Non Keeping.
23166 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23169 * Get a value whether the objects states will be reset or not.
23171 * @note @p transit can not be NULL
23173 * @see elm_transit_objects_final_state_keep_set()
23175 * @param transit The transit object.
23176 * @return EINA_TRUE means the states of the objects will be reset.
23177 * If @p transit is NULL, EINA_FALSE is returned
23181 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23184 * Set the event enabled when transit is operating.
23186 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23187 * events from mouse and keyboard during the animation.
23188 * @note When you add an object with elm_transit_object_add(), its state from
23189 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23190 * transit ends, if you change this state with evas_object_pass_events_set()
23191 * after adding the object, this state will change again when @p transit stops
23194 * @param transit The transit object.
23195 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23196 * ignored otherwise.
23200 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23203 * Get the value of event enabled status.
23205 * @see elm_transit_event_enabled_set()
23207 * @param transit The Transit object
23208 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23209 * EINA_FALSE is returned
23213 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23216 * Set the user-callback function when the transit is deleted.
23218 * @note Using this function twice will overwrite the first function setted.
23219 * @note the @p transit object will be deleted after call @p cb function.
23221 * @param transit The transit object.
23222 * @param cb Callback function pointer. This function will be called before
23223 * the deletion of the transit.
23224 * @param data Callback funtion user data. It is the @p op parameter.
23228 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23231 * Set reverse effect automatically.
23233 * If auto reverse is setted, after running the effects with the progress
23234 * parameter from 0 to 1, it will call the effecs again with the progress
23235 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23236 * where the duration was setted with the function elm_transit_add and
23237 * the repeat with the function elm_transit_repeat_times_set().
23239 * @param transit The transit object.
23240 * @param reverse EINA_TRUE means the auto_reverse is on.
23244 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23247 * Get if the auto reverse is on.
23249 * @see elm_transit_auto_reverse_set()
23251 * @param transit The transit object.
23252 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23253 * EINA_FALSE is returned
23257 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23260 * Set the transit repeat count. Effect will be repeated by repeat count.
23262 * This function sets the number of repetition the transit will run after
23263 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23264 * If the @p repeat is a negative number, it will repeat infinite times.
23266 * @note If this function is called during the transit execution, the transit
23267 * will run @p repeat times, ignoring the times it already performed.
23269 * @param transit The transit object
23270 * @param repeat Repeat count
23274 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23277 * Get the transit repeat count.
23279 * @see elm_transit_repeat_times_set()
23281 * @param transit The Transit object.
23282 * @return The repeat count. If @p transit is NULL
23287 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23290 * Set the transit animation acceleration type.
23292 * This function sets the tween mode of the transit that can be:
23293 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23294 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23295 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23296 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23298 * @param transit The transit object.
23299 * @param tween_mode The tween type.
23303 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23306 * Get the transit animation acceleration type.
23308 * @note @p transit can not be NULL
23310 * @param transit The transit object.
23311 * @return The tween type. If @p transit is NULL
23312 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23316 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23319 * Set the transit animation time
23321 * @note @p transit can not be NULL
23323 * @param transit The transit object.
23324 * @param duration The animation time.
23328 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23331 * Get the transit animation time
23333 * @note @p transit can not be NULL
23335 * @param transit The transit object.
23337 * @return The transit animation time.
23341 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23344 * Starts the transition.
23345 * Once this API is called, the transit begins to measure the time.
23347 * @note @p transit can not be NULL
23349 * @param transit The transit object.
23353 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23356 * Pause/Resume the transition.
23358 * If you call elm_transit_go again, the transit will be started from the
23359 * beginning, and will be unpaused.
23361 * @note @p transit can not be NULL
23363 * @param transit The transit object.
23364 * @param paused Whether the transition should be paused or not.
23368 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23371 * Get the value of paused status.
23373 * @see elm_transit_paused_set()
23375 * @note @p transit can not be NULL
23377 * @param transit The transit object.
23378 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23379 * EINA_FALSE is returned
23383 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23386 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23388 * The value returned is a fraction (current time / total time). It
23389 * represents the progression position relative to the total.
23391 * @note @p transit can not be NULL
23393 * @param transit The transit object.
23395 * @return The time progression value. If @p transit is NULL
23400 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23403 * Makes the chain relationship between two transits.
23405 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23406 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23408 * @param transit The transit object.
23409 * @param chain_transit The chain transit object. This transit will be operated
23410 * after transit is done.
23412 * This function adds @p chain_transit transition to a chain after the @p
23413 * transit, and will be started as soon as @p transit ends. See @ref
23414 * transit_example_02_explained for a full example.
23418 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23421 * Cut off the chain relationship between two transits.
23423 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23424 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23426 * @param transit The transit object.
23427 * @param chain_transit The chain transit object.
23429 * This function remove the @p chain_transit transition from the @p transit.
23433 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23436 * Get the current chain transit list.
23438 * @note @p transit can not be NULL.
23440 * @param transit The transit object.
23441 * @return chain transit list.
23445 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23448 * Add the Resizing Effect to Elm_Transit.
23450 * @note This API is one of the facades. It creates resizing effect context
23451 * and add it's required APIs to elm_transit_effect_add.
23453 * @see elm_transit_effect_add()
23455 * @param transit Transit object.
23456 * @param from_w Object width size when effect begins.
23457 * @param from_h Object height size when effect begins.
23458 * @param to_w Object width size when effect ends.
23459 * @param to_h Object height size when effect ends.
23460 * @return Resizing effect context data.
23464 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);
23467 * Add the Translation Effect to Elm_Transit.
23469 * @note This API is one of the facades. It creates translation effect context
23470 * and add it's required APIs to elm_transit_effect_add.
23472 * @see elm_transit_effect_add()
23474 * @param transit Transit object.
23475 * @param from_dx X Position variation when effect begins.
23476 * @param from_dy Y Position variation when effect begins.
23477 * @param to_dx X Position variation when effect ends.
23478 * @param to_dy Y Position variation when effect ends.
23479 * @return Translation effect context data.
23482 * @warning It is highly recommended just create a transit with this effect when
23483 * the window that the objects of the transit belongs has already been created.
23484 * This is because this effect needs the geometry information about the objects,
23485 * and if the window was not created yet, it can get a wrong information.
23487 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);
23490 * Add the Zoom Effect to Elm_Transit.
23492 * @note This API is one of the facades. It creates zoom effect context
23493 * and add it's required APIs to elm_transit_effect_add.
23495 * @see elm_transit_effect_add()
23497 * @param transit Transit object.
23498 * @param from_rate Scale rate when effect begins (1 is current rate).
23499 * @param to_rate Scale rate when effect ends.
23500 * @return Zoom effect context data.
23503 * @warning It is highly recommended just create a transit with this effect when
23504 * the window that the objects of the transit belongs has already been created.
23505 * This is because this effect needs the geometry information about the objects,
23506 * and if the window was not created yet, it can get a wrong information.
23508 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23511 * Add the Flip Effect to Elm_Transit.
23513 * @note This API is one of the facades. It creates flip effect context
23514 * and add it's required APIs to elm_transit_effect_add.
23515 * @note This effect is applied to each pair of objects in the order they are listed
23516 * in the transit list of objects. The first object in the pair will be the
23517 * "front" object and the second will be the "back" object.
23519 * @see elm_transit_effect_add()
23521 * @param transit Transit object.
23522 * @param axis Flipping Axis(X or Y).
23523 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23524 * @return Flip effect context data.
23527 * @warning It is highly recommended just create a transit with this effect when
23528 * the window that the objects of the transit belongs has already been created.
23529 * This is because this effect needs the geometry information about the objects,
23530 * and if the window was not created yet, it can get a wrong information.
23532 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23535 * Add the Resizable Flip Effect to Elm_Transit.
23537 * @note This API is one of the facades. It creates resizable flip effect context
23538 * and add it's required APIs to elm_transit_effect_add.
23539 * @note This effect is applied to each pair of objects in the order they are listed
23540 * in the transit list of objects. The first object in the pair will be the
23541 * "front" object and the second will be the "back" object.
23543 * @see elm_transit_effect_add()
23545 * @param transit Transit object.
23546 * @param axis Flipping Axis(X or Y).
23547 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23548 * @return Resizable flip effect context data.
23551 * @warning It is highly recommended just create a transit with this effect when
23552 * the window that the objects of the transit belongs has already been created.
23553 * This is because this effect needs the geometry information about the objects,
23554 * and if the window was not created yet, it can get a wrong information.
23556 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23559 * Add the Wipe Effect to Elm_Transit.
23561 * @note This API is one of the facades. It creates wipe effect context
23562 * and add it's required APIs to elm_transit_effect_add.
23564 * @see elm_transit_effect_add()
23566 * @param transit Transit object.
23567 * @param type Wipe type. Hide or show.
23568 * @param dir Wipe Direction.
23569 * @return Wipe effect context data.
23572 * @warning It is highly recommended just create a transit with this effect when
23573 * the window that the objects of the transit belongs has already been created.
23574 * This is because this effect needs the geometry information about the objects,
23575 * and if the window was not created yet, it can get a wrong information.
23577 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23580 * Add the Color Effect to Elm_Transit.
23582 * @note This API is one of the facades. It creates color effect context
23583 * and add it's required APIs to elm_transit_effect_add.
23585 * @see elm_transit_effect_add()
23587 * @param transit Transit object.
23588 * @param from_r RGB R when effect begins.
23589 * @param from_g RGB G when effect begins.
23590 * @param from_b RGB B when effect begins.
23591 * @param from_a RGB A when effect begins.
23592 * @param to_r RGB R when effect ends.
23593 * @param to_g RGB G when effect ends.
23594 * @param to_b RGB B when effect ends.
23595 * @param to_a RGB A when effect ends.
23596 * @return Color effect context data.
23600 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);
23603 * Add the Fade Effect to Elm_Transit.
23605 * @note This API is one of the facades. It creates fade effect context
23606 * and add it's required APIs to elm_transit_effect_add.
23607 * @note This effect is applied to each pair of objects in the order they are listed
23608 * in the transit list of objects. The first object in the pair will be the
23609 * "before" object and the second will be the "after" object.
23611 * @see elm_transit_effect_add()
23613 * @param transit Transit object.
23614 * @return Fade effect context data.
23617 * @warning It is highly recommended just create a transit with this effect when
23618 * the window that the objects of the transit belongs has already been created.
23619 * This is because this effect needs the color information about the objects,
23620 * and if the window was not created yet, it can get a wrong information.
23622 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23625 * Add the Blend Effect to Elm_Transit.
23627 * @note This API is one of the facades. It creates blend effect context
23628 * and add it's required APIs to elm_transit_effect_add.
23629 * @note This effect is applied to each pair of objects in the order they are listed
23630 * in the transit list of objects. The first object in the pair will be the
23631 * "before" object and the second will be the "after" object.
23633 * @see elm_transit_effect_add()
23635 * @param transit Transit object.
23636 * @return Blend effect context data.
23639 * @warning It is highly recommended just create a transit with this effect when
23640 * the window that the objects of the transit belongs has already been created.
23641 * This is because this effect needs the color information about the objects,
23642 * and if the window was not created yet, it can get a wrong information.
23644 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23647 * Add the Rotation Effect to Elm_Transit.
23649 * @note This API is one of the facades. It creates rotation effect context
23650 * and add it's required APIs to elm_transit_effect_add.
23652 * @see elm_transit_effect_add()
23654 * @param transit Transit object.
23655 * @param from_degree Degree when effect begins.
23656 * @param to_degree Degree when effect is ends.
23657 * @return Rotation effect context data.
23660 * @warning It is highly recommended just create a transit with this effect when
23661 * the window that the objects of the transit belongs has already been created.
23662 * This is because this effect needs the geometry information about the objects,
23663 * and if the window was not created yet, it can get a wrong information.
23665 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23668 * Add the ImageAnimation Effect to Elm_Transit.
23670 * @note This API is one of the facades. It creates image animation effect context
23671 * and add it's required APIs to elm_transit_effect_add.
23672 * The @p images parameter is a list images paths. This list and
23673 * its contents will be deleted at the end of the effect by
23674 * elm_transit_effect_image_animation_context_free() function.
23678 * char buf[PATH_MAX];
23679 * Eina_List *images = NULL;
23680 * Elm_Transit *transi = elm_transit_add();
23682 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23683 * images = eina_list_append(images, eina_stringshare_add(buf));
23685 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23686 * images = eina_list_append(images, eina_stringshare_add(buf));
23687 * elm_transit_effect_image_animation_add(transi, images);
23691 * @see elm_transit_effect_add()
23693 * @param transit Transit object.
23694 * @param images Eina_List of images file paths. This list and
23695 * its contents will be deleted at the end of the effect by
23696 * elm_transit_effect_image_animation_context_free() function.
23697 * @return Image Animation effect context data.
23701 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23706 typedef struct _Elm_Store Elm_Store;
23707 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23708 typedef struct _Elm_Store_Item Elm_Store_Item;
23709 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23710 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23711 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23712 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23713 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23714 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23715 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23716 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23718 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23719 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23720 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23721 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23725 ELM_STORE_ITEM_MAPPING_NONE = 0,
23726 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23727 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23728 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23729 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23730 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23731 // can add more here as needed by common apps
23732 ELM_STORE_ITEM_MAPPING_LAST
23733 } Elm_Store_Item_Mapping_Type;
23735 struct _Elm_Store_Item_Mapping_Icon
23737 // FIXME: allow edje file icons
23739 Elm_Icon_Lookup_Order lookup_order;
23740 Eina_Bool standard_name : 1;
23741 Eina_Bool no_scale : 1;
23742 Eina_Bool smooth : 1;
23743 Eina_Bool scale_up : 1;
23744 Eina_Bool scale_down : 1;
23747 struct _Elm_Store_Item_Mapping_Empty
23752 struct _Elm_Store_Item_Mapping_Photo
23757 struct _Elm_Store_Item_Mapping_Custom
23759 Elm_Store_Item_Mapping_Cb func;
23762 struct _Elm_Store_Item_Mapping
23764 Elm_Store_Item_Mapping_Type type;
23769 Elm_Store_Item_Mapping_Empty empty;
23770 Elm_Store_Item_Mapping_Icon icon;
23771 Elm_Store_Item_Mapping_Photo photo;
23772 Elm_Store_Item_Mapping_Custom custom;
23773 // add more types here
23777 struct _Elm_Store_Item_Info
23779 Elm_Genlist_Item_Class *item_class;
23780 const Elm_Store_Item_Mapping *mapping;
23785 struct _Elm_Store_Item_Info_Filesystem
23787 Elm_Store_Item_Info base;
23791 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23792 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23794 EAPI void elm_store_free(Elm_Store *st);
23796 EAPI Elm_Store *elm_store_filesystem_new(void);
23797 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23798 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23799 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23801 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23803 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23804 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23805 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23806 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23807 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23808 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23810 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23811 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23812 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23813 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23814 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23815 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23816 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23819 * @defgroup SegmentControl SegmentControl
23820 * @ingroup Elementary
23822 * @image html img/widget/segment_control/preview-00.png
23823 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23825 * @image html img/segment_control.png
23826 * @image latex img/segment_control.eps width=\textwidth
23828 * Segment control widget is a horizontal control made of multiple segment
23829 * items, each segment item functioning similar to discrete two state button.
23830 * A segment control groups the items together and provides compact
23831 * single button with multiple equal size segments.
23833 * Segment item size is determined by base widget
23834 * size and the number of items added.
23835 * Only one segment item can be at selected state. A segment item can display
23836 * combination of Text and any Evas_Object like Images or other widget.
23838 * Smart callbacks one can listen to:
23839 * - "changed" - When the user clicks on a segment item which is not
23840 * previously selected and get selected. The event_info parameter is the
23841 * segment item index.
23843 * Available styles for it:
23846 * Here is an example on its usage:
23847 * @li @ref segment_control_example
23851 * @addtogroup SegmentControl
23855 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23858 * Add a new segment control widget to the given parent Elementary
23859 * (container) object.
23861 * @param parent The parent object.
23862 * @return a new segment control widget handle or @c NULL, on errors.
23864 * This function inserts a new segment control widget on the canvas.
23866 * @ingroup SegmentControl
23868 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23871 * Append a new item to the segment control object.
23873 * @param obj The segment control object.
23874 * @param icon The icon object to use for the left side of the item. An
23875 * icon can be any Evas object, but usually it is an icon created
23876 * with elm_icon_add().
23877 * @param label The label of the item.
23878 * Note that, NULL is different from empty string "".
23879 * @return The created item or @c NULL upon failure.
23881 * A new item will be created and appended to the segment control, i.e., will
23882 * be set as @b last item.
23884 * If it should be inserted at another position,
23885 * elm_segment_control_item_insert_at() should be used instead.
23887 * Items created with this function can be deleted with function
23888 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23890 * @note @p label set to @c NULL is different from empty string "".
23892 * only has icon, it will be displayed bigger and centered. If it has
23893 * icon and label, even that an empty string, icon will be smaller and
23894 * positioned at left.
23898 * sc = elm_segment_control_add(win);
23899 * ic = elm_icon_add(win);
23900 * elm_icon_file_set(ic, "path/to/image", NULL);
23901 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23902 * elm_segment_control_item_add(sc, ic, "label");
23903 * evas_object_show(sc);
23906 * @see elm_segment_control_item_insert_at()
23907 * @see elm_segment_control_item_del()
23909 * @ingroup SegmentControl
23911 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23914 * Insert a new item to the segment control object at specified position.
23916 * @param obj The segment control object.
23917 * @param icon The icon object to use for the left side of the item. An
23918 * icon can be any Evas object, but usually it is an icon created
23919 * with elm_icon_add().
23920 * @param label The label of the item.
23921 * @param index Item position. Value should be between 0 and items count.
23922 * @return The created item or @c NULL upon failure.
23924 * Index values must be between @c 0, when item will be prepended to
23925 * segment control, and items count, that can be get with
23926 * elm_segment_control_item_count_get(), case when item will be appended
23927 * to segment control, just like elm_segment_control_item_add().
23929 * Items created with this function can be deleted with function
23930 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23932 * @note @p label set to @c NULL is different from empty string "".
23934 * only has icon, it will be displayed bigger and centered. If it has
23935 * icon and label, even that an empty string, icon will be smaller and
23936 * positioned at left.
23938 * @see elm_segment_control_item_add()
23939 * @see elm_segment_control_count_get()
23940 * @see elm_segment_control_item_del()
23942 * @ingroup SegmentControl
23944 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);
23947 * Remove a segment control item from its parent, deleting it.
23949 * @param it The item to be removed.
23951 * Items can be added with elm_segment_control_item_add() or
23952 * elm_segment_control_item_insert_at().
23954 * @ingroup SegmentControl
23956 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23959 * Remove a segment control item at given index from its parent,
23962 * @param obj The segment control object.
23963 * @param index The position of the segment control item to be deleted.
23965 * Items can be added with elm_segment_control_item_add() or
23966 * elm_segment_control_item_insert_at().
23968 * @ingroup SegmentControl
23970 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23973 * Get the Segment items count from segment control.
23975 * @param obj The segment control object.
23976 * @return Segment items count.
23978 * It will just return the number of items added to segment control @p obj.
23980 * @ingroup SegmentControl
23982 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23985 * Get the item placed at specified index.
23987 * @param obj The segment control object.
23988 * @param index The index of the segment item.
23989 * @return The segment control item or @c NULL on failure.
23991 * Index is the position of an item in segment control widget. Its
23992 * range is from @c 0 to <tt> count - 1 </tt>.
23993 * Count is the number of items, that can be get with
23994 * elm_segment_control_item_count_get().
23996 * @ingroup SegmentControl
23998 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24001 * Get the label of item.
24003 * @param obj The segment control object.
24004 * @param index The index of the segment item.
24005 * @return The label of the item at @p index.
24007 * The return value is a pointer to the label associated to the item when
24008 * it was created, with function elm_segment_control_item_add(), or later
24009 * with function elm_segment_control_item_label_set. If no label
24010 * was passed as argument, it will return @c NULL.
24012 * @see elm_segment_control_item_label_set() for more details.
24013 * @see elm_segment_control_item_add()
24015 * @ingroup SegmentControl
24017 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24020 * Set the label of item.
24022 * @param it The item of segment control.
24023 * @param text The label of item.
24025 * The label to be displayed by the item.
24026 * Label will be at right of the icon (if set).
24028 * If a label was passed as argument on item creation, with function
24029 * elm_control_segment_item_add(), it will be already
24030 * displayed by the item.
24032 * @see elm_segment_control_item_label_get()
24033 * @see elm_segment_control_item_add()
24035 * @ingroup SegmentControl
24037 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
24040 * Get the icon associated to the item.
24042 * @param obj The segment control object.
24043 * @param index The index of the segment item.
24044 * @return The left side icon associated to the item at @p index.
24046 * The return value is a pointer to the icon associated to the item when
24047 * it was created, with function elm_segment_control_item_add(), or later
24048 * with function elm_segment_control_item_icon_set(). If no icon
24049 * was passed as argument, it will return @c NULL.
24051 * @see elm_segment_control_item_add()
24052 * @see elm_segment_control_item_icon_set()
24054 * @ingroup SegmentControl
24056 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24059 * Set the icon associated to the item.
24061 * @param it The segment control item.
24062 * @param icon The icon object to associate with @p it.
24064 * The icon object to use at left side of the item. An
24065 * icon can be any Evas object, but usually it is an icon created
24066 * with elm_icon_add().
24068 * Once the icon object is set, a previously set one will be deleted.
24069 * @warning Setting the same icon for two items will cause the icon to
24070 * dissapear from the first item.
24072 * If an icon was passed as argument on item creation, with function
24073 * elm_segment_control_item_add(), it will be already
24074 * associated to the item.
24076 * @see elm_segment_control_item_add()
24077 * @see elm_segment_control_item_icon_get()
24079 * @ingroup SegmentControl
24081 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24084 * Get the index of an item.
24086 * @param it The segment control item.
24087 * @return The position of item in segment control widget.
24089 * Index is the position of an item in segment control widget. Its
24090 * range is from @c 0 to <tt> count - 1 </tt>.
24091 * Count is the number of items, that can be get with
24092 * elm_segment_control_item_count_get().
24094 * @ingroup SegmentControl
24096 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24099 * Get the base object of the item.
24101 * @param it The segment control item.
24102 * @return The base object associated with @p it.
24104 * Base object is the @c Evas_Object that represents that item.
24106 * @ingroup SegmentControl
24108 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24111 * Get the selected item.
24113 * @param obj The segment control object.
24114 * @return The selected item or @c NULL if none of segment items is
24117 * The selected item can be unselected with function
24118 * elm_segment_control_item_selected_set().
24120 * The selected item always will be highlighted on segment control.
24122 * @ingroup SegmentControl
24124 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24127 * Set the selected state of an item.
24129 * @param it The segment control item
24130 * @param select The selected state
24132 * This sets the selected state of the given item @p it.
24133 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24135 * If a new item is selected the previosly selected will be unselected.
24136 * Previoulsy selected item can be get with function
24137 * elm_segment_control_item_selected_get().
24139 * The selected item always will be highlighted on segment control.
24141 * @see elm_segment_control_item_selected_get()
24143 * @ingroup SegmentControl
24145 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24152 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24153 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24154 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24155 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24156 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24157 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24158 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24159 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24162 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
24163 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
24164 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
24166 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24167 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24168 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24169 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24170 EAPI void elm_video_play(Evas_Object *video);
24171 EAPI void elm_video_pause(Evas_Object *video);
24172 EAPI void elm_video_stop(Evas_Object *video);
24173 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24174 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24175 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24176 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24177 EAPI double elm_video_audio_level_get(Evas_Object *video);
24178 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24179 EAPI double elm_video_play_position_get(Evas_Object *video);
24180 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24181 EAPI double elm_video_play_length_get(Evas_Object *video);
24182 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24183 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24184 EAPI const char *elm_video_title_get(Evas_Object *video);
24186 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24187 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24190 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24191 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);
24192 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24193 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24194 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24195 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24196 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24197 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24198 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24199 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24200 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24201 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24202 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24203 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24204 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);