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>
55 * #ifndef ELM_LIB_QUICKLAUNCH
57 * elm_main(int argc, char **argv)
59 * // create window(s) here and do any application init
60 * elm_run(); // run main loop
61 * elm_shutdown(); // after mainloop finishes running, shutdown
62 * return 0; // exit 0 for exit code
68 * To take full advantage of the quicklaunch architecture for launching
69 * processes as quickly as possible (saving time at startup time like
70 * connecting to X11, loading and linking shared libraries) you may want to
71 * use the following configure.in/configure.ac and Makefile.am and autogen.sh
72 * script to generate your files. It is assumed your application uses the
73 * main.c file for its code.
75 * configure.in/configure.ac:
78 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
80 AC_CONFIG_SRCDIR(configure.in)
82 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
83 AM_CONFIG_HEADER(config.h)
93 define([AC_LIBTOOL_LANG_CXX_CONFIG], [:])dnl
94 define([AC_LIBTOOL_LANG_F77_CONFIG], [:])dnl
97 PKG_CHECK_MODULES([ELEMENTARY], elementary)
105 AUTOMAKE_OPTIONS = 1.4 foreign
106 MAINTAINERCLEANFILES = Makefile.in
108 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
111 myapp_LTLIBRARIES = myapp.la
115 myapp_la_SOURCES = main.c
116 myapp_la_LIBADD = @ELEMENTARY_LIBS@
118 myapp_la_LDFLAGS = -module -avoid-version -no-undefined
120 myapp_SOURCES = main.c
121 myapp_LDADD = @ELEMENTARY_LIBS@
122 myapp_CFLAGS = -DELM_LIB_QUICKLAUNCH=1
129 rm -rf autom4te.cache
130 rm -f aclocal.m4 ltmain.sh
135 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS -I m4 || exit 1
136 echo "Running autoheader..." ; autoheader || exit 1
137 echo "Running autoconf..." ; autoconf || exit 1
138 echo "Running libtoolize..." ; (libtoolize --copy --automake || glibtoolize --automake) || exit 1
139 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
141 if [ -z "$NOCONFIGURE" ]; then
146 * To generate all the things needed to bootstrap just run:
152 * This will generate Makefile.in's, the confgure script and everything else.
153 * After this it works like all normal autotools projects:
160 * Note sudo was assumed to get root permissions, as this would install in
161 * /usr/local which is system-owned. Use any way you like to gain root, or
162 * specify a different prefix with configure:
165 ./confiugre --prefix=$HOME/mysoftware
168 * Also remember that autotools buys you some useful commands like:
173 * This uninstalls the software after it was installed with "make install".
174 * It is very useful to clear up what you built if you wish to clean the
181 * This firstly checks if your build tree is "clean" and ready for
182 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
183 * ready to upload and distribute to the world, that contains the generated
184 * Makefile.in's and configure script. The users do not need to run
185 * autogen.sh - just configure and on. They don't need autotools installed.
186 * This tarball also builds cleanly, has all the sources it needs to build
187 * included (that is sources for your application, not libraries it depends
188 * on like Elementary). It builds cleanly in a buildroot and does not
189 * contain any files that are temporarily generated like binaries and other
190 * build-generated files, so the tarball is clean, and no need to worry
191 * about cleaning up your tree before packaging.
197 * This cleans up all build files (binaries, objects etc.) from the tree.
203 * This cleans out all files from the build and from configure's output too.
206 make maintainer-clean
209 * This deletes all the files autogen.sh will produce so the tree is clean
210 * to be put into a revision-control system (like CVS, SVN or GIT for example).
212 * The above will build a library - libmyapp.so and install in the target
213 * library directory (default is /usr/local/lib). You will also get a
214 * myapp.a and myapp.la - these are useless and can be deleted. Libtool likes
215 * to generate these all the time. You will also get a binary in the target
216 * binary directory (default is /usr/local/bin). This is a "debug binary".
217 * This will run and dlopen() the myapp.so and then jump to it's elm_main
218 * function. This allows for easy debugging with GDB and Valgrind. When you
219 * are ready to go to production do the following:
221 * 1. delete the myapp binary. i.e. rm /usr/local/bin/myapp
223 * 2. symlink the myapp binary to elementary_run (supplied by elementary).
224 * i.e. ln -s elmentary_run /usr/local/bin/myapp
226 * 3. run elementary_quicklaunch as part of your graphical login session and
229 * This will man elementary_quicklaunch does pre-initialization before the
230 * application needs to be run, saving the effort at the time the application
231 * is needed, thus speeding up the time it takes to appear.
233 * If you don't want to use the quicklaunch infrastructure (which is
234 * optional), you can execute the old fashioned way by just running the
235 * myapp binary loader than will load the myapp.so for you, or you can
236 * remove the split-file binary and put it into one binary as things always
237 * have been with the following configure.in/configure.ac and Makfile.am
240 * configure.in/configure.ac:
243 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
245 AC_CONFIG_SRCDIR(configure.in)
247 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
248 AM_CONFIG_HEADER(config.h)
257 PKG_CHECK_MODULES([ELEMENTARY], elementary)
265 AUTOMAKE_OPTIONS = 1.4 foreign
266 MAINTAINERCLEANFILES = Makefile.in
268 INCLUDES = -I$(top_srcdir) @ELEMENTARY_CFLAGS@
272 myapp_SOURCES = main.c
273 myapp_LDADD = @ELEMENTARY_LIBS@
277 * Notice that they are the same as before, just with libtool and library
278 * building sections removed. Both ways work for building elementary
279 * applications. It is up to you to decide what is best for you. If you just
280 * follow the template above, you can do it both ways and can decide at build
281 * time. The more advanced of you may suggest making it a configure option.
282 * That is perfectly valid, but has been left out here for simplicity, as our
283 * aim to have an Elementary (and EFL) tutorial, not an autoconf & automake
289 @page authors Authors
290 @author Carsten Haitzler <raster@@rasterman.com>
291 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
292 @author Cedric Bail <cedric.bail@@free.fr>
293 @author Vincent Torri <vtorri@@univ-evry.fr>
294 @author Daniel Kolesa <quaker66@@gmail.com>
295 @author Jaime Thomas <avi.thomas@@gmail.com>
296 @author Swisscom - http://www.swisscom.ch/
297 @author Christopher Michael <devilhorns@@comcast.net>
298 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
299 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
300 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
301 @author Brian Wang <brian.wang.0721@@gmail.com>
302 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
303 @author Samsung Electronics <tbd>
304 @author Samsung SAIT <tbd>
305 @author Brett Nash <nash@@nash.id.au>
306 @author Bruno Dilly <bdilly@@profusion.mobi>
307 @author Rafael Fonseca <rfonseca@@profusion.mobi>
308 @author Chuneon Park <hermet@@hermet.pe.kr>
309 @author Woohyun Jung <wh0705.jung@@samsung.com>
310 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
311 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
312 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
313 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
314 @author Gustavo Lima Chaves <glima@@profusion.mobi>
315 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
316 @author Tiago Falcão <tiago@@profusion.mobi>
317 @author Otavio Pontes <otavio@@profusion.mobi>
318 @author Viktor Kojouharov <vkojouharov@@gmail.com>
319 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
320 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
321 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
322 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
323 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
324 @author Jihoon Kim <jihoon48.kim@@samsung.com>
325 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
326 @author Tom Hacohen <tom@@stosb.com>
327 @author Aharon Hillel <a.hillel@@partner.samsung.com>
328 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
329 @author Shinwoo Kim <kimcinoo@@gmail.com>
330 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
331 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
333 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
334 contact with the developers and maintainers.
342 * @brief Elementary's API
347 @ELM_UNIX_DEF@ ELM_UNIX
348 @ELM_WIN32_DEF@ ELM_WIN32
349 @ELM_WINCE_DEF@ ELM_WINCE
350 @ELM_EDBUS_DEF@ ELM_EDBUS
351 @ELM_EFREET_DEF@ ELM_EFREET
352 @ELM_ETHUMB_DEF@ ELM_ETHUMB
353 @ELM_EMAP_DEF@ ELM_EMAP
354 @ELM_DEBUG_DEF@ ELM_DEBUG
355 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
356 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
358 /* Standard headers for standard system calls etc. */
363 #include <sys/types.h>
364 #include <sys/stat.h>
365 #include <sys/time.h>
366 #include <sys/param.h>
379 # ifdef ELM_LIBINTL_H
380 # include <libintl.h>
391 #if defined (ELM_WIN32) || defined (ELM_WINCE)
394 # define alloca _alloca
405 #include <Ecore_Evas.h>
406 #include <Ecore_File.h>
407 #include <Ecore_IMF.h>
408 #include <Ecore_Con.h>
417 # include <Efreet_Mime.h>
418 # include <Efreet_Trash.h>
422 # include <Ethumb_Client.h>
434 # ifdef ELEMENTARY_BUILD
436 # define EAPI __declspec(dllexport)
439 # endif /* ! DLL_EXPORT */
441 # define EAPI __declspec(dllimport)
442 # endif /* ! EFL_EVAS_BUILD */
446 # define EAPI __attribute__ ((visibility("default")))
453 #endif /* ! _WIN32 */
456 /* allow usage from c++ */
461 #define ELM_VERSION_MAJOR @VMAJ@
462 #define ELM_VERSION_MINOR @VMIN@
464 typedef struct _Elm_Version
472 EAPI extern Elm_Version *elm_version;
475 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
476 #define ELM_PI 3.14159265358979323846
479 * @defgroup General General
481 * @brief General Elementary API. Functions that don't relate to
482 * Elementary objects specifically.
484 * Here are documented functions which init/shutdown the library,
485 * that apply to generic Elementary objects, that deal with
486 * configuration, et cetera.
488 * @ref general_functions_example_page "This" example contemplates
489 * some of these functions.
493 * @addtogroup General
498 * Defines couple of standard Evas_Object layers to be used
499 * with evas_object_layer_set().
501 * @note whenever extending with new values, try to keep some padding
502 * to siblings so there is room for further extensions.
504 typedef enum _Elm_Object_Layer
506 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
507 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
508 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
509 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
510 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
511 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
514 /**************************************************************************/
515 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
518 * Emitted when any Elementary's policy value is changed.
520 EAPI extern int ELM_EVENT_POLICY_CHANGED;
523 * @typedef Elm_Event_Policy_Changed
525 * Data on the event when an Elementary policy has changed
527 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
530 * @struct _Elm_Event_Policy_Changed
532 * Data on the event when an Elementary policy has changed
534 struct _Elm_Event_Policy_Changed
536 unsigned int policy; /**< the policy identifier */
537 int new_value; /**< value the policy had before the change */
538 int old_value; /**< new value the policy got */
542 * Policy identifiers.
544 typedef enum _Elm_Policy
546 ELM_POLICY_QUIT, /**< under which circunstances the application
547 * should quit automatically. @see
551 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
554 typedef enum _Elm_Policy_Quit
556 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
558 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
560 * window is closed */
561 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
563 typedef enum _Elm_Focus_Direction
567 } Elm_Focus_Direction;
569 typedef enum _Elm_Text_Format
571 ELM_TEXT_FORMAT_PLAIN_UTF8,
572 ELM_TEXT_FORMAT_MARKUP_UTF8
576 * Line wrapping types.
578 typedef enum _Elm_Wrap_Type
580 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
581 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
582 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
583 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
588 * @typedef Elm_Object_Item
589 * An Elementary Object item handle.
592 typedef struct _Elm_Object_Item Elm_Object_Item;
596 * Called back when a widget's tooltip is activated and needs content.
597 * @param data user-data given to elm_object_tooltip_content_cb_set()
598 * @param obj owner widget.
599 * @param tooltip The tooltip object (affix content to this!)
601 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
604 * Called back when a widget's item tooltip is activated and needs content.
605 * @param data user-data given to elm_object_tooltip_content_cb_set()
606 * @param obj owner widget.
607 * @param tooltip The tooltip object (affix content to this!)
608 * @param item context dependent item. As an example, if tooltip was
609 * set on Elm_List_Item, then it is of this type.
611 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
613 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
615 #ifndef ELM_LIB_QUICKLAUNCH
616 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
618 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
621 /**************************************************************************/
625 * Initialize Elementary
627 * @param[in] argc System's argument count value
628 * @param[in] argv System's pointer to array of argument strings
629 * @return The init counter value.
631 * This function initializes Elementary and increments a counter of
632 * the number of calls to it. It returs the new counter's value.
634 * @warning This call is exported only for use by the @c ELM_MAIN()
635 * macro. There is no need to use this if you use this macro (which
636 * is highly advisable). An elm_main() should contain the entry
637 * point code for your application, having the same prototype as
638 * elm_init(), and @b not being static (putting the @c EAPI symbol
639 * in front of its type declaration is advisable). The @c
640 * ELM_MAIN() call should be placed just after it.
643 * @dontinclude bg_example_01.c
647 * See the full @ref bg_example_01_c "example".
649 * @see elm_shutdown().
652 EAPI int elm_init(int argc, char **argv);
655 * Shut down Elementary
657 * @return The init counter value.
659 * This should be called at the end of your application, just
660 * before it ceases to do any more processing. This will clean up
661 * any permanent resources your application may have allocated via
662 * Elementary that would otherwise persist.
664 * @see elm_init() for an example
668 EAPI int elm_shutdown(void);
671 * Run Elementary's main loop
673 * This call should be issued just after all initialization is
674 * completed. This function will not return until elm_exit() is
675 * called. It will keep looping, running the main
676 * (event/processing) loop for Elementary.
678 * @see elm_init() for an example
682 EAPI void elm_run(void);
685 * Exit Elementary's main loop
687 * If this call is issued, it will flag the main loop to cease
688 * processing and return back to its parent function (usually your
689 * elm_main() function).
691 * @see elm_init() for an example. There, just after a request to
692 * close the window comes, the main loop will be left.
694 * @note By using the #ELM_POLICY_QUIT on your Elementary
695 * applications, you'll this function called automatically for you.
699 EAPI void elm_exit(void);
702 * Provide information in order to make Elementary determine the @b
703 * run time location of the software in question, so other data files
704 * such as images, sound files, executable utilities, libraries,
705 * modules and locale files can be found.
707 * @param mainfunc This is your application's main function name,
708 * whose binary's location is to be found. Providing @c NULL
709 * will make Elementary not to use it
710 * @param dom This will be used as the application's "domain", in the
711 * form of a prefix to any environment variables that may
712 * override prefix detection and the directory name, inside the
713 * standard share or data directories, where the software's
714 * data files will be looked for.
715 * @param checkfile This is an (optional) magic file's path to check
716 * for existence (and it must be located in the data directory,
717 * under the share directory provided above). Its presence will
718 * help determine the prefix found was correct. Pass @c NULL if
719 * the check is not to be done.
721 * This function allows one to re-locate the application somewhere
722 * else after compilation, if the developer wishes for easier
723 * distribution of pre-compiled binaries.
725 * The prefix system is designed to locate where the given software is
726 * installed (under a common path prefix) at run time and then report
727 * specific locations of this prefix and common directories inside
728 * this prefix like the binary, library, data and locale directories,
729 * through the @c elm_app_*_get() family of functions.
731 * Call elm_app_info_set() early on before you change working
732 * directory or anything about @c argv[0], so it gets accurate
735 * It will then try and trace back which file @p mainfunc comes from,
736 * if provided, to determine the application's prefix directory.
738 * The @p dom parameter provides a string prefix to prepend before
739 * environment variables, allowing a fallback to @b specific
740 * environment variables to locate the software. You would most
741 * probably provide a lowercase string there, because it will also
742 * serve as directory domain, explained next. For environment
743 * variables purposes, this string is made uppercase. For example if
744 * @c "myapp" is provided as the prefix, then the program would expect
745 * @c "MYAPP_PREFIX" as a master environment variable to specify the
746 * exact install prefix for the software, or more specific environment
747 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
748 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
749 * the user or scripts before launching. If not provided (@c NULL),
750 * environment variables will not be used to override compiled-in
751 * defaults or auto detections.
753 * The @p dom string also provides a subdirectory inside the system
754 * shared data directory for data files. For example, if the system
755 * directory is @c /usr/local/share, then this directory name is
756 * appended, creating @c /usr/local/share/myapp, if it @p was @c
757 * "myapp". It is expected the application installs data files in
760 * The @p checkfile is a file name or path of something inside the
761 * share or data directory to be used to test that the prefix
762 * detection worked. For example, your app will install a wallpaper
763 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
764 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
767 * @see elm_app_compile_bin_dir_set()
768 * @see elm_app_compile_lib_dir_set()
769 * @see elm_app_compile_data_dir_set()
770 * @see elm_app_compile_locale_set()
771 * @see elm_app_prefix_dir_get()
772 * @see elm_app_bin_dir_get()
773 * @see elm_app_lib_dir_get()
774 * @see elm_app_data_dir_get()
775 * @see elm_app_locale_dir_get()
777 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
780 * Provide information on the @b fallback application's binaries
781 * directory, on scenarios where they get overriden by
782 * elm_app_info_set().
784 * @param dir The path to the default binaries directory (compile time
787 * @note Elementary will as well use this path to determine actual
788 * names of binaries' directory paths, maybe changing it to be @c
789 * something/local/bin instead of @c something/bin, only, for
792 * @warning You should call this function @b before
793 * elm_app_info_set().
795 EAPI void elm_app_compile_bin_dir_set(const char *dir);
798 * Provide information on the @b fallback application's libraries
799 * directory, on scenarios where they get overriden by
800 * elm_app_info_set().
802 * @param dir The path to the default libraries directory (compile
805 * @note Elementary will as well use this path to determine actual
806 * names of libraries' directory paths, maybe changing it to be @c
807 * something/lib32 or @c something/lib64 instead of @c something/lib,
810 * @warning You should call this function @b before
811 * elm_app_info_set().
813 EAPI void elm_app_compile_lib_dir_set(const char *dir);
816 * Provide information on the @b fallback application's data
817 * directory, on scenarios where they get overriden by
818 * elm_app_info_set().
820 * @param dir The path to the default data directory (compile time
823 * @note Elementary will as well use this path to determine actual
824 * names of data directory paths, maybe changing it to be @c
825 * something/local/share instead of @c something/share, only, for
828 * @warning You should call this function @b before
829 * elm_app_info_set().
831 EAPI void elm_app_compile_data_dir_set(const char *dir);
834 * Provide information on the @b fallback application's locale
835 * directory, on scenarios where they get overriden by
836 * elm_app_info_set().
838 * @param dir The path to the default locale directory (compile time
841 * @warning You should call this function @b before
842 * elm_app_info_set().
844 EAPI void elm_app_compile_locale_set(const char *dir);
847 * Retrieve the application's run time prefix directory, as set by
848 * elm_app_info_set() and the way (environment) the application was
851 * @return The directory prefix the application is actually using
853 EAPI const char *elm_app_prefix_dir_get(void);
856 * Retrieve the application's run time binaries prefix directory, as
857 * set by elm_app_info_set() and the way (environment) the application
860 * @return The binaries directory prefix the application is actually
863 EAPI const char *elm_app_bin_dir_get(void);
866 * Retrieve the application's run time libraries prefix directory, as
867 * set by elm_app_info_set() and the way (environment) the application
870 * @return The libraries directory prefix the application is actually
873 EAPI const char *elm_app_lib_dir_get(void);
876 * Retrieve the application's run time data prefix directory, as
877 * set by elm_app_info_set() and the way (environment) the application
880 * @return The data directory prefix the application is actually
883 EAPI const char *elm_app_data_dir_get(void);
886 * Retrieve the application's run time locale prefix directory, as
887 * set by elm_app_info_set() and the way (environment) the application
890 * @return The locale directory prefix the application is actually
893 EAPI const char *elm_app_locale_dir_get(void);
895 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
896 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
897 EAPI int elm_quicklaunch_init(int argc, char **argv);
898 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
899 EAPI int elm_quicklaunch_sub_shutdown(void);
900 EAPI int elm_quicklaunch_shutdown(void);
901 EAPI void elm_quicklaunch_seed(void);
902 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
903 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
904 EAPI void elm_quicklaunch_cleanup(void);
905 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
906 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
908 EAPI Eina_Bool elm_need_efreet(void);
909 EAPI Eina_Bool elm_need_e_dbus(void);
910 EAPI Eina_Bool elm_need_ethumb(void);
913 * Set a new policy's value (for a given policy group/identifier).
915 * @param policy policy identifier, as in @ref Elm_Policy.
916 * @param value policy value, which depends on the identifier
918 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
920 * Elementary policies define applications' behavior,
921 * somehow. These behaviors are divided in policy groups (see
922 * #Elm_Policy enumeration). This call will emit the Ecore event
923 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
924 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
927 * @note Currently, we have only one policy identifier/group
928 * (#ELM_POLICY_QUIT), which has two possible values.
932 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
935 * Gets the policy value set for given policy identifier.
937 * @param policy policy identifier, as in #Elm_Policy.
938 * @return The currently set policy value, for that
939 * identifier. Will be @c 0 if @p policy passed is invalid.
943 EAPI int elm_policy_get(unsigned int policy);
946 * Set a label of an object
948 * @param obj The Elementary object
949 * @param part The text part name to set (NULL for the default label)
950 * @param label The new text of the label
952 * @note Elementary objects may have many labels (e.g. Action Slider)
956 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
958 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
961 * Get a label of an object
963 * @param obj The Elementary object
964 * @param part The text part name to get (NULL for the default label)
965 * @return text of the label or NULL for any error
967 * @note Elementary objects may have many labels (e.g. Action Slider)
971 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
973 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
976 * Set a content of an object
978 * @param obj The Elementary object
979 * @param part The content part name to set (NULL for the default content)
980 * @param content The new content of the object
982 * @note Elementary objects may have many contents
986 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
988 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
991 * Get a content of an object
993 * @param obj The Elementary object
994 * @param item The content part name to get (NULL for the default content)
995 * @return content of the object or NULL for any error
997 * @note Elementary objects may have many contents
1001 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1003 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1006 * Unset a content of an object
1008 * @param obj The Elementary object
1009 * @param item The content part name to unset (NULL for the default content)
1011 * @note Elementary objects may have many contents
1015 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1017 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1020 * Set a content of an object item
1022 * @param it The Elementary object item
1023 * @param part The content part name to unset (NULL for the default content)
1024 * @param content The new content of the object item
1026 * @note Elementary object items may have many contents
1030 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1032 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1035 * Get a content of an object item
1037 * @param it The Elementary object item
1038 * @param part The content part name to unset (NULL for the default content)
1039 * @return content of the object item or NULL for any error
1041 * @note Elementary object items may have many contents
1045 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1047 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1050 * Unset a content of an object item
1052 * @param it The Elementary object item
1053 * @param part The content part name to unset (NULL for the default content)
1055 * @note Elementary object items may have many contents
1059 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1061 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1064 * Set a label of an objec itemt
1066 * @param it The Elementary object item
1067 * @param part The text part name to set (NULL for the default label)
1068 * @param label The new text of the label
1070 * @note Elementary object items may have many labels
1074 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1076 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1079 * Get a label of an object
1081 * @param it The Elementary object item
1082 * @param part The text part name to get (NULL for the default label)
1083 * @return text of the label or NULL for any error
1085 * @note Elementary object items may have many labels
1089 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1091 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1097 EAPI void elm_all_flush(void);
1098 EAPI int elm_cache_flush_interval_get(void);
1099 EAPI void elm_cache_flush_interval_set(int size);
1100 EAPI void elm_cache_flush_interval_all_set(int size);
1101 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1102 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1103 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1104 EAPI int elm_font_cache_get(void);
1105 EAPI void elm_font_cache_set(int size);
1106 EAPI void elm_font_cache_all_set(int size);
1107 EAPI int elm_image_cache_get(void);
1108 EAPI void elm_image_cache_set(int size);
1109 EAPI void elm_image_cache_all_set(int size);
1110 EAPI int elm_edje_file_cache_get(void);
1111 EAPI void elm_edje_file_cache_set(int size);
1112 EAPI void elm_edje_file_cache_all_set(int size);
1113 EAPI int elm_edje_collection_cache_get(void);
1114 EAPI void elm_edje_collection_cache_set(int size);
1115 EAPI void elm_edje_collection_cache_all_set(int size);
1118 * @defgroup Scaling Selective Widget Scaling
1120 * Different widgets can be scaled independently. These functions
1121 * allow you to manipulate this scaling on a per-widget basis. The
1122 * object and all its children get their scaling factors multiplied
1123 * by the scale factor set. This is multiplicative, in that if a
1124 * child also has a scale size set it is in turn multiplied by its
1125 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1126 * double size, @c 0.5 is half, etc.
1128 * @ref general_functions_example_page "This" example contemplates
1129 * some of these functions.
1133 * Set the scaling factor for a given Elementary object
1135 * @param obj The Elementary to operate on
1136 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1141 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1144 * Get the scaling factor for a given Elementary object
1146 * @param obj The object
1147 * @return The scaling factor set by elm_object_scale_set()
1151 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1152 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1153 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1154 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1155 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1157 * Set the style to use by a widget
1159 * Sets the style name that will define the appearance of a widget. Styles
1160 * vary from widget to widget and may also be defined by other themes
1161 * by means of extensions and overlays.
1163 * @param obj The Elementary widget to style
1164 * @param style The style name to use
1166 * @see elm_theme_extension_add()
1167 * @see elm_theme_overlay_add()
1171 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1173 * Get the style used by the widget
1175 * This gets the style being used for that widget. Note that the string
1176 * pointer is only valid as longas the object is valid and the style doesn't
1179 * @param obj The Elementary widget to query for its style
1180 * @return The style name used
1182 * @see elm_object_style_set()
1186 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1189 * @defgroup Styles Styles
1191 * Widgets can have different styles of look. These generic API's
1192 * set styles of widgets, if they support them (and if the theme(s)
1195 * @ref general_functions_example_page "This" example contemplates
1196 * some of these functions.
1200 * Set the disabled state of an Elementary object.
1202 * @param obj The Elementary object to operate on
1203 * @param disabled The state to put in in: @c EINA_TRUE for
1204 * disabled, @c EINA_FALSE for enabled
1206 * Elementary objects can be @b disabled, in which state they won't
1207 * receive input and, in general, will be themed differently from
1208 * their normal state, usually greyed out. Useful for contexts
1209 * where you don't want your users to interact with some of the
1210 * parts of you interface.
1212 * This sets the state for the widget, either disabling it or
1217 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1220 * Get the disabled state of an Elementary object.
1222 * @param obj The Elementary object to operate on
1223 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1224 * if it's enabled (or on errors)
1226 * This gets the state of the widget, which might be enabled or disabled.
1230 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1233 * @defgroup WidgetNavigation Widget Tree Navigation.
1235 * How to check if an Evas Object is an Elementary widget? How to
1236 * get the first elementary widget that is parent of the given
1237 * object? These are all covered in widget tree navigation.
1239 * @ref general_functions_example_page "This" example contemplates
1240 * some of these functions.
1243 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1246 * Get the first parent of the given object that is an Elementary
1249 * @param obj the Elementary object to query parent from.
1250 * @return the parent object that is an Elementary widget, or @c
1251 * NULL, if it was not found.
1253 * Use this to query for an object's parent widget.
1255 * @note Most of Elementary users wouldn't be mixing non-Elementary
1256 * smart objects in the objects tree of an application, as this is
1257 * an advanced usage of Elementary with Evas. So, except for the
1258 * application's window, which is the root of that tree, all other
1259 * objects would have valid Elementary widget parents.
1261 * @ingroup WidgetNavigation
1263 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1264 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1265 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1267 EAPI double elm_scale_get(void);
1268 EAPI void elm_scale_set(double scale);
1269 EAPI void elm_scale_all_set(double scale);
1271 EAPI Eina_Bool elm_mirrored_get(void);
1272 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1274 EAPI Eina_Bool elm_config_save(void);
1275 EAPI void elm_config_reload(void);
1277 EAPI const char *elm_profile_current_get(void);
1278 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1279 EAPI void elm_profile_dir_free(const char *p_dir);
1280 EAPI Eina_List *elm_profile_list_get(void);
1281 EAPI void elm_profile_list_free(Eina_List *l);
1282 EAPI void elm_profile_set(const char *profile);
1283 EAPI void elm_profile_all_set(const char *profile);
1285 EAPI const char *elm_engine_current_get(void);
1286 EAPI void elm_engine_set(const char *engine);
1288 typedef struct _Elm_Text_Class
1294 typedef struct _Elm_Font_Overlay
1296 const char *text_class;
1298 Evas_Font_Size size;
1301 typedef struct _Elm_Font_Properties
1305 } Elm_Font_Properties;
1307 EAPI const Eina_List *elm_text_classes_list_get(void);
1308 EAPI void elm_text_classes_list_free(const Eina_List *list);
1310 EAPI const Eina_List *elm_font_overlay_list_get(void);
1311 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1312 EAPI void elm_font_overlay_unset(const char *text_class);
1313 EAPI void elm_font_overlay_apply(void);
1314 EAPI void elm_font_overlay_all_apply(void);
1316 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1317 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1318 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1319 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1320 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1321 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1324 * @defgroup Fingers Fingers
1326 * Elementary is designed to be finger-friendly for touchscreens,
1327 * and so in addition to scaling for display resolution, it can
1328 * also scale based on finger "resolution" (or size). You can then
1329 * customize the granularity of the areas meant to receive clicks
1332 * Different profiles may have pre-set values for finger sizes.
1334 * @ref general_functions_example_page "This" example contemplates
1335 * some of these functions.
1339 * Get the configured "finger size"
1341 * @return The finger size
1343 * This gets the globally configured finger size, <b>in pixels</b>
1347 EAPI Evas_Coord elm_finger_size_get(void);
1348 EAPI void elm_finger_size_set(Evas_Coord size);
1349 EAPI void elm_finger_size_all_set(Evas_Coord size);
1352 * @defgroup Focus Focus
1354 * An Elementary application has, at all times, one (and only one)
1355 * @b focused object. This is what determines where the input
1356 * events go to within the application's window. Also, focused
1357 * objects can be decorated differently, in order to signal to the
1358 * user where the input is, at a given moment.
1360 * Elementary applications also have the concept of <b>focus
1361 * chain</b>: one can cycle through all the windows' focusable
1362 * objects by input (tab key) or programmatically. The default
1363 * focus chain for an application is the one define by the order in
1364 * which the widgets where added in code. One will cycle through
1365 * top level widgets, and, for each one containg sub-objects, cycle
1366 * through them all, before returning to the level
1367 * above. Elementary also allows one to set @b custom focus chains
1368 * for their applications.
1370 * Besides the focused decoration a widget may exhibit, when it
1371 * gets focus, Elementary has a @b global focus highlight object
1372 * that can be enabled for a window. If one chooses to do so, this
1373 * extra highlight effect will surround the current focused object,
1376 * @note Some Elementary widgets are @b unfocusable, after
1377 * creation, by their very nature: they are not meant to be
1378 * interacted with input events, but are there just for visual
1381 * @ref general_functions_example_page "This" example contemplates
1382 * some of these functions.
1385 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1386 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1387 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1388 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1391 * Get the whether an Elementary object has the focus or not.
1393 * @param obj The Elementary object to get the information from
1394 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1395 * not (and on errors).
1397 * @see elm_object_focus()
1401 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1404 * Set/unset focus to a given Elementary object.
1406 * @param obj The Elementary object to operate on.
1407 * @param enable @c EINA_TRUE Set focus to a given object,
1408 * @c EINA_FALSE Unset focus to a given object.
1410 * @note When you set focus to this object, if it can handle focus, will
1411 * take the focus away from the one who had it previously and will, for
1412 * now on, be the one receiving input events. Unsetting focus will remove
1413 * the focus from @p obj, passing it back to the previous element in the
1416 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1420 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1423 * Make a given Elementary object the focused one.
1425 * @param obj The Elementary object to make focused.
1427 * @note This object, if it can handle focus, will take the focus
1428 * away from the one who had it previously and will, for now on, be
1429 * the one receiving input events.
1431 * @see elm_object_focus_get()
1432 * @deprecated use elm_object_focus_set() instead.
1436 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1439 * Remove the focus from an Elementary object
1441 * @param obj The Elementary to take focus from
1443 * This removes the focus from @p obj, passing it back to the
1444 * previous element in the focus chain list.
1446 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1447 * @deprecated use elm_object_focus_set() instead.
1451 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1454 * Set the ability for an Element object to be focused
1456 * @param obj The Elementary object to operate on
1457 * @param enable @c EINA_TRUE if the object can be focused, @c
1458 * EINA_FALSE if not (and on errors)
1460 * This sets whether the object @p obj is able to take focus or
1461 * not. Unfocusable objects do nothing when programmatically
1462 * focused, being the nearest focusable parent object the one
1463 * really getting focus. Also, when they receive mouse input, they
1464 * will get the event, but not take away the focus from where it
1469 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1472 * Get whether an Elementary object is focusable or not
1474 * @param obj The Elementary object to operate on
1475 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1476 * EINA_FALSE if not (and on errors)
1478 * @note Objects which are meant to be interacted with by input
1479 * events are created able to be focused, by default. All the
1484 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1486 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1487 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1488 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1489 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1490 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1491 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1492 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1495 * Make the elementary object and its children to be unfocusable (or focusable).
1497 * @param obj The Elementary object to operate on
1498 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1499 * @c EINA_FALSE for focusable.
1501 * This sets whether the object @p obj and its children objects
1502 * are able to take focus or not. If the tree is set as unfocusable,
1503 * newest focused object which is not in this tree will get focus.
1504 * This API can be helpful for an object to be deleted.
1505 * When an object will be deleted soon, it and its children may not
1506 * want to get focus (by focus reverting or by other focus controls).
1507 * Then, just use this API before deleting.
1509 * @see elm_object_tree_unfocusable_get()
1513 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1516 * Get whether an Elementary object and its children are unfocusable or not.
1518 * @param obj The Elementary object to get the information from
1519 * @return @c EINA_TRUE, if the tree is unfocussable,
1520 * @c EINA_FALSE if not (and on errors).
1522 * @see elm_object_tree_unfocusable_set()
1526 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1528 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1529 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1530 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1531 EAPI double elm_scroll_bounce_friction_get(void);
1532 EAPI void elm_scroll_bounce_friction_set(double friction);
1533 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1534 EAPI double elm_scroll_page_scroll_friction_get(void);
1535 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1536 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1537 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1538 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1539 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1540 EAPI double elm_scroll_zoom_friction_get(void);
1541 EAPI void elm_scroll_zoom_friction_set(double friction);
1542 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1543 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1544 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1545 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1546 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1547 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1548 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1549 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1550 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1551 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1552 EAPI double elm_scroll_thumbscroll_friction_get(void);
1553 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1554 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1555 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1556 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1557 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1559 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1560 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1561 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1562 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1564 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1565 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1566 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1568 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1569 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);
1570 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);
1572 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1573 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1576 * Adjust size of an element for finger usage.
1578 * @param times_w How many fingers should fit horizontally
1579 * @param w Pointer to the width size to adjust
1580 * @param times_h How many fingers should fit vertically
1581 * @param h Pointer to the height size to adjust
1583 * This takes width and height sizes (in pixels) as input and a
1584 * size multiple (which is how many fingers you want to place
1585 * within the area, being "finger" the size set by
1586 * elm_finger_size_set()), and adjusts the size to be large enough
1587 * to accommodate the resulting size -- if it doesn't already
1588 * accommodate it. On return the @p w and @p h sizes pointed to by
1589 * these parameters will be modified, on those conditions.
1591 * @note This is kind of a low level Elementary call, most useful
1592 * on size evaluation times for widgets. An external user wouldn't
1593 * be calling, most of the time.
1597 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1599 EAPI double elm_longpress_timeout_get(void);
1600 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1603 * don't use it unless you are sure
1605 EAPI void elm_object_tree_dump(const Evas_Object *top);
1606 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1611 * @defgroup Theme Theme
1613 * Elementary uses Edje to theme its widgets, naturally. But for the most
1614 * part this is hidden behind a simpler interface that lets the user set
1615 * extensions and choose the style of widgets in a much easier way.
1617 * Instead of thinking in terms of paths to Edje files and their groups
1618 * each time you want to change the appearance of a widget, Elementary
1619 * works so you can add any theme file with extensions or replace the
1620 * main theme at one point in the application, and then just set the style
1621 * of widgets with elm_object_style_set() and related functions. Elementary
1622 * will then look in its list of themes for a matching group and apply it,
1623 * and when the theme changes midway through the application, all widgets
1624 * will be updated accordingly.
1626 * There are three concepts you need to know to understand how Elementary
1627 * theming works: default theme, extensions and overlays.
1629 * Default theme, obviously enough, is the one that provides the default
1630 * look of all widgets. End users can change the theme used by Elementary
1631 * by setting the @c ELM_THEME environment variable before running an
1632 * application, or globally for all programs using the @c elementary_config
1633 * utility. Applications can change the default theme using elm_theme_set(),
1634 * but this can go against the user wishes, so it's not an adviced practice.
1636 * Ideally, applications should find everything they need in the already
1637 * provided theme, but there may be occasions when that's not enough and
1638 * custom styles are required to correctly express the idea. For this
1639 * cases, Elementary has extensions.
1641 * Extensions allow the application developer to write styles of its own
1642 * to apply to some widgets. This requires knowledge of how each widget
1643 * is themed, as extensions will always replace the entire group used by
1644 * the widget, so important signals and parts need to be there for the
1645 * object to behave properly (see documentation of Edje for details).
1646 * Once the theme for the extension is done, the application needs to add
1647 * it to the list of themes Elementary will look into, using
1648 * elm_theme_extension_add(), and set the style of the desired widgets as
1649 * he would normally with elm_object_style_set().
1651 * Overlays, on the other hand, can replace the look of all widgets by
1652 * overriding the default style. Like extensions, it's up to the application
1653 * developer to write the theme for the widgets it wants, the difference
1654 * being that when looking for the theme, Elementary will check first the
1655 * list of overlays, then the set theme and lastly the list of extensions,
1656 * so with overlays it's possible to replace the default view and every
1657 * widget will be affected. This is very much alike to setting the whole
1658 * theme for the application and will probably clash with the end user
1659 * options, not to mention the risk of ending up with not matching styles
1660 * across the program. Unless there's a very special reason to use them,
1661 * overlays should be avoided for the resons exposed before.
1663 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1664 * keeps one default internally and every function that receives one of
1665 * these can be called with NULL to refer to this default (except for
1666 * elm_theme_free()). It's possible to create a new instance of a
1667 * ::Elm_Theme to set other theme for a specific widget (and all of its
1668 * children), but this is as discouraged, if not even more so, than using
1669 * overlays. Don't use this unless you really know what you are doing.
1671 * But to be less negative about things, you can look at the following
1673 * @li @ref theme_example_01 "Using extensions"
1674 * @li @ref theme_example_02 "Using overlays"
1679 * @typedef Elm_Theme
1681 * Opaque handler for the list of themes Elementary looks for when
1682 * rendering widgets.
1684 * Stay out of this unless you really know what you are doing. For most
1685 * cases, sticking to the default is all a developer needs.
1687 typedef struct _Elm_Theme Elm_Theme;
1690 * Create a new specific theme
1692 * This creates an empty specific theme that only uses the default theme. A
1693 * specific theme has its own private set of extensions and overlays too
1694 * (which are empty by default). Specific themes do not fall back to themes
1695 * of parent objects. They are not intended for this use. Use styles, overlays
1696 * and extensions when needed, but avoid specific themes unless there is no
1697 * other way (example: you want to have a preview of a new theme you are
1698 * selecting in a "theme selector" window. The preview is inside a scroller
1699 * and should display what the theme you selected will look like, but not
1700 * actually apply it yet. The child of the scroller will have a specific
1701 * theme set to show this preview before the user decides to apply it to all
1704 EAPI Elm_Theme *elm_theme_new(void);
1706 * Free a specific theme
1708 * @param th The theme to free
1710 * This frees a theme created with elm_theme_new().
1712 EAPI void elm_theme_free(Elm_Theme *th);
1714 * Copy the theme fom the source to the destination theme
1716 * @param th The source theme to copy from
1717 * @param thdst The destination theme to copy data to
1719 * This makes a one-time static copy of all the theme config, extensions
1720 * and overlays from @p th to @p thdst. If @p th references a theme, then
1721 * @p thdst is also set to reference it, with all the theme settings,
1722 * overlays and extensions that @p th had.
1724 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1726 * Tell the source theme to reference the ref theme
1728 * @param th The theme that will do the referencing
1729 * @param thref The theme that is the reference source
1731 * This clears @p th to be empty and then sets it to refer to @p thref
1732 * so @p th acts as an override to @p thref, but where its overrides
1733 * don't apply, it will fall through to @p thref for configuration.
1735 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1737 * Return the theme referred to
1739 * @param th The theme to get the reference from
1740 * @return The referenced theme handle
1742 * This gets the theme set as the reference theme by elm_theme_ref_set().
1743 * If no theme is set as a reference, NULL is returned.
1745 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1747 * Return the default theme
1749 * @return The default theme handle
1751 * This returns the internal default theme setup handle that all widgets
1752 * use implicitly unless a specific theme is set. This is also often use
1753 * as a shorthand of NULL.
1755 EAPI Elm_Theme *elm_theme_default_get(void);
1757 * Prepends a theme overlay to the list of overlays
1759 * @param th The theme to add to, or if NULL, the default theme
1760 * @param item The Edje file path to be used
1762 * Use this if your application needs to provide some custom overlay theme
1763 * (An Edje file that replaces some default styles of widgets) where adding
1764 * new styles, or changing system theme configuration is not possible. Do
1765 * NOT use this instead of a proper system theme configuration. Use proper
1766 * configuration files, profiles, environment variables etc. to set a theme
1767 * so that the theme can be altered by simple confiugration by a user. Using
1768 * this call to achieve that effect is abusing the API and will create lots
1771 * @see elm_theme_extension_add()
1773 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1775 * Delete a theme overlay from the list of overlays
1777 * @param th The theme to delete from, or if NULL, the default theme
1778 * @param item The name of the theme overlay
1780 * @see elm_theme_overlay_add()
1782 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1784 * Appends a theme extension to the list of extensions.
1786 * @param th The theme to add to, or if NULL, the default theme
1787 * @param item The Edje file path to be used
1789 * This is intended when an application needs more styles of widgets or new
1790 * widget themes that the default does not provide (or may not provide). The
1791 * application has "extended" usage by coming up with new custom style names
1792 * for widgets for specific uses, but as these are not "standard", they are
1793 * not guaranteed to be provided by a default theme. This means the
1794 * application is required to provide these extra elements itself in specific
1795 * Edje files. This call adds one of those Edje files to the theme search
1796 * path to be search after the default theme. The use of this call is
1797 * encouraged when default styles do not meet the needs of the application.
1798 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1800 * @see elm_object_style_set()
1802 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1804 * Deletes a theme extension from the list of extensions.
1806 * @param th The theme to delete from, or if NULL, the default theme
1807 * @param item The name of the theme extension
1809 * @see elm_theme_extension_add()
1811 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1813 * Set the theme search order for the given theme
1815 * @param th The theme to set the search order, or if NULL, the default theme
1816 * @param theme Theme search string
1818 * This sets the search string for the theme in path-notation from first
1819 * theme to search, to last, delimited by the : character. Example:
1821 * "shiny:/path/to/file.edj:default"
1823 * See the ELM_THEME environment variable for more information.
1825 * @see elm_theme_get()
1826 * @see elm_theme_list_get()
1828 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1830 * Return the theme search order
1832 * @param th The theme to get the search order, or if NULL, the default theme
1833 * @return The internal search order path
1835 * This function returns a colon separated string of theme elements as
1836 * returned by elm_theme_list_get().
1838 * @see elm_theme_set()
1839 * @see elm_theme_list_get()
1841 EAPI const char *elm_theme_get(Elm_Theme *th);
1843 * Return a list of theme elements to be used in a theme.
1845 * @param th Theme to get the list of theme elements from.
1846 * @return The internal list of theme elements
1848 * This returns the internal list of theme elements (will only be valid as
1849 * long as the theme is not modified by elm_theme_set() or theme is not
1850 * freed by elm_theme_free(). This is a list of strings which must not be
1851 * altered as they are also internal. If @p th is NULL, then the default
1852 * theme element list is returned.
1854 * A theme element can consist of a full or relative path to a .edj file,
1855 * or a name, without extension, for a theme to be searched in the known
1856 * theme paths for Elemementary.
1858 * @see elm_theme_set()
1859 * @see elm_theme_get()
1861 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1863 * Return the full patrh for a theme element
1865 * @param f The theme element name
1866 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1867 * @return The full path to the file found.
1869 * This returns a string you should free with free() on success, NULL on
1870 * failure. This will search for the given theme element, and if it is a
1871 * full or relative path element or a simple searchable name. The returned
1872 * path is the full path to the file, if searched, and the file exists, or it
1873 * is simply the full path given in the element or a resolved path if
1874 * relative to home. The @p in_search_path boolean pointed to is set to
1875 * EINA_TRUE if the file was a searchable file andis in the search path,
1876 * and EINA_FALSE otherwise.
1878 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1880 * Flush the current theme.
1882 * @param th Theme to flush
1884 * This flushes caches that let elementary know where to find theme elements
1885 * in the given theme. If @p th is NULL, then the default theme is flushed.
1886 * Call this function if source theme data has changed in such a way as to
1887 * make any caches Elementary kept invalid.
1889 EAPI void elm_theme_flush(Elm_Theme *th);
1891 * This flushes all themes (default and specific ones).
1893 * This will flush all themes in the current application context, by calling
1894 * elm_theme_flush() on each of them.
1896 EAPI void elm_theme_full_flush(void);
1898 * Set the theme for all elementary using applications on the current display
1900 * @param theme The name of the theme to use. Format same as the ELM_THEME
1901 * environment variable.
1903 EAPI void elm_theme_all_set(const char *theme);
1905 * Return a list of theme elements in the theme search path
1907 * @return A list of strings that are the theme element names.
1909 * This lists all available theme files in the standard Elementary search path
1910 * for theme elements, and returns them in alphabetical order as theme
1911 * element names in a list of strings. Free this with
1912 * elm_theme_name_available_list_free() when you are done with the list.
1914 EAPI Eina_List *elm_theme_name_available_list_new(void);
1916 * Free the list returned by elm_theme_name_available_list_new()
1918 * This frees the list of themes returned by
1919 * elm_theme_name_available_list_new(). Once freed the list should no longer
1920 * be used. a new list mys be created.
1922 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1924 * Set a specific theme to be used for this object and its children
1926 * @param obj The object to set the theme on
1927 * @param th The theme to set
1929 * This sets a specific theme that will be used for the given object and any
1930 * child objects it has. If @p th is NULL then the theme to be used is
1931 * cleared and the object will inherit its theme from its parent (which
1932 * ultimately will use the default theme if no specific themes are set).
1934 * Use special themes with great care as this will annoy users and make
1935 * configuration difficult. Avoid any custom themes at all if it can be
1938 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1940 * Get the specific theme to be used
1942 * @param obj The object to get the specific theme from
1943 * @return The specifc theme set.
1945 * This will return a specific theme set, or NULL if no specific theme is
1946 * set on that object. It will not return inherited themes from parents, only
1947 * the specific theme set for that specific object. See elm_object_theme_set()
1948 * for more information.
1950 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1956 /** @defgroup Win Win
1958 * @image html img/widget/win/preview-00.png
1959 * @image latex img/widget/win/preview-00.eps
1961 * The window class of Elementary. Contains functions to manipulate
1962 * windows. The Evas engine used to render the window contents is specified
1963 * in the system or user elementary config files (whichever is found last),
1964 * and can be overridden with the ELM_ENGINE environment variable for
1965 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1966 * compilation setup and modules actually installed at runtime) are (listed
1967 * in order of best supported and most likely to be complete and work to
1970 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1971 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1973 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1975 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1977 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1979 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1980 * rendering using SDL as the buffer)
1981 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1982 * GDI with software)
1983 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1984 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1985 * grayscale using dedicated 8bit software engine in X11)
1986 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1987 * X11 using 16bit software engine)
1988 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1989 * (Windows CE rendering via GDI with 16bit software renderer)
1990 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1991 * buffer with 16bit software renderer)
1993 * All engines use a simple string to select the engine to render, EXCEPT
1994 * the "shot" engine. This actually encodes the output of the virtual
1995 * screenshot and how long to delay in the engine string. The engine string
1996 * is encoded in the following way:
1998 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
2000 * Where options are separated by a ":" char if more than one option is
2001 * given, with delay, if provided being the first option and file the last
2002 * (order is important). The delay specifies how long to wait after the
2003 * window is shown before doing the virtual "in memory" rendering and then
2004 * save the output to the file specified by the file option (and then exit).
2005 * If no delay is given, the default is 0.5 seconds. If no file is given the
2006 * default output file is "out.png". Repeat option is for continous
2007 * capturing screenshots. Repeat range is from 1 to 999 and filename is
2008 * fixed to "out001.png" Some examples of using the shot engine:
2010 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
2011 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
2012 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
2013 * ELM_ENGINE="shot:delay=2.0" elementary_test
2014 * ELM_ENGINE="shot:" elementary_test
2016 * Signals that you can add callbacks for are:
2018 * @li "delete,request": the user requested to close the window. See
2019 * elm_win_autodel_set().
2020 * @li "focus,in": window got focus
2021 * @li "focus,out": window lost focus
2022 * @li "moved": window that holds the canvas was moved
2025 * @li @ref win_example_01
2030 * Defines the types of window that can be created
2032 * These are hints set on the window so that a running Window Manager knows
2033 * how the window should be handled and/or what kind of decorations it
2036 * Currently, only the X11 backed engines use them.
2038 typedef enum _Elm_Win_Type
2040 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
2041 window. Almost every window will be created with this
2043 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
2044 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
2045 window holding desktop icons. */
2046 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
2047 be kept on top of any other window by the Window
2049 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
2051 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
2052 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
2054 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
2055 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
2056 entry in a menubar is clicked. Typically used
2057 with elm_win_override_set(). This hint exists
2058 for completion only, as the EFL way of
2059 implementing a menu would not normally use a
2060 separate window for its contents. */
2061 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
2062 triggered by right-clicking an object. */
2063 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
2064 explanatory text that typically appear after the
2065 mouse cursor hovers over an object for a while.
2066 Typically used with elm_win_override_set() and also
2067 not very commonly used in the EFL. */
2068 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
2069 battery life or a new E-Mail received. */
2070 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
2071 usually used in the EFL. */
2072 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
2073 object being dragged across different windows, or even
2074 applications. Typically used with
2075 elm_win_override_set(). */
2076 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
2077 buffer. No actual window is created for this
2078 type, instead the window and all of its
2079 contents will be rendered to an image buffer.
2080 This allows to have children window inside a
2081 parent one just like any other object would
2082 be, and do other things like applying @c
2083 Evas_Map effects to it. This is the only type
2084 of window that requires the @c parent
2085 parameter of elm_win_add() to be a valid @c
2090 * The differents layouts that can be requested for the virtual keyboard.
2092 * When the application window is being managed by Illume, it may request
2093 * any of the following layouts for the virtual keyboard.
2095 typedef enum _Elm_Win_Keyboard_Mode
2097 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
2098 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
2099 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
2100 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
2101 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
2102 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
2103 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
2104 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
2105 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
2106 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
2107 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
2108 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
2109 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
2110 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
2111 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
2112 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
2113 } Elm_Win_Keyboard_Mode;
2116 * Available commands that can be sent to the Illume manager.
2118 * When running under an Illume session, a window may send commands to the
2119 * Illume manager to perform different actions.
2121 typedef enum _Elm_Illume_Command
2123 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
2125 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
2127 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
2129 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
2130 } Elm_Illume_Command;
2133 * Adds a window object. If this is the first window created, pass NULL as
2136 * @param parent Parent object to add the window to, or NULL
2137 * @param name The name of the window
2138 * @param type The window type, one of #Elm_Win_Type.
2140 * The @p parent paramter can be @c NULL for every window @p type except
2141 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
2142 * which the image object will be created.
2144 * @return The created object, or NULL on failure
2146 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
2148 * Add @p subobj as a resize object of window @p obj.
2151 * Setting an object as a resize object of the window means that the
2152 * @p subobj child's size and position will be controlled by the window
2153 * directly. That is, the object will be resized to match the window size
2154 * and should never be moved or resized manually by the developer.
2156 * In addition, resize objects of the window control what the minimum size
2157 * of it will be, as well as whether it can or not be resized by the user.
2159 * For the end user to be able to resize a window by dragging the handles
2160 * or borders provided by the Window Manager, or using any other similar
2161 * mechanism, all of the resize objects in the window should have their
2162 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
2164 * @param obj The window object
2165 * @param subobj The resize object to add
2167 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2169 * Delete @p subobj as a resize object of window @p obj.
2171 * This function removes the object @p subobj from the resize objects of
2172 * the window @p obj. It will not delete the object itself, which will be
2173 * left unmanaged and should be deleted by the developer, manually handled
2174 * or set as child of some other container.
2176 * @param obj The window object
2177 * @param subobj The resize object to add
2179 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2181 * Set the title of the window
2183 * @param obj The window object
2184 * @param title The title to set
2186 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2188 * Get the title of the window
2190 * The returned string is an internal one and should not be freed or
2191 * modified. It will also be rendered invalid if a new title is set or if
2192 * the window is destroyed.
2194 * @param obj The window object
2197 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2199 * Set the window's autodel state.
2201 * When closing the window in any way outside of the program control, like
2202 * pressing the X button in the titlebar or using a command from the
2203 * Window Manager, a "delete,request" signal is emitted to indicate that
2204 * this event occurred and the developer can take any action, which may
2205 * include, or not, destroying the window object.
2207 * When the @p autodel parameter is set, the window will be automatically
2208 * destroyed when this event occurs, after the signal is emitted.
2209 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
2210 * and is up to the program to do so when it's required.
2212 * @param obj The window object
2213 * @param autodel If true, the window will automatically delete itself when
2216 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
2218 * Get the window's autodel state.
2220 * @param obj The window object
2221 * @return If the window will automatically delete itself when closed
2223 * @see elm_win_autodel_set()
2225 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2227 * Activate a window object.
2229 * This function sends a request to the Window Manager to activate the
2230 * window pointed by @p obj. If honored by the WM, the window will receive
2231 * the keyboard focus.
2233 * @note This is just a request that a Window Manager may ignore, so calling
2234 * this function does not ensure in any way that the window will be the
2235 * active one after it.
2237 * @param obj The window object
2239 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2241 * Lower a window object.
2243 * Places the window pointed by @p obj at the bottom of the stack, so that
2244 * no other window is covered by it.
2246 * If elm_win_override_set() is not set, the Window Manager may ignore this
2249 * @param obj The window object
2251 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2253 * Raise a window object.
2255 * Places the window pointed by @p obj at the top of the stack, so that it's
2256 * not covered by any other window.
2258 * If elm_win_override_set() is not set, the Window Manager may ignore this
2261 * @param obj The window object
2263 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2265 * Set the borderless state of a window.
2267 * This function requests the Window Manager to not draw any decoration
2268 * around the window.
2270 * @param obj The window object
2271 * @param borderless If true, the window is borderless
2273 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2275 * Get the borderless state of a window.
2277 * @param obj The window object
2278 * @return If true, the window is borderless
2280 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2282 * Set the shaped state of a window.
2284 * Shaped windows, when supported, will render the parts of the window that
2285 * has no content, transparent.
2287 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2288 * background object or cover the entire window in any other way, or the
2289 * parts of the canvas that have no data will show framebuffer artifacts.
2291 * @param obj The window object
2292 * @param shaped If true, the window is shaped
2294 * @see elm_win_alpha_set()
2296 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2298 * Get the shaped state of a window.
2300 * @param obj The window object
2301 * @return If true, the window is shaped
2303 * @see elm_win_shaped_set()
2305 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2307 * Set the alpha channel state of a window.
2309 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2310 * possibly making parts of the window completely or partially transparent.
2311 * This is also subject to the underlying system supporting it, like for
2312 * example, running under a compositing manager. If no compositing is
2313 * available, enabling this option will instead fallback to using shaped
2314 * windows, with elm_win_shaped_set().
2316 * @param obj The window object
2317 * @param alpha If true, the window has an alpha channel
2319 * @see elm_win_alpha_set()
2321 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2323 * Get the transparency state of a window.
2325 * @param obj The window object
2326 * @return If true, the window is transparent
2328 * @see elm_win_transparent_set()
2330 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2332 * Set the transparency state of a window.
2334 * Use elm_win_alpha_set() instead.
2336 * @param obj The window object
2337 * @param transparent If true, the window is transparent
2339 * @see elm_win_alpha_set()
2341 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2343 * Get the alpha channel state of a window.
2345 * @param obj The window object
2346 * @return If true, the window has an alpha channel
2348 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2350 * Set the override state of a window.
2352 * A window with @p override set to EINA_TRUE will not be managed by the
2353 * Window Manager. This means that no decorations of any kind will be shown
2354 * for it, moving and resizing must be handled by the application, as well
2355 * as the window visibility.
2357 * This should not be used for normal windows, and even for not so normal
2358 * ones, it should only be used when there's a good reason and with a lot
2359 * of care. Mishandling override windows may result situations that
2360 * disrupt the normal workflow of the end user.
2362 * @param obj The window object
2363 * @param override If true, the window is overridden
2365 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2367 * Get the override state of a window.
2369 * @param obj The window object
2370 * @return If true, the window is overridden
2372 * @see elm_win_override_set()
2374 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2376 * Set the fullscreen state of a window.
2378 * @param obj The window object
2379 * @param fullscreen If true, the window is fullscreen
2381 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2383 * Get the fullscreen state of a window.
2385 * @param obj The window object
2386 * @return If true, the window is fullscreen
2388 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2390 * Set the maximized state of a window.
2392 * @param obj The window object
2393 * @param maximized If true, the window is maximized
2395 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2397 * Get the maximized state of a window.
2399 * @param obj The window object
2400 * @return If true, the window is maximized
2402 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2404 * Set the iconified state of a window.
2406 * @param obj The window object
2407 * @param iconified If true, the window is iconified
2409 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2411 * Get the iconified state of a window.
2413 * @param obj The window object
2414 * @return If true, the window is iconified
2416 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2418 * Set the layer of the window.
2420 * What this means exactly will depend on the underlying engine used.
2422 * In the case of X11 backed engines, the value in @p layer has the
2423 * following meanings:
2424 * @li < 3: The window will be placed below all others.
2425 * @li > 5: The window will be placed above all others.
2426 * @li other: The window will be placed in the default layer.
2428 * @param obj The window object
2429 * @param layer The layer of the window
2431 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2433 * Get the layer of the window.
2435 * @param obj The window object
2436 * @return The layer of the window
2438 * @see elm_win_layer_set()
2440 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2442 * Set the rotation of the window.
2444 * Most engines only work with multiples of 90.
2446 * This function is used to set the orientation of the window @p obj to
2447 * match that of the screen. The window itself will be resized to adjust
2448 * to the new geometry of its contents. If you want to keep the window size,
2449 * see elm_win_rotation_with_resize_set().
2451 * @param obj The window object
2452 * @param rotation The rotation of the window, in degrees (0-360),
2453 * counter-clockwise.
2455 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2457 * Rotates the window and resizes it.
2459 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2460 * that they fit inside the current window geometry.
2462 * @param obj The window object
2463 * @param layer The rotation of the window in degrees (0-360),
2464 * counter-clockwise.
2466 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2468 * Get the rotation of the window.
2470 * @param obj The window object
2471 * @return The rotation of the window in degrees (0-360)
2473 * @see elm_win_rotation_set()
2474 * @see elm_win_rotation_with_resize_set()
2476 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2478 * Set the sticky state of the window.
2480 * Hints the Window Manager that the window in @p obj should be left fixed
2481 * at its position even when the virtual desktop it's on moves or changes.
2483 * @param obj The window object
2484 * @param sticky If true, the window's sticky state is enabled
2486 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2488 * Get the sticky state of the window.
2490 * @param obj The window object
2491 * @return If true, the window's sticky state is enabled
2493 * @see elm_win_sticky_set()
2495 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2497 * Set if this window is an illume conformant window
2499 * @param obj The window object
2500 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2502 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2504 * Get if this window is an illume conformant window
2506 * @param obj The window object
2507 * @return A boolean if this window is illume conformant or not
2509 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2511 * Set a window to be an illume quickpanel window
2513 * By default window objects are not quickpanel windows.
2515 * @param obj The window object
2516 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2518 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2520 * Get if this window is a quickpanel or not
2522 * @param obj The window object
2523 * @return A boolean if this window is a quickpanel or not
2525 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2527 * Set the major priority of a quickpanel window
2529 * @param obj The window object
2530 * @param priority The major priority for this quickpanel
2532 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2534 * Get the major priority of a quickpanel window
2536 * @param obj The window object
2537 * @return The major priority of this quickpanel
2539 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2541 * Set the minor priority of a quickpanel window
2543 * @param obj The window object
2544 * @param priority The minor priority for this quickpanel
2546 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2548 * Get the minor priority of a quickpanel window
2550 * @param obj The window object
2551 * @return The minor priority of this quickpanel
2553 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2555 * Set which zone this quickpanel should appear in
2557 * @param obj The window object
2558 * @param zone The requested zone for this quickpanel
2560 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2562 * Get which zone this quickpanel should appear in
2564 * @param obj The window object
2565 * @return The requested zone for this quickpanel
2567 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2569 * Set the window to be skipped by keyboard focus
2571 * This sets the window to be skipped by normal keyboard input. This means
2572 * a window manager will be asked to not focus this window as well as omit
2573 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2575 * Call this and enable it on a window BEFORE you show it for the first time,
2576 * otherwise it may have no effect.
2578 * Use this for windows that have only output information or might only be
2579 * interacted with by the mouse or fingers, and never for typing input.
2580 * Be careful that this may have side-effects like making the window
2581 * non-accessible in some cases unless the window is specially handled. Use
2584 * @param obj The window object
2585 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2587 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2589 * Send a command to the windowing environment
2591 * This is intended to work in touchscreen or small screen device
2592 * environments where there is a more simplistic window management policy in
2593 * place. This uses the window object indicated to select which part of the
2594 * environment to control (the part that this window lives in), and provides
2595 * a command and an optional parameter structure (use NULL for this if not
2598 * @param obj The window object that lives in the environment to control
2599 * @param command The command to send
2600 * @param params Optional parameters for the command
2602 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2604 * Get the inlined image object handle
2606 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2607 * then the window is in fact an evas image object inlined in the parent
2608 * canvas. You can get this object (be careful to not manipulate it as it
2609 * is under control of elementary), and use it to do things like get pixel
2610 * data, save the image to a file, etc.
2612 * @param obj The window object to get the inlined image from
2613 * @return The inlined image object, or NULL if none exists
2615 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2617 * Set the enabled status for the focus highlight in a window
2619 * This function will enable or disable the focus highlight only for the
2620 * given window, regardless of the global setting for it
2622 * @param obj The window where to enable the highlight
2623 * @param enabled The enabled value for the highlight
2625 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2627 * Get the enabled value of the focus highlight for this window
2629 * @param obj The window in which to check if the focus highlight is enabled
2631 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2633 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2635 * Set the style for the focus highlight on this window
2637 * Sets the style to use for theming the highlight of focused objects on
2638 * the given window. If @p style is NULL, the default will be used.
2640 * @param obj The window where to set the style
2641 * @param style The style to set
2643 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2645 * Get the style set for the focus highlight object
2647 * Gets the style set for this windows highilght object, or NULL if none
2650 * @param obj The window to retrieve the highlights style from
2652 * @return The style set or NULL if none was. Default is used in that case.
2654 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2656 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2657 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2658 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2659 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2660 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2661 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2662 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2664 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2665 * (blank mouse, private mouse obj, defaultmouse)
2669 * Sets the keyboard mode of the window.
2671 * @param obj The window object
2672 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2674 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2676 * Gets the keyboard mode of the window.
2678 * @param obj The window object
2679 * @return The mode, one of #Elm_Win_Keyboard_Mode
2681 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2683 * Sets whether the window is a keyboard.
2685 * @param obj The window object
2686 * @param is_keyboard If true, the window is a virtual keyboard
2688 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2690 * Gets whether the window is a keyboard.
2692 * @param obj The window object
2693 * @return If the window is a virtual keyboard
2695 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2698 * Get the screen position of a window.
2700 * @param obj The window object
2701 * @param x The int to store the x coordinate to
2702 * @param y The int to store the y coordinate to
2704 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2710 * @defgroup Inwin Inwin
2712 * @image html img/widget/inwin/preview-00.png
2713 * @image latex img/widget/inwin/preview-00.eps
2714 * @image html img/widget/inwin/preview-01.png
2715 * @image latex img/widget/inwin/preview-01.eps
2716 * @image html img/widget/inwin/preview-02.png
2717 * @image latex img/widget/inwin/preview-02.eps
2719 * An inwin is a window inside a window that is useful for a quick popup.
2720 * It does not hover.
2722 * It works by creating an object that will occupy the entire window, so it
2723 * must be created using an @ref Win "elm_win" as parent only. The inwin
2724 * object can be hidden or restacked below every other object if it's
2725 * needed to show what's behind it without destroying it. If this is done,
2726 * the elm_win_inwin_activate() function can be used to bring it back to
2727 * full visibility again.
2729 * There are three styles available in the default theme. These are:
2730 * @li default: The inwin is sized to take over most of the window it's
2732 * @li minimal: The size of the inwin will be the minimum necessary to show
2734 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2735 * possible, but it's sized vertically the most it needs to fit its\
2738 * Some examples of Inwin can be found in the following:
2739 * @li @ref inwin_example_01
2744 * Adds an inwin to the current window
2746 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2747 * Never call this function with anything other than the top-most window
2748 * as its parameter, unless you are fond of undefined behavior.
2750 * After creating the object, the widget will set itself as resize object
2751 * for the window with elm_win_resize_object_add(), so when shown it will
2752 * appear to cover almost the entire window (how much of it depends on its
2753 * content and the style used). It must not be added into other container
2754 * objects and it needs not be moved or resized manually.
2756 * @param parent The parent object
2757 * @return The new object or NULL if it cannot be created
2759 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2761 * Activates an inwin object, ensuring its visibility
2763 * This function will make sure that the inwin @p obj is completely visible
2764 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2765 * to the front. It also sets the keyboard focus to it, which will be passed
2768 * The object's theme will also receive the signal "elm,action,show" with
2771 * @param obj The inwin to activate
2773 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2775 * Set the content of an inwin object.
2777 * Once the content object is set, a previously set one will be deleted.
2778 * If you want to keep that old content object, use the
2779 * elm_win_inwin_content_unset() function.
2781 * @param obj The inwin object
2782 * @param content The object to set as content
2784 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2786 * Get the content of an inwin object.
2788 * Return the content object which is set for this widget.
2790 * The returned object is valid as long as the inwin is still alive and no
2791 * other content is set on it. Deleting the object will notify the inwin
2792 * about it and this one will be left empty.
2794 * If you need to remove an inwin's content to be reused somewhere else,
2795 * see elm_win_inwin_content_unset().
2797 * @param obj The inwin object
2798 * @return The content that is being used
2800 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2802 * Unset the content of an inwin object.
2804 * Unparent and return the content object which was set for this widget.
2806 * @param obj The inwin object
2807 * @return The content that was being used
2809 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2813 /* X specific calls - won't work on non-x engines (return 0) */
2814 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2815 /* smart callbacks called:
2816 * "delete,request" - the user requested to delete the window
2817 * "focus,in" - window got focus
2818 * "focus,out" - window lost focus
2819 * "moved" - window that holds the canvas was moved
2825 * @image html img/widget/bg/preview-00.png
2826 * @image latex img/widget/bg/preview-00.eps
2828 * @brief Background object, used for setting a solid color, image or Edje
2829 * group as background to a window or any container object.
2831 * The bg object is used for setting a solid background to a window or
2832 * packing into any container object. It works just like an image, but has
2833 * some properties useful to a background, like setting it to tiled,
2834 * centered, scaled or stretched.
2836 * Here is some sample code using it:
2837 * @li @ref bg_01_example_page
2838 * @li @ref bg_02_example_page
2839 * @li @ref bg_03_example_page
2843 typedef enum _Elm_Bg_Option
2845 ELM_BG_OPTION_CENTER, /**< center the background */
2846 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2847 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2848 ELM_BG_OPTION_TILE /**< tile background at its original size */
2852 * Add a new background to the parent
2854 * @param parent The parent object
2855 * @return The new object or NULL if it cannot be created
2859 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2862 * Set the file (image or edje) used for the background
2864 * @param obj The bg object
2865 * @param file The file path
2866 * @param group Optional key (group in Edje) within the file
2868 * This sets the image file used in the background object. The image (or edje)
2869 * will be stretched (retaining aspect if its an image file) to completely fill
2870 * the bg object. This may mean some parts are not visible.
2872 * @note Once the image of @p obj is set, a previously set one will be deleted,
2873 * even if @p file is NULL.
2877 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2880 * Get the file (image or edje) used for the background
2882 * @param obj The bg object
2883 * @param file The file path
2884 * @param group Optional key (group in Edje) within the file
2888 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2891 * Set the option used for the background image
2893 * @param obj The bg object
2894 * @param option The desired background option (TILE, SCALE)
2896 * This sets the option used for manipulating the display of the background
2897 * image. The image can be tiled or scaled.
2901 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2904 * Get the option used for the background image
2906 * @param obj The bg object
2907 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2911 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2913 * Set the option used for the background color
2915 * @param obj The bg object
2920 * This sets the color used for the background rectangle. Its range goes
2925 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2927 * Get the option used for the background color
2929 * @param obj The bg object
2936 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2939 * Set the overlay object used for the background object.
2941 * @param obj The bg object
2942 * @param overlay The overlay object
2944 * This provides a way for elm_bg to have an 'overlay' that will be on top
2945 * of the bg. Once the over object is set, a previously set one will be
2946 * deleted, even if you set the new one to NULL. If you want to keep that
2947 * old content object, use the elm_bg_overlay_unset() function.
2952 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2955 * Get the overlay object used for the background object.
2957 * @param obj The bg object
2958 * @return The content that is being used
2960 * Return the content object which is set for this widget
2964 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2967 * Get the overlay object used for the background object.
2969 * @param obj The bg object
2970 * @return The content that was being used
2972 * Unparent and return the overlay object which was set for this widget
2976 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2979 * Set the size of the pixmap representation of the image.
2981 * This option just makes sense if an image is going to be set in the bg.
2983 * @param obj The bg object
2984 * @param w The new width of the image pixmap representation.
2985 * @param h The new height of the image pixmap representation.
2987 * This function sets a new size for pixmap representation of the given bg
2988 * image. It allows the image to be loaded already in the specified size,
2989 * reducing the memory usage and load time when loading a big image with load
2990 * size set to a smaller size.
2992 * NOTE: this is just a hint, the real size of the pixmap may differ
2993 * depending on the type of image being loaded, being bigger than requested.
2997 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2998 /* smart callbacks called:
3002 * @defgroup Icon Icon
3004 * @image html img/widget/icon/preview-00.png
3005 * @image latex img/widget/icon/preview-00.eps
3007 * An object that provides standard icon images (delete, edit, arrows, etc.)
3008 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
3010 * The icon image requested can be in the elementary theme, or in the
3011 * freedesktop.org paths. It's possible to set the order of preference from
3012 * where the image will be used.
3014 * This API is very similar to @ref Image, but with ready to use images.
3016 * Default images provided by the theme are described below.
3018 * The first list contains icons that were first intended to be used in
3019 * toolbars, but can be used in many other places too:
3035 * Now some icons that were designed to be used in menus (but again, you can
3036 * use them anywhere else):
3041 * @li menu/arrow_down
3042 * @li menu/arrow_left
3043 * @li menu/arrow_right
3052 * And here we have some media player specific icons:
3053 * @li media_player/forward
3054 * @li media_player/info
3055 * @li media_player/next
3056 * @li media_player/pause
3057 * @li media_player/play
3058 * @li media_player/prev
3059 * @li media_player/rewind
3060 * @li media_player/stop
3062 * Signals that you can add callbacks for are:
3064 * "clicked" - This is called when a user has clicked the icon
3066 * An example of usage for this API follows:
3067 * @li @ref tutorial_icon
3075 typedef enum _Elm_Icon_Type
3082 * @enum _Elm_Icon_Lookup_Order
3083 * @typedef Elm_Icon_Lookup_Order
3085 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
3086 * theme, FDO paths, or both?
3090 typedef enum _Elm_Icon_Lookup_Order
3092 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
3093 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
3094 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
3095 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
3096 } Elm_Icon_Lookup_Order;
3099 * Add a new icon object to the parent.
3101 * @param parent The parent object
3102 * @return The new object or NULL if it cannot be created
3104 * @see elm_icon_file_set()
3108 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3110 * Set the file that will be used as icon.
3112 * @param obj The icon object
3113 * @param file The path to file that will be used as icon image
3114 * @param group The group that the icon belongs to in edje file
3116 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3118 * @note The icon image set by this function can be changed by
3119 * elm_icon_standard_set().
3121 * @see elm_icon_file_get()
3125 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3127 * Set a location in memory to be used as an icon
3129 * @param obj The icon object
3130 * @param img The binary data that will be used as an image
3131 * @param size The size of binary data @p img
3132 * @param format Optional format of @p img to pass to the image loader
3133 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
3135 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3137 * @note The icon image set by this function can be changed by
3138 * elm_icon_standard_set().
3142 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);
3144 * Get the file that will be used as icon.
3146 * @param obj The icon object
3147 * @param file The path to file that will be used as icon icon image
3148 * @param group The group that the icon belongs to in edje file
3150 * @see elm_icon_file_set()
3154 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3155 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3157 * Set the icon by icon standards names.
3159 * @param obj The icon object
3160 * @param name The icon name
3162 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3164 * For example, freedesktop.org defines standard icon names such as "home",
3165 * "network", etc. There can be different icon sets to match those icon
3166 * keys. The @p name given as parameter is one of these "keys", and will be
3167 * used to look in the freedesktop.org paths and elementary theme. One can
3168 * change the lookup order with elm_icon_order_lookup_set().
3170 * If name is not found in any of the expected locations and it is the
3171 * absolute path of an image file, this image will be used.
3173 * @note The icon image set by this function can be changed by
3174 * elm_icon_file_set().
3176 * @see elm_icon_standard_get()
3177 * @see elm_icon_file_set()
3181 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
3183 * Get the icon name set by icon standard names.
3185 * @param obj The icon object
3186 * @return The icon name
3188 * If the icon image was set using elm_icon_file_set() instead of
3189 * elm_icon_standard_set(), then this function will return @c NULL.
3191 * @see elm_icon_standard_set()
3195 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3197 * Set the smooth effect for an icon object.
3199 * @param obj The icon object
3200 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3201 * otherwise. Default is @c EINA_TRUE.
3203 * Set the scaling algorithm to be used when scaling the icon image. Smooth
3204 * scaling provides a better resulting image, but is slower.
3206 * The smooth scaling should be disabled when making animations that change
3207 * the icon size, since they will be faster. Animations that don't require
3208 * resizing of the icon can keep the smooth scaling enabled (even if the icon
3209 * is already scaled, since the scaled icon image will be cached).
3211 * @see elm_icon_smooth_get()
3215 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3217 * Get the smooth effect for an icon object.
3219 * @param obj The icon object
3220 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3222 * @see elm_icon_smooth_set()
3226 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3228 * Disable scaling of this object.
3230 * @param obj The icon object.
3231 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3232 * otherwise. Default is @c EINA_FALSE.
3234 * This function disables scaling of the icon object through the function
3235 * elm_object_scale_set(). However, this does not affect the object
3236 * size/resize in any way. For that effect, take a look at
3237 * elm_icon_scale_set().
3239 * @see elm_icon_no_scale_get()
3240 * @see elm_icon_scale_set()
3241 * @see elm_object_scale_set()
3245 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3247 * Get whether scaling is disabled on the object.
3249 * @param obj The icon object
3250 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3252 * @see elm_icon_no_scale_set()
3256 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3258 * Set if the object is (up/down) resizeable.
3260 * @param obj The icon object
3261 * @param scale_up A bool to set if the object is resizeable up. Default is
3263 * @param scale_down A bool to set if the object is resizeable down. Default
3266 * This function limits the icon object resize ability. If @p scale_up is set to
3267 * @c EINA_FALSE, the object can't have its height or width resized to a value
3268 * higher than the original icon size. Same is valid for @p scale_down.
3270 * @see elm_icon_scale_get()
3274 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3276 * Get if the object is (up/down) resizeable.
3278 * @param obj The icon object
3279 * @param scale_up A bool to set if the object is resizeable up
3280 * @param scale_down A bool to set if the object is resizeable down
3282 * @see elm_icon_scale_set()
3286 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3288 * Get the object's image size
3290 * @param obj The icon object
3291 * @param w A pointer to store the width in
3292 * @param h A pointer to store the height in
3296 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3298 * Set if the icon fill the entire object area.
3300 * @param obj The icon object
3301 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3302 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3304 * When the icon object is resized to a different aspect ratio from the
3305 * original icon image, the icon image will still keep its aspect. This flag
3306 * tells how the image should fill the object's area. They are: keep the
3307 * entire icon inside the limits of height and width of the object (@p
3308 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3309 * of the object, and the icon will fill the entire object (@p fill_outside
3312 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3313 * retain property to false. Thus, the icon image will always keep its
3314 * original aspect ratio.
3316 * @see elm_icon_fill_outside_get()
3317 * @see elm_image_fill_outside_set()
3321 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3323 * Get if the object is filled outside.
3325 * @param obj The icon object
3326 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3328 * @see elm_icon_fill_outside_set()
3332 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3334 * Set the prescale size for the icon.
3336 * @param obj The icon object
3337 * @param size The prescale size. This value is used for both width and
3340 * This function sets a new size for pixmap representation of the given
3341 * icon. It allows the icon to be loaded already in the specified size,
3342 * reducing the memory usage and load time when loading a big icon with load
3343 * size set to a smaller size.
3345 * It's equivalent to the elm_bg_load_size_set() function for bg.
3347 * @note this is just a hint, the real size of the pixmap may differ
3348 * depending on the type of icon being loaded, being bigger than requested.
3350 * @see elm_icon_prescale_get()
3351 * @see elm_bg_load_size_set()
3355 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3357 * Get the prescale size for the icon.
3359 * @param obj The icon object
3360 * @return The prescale size
3362 * @see elm_icon_prescale_set()
3366 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3368 * Sets the icon lookup order used by elm_icon_standard_set().
3370 * @param obj The icon object
3371 * @param order The icon lookup order (can be one of
3372 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3373 * or ELM_ICON_LOOKUP_THEME)
3375 * @see elm_icon_order_lookup_get()
3376 * @see Elm_Icon_Lookup_Order
3380 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3382 * Gets the icon lookup order.
3384 * @param obj The icon object
3385 * @return The icon lookup order
3387 * @see elm_icon_order_lookup_set()
3388 * @see Elm_Icon_Lookup_Order
3392 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3399 * @defgroup Image Image
3401 * @image html img/widget/image/preview-00.png
3402 * @image latex img/widget/image/preview-00.eps
3404 * An object that allows one to load an image file to it. It can be used
3405 * anywhere like any other elementary widget.
3407 * This widget provides most of the functionality provided from @ref Bg or @ref
3408 * Icon, but with a slightly different API (use the one that fits better your
3411 * The features not provided by those two other image widgets are:
3412 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3413 * @li change the object orientation with elm_image_orient_set();
3414 * @li and turning the image editable with elm_image_editable_set().
3416 * Signals that you can add callbacks for are:
3418 * @li @c "clicked" - This is called when a user has clicked the image
3420 * An example of usage for this API follows:
3421 * @li @ref tutorial_image
3430 * @enum _Elm_Image_Orient
3431 * @typedef Elm_Image_Orient
3433 * Possible orientation options for elm_image_orient_set().
3435 * @image html elm_image_orient_set.png
3436 * @image latex elm_image_orient_set.eps width=\textwidth
3440 typedef enum _Elm_Image_Orient
3442 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3443 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3444 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3445 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3446 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3447 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3448 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3449 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3453 * Add a new image to the parent.
3455 * @param parent The parent object
3456 * @return The new object or NULL if it cannot be created
3458 * @see elm_image_file_set()
3462 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3464 * Set the file that will be used as image.
3466 * @param obj The image object
3467 * @param file The path to file that will be used as image
3468 * @param group The group that the image belongs in edje file (if it's an
3471 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3473 * @see elm_image_file_get()
3477 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3479 * Get the file that will be used as image.
3481 * @param obj The image object
3482 * @param file The path to file
3483 * @param group The group that the image belongs in edje file
3485 * @see elm_image_file_set()
3489 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3491 * Set the smooth effect for an image.
3493 * @param obj The image object
3494 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3495 * otherwise. Default is @c EINA_TRUE.
3497 * Set the scaling algorithm to be used when scaling the image. Smooth
3498 * scaling provides a better resulting image, but is slower.
3500 * The smooth scaling should be disabled when making animations that change
3501 * the image size, since it will be faster. Animations that don't require
3502 * resizing of the image can keep the smooth scaling enabled (even if the
3503 * image is already scaled, since the scaled image will be cached).
3505 * @see elm_image_smooth_get()
3509 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3511 * Get the smooth effect for an image.
3513 * @param obj The image object
3514 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3516 * @see elm_image_smooth_get()
3520 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3522 * Gets the current size of the image.
3524 * @param obj The image object.
3525 * @param w Pointer to store width, or NULL.
3526 * @param h Pointer to store height, or NULL.
3528 * This is the real size of the image, not the size of the object.
3530 * On error, neither w or h will be written.
3534 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3536 * Disable scaling of this object.
3538 * @param obj The image object.
3539 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3540 * otherwise. Default is @c EINA_FALSE.
3542 * This function disables scaling of the elm_image widget through the
3543 * function elm_object_scale_set(). However, this does not affect the widget
3544 * size/resize in any way. For that effect, take a look at
3545 * elm_image_scale_set().
3547 * @see elm_image_no_scale_get()
3548 * @see elm_image_scale_set()
3549 * @see elm_object_scale_set()
3553 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3555 * Get whether scaling is disabled on the object.
3557 * @param obj The image object
3558 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3560 * @see elm_image_no_scale_set()
3564 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3566 * Set if the object is (up/down) resizeable.
3568 * @param obj The image object
3569 * @param scale_up A bool to set if the object is resizeable up. Default is
3571 * @param scale_down A bool to set if the object is resizeable down. Default
3574 * This function limits the image resize ability. If @p scale_up is set to
3575 * @c EINA_FALSE, the object can't have its height or width resized to a value
3576 * higher than the original image size. Same is valid for @p scale_down.
3578 * @see elm_image_scale_get()
3582 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3584 * Get if the object is (up/down) resizeable.
3586 * @param obj The image object
3587 * @param scale_up A bool to set if the object is resizeable up
3588 * @param scale_down A bool to set if the object is resizeable down
3590 * @see elm_image_scale_set()
3594 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3596 * Set if the image fill the entire object area when keeping the aspect ratio.
3598 * @param obj The image object
3599 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3600 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3602 * When the image should keep its aspect ratio even if resized to another
3603 * aspect ratio, there are two possibilities to resize it: keep the entire
3604 * image inside the limits of height and width of the object (@p fill_outside
3605 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3606 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3608 * @note This option will have no effect if
3609 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3611 * @see elm_image_fill_outside_get()
3612 * @see elm_image_aspect_ratio_retained_set()
3616 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3618 * Get if the object is filled outside
3620 * @param obj The image object
3621 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3623 * @see elm_image_fill_outside_set()
3627 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3629 * Set the prescale size for the image
3631 * @param obj The image object
3632 * @param size The prescale size. This value is used for both width and
3635 * This function sets a new size for pixmap representation of the given
3636 * image. It allows the image to be loaded already in the specified size,
3637 * reducing the memory usage and load time when loading a big image with load
3638 * size set to a smaller size.
3640 * It's equivalent to the elm_bg_load_size_set() function for bg.
3642 * @note this is just a hint, the real size of the pixmap may differ
3643 * depending on the type of image being loaded, being bigger than requested.
3645 * @see elm_image_prescale_get()
3646 * @see elm_bg_load_size_set()
3650 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3652 * Get the prescale size for the image
3654 * @param obj The image object
3655 * @return The prescale size
3657 * @see elm_image_prescale_set()
3661 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3663 * Set the image orientation.
3665 * @param obj The image object
3666 * @param orient The image orientation
3667 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3668 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3669 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3670 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3671 * Default is #ELM_IMAGE_ORIENT_NONE.
3673 * This function allows to rotate or flip the given image.
3675 * @see elm_image_orient_get()
3676 * @see @ref Elm_Image_Orient
3680 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3682 * Get the image orientation.
3684 * @param obj The image object
3685 * @return The image orientation
3686 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3687 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3688 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3689 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3691 * @see elm_image_orient_set()
3692 * @see @ref Elm_Image_Orient
3696 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3698 * Make the image 'editable'.
3700 * @param obj Image object.
3701 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3703 * This means the image is a valid drag target for drag and drop, and can be
3704 * cut or pasted too.
3708 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3710 * Make the image 'editable'.
3712 * @param obj Image object.
3713 * @return Editability.
3715 * This means the image is a valid drag target for drag and drop, and can be
3716 * cut or pasted too.
3720 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3722 * Get the basic Evas_Image object from this object (widget).
3724 * @param obj The image object to get the inlined image from
3725 * @return The inlined image object, or NULL if none exists
3727 * This function allows one to get the underlying @c Evas_Object of type
3728 * Image from this elementary widget. It can be useful to do things like get
3729 * the pixel data, save the image to a file, etc.
3731 * @note Be careful to not manipulate it, as it is under control of
3736 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3738 * Set whether the original aspect ratio of the image should be kept on resize.
3740 * @param obj The image object.
3741 * @param retained @c EINA_TRUE if the image should retain the aspect,
3742 * @c EINA_FALSE otherwise.
3744 * The original aspect ratio (width / height) of the image is usually
3745 * distorted to match the object's size. Enabling this option will retain
3746 * this original aspect, and the way that the image is fit into the object's
3747 * area depends on the option set by elm_image_fill_outside_set().
3749 * @see elm_image_aspect_ratio_retained_get()
3750 * @see elm_image_fill_outside_set()
3754 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3756 * Get if the object retains the original aspect ratio.
3758 * @param obj The image object.
3759 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3764 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3766 /* smart callbacks called:
3767 * "clicked" - the user clicked the image
3775 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3777 typedef enum _Elm_GLView_Mode
3779 ELM_GLVIEW_ALPHA = 1,
3780 ELM_GLVIEW_DEPTH = 2,
3781 ELM_GLVIEW_STENCIL = 4
3785 * Defines a policy for the glview resizing.
3787 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3789 typedef enum _Elm_GLView_Resize_Policy
3791 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3792 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3793 } Elm_GLView_Resize_Policy;
3795 typedef enum _Elm_GLView_Render_Policy
3797 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3798 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3799 } Elm_GLView_Render_Policy;
3802 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3803 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3804 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3805 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3806 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3807 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3808 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3809 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3810 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3811 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3812 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3813 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3819 * @image html img/widget/box/preview-00.png
3820 * @image latex img/widget/box/preview-00.eps width=\textwidth
3822 * @image html img/box.png
3823 * @image latex img/box.eps width=\textwidth
3825 * A box arranges objects in a linear fashion, governed by a layout function
3826 * that defines the details of this arrangement.
3828 * By default, the box will use an internal function to set the layout to
3829 * a single row, either vertical or horizontal. This layout is affected
3830 * by a number of parameters, such as the homogeneous flag set by
3831 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3832 * elm_box_align_set() and the hints set to each object in the box.
3834 * For this default layout, it's possible to change the orientation with
3835 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3836 * placing its elements ordered from top to bottom. When horizontal is set,
3837 * the order will go from left to right. If the box is set to be
3838 * homogeneous, every object in it will be assigned the same space, that
3839 * of the largest object. Padding can be used to set some spacing between
3840 * the cell given to each object. The alignment of the box, set with
3841 * elm_box_align_set(), determines how the bounding box of all the elements
3842 * will be placed within the space given to the box widget itself.
3844 * The size hints of each object also affect how they are placed and sized
3845 * within the box. evas_object_size_hint_min_set() will give the minimum
3846 * size the object can have, and the box will use it as the basis for all
3847 * latter calculations. Elementary widgets set their own minimum size as
3848 * needed, so there's rarely any need to use it manually.
3850 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3851 * used to tell whether the object will be allocated the minimum size it
3852 * needs or if the space given to it should be expanded. It's important
3853 * to realize that expanding the size given to the object is not the same
3854 * thing as resizing the object. It could very well end being a small
3855 * widget floating in a much larger empty space. If not set, the weight
3856 * for objects will normally be 0.0 for both axis, meaning the widget will
3857 * not be expanded. To take as much space possible, set the weight to
3858 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3860 * Besides how much space each object is allocated, it's possible to control
3861 * how the widget will be placed within that space using
3862 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3863 * for both axis, meaning the object will be centered, but any value from
3864 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3865 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3866 * is -1.0, means the object will be resized to fill the entire space it
3869 * In addition, customized functions to define the layout can be set, which
3870 * allow the application developer to organize the objects within the box
3871 * in any number of ways.
3873 * The special elm_box_layout_transition() function can be used
3874 * to switch from one layout to another, animating the motion of the
3875 * children of the box.
3877 * @note Objects should not be added to box objects using _add() calls.
3879 * Some examples on how to use boxes follow:
3880 * @li @ref box_example_01
3881 * @li @ref box_example_02
3886 * @typedef Elm_Box_Transition
3888 * Opaque handler containing the parameters to perform an animated
3889 * transition of the layout the box uses.
3891 * @see elm_box_transition_new()
3892 * @see elm_box_layout_set()
3893 * @see elm_box_layout_transition()
3895 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3898 * Add a new box to the parent
3900 * By default, the box will be in vertical mode and non-homogeneous.
3902 * @param parent The parent object
3903 * @return The new object or NULL if it cannot be created
3905 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3907 * Set the horizontal orientation
3909 * By default, box object arranges their contents vertically from top to
3911 * By calling this function with @p horizontal as EINA_TRUE, the box will
3912 * become horizontal, arranging contents from left to right.
3914 * @note This flag is ignored if a custom layout function is set.
3916 * @param obj The box object
3917 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3918 * EINA_FALSE = vertical)
3920 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3922 * Get the horizontal orientation
3924 * @param obj The box object
3925 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3927 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3929 * Set the box to arrange its children homogeneously
3931 * If enabled, homogeneous layout makes all items the same size, according
3932 * to the size of the largest of its children.
3934 * @note This flag is ignored if a custom layout function is set.
3936 * @param obj The box object
3937 * @param homogeneous The homogeneous flag
3939 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3941 * Get whether the box is using homogeneous mode or not
3943 * @param obj The box object
3944 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3946 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3947 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3948 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3950 * Add an object to the beginning of the pack list
3952 * Pack @p subobj into the box @p obj, placing it first in the list of
3953 * children objects. The actual position the object will get on screen
3954 * depends on the layout used. If no custom layout is set, it will be at
3955 * the top or left, depending if the box is vertical or horizontal,
3958 * @param obj The box object
3959 * @param subobj The object to add to the box
3961 * @see elm_box_pack_end()
3962 * @see elm_box_pack_before()
3963 * @see elm_box_pack_after()
3964 * @see elm_box_unpack()
3965 * @see elm_box_unpack_all()
3966 * @see elm_box_clear()
3968 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3970 * Add an object at the end of the pack list
3972 * Pack @p subobj into the box @p obj, placing it last in the list of
3973 * children objects. The actual position the object will get on screen
3974 * depends on the layout used. If no custom layout is set, it will be at
3975 * the bottom or right, depending if the box is vertical or horizontal,
3978 * @param obj The box object
3979 * @param subobj The object to add to the box
3981 * @see elm_box_pack_start()
3982 * @see elm_box_pack_before()
3983 * @see elm_box_pack_after()
3984 * @see elm_box_unpack()
3985 * @see elm_box_unpack_all()
3986 * @see elm_box_clear()
3988 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3990 * Adds an object to the box before the indicated object
3992 * This will add the @p subobj to the box indicated before the object
3993 * indicated with @p before. If @p before is not already in the box, results
3994 * are undefined. Before means either to the left of the indicated object or
3995 * above it depending on orientation.
3997 * @param obj The box object
3998 * @param subobj The object to add to the box
3999 * @param before The object before which to add it
4001 * @see elm_box_pack_start()
4002 * @see elm_box_pack_end()
4003 * @see elm_box_pack_after()
4004 * @see elm_box_unpack()
4005 * @see elm_box_unpack_all()
4006 * @see elm_box_clear()
4008 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
4010 * Adds an object to the box after the indicated object
4012 * This will add the @p subobj to the box indicated after the object
4013 * indicated with @p after. If @p after is not already in the box, results
4014 * are undefined. After means either to the right of the indicated object or
4015 * below it depending on orientation.
4017 * @param obj The box object
4018 * @param subobj The object to add to the box
4019 * @param after The object after which to add it
4021 * @see elm_box_pack_start()
4022 * @see elm_box_pack_end()
4023 * @see elm_box_pack_before()
4024 * @see elm_box_unpack()
4025 * @see elm_box_unpack_all()
4026 * @see elm_box_clear()
4028 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
4030 * Clear the box of all children
4032 * Remove all the elements contained by the box, deleting the respective
4035 * @param obj The box object
4037 * @see elm_box_unpack()
4038 * @see elm_box_unpack_all()
4040 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4044 * Remove the object given by @p subobj from the box @p obj without
4047 * @param obj The box object
4049 * @see elm_box_unpack_all()
4050 * @see elm_box_clear()
4052 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4054 * Remove all items from the box, without deleting them
4056 * Clear the box from all children, but don't delete the respective objects.
4057 * If no other references of the box children exist, the objects will never
4058 * be deleted, and thus the application will leak the memory. Make sure
4059 * when using this function that you hold a reference to all the objects
4060 * in the box @p obj.
4062 * @param obj The box object
4064 * @see elm_box_clear()
4065 * @see elm_box_unpack()
4067 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4069 * Retrieve a list of the objects packed into the box
4071 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
4072 * The order of the list corresponds to the packing order the box uses.
4074 * You must free this list with eina_list_free() once you are done with it.
4076 * @param obj The box object
4078 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4080 * Set the space (padding) between the box's elements.
4082 * Extra space in pixels that will be added between a box child and its
4083 * neighbors after its containing cell has been calculated. This padding
4084 * is set for all elements in the box, besides any possible padding that
4085 * individual elements may have through their size hints.
4087 * @param obj The box object
4088 * @param horizontal The horizontal space between elements
4089 * @param vertical The vertical space between elements
4091 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
4093 * Get the space (padding) between the box's elements.
4095 * @param obj The box object
4096 * @param horizontal The horizontal space between elements
4097 * @param vertical The vertical space between elements
4099 * @see elm_box_padding_set()
4101 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
4103 * Set the alignment of the whole bouding box of contents.
4105 * Sets how the bounding box containing all the elements of the box, after
4106 * their sizes and position has been calculated, will be aligned within
4107 * the space given for the whole box widget.
4109 * @param obj The box object
4110 * @param horizontal The horizontal alignment of elements
4111 * @param vertical The vertical alignment of elements
4113 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
4115 * Get the alignment of the whole bouding box of contents.
4117 * @param obj The box object
4118 * @param horizontal The horizontal alignment of elements
4119 * @param vertical The vertical alignment of elements
4121 * @see elm_box_align_set()
4123 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
4126 * Set the layout defining function to be used by the box
4128 * Whenever anything changes that requires the box in @p obj to recalculate
4129 * the size and position of its elements, the function @p cb will be called
4130 * to determine what the layout of the children will be.
4132 * Once a custom function is set, everything about the children layout
4133 * is defined by it. The flags set by elm_box_horizontal_set() and
4134 * elm_box_homogeneous_set() no longer have any meaning, and the values
4135 * given by elm_box_padding_set() and elm_box_align_set() are up to this
4136 * layout function to decide if they are used and how. These last two
4137 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
4138 * passed to @p cb. The @c Evas_Object the function receives is not the
4139 * Elementary widget, but the internal Evas Box it uses, so none of the
4140 * functions described here can be used on it.
4142 * Any of the layout functions in @c Evas can be used here, as well as the
4143 * special elm_box_layout_transition().
4145 * The final @p data argument received by @p cb is the same @p data passed
4146 * here, and the @p free_data function will be called to free it
4147 * whenever the box is destroyed or another layout function is set.
4149 * Setting @p cb to NULL will revert back to the default layout function.
4151 * @param obj The box object
4152 * @param cb The callback function used for layout
4153 * @param data Data that will be passed to layout function
4154 * @param free_data Function called to free @p data
4156 * @see elm_box_layout_transition()
4158 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);
4160 * Special layout function that animates the transition from one layout to another
4162 * Normally, when switching the layout function for a box, this will be
4163 * reflected immediately on screen on the next render, but it's also
4164 * possible to do this through an animated transition.
4166 * This is done by creating an ::Elm_Box_Transition and setting the box
4167 * layout to this function.
4171 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
4172 * evas_object_box_layout_vertical, // start
4173 * NULL, // data for initial layout
4174 * NULL, // free function for initial data
4175 * evas_object_box_layout_horizontal, // end
4176 * NULL, // data for final layout
4177 * NULL, // free function for final data
4178 * anim_end, // will be called when animation ends
4179 * NULL); // data for anim_end function\
4180 * elm_box_layout_set(box, elm_box_layout_transition, t,
4181 * elm_box_transition_free);
4184 * @note This function can only be used with elm_box_layout_set(). Calling
4185 * it directly will not have the expected results.
4187 * @see elm_box_transition_new
4188 * @see elm_box_transition_free
4189 * @see elm_box_layout_set
4191 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
4193 * Create a new ::Elm_Box_Transition to animate the switch of layouts
4195 * If you want to animate the change from one layout to another, you need
4196 * to set the layout function of the box to elm_box_layout_transition(),
4197 * passing as user data to it an instance of ::Elm_Box_Transition with the
4198 * necessary information to perform this animation. The free function to
4199 * set for the layout is elm_box_transition_free().
4201 * The parameters to create an ::Elm_Box_Transition sum up to how long
4202 * will it be, in seconds, a layout function to describe the initial point,
4203 * another for the final position of the children and one function to be
4204 * called when the whole animation ends. This last function is useful to
4205 * set the definitive layout for the box, usually the same as the end
4206 * layout for the animation, but could be used to start another transition.
4208 * @param start_layout The layout function that will be used to start the animation
4209 * @param start_layout_data The data to be passed the @p start_layout function
4210 * @param start_layout_free_data Function to free @p start_layout_data
4211 * @param end_layout The layout function that will be used to end the animation
4212 * @param end_layout_free_data The data to be passed the @p end_layout function
4213 * @param end_layout_free_data Function to free @p end_layout_data
4214 * @param transition_end_cb Callback function called when animation ends
4215 * @param transition_end_data Data to be passed to @p transition_end_cb
4216 * @return An instance of ::Elm_Box_Transition
4218 * @see elm_box_transition_new
4219 * @see elm_box_layout_transition
4221 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);
4223 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
4225 * This function is mostly useful as the @c free_data parameter in
4226 * elm_box_layout_set() when elm_box_layout_transition().
4228 * @param data The Elm_Box_Transition instance to be freed.
4230 * @see elm_box_transition_new
4231 * @see elm_box_layout_transition
4233 EAPI void elm_box_transition_free(void *data);
4240 * @defgroup Button Button
4242 * @image html img/widget/button/preview-00.png
4243 * @image latex img/widget/button/preview-00.eps
4244 * @image html img/widget/button/preview-01.png
4245 * @image latex img/widget/button/preview-01.eps
4246 * @image html img/widget/button/preview-02.png
4247 * @image latex img/widget/button/preview-02.eps
4249 * This is a push-button. Press it and run some function. It can contain
4250 * a simple label and icon object and it also has an autorepeat feature.
4252 * This widgets emits the following signals:
4253 * @li "clicked": the user clicked the button (press/release).
4254 * @li "repeated": the user pressed the button without releasing it.
4255 * @li "pressed": button was pressed.
4256 * @li "unpressed": button was released after being pressed.
4257 * In all three cases, the @c event parameter of the callback will be
4260 * Also, defined in the default theme, the button has the following styles
4262 * @li default: a normal button.
4263 * @li anchor: Like default, but the button fades away when the mouse is not
4264 * over it, leaving only the text or icon.
4265 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4266 * continuous look across its options.
4267 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4269 * Follow through a complete example @ref button_example_01 "here".
4273 * Add a new button to the parent's canvas
4275 * @param parent The parent object
4276 * @return The new object or NULL if it cannot be created
4278 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4280 * Set the label used in the button
4282 * The passed @p label can be NULL to clean any existing text in it and
4283 * leave the button as an icon only object.
4285 * @param obj The button object
4286 * @param label The text will be written on the button
4287 * @deprecated use elm_object_text_set() instead.
4289 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4291 * Get the label set for the button
4293 * The string returned is an internal pointer and should not be freed or
4294 * altered. It will also become invalid when the button is destroyed.
4295 * The string returned, if not NULL, is a stringshare, so if you need to
4296 * keep it around even after the button is destroyed, you can use
4297 * eina_stringshare_ref().
4299 * @param obj The button object
4300 * @return The text set to the label, or NULL if nothing is set
4301 * @deprecated use elm_object_text_set() instead.
4303 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4305 * Set the icon used for the button
4307 * Setting a new icon will delete any other that was previously set, making
4308 * any reference to them invalid. If you need to maintain the previous
4309 * object alive, unset it first with elm_button_icon_unset().
4311 * @param obj The button object
4312 * @param icon The icon object for the button
4314 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4316 * Get the icon used for the button
4318 * Return the icon object which is set for this widget. If the button is
4319 * destroyed or another icon is set, the returned object will be deleted
4320 * and any reference to it will be invalid.
4322 * @param obj The button object
4323 * @return The icon object that is being used
4325 * @see elm_button_icon_unset()
4327 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4329 * Remove the icon set without deleting it and return the object
4331 * This function drops the reference the button holds of the icon object
4332 * and returns this last object. It is used in case you want to remove any
4333 * icon, or set another one, without deleting the actual object. The button
4334 * will be left without an icon set.
4336 * @param obj The button object
4337 * @return The icon object that was being used
4339 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4341 * Turn on/off the autorepeat event generated when the button is kept pressed
4343 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4344 * signal when they are clicked.
4346 * When on, keeping a button pressed will continuously emit a @c repeated
4347 * signal until the button is released. The time it takes until it starts
4348 * emitting the signal is given by
4349 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4350 * new emission by elm_button_autorepeat_gap_timeout_set().
4352 * @param obj The button object
4353 * @param on A bool to turn on/off the event
4355 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4357 * Get whether the autorepeat feature is enabled
4359 * @param obj The button object
4360 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4362 * @see elm_button_autorepeat_set()
4364 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4366 * Set the initial timeout before the autorepeat event is generated
4368 * Sets the timeout, in seconds, since the button is pressed until the
4369 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4370 * won't be any delay and the even will be fired the moment the button is
4373 * @param obj The button object
4374 * @param t Timeout in seconds
4376 * @see elm_button_autorepeat_set()
4377 * @see elm_button_autorepeat_gap_timeout_set()
4379 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4381 * Get the initial timeout before the autorepeat event is generated
4383 * @param obj The button object
4384 * @return Timeout in seconds
4386 * @see elm_button_autorepeat_initial_timeout_set()
4388 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4390 * Set the interval between each generated autorepeat event
4392 * After the first @c repeated event is fired, all subsequent ones will
4393 * follow after a delay of @p t seconds for each.
4395 * @param obj The button object
4396 * @param t Interval in seconds
4398 * @see elm_button_autorepeat_initial_timeout_set()
4400 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4402 * Get the interval between each generated autorepeat event
4404 * @param obj The button object
4405 * @return Interval in seconds
4407 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4413 * @defgroup File_Selector_Button File Selector Button
4415 * @image html img/widget/fileselector_button/preview-00.png
4416 * @image latex img/widget/fileselector_button/preview-00.eps
4417 * @image html img/widget/fileselector_button/preview-01.png
4418 * @image latex img/widget/fileselector_button/preview-01.eps
4419 * @image html img/widget/fileselector_button/preview-02.png
4420 * @image latex img/widget/fileselector_button/preview-02.eps
4422 * This is a button that, when clicked, creates an Elementary
4423 * window (or inner window) <b> with a @ref Fileselector "file
4424 * selector widget" within</b>. When a file is chosen, the (inner)
4425 * window is closed and the button emits a signal having the
4426 * selected file as it's @c event_info.
4428 * This widget encapsulates operations on its internal file
4429 * selector on its own API. There is less control over its file
4430 * selector than that one would have instatiating one directly.
4432 * The following styles are available for this button:
4435 * @li @c "hoversel_vertical"
4436 * @li @c "hoversel_vertical_entry"
4438 * Smart callbacks one can register to:
4439 * - @c "file,chosen" - the user has selected a path, whose string
4440 * pointer comes as the @c event_info data (a stringshared
4443 * Here is an example on its usage:
4444 * @li @ref fileselector_button_example
4446 * @see @ref File_Selector_Entry for a similar widget.
4451 * Add a new file selector button widget to the given parent
4452 * Elementary (container) object
4454 * @param parent The parent object
4455 * @return a new file selector button widget handle or @c NULL, on
4458 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4461 * Set the label for a given file selector button widget
4463 * @param obj The file selector button widget
4464 * @param label The text label to be displayed on @p obj
4466 * @deprecated use elm_object_text_set() instead.
4468 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4471 * Get the label set for a given file selector button widget
4473 * @param obj The file selector button widget
4474 * @return The button label
4476 * @deprecated use elm_object_text_set() instead.
4478 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4481 * Set the icon on a given file selector button widget
4483 * @param obj The file selector button widget
4484 * @param icon The icon object for the button
4486 * Once the icon object is set, a previously set one will be
4487 * deleted. If you want to keep the latter, use the
4488 * elm_fileselector_button_icon_unset() function.
4490 * @see elm_fileselector_button_icon_get()
4492 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4495 * Get the icon set for a given file selector button widget
4497 * @param obj The file selector button widget
4498 * @return The icon object currently set on @p obj or @c NULL, if
4501 * @see elm_fileselector_button_icon_set()
4503 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4506 * Unset the icon used in a given file selector button widget
4508 * @param obj The file selector button widget
4509 * @return The icon object that was being used on @p obj or @c
4512 * Unparent and return the icon object which was set for this
4515 * @see elm_fileselector_button_icon_set()
4517 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4520 * Set the title for a given file selector button widget's window
4522 * @param obj The file selector button widget
4523 * @param title The title string
4525 * This will change the window's title, when the file selector pops
4526 * out after a click on the button. Those windows have the default
4527 * (unlocalized) value of @c "Select a file" as titles.
4529 * @note It will only take any effect if the file selector
4530 * button widget is @b not under "inwin mode".
4532 * @see elm_fileselector_button_window_title_get()
4534 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4537 * Get the title set for a given file selector button widget's
4540 * @param obj The file selector button widget
4541 * @return Title of the file selector button's window
4543 * @see elm_fileselector_button_window_title_get() for more details
4545 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4548 * Set the size of a given file selector button widget's window,
4549 * holding the file selector itself.
4551 * @param obj The file selector button widget
4552 * @param width The window's width
4553 * @param height The window's height
4555 * @note it will only take any effect if the file selector button
4556 * widget is @b not under "inwin mode". The default size for the
4557 * window (when applicable) is 400x400 pixels.
4559 * @see elm_fileselector_button_window_size_get()
4561 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4564 * Get the size of a given file selector button widget's window,
4565 * holding the file selector itself.
4567 * @param obj The file selector button widget
4568 * @param width Pointer into which to store the width value
4569 * @param height Pointer into which to store the height value
4571 * @note Use @c NULL pointers on the size values you're not
4572 * interested in: they'll be ignored by the function.
4574 * @see elm_fileselector_button_window_size_set(), for more details
4576 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4579 * Set the initial file system path for a given file selector
4582 * @param obj The file selector button widget
4583 * @param path The path string
4585 * It must be a <b>directory</b> path, which will have the contents
4586 * displayed initially in the file selector's view, when invoked
4587 * from @p obj. The default initial path is the @c "HOME"
4588 * environment variable's value.
4590 * @see elm_fileselector_button_path_get()
4592 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4595 * Get the initial file system path set for a given file selector
4598 * @param obj The file selector button widget
4599 * @return path The path string
4601 * @see elm_fileselector_button_path_set() for more details
4603 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4606 * Enable/disable a tree view in the given file selector button
4607 * widget's internal file selector
4609 * @param obj The file selector button widget
4610 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4613 * This has the same effect as elm_fileselector_expandable_set(),
4614 * but now applied to a file selector button's internal file
4617 * @note There's no way to put a file selector button's internal
4618 * file selector in "grid mode", as one may do with "pure" file
4621 * @see elm_fileselector_expandable_get()
4623 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4626 * Get whether tree view is enabled for the given file selector
4627 * button widget's internal file selector
4629 * @param obj The file selector button widget
4630 * @return @c EINA_TRUE if @p obj widget's internal file selector
4631 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4633 * @see elm_fileselector_expandable_set() for more details
4635 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4638 * Set whether a given file selector button widget's internal file
4639 * selector is to display folders only or the directory contents,
4642 * @param obj The file selector button widget
4643 * @param only @c EINA_TRUE to make @p obj widget's internal file
4644 * selector only display directories, @c EINA_FALSE to make files
4645 * to be displayed in it too
4647 * This has the same effect as elm_fileselector_folder_only_set(),
4648 * but now applied to a file selector button's internal file
4651 * @see elm_fileselector_folder_only_get()
4653 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4656 * Get whether a given file selector button widget's internal file
4657 * selector is displaying folders only or the directory contents,
4660 * @param obj The file selector button widget
4661 * @return @c EINA_TRUE if @p obj widget's internal file
4662 * selector is only displaying directories, @c EINA_FALSE if files
4663 * are being displayed in it too (and on errors)
4665 * @see elm_fileselector_button_folder_only_set() for more details
4667 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4670 * Enable/disable the file name entry box where the user can type
4671 * in a name for a file, in a given file selector button widget's
4672 * internal file selector.
4674 * @param obj The file selector button widget
4675 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4676 * file selector a "saving dialog", @c EINA_FALSE otherwise
4678 * This has the same effect as elm_fileselector_is_save_set(),
4679 * but now applied to a file selector button's internal file
4682 * @see elm_fileselector_is_save_get()
4684 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4687 * Get whether the given file selector button widget's internal
4688 * file selector is in "saving dialog" mode
4690 * @param obj The file selector button widget
4691 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4692 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4695 * @see elm_fileselector_button_is_save_set() for more details
4697 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4700 * Set whether a given file selector button widget's internal file
4701 * selector will raise an Elementary "inner window", instead of a
4702 * dedicated Elementary window. By default, it won't.
4704 * @param obj The file selector button widget
4705 * @param value @c EINA_TRUE to make it use an inner window, @c
4706 * EINA_TRUE to make it use a dedicated window
4708 * @see elm_win_inwin_add() for more information on inner windows
4709 * @see elm_fileselector_button_inwin_mode_get()
4711 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4714 * Get whether a given file selector button widget's internal file
4715 * selector will raise an Elementary "inner window", instead of a
4716 * dedicated Elementary window.
4718 * @param obj The file selector button widget
4719 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4720 * if it will use a dedicated window
4722 * @see elm_fileselector_button_inwin_mode_set() for more details
4724 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4731 * @defgroup File_Selector_Entry File Selector Entry
4733 * @image html img/widget/fileselector_entry/preview-00.png
4734 * @image latex img/widget/fileselector_entry/preview-00.eps
4736 * This is an entry made to be filled with or display a <b>file
4737 * system path string</b>. Besides the entry itself, the widget has
4738 * a @ref File_Selector_Button "file selector button" on its side,
4739 * which will raise an internal @ref Fileselector "file selector widget",
4740 * when clicked, for path selection aided by file system
4743 * This file selector may appear in an Elementary window or in an
4744 * inner window. When a file is chosen from it, the (inner) window
4745 * is closed and the selected file's path string is exposed both as
4746 * an smart event and as the new text on the entry.
4748 * This widget encapsulates operations on its internal file
4749 * selector on its own API. There is less control over its file
4750 * selector than that one would have instatiating one directly.
4752 * Smart callbacks one can register to:
4753 * - @c "changed" - The text within the entry was changed
4754 * - @c "activated" - The entry has had editing finished and
4755 * changes are to be "committed"
4756 * - @c "press" - The entry has been clicked
4757 * - @c "longpressed" - The entry has been clicked (and held) for a
4759 * - @c "clicked" - The entry has been clicked
4760 * - @c "clicked,double" - The entry has been double clicked
4761 * - @c "focused" - The entry has received focus
4762 * - @c "unfocused" - The entry has lost focus
4763 * - @c "selection,paste" - A paste action has occurred on the
4765 * - @c "selection,copy" - A copy action has occurred on the entry
4766 * - @c "selection,cut" - A cut action has occurred on the entry
4767 * - @c "unpressed" - The file selector entry's button was released
4768 * after being pressed.
4769 * - @c "file,chosen" - The user has selected a path via the file
4770 * selector entry's internal file selector, whose string pointer
4771 * comes as the @c event_info data (a stringshared string)
4773 * Here is an example on its usage:
4774 * @li @ref fileselector_entry_example
4776 * @see @ref File_Selector_Button for a similar widget.
4781 * Add a new file selector entry widget to the given parent
4782 * Elementary (container) object
4784 * @param parent The parent object
4785 * @return a new file selector entry widget handle or @c NULL, on
4788 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4791 * Set the label for a given file selector entry widget's button
4793 * @param obj The file selector entry widget
4794 * @param label The text label to be displayed on @p obj widget's
4797 * @deprecated use elm_object_text_set() instead.
4799 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4802 * Get the label set for a given file selector entry widget's button
4804 * @param obj The file selector entry widget
4805 * @return The widget button's label
4807 * @deprecated use elm_object_text_set() instead.
4809 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4812 * Set the icon on a given file selector entry widget's button
4814 * @param obj The file selector entry widget
4815 * @param icon The icon object for the entry's button
4817 * Once the icon object is set, a previously set one will be
4818 * deleted. If you want to keep the latter, use the
4819 * elm_fileselector_entry_button_icon_unset() function.
4821 * @see elm_fileselector_entry_button_icon_get()
4823 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4826 * Get the icon set for a given file selector entry widget's button
4828 * @param obj The file selector entry widget
4829 * @return The icon object currently set on @p obj widget's button
4830 * or @c NULL, if none is
4832 * @see elm_fileselector_entry_button_icon_set()
4834 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4837 * Unset the icon used in a given file selector entry widget's
4840 * @param obj The file selector entry widget
4841 * @return The icon object that was being used on @p obj widget's
4842 * button or @c NULL, on errors
4844 * Unparent and return the icon object which was set for this
4847 * @see elm_fileselector_entry_button_icon_set()
4849 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4852 * Set the title for a given file selector entry widget's window
4854 * @param obj The file selector entry widget
4855 * @param title The title string
4857 * This will change the window's title, when the file selector pops
4858 * out after a click on the entry's button. Those windows have the
4859 * default (unlocalized) value of @c "Select a file" as titles.
4861 * @note It will only take any effect if the file selector
4862 * entry widget is @b not under "inwin mode".
4864 * @see elm_fileselector_entry_window_title_get()
4866 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4869 * Get the title set for a given file selector entry widget's
4872 * @param obj The file selector entry widget
4873 * @return Title of the file selector entry's window
4875 * @see elm_fileselector_entry_window_title_get() for more details
4877 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4880 * Set the size of a given file selector entry widget's window,
4881 * holding the file selector itself.
4883 * @param obj The file selector entry widget
4884 * @param width The window's width
4885 * @param height The window's height
4887 * @note it will only take any effect if the file selector entry
4888 * widget is @b not under "inwin mode". The default size for the
4889 * window (when applicable) is 400x400 pixels.
4891 * @see elm_fileselector_entry_window_size_get()
4893 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4896 * Get the size of a given file selector entry widget's window,
4897 * holding the file selector itself.
4899 * @param obj The file selector entry widget
4900 * @param width Pointer into which to store the width value
4901 * @param height Pointer into which to store the height value
4903 * @note Use @c NULL pointers on the size values you're not
4904 * interested in: they'll be ignored by the function.
4906 * @see elm_fileselector_entry_window_size_set(), for more details
4908 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4911 * Set the initial file system path and the entry's path string for
4912 * a given file selector entry widget
4914 * @param obj The file selector entry widget
4915 * @param path The path string
4917 * It must be a <b>directory</b> path, which will have the contents
4918 * displayed initially in the file selector's view, when invoked
4919 * from @p obj. The default initial path is the @c "HOME"
4920 * environment variable's value.
4922 * @see elm_fileselector_entry_path_get()
4924 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4927 * Get the entry's path string for a given file selector entry
4930 * @param obj The file selector entry widget
4931 * @return path The path string
4933 * @see elm_fileselector_entry_path_set() for more details
4935 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4938 * Enable/disable a tree view in the given file selector entry
4939 * widget's internal file selector
4941 * @param obj The file selector entry widget
4942 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4945 * This has the same effect as elm_fileselector_expandable_set(),
4946 * but now applied to a file selector entry's internal file
4949 * @note There's no way to put a file selector entry's internal
4950 * file selector in "grid mode", as one may do with "pure" file
4953 * @see elm_fileselector_expandable_get()
4955 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4958 * Get whether tree view is enabled for the given file selector
4959 * entry widget's internal file selector
4961 * @param obj The file selector entry widget
4962 * @return @c EINA_TRUE if @p obj widget's internal file selector
4963 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4965 * @see elm_fileselector_expandable_set() for more details
4967 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4970 * Set whether a given file selector entry widget's internal file
4971 * selector is to display folders only or the directory contents,
4974 * @param obj The file selector entry widget
4975 * @param only @c EINA_TRUE to make @p obj widget's internal file
4976 * selector only display directories, @c EINA_FALSE to make files
4977 * to be displayed in it too
4979 * This has the same effect as elm_fileselector_folder_only_set(),
4980 * but now applied to a file selector entry's internal file
4983 * @see elm_fileselector_folder_only_get()
4985 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4988 * Get whether a given file selector entry widget's internal file
4989 * selector is displaying folders only or the directory contents,
4992 * @param obj The file selector entry widget
4993 * @return @c EINA_TRUE if @p obj widget's internal file
4994 * selector is only displaying directories, @c EINA_FALSE if files
4995 * are being displayed in it too (and on errors)
4997 * @see elm_fileselector_entry_folder_only_set() for more details
4999 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5002 * Enable/disable the file name entry box where the user can type
5003 * in a name for a file, in a given file selector entry widget's
5004 * internal file selector.
5006 * @param obj The file selector entry widget
5007 * @param is_save @c EINA_TRUE to make @p obj widget's internal
5008 * file selector a "saving dialog", @c EINA_FALSE otherwise
5010 * This has the same effect as elm_fileselector_is_save_set(),
5011 * but now applied to a file selector entry's internal file
5014 * @see elm_fileselector_is_save_get()
5016 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5019 * Get whether the given file selector entry widget's internal
5020 * file selector is in "saving dialog" mode
5022 * @param obj The file selector entry widget
5023 * @return @c EINA_TRUE, if @p obj widget's internal file selector
5024 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
5027 * @see elm_fileselector_entry_is_save_set() for more details
5029 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5032 * Set whether a given file selector entry widget's internal file
5033 * selector will raise an Elementary "inner window", instead of a
5034 * dedicated Elementary window. By default, it won't.
5036 * @param obj The file selector entry widget
5037 * @param value @c EINA_TRUE to make it use an inner window, @c
5038 * EINA_TRUE to make it use a dedicated window
5040 * @see elm_win_inwin_add() for more information on inner windows
5041 * @see elm_fileselector_entry_inwin_mode_get()
5043 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
5046 * Get whether a given file selector entry widget's internal file
5047 * selector will raise an Elementary "inner window", instead of a
5048 * dedicated Elementary window.
5050 * @param obj The file selector entry widget
5051 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
5052 * if it will use a dedicated window
5054 * @see elm_fileselector_entry_inwin_mode_set() for more details
5056 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5059 * Set the initial file system path for a given file selector entry
5062 * @param obj The file selector entry widget
5063 * @param path The path string
5065 * It must be a <b>directory</b> path, which will have the contents
5066 * displayed initially in the file selector's view, when invoked
5067 * from @p obj. The default initial path is the @c "HOME"
5068 * environment variable's value.
5070 * @see elm_fileselector_entry_path_get()
5072 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
5075 * Get the parent directory's path to the latest file selection on
5076 * a given filer selector entry widget
5078 * @param obj The file selector object
5079 * @return The (full) path of the directory of the last selection
5080 * on @p obj widget, a @b stringshared string
5082 * @see elm_fileselector_entry_path_set()
5084 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5091 * @defgroup Scroller Scroller
5093 * A scroller holds a single object and "scrolls it around". This means that
5094 * it allows the user to use a scrollbar (or a finger) to drag the viewable
5095 * region around, allowing to move through a much larger object that is
5096 * contained in the scroller. The scroiller will always have a small minimum
5097 * size by default as it won't be limited by the contents of the scroller.
5099 * Signals that you can add callbacks for are:
5100 * @li "edge,left" - the left edge of the content has been reached
5101 * @li "edge,right" - the right edge of the content has been reached
5102 * @li "edge,top" - the top edge of the content has been reached
5103 * @li "edge,bottom" - the bottom edge of the content has been reached
5104 * @li "scroll" - the content has been scrolled (moved)
5105 * @li "scroll,anim,start" - scrolling animation has started
5106 * @li "scroll,anim,stop" - scrolling animation has stopped
5107 * @li "scroll,drag,start" - dragging the contents around has started
5108 * @li "scroll,drag,stop" - dragging the contents around has stopped
5109 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
5112 * @note When Elemementary is in embedded mode the scrollbars will not be
5113 * dragable, they appear merely as indicators of how much has been scrolled.
5114 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
5115 * fingerscroll) won't work.
5117 * In @ref tutorial_scroller you'll find an example of how to use most of
5122 * @brief Type that controls when scrollbars should appear.
5124 * @see elm_scroller_policy_set()
5126 typedef enum _Elm_Scroller_Policy
5128 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
5129 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
5130 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
5131 ELM_SCROLLER_POLICY_LAST
5132 } Elm_Scroller_Policy;
5134 * @brief Add a new scroller to the parent
5136 * @param parent The parent object
5137 * @return The new object or NULL if it cannot be created
5139 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5141 * @brief Set the content of the scroller widget (the object to be scrolled around).
5143 * @param obj The scroller object
5144 * @param content The new content object
5146 * Once the content object is set, a previously set one will be deleted.
5147 * If you want to keep that old content object, use the
5148 * elm_scroller_content_unset() function.
5150 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
5152 * @brief Get the content of the scroller widget
5154 * @param obj The slider object
5155 * @return The content that is being used
5157 * Return the content object which is set for this widget
5159 * @see elm_scroller_content_set()
5161 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5163 * @brief Unset the content of the scroller widget
5165 * @param obj The slider object
5166 * @return The content that was being used
5168 * Unparent and return the content object which was set for this widget
5170 * @see elm_scroller_content_set()
5172 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5174 * @brief Set custom theme elements for the scroller
5176 * @param obj The scroller object
5177 * @param widget The widget name to use (default is "scroller")
5178 * @param base The base name to use (default is "base")
5180 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
5182 * @brief Make the scroller minimum size limited to the minimum size of the content
5184 * @param obj The scroller object
5185 * @param w Enable limiting minimum size horizontally
5186 * @param h Enable limiting minimum size vertically
5188 * By default the scroller will be as small as its design allows,
5189 * irrespective of its content. This will make the scroller minimum size the
5190 * right size horizontally and/or vertically to perfectly fit its content in
5193 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
5195 * @brief Show a specific virtual region within the scroller content object
5197 * @param obj The scroller object
5198 * @param x X coordinate of the region
5199 * @param y Y coordinate of the region
5200 * @param w Width of the region
5201 * @param h Height of the region
5203 * This will ensure all (or part if it does not fit) of the designated
5204 * region in the virtual content object (0, 0 starting at the top-left of the
5205 * virtual content object) is shown within the scroller.
5207 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);
5209 * @brief Set the scrollbar visibility policy
5211 * @param obj The scroller object
5212 * @param policy_h Horizontal scrollbar policy
5213 * @param policy_v Vertical scrollbar policy
5215 * This sets the scrollbar visibility policy for the given scroller.
5216 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
5217 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
5218 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
5219 * respectively for the horizontal and vertical scrollbars.
5221 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5223 * @brief Gets scrollbar visibility policy
5225 * @param obj The scroller object
5226 * @param policy_h Horizontal scrollbar policy
5227 * @param policy_v Vertical scrollbar policy
5229 * @see elm_scroller_policy_set()
5231 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
5233 * @brief Get the currently visible content region
5235 * @param obj The scroller object
5236 * @param x X coordinate of the region
5237 * @param y Y coordinate of the region
5238 * @param w Width of the region
5239 * @param h Height of the region
5241 * This gets the current region in the content object that is visible through
5242 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
5243 * w, @p h values pointed to.
5245 * @note All coordinates are relative to the content.
5247 * @see elm_scroller_region_show()
5249 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);
5251 * @brief Get the size of the content object
5253 * @param obj The scroller object
5254 * @param w Width return
5255 * @param h Height return
5257 * This gets the size of the content object of the scroller.
5259 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5261 * @brief Set bouncing behavior
5263 * @param obj The scroller object
5264 * @param h_bounce Will the scroller bounce horizontally or not
5265 * @param v_bounce Will the scroller bounce vertically or not
5267 * When scrolling, the scroller may "bounce" when reaching an edge of the
5268 * content object. This is a visual way to indicate the end has been reached.
5269 * This is enabled by default for both axis. This will set if it is enabled
5270 * for that axis with the boolean parameters for each axis.
5272 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5274 * @brief Get the bounce mode
5276 * @param obj The Scroller object
5277 * @param h_bounce Allow bounce horizontally
5278 * @param v_bounce Allow bounce vertically
5280 * @see elm_scroller_bounce_set()
5282 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5284 * @brief Set scroll page size relative to viewport size.
5286 * @param obj The scroller object
5287 * @param h_pagerel The horizontal page relative size
5288 * @param v_pagerel The vertical page relative size
5290 * The scroller is capable of limiting scrolling by the user to "pages". That
5291 * is to jump by and only show a "whole page" at a time as if the continuous
5292 * area of the scroller content is split into page sized pieces. This sets
5293 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5294 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5295 * axis. This is mutually exclusive with page size
5296 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5297 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5298 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5301 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5303 * @brief Set scroll page size.
5305 * @param obj The scroller object
5306 * @param h_pagesize The horizontal page size
5307 * @param v_pagesize The vertical page size
5309 * This sets the page size to an absolute fixed value, with 0 turning it off
5312 * @see elm_scroller_page_relative_set()
5314 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5316 * @brief Show a specific virtual region within the scroller content object.
5318 * @param obj The scroller object
5319 * @param x X coordinate of the region
5320 * @param y Y coordinate of the region
5321 * @param w Width of the region
5322 * @param h Height of the region
5324 * This will ensure all (or part if it does not fit) of the designated
5325 * region in the virtual content object (0, 0 starting at the top-left of the
5326 * virtual content object) is shown within the scroller. Unlike
5327 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5328 * to this location (if configuration in general calls for transitions). It
5329 * may not jump immediately to the new location and make take a while and
5330 * show other content along the way.
5332 * @see elm_scroller_region_show()
5334 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);
5336 * @brief Set event propagation on a scroller
5338 * @param obj The scroller object
5339 * @param propagation If propagation is enabled or not
5341 * This enables or disabled event propagation from the scroller content to
5342 * the scroller and its parent. By default event propagation is disabled.
5344 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5346 * @brief Get event propagation for a scroller
5348 * @param obj The scroller object
5349 * @return The propagation state
5351 * This gets the event propagation for a scroller.
5353 * @see elm_scroller_propagate_events_set()
5355 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5361 * @defgroup Label Label
5363 * @image html img/widget/label/preview-00.png
5364 * @image latex img/widget/label/preview-00.eps
5366 * @brief Widget to display text, with simple html-like markup.
5368 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5369 * text doesn't fit the geometry of the label it will be ellipsized or be
5370 * cut. Elementary provides several themes for this widget:
5371 * @li default - No animation
5372 * @li marker - Centers the text in the label and make it bold by default
5373 * @li slide_long - The entire text appears from the right of the screen and
5374 * slides until it disappears in the left of the screen(reappering on the
5376 * @li slide_short - The text appears in the left of the label and slides to
5377 * the right to show the overflow. When all of the text has been shown the
5378 * position is reset.
5379 * @li slide_bounce - The text appears in the left of the label and slides to
5380 * the right to show the overflow. When all of the text has been shown the
5381 * animation reverses, moving the text to the left.
5383 * Custom themes can of course invent new markup tags and style them any way
5386 * See @ref tutorial_label for a demonstration of how to use a label widget.
5390 * @brief Add a new label to the parent
5392 * @param parent The parent object
5393 * @return The new object or NULL if it cannot be created
5395 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5397 * @brief Set the label on the label object
5399 * @param obj The label object
5400 * @param label The label will be used on the label object
5401 * @deprecated See elm_object_text_set()
5403 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 */
5405 * @brief Get the label used on the label object
5407 * @param obj The label object
5408 * @return The string inside the label
5409 * @deprecated See elm_object_text_get()
5411 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5413 * @brief Set the wrapping behavior of the label
5415 * @param obj The label object
5416 * @param wrap To wrap text or not
5418 * By default no wrapping is done. Possible values for @p wrap are:
5419 * @li ELM_WRAP_NONE - No wrapping
5420 * @li ELM_WRAP_CHAR - wrap between characters
5421 * @li ELM_WRAP_WORD - wrap between words
5422 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5424 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5426 * @brief Get the wrapping behavior of the label
5428 * @param obj The label object
5431 * @see elm_label_line_wrap_set()
5433 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5435 * @brief Set wrap width of the label
5437 * @param obj The label object
5438 * @param w The wrap width in pixels at a minimum where words need to wrap
5440 * This function sets the maximum width size hint of the label.
5442 * @warning This is only relevant if the label is inside a container.
5444 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5446 * @brief Get wrap width of the label
5448 * @param obj The label object
5449 * @return The wrap width in pixels at a minimum where words need to wrap
5451 * @see elm_label_wrap_width_set()
5453 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5455 * @brief Set wrap height of the label
5457 * @param obj The label object
5458 * @param h The wrap height in pixels at a minimum where words need to wrap
5460 * This function sets the maximum height size hint of the label.
5462 * @warning This is only relevant if the label is inside a container.
5464 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5466 * @brief get wrap width of the label
5468 * @param obj The label object
5469 * @return The wrap height in pixels at a minimum where words need to wrap
5471 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5473 * @brief Set the font size on the label object.
5475 * @param obj The label object
5476 * @param size font size
5478 * @warning NEVER use this. It is for hyper-special cases only. use styles
5479 * instead. e.g. "big", "medium", "small" - or better name them by use:
5480 * "title", "footnote", "quote" etc.
5482 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5484 * @brief Set the text color on the label object
5486 * @param obj The label object
5487 * @param r Red property background color of The label object
5488 * @param g Green property background color of The label object
5489 * @param b Blue property background color of The label object
5490 * @param a Alpha property background color of The label object
5492 * @warning NEVER use this. It is for hyper-special cases only. use styles
5493 * instead. e.g. "big", "medium", "small" - or better name them by use:
5494 * "title", "footnote", "quote" etc.
5496 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);
5498 * @brief Set the text align on the label object
5500 * @param obj The label object
5501 * @param align align mode ("left", "center", "right")
5503 * @warning NEVER use this. It is for hyper-special cases only. use styles
5504 * instead. e.g. "big", "medium", "small" - or better name them by use:
5505 * "title", "footnote", "quote" etc.
5507 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5509 * @brief Set background color of the label
5511 * @param obj The label object
5512 * @param r Red property background color of The label object
5513 * @param g Green property background color of The label object
5514 * @param b Blue property background color of The label object
5515 * @param a Alpha property background alpha of The label object
5517 * @warning NEVER use this. It is for hyper-special cases only. use styles
5518 * instead. e.g. "big", "medium", "small" - or better name them by use:
5519 * "title", "footnote", "quote" etc.
5521 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);
5523 * @brief Set the ellipsis behavior of the label
5525 * @param obj The label object
5526 * @param ellipsis To ellipsis text or not
5528 * If set to true and the text doesn't fit in the label an ellipsis("...")
5529 * will be shown at the end of the widget.
5531 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5532 * choosen wrap method was ELM_WRAP_WORD.
5534 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5536 * @brief Set the text slide of the label
5538 * @param obj The label object
5539 * @param slide To start slide or stop
5541 * If set to true the text of the label will slide throught the length of
5544 * @warning This only work with the themes "slide_short", "slide_long" and
5547 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5549 * @brief Get the text slide mode of the label
5551 * @param obj The label object
5552 * @return slide slide mode value
5554 * @see elm_label_slide_set()
5556 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5558 * @brief Set the slide duration(speed) of the label
5560 * @param obj The label object
5561 * @return The duration in seconds in moving text from slide begin position
5562 * to slide end position
5564 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5566 * @brief Get the slide duration(speed) of the label
5568 * @param obj The label object
5569 * @return The duration time in moving text from slide begin position to slide end position
5571 * @see elm_label_slide_duration_set()
5573 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5579 * @defgroup Toggle Toggle
5581 * @image html img/widget/toggle/preview-00.png
5582 * @image latex img/widget/toggle/preview-00.eps
5584 * @brief A toggle is a slider which can be used to toggle between
5585 * two values. It has two states: on and off.
5587 * Signals that you can add callbacks for are:
5588 * @li "changed" - Whenever the toggle value has been changed. Is not called
5589 * until the toggle is released by the cursor (assuming it
5590 * has been triggered by the cursor in the first place).
5592 * @ref tutorial_toggle show how to use a toggle.
5596 * @brief Add a toggle to @p parent.
5598 * @param parent The parent object
5600 * @return The toggle object
5602 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5604 * @brief Sets the label to be displayed with the toggle.
5606 * @param obj The toggle object
5607 * @param label The label to be displayed
5609 * @deprecated use elm_object_text_set() instead.
5611 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5613 * @brief Gets the label of the toggle
5615 * @param obj toggle object
5616 * @return The label of the toggle
5618 * @deprecated use elm_object_text_get() instead.
5620 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5622 * @brief Set the icon used for the toggle
5624 * @param obj The toggle object
5625 * @param icon The icon object for the button
5627 * Once the icon object is set, a previously set one will be deleted
5628 * If you want to keep that old content object, use the
5629 * elm_toggle_icon_unset() function.
5631 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5633 * @brief Get the icon used for the toggle
5635 * @param obj The toggle object
5636 * @return The icon object that is being used
5638 * Return the icon object which is set for this widget.
5640 * @see elm_toggle_icon_set()
5642 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5644 * @brief Unset the icon used for the toggle
5646 * @param obj The toggle object
5647 * @return The icon object that was being used
5649 * Unparent and return the icon object which was set for this widget.
5651 * @see elm_toggle_icon_set()
5653 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5655 * @brief Sets the labels to be associated with the on and off states of the toggle.
5657 * @param obj The toggle object
5658 * @param onlabel The label displayed when the toggle is in the "on" state
5659 * @param offlabel The label displayed when the toggle is in the "off" state
5661 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5663 * @brief Gets the labels associated with the on and off states of the toggle.
5665 * @param obj The toggle object
5666 * @param onlabel A char** to place the onlabel of @p obj into
5667 * @param offlabel A char** to place the offlabel of @p obj into
5669 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5671 * @brief Sets the state of the toggle to @p state.
5673 * @param obj The toggle object
5674 * @param state The state of @p obj
5676 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5678 * @brief Gets the state of the toggle to @p state.
5680 * @param obj The toggle object
5681 * @return The state of @p obj
5683 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5685 * @brief Sets the state pointer of the toggle to @p statep.
5687 * @param obj The toggle object
5688 * @param statep The state pointer of @p obj
5690 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5696 * @defgroup Frame Frame
5698 * @image html img/widget/frame/preview-00.png
5699 * @image latex img/widget/frame/preview-00.eps
5701 * @brief Frame is a widget that holds some content and has a title.
5703 * The default look is a frame with a title, but Frame supports multple
5711 * @li outdent_bottom
5713 * Of all this styles only default shows the title. Frame emits no signals.
5715 * For a detailed example see the @ref tutorial_frame.
5720 * @brief Add a new frame to the parent
5722 * @param parent The parent object
5723 * @return The new object or NULL if it cannot be created
5725 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5727 * @brief Set the frame label
5729 * @param obj The frame object
5730 * @param label The label of this frame object
5732 * @deprecated use elm_object_text_set() instead.
5734 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5736 * @brief Get the frame label
5738 * @param obj The frame object
5740 * @return The label of this frame objet or NULL if unable to get frame
5742 * @deprecated use elm_object_text_get() instead.
5744 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5746 * @brief Set the content of the frame widget
5748 * Once the content object is set, a previously set one will be deleted.
5749 * If you want to keep that old content object, use the
5750 * elm_frame_content_unset() function.
5752 * @param obj The frame object
5753 * @param content The content will be filled in this frame object
5755 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5757 * @brief Get the content of the frame widget
5759 * Return the content object which is set for this widget
5761 * @param obj The frame object
5762 * @return The content that is being used
5764 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5766 * @brief Unset the content of the frame widget
5768 * Unparent and return the content object which was set for this widget
5770 * @param obj The frame object
5771 * @return The content that was being used
5773 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5779 * @defgroup Table Table
5781 * A container widget to arrange other widgets in a table where items can
5782 * also span multiple columns or rows - even overlap (and then be raised or
5783 * lowered accordingly to adjust stacking if they do overlap).
5785 * The followin are examples of how to use a table:
5786 * @li @ref tutorial_table_01
5787 * @li @ref tutorial_table_02
5792 * @brief Add a new table to the parent
5794 * @param parent The parent object
5795 * @return The new object or NULL if it cannot be created
5797 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5799 * @brief Set the homogeneous layout in the table
5801 * @param obj The layout object
5802 * @param homogeneous A boolean to set if the layout is homogeneous in the
5803 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5805 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5807 * @brief Get the current table homogeneous mode.
5809 * @param obj The table object
5810 * @return A boolean to indicating if the layout is homogeneous in the table
5811 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5813 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5815 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5817 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5819 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5821 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5823 * @brief Set padding between cells.
5825 * @param obj The layout object.
5826 * @param horizontal set the horizontal padding.
5827 * @param vertical set the vertical padding.
5829 * Default value is 0.
5831 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5833 * @brief Get padding between cells.
5835 * @param obj The layout object.
5836 * @param horizontal set the horizontal padding.
5837 * @param vertical set the vertical padding.
5839 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5841 * @brief Add a subobject on the table with the coordinates passed
5843 * @param obj The table object
5844 * @param subobj The subobject to be added to the table
5845 * @param x Row number
5846 * @param y Column number
5850 * @note All positioning inside the table is relative to rows and columns, so
5851 * a value of 0 for x and y, means the top left cell of the table, and a
5852 * value of 1 for w and h means @p subobj only takes that 1 cell.
5854 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5856 * @brief Remove child from table.
5858 * @param obj The table object
5859 * @param subobj The subobject
5861 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5863 * @brief Faster way to remove all child objects from a table object.
5865 * @param obj The table object
5866 * @param clear If true, will delete children, else just remove from table.
5868 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5870 * @brief Set the packing location of an existing child of the table
5872 * @param subobj The subobject to be modified in the table
5873 * @param x Row number
5874 * @param y Column number
5878 * Modifies the position of an object already in the table.
5880 * @note All positioning inside the table is relative to rows and columns, so
5881 * a value of 0 for x and y, means the top left cell of the table, and a
5882 * value of 1 for w and h means @p subobj only takes that 1 cell.
5884 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5886 * @brief Get the packing location of an existing child of the table
5888 * @param subobj The subobject to be modified in the table
5889 * @param x Row number
5890 * @param y Column number
5894 * @see elm_table_pack_set()
5896 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5902 * @defgroup Gengrid Gengrid (Generic grid)
5904 * This widget aims to position objects in a grid layout while
5905 * actually creating and rendering only the visible ones, using the
5906 * same idea as the @ref Genlist "genlist": the user defines a @b
5907 * class for each item, specifying functions that will be called at
5908 * object creation, deletion, etc. When those items are selected by
5909 * the user, a callback function is issued. Users may interact with
5910 * a gengrid via the mouse (by clicking on items to select them and
5911 * clicking on the grid's viewport and swiping to pan the whole
5912 * view) or via the keyboard, navigating through item with the
5915 * @section Gengrid_Layouts Gengrid layouts
5917 * Gengrids may layout its items in one of two possible layouts:
5921 * When in "horizontal mode", items will be placed in @b columns,
5922 * from top to bottom and, when the space for a column is filled,
5923 * another one is started on the right, thus expanding the grid
5924 * horizontally, making for horizontal scrolling. When in "vertical
5925 * mode" , though, items will be placed in @b rows, from left to
5926 * right and, when the space for a row is filled, another one is
5927 * started below, thus expanding the grid vertically (and making
5928 * for vertical scrolling).
5930 * @section Gengrid_Items Gengrid items
5932 * An item in a gengrid can have 0 or more text labels (they can be
5933 * regular text or textblock Evas objects - that's up to the style
5934 * to determine), 0 or more icons (which are simply objects
5935 * swallowed into the gengrid item's theming Edje object) and 0 or
5936 * more <b>boolean states</b>, which have the behavior left to the
5937 * user to define. The Edje part names for each of these properties
5938 * will be looked up, in the theme file for the gengrid, under the
5939 * Edje (string) data items named @c "labels", @c "icons" and @c
5940 * "states", respectively. For each of those properties, if more
5941 * than one part is provided, they must have names listed separated
5942 * by spaces in the data fields. For the default gengrid item
5943 * theme, we have @b one label part (@c "elm.text"), @b two icon
5944 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5947 * A gengrid item may be at one of several styles. Elementary
5948 * provides one by default - "default", but this can be extended by
5949 * system or application custom themes/overlays/extensions (see
5950 * @ref Theme "themes" for more details).
5952 * @section Gengrid_Item_Class Gengrid item classes
5954 * In order to have the ability to add and delete items on the fly,
5955 * gengrid implements a class (callback) system where the
5956 * application provides a structure with information about that
5957 * type of item (gengrid may contain multiple different items with
5958 * different classes, states and styles). Gengrid will call the
5959 * functions in this struct (methods) when an item is "realized"
5960 * (i.e., created dynamically, while the user is scrolling the
5961 * grid). All objects will simply be deleted when no longer needed
5962 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5963 * contains the following members:
5964 * - @c item_style - This is a constant string and simply defines
5965 * the name of the item style. It @b must be specified and the
5966 * default should be @c "default".
5967 * - @c func.label_get - This function is called when an item
5968 * object is actually created. The @c data parameter will point to
5969 * the same data passed to elm_gengrid_item_append() and related
5970 * item creation functions. The @c obj parameter is the gengrid
5971 * object itself, while the @c part one is the name string of one
5972 * of the existing text parts in the Edje group implementing the
5973 * item's theme. This function @b must return a strdup'()ed string,
5974 * as the caller will free() it when done. See
5975 * #GridItemLabelGetFunc.
5976 * - @c func.icon_get - This function is called when an item object
5977 * is actually created. The @c data parameter will point to the
5978 * same data passed to elm_gengrid_item_append() and related item
5979 * creation functions. The @c obj parameter is the gengrid object
5980 * itself, while the @c part one is the name string of one of the
5981 * existing (icon) swallow parts in the Edje group implementing the
5982 * item's theme. It must return @c NULL, when no icon is desired,
5983 * or a valid object handle, otherwise. The object will be deleted
5984 * by the gengrid on its deletion or when the item is "unrealized".
5985 * See #GridItemIconGetFunc.
5986 * - @c func.state_get - This function is called when an item
5987 * object is actually created. The @c data parameter will point to
5988 * the same data passed to elm_gengrid_item_append() and related
5989 * item creation functions. The @c obj parameter is the gengrid
5990 * object itself, while the @c part one is the name string of one
5991 * of the state parts in the Edje group implementing the item's
5992 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5993 * true/on. Gengrids will emit a signal to its theming Edje object
5994 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5995 * "source" arguments, respectively, when the state is true (the
5996 * default is false), where @c XXX is the name of the (state) part.
5997 * See #GridItemStateGetFunc.
5998 * - @c func.del - This is called when elm_gengrid_item_del() is
5999 * called on an item or elm_gengrid_clear() is called on the
6000 * gengrid. This is intended for use when gengrid items are
6001 * deleted, so any data attached to the item (e.g. its data
6002 * parameter on creation) can be deleted. See #GridItemDelFunc.
6004 * @section Gengrid_Usage_Hints Usage hints
6006 * If the user wants to have multiple items selected at the same
6007 * time, elm_gengrid_multi_select_set() will permit it. If the
6008 * gengrid is single-selection only (the default), then
6009 * elm_gengrid_select_item_get() will return the selected item or
6010 * @c NULL, if none is selected. If the gengrid is under
6011 * multi-selection, then elm_gengrid_selected_items_get() will
6012 * return a list (that is only valid as long as no items are
6013 * modified (added, deleted, selected or unselected) of child items
6016 * If an item changes (internal (boolean) state, label or icon
6017 * changes), then use elm_gengrid_item_update() to have gengrid
6018 * update the item with the new state. A gengrid will re-"realize"
6019 * the item, thus calling the functions in the
6020 * #Elm_Gengrid_Item_Class set for that item.
6022 * To programmatically (un)select an item, use
6023 * elm_gengrid_item_selected_set(). To get its selected state use
6024 * elm_gengrid_item_selected_get(). To make an item disabled
6025 * (unable to be selected and appear differently) use
6026 * elm_gengrid_item_disabled_set() to set this and
6027 * elm_gengrid_item_disabled_get() to get the disabled state.
6029 * Grid cells will only have their selection smart callbacks called
6030 * when firstly getting selected. Any further clicks will do
6031 * nothing, unless you enable the "always select mode", with
6032 * elm_gengrid_always_select_mode_set(), thus making every click to
6033 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
6034 * turn off the ability to select items entirely in the widget and
6035 * they will neither appear selected nor call the selection smart
6038 * Remember that you can create new styles and add your own theme
6039 * augmentation per application with elm_theme_extension_add(). If
6040 * you absolutely must have a specific style that overrides any
6041 * theme the user or system sets up you can use
6042 * elm_theme_overlay_add() to add such a file.
6044 * @section Gengrid_Smart_Events Gengrid smart events
6046 * Smart events that you can add callbacks for are:
6047 * - @c "activated" - The user has double-clicked or pressed
6048 * (enter|return|spacebar) on an item. The @c event_info parameter
6049 * is the gengrid item that was activated.
6050 * - @c "clicked,double" - The user has double-clicked an item.
6051 * The @c event_info parameter is the gengrid item that was double-clicked.
6052 * - @c "selected" - The user has made an item selected. The
6053 * @c event_info parameter is the gengrid item that was selected.
6054 * - @c "unselected" - The user has made an item unselected. The
6055 * @c event_info parameter is the gengrid item that was unselected.
6056 * - @c "realized" - This is called when the item in the gengrid
6057 * has its implementing Evas object instantiated, de facto. @c
6058 * event_info is the gengrid item that was created. The object
6059 * may be deleted at any time, so it is highly advised to the
6060 * caller @b not to use the object pointer returned from
6061 * elm_gengrid_item_object_get(), because it may point to freed
6063 * - @c "unrealized" - This is called when the implementing Evas
6064 * object for this item is deleted. @c event_info is the gengrid
6065 * item that was deleted.
6066 * - @c "changed" - Called when an item is added, removed, resized
6067 * or moved and when the gengrid is resized or gets "horizontal"
6069 * - @c "drag,start,up" - Called when the item in the gengrid has
6070 * been dragged (not scrolled) up.
6071 * - @c "drag,start,down" - Called when the item in the gengrid has
6072 * been dragged (not scrolled) down.
6073 * - @c "drag,start,left" - Called when the item in the gengrid has
6074 * been dragged (not scrolled) left.
6075 * - @c "drag,start,right" - Called when the item in the gengrid has
6076 * been dragged (not scrolled) right.
6077 * - @c "drag,stop" - Called when the item in the gengrid has
6078 * stopped being dragged.
6079 * - @c "drag" - Called when the item in the gengrid is being
6081 * - @c "scroll" - called when the content has been scrolled
6083 * - @c "scroll,drag,start" - called when dragging the content has
6085 * - @c "scroll,drag,stop" - called when dragging the content has
6088 * List of gendrid examples:
6089 * @li @ref gengrid_example
6093 * @addtogroup Gengrid
6097 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
6098 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
6099 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
6100 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
6101 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
6102 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
6103 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
6106 * @struct _Elm_Gengrid_Item_Class
6108 * Gengrid item class definition. See @ref Gengrid_Item_Class for
6111 struct _Elm_Gengrid_Item_Class
6113 const char *item_style;
6114 struct _Elm_Gengrid_Item_Class_Func
6116 GridItemLabelGetFunc label_get;
6117 GridItemIconGetFunc icon_get;
6118 GridItemStateGetFunc state_get;
6119 GridItemDelFunc del;
6121 }; /**< #Elm_Gengrid_Item_Class member definitions */
6124 * Add a new gengrid widget to the given parent Elementary
6125 * (container) object
6127 * @param parent The parent object
6128 * @return a new gengrid widget handle or @c NULL, on errors
6130 * This function inserts a new gengrid widget on the canvas.
6132 * @see elm_gengrid_item_size_set()
6133 * @see elm_gengrid_horizontal_set()
6134 * @see elm_gengrid_item_append()
6135 * @see elm_gengrid_item_del()
6136 * @see elm_gengrid_clear()
6140 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6143 * Set the size for the items of a given gengrid widget
6145 * @param obj The gengrid object.
6146 * @param w The items' width.
6147 * @param h The items' height;
6149 * A gengrid, after creation, has still no information on the size
6150 * to give to each of its cells. So, you most probably will end up
6151 * with squares one @ref Fingers "finger" wide, the default
6152 * size. Use this function to force a custom size for you items,
6153 * making them as big as you wish.
6155 * @see elm_gengrid_item_size_get()
6159 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
6162 * Get the size set for the items of a given gengrid widget
6164 * @param obj The gengrid object.
6165 * @param w Pointer to a variable where to store the items' width.
6166 * @param h Pointer to a variable where to store the items' height.
6168 * @note Use @c NULL pointers on the size values you're not
6169 * interested in: they'll be ignored by the function.
6171 * @see elm_gengrid_item_size_get() for more details
6175 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6178 * Set the items grid's alignment within a given gengrid widget
6180 * @param obj The gengrid object.
6181 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
6182 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
6184 * This sets the alignment of the whole grid of items of a gengrid
6185 * within its given viewport. By default, those values are both
6186 * 0.5, meaning that the gengrid will have its items grid placed
6187 * exactly in the middle of its viewport.
6189 * @note If given alignment values are out of the cited ranges,
6190 * they'll be changed to the nearest boundary values on the valid
6193 * @see elm_gengrid_align_get()
6197 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
6200 * Get the items grid's alignment values within a given gengrid
6203 * @param obj The gengrid object.
6204 * @param align_x Pointer to a variable where to store the
6205 * horizontal alignment.
6206 * @param align_y Pointer to a variable where to store the vertical
6209 * @note Use @c NULL pointers on the alignment values you're not
6210 * interested in: they'll be ignored by the function.
6212 * @see elm_gengrid_align_set() for more details
6216 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
6219 * Set whether a given gengrid widget is or not able have items
6222 * @param obj The gengrid object
6223 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
6224 * @c EINA_FALSE to turn it off
6226 * If a gengrid is set to allow reordering, a click held for more
6227 * than 0.5 over a given item will highlight it specially,
6228 * signalling the gengrid has entered the reordering state. From
6229 * that time on, the user will be able to, while still holding the
6230 * mouse button down, move the item freely in the gengrid's
6231 * viewport, replacing to said item to the locations it goes to.
6232 * The replacements will be animated and, whenever the user
6233 * releases the mouse button, the item being replaced gets a new
6234 * definitive place in the grid.
6236 * @see elm_gengrid_reorder_mode_get()
6240 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6243 * Get whether a given gengrid widget is or not able have items
6246 * @param obj The gengrid object
6247 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6250 * @see elm_gengrid_reorder_mode_set() for more details
6254 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6257 * Append a new item in a given gengrid widget.
6259 * @param obj The gengrid object.
6260 * @param gic The item class for the item.
6261 * @param data The item data.
6262 * @param func Convenience function called when the item is
6264 * @param func_data Data to be passed to @p func.
6265 * @return A handle to the item added or @c NULL, on errors.
6267 * This adds an item to the beginning of the gengrid.
6269 * @see elm_gengrid_item_prepend()
6270 * @see elm_gengrid_item_insert_before()
6271 * @see elm_gengrid_item_insert_after()
6272 * @see elm_gengrid_item_del()
6276 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);
6279 * Prepend a new item in a given gengrid widget.
6281 * @param obj The gengrid object.
6282 * @param gic The item class for the item.
6283 * @param data The item data.
6284 * @param func Convenience function called when the item is
6286 * @param func_data Data to be passed to @p func.
6287 * @return A handle to the item added or @c NULL, on errors.
6289 * This adds an item to the end of the gengrid.
6291 * @see elm_gengrid_item_append()
6292 * @see elm_gengrid_item_insert_before()
6293 * @see elm_gengrid_item_insert_after()
6294 * @see elm_gengrid_item_del()
6298 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);
6301 * Insert an item before another in a gengrid widget
6303 * @param obj The gengrid object.
6304 * @param gic The item class for the item.
6305 * @param data The item data.
6306 * @param relative The item to place this new one before.
6307 * @param func Convenience function called when the item is
6309 * @param func_data Data to be passed to @p func.
6310 * @return A handle to the item added or @c NULL, on errors.
6312 * This inserts an item before another in the gengrid.
6314 * @see elm_gengrid_item_append()
6315 * @see elm_gengrid_item_prepend()
6316 * @see elm_gengrid_item_insert_after()
6317 * @see elm_gengrid_item_del()
6321 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);
6324 * Insert an item after another in a gengrid widget
6326 * @param obj The gengrid object.
6327 * @param gic The item class for the item.
6328 * @param data The item data.
6329 * @param relative The item to place this new one after.
6330 * @param func Convenience function called when the item is
6332 * @param func_data Data to be passed to @p func.
6333 * @return A handle to the item added or @c NULL, on errors.
6335 * This inserts an item after another in the gengrid.
6337 * @see elm_gengrid_item_append()
6338 * @see elm_gengrid_item_prepend()
6339 * @see elm_gengrid_item_insert_after()
6340 * @see elm_gengrid_item_del()
6344 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);
6346 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);
6348 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);
6351 * Set whether items on a given gengrid widget are to get their
6352 * selection callbacks issued for @b every subsequent selection
6353 * click on them or just for the first click.
6355 * @param obj The gengrid object
6356 * @param always_select @c EINA_TRUE to make items "always
6357 * selected", @c EINA_FALSE, otherwise
6359 * By default, grid items will only call their selection callback
6360 * function when firstly getting selected, any subsequent further
6361 * clicks will do nothing. With this call, you make those
6362 * subsequent clicks also to issue the selection callbacks.
6364 * @note <b>Double clicks</b> will @b always be reported on items.
6366 * @see elm_gengrid_always_select_mode_get()
6370 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6373 * Get whether items on a given gengrid widget have their selection
6374 * callbacks issued for @b every subsequent selection click on them
6375 * or just for the first click.
6377 * @param obj The gengrid object.
6378 * @return @c EINA_TRUE if the gengrid items are "always selected",
6379 * @c EINA_FALSE, otherwise
6381 * @see elm_gengrid_always_select_mode_set() for more details
6385 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6388 * Set whether items on a given gengrid widget can be selected or not.
6390 * @param obj The gengrid object
6391 * @param no_select @c EINA_TRUE to make items selectable,
6392 * @c EINA_FALSE otherwise
6394 * This will make items in @p obj selectable or not. In the latter
6395 * case, any user interacion on the gendrid items will neither make
6396 * them appear selected nor them call their selection callback
6399 * @see elm_gengrid_no_select_mode_get()
6403 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6406 * Get whether items on a given gengrid widget can be selected or
6409 * @param obj The gengrid object
6410 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6413 * @see elm_gengrid_no_select_mode_set() for more details
6417 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6420 * Enable or disable multi-selection in a given gengrid widget
6422 * @param obj The gengrid object.
6423 * @param multi @c EINA_TRUE, to enable multi-selection,
6424 * @c EINA_FALSE to disable it.
6426 * Multi-selection is the ability for one to have @b more than one
6427 * item selected, on a given gengrid, simultaneously. When it is
6428 * enabled, a sequence of clicks on different items will make them
6429 * all selected, progressively. A click on an already selected item
6430 * will unselect it. If interecting via the keyboard,
6431 * multi-selection is enabled while holding the "Shift" key.
6433 * @note By default, multi-selection is @b disabled on gengrids
6435 * @see elm_gengrid_multi_select_get()
6439 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6442 * Get whether multi-selection is enabled or disabled for a given
6445 * @param obj The gengrid object.
6446 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6447 * EINA_FALSE otherwise
6449 * @see elm_gengrid_multi_select_set() for more details
6453 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6456 * Enable or disable bouncing effect for a given gengrid widget
6458 * @param obj The gengrid object
6459 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6460 * @c EINA_FALSE to disable it
6461 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6462 * @c EINA_FALSE to disable it
6464 * The bouncing effect occurs whenever one reaches the gengrid's
6465 * edge's while panning it -- it will scroll past its limits a
6466 * little bit and return to the edge again, in a animated for,
6469 * @note By default, gengrids have bouncing enabled on both axis
6471 * @see elm_gengrid_bounce_get()
6475 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6478 * Get whether bouncing effects are enabled or disabled, for a
6479 * given gengrid widget, on each axis
6481 * @param obj The gengrid object
6482 * @param h_bounce Pointer to a variable where to store the
6483 * horizontal bouncing flag.
6484 * @param v_bounce Pointer to a variable where to store the
6485 * vertical bouncing flag.
6487 * @see elm_gengrid_bounce_set() for more details
6491 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6494 * Set a given gengrid widget's scrolling page size, relative to
6495 * its viewport size.
6497 * @param obj The gengrid object
6498 * @param h_pagerel The horizontal page (relative) size
6499 * @param v_pagerel The vertical page (relative) size
6501 * The gengrid's scroller is capable of binding scrolling by the
6502 * user to "pages". It means that, while scrolling and, specially
6503 * after releasing the mouse button, the grid will @b snap to the
6504 * nearest displaying page's area. When page sizes are set, the
6505 * grid's continuous content area is split into (equal) page sized
6508 * This function sets the size of a page <b>relatively to the
6509 * viewport dimensions</b> of the gengrid, for each axis. A value
6510 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6511 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6512 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6513 * 1.0. Values beyond those will make it behave behave
6514 * inconsistently. If you only want one axis to snap to pages, use
6515 * the value @c 0.0 for the other one.
6517 * There is a function setting page size values in @b absolute
6518 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6519 * is mutually exclusive to this one.
6521 * @see elm_gengrid_page_relative_get()
6525 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6528 * Get a given gengrid widget's scrolling page size, relative to
6529 * its viewport size.
6531 * @param obj The gengrid object
6532 * @param h_pagerel Pointer to a variable where to store the
6533 * horizontal page (relative) size
6534 * @param v_pagerel Pointer to a variable where to store the
6535 * vertical page (relative) size
6537 * @see elm_gengrid_page_relative_set() for more details
6541 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6544 * Set a given gengrid widget's scrolling page size
6546 * @param obj The gengrid object
6547 * @param h_pagerel The horizontal page size, in pixels
6548 * @param v_pagerel The vertical page size, in pixels
6550 * The gengrid's scroller is capable of binding scrolling by the
6551 * user to "pages". It means that, while scrolling and, specially
6552 * after releasing the mouse button, the grid will @b snap to the
6553 * nearest displaying page's area. When page sizes are set, the
6554 * grid's continuous content area is split into (equal) page sized
6557 * This function sets the size of a page of the gengrid, in pixels,
6558 * for each axis. Sane usable values are, between @c 0 and the
6559 * dimensions of @p obj, for each axis. Values beyond those will
6560 * make it behave behave inconsistently. If you only want one axis
6561 * to snap to pages, use the value @c 0 for the other one.
6563 * There is a function setting page size values in @b relative
6564 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6565 * use is mutually exclusive to this one.
6569 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6572 * Set for what direction a given gengrid widget will expand while
6573 * placing its items.
6575 * @param obj The gengrid object.
6576 * @param setting @c EINA_TRUE to make the gengrid expand
6577 * horizontally, @c EINA_FALSE to expand vertically.
6579 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6580 * in @b columns, from top to bottom and, when the space for a
6581 * column is filled, another one is started on the right, thus
6582 * expanding the grid horizontally. When in "vertical mode"
6583 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6584 * to right and, when the space for a row is filled, another one is
6585 * started below, thus expanding the grid vertically.
6587 * @see elm_gengrid_horizontal_get()
6591 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6594 * Get for what direction a given gengrid widget will expand while
6595 * placing its items.
6597 * @param obj The gengrid object.
6598 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6599 * @c EINA_FALSE if it's set to expand vertically.
6601 * @see elm_gengrid_horizontal_set() for more detais
6605 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6608 * Get the first item in a given gengrid widget
6610 * @param obj The gengrid object
6611 * @return The first item's handle or @c NULL, if there are no
6612 * items in @p obj (and on errors)
6614 * This returns the first item in the @p obj's internal list of
6617 * @see elm_gengrid_last_item_get()
6621 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6624 * Get the last item in a given gengrid widget
6626 * @param obj The gengrid object
6627 * @return The last item's handle or @c NULL, if there are no
6628 * items in @p obj (and on errors)
6630 * This returns the last item in the @p obj's internal list of
6633 * @see elm_gengrid_first_item_get()
6637 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6640 * Get the @b next item in a gengrid widget's internal list of items,
6641 * given a handle to one of those items.
6643 * @param item The gengrid item to fetch next from
6644 * @return The item after @p item, or @c NULL if there's none (and
6647 * This returns the item placed after the @p item, on the container
6650 * @see elm_gengrid_item_prev_get()
6654 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6657 * Get the @b previous item in a gengrid widget's internal list of items,
6658 * given a handle to one of those items.
6660 * @param item The gengrid item to fetch previous from
6661 * @return The item before @p item, or @c NULL if there's none (and
6664 * This returns the item placed before the @p item, on the container
6667 * @see elm_gengrid_item_next_get()
6671 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6674 * Get the gengrid object's handle which contains a given gengrid
6677 * @param item The item to fetch the container from
6678 * @return The gengrid (parent) object
6680 * This returns the gengrid object itself that an item belongs to.
6684 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6687 * Remove a gengrid item from the its parent, deleting it.
6689 * @param item The item to be removed.
6690 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6692 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6697 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6700 * Update the contents of a given gengrid item
6702 * @param item The gengrid item
6704 * This updates an item by calling all the item class functions
6705 * again to get the icons, labels and states. Use this when the
6706 * original item data has changed and you want thta changes to be
6711 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6712 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6713 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6716 * Return the data associated to a given gengrid item
6718 * @param item The gengrid item.
6719 * @return the data associated to this item.
6721 * This returns the @c data value passed on the
6722 * elm_gengrid_item_append() and related item addition calls.
6724 * @see elm_gengrid_item_append()
6725 * @see elm_gengrid_item_data_set()
6729 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6732 * Set the data associated to a given gengrid item
6734 * @param item The gengrid item
6735 * @param data The new data pointer to set on it
6737 * This @b overrides the @c data value passed on the
6738 * elm_gengrid_item_append() and related item addition calls. This
6739 * function @b won't call elm_gengrid_item_update() automatically,
6740 * so you'd issue it afterwards if you want to hove the item
6741 * updated to reflect the that new data.
6743 * @see elm_gengrid_item_data_get()
6747 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6750 * Get a given gengrid item's position, relative to the whole
6751 * gengrid's grid area.
6753 * @param item The Gengrid item.
6754 * @param x Pointer to variable where to store the item's <b>row
6756 * @param y Pointer to variable where to store the item's <b>column
6759 * This returns the "logical" position of the item whithin the
6760 * gengrid. For example, @c (0, 1) would stand for first row,
6765 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6768 * Set whether a given gengrid item is selected or not
6770 * @param item The gengrid item
6771 * @param selected Use @c EINA_TRUE, to make it selected, @c
6772 * EINA_FALSE to make it unselected
6774 * This sets the selected state of an item. If multi selection is
6775 * not enabled on the containing gengrid and @p selected is @c
6776 * EINA_TRUE, any other previously selected items will get
6777 * unselected in favor of this new one.
6779 * @see elm_gengrid_item_selected_get()
6783 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6786 * Get whether a given gengrid item is selected or not
6788 * @param item The gengrid item
6789 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6791 * @see elm_gengrid_item_selected_set() for more details
6795 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6798 * Get the real Evas object created to implement the view of a
6799 * given gengrid item
6801 * @param item The gengrid item.
6802 * @return the Evas object implementing this item's view.
6804 * This returns the actual Evas object used to implement the
6805 * specified gengrid item's view. This may be @c NULL, as it may
6806 * not have been created or may have been deleted, at any time, by
6807 * the gengrid. <b>Do not modify this object</b> (move, resize,
6808 * show, hide, etc.), as the gengrid is controlling it. This
6809 * function is for querying, emitting custom signals or hooking
6810 * lower level callbacks for events on that object. Do not delete
6811 * this object under any circumstances.
6813 * @see elm_gengrid_item_data_get()
6817 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6820 * Show the portion of a gengrid's internal grid containing a given
6821 * item, @b immediately.
6823 * @param item The item to display
6825 * This causes gengrid to @b redraw its viewport's contents to the
6826 * region contining the given @p item item, if it is not fully
6829 * @see elm_gengrid_item_bring_in()
6833 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6836 * Animatedly bring in, to the visible are of a gengrid, a given
6839 * @param item The gengrid item to display
6841 * This causes gengrig to jump to the given @p item item and show
6842 * it (by scrolling), if it is not fully visible. This will use
6843 * animation to do so and take a period of time to complete.
6845 * @see elm_gengrid_item_show()
6849 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6852 * Set whether a given gengrid item is disabled or not.
6854 * @param item The gengrid item
6855 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6856 * to enable it back.
6858 * A disabled item cannot be selected or unselected. It will also
6859 * change its appearance, to signal the user it's disabled.
6861 * @see elm_gengrid_item_disabled_get()
6865 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6868 * Get whether a given gengrid item is disabled or not.
6870 * @param item The gengrid item
6871 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6874 * @see elm_gengrid_item_disabled_set() for more details
6878 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6881 * Set the text to be shown in a given gengrid item's tooltips.
6883 * @param item The gengrid item
6884 * @param text The text to set in the content
6886 * This call will setup the text to be used as tooltip to that item
6887 * (analogous to elm_object_tooltip_text_set(), but being item
6888 * tooltips with higher precedence than object tooltips). It can
6889 * have only one tooltip at a time, so any previous tooltip data
6894 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6897 * Set the content to be shown in a given gengrid item's tooltips
6899 * @param item The gengrid item.
6900 * @param func The function returning the tooltip contents.
6901 * @param data What to provide to @a func as callback data/context.
6902 * @param del_cb Called when data is not needed anymore, either when
6903 * another callback replaces @p func, the tooltip is unset with
6904 * elm_gengrid_item_tooltip_unset() or the owner @p item
6905 * dies. This callback receives as its first parameter the
6906 * given @p data, being @c event_info the item handle.
6908 * This call will setup the tooltip's contents to @p item
6909 * (analogous to elm_object_tooltip_content_cb_set(), but being
6910 * item tooltips with higher precedence than object tooltips). It
6911 * can have only one tooltip at a time, so any previous tooltip
6912 * content will get removed. @p func (with @p data) will be called
6913 * every time Elementary needs to show the tooltip and it should
6914 * return a valid Evas object, which will be fully managed by the
6915 * tooltip system, getting deleted when the tooltip is gone.
6919 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);
6922 * Unset a tooltip from a given gengrid item
6924 * @param item gengrid item to remove a previously set tooltip from.
6926 * This call removes any tooltip set on @p item. The callback
6927 * provided as @c del_cb to
6928 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6929 * notify it is not used anymore (and have resources cleaned, if
6932 * @see elm_gengrid_item_tooltip_content_cb_set()
6936 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6939 * Set a different @b style for a given gengrid item's tooltip.
6941 * @param item gengrid item with tooltip set
6942 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6943 * "default", @c "transparent", etc)
6945 * Tooltips can have <b>alternate styles</b> to be displayed on,
6946 * which are defined by the theme set on Elementary. This function
6947 * works analogously as elm_object_tooltip_style_set(), but here
6948 * applied only to gengrid item objects. The default style for
6949 * tooltips is @c "default".
6951 * @note before you set a style you should define a tooltip with
6952 * elm_gengrid_item_tooltip_content_cb_set() or
6953 * elm_gengrid_item_tooltip_text_set()
6955 * @see elm_gengrid_item_tooltip_style_get()
6959 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6962 * Get the style set a given gengrid item's tooltip.
6964 * @param item gengrid item with tooltip already set on.
6965 * @return style the theme style in use, which defaults to
6966 * "default". If the object does not have a tooltip set,
6967 * then @c NULL is returned.
6969 * @see elm_gengrid_item_tooltip_style_set() for more details
6973 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6975 * @brief Disable size restrictions on an object's tooltip
6976 * @param item The tooltip's anchor object
6977 * @param disable If EINA_TRUE, size restrictions are disabled
6978 * @return EINA_FALSE on failure, EINA_TRUE on success
6980 * This function allows a tooltip to expand beyond its parant window's canvas.
6981 * It will instead be limited only by the size of the display.
6983 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6985 * @brief Retrieve size restriction state of an object's tooltip
6986 * @param item The tooltip's anchor object
6987 * @return If EINA_TRUE, size restrictions are disabled
6989 * This function returns whether a tooltip is allowed to expand beyond
6990 * its parant window's canvas.
6991 * It will instead be limited only by the size of the display.
6993 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6995 * Set the type of mouse pointer/cursor decoration to be shown,
6996 * when the mouse pointer is over the given gengrid widget item
6998 * @param item gengrid item to customize cursor on
6999 * @param cursor the cursor type's name
7001 * This function works analogously as elm_object_cursor_set(), but
7002 * here the cursor's changing area is restricted to the item's
7003 * area, and not the whole widget's. Note that that item cursors
7004 * have precedence over widget cursors, so that a mouse over @p
7005 * item will always show cursor @p type.
7007 * If this function is called twice for an object, a previously set
7008 * cursor will be unset on the second call.
7010 * @see elm_object_cursor_set()
7011 * @see elm_gengrid_item_cursor_get()
7012 * @see elm_gengrid_item_cursor_unset()
7016 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7019 * Get the type of mouse pointer/cursor decoration set to be shown,
7020 * when the mouse pointer is over the given gengrid widget item
7022 * @param item gengrid item with custom cursor set
7023 * @return the cursor type's name or @c NULL, if no custom cursors
7024 * were set to @p item (and on errors)
7026 * @see elm_object_cursor_get()
7027 * @see elm_gengrid_item_cursor_set() for more details
7028 * @see elm_gengrid_item_cursor_unset()
7032 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7035 * Unset any custom mouse pointer/cursor decoration set to be
7036 * shown, when the mouse pointer is over the given gengrid widget
7037 * item, thus making it show the @b default cursor again.
7039 * @param item a gengrid item
7041 * Use this call to undo any custom settings on this item's cursor
7042 * decoration, bringing it back to defaults (no custom style set).
7044 * @see elm_object_cursor_unset()
7045 * @see elm_gengrid_item_cursor_set() for more details
7049 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7052 * Set a different @b style for a given custom cursor set for a
7055 * @param item gengrid item with custom cursor set
7056 * @param style the <b>theme style</b> to use (e.g. @c "default",
7057 * @c "transparent", etc)
7059 * This function only makes sense when one is using custom mouse
7060 * cursor decorations <b>defined in a theme file</b> , which can
7061 * have, given a cursor name/type, <b>alternate styles</b> on
7062 * it. It works analogously as elm_object_cursor_style_set(), but
7063 * here applied only to gengrid item objects.
7065 * @warning Before you set a cursor style you should have defined a
7066 * custom cursor previously on the item, with
7067 * elm_gengrid_item_cursor_set()
7069 * @see elm_gengrid_item_cursor_engine_only_set()
7070 * @see elm_gengrid_item_cursor_style_get()
7074 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
7077 * Get the current @b style set for a given gengrid item's custom
7080 * @param item gengrid item with custom cursor set.
7081 * @return style the cursor style in use. If the object does not
7082 * have a cursor set, then @c NULL is returned.
7084 * @see elm_gengrid_item_cursor_style_set() for more details
7088 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7091 * Set if the (custom) cursor for a given gengrid item should be
7092 * searched in its theme, also, or should only rely on the
7095 * @param item item with custom (custom) cursor already set on
7096 * @param engine_only Use @c EINA_TRUE to have cursors looked for
7097 * only on those provided by the rendering engine, @c EINA_FALSE to
7098 * have them searched on the widget's theme, as well.
7100 * @note This call is of use only if you've set a custom cursor
7101 * for gengrid items, with elm_gengrid_item_cursor_set().
7103 * @note By default, cursors will only be looked for between those
7104 * provided by the rendering engine.
7108 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7111 * Get if the (custom) cursor for a given gengrid item is being
7112 * searched in its theme, also, or is only relying on the rendering
7115 * @param item a gengrid item
7116 * @return @c EINA_TRUE, if cursors are being looked for only on
7117 * those provided by the rendering engine, @c EINA_FALSE if they
7118 * are being searched on the widget's theme, as well.
7120 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
7124 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7127 * Remove all items from a given gengrid widget
7129 * @param obj The gengrid object.
7131 * This removes (and deletes) all items in @p obj, leaving it
7134 * @see elm_gengrid_item_del(), to remove just one item.
7138 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7141 * Get the selected item in a given gengrid widget
7143 * @param obj The gengrid object.
7144 * @return The selected item's handleor @c NULL, if none is
7145 * selected at the moment (and on errors)
7147 * This returns the selected item in @p obj. If multi selection is
7148 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
7149 * the first item in the list is selected, which might not be very
7150 * useful. For that case, see elm_gengrid_selected_items_get().
7154 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7157 * Get <b>a list</b> of selected items in a given gengrid
7159 * @param obj The gengrid object.
7160 * @return The list of selected items or @c NULL, if none is
7161 * selected at the moment (and on errors)
7163 * This returns a list of the selected items, in the order that
7164 * they appear in the grid. This list is only valid as long as no
7165 * more items are selected or unselected (or unselected implictly
7166 * by deletion). The list contains #Elm_Gengrid_Item pointers as
7169 * @see elm_gengrid_selected_item_get()
7173 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7180 * @defgroup Clock Clock
7182 * @image html img/widget/clock/preview-00.png
7183 * @image latex img/widget/clock/preview-00.eps
7185 * This is a @b digital clock widget. In its default theme, it has a
7186 * vintage "flipping numbers clock" appearance, which will animate
7187 * sheets of individual algarisms individually as time goes by.
7189 * A newly created clock will fetch system's time (already
7190 * considering local time adjustments) to start with, and will tick
7191 * accondingly. It may or may not show seconds.
7193 * Clocks have an @b edition mode. When in it, the sheets will
7194 * display extra arrow indications on the top and bottom and the
7195 * user may click on them to raise or lower the time values. After
7196 * it's told to exit edition mode, it will keep ticking with that
7197 * new time set (it keeps the difference from local time).
7199 * Also, when under edition mode, user clicks on the cited arrows
7200 * which are @b held for some time will make the clock to flip the
7201 * sheet, thus editing the time, continuosly and automatically for
7202 * the user. The interval between sheet flips will keep growing in
7203 * time, so that it helps the user to reach a time which is distant
7206 * The time display is, by default, in military mode (24h), but an
7207 * am/pm indicator may be optionally shown, too, when it will
7210 * Smart callbacks one can register to:
7211 * - "changed" - the clock's user changed the time
7213 * Here is an example on its usage:
7214 * @li @ref clock_example
7223 * Identifiers for which clock digits should be editable, when a
7224 * clock widget is in edition mode. Values may be ORed together to
7225 * make a mask, naturally.
7227 * @see elm_clock_edit_set()
7228 * @see elm_clock_digit_edit_set()
7230 typedef enum _Elm_Clock_Digedit
7232 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
7233 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
7234 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
7235 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
7236 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
7237 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
7238 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
7239 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
7240 } Elm_Clock_Digedit;
7243 * Add a new clock widget to the given parent Elementary
7244 * (container) object
7246 * @param parent The parent object
7247 * @return a new clock widget handle or @c NULL, on errors
7249 * This function inserts a new clock widget on the canvas.
7253 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7256 * Set a clock widget's time, programmatically
7258 * @param obj The clock widget object
7259 * @param hrs The hours to set
7260 * @param min The minutes to set
7261 * @param sec The secondes to set
7263 * This function updates the time that is showed by the clock
7266 * Values @b must be set within the following ranges:
7267 * - 0 - 23, for hours
7268 * - 0 - 59, for minutes
7269 * - 0 - 59, for seconds,
7271 * even if the clock is not in "military" mode.
7273 * @warning The behavior for values set out of those ranges is @b
7278 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7281 * Get a clock widget's time values
7283 * @param obj The clock object
7284 * @param[out] hrs Pointer to the variable to get the hours value
7285 * @param[out] min Pointer to the variable to get the minutes value
7286 * @param[out] sec Pointer to the variable to get the seconds value
7288 * This function gets the time set for @p obj, returning
7289 * it on the variables passed as the arguments to function
7291 * @note Use @c NULL pointers on the time values you're not
7292 * interested in: they'll be ignored by the function.
7296 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7299 * Set whether a given clock widget is under <b>edition mode</b> or
7300 * under (default) displaying-only mode.
7302 * @param obj The clock object
7303 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7304 * put it back to "displaying only" mode
7306 * This function makes a clock's time to be editable or not <b>by
7307 * user interaction</b>. When in edition mode, clocks @b stop
7308 * ticking, until one brings them back to canonical mode. The
7309 * elm_clock_digit_edit_set() function will influence which digits
7310 * of the clock will be editable. By default, all of them will be
7311 * (#ELM_CLOCK_NONE).
7313 * @note am/pm sheets, if being shown, will @b always be editable
7314 * under edition mode.
7316 * @see elm_clock_edit_get()
7320 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7323 * Retrieve whether a given clock widget is under <b>edition
7324 * mode</b> or under (default) displaying-only mode.
7326 * @param obj The clock object
7327 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7330 * This function retrieves whether the clock's time can be edited
7331 * or not by user interaction.
7333 * @see elm_clock_edit_set() for more details
7337 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7340 * Set what digits of the given clock widget should be editable
7341 * when in edition mode.
7343 * @param obj The clock object
7344 * @param digedit Bit mask indicating the digits to be editable
7345 * (values in #Elm_Clock_Digedit).
7347 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7348 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7351 * @see elm_clock_digit_edit_get()
7355 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7358 * Retrieve what digits of the given clock widget should be
7359 * editable when in edition mode.
7361 * @param obj The clock object
7362 * @return Bit mask indicating the digits to be editable
7363 * (values in #Elm_Clock_Digedit).
7365 * @see elm_clock_digit_edit_set() for more details
7369 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7372 * Set if the given clock widget must show hours in military or
7375 * @param obj The clock object
7376 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7379 * This function sets if the clock must show hours in military or
7380 * am/pm mode. In some countries like Brazil the military mode
7381 * (00-24h-format) is used, in opposition to the USA, where the
7382 * am/pm mode is more commonly used.
7384 * @see elm_clock_show_am_pm_get()
7388 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7391 * Get if the given clock widget shows hours in military or am/pm
7394 * @param obj The clock object
7395 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7398 * This function gets if the clock shows hours in military or am/pm
7401 * @see elm_clock_show_am_pm_set() for more details
7405 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7408 * Set if the given clock widget must show time with seconds or not
7410 * @param obj The clock object
7411 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7413 * This function sets if the given clock must show or not elapsed
7414 * seconds. By default, they are @b not shown.
7416 * @see elm_clock_show_seconds_get()
7420 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7423 * Get whether the given clock widget is showing time with seconds
7426 * @param obj The clock object
7427 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7429 * This function gets whether @p obj is showing or not the elapsed
7432 * @see elm_clock_show_seconds_set()
7436 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7439 * Set the interval on time updates for an user mouse button hold
7440 * on clock widgets' time edition.
7442 * @param obj The clock object
7443 * @param interval The (first) interval value in seconds
7445 * This interval value is @b decreased while the user holds the
7446 * mouse pointer either incrementing or decrementing a given the
7447 * clock digit's value.
7449 * This helps the user to get to a given time distant from the
7450 * current one easier/faster, as it will start to flip quicker and
7451 * quicker on mouse button holds.
7453 * The calculation for the next flip interval value, starting from
7454 * the one set with this call, is the previous interval divided by
7455 * 1.05, so it decreases a little bit.
7457 * The default starting interval value for automatic flips is
7460 * @see elm_clock_interval_get()
7464 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7467 * Get the interval on time updates for an user mouse button hold
7468 * on clock widgets' time edition.
7470 * @param obj The clock object
7471 * @return The (first) interval value, in seconds, set on it
7473 * @see elm_clock_interval_set() for more details
7477 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7484 * @defgroup Layout Layout
7486 * @image html img/widget/layout/preview-00.png
7487 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7489 * @image html img/layout-predefined.png
7490 * @image latex img/layout-predefined.eps width=\textwidth
7492 * This is a container widget that takes a standard Edje design file and
7493 * wraps it very thinly in a widget.
7495 * An Edje design (theme) file has a very wide range of possibilities to
7496 * describe the behavior of elements added to the Layout. Check out the Edje
7497 * documentation and the EDC reference to get more information about what can
7498 * be done with Edje.
7500 * Just like @ref List, @ref Box, and other container widgets, any
7501 * object added to the Layout will become its child, meaning that it will be
7502 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7504 * The Layout widget can contain as many Contents, Boxes or Tables as
7505 * described in its theme file. For instance, objects can be added to
7506 * different Tables by specifying the respective Table part names. The same
7507 * is valid for Content and Box.
7509 * The objects added as child of the Layout will behave as described in the
7510 * part description where they were added. There are 3 possible types of
7511 * parts where a child can be added:
7513 * @section secContent Content (SWALLOW part)
7515 * Only one object can be added to the @c SWALLOW part (but you still can
7516 * have many @c SWALLOW parts and one object on each of them). Use the @c
7517 * elm_layout_content_* set of functions to set, retrieve and unset objects
7518 * as content of the @c SWALLOW. After being set to this part, the object
7519 * size, position, visibility, clipping and other description properties
7520 * will be totally controled by the description of the given part (inside
7521 * the Edje theme file).
7523 * One can use @c evas_object_size_hint_* functions on the child to have some
7524 * kind of control over its behavior, but the resulting behavior will still
7525 * depend heavily on the @c SWALLOW part description.
7527 * The Edje theme also can change the part description, based on signals or
7528 * scripts running inside the theme. This change can also be animated. All of
7529 * this will affect the child object set as content accordingly. The object
7530 * size will be changed if the part size is changed, it will animate move if
7531 * the part is moving, and so on.
7533 * The following picture demonstrates a Layout widget with a child object
7534 * added to its @c SWALLOW:
7536 * @image html layout_swallow.png
7537 * @image latex layout_swallow.eps width=\textwidth
7539 * @section secBox Box (BOX part)
7541 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7542 * allows one to add objects to the box and have them distributed along its
7543 * area, accordingly to the specified @a layout property (now by @a layout we
7544 * mean the chosen layouting design of the Box, not the Layout widget
7547 * A similar effect for having a box with its position, size and other things
7548 * controled by the Layout theme would be to create an Elementary @ref Box
7549 * widget and add it as a Content in the @c SWALLOW part.
7551 * The main difference of using the Layout Box is that its behavior, the box
7552 * properties like layouting format, padding, align, etc. will be all
7553 * controled by the theme. This means, for example, that a signal could be
7554 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7555 * handled the signal by changing the box padding, or align, or both. Using
7556 * the Elementary @ref Box widget is not necessarily harder or easier, it
7557 * just depends on the circunstances and requirements.
7559 * The Layout Box can be used through the @c elm_layout_box_* set of
7562 * The following picture demonstrates a Layout widget with many child objects
7563 * added to its @c BOX part:
7565 * @image html layout_box.png
7566 * @image latex layout_box.eps width=\textwidth
7568 * @section secTable Table (TABLE part)
7570 * Just like the @ref secBox, the Layout Table is very similar to the
7571 * Elementary @ref Table widget. It allows one to add objects to the Table
7572 * specifying the row and column where the object should be added, and any
7573 * column or row span if necessary.
7575 * Again, we could have this design by adding a @ref Table widget to the @c
7576 * SWALLOW part using elm_layout_content_set(). The same difference happens
7577 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7578 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7580 * The Layout Table can be used through the @c elm_layout_table_* set of
7583 * The following picture demonstrates a Layout widget with many child objects
7584 * added to its @c TABLE part:
7586 * @image html layout_table.png
7587 * @image latex layout_table.eps width=\textwidth
7589 * @section secPredef Predefined Layouts
7591 * Another interesting thing about the Layout widget is that it offers some
7592 * predefined themes that come with the default Elementary theme. These
7593 * themes can be set by the call elm_layout_theme_set(), and provide some
7594 * basic functionality depending on the theme used.
7596 * Most of them already send some signals, some already provide a toolbar or
7597 * back and next buttons.
7599 * These are available predefined theme layouts. All of them have class = @c
7600 * layout, group = @c application, and style = one of the following options:
7602 * @li @c toolbar-content - application with toolbar and main content area
7603 * @li @c toolbar-content-back - application with toolbar and main content
7604 * area with a back button and title area
7605 * @li @c toolbar-content-back-next - application with toolbar and main
7606 * content area with a back and next buttons and title area
7607 * @li @c content-back - application with a main content area with a back
7608 * button and title area
7609 * @li @c content-back-next - application with a main content area with a
7610 * back and next buttons and title area
7611 * @li @c toolbar-vbox - application with toolbar and main content area as a
7613 * @li @c toolbar-table - application with toolbar and main content area as a
7616 * @section secExamples Examples
7618 * Some examples of the Layout widget can be found here:
7619 * @li @ref layout_example_01
7620 * @li @ref layout_example_02
7621 * @li @ref layout_example_03
7622 * @li @ref layout_example_edc
7627 * Add a new layout to the parent
7629 * @param parent The parent object
7630 * @return The new object or NULL if it cannot be created
7632 * @see elm_layout_file_set()
7633 * @see elm_layout_theme_set()
7637 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7639 * Set the file that will be used as layout
7641 * @param obj The layout object
7642 * @param file The path to file (edj) that will be used as layout
7643 * @param group The group that the layout belongs in edje file
7645 * @return (1 = success, 0 = error)
7649 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7651 * Set the edje group from the elementary theme that will be used as layout
7653 * @param obj The layout object
7654 * @param clas the clas of the group
7655 * @param group the group
7656 * @param style the style to used
7658 * @return (1 = success, 0 = error)
7662 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7664 * Set the layout content.
7666 * @param obj The layout object
7667 * @param swallow The swallow part name in the edje file
7668 * @param content The child that will be added in this layout object
7670 * Once the content object is set, a previously set one will be deleted.
7671 * If you want to keep that old content object, use the
7672 * elm_layout_content_unset() function.
7674 * @note In an Edje theme, the part used as a content container is called @c
7675 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7676 * expected to be a part name just like the second parameter of
7677 * elm_layout_box_append().
7679 * @see elm_layout_box_append()
7680 * @see elm_layout_content_get()
7681 * @see elm_layout_content_unset()
7686 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7688 * Get the child object in the given content part.
7690 * @param obj The layout object
7691 * @param swallow The SWALLOW part to get its content
7693 * @return The swallowed object or NULL if none or an error occurred
7695 * @see elm_layout_content_set()
7699 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7701 * Unset the layout content.
7703 * @param obj The layout object
7704 * @param swallow The swallow part name in the edje file
7705 * @return The content that was being used
7707 * Unparent and return the content object which was set for this part.
7709 * @see elm_layout_content_set()
7713 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7715 * Set the text of the given part
7717 * @param obj The layout object
7718 * @param part The TEXT part where to set the text
7719 * @param text The text to set
7722 * @deprecated use elm_object_text_* instead.
7724 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7726 * Get the text set in the given part
7728 * @param obj The layout object
7729 * @param part The TEXT part to retrieve the text off
7731 * @return The text set in @p part
7734 * @deprecated use elm_object_text_* instead.
7736 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7738 * Append child to layout box part.
7740 * @param obj the layout object
7741 * @param part the box part to which the object will be appended.
7742 * @param child the child object to append to box.
7744 * Once the object is appended, it will become child of the layout. Its
7745 * lifetime will be bound to the layout, whenever the layout dies the child
7746 * will be deleted automatically. One should use elm_layout_box_remove() to
7747 * make this layout forget about the object.
7749 * @see elm_layout_box_prepend()
7750 * @see elm_layout_box_insert_before()
7751 * @see elm_layout_box_insert_at()
7752 * @see elm_layout_box_remove()
7756 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7758 * Prepend child to layout box part.
7760 * @param obj the layout object
7761 * @param part the box part to prepend.
7762 * @param child the child object to prepend to box.
7764 * Once the object is prepended, it will become child of the layout. Its
7765 * lifetime will be bound to the layout, whenever the layout dies the child
7766 * will be deleted automatically. One should use elm_layout_box_remove() to
7767 * make this layout forget about the object.
7769 * @see elm_layout_box_append()
7770 * @see elm_layout_box_insert_before()
7771 * @see elm_layout_box_insert_at()
7772 * @see elm_layout_box_remove()
7776 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7778 * Insert child to layout box part before a reference object.
7780 * @param obj the layout object
7781 * @param part the box part to insert.
7782 * @param child the child object to insert into box.
7783 * @param reference another reference object to insert before in box.
7785 * Once the object is inserted, it will become child of the layout. Its
7786 * lifetime will be bound to the layout, whenever the layout dies the child
7787 * will be deleted automatically. One should use elm_layout_box_remove() to
7788 * make this layout forget about the object.
7790 * @see elm_layout_box_append()
7791 * @see elm_layout_box_prepend()
7792 * @see elm_layout_box_insert_before()
7793 * @see elm_layout_box_remove()
7797 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7799 * Insert child to layout box part at a given position.
7801 * @param obj the layout object
7802 * @param part the box part to insert.
7803 * @param child the child object to insert into box.
7804 * @param pos the numeric position >=0 to insert the child.
7806 * Once the object is inserted, it will become child of the layout. Its
7807 * lifetime will be bound to the layout, whenever the layout dies the child
7808 * will be deleted automatically. One should use elm_layout_box_remove() to
7809 * make this layout forget about the object.
7811 * @see elm_layout_box_append()
7812 * @see elm_layout_box_prepend()
7813 * @see elm_layout_box_insert_before()
7814 * @see elm_layout_box_remove()
7818 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7820 * Remove a child of the given part box.
7822 * @param obj The layout object
7823 * @param part The box part name to remove child.
7824 * @param child The object to remove from box.
7825 * @return The object that was being used, or NULL if not found.
7827 * The object will be removed from the box part and its lifetime will
7828 * not be handled by the layout anymore. This is equivalent to
7829 * elm_layout_content_unset() for box.
7831 * @see elm_layout_box_append()
7832 * @see elm_layout_box_remove_all()
7836 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7838 * Remove all child of the given part box.
7840 * @param obj The layout object
7841 * @param part The box part name to remove child.
7842 * @param clear If EINA_TRUE, then all objects will be deleted as
7843 * well, otherwise they will just be removed and will be
7844 * dangling on the canvas.
7846 * The objects will be removed from the box part and their lifetime will
7847 * not be handled by the layout anymore. This is equivalent to
7848 * elm_layout_box_remove() for all box children.
7850 * @see elm_layout_box_append()
7851 * @see elm_layout_box_remove()
7855 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7857 * Insert child to layout table part.
7859 * @param obj the layout object
7860 * @param part the box part to pack child.
7861 * @param child_obj the child object to pack into table.
7862 * @param col the column to which the child should be added. (>= 0)
7863 * @param row the row to which the child should be added. (>= 0)
7864 * @param colspan how many columns should be used to store this object. (>=
7866 * @param rowspan how many rows should be used to store this object. (>= 1)
7868 * Once the object is inserted, it will become child of the table. Its
7869 * lifetime will be bound to the layout, and whenever the layout dies the
7870 * child will be deleted automatically. One should use
7871 * elm_layout_table_remove() to make this layout forget about the object.
7873 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7874 * more space than a single cell. For instance, the following code:
7876 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7879 * Would result in an object being added like the following picture:
7881 * @image html layout_colspan.png
7882 * @image latex layout_colspan.eps width=\textwidth
7884 * @see elm_layout_table_unpack()
7885 * @see elm_layout_table_clear()
7889 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);
7891 * Unpack (remove) a child of the given part table.
7893 * @param obj The layout object
7894 * @param part The table part name to remove child.
7895 * @param child_obj The object to remove from table.
7896 * @return The object that was being used, or NULL if not found.
7898 * The object will be unpacked from the table part and its lifetime
7899 * will not be handled by the layout anymore. This is equivalent to
7900 * elm_layout_content_unset() for table.
7902 * @see elm_layout_table_pack()
7903 * @see elm_layout_table_clear()
7907 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7909 * Remove all child of the given part table.
7911 * @param obj The layout object
7912 * @param part The table part name to remove child.
7913 * @param clear If EINA_TRUE, then all objects will be deleted as
7914 * well, otherwise they will just be removed and will be
7915 * dangling on the canvas.
7917 * The objects will be removed from the table part and their lifetime will
7918 * not be handled by the layout anymore. This is equivalent to
7919 * elm_layout_table_unpack() for all table children.
7921 * @see elm_layout_table_pack()
7922 * @see elm_layout_table_unpack()
7926 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7928 * Get the edje layout
7930 * @param obj The layout object
7932 * @return A Evas_Object with the edje layout settings loaded
7933 * with function elm_layout_file_set
7935 * This returns the edje object. It is not expected to be used to then
7936 * swallow objects via edje_object_part_swallow() for example. Use
7937 * elm_layout_content_set() instead so child object handling and sizing is
7940 * @note This function should only be used if you really need to call some
7941 * low level Edje function on this edje object. All the common stuff (setting
7942 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7943 * with proper elementary functions.
7945 * @see elm_object_signal_callback_add()
7946 * @see elm_object_signal_emit()
7947 * @see elm_object_text_part_set()
7948 * @see elm_layout_content_set()
7949 * @see elm_layout_box_append()
7950 * @see elm_layout_table_pack()
7951 * @see elm_layout_data_get()
7955 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7957 * Get the edje data from the given layout
7959 * @param obj The layout object
7960 * @param key The data key
7962 * @return The edje data string
7964 * This function fetches data specified inside the edje theme of this layout.
7965 * This function return NULL if data is not found.
7967 * In EDC this comes from a data block within the group block that @p
7968 * obj was loaded from. E.g.
7975 * item: "key1" "value1";
7976 * item: "key2" "value2";
7984 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7988 * @param obj The layout object
7990 * Manually forces a sizing re-evaluation. This is useful when the minimum
7991 * size required by the edje theme of this layout has changed. The change on
7992 * the minimum size required by the edje theme is not immediately reported to
7993 * the elementary layout, so one needs to call this function in order to tell
7994 * the widget (layout) that it needs to reevaluate its own size.
7996 * The minimum size of the theme is calculated based on minimum size of
7997 * parts, the size of elements inside containers like box and table, etc. All
7998 * of this can change due to state changes, and that's when this function
8001 * Also note that a standard signal of "size,eval" "elm" emitted from the
8002 * edje object will cause this to happen too.
8006 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
8007 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
8008 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
8009 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
8010 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
8011 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
8012 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);
8013 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
8015 * @def elm_layout_icon_set
8016 * Convienience macro to set the icon object in a layout that follows the
8017 * Elementary naming convention for its parts.
8021 #define elm_layout_icon_set(_ly, _obj) \
8024 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
8025 if ((_obj)) sig = "elm,state,icon,visible"; \
8026 else sig = "elm,state,icon,hidden"; \
8027 elm_object_signal_emit((_ly), sig, "elm"); \
8031 * @def elm_layout_icon_get
8032 * Convienience macro to get the icon object from a layout that follows the
8033 * Elementary naming convention for its parts.
8037 #define elm_layout_icon_get(_ly) \
8038 elm_layout_content_get((_ly), "elm.swallow.icon")
8041 * @def elm_layout_end_set
8042 * Convienience macro to set the end object in a layout that follows the
8043 * Elementary naming convention for its parts.
8047 #define elm_layout_end_set(_ly, _obj) \
8050 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
8051 if ((_obj)) sig = "elm,state,end,visible"; \
8052 else sig = "elm,state,end,hidden"; \
8053 elm_object_signal_emit((_ly), sig, "elm"); \
8057 * @def elm_layout_end_get
8058 * Convienience macro to get the end object in a layout that follows the
8059 * Elementary naming convention for its parts.
8063 #define elm_layout_end_get(_ly) \
8064 elm_layout_content_get((_ly), "elm.swallow.end")
8067 * @def elm_layout_label_set
8068 * Convienience macro to set the label in a layout that follows the
8069 * Elementary naming convention for its parts.
8072 * @deprecated use elm_object_text_* instead.
8074 #define elm_layout_label_set(_ly, _txt) \
8075 elm_layout_text_set((_ly), "elm.text", (_txt))
8078 * @def elm_layout_label_get
8079 * Convienience macro to get the label in a layout that follows the
8080 * Elementary naming convention for its parts.
8083 * @deprecated use elm_object_text_* instead.
8085 #define elm_layout_label_get(_ly) \
8086 elm_layout_text_get((_ly), "elm.text")
8088 /* smart callbacks called:
8089 * "theme,changed" - when elm theme is changed.
8093 * @defgroup Notify Notify
8095 * @image html img/widget/notify/preview-00.png
8096 * @image latex img/widget/notify/preview-00.eps
8098 * Display a container in a particular region of the parent(top, bottom,
8099 * etc. A timeout can be set to automatically hide the notify. This is so
8100 * that, after an evas_object_show() on a notify object, if a timeout was set
8101 * on it, it will @b automatically get hidden after that time.
8103 * Signals that you can add callbacks for are:
8104 * @li "timeout" - when timeout happens on notify and it's hidden
8105 * @li "block,clicked" - when a click outside of the notify happens
8107 * @ref tutorial_notify show usage of the API.
8112 * @brief Possible orient values for notify.
8114 * This values should be used in conjunction to elm_notify_orient_set() to
8115 * set the position in which the notify should appear(relative to its parent)
8116 * and in conjunction with elm_notify_orient_get() to know where the notify
8119 typedef enum _Elm_Notify_Orient
8121 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
8122 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
8123 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
8124 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
8125 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
8126 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
8127 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
8128 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
8129 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
8130 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
8131 } Elm_Notify_Orient;
8133 * @brief Add a new notify to the parent
8135 * @param parent The parent object
8136 * @return The new object or NULL if it cannot be created
8138 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8140 * @brief Set the content of the notify widget
8142 * @param obj The notify object
8143 * @param content The content will be filled in this notify object
8145 * Once the content object is set, a previously set one will be deleted. If
8146 * you want to keep that old content object, use the
8147 * elm_notify_content_unset() function.
8149 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8151 * @brief Unset the content of the notify widget
8153 * @param obj The notify object
8154 * @return The content that was being used
8156 * Unparent and return the content object which was set for this widget
8158 * @see elm_notify_content_set()
8160 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8162 * @brief Return the content of the notify widget
8164 * @param obj The notify object
8165 * @return The content that is being used
8167 * @see elm_notify_content_set()
8169 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8171 * @brief Set the notify parent
8173 * @param obj The notify object
8174 * @param content The new parent
8176 * Once the parent object is set, a previously set one will be disconnected
8179 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8181 * @brief Get the notify parent
8183 * @param obj The notify object
8184 * @return The parent
8186 * @see elm_notify_parent_set()
8188 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8190 * @brief Set the orientation
8192 * @param obj The notify object
8193 * @param orient The new orientation
8195 * Sets the position in which the notify will appear in its parent.
8197 * @see @ref Elm_Notify_Orient for possible values.
8199 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
8201 * @brief Return the orientation
8202 * @param obj The notify object
8203 * @return The orientation of the notification
8205 * @see elm_notify_orient_set()
8206 * @see Elm_Notify_Orient
8208 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8210 * @brief Set the time interval after which the notify window is going to be
8213 * @param obj The notify object
8214 * @param time The timeout in seconds
8216 * This function sets a timeout and starts the timer controlling when the
8217 * notify is hidden. Since calling evas_object_show() on a notify restarts
8218 * the timer controlling when the notify is hidden, setting this before the
8219 * notify is shown will in effect mean starting the timer when the notify is
8222 * @note Set a value <= 0.0 to disable a running timer.
8224 * @note If the value > 0.0 and the notify is previously visible, the
8225 * timer will be started with this value, canceling any running timer.
8227 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
8229 * @brief Return the timeout value (in seconds)
8230 * @param obj the notify object
8232 * @see elm_notify_timeout_set()
8234 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8236 * @brief Sets whether events should be passed to by a click outside
8239 * @param obj The notify object
8240 * @param repeats EINA_TRUE Events are repeats, else no
8242 * When true if the user clicks outside the window the events will be caught
8243 * by the others widgets, else the events are blocked.
8245 * @note The default value is EINA_TRUE.
8247 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8249 * @brief Return true if events are repeat below the notify object
8250 * @param obj the notify object
8252 * @see elm_notify_repeat_events_set()
8254 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8260 * @defgroup Hover Hover
8262 * @image html img/widget/hover/preview-00.png
8263 * @image latex img/widget/hover/preview-00.eps
8265 * A Hover object will hover over its @p parent object at the @p target
8266 * location. Anything in the background will be given a darker coloring to
8267 * indicate that the hover object is on top (at the default theme). When the
8268 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8269 * clicked that @b doesn't cause the hover to be dismissed.
8271 * @note The hover object will take up the entire space of @p target
8274 * Elementary has the following styles for the hover widget:
8278 * @li hoversel_vertical
8280 * The following are the available position for content:
8292 * Signals that you can add callbacks for are:
8293 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8294 * @li "smart,changed" - a content object placed under the "smart"
8295 * policy was replaced to a new slot direction.
8297 * See @ref tutorial_hover for more information.
8301 typedef enum _Elm_Hover_Axis
8303 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8304 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8305 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8306 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8309 * @brief Adds a hover object to @p parent
8311 * @param parent The parent object
8312 * @return The hover object or NULL if one could not be created
8314 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8316 * @brief Sets the target object for the hover.
8318 * @param obj The hover object
8319 * @param target The object to center the hover onto. The hover
8321 * This function will cause the hover to be centered on the target object.
8323 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8325 * @brief Gets the target object for the hover.
8327 * @param obj The hover object
8328 * @param parent The object to locate the hover over.
8330 * @see elm_hover_target_set()
8332 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8334 * @brief Sets the parent object for the hover.
8336 * @param obj The hover object
8337 * @param parent The object to locate the hover over.
8339 * This function will cause the hover to take up the entire space that the
8340 * parent object fills.
8342 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8344 * @brief Gets the parent object for the hover.
8346 * @param obj The hover object
8347 * @return The parent object to locate the hover over.
8349 * @see elm_hover_parent_set()
8351 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8353 * @brief Sets the content of the hover object and the direction in which it
8356 * @param obj The hover object
8357 * @param swallow The direction that the object will be displayed
8358 * at. Accepted values are "left", "top-left", "top", "top-right",
8359 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8361 * @param content The content to place at @p swallow
8363 * Once the content object is set for a given direction, a previously
8364 * set one (on the same direction) will be deleted. If you want to
8365 * keep that old content object, use the elm_hover_content_unset()
8368 * All directions may have contents at the same time, except for
8369 * "smart". This is a special placement hint and its use case
8370 * independs of the calculations coming from
8371 * elm_hover_best_content_location_get(). Its use is for cases when
8372 * one desires only one hover content, but with a dinamic special
8373 * placement within the hover area. The content's geometry, whenever
8374 * it changes, will be used to decide on a best location not
8375 * extrapolating the hover's parent object view to show it in (still
8376 * being the hover's target determinant of its medium part -- move and
8377 * resize it to simulate finger sizes, for example). If one of the
8378 * directions other than "smart" are used, a previously content set
8379 * using it will be deleted, and vice-versa.
8381 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8383 * @brief Get the content of the hover object, in a given direction.
8385 * Return the content object which was set for this widget in the
8386 * @p swallow direction.
8388 * @param obj The hover object
8389 * @param swallow The direction that the object was display at.
8390 * @return The content that was being used
8392 * @see elm_hover_content_set()
8394 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8396 * @brief Unset the content of the hover object, in a given direction.
8398 * Unparent and return the content object set at @p swallow direction.
8400 * @param obj The hover object
8401 * @param swallow The direction that the object was display at.
8402 * @return The content that was being used.
8404 * @see elm_hover_content_set()
8406 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8408 * @brief Returns the best swallow location for content in the hover.
8410 * @param obj The hover object
8411 * @param pref_axis The preferred orientation axis for the hover object to use
8412 * @return The edje location to place content into the hover or @c
8415 * Best is defined here as the location at which there is the most available
8418 * @p pref_axis may be one of
8419 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8420 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8421 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8422 * - @c ELM_HOVER_AXIS_BOTH -- both
8424 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8425 * nescessarily be along the horizontal axis("left" or "right"). If
8426 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8427 * be along the vertical axis("top" or "bottom"). Chossing
8428 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8429 * returned position may be in either axis.
8431 * @see elm_hover_content_set()
8433 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8440 * @defgroup Entry Entry
8442 * @image html img/widget/entry/preview-00.png
8443 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8444 * @image html img/widget/entry/preview-01.png
8445 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8446 * @image html img/widget/entry/preview-02.png
8447 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8448 * @image html img/widget/entry/preview-03.png
8449 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8451 * An entry is a convenience widget which shows a box that the user can
8452 * enter text into. Entries by default don't scroll, so they grow to
8453 * accomodate the entire text, resizing the parent window as needed. This
8454 * can be changed with the elm_entry_scrollable_set() function.
8456 * They can also be single line or multi line (the default) and when set
8457 * to multi line mode they support text wrapping in any of the modes
8458 * indicated by #Elm_Wrap_Type.
8460 * Other features include password mode, filtering of inserted text with
8461 * elm_entry_text_filter_append() and related functions, inline "items" and
8462 * formatted markup text.
8464 * @section entry-markup Formatted text
8466 * The markup tags supported by the Entry are defined by the theme, but
8467 * even when writing new themes or extensions it's a good idea to stick to
8468 * a sane default, to maintain coherency and avoid application breakages.
8469 * Currently defined by the default theme are the following tags:
8470 * @li \<br\>: Inserts a line break.
8471 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8473 * @li \<tab\>: Inserts a tab.
8474 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8476 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8477 * @li \<link\>...\</link\>: Underlines the enclosed text.
8478 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8480 * @section entry-special Special markups
8482 * Besides those used to format text, entries support two special markup
8483 * tags used to insert clickable portions of text or items inlined within
8486 * @subsection entry-anchors Anchors
8488 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8489 * \</a\> tags and an event will be generated when this text is clicked,
8493 * This text is outside <a href=anc-01>but this one is an anchor</a>
8496 * The @c href attribute in the opening tag gives the name that will be
8497 * used to identify the anchor and it can be any valid utf8 string.
8499 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8500 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8501 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8502 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8505 * @subsection entry-items Items
8507 * Inlined in the text, any other @c Evas_Object can be inserted by using
8508 * \<item\> tags this way:
8511 * <item size=16x16 vsize=full href=emoticon/haha></item>
8514 * Just like with anchors, the @c href identifies each item, but these need,
8515 * in addition, to indicate their size, which is done using any one of
8516 * @c size, @c absize or @c relsize attributes. These attributes take their
8517 * value in the WxH format, where W is the width and H the height of the
8520 * @li absize: Absolute pixel size for the item. Whatever value is set will
8521 * be the item's size regardless of any scale value the object may have
8522 * been set to. The final line height will be adjusted to fit larger items.
8523 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8525 * @li relsize: Size is adjusted for the item to fit within the current
8528 * Besides their size, items are specificed a @c vsize value that affects
8529 * how their final size and position are calculated. The possible values
8531 * @li ascent: Item will be placed within the line's baseline and its
8532 * ascent. That is, the height between the line where all characters are
8533 * positioned and the highest point in the line. For @c size and @c absize
8534 * items, the descent value will be added to the total line height to make
8535 * them fit. @c relsize items will be adjusted to fit within this space.
8536 * @li full: Items will be placed between the descent and ascent, or the
8537 * lowest point in the line and its highest.
8539 * The next image shows different configurations of items and how they
8540 * are the previously mentioned options affect their sizes. In all cases,
8541 * the green line indicates the ascent, blue for the baseline and red for
8544 * @image html entry_item.png
8545 * @image latex entry_item.eps width=\textwidth
8547 * And another one to show how size differs from absize. In the first one,
8548 * the scale value is set to 1.0, while the second one is using one of 2.0.
8550 * @image html entry_item_scale.png
8551 * @image latex entry_item_scale.eps width=\textwidth
8553 * After the size for an item is calculated, the entry will request an
8554 * object to place in its space. For this, the functions set with
8555 * elm_entry_item_provider_append() and related functions will be called
8556 * in order until one of them returns a @c non-NULL value. If no providers
8557 * are available, or all of them return @c NULL, then the entry falls back
8558 * to one of the internal defaults, provided the name matches with one of
8561 * All of the following are currently supported:
8564 * - emoticon/angry-shout
8565 * - emoticon/crazy-laugh
8566 * - emoticon/evil-laugh
8568 * - emoticon/goggle-smile
8570 * - emoticon/grumpy-smile
8572 * - emoticon/guilty-smile
8574 * - emoticon/half-smile
8575 * - emoticon/happy-panting
8577 * - emoticon/indifferent
8579 * - emoticon/knowing-grin
8581 * - emoticon/little-bit-sorry
8582 * - emoticon/love-lots
8584 * - emoticon/minimal-smile
8585 * - emoticon/not-happy
8586 * - emoticon/not-impressed
8588 * - emoticon/opensmile
8591 * - emoticon/squint-laugh
8592 * - emoticon/surprised
8593 * - emoticon/suspicious
8594 * - emoticon/tongue-dangling
8595 * - emoticon/tongue-poke
8597 * - emoticon/unhappy
8598 * - emoticon/very-sorry
8601 * - emoticon/worried
8604 * Alternatively, an item may reference an image by its path, using
8605 * the URI form @c file:///path/to/an/image.png and the entry will then
8606 * use that image for the item.
8608 * @section entry-files Loading and saving files
8610 * Entries have convinience functions to load text from a file and save
8611 * changes back to it after a short delay. The automatic saving is enabled
8612 * by default, but can be disabled with elm_entry_autosave_set() and files
8613 * can be loaded directly as plain text or have any markup in them
8614 * recognized. See elm_entry_file_set() for more details.
8616 * @section entry-signals Emitted signals
8618 * This widget emits the following signals:
8620 * @li "changed": The text within the entry was changed.
8621 * @li "changed,user": The text within the entry was changed because of user interaction.
8622 * @li "activated": The enter key was pressed on a single line entry.
8623 * @li "press": A mouse button has been pressed on the entry.
8624 * @li "longpressed": A mouse button has been pressed and held for a couple
8626 * @li "clicked": The entry has been clicked (mouse press and release).
8627 * @li "clicked,double": The entry has been double clicked.
8628 * @li "clicked,triple": The entry has been triple clicked.
8629 * @li "focused": The entry has received focus.
8630 * @li "unfocused": The entry has lost focus.
8631 * @li "selection,paste": A paste of the clipboard contents was requested.
8632 * @li "selection,copy": A copy of the selected text into the clipboard was
8634 * @li "selection,cut": A cut of the selected text into the clipboard was
8636 * @li "selection,start": A selection has begun and no previous selection
8638 * @li "selection,changed": The current selection has changed.
8639 * @li "selection,cleared": The current selection has been cleared.
8640 * @li "cursor,changed": The cursor has changed position.
8641 * @li "anchor,clicked": An anchor has been clicked. The event_info
8642 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8643 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8644 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8645 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8646 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8647 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8648 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8649 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8650 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8651 * @li "preedit,changed": The preedit string has changed.
8653 * @section entry-examples
8655 * An overview of the Entry API can be seen in @ref entry_example_01
8660 * @typedef Elm_Entry_Anchor_Info
8662 * The info sent in the callback for the "anchor,clicked" signals emitted
8665 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8667 * @struct _Elm_Entry_Anchor_Info
8669 * The info sent in the callback for the "anchor,clicked" signals emitted
8672 struct _Elm_Entry_Anchor_Info
8674 const char *name; /**< The name of the anchor, as stated in its href */
8675 int button; /**< The mouse button used to click on it */
8676 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8677 y, /**< Anchor geometry, relative to canvas */
8678 w, /**< Anchor geometry, relative to canvas */
8679 h; /**< Anchor geometry, relative to canvas */
8682 * @typedef Elm_Entry_Filter_Cb
8683 * This callback type is used by entry filters to modify text.
8684 * @param data The data specified as the last param when adding the filter
8685 * @param entry The entry object
8686 * @param text A pointer to the location of the text being filtered. This data can be modified,
8687 * but any additional allocations must be managed by the user.
8688 * @see elm_entry_text_filter_append
8689 * @see elm_entry_text_filter_prepend
8691 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8694 * This adds an entry to @p parent object.
8696 * By default, entries are:
8700 * @li autosave is enabled
8702 * @param parent The parent object
8703 * @return The new object or NULL if it cannot be created
8705 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8707 * Sets the entry to single line mode.
8709 * In single line mode, entries don't ever wrap when the text reaches the
8710 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8711 * key will generate an @c "activate" event instead of adding a new line.
8713 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8714 * and pressing enter will break the text into a different line
8715 * without generating any events.
8717 * @param obj The entry object
8718 * @param single_line If true, the text in the entry
8719 * will be on a single line.
8721 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8723 * Gets whether the entry is set to be single line.
8725 * @param obj The entry object
8726 * @return single_line If true, the text in the entry is set to display
8729 * @see elm_entry_single_line_set()
8731 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8733 * Sets the entry to password mode.
8735 * In password mode, entries are implicitly single line and the display of
8736 * any text in them is replaced with asterisks (*).
8738 * @param obj The entry object
8739 * @param password If true, password mode is enabled.
8741 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8743 * Gets whether the entry is set to password mode.
8745 * @param obj The entry object
8746 * @return If true, the entry is set to display all characters
8749 * @see elm_entry_password_set()
8751 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8753 * This sets the text displayed within the entry to @p entry.
8755 * @param obj The entry object
8756 * @param entry The text to be displayed
8758 * @deprecated Use elm_object_text_set() instead.
8760 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8762 * This returns the text currently shown in object @p entry.
8763 * See also elm_entry_entry_set().
8765 * @param obj The entry object
8766 * @return The currently displayed text or NULL on failure
8768 * @deprecated Use elm_object_text_get() instead.
8770 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8772 * Appends @p entry to the text of the entry.
8774 * Adds the text in @p entry to the end of any text already present in the
8777 * The appended text is subject to any filters set for the widget.
8779 * @param obj The entry object
8780 * @param entry The text to be displayed
8782 * @see elm_entry_text_filter_append()
8784 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8786 * Gets whether the entry is empty.
8788 * Empty means no text at all. If there are any markup tags, like an item
8789 * tag for which no provider finds anything, and no text is displayed, this
8790 * function still returns EINA_FALSE.
8792 * @param obj The entry object
8793 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8795 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8797 * Gets any selected text within the entry.
8799 * If there's any selected text in the entry, this function returns it as
8800 * a string in markup format. NULL is returned if no selection exists or
8801 * if an error occurred.
8803 * The returned value points to an internal string and should not be freed
8804 * or modified in any way. If the @p entry object is deleted or its
8805 * contents are changed, the returned pointer should be considered invalid.
8807 * @param obj The entry object
8808 * @return The selected text within the entry or NULL on failure
8810 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8812 * Inserts the given text into the entry at the current cursor position.
8814 * This inserts text at the cursor position as if it was typed
8815 * by the user (note that this also allows markup which a user
8816 * can't just "type" as it would be converted to escaped text, so this
8817 * call can be used to insert things like emoticon items or bold push/pop
8818 * tags, other font and color change tags etc.)
8820 * If any selection exists, it will be replaced by the inserted text.
8822 * The inserted text is subject to any filters set for the widget.
8824 * @param obj The entry object
8825 * @param entry The text to insert
8827 * @see elm_entry_text_filter_append()
8829 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8831 * Set the line wrap type to use on multi-line entries.
8833 * Sets the wrap type used by the entry to any of the specified in
8834 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8835 * line (without inserting a line break or paragraph separator) when it
8836 * reaches the far edge of the widget.
8838 * Note that this only makes sense for multi-line entries. A widget set
8839 * to be single line will never wrap.
8841 * @param obj The entry object
8842 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8844 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8846 * Gets the wrap mode the entry was set to use.
8848 * @param obj The entry object
8851 * @see also elm_entry_line_wrap_set()
8853 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8855 * Sets if the entry is to be editable or not.
8857 * By default, entries are editable and when focused, any text input by the
8858 * user will be inserted at the current cursor position. But calling this
8859 * function with @p editable as EINA_FALSE will prevent the user from
8860 * inputting text into the entry.
8862 * The only way to change the text of a non-editable entry is to use
8863 * elm_object_text_set(), elm_entry_entry_insert() and other related
8866 * @param obj The entry object
8867 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8868 * if not, the entry is read-only and no user input is allowed.
8870 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8872 * Gets whether the entry is editable or not.
8874 * @param obj The entry object
8875 * @return If true, the entry is editable by the user.
8876 * If false, it is not editable by the user
8878 * @see elm_entry_editable_set()
8880 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8882 * This drops any existing text selection within the entry.
8884 * @param obj The entry object
8886 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8888 * This selects all text within the entry.
8890 * @param obj The entry object
8892 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8894 * This moves the cursor one place to the right within the entry.
8896 * @param obj The entry object
8897 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8899 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8901 * This moves the cursor one place to the left within the entry.
8903 * @param obj The entry object
8904 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8906 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8908 * This moves the cursor one line up within the entry.
8910 * @param obj The entry object
8911 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8913 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8915 * This moves the cursor one line down within the entry.
8917 * @param obj The entry object
8918 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8920 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8922 * This moves the cursor to the beginning of the entry.
8924 * @param obj The entry object
8926 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8928 * This moves the cursor to the end of the entry.
8930 * @param obj The entry object
8932 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8934 * This moves the cursor to the beginning of the current line.
8936 * @param obj The entry object
8938 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8940 * This moves the cursor to the end of the current line.
8942 * @param obj The entry object
8944 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8946 * This begins a selection within the entry as though
8947 * the user were holding down the mouse button to make a selection.
8949 * @param obj The entry object
8951 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8953 * This ends a selection within the entry as though
8954 * the user had just released the mouse button while making a selection.
8956 * @param obj The entry object
8958 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8960 * Gets whether a format node exists at the current cursor position.
8962 * A format node is anything that defines how the text is rendered. It can
8963 * be a visible format node, such as a line break or a paragraph separator,
8964 * or an invisible one, such as bold begin or end tag.
8965 * This function returns whether any format node exists at the current
8968 * @param obj The entry object
8969 * @return EINA_TRUE if the current cursor position contains a format node,
8970 * EINA_FALSE otherwise.
8972 * @see elm_entry_cursor_is_visible_format_get()
8974 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8976 * Gets if the current cursor position holds a visible format node.
8978 * @param obj The entry object
8979 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8980 * if it's an invisible one or no format exists.
8982 * @see elm_entry_cursor_is_format_get()
8984 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8986 * Gets the character pointed by the cursor at its current position.
8988 * This function returns a string with the utf8 character stored at the
8989 * current cursor position.
8990 * Only the text is returned, any format that may exist will not be part
8991 * of the return value.
8993 * @param obj The entry object
8994 * @return The text pointed by the cursors.
8996 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8998 * This function returns the geometry of the cursor.
9000 * It's useful if you want to draw something on the cursor (or where it is),
9001 * or for example in the case of scrolled entry where you want to show the
9004 * @param obj The entry object
9005 * @param x returned geometry
9006 * @param y returned geometry
9007 * @param w returned geometry
9008 * @param h returned geometry
9009 * @return EINA_TRUE upon success, EINA_FALSE upon failure
9011 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);
9013 * Sets the cursor position in the entry to the given value
9015 * The value in @p pos is the index of the character position within the
9016 * contents of the string as returned by elm_entry_cursor_pos_get().
9018 * @param obj The entry object
9019 * @param pos The position of the cursor
9021 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
9023 * Retrieves the current position of the cursor in the entry
9025 * @param obj The entry object
9026 * @return The cursor position
9028 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9030 * This executes a "cut" action on the selected text in the entry.
9032 * @param obj The entry object
9034 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
9036 * This executes a "copy" action on the selected text in the entry.
9038 * @param obj The entry object
9040 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
9042 * This executes a "paste" action in the entry.
9044 * @param obj The entry object
9046 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
9048 * This clears and frees the items in a entry's contextual (longpress)
9051 * @param obj The entry object
9053 * @see elm_entry_context_menu_item_add()
9055 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9057 * This adds an item to the entry's contextual menu.
9059 * A longpress on an entry will make the contextual menu show up, if this
9060 * hasn't been disabled with elm_entry_context_menu_disabled_set().
9061 * By default, this menu provides a few options like enabling selection mode,
9062 * which is useful on embedded devices that need to be explicit about it,
9063 * and when a selection exists it also shows the copy and cut actions.
9065 * With this function, developers can add other options to this menu to
9066 * perform any action they deem necessary.
9068 * @param obj The entry object
9069 * @param label The item's text label
9070 * @param icon_file The item's icon file
9071 * @param icon_type The item's icon type
9072 * @param func The callback to execute when the item is clicked
9073 * @param data The data to associate with the item for related functions
9075 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);
9077 * This disables the entry's contextual (longpress) menu.
9079 * @param obj The entry object
9080 * @param disabled If true, the menu is disabled
9082 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9084 * This returns whether the entry's contextual (longpress) menu is
9087 * @param obj The entry object
9088 * @return If true, the menu is disabled
9090 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9092 * This appends a custom item provider to the list for that entry
9094 * This appends the given callback. The list is walked from beginning to end
9095 * with each function called given the item href string in the text. If the
9096 * function returns an object handle other than NULL (it should create an
9097 * object to do this), then this object is used to replace that item. If
9098 * not the next provider is called until one provides an item object, or the
9099 * default provider in entry does.
9101 * @param obj The entry object
9102 * @param func The function called to provide the item object
9103 * @param data The data passed to @p func
9105 * @see @ref entry-items
9107 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);
9109 * This prepends a custom item provider to the list for that entry
9111 * This prepends the given callback. See elm_entry_item_provider_append() for
9114 * @param obj The entry object
9115 * @param func The function called to provide the item object
9116 * @param data The data passed to @p func
9118 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);
9120 * This removes a custom item provider to the list for that entry
9122 * This removes the given callback. See elm_entry_item_provider_append() for
9125 * @param obj The entry object
9126 * @param func The function called to provide the item object
9127 * @param data The data passed to @p func
9129 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);
9131 * Append a filter function for text inserted in the entry
9133 * Append the given callback to the list. This functions will be called
9134 * whenever any text is inserted into the entry, with the text to be inserted
9135 * as a parameter. The callback function is free to alter the text in any way
9136 * it wants, but it must remember to free the given pointer and update it.
9137 * If the new text is to be discarded, the function can free it and set its
9138 * text parameter to NULL. This will also prevent any following filters from
9141 * @param obj The entry object
9142 * @param func The function to use as text filter
9143 * @param data User data to pass to @p func
9145 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9147 * Prepend a filter function for text insdrted in the entry
9149 * Prepend the given callback to the list. See elm_entry_text_filter_append()
9150 * for more information
9152 * @param obj The entry object
9153 * @param func The function to use as text filter
9154 * @param data User data to pass to @p func
9156 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9158 * Remove a filter from the list
9160 * Removes the given callback from the filter list. See
9161 * elm_entry_text_filter_append() for more information.
9163 * @param obj The entry object
9164 * @param func The filter function to remove
9165 * @param data The user data passed when adding the function
9167 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9169 * This converts a markup (HTML-like) string into UTF-8.
9171 * The returned string is a malloc'ed buffer and it should be freed when
9172 * not needed anymore.
9174 * @param s The string (in markup) to be converted
9175 * @return The converted string (in UTF-8). It should be freed.
9177 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9179 * This converts a UTF-8 string into markup (HTML-like).
9181 * The returned string is a malloc'ed buffer and it should be freed when
9182 * not needed anymore.
9184 * @param s The string (in UTF-8) to be converted
9185 * @return The converted string (in markup). It should be freed.
9187 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9189 * This sets the file (and implicitly loads it) for the text to display and
9190 * then edit. All changes are written back to the file after a short delay if
9191 * the entry object is set to autosave (which is the default).
9193 * If the entry had any other file set previously, any changes made to it
9194 * will be saved if the autosave feature is enabled, otherwise, the file
9195 * will be silently discarded and any non-saved changes will be lost.
9197 * @param obj The entry object
9198 * @param file The path to the file to load and save
9199 * @param format The file format
9201 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
9203 * Gets the file being edited by the entry.
9205 * This function can be used to retrieve any file set on the entry for
9206 * edition, along with the format used to load and save it.
9208 * @param obj The entry object
9209 * @param file The path to the file to load and save
9210 * @param format The file format
9212 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
9214 * This function writes any changes made to the file set with
9215 * elm_entry_file_set()
9217 * @param obj The entry object
9219 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
9221 * This sets the entry object to 'autosave' the loaded text file or not.
9223 * @param obj The entry object
9224 * @param autosave Autosave the loaded file or not
9226 * @see elm_entry_file_set()
9228 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
9230 * This gets the entry object's 'autosave' status.
9232 * @param obj The entry object
9233 * @return Autosave the loaded file or not
9235 * @see elm_entry_file_set()
9237 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9239 * Control pasting of text and images for the widget.
9241 * Normally the entry allows both text and images to be pasted. By setting
9242 * textonly to be true, this prevents images from being pasted.
9244 * Note this only changes the behaviour of text.
9246 * @param obj The entry object
9247 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9250 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9252 * Getting elm_entry text paste/drop mode.
9254 * In textonly mode, only text may be pasted or dropped into the widget.
9256 * @param obj The entry object
9257 * @return If the widget only accepts text from pastes.
9259 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9261 * Enable or disable scrolling in entry
9263 * Normally the entry is not scrollable unless you enable it with this call.
9265 * @param obj The entry object
9266 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9268 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9270 * Get the scrollable state of the entry
9272 * Normally the entry is not scrollable. This gets the scrollable state
9273 * of the entry. See elm_entry_scrollable_set() for more information.
9275 * @param obj The entry object
9276 * @return The scrollable state
9278 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9280 * This sets a widget to be displayed to the left of a scrolled entry.
9282 * @param obj The scrolled entry object
9283 * @param icon The widget to display on the left side of the scrolled
9286 * @note A previously set widget will be destroyed.
9287 * @note If the object being set does not have minimum size hints set,
9288 * it won't get properly displayed.
9290 * @see elm_entry_end_set()
9292 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9294 * Gets the leftmost widget of the scrolled entry. This object is
9295 * owned by the scrolled entry and should not be modified.
9297 * @param obj The scrolled entry object
9298 * @return the left widget inside the scroller
9300 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9302 * Unset the leftmost widget of the scrolled entry, unparenting and
9305 * @param obj The scrolled entry object
9306 * @return the previously set icon sub-object of this entry, on
9309 * @see elm_entry_icon_set()
9311 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9313 * Sets the visibility of the left-side widget of the scrolled entry,
9314 * set by elm_entry_icon_set().
9316 * @param obj The scrolled entry object
9317 * @param setting EINA_TRUE if the object should be displayed,
9318 * EINA_FALSE if not.
9320 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9322 * This sets a widget to be displayed to the end of a scrolled entry.
9324 * @param obj The scrolled entry object
9325 * @param end The widget to display on the right side of the scrolled
9328 * @note A previously set widget will be destroyed.
9329 * @note If the object being set does not have minimum size hints set,
9330 * it won't get properly displayed.
9332 * @see elm_entry_icon_set
9334 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9336 * Gets the endmost widget of the scrolled entry. This object is owned
9337 * by the scrolled entry and should not be modified.
9339 * @param obj The scrolled entry object
9340 * @return the right widget inside the scroller
9342 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9344 * Unset the endmost widget of the scrolled entry, unparenting and
9347 * @param obj The scrolled entry object
9348 * @return the previously set icon sub-object of this entry, on
9351 * @see elm_entry_icon_set()
9353 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9355 * Sets the visibility of the end widget of the scrolled entry, set by
9356 * elm_entry_end_set().
9358 * @param obj The scrolled entry object
9359 * @param setting EINA_TRUE if the object should be displayed,
9360 * EINA_FALSE if not.
9362 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9364 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9367 * Setting an entry to single-line mode with elm_entry_single_line_set()
9368 * will automatically disable the display of scrollbars when the entry
9369 * moves inside its scroller.
9371 * @param obj The scrolled entry object
9372 * @param h The horizontal scrollbar policy to apply
9373 * @param v The vertical scrollbar policy to apply
9375 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9377 * This enables/disables bouncing within the entry.
9379 * This function sets whether the entry will bounce when scrolling reaches
9380 * the end of the contained entry.
9382 * @param obj The scrolled entry object
9383 * @param h The horizontal bounce state
9384 * @param v The vertical bounce state
9386 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9388 * Get the bounce mode
9390 * @param obj The Entry object
9391 * @param h_bounce Allow bounce horizontally
9392 * @param v_bounce Allow bounce vertically
9394 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9396 /* pre-made filters for entries */
9398 * @typedef Elm_Entry_Filter_Limit_Size
9400 * Data for the elm_entry_filter_limit_size() entry filter.
9402 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9404 * @struct _Elm_Entry_Filter_Limit_Size
9406 * Data for the elm_entry_filter_limit_size() entry filter.
9408 struct _Elm_Entry_Filter_Limit_Size
9410 int max_char_count; /**< The maximum number of characters allowed. */
9411 int max_byte_count; /**< The maximum number of bytes allowed*/
9414 * Filter inserted text based on user defined character and byte limits
9416 * Add this filter to an entry to limit the characters that it will accept
9417 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9418 * The funtion works on the UTF-8 representation of the string, converting
9419 * it from the set markup, thus not accounting for any format in it.
9421 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9422 * it as data when setting the filter. In it, it's possible to set limits
9423 * by character count or bytes (any of them is disabled if 0), and both can
9424 * be set at the same time. In that case, it first checks for characters,
9427 * The function will cut the inserted text in order to allow only the first
9428 * number of characters that are still allowed. The cut is made in
9429 * characters, even when limiting by bytes, in order to always contain
9430 * valid ones and avoid half unicode characters making it in.
9432 * This filter, like any others, does not apply when setting the entry text
9433 * directly with elm_object_text_set() (or the deprecated
9434 * elm_entry_entry_set()).
9436 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9438 * @typedef Elm_Entry_Filter_Accept_Set
9440 * Data for the elm_entry_filter_accept_set() entry filter.
9442 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9444 * @struct _Elm_Entry_Filter_Accept_Set
9446 * Data for the elm_entry_filter_accept_set() entry filter.
9448 struct _Elm_Entry_Filter_Accept_Set
9450 const char *accepted; /**< Set of characters accepted in the entry. */
9451 const char *rejected; /**< Set of characters rejected from the entry. */
9454 * Filter inserted text based on accepted or rejected sets of characters
9456 * Add this filter to an entry to restrict the set of accepted characters
9457 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9458 * This structure contains both accepted and rejected sets, but they are
9459 * mutually exclusive.
9461 * The @c accepted set takes preference, so if it is set, the filter will
9462 * only work based on the accepted characters, ignoring anything in the
9463 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9465 * In both cases, the function filters by matching utf8 characters to the
9466 * raw markup text, so it can be used to remove formatting tags.
9468 * This filter, like any others, does not apply when setting the entry text
9469 * directly with elm_object_text_set() (or the deprecated
9470 * elm_entry_entry_set()).
9472 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9477 /* composite widgets - these basically put together basic widgets above
9478 * in convenient packages that do more than basic stuff */
9482 * @defgroup Anchorview Anchorview
9484 * @image html img/widget/anchorview/preview-00.png
9485 * @image latex img/widget/anchorview/preview-00.eps
9487 * Anchorview is for displaying text that contains markup with anchors
9488 * like <c>\<a href=1234\>something\</\></c> in it.
9490 * Besides being styled differently, the anchorview widget provides the
9491 * necessary functionality so that clicking on these anchors brings up a
9492 * popup with user defined content such as "call", "add to contacts" or
9493 * "open web page". This popup is provided using the @ref Hover widget.
9495 * This widget is very similar to @ref Anchorblock, so refer to that
9496 * widget for an example. The only difference Anchorview has is that the
9497 * widget is already provided with scrolling functionality, so if the
9498 * text set to it is too large to fit in the given space, it will scroll,
9499 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9500 * text can be displayed.
9502 * This widget emits the following signals:
9503 * @li "anchor,clicked": will be called when an anchor is clicked. The
9504 * @p event_info parameter on the callback will be a pointer of type
9505 * ::Elm_Entry_Anchorview_Info.
9507 * See @ref Anchorblock for an example on how to use both of them.
9516 * @typedef Elm_Entry_Anchorview_Info
9518 * The info sent in the callback for "anchor,clicked" signals emitted by
9519 * the Anchorview widget.
9521 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9523 * @struct _Elm_Entry_Anchorview_Info
9525 * The info sent in the callback for "anchor,clicked" signals emitted by
9526 * the Anchorview widget.
9528 struct _Elm_Entry_Anchorview_Info
9530 const char *name; /**< Name of the anchor, as indicated in its href
9532 int button; /**< The mouse button used to click on it */
9533 Evas_Object *hover; /**< The hover object to use for the popup */
9535 Evas_Coord x, y, w, h;
9536 } anchor, /**< Geometry selection of text used as anchor */
9537 hover_parent; /**< Geometry of the object used as parent by the
9539 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9540 for content on the left side of
9541 the hover. Before calling the
9542 callback, the widget will make the
9543 necessary calculations to check
9544 which sides are fit to be set with
9545 content, based on the position the
9546 hover is activated and its distance
9547 to the edges of its parent object
9549 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9550 the right side of the hover.
9551 See @ref hover_left */
9552 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9553 of the hover. See @ref hover_left */
9554 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9555 below the hover. See @ref
9559 * Add a new Anchorview object
9561 * @param parent The parent object
9562 * @return The new object or NULL if it cannot be created
9564 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9566 * Set the text to show in the anchorview
9568 * Sets the text of the anchorview to @p text. This text can include markup
9569 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9570 * text that will be specially styled and react to click events, ended with
9571 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9572 * "anchor,clicked" signal that you can attach a callback to with
9573 * evas_object_smart_callback_add(). The name of the anchor given in the
9574 * event info struct will be the one set in the href attribute, in this
9577 * Other markup can be used to style the text in different ways, but it's
9578 * up to the style defined in the theme which tags do what.
9579 * @deprecated use elm_object_text_set() instead.
9581 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9583 * Get the markup text set for the anchorview
9585 * Retrieves the text set on the anchorview, with markup tags included.
9587 * @param obj The anchorview object
9588 * @return The markup text set or @c NULL if nothing was set or an error
9590 * @deprecated use elm_object_text_set() instead.
9592 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9594 * Set the parent of the hover popup
9596 * Sets the parent object to use by the hover created by the anchorview
9597 * when an anchor is clicked. See @ref Hover for more details on this.
9598 * If no parent is set, the same anchorview object will be used.
9600 * @param obj The anchorview object
9601 * @param parent The object to use as parent for the hover
9603 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9605 * Get the parent of the hover popup
9607 * Get the object used as parent for the hover created by the anchorview
9608 * widget. See @ref Hover for more details on this.
9610 * @param obj The anchorview object
9611 * @return The object used as parent for the hover, NULL if none is set.
9613 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9615 * Set the style that the hover should use
9617 * When creating the popup hover, anchorview will request that it's
9618 * themed according to @p style.
9620 * @param obj The anchorview object
9621 * @param style The style to use for the underlying hover
9623 * @see elm_object_style_set()
9625 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9627 * Get the style that the hover should use
9629 * Get the style the hover created by anchorview will use.
9631 * @param obj The anchorview object
9632 * @return The style to use by the hover. NULL means the default is used.
9634 * @see elm_object_style_set()
9636 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9638 * Ends the hover popup in the anchorview
9640 * When an anchor is clicked, the anchorview widget will create a hover
9641 * object to use as a popup with user provided content. This function
9642 * terminates this popup, returning the anchorview to its normal state.
9644 * @param obj The anchorview object
9646 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9648 * Set bouncing behaviour when the scrolled content reaches an edge
9650 * Tell the internal scroller object whether it should bounce or not
9651 * when it reaches the respective edges for each axis.
9653 * @param obj The anchorview object
9654 * @param h_bounce Whether to bounce or not in the horizontal axis
9655 * @param v_bounce Whether to bounce or not in the vertical axis
9657 * @see elm_scroller_bounce_set()
9659 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9661 * Get the set bouncing behaviour of the internal scroller
9663 * Get whether the internal scroller should bounce when the edge of each
9664 * axis is reached scrolling.
9666 * @param obj The anchorview object
9667 * @param h_bounce Pointer where to store the bounce state of the horizontal
9669 * @param v_bounce Pointer where to store the bounce state of the vertical
9672 * @see elm_scroller_bounce_get()
9674 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9676 * Appends a custom item provider to the given anchorview
9678 * Appends the given function to the list of items providers. This list is
9679 * called, one function at a time, with the given @p data pointer, the
9680 * anchorview object and, in the @p item parameter, the item name as
9681 * referenced in its href string. Following functions in the list will be
9682 * called in order until one of them returns something different to NULL,
9683 * which should be an Evas_Object which will be used in place of the item
9686 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9687 * href=item/name\>\</item\>
9689 * @param obj The anchorview object
9690 * @param func The function to add to the list of providers
9691 * @param data User data that will be passed to the callback function
9693 * @see elm_entry_item_provider_append()
9695 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);
9697 * Prepend a custom item provider to the given anchorview
9699 * Like elm_anchorview_item_provider_append(), but it adds the function
9700 * @p func to the beginning of the list, instead of the end.
9702 * @param obj The anchorview object
9703 * @param func The function to add to the list of providers
9704 * @param data User data that will be passed to the callback function
9706 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);
9708 * Remove a custom item provider from the list of the given anchorview
9710 * Removes the function and data pairing that matches @p func and @p data.
9711 * That is, unless the same function and same user data are given, the
9712 * function will not be removed from the list. This allows us to add the
9713 * same callback several times, with different @p data pointers and be
9714 * able to remove them later without conflicts.
9716 * @param obj The anchorview object
9717 * @param func The function to remove from the list
9718 * @param data The data matching the function to remove from the list
9720 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);
9727 * @defgroup Anchorblock Anchorblock
9729 * @image html img/widget/anchorblock/preview-00.png
9730 * @image latex img/widget/anchorblock/preview-00.eps
9732 * Anchorblock is for displaying text that contains markup with anchors
9733 * like <c>\<a href=1234\>something\</\></c> in it.
9735 * Besides being styled differently, the anchorblock widget provides the
9736 * necessary functionality so that clicking on these anchors brings up a
9737 * popup with user defined content such as "call", "add to contacts" or
9738 * "open web page". This popup is provided using the @ref Hover widget.
9740 * This widget emits the following signals:
9741 * @li "anchor,clicked": will be called when an anchor is clicked. The
9742 * @p event_info parameter on the callback will be a pointer of type
9743 * ::Elm_Entry_Anchorblock_Info.
9749 * Since examples are usually better than plain words, we might as well
9750 * try @ref tutorial_anchorblock_example "one".
9753 * @addtogroup Anchorblock
9757 * @typedef Elm_Entry_Anchorblock_Info
9759 * The info sent in the callback for "anchor,clicked" signals emitted by
9760 * the Anchorblock widget.
9762 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9764 * @struct _Elm_Entry_Anchorblock_Info
9766 * The info sent in the callback for "anchor,clicked" signals emitted by
9767 * the Anchorblock widget.
9769 struct _Elm_Entry_Anchorblock_Info
9771 const char *name; /**< Name of the anchor, as indicated in its href
9773 int button; /**< The mouse button used to click on it */
9774 Evas_Object *hover; /**< The hover object to use for the popup */
9776 Evas_Coord x, y, w, h;
9777 } anchor, /**< Geometry selection of text used as anchor */
9778 hover_parent; /**< Geometry of the object used as parent by the
9780 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9781 for content on the left side of
9782 the hover. Before calling the
9783 callback, the widget will make the
9784 necessary calculations to check
9785 which sides are fit to be set with
9786 content, based on the position the
9787 hover is activated and its distance
9788 to the edges of its parent object
9790 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9791 the right side of the hover.
9792 See @ref hover_left */
9793 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9794 of the hover. See @ref hover_left */
9795 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9796 below the hover. See @ref
9800 * Add a new Anchorblock object
9802 * @param parent The parent object
9803 * @return The new object or NULL if it cannot be created
9805 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9807 * Set the text to show in the anchorblock
9809 * Sets the text of the anchorblock to @p text. This text can include markup
9810 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9811 * of text that will be specially styled and react to click events, ended
9812 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9813 * "anchor,clicked" signal that you can attach a callback to with
9814 * evas_object_smart_callback_add(). The name of the anchor given in the
9815 * event info struct will be the one set in the href attribute, in this
9818 * Other markup can be used to style the text in different ways, but it's
9819 * up to the style defined in the theme which tags do what.
9820 * @deprecated use elm_object_text_set() instead.
9822 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9824 * Get the markup text set for the anchorblock
9826 * Retrieves the text set on the anchorblock, with markup tags included.
9828 * @param obj The anchorblock object
9829 * @return The markup text set or @c NULL if nothing was set or an error
9831 * @deprecated use elm_object_text_set() instead.
9833 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9835 * Set the parent of the hover popup
9837 * Sets the parent object to use by the hover created by the anchorblock
9838 * when an anchor is clicked. See @ref Hover for more details on this.
9840 * @param obj The anchorblock object
9841 * @param parent The object to use as parent for the hover
9843 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9845 * Get the parent of the hover popup
9847 * Get the object used as parent for the hover created by the anchorblock
9848 * widget. See @ref Hover for more details on this.
9849 * If no parent is set, the same anchorblock object will be used.
9851 * @param obj The anchorblock object
9852 * @return The object used as parent for the hover, NULL if none is set.
9854 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9856 * Set the style that the hover should use
9858 * When creating the popup hover, anchorblock will request that it's
9859 * themed according to @p style.
9861 * @param obj The anchorblock object
9862 * @param style The style to use for the underlying hover
9864 * @see elm_object_style_set()
9866 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9868 * Get the style that the hover should use
9870 * Get the style the hover created by anchorblock will use.
9872 * @param obj The anchorblock object
9873 * @return The style to use by the hover. NULL means the default is used.
9875 * @see elm_object_style_set()
9877 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9879 * Ends the hover popup in the anchorblock
9881 * When an anchor is clicked, the anchorblock widget will create a hover
9882 * object to use as a popup with user provided content. This function
9883 * terminates this popup, returning the anchorblock to its normal state.
9885 * @param obj The anchorblock object
9887 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9889 * Appends a custom item provider to the given anchorblock
9891 * Appends the given function to the list of items providers. This list is
9892 * called, one function at a time, with the given @p data pointer, the
9893 * anchorblock object and, in the @p item parameter, the item name as
9894 * referenced in its href string. Following functions in the list will be
9895 * called in order until one of them returns something different to NULL,
9896 * which should be an Evas_Object which will be used in place of the item
9899 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9900 * href=item/name\>\</item\>
9902 * @param obj The anchorblock object
9903 * @param func The function to add to the list of providers
9904 * @param data User data that will be passed to the callback function
9906 * @see elm_entry_item_provider_append()
9908 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);
9910 * Prepend a custom item provider to the given anchorblock
9912 * Like elm_anchorblock_item_provider_append(), but it adds the function
9913 * @p func to the beginning of the list, instead of the end.
9915 * @param obj The anchorblock object
9916 * @param func The function to add to the list of providers
9917 * @param data User data that will be passed to the callback function
9919 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);
9921 * Remove a custom item provider from the list of the given anchorblock
9923 * Removes the function and data pairing that matches @p func and @p data.
9924 * That is, unless the same function and same user data are given, the
9925 * function will not be removed from the list. This allows us to add the
9926 * same callback several times, with different @p data pointers and be
9927 * able to remove them later without conflicts.
9929 * @param obj The anchorblock object
9930 * @param func The function to remove from the list
9931 * @param data The data matching the function to remove from the list
9933 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);
9939 * @defgroup Bubble Bubble
9941 * @image html img/widget/bubble/preview-00.png
9942 * @image latex img/widget/bubble/preview-00.eps
9943 * @image html img/widget/bubble/preview-01.png
9944 * @image latex img/widget/bubble/preview-01.eps
9945 * @image html img/widget/bubble/preview-02.png
9946 * @image latex img/widget/bubble/preview-02.eps
9948 * @brief The Bubble is a widget to show text similarly to how speech is
9949 * represented in comics.
9951 * The bubble widget contains 5 important visual elements:
9952 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9953 * @li The @p icon is an image to which the frame's arrow points to.
9954 * @li The @p label is a text which appears to the right of the icon if the
9955 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9957 * @li The @p info is a text which appears to the right of the label. Info's
9958 * font is of a ligther color than label.
9959 * @li The @p content is an evas object that is shown inside the frame.
9961 * The position of the arrow, icon, label and info depends on which corner is
9962 * selected. The four available corners are:
9963 * @li "top_left" - Default
9966 * @li "bottom_right"
9968 * Signals that you can add callbacks for are:
9969 * @li "clicked" - This is called when a user has clicked the bubble.
9971 * For an example of using a buble see @ref bubble_01_example_page "this".
9976 * Add a new bubble to the parent
9978 * @param parent The parent object
9979 * @return The new object or NULL if it cannot be created
9981 * This function adds a text bubble to the given parent evas object.
9983 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9985 * Set the label of the bubble
9987 * @param obj The bubble object
9988 * @param label The string to set in the label
9990 * This function sets the title of the bubble. Where this appears depends on
9991 * the selected corner.
9992 * @deprecated use elm_object_text_set() instead.
9994 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9996 * Get the label of the bubble
9998 * @param obj The bubble object
9999 * @return The string of set in the label
10001 * This function gets the title of the bubble.
10002 * @deprecated use elm_object_text_get() instead.
10004 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10006 * Set the info of the bubble
10008 * @param obj The bubble object
10009 * @param info The given info about the bubble
10011 * This function sets the info of the bubble. Where this appears depends on
10012 * the selected corner.
10013 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
10015 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
10017 * Get the info of the bubble
10019 * @param obj The bubble object
10021 * @return The "info" string of the bubble
10023 * This function gets the info text.
10024 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
10026 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10028 * Set the content to be shown in the bubble
10030 * Once the content object is set, a previously set one will be deleted.
10031 * If you want to keep the old content object, use the
10032 * elm_bubble_content_unset() function.
10034 * @param obj The bubble object
10035 * @param content The given content of the bubble
10037 * This function sets the content shown on the middle of the bubble.
10039 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10041 * Get the content shown in the bubble
10043 * Return the content object which is set for this widget.
10045 * @param obj The bubble object
10046 * @return The content that is being used
10048 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10050 * Unset the content shown in the bubble
10052 * Unparent and return the content object which was set for this widget.
10054 * @param obj The bubble object
10055 * @return The content that was being used
10057 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10059 * Set the icon of the bubble
10061 * Once the icon object is set, a previously set one will be deleted.
10062 * If you want to keep the old content object, use the
10063 * elm_icon_content_unset() function.
10065 * @param obj The bubble object
10066 * @param icon The given icon for the bubble
10068 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10070 * Get the icon of the bubble
10072 * @param obj The bubble object
10073 * @return The icon for the bubble
10075 * This function gets the icon shown on the top left of bubble.
10077 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10079 * Unset the icon of the bubble
10081 * Unparent and return the icon object which was set for this widget.
10083 * @param obj The bubble object
10084 * @return The icon that was being used
10086 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10088 * Set the corner of the bubble
10090 * @param obj The bubble object.
10091 * @param corner The given corner for the bubble.
10093 * This function sets the corner of the bubble. The corner will be used to
10094 * determine where the arrow in the frame points to and where label, icon and
10097 * Possible values for corner are:
10098 * @li "top_left" - Default
10100 * @li "bottom_left"
10101 * @li "bottom_right"
10103 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
10105 * Get the corner of the bubble
10107 * @param obj The bubble object.
10108 * @return The given corner for the bubble.
10110 * This function gets the selected corner of the bubble.
10112 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10118 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10119 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
10120 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
10121 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
10122 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
10123 /* smart callbacks called:
10124 * "clicked" - the user clicked the icon
10125 * "drag,start" - Someone started dragging the image out of the object
10126 * "drag,end" - Dragged item was dropped (somewhere)
10129 /* gesture layer */
10131 * @defgroup Elm_Gesture_Layer Gesture Layer
10132 * Gesture Layer Usage:
10134 * Use Gesture Layer to detect gestures.
10135 * The advantage is that you don't have to implement
10136 * gesture detection, just set callbacks of gesture state.
10137 * By using gesture layer we make standard interface.
10139 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
10140 * with a parent object parameter.
10141 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
10142 * call. Usually with same object as target (2nd parameter).
10144 * Now you need to tell gesture layer what gestures you follow.
10145 * This is done with @ref elm_gesture_layer_cb_set call.
10146 * By setting the callback you actually saying to gesture layer:
10147 * I would like to know when the gesture @ref Elm_Gesture_Types
10148 * switches to state @ref Elm_Gesture_State.
10150 * Next, you need to implement the actual action that follows the input
10151 * in your callback.
10153 * Note that if you like to stop being reported about a gesture, just set
10154 * all callbacks referring this gesture to NULL.
10155 * (again with @ref elm_gesture_layer_cb_set)
10157 * The information reported by gesture layer to your callback is depending
10158 * on @ref Elm_Gesture_Types:
10159 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
10160 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
10161 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
10163 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
10164 * @ref ELM_GESTURE_MOMENTUM.
10166 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
10167 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
10168 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
10169 * Note that we consider a flick as a line-gesture that should be completed
10170 * in flick-time-limit as defined in @ref Config.
10172 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
10174 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
10178 * @enum _Elm_Gesture_Types
10179 * Enum of supported gesture types.
10180 * @ingroup Elm_Gesture_Layer
10182 enum _Elm_Gesture_Types
10184 ELM_GESTURE_FIRST = 0,
10186 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
10187 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
10188 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
10189 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
10191 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
10193 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
10194 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
10196 ELM_GESTURE_ZOOM, /**< Zoom */
10197 ELM_GESTURE_ROTATE, /**< Rotate */
10203 * @typedef Elm_Gesture_Types
10204 * gesture types enum
10205 * @ingroup Elm_Gesture_Layer
10207 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
10210 * @enum _Elm_Gesture_State
10211 * Enum of gesture states.
10212 * @ingroup Elm_Gesture_Layer
10214 enum _Elm_Gesture_State
10216 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
10217 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
10218 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
10219 ELM_GESTURE_STATE_END, /**< Gesture completed */
10220 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
10224 * @typedef Elm_Gesture_State
10225 * gesture states enum
10226 * @ingroup Elm_Gesture_Layer
10228 typedef enum _Elm_Gesture_State Elm_Gesture_State;
10231 * @struct _Elm_Gesture_Taps_Info
10232 * Struct holds taps info for user
10233 * @ingroup Elm_Gesture_Layer
10235 struct _Elm_Gesture_Taps_Info
10237 Evas_Coord x, y; /**< Holds center point between fingers */
10238 unsigned int n; /**< Number of fingers tapped */
10239 unsigned int timestamp; /**< event timestamp */
10243 * @typedef Elm_Gesture_Taps_Info
10244 * holds taps info for user
10245 * @ingroup Elm_Gesture_Layer
10247 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10250 * @struct _Elm_Gesture_Momentum_Info
10251 * Struct holds momentum info for user
10252 * x1 and y1 are not necessarily in sync
10253 * x1 holds x value of x direction starting point
10254 * and same holds for y1.
10255 * This is noticeable when doing V-shape movement
10256 * @ingroup Elm_Gesture_Layer
10258 struct _Elm_Gesture_Momentum_Info
10259 { /* Report line ends, timestamps, and momentum computed */
10260 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10261 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10262 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10263 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10265 unsigned int tx; /**< Timestamp of start of final x-swipe */
10266 unsigned int ty; /**< Timestamp of start of final y-swipe */
10268 Evas_Coord mx; /**< Momentum on X */
10269 Evas_Coord my; /**< Momentum on Y */
10273 * @typedef Elm_Gesture_Momentum_Info
10274 * holds momentum info for user
10275 * @ingroup Elm_Gesture_Layer
10277 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10280 * @struct _Elm_Gesture_Line_Info
10281 * Struct holds line info for user
10282 * @ingroup Elm_Gesture_Layer
10284 struct _Elm_Gesture_Line_Info
10285 { /* Report line ends, timestamps, and momentum computed */
10286 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10287 unsigned int n; /**< Number of fingers (lines) */
10288 /* FIXME should be radians, bot degrees */
10289 double angle; /**< Angle (direction) of lines */
10293 * @typedef Elm_Gesture_Line_Info
10294 * Holds line info for user
10295 * @ingroup Elm_Gesture_Layer
10297 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10300 * @struct _Elm_Gesture_Zoom_Info
10301 * Struct holds zoom info for user
10302 * @ingroup Elm_Gesture_Layer
10304 struct _Elm_Gesture_Zoom_Info
10306 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10307 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10308 double zoom; /**< Zoom value: 1.0 means no zoom */
10309 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10313 * @typedef Elm_Gesture_Zoom_Info
10314 * Holds zoom info for user
10315 * @ingroup Elm_Gesture_Layer
10317 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10320 * @struct _Elm_Gesture_Rotate_Info
10321 * Struct holds rotation info for user
10322 * @ingroup Elm_Gesture_Layer
10324 struct _Elm_Gesture_Rotate_Info
10326 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10327 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10328 double base_angle; /**< Holds start-angle */
10329 double angle; /**< Rotation value: 0.0 means no rotation */
10330 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10334 * @typedef Elm_Gesture_Rotate_Info
10335 * Holds rotation info for user
10336 * @ingroup Elm_Gesture_Layer
10338 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10341 * @typedef Elm_Gesture_Event_Cb
10342 * User callback used to stream gesture info from gesture layer
10343 * @param data user data
10344 * @param event_info gesture report info
10345 * Returns a flag field to be applied on the causing event.
10346 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10347 * upon the event, in an irreversible way.
10349 * @ingroup Elm_Gesture_Layer
10351 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10354 * Use function to set callbacks to be notified about
10355 * change of state of gesture.
10356 * When a user registers a callback with this function
10357 * this means this gesture has to be tested.
10359 * When ALL callbacks for a gesture are set to NULL
10360 * it means user isn't interested in gesture-state
10361 * and it will not be tested.
10363 * @param obj Pointer to gesture-layer.
10364 * @param idx The gesture you would like to track its state.
10365 * @param cb callback function pointer.
10366 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10367 * @param data user info to be sent to callback (usually, Smart Data)
10369 * @ingroup Elm_Gesture_Layer
10371 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);
10374 * Call this function to get repeat-events settings.
10376 * @param obj Pointer to gesture-layer.
10378 * @return repeat events settings.
10379 * @see elm_gesture_layer_hold_events_set()
10380 * @ingroup Elm_Gesture_Layer
10382 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10385 * This function called in order to make gesture-layer repeat events.
10386 * Set this of you like to get the raw events only if gestures were not detected.
10387 * Clear this if you like gesture layer to fwd events as testing gestures.
10389 * @param obj Pointer to gesture-layer.
10390 * @param r Repeat: TRUE/FALSE
10392 * @ingroup Elm_Gesture_Layer
10394 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10397 * This function sets step-value for zoom action.
10398 * Set step to any positive value.
10399 * Cancel step setting by setting to 0.0
10401 * @param obj Pointer to gesture-layer.
10402 * @param s new zoom step value.
10404 * @ingroup Elm_Gesture_Layer
10406 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10409 * This function sets step-value for rotate action.
10410 * Set step to any positive value.
10411 * Cancel step setting by setting to 0.0
10413 * @param obj Pointer to gesture-layer.
10414 * @param s new roatate step value.
10416 * @ingroup Elm_Gesture_Layer
10418 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10421 * This function called to attach gesture-layer to an Evas_Object.
10422 * @param obj Pointer to gesture-layer.
10423 * @param t Pointer to underlying object (AKA Target)
10425 * @return TRUE, FALSE on success, failure.
10427 * @ingroup Elm_Gesture_Layer
10429 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10432 * Call this function to construct a new gesture-layer object.
10433 * This does not activate the gesture layer. You have to
10434 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10436 * @param parent the parent object.
10438 * @return Pointer to new gesture-layer object.
10440 * @ingroup Elm_Gesture_Layer
10442 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10445 * @defgroup Thumb Thumb
10447 * @image html img/widget/thumb/preview-00.png
10448 * @image latex img/widget/thumb/preview-00.eps
10450 * A thumb object is used for displaying the thumbnail of an image or video.
10451 * You must have compiled Elementary with Ethumb_Client support and the DBus
10452 * service must be present and auto-activated in order to have thumbnails to
10455 * Once the thumbnail object becomes visible, it will check if there is a
10456 * previously generated thumbnail image for the file set on it. If not, it
10457 * will start generating this thumbnail.
10459 * Different config settings will cause different thumbnails to be generated
10460 * even on the same file.
10462 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10463 * Ethumb documentation to change this path, and to see other configuration
10466 * Signals that you can add callbacks for are:
10468 * - "clicked" - This is called when a user has clicked the thumb without dragging
10470 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10471 * - "press" - This is called when a user has pressed down the thumb.
10472 * - "generate,start" - The thumbnail generation started.
10473 * - "generate,stop" - The generation process stopped.
10474 * - "generate,error" - The generation failed.
10475 * - "load,error" - The thumbnail image loading failed.
10477 * available styles:
10481 * An example of use of thumbnail:
10483 * - @ref thumb_example_01
10487 * @addtogroup Thumb
10492 * @enum _Elm_Thumb_Animation_Setting
10493 * @typedef Elm_Thumb_Animation_Setting
10495 * Used to set if a video thumbnail is animating or not.
10499 typedef enum _Elm_Thumb_Animation_Setting
10501 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10502 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10503 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10504 ELM_THUMB_ANIMATION_LAST
10505 } Elm_Thumb_Animation_Setting;
10508 * Add a new thumb object to the parent.
10510 * @param parent The parent object.
10511 * @return The new object or NULL if it cannot be created.
10513 * @see elm_thumb_file_set()
10514 * @see elm_thumb_ethumb_client_get()
10518 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10520 * Reload thumbnail if it was generated before.
10522 * @param obj The thumb object to reload
10524 * This is useful if the ethumb client configuration changed, like its
10525 * size, aspect or any other property one set in the handle returned
10526 * by elm_thumb_ethumb_client_get().
10528 * If the options didn't change, the thumbnail won't be generated again, but
10529 * the old one will still be used.
10531 * @see elm_thumb_file_set()
10535 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10537 * Set the file that will be used as thumbnail.
10539 * @param obj The thumb object.
10540 * @param file The path to file that will be used as thumb.
10541 * @param key The key used in case of an EET file.
10543 * The file can be an image or a video (in that case, acceptable extensions are:
10544 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10545 * function elm_thumb_animate().
10547 * @see elm_thumb_file_get()
10548 * @see elm_thumb_reload()
10549 * @see elm_thumb_animate()
10553 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10555 * Get the image or video path and key used to generate the thumbnail.
10557 * @param obj The thumb object.
10558 * @param file Pointer to filename.
10559 * @param key Pointer to key.
10561 * @see elm_thumb_file_set()
10562 * @see elm_thumb_path_get()
10566 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10568 * Get the path and key to the image or video generated by ethumb.
10570 * One just need to make sure that the thumbnail was generated before getting
10571 * its path; otherwise, the path will be NULL. One way to do that is by asking
10572 * for the path when/after the "generate,stop" smart callback is called.
10574 * @param obj The thumb object.
10575 * @param file Pointer to thumb path.
10576 * @param key Pointer to thumb key.
10578 * @see elm_thumb_file_get()
10582 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10584 * Set the animation state for the thumb object. If its content is an animated
10585 * video, you may start/stop the animation or tell it to play continuously and
10588 * @param obj The thumb object.
10589 * @param setting The animation setting.
10591 * @see elm_thumb_file_set()
10595 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10597 * Get the animation state for the thumb object.
10599 * @param obj The thumb object.
10600 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10603 * @see elm_thumb_animate_set()
10607 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10609 * Get the ethumb_client handle so custom configuration can be made.
10611 * @return Ethumb_Client instance or NULL.
10613 * This must be called before the objects are created to be sure no object is
10614 * visible and no generation started.
10616 * Example of usage:
10619 * #include <Elementary.h>
10620 * #ifndef ELM_LIB_QUICKLAUNCH
10622 * elm_main(int argc, char **argv)
10624 * Ethumb_Client *client;
10626 * elm_need_ethumb();
10630 * client = elm_thumb_ethumb_client_get();
10633 * ERR("could not get ethumb_client");
10636 * ethumb_client_size_set(client, 100, 100);
10637 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10640 * // Create elm_thumb objects here
10650 * @note There's only one client handle for Ethumb, so once a configuration
10651 * change is done to it, any other request for thumbnails (for any thumbnail
10652 * object) will use that configuration. Thus, this configuration is global.
10656 EAPI void *elm_thumb_ethumb_client_get(void);
10658 * Get the ethumb_client connection state.
10660 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10663 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10665 * Make the thumbnail 'editable'.
10667 * @param obj Thumb object.
10668 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10670 * This means the thumbnail is a valid drag target for drag and drop, and can be
10671 * cut or pasted too.
10673 * @see elm_thumb_editable_get()
10677 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10679 * Make the thumbnail 'editable'.
10681 * @param obj Thumb object.
10682 * @return Editability.
10684 * This means the thumbnail is a valid drag target for drag and drop, and can be
10685 * cut or pasted too.
10687 * @see elm_thumb_editable_set()
10691 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10698 * @defgroup Hoversel Hoversel
10700 * @image html img/widget/hoversel/preview-00.png
10701 * @image latex img/widget/hoversel/preview-00.eps
10703 * A hoversel is a button that pops up a list of items (automatically
10704 * choosing the direction to display) that have a label and, optionally, an
10705 * icon to select from. It is a convenience widget to avoid the need to do
10706 * all the piecing together yourself. It is intended for a small number of
10707 * items in the hoversel menu (no more than 8), though is capable of many
10710 * Signals that you can add callbacks for are:
10711 * "clicked" - the user clicked the hoversel button and popped up the sel
10712 * "selected" - an item in the hoversel list is selected. event_info is the item
10713 * "dismissed" - the hover is dismissed
10715 * See @ref tutorial_hoversel for an example.
10718 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10720 * @brief Add a new Hoversel object
10722 * @param parent The parent object
10723 * @return The new object or NULL if it cannot be created
10725 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10727 * @brief This sets the hoversel to expand horizontally.
10729 * @param obj The hoversel object
10730 * @param horizontal If true, the hover will expand horizontally to the
10733 * @note The initial button will display horizontally regardless of this
10736 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10738 * @brief This returns whether the hoversel is set to expand horizontally.
10740 * @param obj The hoversel object
10741 * @return If true, the hover will expand horizontally to the right.
10743 * @see elm_hoversel_horizontal_set()
10745 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10747 * @brief Set the Hover parent
10749 * @param obj The hoversel object
10750 * @param parent The parent to use
10752 * Sets the hover parent object, the area that will be darkened when the
10753 * hoversel is clicked. Should probably be the window that the hoversel is
10754 * in. See @ref Hover objects for more information.
10756 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10758 * @brief Get the Hover parent
10760 * @param obj The hoversel object
10761 * @return The used parent
10763 * Gets the hover parent object.
10765 * @see elm_hoversel_hover_parent_set()
10767 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10769 * @brief Set the hoversel button label
10771 * @param obj The hoversel object
10772 * @param label The label text.
10774 * This sets the label of the button that is always visible (before it is
10775 * clicked and expanded).
10777 * @deprecated elm_object_text_set()
10779 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10781 * @brief Get the hoversel button label
10783 * @param obj The hoversel object
10784 * @return The label text.
10786 * @deprecated elm_object_text_get()
10788 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10790 * @brief Set the icon of the hoversel button
10792 * @param obj The hoversel object
10793 * @param icon The icon object
10795 * Sets the icon of the button that is always visible (before it is clicked
10796 * and expanded). Once the icon object is set, a previously set one will be
10797 * deleted, if you want to keep that old content object, use the
10798 * elm_hoversel_icon_unset() function.
10800 * @see elm_button_icon_set()
10802 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10804 * @brief Get the icon of the hoversel button
10806 * @param obj The hoversel object
10807 * @return The icon object
10809 * Get the icon of the button that is always visible (before it is clicked
10810 * and expanded). Also see elm_button_icon_get().
10812 * @see elm_hoversel_icon_set()
10814 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10816 * @brief Get and unparent the icon of the hoversel button
10818 * @param obj The hoversel object
10819 * @return The icon object that was being used
10821 * Unparent and return the icon of the button that is always visible
10822 * (before it is clicked and expanded).
10824 * @see elm_hoversel_icon_set()
10825 * @see elm_button_icon_unset()
10827 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10829 * @brief This triggers the hoversel popup from code, the same as if the user
10830 * had clicked the button.
10832 * @param obj The hoversel object
10834 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10836 * @brief This dismisses the hoversel popup as if the user had clicked
10837 * outside the hover.
10839 * @param obj The hoversel object
10841 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10843 * @brief Returns whether the hoversel is expanded.
10845 * @param obj The hoversel object
10846 * @return This will return EINA_TRUE if the hoversel is expanded or
10847 * EINA_FALSE if it is not expanded.
10849 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10851 * @brief This will remove all the children items from the hoversel.
10853 * @param obj The hoversel object
10855 * @warning Should @b not be called while the hoversel is active; use
10856 * elm_hoversel_expanded_get() to check first.
10858 * @see elm_hoversel_item_del_cb_set()
10859 * @see elm_hoversel_item_del()
10861 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10863 * @brief Get the list of items within the given hoversel.
10865 * @param obj The hoversel object
10866 * @return Returns a list of Elm_Hoversel_Item*
10868 * @see elm_hoversel_item_add()
10870 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10872 * @brief Add an item to the hoversel button
10874 * @param obj The hoversel object
10875 * @param label The text label to use for the item (NULL if not desired)
10876 * @param icon_file An image file path on disk to use for the icon or standard
10877 * icon name (NULL if not desired)
10878 * @param icon_type The icon type if relevant
10879 * @param func Convenience function to call when this item is selected
10880 * @param data Data to pass to item-related functions
10881 * @return A handle to the item added.
10883 * This adds an item to the hoversel to show when it is clicked. Note: if you
10884 * need to use an icon from an edje file then use
10885 * elm_hoversel_item_icon_set() right after the this function, and set
10886 * icon_file to NULL here.
10888 * For more information on what @p icon_file and @p icon_type are see the
10889 * @ref Icon "icon documentation".
10891 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);
10893 * @brief Delete an item from the hoversel
10895 * @param item The item to delete
10897 * This deletes the item from the hoversel (should not be called while the
10898 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10900 * @see elm_hoversel_item_add()
10901 * @see elm_hoversel_item_del_cb_set()
10903 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10905 * @brief Set the function to be called when an item from the hoversel is
10908 * @param item The item to set the callback on
10909 * @param func The function called
10911 * That function will receive these parameters:
10912 * @li void *item_data
10913 * @li Evas_Object *the_item_object
10914 * @li Elm_Hoversel_Item *the_object_struct
10916 * @see elm_hoversel_item_add()
10918 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10920 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10921 * that will be passed to associated function callbacks.
10923 * @param item The item to get the data from
10924 * @return The data pointer set with elm_hoversel_item_add()
10926 * @see elm_hoversel_item_add()
10928 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10930 * @brief This returns the label text of the given hoversel item.
10932 * @param item The item to get the label
10933 * @return The label text of the hoversel item
10935 * @see elm_hoversel_item_add()
10937 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10939 * @brief This sets the icon for the given hoversel item.
10941 * @param item The item to set the icon
10942 * @param icon_file An image file path on disk to use for the icon or standard
10944 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10945 * to NULL if the icon is not an edje file
10946 * @param icon_type The icon type
10948 * The icon can be loaded from the standard set, from an image file, or from
10951 * @see elm_hoversel_item_add()
10953 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);
10955 * @brief Get the icon object of the hoversel item
10957 * @param item The item to get the icon from
10958 * @param icon_file The image file path on disk used for the icon or standard
10960 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10961 * if the icon is not an edje file
10962 * @param icon_type The icon type
10964 * @see elm_hoversel_item_icon_set()
10965 * @see elm_hoversel_item_add()
10967 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);
10973 * @defgroup Toolbar Toolbar
10974 * @ingroup Elementary
10976 * @image html img/widget/toolbar/preview-00.png
10977 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10979 * @image html img/toolbar.png
10980 * @image latex img/toolbar.eps width=\textwidth
10982 * A toolbar is a widget that displays a list of items inside
10983 * a box. It can be scrollable, show a menu with items that don't fit
10984 * to toolbar size or even crop them.
10986 * Only one item can be selected at a time.
10988 * Items can have multiple states, or show menus when selected by the user.
10990 * Smart callbacks one can listen to:
10991 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10993 * Available styles for it:
10995 * - @c "transparent" - no background or shadow, just show the content
10997 * List of examples:
10998 * @li @ref toolbar_example_01
10999 * @li @ref toolbar_example_02
11000 * @li @ref toolbar_example_03
11004 * @addtogroup Toolbar
11009 * @enum _Elm_Toolbar_Shrink_Mode
11010 * @typedef Elm_Toolbar_Shrink_Mode
11012 * Set toolbar's items display behavior, it can be scrollabel,
11013 * show a menu with exceeding items, or simply hide them.
11015 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
11018 * Values <b> don't </b> work as bitmask, only one can be choosen.
11020 * @see elm_toolbar_mode_shrink_set()
11021 * @see elm_toolbar_mode_shrink_get()
11025 typedef enum _Elm_Toolbar_Shrink_Mode
11027 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
11028 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
11029 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
11030 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
11031 } Elm_Toolbar_Shrink_Mode;
11033 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(). */
11035 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(). */
11038 * Add a new toolbar widget to the given parent Elementary
11039 * (container) object.
11041 * @param parent The parent object.
11042 * @return a new toolbar widget handle or @c NULL, on errors.
11044 * This function inserts a new toolbar widget on the canvas.
11048 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11051 * Set the icon size, in pixels, to be used by toolbar items.
11053 * @param obj The toolbar object
11054 * @param icon_size The icon size in pixels
11056 * @note Default value is @c 32. It reads value from elm config.
11058 * @see elm_toolbar_icon_size_get()
11062 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
11065 * Get the icon size, in pixels, to be used by toolbar items.
11067 * @param obj The toolbar object.
11068 * @return The icon size in pixels.
11070 * @see elm_toolbar_icon_size_set() for details.
11074 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11077 * Sets icon lookup order, for toolbar items' icons.
11079 * @param obj The toolbar object.
11080 * @param order The icon lookup order.
11082 * Icons added before calling this function will not be affected.
11083 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
11085 * @see elm_toolbar_icon_order_lookup_get()
11089 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
11092 * Gets the icon lookup order.
11094 * @param obj The toolbar object.
11095 * @return The icon lookup order.
11097 * @see elm_toolbar_icon_order_lookup_set() for details.
11101 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11104 * Set whether the toolbar items' should be selected by the user or not.
11106 * @param obj The toolbar object.
11107 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
11110 * This will turn off the ability to select items entirely and they will
11111 * neither appear selected nor emit selected signals. The clicked
11112 * callback function will still be called.
11114 * Selection is enabled by default.
11116 * @see elm_toolbar_no_select_mode_get().
11120 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
11123 * Set whether the toolbar items' should be selected by the user or not.
11125 * @param obj The toolbar object.
11126 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
11127 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
11129 * @see elm_toolbar_no_select_mode_set() for details.
11133 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11136 * Append item to the toolbar.
11138 * @param obj The toolbar object.
11139 * @param icon A string with icon name or the absolute path of an image file.
11140 * @param label The label of the item.
11141 * @param func The function to call when the item is clicked.
11142 * @param data The data to associate with the item for related callbacks.
11143 * @return The created item or @c NULL upon failure.
11145 * A new item will be created and appended to the toolbar, i.e., will
11146 * be set as @b last item.
11148 * Items created with this method can be deleted with
11149 * elm_toolbar_item_del().
11151 * Associated @p data can be properly freed when item is deleted if a
11152 * callback function is set with elm_toolbar_item_del_cb_set().
11154 * If a function is passed as argument, it will be called everytime this item
11155 * is selected, i.e., the user clicks over an unselected item.
11156 * If such function isn't needed, just passing
11157 * @c NULL as @p func is enough. The same should be done for @p data.
11159 * Toolbar will load icon image from fdo or current theme.
11160 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11161 * If an absolute path is provided it will load it direct from a file.
11163 * @see elm_toolbar_item_icon_set()
11164 * @see elm_toolbar_item_del()
11165 * @see elm_toolbar_item_del_cb_set()
11169 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);
11172 * Prepend item to the toolbar.
11174 * @param obj The toolbar object.
11175 * @param icon A string with icon name or the absolute path of an image file.
11176 * @param label The label of the item.
11177 * @param func The function to call when the item is clicked.
11178 * @param data The data to associate with the item for related callbacks.
11179 * @return The created item or @c NULL upon failure.
11181 * A new item will be created and prepended to the toolbar, i.e., will
11182 * be set as @b first item.
11184 * Items created with this method can be deleted with
11185 * elm_toolbar_item_del().
11187 * Associated @p data can be properly freed when item is deleted if a
11188 * callback function is set with elm_toolbar_item_del_cb_set().
11190 * If a function is passed as argument, it will be called everytime this item
11191 * is selected, i.e., the user clicks over an unselected item.
11192 * If such function isn't needed, just passing
11193 * @c NULL as @p func is enough. The same should be done for @p data.
11195 * Toolbar will load icon image from fdo or current theme.
11196 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11197 * If an absolute path is provided it will load it direct from a file.
11199 * @see elm_toolbar_item_icon_set()
11200 * @see elm_toolbar_item_del()
11201 * @see elm_toolbar_item_del_cb_set()
11205 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);
11208 * Insert a new item into the toolbar object before item @p before.
11210 * @param obj The toolbar object.
11211 * @param before The toolbar item to insert before.
11212 * @param icon A string with icon name or the absolute path of an image file.
11213 * @param label The label of the item.
11214 * @param func The function to call when the item is clicked.
11215 * @param data The data to associate with the item for related callbacks.
11216 * @return The created item or @c NULL upon failure.
11218 * A new item will be created and added to the toolbar. Its position in
11219 * this toolbar will be just before item @p before.
11221 * Items created with this method can be deleted with
11222 * elm_toolbar_item_del().
11224 * Associated @p data can be properly freed when item is deleted if a
11225 * callback function is set with elm_toolbar_item_del_cb_set().
11227 * If a function is passed as argument, it will be called everytime this item
11228 * is selected, i.e., the user clicks over an unselected item.
11229 * If such function isn't needed, just passing
11230 * @c NULL as @p func is enough. The same should be done for @p data.
11232 * Toolbar will load icon image from fdo or current theme.
11233 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11234 * If an absolute path is provided it will load it direct from a file.
11236 * @see elm_toolbar_item_icon_set()
11237 * @see elm_toolbar_item_del()
11238 * @see elm_toolbar_item_del_cb_set()
11242 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);
11245 * Insert a new item into the toolbar object after item @p after.
11247 * @param obj The toolbar object.
11248 * @param before The toolbar item to insert before.
11249 * @param icon A string with icon name or the absolute path of an image file.
11250 * @param label The label of the item.
11251 * @param func The function to call when the item is clicked.
11252 * @param data The data to associate with the item for related callbacks.
11253 * @return The created item or @c NULL upon failure.
11255 * A new item will be created and added to the toolbar. Its position in
11256 * this toolbar will be just after item @p after.
11258 * Items created with this method can be deleted with
11259 * elm_toolbar_item_del().
11261 * Associated @p data can be properly freed when item is deleted if a
11262 * callback function is set with elm_toolbar_item_del_cb_set().
11264 * If a function is passed as argument, it will be called everytime this item
11265 * is selected, i.e., the user clicks over an unselected item.
11266 * If such function isn't needed, just passing
11267 * @c NULL as @p func is enough. The same should be done for @p data.
11269 * Toolbar will load icon image from fdo or current theme.
11270 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11271 * If an absolute path is provided it will load it direct from a file.
11273 * @see elm_toolbar_item_icon_set()
11274 * @see elm_toolbar_item_del()
11275 * @see elm_toolbar_item_del_cb_set()
11279 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);
11282 * Get the first item in the given toolbar widget's list of
11285 * @param obj The toolbar object
11286 * @return The first item or @c NULL, if it has no items (and on
11289 * @see elm_toolbar_item_append()
11290 * @see elm_toolbar_last_item_get()
11294 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11297 * Get the last item in the given toolbar widget's list of
11300 * @param obj The toolbar object
11301 * @return The last item or @c NULL, if it has no items (and on
11304 * @see elm_toolbar_item_prepend()
11305 * @see elm_toolbar_first_item_get()
11309 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11312 * Get the item after @p item in toolbar.
11314 * @param item The toolbar item.
11315 * @return The item after @p item, or @c NULL if none or on failure.
11317 * @note If it is the last item, @c NULL will be returned.
11319 * @see elm_toolbar_item_append()
11323 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11326 * Get the item before @p item in toolbar.
11328 * @param item The toolbar item.
11329 * @return The item before @p item, or @c NULL if none or on failure.
11331 * @note If it is the first item, @c NULL will be returned.
11333 * @see elm_toolbar_item_prepend()
11337 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11340 * Get the toolbar object from an item.
11342 * @param item The item.
11343 * @return The toolbar object.
11345 * This returns the toolbar object itself that an item belongs to.
11349 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11352 * Set the priority of a toolbar item.
11354 * @param item The toolbar item.
11355 * @param priority The item priority. The default is zero.
11357 * This is used only when the toolbar shrink mode is set to
11358 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11359 * When space is less than required, items with low priority
11360 * will be removed from the toolbar and added to a dynamically-created menu,
11361 * while items with higher priority will remain on the toolbar,
11362 * with the same order they were added.
11364 * @see elm_toolbar_item_priority_get()
11368 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11371 * Get the priority of a toolbar item.
11373 * @param item The toolbar item.
11374 * @return The @p item priority, or @c 0 on failure.
11376 * @see elm_toolbar_item_priority_set() for details.
11380 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11383 * Get the label of item.
11385 * @param item The item of toolbar.
11386 * @return The label of item.
11388 * The return value is a pointer to the label associated to @p item when
11389 * it was created, with function elm_toolbar_item_append() or similar,
11391 * with function elm_toolbar_item_label_set. If no label
11392 * was passed as argument, it will return @c NULL.
11394 * @see elm_toolbar_item_label_set() for more details.
11395 * @see elm_toolbar_item_append()
11399 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11402 * Set the label of item.
11404 * @param item The item of toolbar.
11405 * @param text The label of item.
11407 * The label to be displayed by the item.
11408 * Label will be placed at icons bottom (if set).
11410 * If a label was passed as argument on item creation, with function
11411 * elm_toolbar_item_append() or similar, it will be already
11412 * displayed by the item.
11414 * @see elm_toolbar_item_label_get()
11415 * @see elm_toolbar_item_append()
11419 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11422 * Return the data associated with a given toolbar widget item.
11424 * @param item The toolbar widget item handle.
11425 * @return The data associated with @p item.
11427 * @see elm_toolbar_item_data_set()
11431 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11434 * Set the data associated with a given toolbar widget item.
11436 * @param item The toolbar widget item handle.
11437 * @param data The new data pointer to set to @p item.
11439 * This sets new item data on @p item.
11441 * @warning The old data pointer won't be touched by this function, so
11442 * the user had better to free that old data himself/herself.
11446 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11449 * Returns a pointer to a toolbar item by its label.
11451 * @param obj The toolbar object.
11452 * @param label The label of the item to find.
11454 * @return The pointer to the toolbar item matching @p label or @c NULL
11459 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11462 * Get whether the @p item is selected or not.
11464 * @param item The toolbar item.
11465 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11466 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11468 * @see elm_toolbar_selected_item_set() for details.
11469 * @see elm_toolbar_item_selected_get()
11473 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11476 * Set the selected state of an item.
11478 * @param item The toolbar item
11479 * @param selected The selected state
11481 * This sets the selected state of the given item @p it.
11482 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11484 * If a new item is selected the previosly selected will be unselected.
11485 * Previoulsy selected item can be get with function
11486 * elm_toolbar_selected_item_get().
11488 * Selected items will be highlighted.
11490 * @see elm_toolbar_item_selected_get()
11491 * @see elm_toolbar_selected_item_get()
11495 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11498 * Get the selected item.
11500 * @param obj The toolbar object.
11501 * @return The selected toolbar item.
11503 * The selected item can be unselected with function
11504 * elm_toolbar_item_selected_set().
11506 * The selected item always will be highlighted on toolbar.
11508 * @see elm_toolbar_selected_items_get()
11512 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11515 * Set the icon associated with @p item.
11517 * @param obj The parent of this item.
11518 * @param item The toolbar item.
11519 * @param icon A string with icon name or the absolute path of an image file.
11521 * Toolbar will load icon image from fdo or current theme.
11522 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11523 * If an absolute path is provided it will load it direct from a file.
11525 * @see elm_toolbar_icon_order_lookup_set()
11526 * @see elm_toolbar_icon_order_lookup_get()
11530 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11533 * Get the string used to set the icon of @p item.
11535 * @param item The toolbar item.
11536 * @return The string associated with the icon object.
11538 * @see elm_toolbar_item_icon_set() for details.
11542 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11545 * Delete them item from the toolbar.
11547 * @param item The item of toolbar to be deleted.
11549 * @see elm_toolbar_item_append()
11550 * @see elm_toolbar_item_del_cb_set()
11554 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11557 * Set the function called when a toolbar item is freed.
11559 * @param item The item to set the callback on.
11560 * @param func The function called.
11562 * If there is a @p func, then it will be called prior item's memory release.
11563 * That will be called with the following arguments:
11565 * @li item's Evas object;
11568 * This way, a data associated to a toolbar item could be properly freed.
11572 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11575 * Get a value whether toolbar item is disabled or not.
11577 * @param item The item.
11578 * @return The disabled state.
11580 * @see elm_toolbar_item_disabled_set() for more details.
11584 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11587 * Sets the disabled/enabled state of a toolbar item.
11589 * @param item The item.
11590 * @param disabled The disabled state.
11592 * A disabled item cannot be selected or unselected. It will also
11593 * change its appearance (generally greyed out). This sets the
11594 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11599 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11602 * Set or unset item as a separator.
11604 * @param item The toolbar item.
11605 * @param setting @c EINA_TRUE to set item @p item as separator or
11606 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11608 * Items aren't set as separator by default.
11610 * If set as separator it will display separator theme, so won't display
11613 * @see elm_toolbar_item_separator_get()
11617 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11620 * Get a value whether item is a separator or not.
11622 * @param item The toolbar item.
11623 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11624 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11626 * @see elm_toolbar_item_separator_set() for details.
11630 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11633 * Set the shrink state of toolbar @p obj.
11635 * @param obj The toolbar object.
11636 * @param shrink_mode Toolbar's items display behavior.
11638 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11639 * but will enforce a minimun size so all the items will fit, won't scroll
11640 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11641 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11642 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11646 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11649 * Get the shrink mode of toolbar @p obj.
11651 * @param obj The toolbar object.
11652 * @return Toolbar's items display behavior.
11654 * @see elm_toolbar_mode_shrink_set() for details.
11658 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11661 * Enable/disable homogenous mode.
11663 * @param obj The toolbar object
11664 * @param homogeneous Assume the items within the toolbar are of the
11665 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11667 * This will enable the homogeneous mode where items are of the same size.
11668 * @see elm_toolbar_homogeneous_get()
11672 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11675 * Get whether the homogenous mode is enabled.
11677 * @param obj The toolbar object.
11678 * @return Assume the items within the toolbar are of the same height
11679 * and width (EINA_TRUE = on, EINA_FALSE = off).
11681 * @see elm_toolbar_homogeneous_set()
11685 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11688 * Enable/disable homogenous mode.
11690 * @param obj The toolbar object
11691 * @param homogeneous Assume the items within the toolbar are of the
11692 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11694 * This will enable the homogeneous mode where items are of the same size.
11695 * @see elm_toolbar_homogeneous_get()
11697 * @deprecated use elm_toolbar_homogeneous_set() instead.
11701 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11704 * Get whether the homogenous mode is enabled.
11706 * @param obj The toolbar object.
11707 * @return Assume the items within the toolbar are of the same height
11708 * and width (EINA_TRUE = on, EINA_FALSE = off).
11710 * @see elm_toolbar_homogeneous_set()
11711 * @deprecated use elm_toolbar_homogeneous_get() instead.
11715 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11718 * Set the parent object of the toolbar items' menus.
11720 * @param obj The toolbar object.
11721 * @param parent The parent of the menu objects.
11723 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11725 * For more details about setting the parent for toolbar menus, see
11726 * elm_menu_parent_set().
11728 * @see elm_menu_parent_set() for details.
11729 * @see elm_toolbar_item_menu_set() for details.
11733 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11736 * Get the parent object of the toolbar items' menus.
11738 * @param obj The toolbar object.
11739 * @return The parent of the menu objects.
11741 * @see elm_toolbar_menu_parent_set() for details.
11745 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11748 * Set the alignment of the items.
11750 * @param obj The toolbar object.
11751 * @param align The new alignment, a float between <tt> 0.0 </tt>
11752 * and <tt> 1.0 </tt>.
11754 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11755 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11758 * Centered items by default.
11760 * @see elm_toolbar_align_get()
11764 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11767 * Get the alignment of the items.
11769 * @param obj The toolbar object.
11770 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11773 * @see elm_toolbar_align_set() for details.
11777 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11780 * Set whether the toolbar item opens a menu.
11782 * @param item The toolbar item.
11783 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11785 * A toolbar item can be set to be a menu, using this function.
11787 * Once it is set to be a menu, it can be manipulated through the
11788 * menu-like function elm_toolbar_menu_parent_set() and the other
11789 * elm_menu functions, using the Evas_Object @c menu returned by
11790 * elm_toolbar_item_menu_get().
11792 * So, items to be displayed in this item's menu should be added with
11793 * elm_menu_item_add().
11795 * The following code exemplifies the most basic usage:
11797 * tb = elm_toolbar_add(win)
11798 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11799 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11800 * elm_toolbar_menu_parent_set(tb, win);
11801 * menu = elm_toolbar_item_menu_get(item);
11802 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11803 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11807 * @see elm_toolbar_item_menu_get()
11811 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11814 * Get toolbar item's menu.
11816 * @param item The toolbar item.
11817 * @return Item's menu object or @c NULL on failure.
11819 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11820 * this function will set it.
11822 * @see elm_toolbar_item_menu_set() for details.
11826 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11829 * Add a new state to @p item.
11831 * @param item The item.
11832 * @param icon A string with icon name or the absolute path of an image file.
11833 * @param label The label of the new state.
11834 * @param func The function to call when the item is clicked when this
11835 * state is selected.
11836 * @param data The data to associate with the state.
11837 * @return The toolbar item state, or @c NULL upon failure.
11839 * Toolbar will load icon image from fdo or current theme.
11840 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11841 * If an absolute path is provided it will load it direct from a file.
11843 * States created with this function can be removed with
11844 * elm_toolbar_item_state_del().
11846 * @see elm_toolbar_item_state_del()
11847 * @see elm_toolbar_item_state_sel()
11848 * @see elm_toolbar_item_state_get()
11852 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);
11855 * Delete a previoulsy added state to @p item.
11857 * @param item The toolbar item.
11858 * @param state The state to be deleted.
11859 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11861 * @see elm_toolbar_item_state_add()
11863 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11866 * Set @p state as the current state of @p it.
11868 * @param it The item.
11869 * @param state The state to use.
11870 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11872 * If @p state is @c NULL, it won't select any state and the default item's
11873 * icon and label will be used. It's the same behaviour than
11874 * elm_toolbar_item_state_unser().
11876 * @see elm_toolbar_item_state_unset()
11880 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11883 * Unset the state of @p it.
11885 * @param it The item.
11887 * The default icon and label from this item will be displayed.
11889 * @see elm_toolbar_item_state_set() for more details.
11893 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11896 * Get the current state of @p it.
11898 * @param item The item.
11899 * @return The selected state or @c NULL if none is selected or on failure.
11901 * @see elm_toolbar_item_state_set() for details.
11902 * @see elm_toolbar_item_state_unset()
11903 * @see elm_toolbar_item_state_add()
11907 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11910 * Get the state after selected state in toolbar's @p item.
11912 * @param it The toolbar item to change state.
11913 * @return The state after current state, or @c NULL on failure.
11915 * If last state is selected, this function will return first state.
11917 * @see elm_toolbar_item_state_set()
11918 * @see elm_toolbar_item_state_add()
11922 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11925 * Get the state before selected state in toolbar's @p item.
11927 * @param it The toolbar item to change state.
11928 * @return The state before current state, or @c NULL on failure.
11930 * If first state is selected, this function will return last state.
11932 * @see elm_toolbar_item_state_set()
11933 * @see elm_toolbar_item_state_add()
11937 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11940 * Set the text to be shown in a given toolbar item's tooltips.
11942 * @param item Target item.
11943 * @param text The text to set in the content.
11945 * Setup the text as tooltip to object. The item can have only one tooltip,
11946 * so any previous tooltip data - set with this function or
11947 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11949 * @see elm_object_tooltip_text_set() for more details.
11953 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11956 * Set the content to be shown in the tooltip item.
11958 * Setup the tooltip to item. The item can have only one tooltip,
11959 * so any previous tooltip data is removed. @p func(with @p data) will
11960 * be called every time that need show the tooltip and it should
11961 * return a valid Evas_Object. This object is then managed fully by
11962 * tooltip system and is deleted when the tooltip is gone.
11964 * @param item the toolbar item being attached a tooltip.
11965 * @param func the function used to create the tooltip contents.
11966 * @param data what to provide to @a func as callback data/context.
11967 * @param del_cb called when data is not needed anymore, either when
11968 * another callback replaces @a func, the tooltip is unset with
11969 * elm_toolbar_item_tooltip_unset() or the owner @a item
11970 * dies. This callback receives as the first parameter the
11971 * given @a data, and @c event_info is the item.
11973 * @see elm_object_tooltip_content_cb_set() for more details.
11977 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);
11980 * Unset tooltip from item.
11982 * @param item toolbar item to remove previously set tooltip.
11984 * Remove tooltip from item. The callback provided as del_cb to
11985 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11986 * it is not used anymore.
11988 * @see elm_object_tooltip_unset() for more details.
11989 * @see elm_toolbar_item_tooltip_content_cb_set()
11993 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11996 * Sets a different style for this item tooltip.
11998 * @note before you set a style you should define a tooltip with
11999 * elm_toolbar_item_tooltip_content_cb_set() or
12000 * elm_toolbar_item_tooltip_text_set()
12002 * @param item toolbar item with tooltip already set.
12003 * @param style the theme style to use (default, transparent, ...)
12005 * @see elm_object_tooltip_style_set() for more details.
12009 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12012 * Get the style for this item tooltip.
12014 * @param item toolbar item with tooltip already set.
12015 * @return style the theme style in use, defaults to "default". If the
12016 * object does not have a tooltip set, then NULL is returned.
12018 * @see elm_object_tooltip_style_get() for more details.
12019 * @see elm_toolbar_item_tooltip_style_set()
12023 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12026 * Set the type of mouse pointer/cursor decoration to be shown,
12027 * when the mouse pointer is over the given toolbar widget item
12029 * @param item toolbar item to customize cursor on
12030 * @param cursor the cursor type's name
12032 * This function works analogously as elm_object_cursor_set(), but
12033 * here the cursor's changing area is restricted to the item's
12034 * area, and not the whole widget's. Note that that item cursors
12035 * have precedence over widget cursors, so that a mouse over an
12036 * item with custom cursor set will always show @b that cursor.
12038 * If this function is called twice for an object, a previously set
12039 * cursor will be unset on the second call.
12041 * @see elm_object_cursor_set()
12042 * @see elm_toolbar_item_cursor_get()
12043 * @see elm_toolbar_item_cursor_unset()
12047 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
12050 * Get the type of mouse pointer/cursor decoration set to be shown,
12051 * when the mouse pointer is over the given toolbar widget item
12053 * @param item toolbar item with custom cursor set
12054 * @return the cursor type's name or @c NULL, if no custom cursors
12055 * were set to @p item (and on errors)
12057 * @see elm_object_cursor_get()
12058 * @see elm_toolbar_item_cursor_set()
12059 * @see elm_toolbar_item_cursor_unset()
12063 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12066 * Unset any custom mouse pointer/cursor decoration set to be
12067 * shown, when the mouse pointer is over the given toolbar widget
12068 * item, thus making it show the @b default cursor again.
12070 * @param item a toolbar item
12072 * Use this call to undo any custom settings on this item's cursor
12073 * decoration, bringing it back to defaults (no custom style set).
12075 * @see elm_object_cursor_unset()
12076 * @see elm_toolbar_item_cursor_set()
12080 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12083 * Set a different @b style for a given custom cursor set for a
12086 * @param item toolbar item with custom cursor set
12087 * @param style the <b>theme style</b> to use (e.g. @c "default",
12088 * @c "transparent", etc)
12090 * This function only makes sense when one is using custom mouse
12091 * cursor decorations <b>defined in a theme file</b>, which can have,
12092 * given a cursor name/type, <b>alternate styles</b> on it. It
12093 * works analogously as elm_object_cursor_style_set(), but here
12094 * applyed only to toolbar item objects.
12096 * @warning Before you set a cursor style you should have definen a
12097 * custom cursor previously on the item, with
12098 * elm_toolbar_item_cursor_set()
12100 * @see elm_toolbar_item_cursor_engine_only_set()
12101 * @see elm_toolbar_item_cursor_style_get()
12105 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12108 * Get the current @b style set for a given toolbar item's custom
12111 * @param item toolbar item with custom cursor set.
12112 * @return style the cursor style in use. If the object does not
12113 * have a cursor set, then @c NULL is returned.
12115 * @see elm_toolbar_item_cursor_style_set() for more details
12119 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12122 * Set if the (custom)cursor for a given toolbar item should be
12123 * searched in its theme, also, or should only rely on the
12124 * rendering engine.
12126 * @param item item with custom (custom) cursor already set on
12127 * @param engine_only Use @c EINA_TRUE to have cursors looked for
12128 * only on those provided by the rendering engine, @c EINA_FALSE to
12129 * have them searched on the widget's theme, as well.
12131 * @note This call is of use only if you've set a custom cursor
12132 * for toolbar items, with elm_toolbar_item_cursor_set().
12134 * @note By default, cursors will only be looked for between those
12135 * provided by the rendering engine.
12139 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12142 * Get if the (custom) cursor for a given toolbar item is being
12143 * searched in its theme, also, or is only relying on the rendering
12146 * @param item a toolbar item
12147 * @return @c EINA_TRUE, if cursors are being looked for only on
12148 * those provided by the rendering engine, @c EINA_FALSE if they
12149 * are being searched on the widget's theme, as well.
12151 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
12155 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12158 * Change a toolbar's orientation
12159 * @param obj The toolbar object
12160 * @param vertical If @c EINA_TRUE, the toolbar is vertical
12161 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
12164 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
12167 * Get a toolbar's orientation
12168 * @param obj The toolbar object
12169 * @return If @c EINA_TRUE, the toolbar is vertical
12170 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
12173 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12180 EAPI double elm_tooltip_delay_get(void);
12181 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
12182 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
12183 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
12184 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
12185 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);
12186 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12187 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12188 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12189 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
12190 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12191 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12192 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12193 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12194 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12195 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12196 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
12197 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
12200 EAPI int elm_cursor_engine_only_get(void);
12201 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
12204 * @defgroup Menu Menu
12206 * @image html img/widget/menu/preview-00.png
12207 * @image latex img/widget/menu/preview-00.eps
12209 * A menu is a list of items displayed above its parent. When the menu is
12210 * showing its parent is darkened. Each item can have a sub-menu. The menu
12211 * object can be used to display a menu on a right click event, in a toolbar,
12214 * Signals that you can add callbacks for are:
12215 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
12216 * event_info is NULL.
12218 * @see @ref tutorial_menu
12221 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
12223 * @brief Add a new menu to the parent
12225 * @param parent The parent object.
12226 * @return The new object or NULL if it cannot be created.
12228 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12230 * @brief Set the parent for the given menu widget
12232 * @param obj The menu object.
12233 * @param parent The new parent.
12235 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12237 * @brief Get the parent for the given menu widget
12239 * @param obj The menu object.
12240 * @return The parent.
12242 * @see elm_menu_parent_set()
12244 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12246 * @brief Move the menu to a new position
12248 * @param obj The menu object.
12249 * @param x The new position.
12250 * @param y The new position.
12252 * Sets the top-left position of the menu to (@p x,@p y).
12254 * @note @p x and @p y coordinates are relative to parent.
12256 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12258 * @brief Close a opened menu
12260 * @param obj the menu object
12263 * Hides the menu and all it's sub-menus.
12265 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12267 * @brief Returns a list of @p item's items.
12269 * @param obj The menu object
12270 * @return An Eina_List* of @p item's items
12272 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12274 * @brief Get the Evas_Object of an Elm_Menu_Item
12276 * @param item The menu item object.
12277 * @return The edje object containing the swallowed content
12279 * @warning Don't manipulate this object!
12281 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12283 * @brief Add an item at the end of the given menu widget
12285 * @param obj The menu object.
12286 * @param parent The parent menu item (optional)
12287 * @param icon A icon display on the item. The icon will be destryed by the menu.
12288 * @param label The label of the item.
12289 * @param func Function called when the user select the item.
12290 * @param data Data sent by the callback.
12291 * @return Returns the new item.
12293 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);
12295 * @brief Add an object swallowed in an item at the end of the given menu
12298 * @param obj The menu object.
12299 * @param parent The parent menu item (optional)
12300 * @param subobj The object to swallow
12301 * @param func Function called when the user select the item.
12302 * @param data Data sent by the callback.
12303 * @return Returns the new item.
12305 * Add an evas object as an item to the menu.
12307 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);
12309 * @brief Set the label of a menu item
12311 * @param item The menu item object.
12312 * @param label The label to set for @p item
12314 * @warning Don't use this funcion on items created with
12315 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12317 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12319 * @brief Get the label of a menu item
12321 * @param item The menu item object.
12322 * @return The label of @p item
12324 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12326 * @brief Set the icon of a menu item to the standard icon with name @p icon
12328 * @param item The menu item object.
12329 * @param icon The icon object to set for the content of @p item
12331 * Once this icon is set, any previously set icon will be deleted.
12333 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12335 * @brief Get the string representation from the icon of a menu item
12337 * @param item The menu item object.
12338 * @return The string representation of @p item's icon or NULL
12340 * @see elm_menu_item_object_icon_name_set()
12342 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12344 * @brief Set the content object of a menu item
12346 * @param item The menu item object
12347 * @param The content object or NULL
12348 * @return EINA_TRUE on success, else EINA_FALSE
12350 * Use this function to change the object swallowed by a menu item, deleting
12351 * any previously swallowed object.
12353 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12355 * @brief Get the content object of a menu item
12357 * @param item The menu item object
12358 * @return The content object or NULL
12359 * @note If @p item was added with elm_menu_item_add_object, this
12360 * function will return the object passed, else it will return the
12363 * @see elm_menu_item_object_content_set()
12365 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12367 * @brief Set the selected state of @p item.
12369 * @param item The menu item object.
12370 * @param selected The selected/unselected state of the item
12372 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12374 * @brief Get the selected state of @p item.
12376 * @param item The menu item object.
12377 * @return The selected/unselected state of the item
12379 * @see elm_menu_item_selected_set()
12381 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12383 * @brief Set the disabled state of @p item.
12385 * @param item The menu item object.
12386 * @param disabled The enabled/disabled state of the item
12388 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12390 * @brief Get the disabled state of @p item.
12392 * @param item The menu item object.
12393 * @return The enabled/disabled state of the item
12395 * @see elm_menu_item_disabled_set()
12397 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12399 * @brief Add a separator item to menu @p obj under @p parent.
12401 * @param obj The menu object
12402 * @param parent The item to add the separator under
12403 * @return The created item or NULL on failure
12405 * This is item is a @ref Separator.
12407 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12409 * @brief Returns whether @p item is a separator.
12411 * @param item The item to check
12412 * @return If true, @p item is a separator
12414 * @see elm_menu_item_separator_add()
12416 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12418 * @brief Deletes an item from the menu.
12420 * @param item The item to delete.
12422 * @see elm_menu_item_add()
12424 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12426 * @brief Set the function called when a menu item is deleted.
12428 * @param item The item to set the callback on
12429 * @param func The function called
12431 * @see elm_menu_item_add()
12432 * @see elm_menu_item_del()
12434 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12436 * @brief Returns the data associated with menu item @p item.
12438 * @param item The item
12439 * @return The data associated with @p item or NULL if none was set.
12441 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12443 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12445 * @brief Sets the data to be associated with menu item @p item.
12447 * @param item The item
12448 * @param data The data to be associated with @p item
12450 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12452 * @brief Returns a list of @p item's subitems.
12454 * @param item The item
12455 * @return An Eina_List* of @p item's subitems
12457 * @see elm_menu_add()
12459 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12461 * @brief Get the position of a menu item
12463 * @param item The menu item
12464 * @return The item's index
12466 * This function returns the index position of a menu item in a menu.
12467 * For a sub-menu, this number is relative to the first item in the sub-menu.
12469 * @note Index values begin with 0
12471 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12473 * @brief @brief Return a menu item's owner menu
12475 * @param item The menu item
12476 * @return The menu object owning @p item, or NULL on failure
12478 * Use this function to get the menu object owning an item.
12480 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12482 * @brief Get the selected item in the menu
12484 * @param obj The menu object
12485 * @return The selected item, or NULL if none
12487 * @see elm_menu_item_selected_get()
12488 * @see elm_menu_item_selected_set()
12490 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12492 * @brief Get the last item in the menu
12494 * @param obj The menu object
12495 * @return The last item, or NULL if none
12497 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12499 * @brief Get the first item in the menu
12501 * @param obj The menu object
12502 * @return The first item, or NULL if none
12504 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12506 * @brief Get the next item in the menu.
12508 * @param item The menu item object.
12509 * @return The item after it, or NULL if none
12511 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12513 * @brief Get the previous item in the menu.
12515 * @param item The menu item object.
12516 * @return The item before it, or NULL if none
12518 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12524 * @defgroup List List
12525 * @ingroup Elementary
12527 * @image html img/widget/list/preview-00.png
12528 * @image latex img/widget/list/preview-00.eps width=\textwidth
12530 * @image html img/list.png
12531 * @image latex img/list.eps width=\textwidth
12533 * A list widget is a container whose children are displayed vertically or
12534 * horizontally, in order, and can be selected.
12535 * The list can accept only one or multiple items selection. Also has many
12536 * modes of items displaying.
12538 * A list is a very simple type of list widget. For more robust
12539 * lists, @ref Genlist should probably be used.
12541 * Smart callbacks one can listen to:
12542 * - @c "activated" - The user has double-clicked or pressed
12543 * (enter|return|spacebar) on an item. The @c event_info parameter
12544 * is the item that was activated.
12545 * - @c "clicked,double" - The user has double-clicked an item.
12546 * The @c event_info parameter is the item that was double-clicked.
12547 * - "selected" - when the user selected an item
12548 * - "unselected" - when the user unselected an item
12549 * - "longpressed" - an item in the list is long-pressed
12550 * - "scroll,edge,top" - the list is scrolled until the top edge
12551 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12552 * - "scroll,edge,left" - the list is scrolled until the left edge
12553 * - "scroll,edge,right" - the list is scrolled until the right edge
12555 * Available styles for it:
12558 * List of examples:
12559 * @li @ref list_example_01
12560 * @li @ref list_example_02
12561 * @li @ref list_example_03
12570 * @enum _Elm_List_Mode
12571 * @typedef Elm_List_Mode
12573 * Set list's resize behavior, transverse axis scroll and
12574 * items cropping. See each mode's description for more details.
12576 * @note Default value is #ELM_LIST_SCROLL.
12578 * Values <b> don't </b> work as bitmask, only one can be choosen.
12580 * @see elm_list_mode_set()
12581 * @see elm_list_mode_get()
12585 typedef enum _Elm_List_Mode
12587 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. */
12588 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). */
12589 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. */
12590 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. */
12591 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12594 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(). */
12597 * Add a new list widget to the given parent Elementary
12598 * (container) object.
12600 * @param parent The parent object.
12601 * @return a new list widget handle or @c NULL, on errors.
12603 * This function inserts a new list widget on the canvas.
12607 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12612 * @param obj The list object
12614 * @note Call before running show() on the list object.
12615 * @warning If not called, it won't display the list properly.
12618 * li = elm_list_add(win);
12619 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12620 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12622 * evas_object_show(li);
12627 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12630 * Enable or disable multiple items selection on the list object.
12632 * @param obj The list object
12633 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12636 * Disabled by default. If disabled, the user can select a single item of
12637 * the list each time. Selected items are highlighted on list.
12638 * If enabled, many items can be selected.
12640 * If a selected item is selected again, it will be unselected.
12642 * @see elm_list_multi_select_get()
12646 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12649 * Get a value whether multiple items selection is enabled or not.
12651 * @see elm_list_multi_select_set() for details.
12653 * @param obj The list object.
12654 * @return @c EINA_TRUE means multiple items selection is enabled.
12655 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12656 * @c EINA_FALSE is returned.
12660 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12663 * Set which mode to use for the list object.
12665 * @param obj The list object
12666 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12667 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12669 * Set list's resize behavior, transverse axis scroll and
12670 * items cropping. See each mode's description for more details.
12672 * @note Default value is #ELM_LIST_SCROLL.
12674 * Only one can be set, if a previous one was set, it will be changed
12675 * by the new mode set. Bitmask won't work as well.
12677 * @see elm_list_mode_get()
12681 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12684 * Get the mode the list is at.
12686 * @param obj The list object
12687 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12688 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12690 * @note see elm_list_mode_set() for more information.
12694 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12697 * Enable or disable horizontal mode on the list object.
12699 * @param obj The list object.
12700 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12701 * disable it, i.e., to enable vertical mode.
12703 * @note Vertical mode is set by default.
12705 * On horizontal mode items are displayed on list from left to right,
12706 * instead of from top to bottom. Also, the list will scroll horizontally.
12707 * Each item will presents left icon on top and right icon, or end, at
12710 * @see elm_list_horizontal_get()
12714 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12717 * Get a value whether horizontal mode is enabled or not.
12719 * @param obj The list object.
12720 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12721 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12722 * @c EINA_FALSE is returned.
12724 * @see elm_list_horizontal_set() for details.
12728 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12731 * Enable or disable always select mode on the list object.
12733 * @param obj The list object
12734 * @param always_select @c EINA_TRUE to enable always select mode or
12735 * @c EINA_FALSE to disable it.
12737 * @note Always select mode is disabled by default.
12739 * Default behavior of list items is to only call its callback function
12740 * the first time it's pressed, i.e., when it is selected. If a selected
12741 * item is pressed again, and multi-select is disabled, it won't call
12742 * this function (if multi-select is enabled it will unselect the item).
12744 * If always select is enabled, it will call the callback function
12745 * everytime a item is pressed, so it will call when the item is selected,
12746 * and again when a selected item is pressed.
12748 * @see elm_list_always_select_mode_get()
12749 * @see elm_list_multi_select_set()
12753 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12756 * Get a value whether always select mode is enabled or not, meaning that
12757 * an item will always call its callback function, even if already selected.
12759 * @param obj The list object
12760 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12761 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12762 * @c EINA_FALSE is returned.
12764 * @see elm_list_always_select_mode_set() for details.
12768 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12771 * Set bouncing behaviour when the scrolled content reaches an edge.
12773 * Tell the internal scroller object whether it should bounce or not
12774 * when it reaches the respective edges for each axis.
12776 * @param obj The list object
12777 * @param h_bounce Whether to bounce or not in the horizontal axis.
12778 * @param v_bounce Whether to bounce or not in the vertical axis.
12780 * @see elm_scroller_bounce_set()
12784 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12787 * Get the bouncing behaviour of the internal scroller.
12789 * Get whether the internal scroller should bounce when the edge of each
12790 * axis is reached scrolling.
12792 * @param obj The list object.
12793 * @param h_bounce Pointer where to store the bounce state of the horizontal
12795 * @param v_bounce Pointer where to store the bounce state of the vertical
12798 * @see elm_scroller_bounce_get()
12799 * @see elm_list_bounce_set()
12803 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12806 * Set the scrollbar policy.
12808 * @param obj The list object
12809 * @param policy_h Horizontal scrollbar policy.
12810 * @param policy_v Vertical scrollbar policy.
12812 * This sets the scrollbar visibility policy for the given scroller.
12813 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12814 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12815 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12816 * This applies respectively for the horizontal and vertical scrollbars.
12818 * The both are disabled by default, i.e., are set to
12819 * #ELM_SCROLLER_POLICY_OFF.
12823 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12826 * Get the scrollbar policy.
12828 * @see elm_list_scroller_policy_get() for details.
12830 * @param obj The list object.
12831 * @param policy_h Pointer where to store horizontal scrollbar policy.
12832 * @param policy_v Pointer where to store vertical scrollbar policy.
12836 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);
12839 * Append a new item to the list object.
12841 * @param obj The list object.
12842 * @param label The label of the list item.
12843 * @param icon The icon object to use for the left side of the item. An
12844 * icon can be any Evas object, but usually it is an icon created
12845 * with elm_icon_add().
12846 * @param end The icon object to use for the right side of the item. An
12847 * icon can be any Evas object.
12848 * @param func The function to call when the item is clicked.
12849 * @param data The data to associate with the item for related callbacks.
12851 * @return The created item or @c NULL upon failure.
12853 * A new item will be created and appended to the list, i.e., will
12854 * be set as @b last item.
12856 * Items created with this method can be deleted with
12857 * elm_list_item_del().
12859 * Associated @p data can be properly freed when item is deleted if a
12860 * callback function is set with elm_list_item_del_cb_set().
12862 * If a function is passed as argument, it will be called everytime this item
12863 * is selected, i.e., the user clicks over an unselected item.
12864 * If always select is enabled it will call this function every time
12865 * user clicks over an item (already selected or not).
12866 * If such function isn't needed, just passing
12867 * @c NULL as @p func is enough. The same should be done for @p data.
12869 * Simple example (with no function callback or data associated):
12871 * li = elm_list_add(win);
12872 * ic = elm_icon_add(win);
12873 * elm_icon_file_set(ic, "path/to/image", NULL);
12874 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12875 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12877 * evas_object_show(li);
12880 * @see elm_list_always_select_mode_set()
12881 * @see elm_list_item_del()
12882 * @see elm_list_item_del_cb_set()
12883 * @see elm_list_clear()
12884 * @see elm_icon_add()
12888 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);
12891 * Prepend a new item to the list object.
12893 * @param obj The list object.
12894 * @param label The label of the list item.
12895 * @param icon The icon object to use for the left side of the item. An
12896 * icon can be any Evas object, but usually it is an icon created
12897 * with elm_icon_add().
12898 * @param end The icon object to use for the right side of the item. An
12899 * icon can be any Evas object.
12900 * @param func The function to call when the item is clicked.
12901 * @param data The data to associate with the item for related callbacks.
12903 * @return The created item or @c NULL upon failure.
12905 * A new item will be created and prepended to the list, i.e., will
12906 * be set as @b first item.
12908 * Items created with this method can be deleted with
12909 * elm_list_item_del().
12911 * Associated @p data can be properly freed when item is deleted if a
12912 * callback function is set with elm_list_item_del_cb_set().
12914 * If a function is passed as argument, it will be called everytime this item
12915 * is selected, i.e., the user clicks over an unselected item.
12916 * If always select is enabled it will call this function every time
12917 * user clicks over an item (already selected or not).
12918 * If such function isn't needed, just passing
12919 * @c NULL as @p func is enough. The same should be done for @p data.
12921 * @see elm_list_item_append() for a simple code example.
12922 * @see elm_list_always_select_mode_set()
12923 * @see elm_list_item_del()
12924 * @see elm_list_item_del_cb_set()
12925 * @see elm_list_clear()
12926 * @see elm_icon_add()
12930 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);
12933 * Insert a new item into the list object before item @p before.
12935 * @param obj The list object.
12936 * @param before The list item to insert before.
12937 * @param label The label of the list item.
12938 * @param icon The icon object to use for the left side of the item. An
12939 * icon can be any Evas object, but usually it is an icon created
12940 * with elm_icon_add().
12941 * @param end The icon object to use for the right side of the item. An
12942 * icon can be any Evas object.
12943 * @param func The function to call when the item is clicked.
12944 * @param data The data to associate with the item for related callbacks.
12946 * @return The created item or @c NULL upon failure.
12948 * A new item will be created and added to the list. Its position in
12949 * this list will be just before item @p before.
12951 * Items created with this method can be deleted with
12952 * elm_list_item_del().
12954 * Associated @p data can be properly freed when item is deleted if a
12955 * callback function is set with elm_list_item_del_cb_set().
12957 * If a function is passed as argument, it will be called everytime this item
12958 * is selected, i.e., the user clicks over an unselected item.
12959 * If always select is enabled it will call this function every time
12960 * user clicks over an item (already selected or not).
12961 * If such function isn't needed, just passing
12962 * @c NULL as @p func is enough. The same should be done for @p data.
12964 * @see elm_list_item_append() for a simple code example.
12965 * @see elm_list_always_select_mode_set()
12966 * @see elm_list_item_del()
12967 * @see elm_list_item_del_cb_set()
12968 * @see elm_list_clear()
12969 * @see elm_icon_add()
12973 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);
12976 * Insert a new item into the list object after item @p after.
12978 * @param obj The list object.
12979 * @param after The list item to insert after.
12980 * @param label The label of the list item.
12981 * @param icon The icon object to use for the left side of the item. An
12982 * icon can be any Evas object, but usually it is an icon created
12983 * with elm_icon_add().
12984 * @param end The icon object to use for the right side of the item. An
12985 * icon can be any Evas object.
12986 * @param func The function to call when the item is clicked.
12987 * @param data The data to associate with the item for related callbacks.
12989 * @return The created item or @c NULL upon failure.
12991 * A new item will be created and added to the list. Its position in
12992 * this list will be just after item @p after.
12994 * Items created with this method can be deleted with
12995 * elm_list_item_del().
12997 * Associated @p data can be properly freed when item is deleted if a
12998 * callback function is set with elm_list_item_del_cb_set().
13000 * If a function is passed as argument, it will be called everytime this item
13001 * is selected, i.e., the user clicks over an unselected item.
13002 * If always select is enabled it will call this function every time
13003 * user clicks over an item (already selected or not).
13004 * If such function isn't needed, just passing
13005 * @c NULL as @p func is enough. The same should be done for @p data.
13007 * @see elm_list_item_append() for a simple code example.
13008 * @see elm_list_always_select_mode_set()
13009 * @see elm_list_item_del()
13010 * @see elm_list_item_del_cb_set()
13011 * @see elm_list_clear()
13012 * @see elm_icon_add()
13016 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);
13019 * Insert a new item into the sorted list object.
13021 * @param obj The list object.
13022 * @param label The label of the list item.
13023 * @param icon The icon object to use for the left side of the item. An
13024 * icon can be any Evas object, but usually it is an icon created
13025 * with elm_icon_add().
13026 * @param end The icon object to use for the right side of the item. An
13027 * icon can be any Evas object.
13028 * @param func The function to call when the item is clicked.
13029 * @param data The data to associate with the item for related callbacks.
13030 * @param cmp_func The comparing function to be used to sort list
13031 * items <b>by #Elm_List_Item item handles</b>. This function will
13032 * receive two items and compare them, returning a non-negative integer
13033 * if the second item should be place after the first, or negative value
13034 * if should be placed before.
13036 * @return The created item or @c NULL upon failure.
13038 * @note This function inserts values into a list object assuming it was
13039 * sorted and the result will be sorted.
13041 * A new item will be created and added to the list. Its position in
13042 * this list will be found comparing the new item with previously inserted
13043 * items using function @p cmp_func.
13045 * Items created with this method can be deleted with
13046 * elm_list_item_del().
13048 * Associated @p data can be properly freed when item is deleted if a
13049 * callback function is set with elm_list_item_del_cb_set().
13051 * If a function is passed as argument, it will be called everytime this item
13052 * is selected, i.e., the user clicks over an unselected item.
13053 * If always select is enabled it will call this function every time
13054 * user clicks over an item (already selected or not).
13055 * If such function isn't needed, just passing
13056 * @c NULL as @p func is enough. The same should be done for @p data.
13058 * @see elm_list_item_append() for a simple code example.
13059 * @see elm_list_always_select_mode_set()
13060 * @see elm_list_item_del()
13061 * @see elm_list_item_del_cb_set()
13062 * @see elm_list_clear()
13063 * @see elm_icon_add()
13067 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);
13070 * Remove all list's items.
13072 * @param obj The list object
13074 * @see elm_list_item_del()
13075 * @see elm_list_item_append()
13079 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
13082 * Get a list of all the list items.
13084 * @param obj The list object
13085 * @return An @c Eina_List of list items, #Elm_List_Item,
13086 * or @c NULL on failure.
13088 * @see elm_list_item_append()
13089 * @see elm_list_item_del()
13090 * @see elm_list_clear()
13094 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13097 * Get the selected item.
13099 * @param obj The list object.
13100 * @return The selected list item.
13102 * The selected item can be unselected with function
13103 * elm_list_item_selected_set().
13105 * The selected item always will be highlighted on list.
13107 * @see elm_list_selected_items_get()
13111 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13114 * Return a list of the currently selected list items.
13116 * @param obj The list object.
13117 * @return An @c Eina_List of list items, #Elm_List_Item,
13118 * or @c NULL on failure.
13120 * Multiple items can be selected if multi select is enabled. It can be
13121 * done with elm_list_multi_select_set().
13123 * @see elm_list_selected_item_get()
13124 * @see elm_list_multi_select_set()
13128 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13131 * Set the selected state of an item.
13133 * @param item The list item
13134 * @param selected The selected state
13136 * This sets the selected state of the given item @p it.
13137 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13139 * If a new item is selected the previosly selected will be unselected,
13140 * unless multiple selection is enabled with elm_list_multi_select_set().
13141 * Previoulsy selected item can be get with function
13142 * elm_list_selected_item_get().
13144 * Selected items will be highlighted.
13146 * @see elm_list_item_selected_get()
13147 * @see elm_list_selected_item_get()
13148 * @see elm_list_multi_select_set()
13152 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13155 * Get whether the @p item is selected or not.
13157 * @param item The list item.
13158 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13159 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13161 * @see elm_list_selected_item_set() for details.
13162 * @see elm_list_item_selected_get()
13166 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13169 * Set or unset item as a separator.
13171 * @param it The list item.
13172 * @param setting @c EINA_TRUE to set item @p it as separator or
13173 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13175 * Items aren't set as separator by default.
13177 * If set as separator it will display separator theme, so won't display
13180 * @see elm_list_item_separator_get()
13184 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
13187 * Get a value whether item is a separator or not.
13189 * @see elm_list_item_separator_set() for details.
13191 * @param it The list item.
13192 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13193 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13197 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13200 * Show @p item in the list view.
13202 * @param item The list item to be shown.
13204 * It won't animate list until item is visible. If such behavior is wanted,
13205 * use elm_list_bring_in() intead.
13209 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13212 * Bring in the given item to list view.
13214 * @param item The item.
13216 * This causes list to jump to the given item @p item and show it
13217 * (by scrolling), if it is not fully visible.
13219 * This may use animation to do so and take a period of time.
13221 * If animation isn't wanted, elm_list_item_show() can be used.
13225 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13228 * Delete them item from the list.
13230 * @param item The item of list to be deleted.
13232 * If deleting all list items is required, elm_list_clear()
13233 * should be used instead of getting items list and deleting each one.
13235 * @see elm_list_clear()
13236 * @see elm_list_item_append()
13237 * @see elm_list_item_del_cb_set()
13241 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13244 * Set the function called when a list item is freed.
13246 * @param item The item to set the callback on
13247 * @param func The function called
13249 * If there is a @p func, then it will be called prior item's memory release.
13250 * That will be called with the following arguments:
13252 * @li item's Evas object;
13255 * This way, a data associated to a list item could be properly freed.
13259 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13262 * Get the data associated to the item.
13264 * @param item The list item
13265 * @return The data associated to @p item
13267 * The return value is a pointer to data associated to @p item when it was
13268 * created, with function elm_list_item_append() or similar. If no data
13269 * was passed as argument, it will return @c NULL.
13271 * @see elm_list_item_append()
13275 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13278 * Get the left side icon associated to the item.
13280 * @param item The list item
13281 * @return The left side icon associated to @p item
13283 * The return value is a pointer to the icon associated to @p item when
13285 * created, with function elm_list_item_append() or similar, or later
13286 * with function elm_list_item_icon_set(). If no icon
13287 * was passed as argument, it will return @c NULL.
13289 * @see elm_list_item_append()
13290 * @see elm_list_item_icon_set()
13294 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13297 * Set the left side icon associated to the item.
13299 * @param item The list item
13300 * @param icon The left side icon object to associate with @p item
13302 * The icon object to use at left side of the item. An
13303 * icon can be any Evas object, but usually it is an icon created
13304 * with elm_icon_add().
13306 * Once the icon object is set, a previously set one will be deleted.
13307 * @warning Setting the same icon for two items will cause the icon to
13308 * dissapear from the first item.
13310 * If an icon was passed as argument on item creation, with function
13311 * elm_list_item_append() or similar, it will be already
13312 * associated to the item.
13314 * @see elm_list_item_append()
13315 * @see elm_list_item_icon_get()
13319 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13322 * Get the right side icon associated to the item.
13324 * @param item The list item
13325 * @return The right side icon associated to @p item
13327 * The return value is a pointer to the icon associated to @p item when
13329 * created, with function elm_list_item_append() or similar, or later
13330 * with function elm_list_item_icon_set(). If no icon
13331 * was passed as argument, it will return @c NULL.
13333 * @see elm_list_item_append()
13334 * @see elm_list_item_icon_set()
13338 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13341 * Set the right side icon associated to the item.
13343 * @param item The list item
13344 * @param end The right side icon object to associate with @p item
13346 * The icon object to use at right side of the item. An
13347 * icon can be any Evas object, but usually it is an icon created
13348 * with elm_icon_add().
13350 * Once the icon object is set, a previously set one will be deleted.
13351 * @warning Setting the same icon for two items will cause the icon to
13352 * dissapear from the first item.
13354 * If an icon was passed as argument on item creation, with function
13355 * elm_list_item_append() or similar, it will be already
13356 * associated to the item.
13358 * @see elm_list_item_append()
13359 * @see elm_list_item_end_get()
13363 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13366 * Gets the base object of the item.
13368 * @param item The list item
13369 * @return The base object associated with @p item
13371 * Base object is the @c Evas_Object that represents that item.
13375 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13378 * Get the label of item.
13380 * @param item The item of list.
13381 * @return The label of item.
13383 * The return value is a pointer to the label associated to @p item when
13384 * it was created, with function elm_list_item_append(), or later
13385 * with function elm_list_item_label_set. If no label
13386 * was passed as argument, it will return @c NULL.
13388 * @see elm_list_item_label_set() for more details.
13389 * @see elm_list_item_append()
13393 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13396 * Set the label of item.
13398 * @param item The item of list.
13399 * @param text The label of item.
13401 * The label to be displayed by the item.
13402 * Label will be placed between left and right side icons (if set).
13404 * If a label was passed as argument on item creation, with function
13405 * elm_list_item_append() or similar, it will be already
13406 * displayed by the item.
13408 * @see elm_list_item_label_get()
13409 * @see elm_list_item_append()
13413 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13417 * Get the item before @p it in list.
13419 * @param it The list item.
13420 * @return The item before @p it, or @c NULL if none or on failure.
13422 * @note If it is the first item, @c NULL will be returned.
13424 * @see elm_list_item_append()
13425 * @see elm_list_items_get()
13429 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13432 * Get the item after @p it in list.
13434 * @param it The list item.
13435 * @return The item after @p it, or @c NULL if none or on failure.
13437 * @note If it is the last item, @c NULL will be returned.
13439 * @see elm_list_item_append()
13440 * @see elm_list_items_get()
13444 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13447 * Sets the disabled/enabled state of a list item.
13449 * @param it The item.
13450 * @param disabled The disabled state.
13452 * A disabled item cannot be selected or unselected. It will also
13453 * change its appearance (generally greyed out). This sets the
13454 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13459 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13462 * Get a value whether list item is disabled or not.
13464 * @param it The item.
13465 * @return The disabled state.
13467 * @see elm_list_item_disabled_set() for more details.
13471 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13474 * Set the text to be shown in a given list item's tooltips.
13476 * @param item Target item.
13477 * @param text The text to set in the content.
13479 * Setup the text as tooltip to object. The item can have only one tooltip,
13480 * so any previous tooltip data - set with this function or
13481 * elm_list_item_tooltip_content_cb_set() - is removed.
13483 * @see elm_object_tooltip_text_set() for more details.
13487 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13491 * @brief Disable size restrictions on an object's tooltip
13492 * @param item The tooltip's anchor object
13493 * @param disable If EINA_TRUE, size restrictions are disabled
13494 * @return EINA_FALSE on failure, EINA_TRUE on success
13496 * This function allows a tooltip to expand beyond its parant window's canvas.
13497 * It will instead be limited only by the size of the display.
13499 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13501 * @brief Retrieve size restriction state of an object's tooltip
13502 * @param obj The tooltip's anchor object
13503 * @return If EINA_TRUE, size restrictions are disabled
13505 * This function returns whether a tooltip is allowed to expand beyond
13506 * its parant window's canvas.
13507 * It will instead be limited only by the size of the display.
13509 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13512 * Set the content to be shown in the tooltip item.
13514 * Setup the tooltip to item. The item can have only one tooltip,
13515 * so any previous tooltip data is removed. @p func(with @p data) will
13516 * be called every time that need show the tooltip and it should
13517 * return a valid Evas_Object. This object is then managed fully by
13518 * tooltip system and is deleted when the tooltip is gone.
13520 * @param item the list item being attached a tooltip.
13521 * @param func the function used to create the tooltip contents.
13522 * @param data what to provide to @a func as callback data/context.
13523 * @param del_cb called when data is not needed anymore, either when
13524 * another callback replaces @a func, the tooltip is unset with
13525 * elm_list_item_tooltip_unset() or the owner @a item
13526 * dies. This callback receives as the first parameter the
13527 * given @a data, and @c event_info is the item.
13529 * @see elm_object_tooltip_content_cb_set() for more details.
13533 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);
13536 * Unset tooltip from item.
13538 * @param item list item to remove previously set tooltip.
13540 * Remove tooltip from item. The callback provided as del_cb to
13541 * elm_list_item_tooltip_content_cb_set() will be called to notify
13542 * it is not used anymore.
13544 * @see elm_object_tooltip_unset() for more details.
13545 * @see elm_list_item_tooltip_content_cb_set()
13549 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13552 * Sets a different style for this item tooltip.
13554 * @note before you set a style you should define a tooltip with
13555 * elm_list_item_tooltip_content_cb_set() or
13556 * elm_list_item_tooltip_text_set()
13558 * @param item list item with tooltip already set.
13559 * @param style the theme style to use (default, transparent, ...)
13561 * @see elm_object_tooltip_style_set() for more details.
13565 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13568 * Get the style for this item tooltip.
13570 * @param item list item with tooltip already set.
13571 * @return style the theme style in use, defaults to "default". If the
13572 * object does not have a tooltip set, then NULL is returned.
13574 * @see elm_object_tooltip_style_get() for more details.
13575 * @see elm_list_item_tooltip_style_set()
13579 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13582 * Set the type of mouse pointer/cursor decoration to be shown,
13583 * when the mouse pointer is over the given list widget item
13585 * @param item list item to customize cursor on
13586 * @param cursor the cursor type's name
13588 * This function works analogously as elm_object_cursor_set(), but
13589 * here the cursor's changing area is restricted to the item's
13590 * area, and not the whole widget's. Note that that item cursors
13591 * have precedence over widget cursors, so that a mouse over an
13592 * item with custom cursor set will always show @b that cursor.
13594 * If this function is called twice for an object, a previously set
13595 * cursor will be unset on the second call.
13597 * @see elm_object_cursor_set()
13598 * @see elm_list_item_cursor_get()
13599 * @see elm_list_item_cursor_unset()
13603 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13606 * Get the type of mouse pointer/cursor decoration set to be shown,
13607 * when the mouse pointer is over the given list widget item
13609 * @param item list item with custom cursor set
13610 * @return the cursor type's name or @c NULL, if no custom cursors
13611 * were set to @p item (and on errors)
13613 * @see elm_object_cursor_get()
13614 * @see elm_list_item_cursor_set()
13615 * @see elm_list_item_cursor_unset()
13619 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13622 * Unset any custom mouse pointer/cursor decoration set to be
13623 * shown, when the mouse pointer is over the given list widget
13624 * item, thus making it show the @b default cursor again.
13626 * @param item a list item
13628 * Use this call to undo any custom settings on this item's cursor
13629 * decoration, bringing it back to defaults (no custom style set).
13631 * @see elm_object_cursor_unset()
13632 * @see elm_list_item_cursor_set()
13636 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13639 * Set a different @b style for a given custom cursor set for a
13642 * @param item list item with custom cursor set
13643 * @param style the <b>theme style</b> to use (e.g. @c "default",
13644 * @c "transparent", etc)
13646 * This function only makes sense when one is using custom mouse
13647 * cursor decorations <b>defined in a theme file</b>, which can have,
13648 * given a cursor name/type, <b>alternate styles</b> on it. It
13649 * works analogously as elm_object_cursor_style_set(), but here
13650 * applyed only to list item objects.
13652 * @warning Before you set a cursor style you should have definen a
13653 * custom cursor previously on the item, with
13654 * elm_list_item_cursor_set()
13656 * @see elm_list_item_cursor_engine_only_set()
13657 * @see elm_list_item_cursor_style_get()
13661 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13664 * Get the current @b style set for a given list item's custom
13667 * @param item list item with custom cursor set.
13668 * @return style the cursor style in use. If the object does not
13669 * have a cursor set, then @c NULL is returned.
13671 * @see elm_list_item_cursor_style_set() for more details
13675 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13678 * Set if the (custom)cursor for a given list item should be
13679 * searched in its theme, also, or should only rely on the
13680 * rendering engine.
13682 * @param item item with custom (custom) cursor already set on
13683 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13684 * only on those provided by the rendering engine, @c EINA_FALSE to
13685 * have them searched on the widget's theme, as well.
13687 * @note This call is of use only if you've set a custom cursor
13688 * for list items, with elm_list_item_cursor_set().
13690 * @note By default, cursors will only be looked for between those
13691 * provided by the rendering engine.
13695 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13698 * Get if the (custom) cursor for a given list item is being
13699 * searched in its theme, also, or is only relying on the rendering
13702 * @param item a list item
13703 * @return @c EINA_TRUE, if cursors are being looked for only on
13704 * those provided by the rendering engine, @c EINA_FALSE if they
13705 * are being searched on the widget's theme, as well.
13707 * @see elm_list_item_cursor_engine_only_set(), for more details
13711 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13718 * @defgroup Slider Slider
13719 * @ingroup Elementary
13721 * @image html img/widget/slider/preview-00.png
13722 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13724 * The slider adds a dragable “slider” widget for selecting the value of
13725 * something within a range.
13727 * A slider can be horizontal or vertical. It can contain an Icon and has a
13728 * primary label as well as a units label (that is formatted with floating
13729 * point values and thus accepts a printf-style format string, like
13730 * “%1.2f units”. There is also an indicator string that may be somewhere
13731 * else (like on the slider itself) that also accepts a format string like
13732 * units. Label, Icon Unit and Indicator strings/objects are optional.
13734 * A slider may be inverted which means values invert, with high vales being
13735 * on the left or top and low values on the right or bottom (as opposed to
13736 * normally being low on the left or top and high on the bottom and right).
13738 * The slider should have its minimum and maximum values set by the
13739 * application with elm_slider_min_max_set() and value should also be set by
13740 * the application before use with elm_slider_value_set(). The span of the
13741 * slider is its length (horizontally or vertically). This will be scaled by
13742 * the object or applications scaling factor. At any point code can query the
13743 * slider for its value with elm_slider_value_get().
13745 * Smart callbacks one can listen to:
13746 * - "changed" - Whenever the slider value is changed by the user.
13747 * - "slider,drag,start" - dragging the slider indicator around has started.
13748 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13749 * - "delay,changed" - A short time after the value is changed by the user.
13750 * This will be called only when the user stops dragging for
13751 * a very short period or when they release their
13752 * finger/mouse, so it avoids possibly expensive reactions to
13753 * the value change.
13755 * Available styles for it:
13758 * Here is an example on its usage:
13759 * @li @ref slider_example
13763 * @addtogroup Slider
13768 * Add a new slider widget to the given parent Elementary
13769 * (container) object.
13771 * @param parent The parent object.
13772 * @return a new slider widget handle or @c NULL, on errors.
13774 * This function inserts a new slider widget on the canvas.
13778 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13781 * Set the label of a given slider widget
13783 * @param obj The progress bar object
13784 * @param label The text label string, in UTF-8
13787 * @deprecated use elm_object_text_set() instead.
13789 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13792 * Get the label of a given slider widget
13794 * @param obj The progressbar object
13795 * @return The text label string, in UTF-8
13798 * @deprecated use elm_object_text_get() instead.
13800 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13803 * Set the icon object of the slider object.
13805 * @param obj The slider object.
13806 * @param icon The icon object.
13808 * On horizontal mode, icon is placed at left, and on vertical mode,
13811 * @note Once the icon object is set, a previously set one will be deleted.
13812 * If you want to keep that old content object, use the
13813 * elm_slider_icon_unset() function.
13815 * @warning If the object being set does not have minimum size hints set,
13816 * it won't get properly displayed.
13820 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13823 * Unset an icon set on a given slider widget.
13825 * @param obj The slider object.
13826 * @return The icon object that was being used, if any was set, or
13827 * @c NULL, otherwise (and on errors).
13829 * On horizontal mode, icon is placed at left, and on vertical mode,
13832 * This call will unparent and return the icon object which was set
13833 * for this widget, previously, on success.
13835 * @see elm_slider_icon_set() for more details
13836 * @see elm_slider_icon_get()
13840 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13843 * Retrieve the icon object set for a given slider widget.
13845 * @param obj The slider object.
13846 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13847 * otherwise (and on errors).
13849 * On horizontal mode, icon is placed at left, and on vertical mode,
13852 * @see elm_slider_icon_set() for more details
13853 * @see elm_slider_icon_unset()
13857 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13860 * Set the end object of the slider object.
13862 * @param obj The slider object.
13863 * @param end The end object.
13865 * On horizontal mode, end is placed at left, and on vertical mode,
13866 * placed at bottom.
13868 * @note Once the icon object is set, a previously set one will be deleted.
13869 * If you want to keep that old content object, use the
13870 * elm_slider_end_unset() function.
13872 * @warning If the object being set does not have minimum size hints set,
13873 * it won't get properly displayed.
13877 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13880 * Unset an end object set on a given slider widget.
13882 * @param obj The slider object.
13883 * @return The end object that was being used, if any was set, or
13884 * @c NULL, otherwise (and on errors).
13886 * On horizontal mode, end is placed at left, and on vertical mode,
13887 * placed at bottom.
13889 * This call will unparent and return the icon object which was set
13890 * for this widget, previously, on success.
13892 * @see elm_slider_end_set() for more details.
13893 * @see elm_slider_end_get()
13897 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13900 * Retrieve the end object set for a given slider widget.
13902 * @param obj The slider object.
13903 * @return The end object's handle, if @p obj had one set, or @c NULL,
13904 * otherwise (and on errors).
13906 * On horizontal mode, icon is placed at right, and on vertical mode,
13907 * placed at bottom.
13909 * @see elm_slider_end_set() for more details.
13910 * @see elm_slider_end_unset()
13914 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13917 * Set the (exact) length of the bar region of a given slider widget.
13919 * @param obj The slider object.
13920 * @param size The length of the slider's bar region.
13922 * This sets the minimum width (when in horizontal mode) or height
13923 * (when in vertical mode) of the actual bar area of the slider
13924 * @p obj. This in turn affects the object's minimum size. Use
13925 * this when you're not setting other size hints expanding on the
13926 * given direction (like weight and alignment hints) and you would
13927 * like it to have a specific size.
13929 * @note Icon, end, label, indicator and unit text around @p obj
13930 * will require their
13931 * own space, which will make @p obj to require more the @p size,
13934 * @see elm_slider_span_size_get()
13938 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13941 * Get the length set for the bar region of a given slider widget
13943 * @param obj The slider object.
13944 * @return The length of the slider's bar region.
13946 * If that size was not set previously, with
13947 * elm_slider_span_size_set(), this call will return @c 0.
13951 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13954 * Set the format string for the unit label.
13956 * @param obj The slider object.
13957 * @param format The format string for the unit display.
13959 * Unit label is displayed all the time, if set, after slider's bar.
13960 * In horizontal mode, at right and in vertical mode, at bottom.
13962 * If @c NULL, unit label won't be visible. If not it sets the format
13963 * string for the label text. To the label text is provided a floating point
13964 * value, so the label text can display up to 1 floating point value.
13965 * Note that this is optional.
13967 * Use a format string such as "%1.2f meters" for example, and it will
13968 * display values like: "3.14 meters" for a value equal to 3.14159.
13970 * Default is unit label disabled.
13972 * @see elm_slider_indicator_format_get()
13976 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13979 * Get the unit label format of the slider.
13981 * @param obj The slider object.
13982 * @return The unit label format string in UTF-8.
13984 * Unit label is displayed all the time, if set, after slider's bar.
13985 * In horizontal mode, at right and in vertical mode, at bottom.
13987 * @see elm_slider_unit_format_set() for more
13988 * information on how this works.
13992 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13995 * Set the format string for the indicator label.
13997 * @param obj The slider object.
13998 * @param indicator The format string for the indicator display.
14000 * The slider may display its value somewhere else then unit label,
14001 * for example, above the slider knob that is dragged around. This function
14002 * sets the format string used for this.
14004 * If @c NULL, indicator label won't be visible. If not it sets the format
14005 * string for the label text. To the label text is provided a floating point
14006 * value, so the label text can display up to 1 floating point value.
14007 * Note that this is optional.
14009 * Use a format string such as "%1.2f meters" for example, and it will
14010 * display values like: "3.14 meters" for a value equal to 3.14159.
14012 * Default is indicator label disabled.
14014 * @see elm_slider_indicator_format_get()
14018 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
14021 * Get the indicator label format of the slider.
14023 * @param obj The slider object.
14024 * @return The indicator label format string in UTF-8.
14026 * The slider may display its value somewhere else then unit label,
14027 * for example, above the slider knob that is dragged around. This function
14028 * gets the format string used for this.
14030 * @see elm_slider_indicator_format_set() for more
14031 * information on how this works.
14035 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14038 * Set the format function pointer for the indicator label
14040 * @param obj The slider object.
14041 * @param func The indicator format function.
14042 * @param free_func The freeing function for the format string.
14044 * Set the callback function to format the indicator string.
14046 * @see elm_slider_indicator_format_set() for more info on how this works.
14050 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);
14053 * Set the format function pointer for the units label
14055 * @param obj The slider object.
14056 * @param func The units format function.
14057 * @param free_func The freeing function for the format string.
14059 * Set the callback function to format the indicator string.
14061 * @see elm_slider_units_format_set() for more info on how this works.
14065 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);
14068 * Set the orientation of a given slider widget.
14070 * @param obj The slider object.
14071 * @param horizontal Use @c EINA_TRUE to make @p obj to be
14072 * @b horizontal, @c EINA_FALSE to make it @b vertical.
14074 * Use this function to change how your slider is to be
14075 * disposed: vertically or horizontally.
14077 * By default it's displayed horizontally.
14079 * @see elm_slider_horizontal_get()
14083 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14086 * Retrieve the orientation of a given slider widget
14088 * @param obj The slider object.
14089 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
14090 * @c EINA_FALSE if it's @b vertical (and on errors).
14092 * @see elm_slider_horizontal_set() for more details.
14096 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14099 * Set the minimum and maximum values for the slider.
14101 * @param obj The slider object.
14102 * @param min The minimum value.
14103 * @param max The maximum value.
14105 * Define the allowed range of values to be selected by the user.
14107 * If actual value is less than @p min, it will be updated to @p min. If it
14108 * is bigger then @p max, will be updated to @p max. Actual value can be
14109 * get with elm_slider_value_get().
14111 * By default, min is equal to 0.0, and max is equal to 1.0.
14113 * @warning Maximum must be greater than minimum, otherwise behavior
14116 * @see elm_slider_min_max_get()
14120 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
14123 * Get the minimum and maximum values of the slider.
14125 * @param obj The slider object.
14126 * @param min Pointer where to store the minimum value.
14127 * @param max Pointer where to store the maximum value.
14129 * @note If only one value is needed, the other pointer can be passed
14132 * @see elm_slider_min_max_set() for details.
14136 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
14139 * Set the value the slider displays.
14141 * @param obj The slider object.
14142 * @param val The value to be displayed.
14144 * Value will be presented on the unit label following format specified with
14145 * elm_slider_unit_format_set() and on indicator with
14146 * elm_slider_indicator_format_set().
14148 * @warning The value must to be between min and max values. This values
14149 * are set by elm_slider_min_max_set().
14151 * @see elm_slider_value_get()
14152 * @see elm_slider_unit_format_set()
14153 * @see elm_slider_indicator_format_set()
14154 * @see elm_slider_min_max_set()
14158 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
14161 * Get the value displayed by the spinner.
14163 * @param obj The spinner object.
14164 * @return The value displayed.
14166 * @see elm_spinner_value_set() for details.
14170 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14173 * Invert a given slider widget's displaying values order
14175 * @param obj The slider object.
14176 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
14177 * @c EINA_FALSE to bring it back to default, non-inverted values.
14179 * A slider may be @b inverted, in which state it gets its
14180 * values inverted, with high vales being on the left or top and
14181 * low values on the right or bottom, as opposed to normally have
14182 * the low values on the former and high values on the latter,
14183 * respectively, for horizontal and vertical modes.
14185 * @see elm_slider_inverted_get()
14189 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
14192 * Get whether a given slider widget's displaying values are
14195 * @param obj The slider object.
14196 * @return @c EINA_TRUE, if @p obj has inverted values,
14197 * @c EINA_FALSE otherwise (and on errors).
14199 * @see elm_slider_inverted_set() for more details.
14203 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14206 * Set whether to enlarge slider indicator (augmented knob) or not.
14208 * @param obj The slider object.
14209 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
14210 * let the knob always at default size.
14212 * By default, indicator will be bigger while dragged by the user.
14214 * @warning It won't display values set with
14215 * elm_slider_indicator_format_set() if you disable indicator.
14219 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
14222 * Get whether a given slider widget's enlarging indicator or not.
14224 * @param obj The slider object.
14225 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
14226 * @c EINA_FALSE otherwise (and on errors).
14228 * @see elm_slider_indicator_show_set() for details.
14232 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14239 * @addtogroup Actionslider Actionslider
14241 * @image html img/widget/actionslider/preview-00.png
14242 * @image latex img/widget/actionslider/preview-00.eps
14244 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
14245 * properties. The indicator is the element the user drags to choose a label.
14246 * When the position is set with magnet, when released the indicator will be
14247 * moved to it if it's nearest the magnetized position.
14249 * @note By default all positions are set as enabled.
14251 * Signals that you can add callbacks for are:
14253 * "selected" - when user selects an enabled position (the label is passed
14256 * "pos_changed" - when the indicator reaches any of the positions("left",
14257 * "right" or "center").
14259 * See an example of actionslider usage @ref actionslider_example_page "here"
14262 typedef enum _Elm_Actionslider_Pos
14264 ELM_ACTIONSLIDER_NONE = 0,
14265 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14266 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14267 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14268 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14269 } Elm_Actionslider_Pos;
14272 * Add a new actionslider to the parent.
14274 * @param parent The parent object
14275 * @return The new actionslider object or NULL if it cannot be created
14277 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14279 * Set actionslider labels.
14281 * @param obj The actionslider object
14282 * @param left_label The label to be set on the left.
14283 * @param center_label The label to be set on the center.
14284 * @param right_label The label to be set on the right.
14285 * @deprecated use elm_object_text_set() instead.
14287 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);
14289 * Get actionslider labels.
14291 * @param obj The actionslider object
14292 * @param left_label A char** to place the left_label of @p obj into.
14293 * @param center_label A char** to place the center_label of @p obj into.
14294 * @param right_label A char** to place the right_label of @p obj into.
14295 * @deprecated use elm_object_text_set() instead.
14297 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);
14299 * Get actionslider selected label.
14301 * @param obj The actionslider object
14302 * @return The selected label
14304 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14306 * Set actionslider indicator position.
14308 * @param obj The actionslider object.
14309 * @param pos The position of the indicator.
14311 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14313 * Get actionslider indicator position.
14315 * @param obj The actionslider object.
14316 * @return The position of the indicator.
14318 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14320 * Set actionslider magnet position. To make multiple positions magnets @c or
14321 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14323 * @param obj The actionslider object.
14324 * @param pos Bit mask indicating the magnet positions.
14326 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14328 * Get actionslider magnet position.
14330 * @param obj The actionslider object.
14331 * @return The positions with magnet property.
14333 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14335 * Set actionslider enabled position. To set multiple positions as enabled @c or
14336 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14338 * @note All the positions are enabled by default.
14340 * @param obj The actionslider object.
14341 * @param pos Bit mask indicating the enabled positions.
14343 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14345 * Get actionslider enabled position.
14347 * @param obj The actionslider object.
14348 * @return The enabled positions.
14350 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14352 * Set the label used on the indicator.
14354 * @param obj The actionslider object
14355 * @param label The label to be set on the indicator.
14356 * @deprecated use elm_object_text_set() instead.
14358 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14360 * Get the label used on the indicator object.
14362 * @param obj The actionslider object
14363 * @return The indicator label
14364 * @deprecated use elm_object_text_get() instead.
14366 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14372 * @defgroup Genlist Genlist
14374 * @image html img/widget/genlist/preview-00.png
14375 * @image latex img/widget/genlist/preview-00.eps
14376 * @image html img/genlist.png
14377 * @image latex img/genlist.eps
14379 * This widget aims to have more expansive list than the simple list in
14380 * Elementary that could have more flexible items and allow many more entries
14381 * while still being fast and low on memory usage. At the same time it was
14382 * also made to be able to do tree structures. But the price to pay is more
14383 * complexity when it comes to usage. If all you want is a simple list with
14384 * icons and a single label, use the normal @ref List object.
14386 * Genlist has a fairly large API, mostly because it's relatively complex,
14387 * trying to be both expansive, powerful and efficient. First we will begin
14388 * an overview on the theory behind genlist.
14390 * @section Genlist_Item_Class Genlist item classes - creating items
14392 * In order to have the ability to add and delete items on the fly, genlist
14393 * implements a class (callback) system where the application provides a
14394 * structure with information about that type of item (genlist may contain
14395 * multiple different items with different classes, states and styles).
14396 * Genlist will call the functions in this struct (methods) when an item is
14397 * "realized" (i.e., created dynamically, while the user is scrolling the
14398 * grid). All objects will simply be deleted when no longer needed with
14399 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14400 * following members:
14401 * - @c item_style - This is a constant string and simply defines the name
14402 * of the item style. It @b must be specified and the default should be @c
14404 * - @c mode_item_style - This is a constant string and simply defines the
14405 * name of the style that will be used for mode animations. It can be left
14406 * as @c NULL if you don't plan to use Genlist mode. See
14407 * elm_genlist_item_mode_set() for more info.
14409 * - @c func - A struct with pointers to functions that will be called when
14410 * an item is going to be actually created. All of them receive a @c data
14411 * parameter that will point to the same data passed to
14412 * elm_genlist_item_append() and related item creation functions, and a @c
14413 * obj parameter that points to the genlist object itself.
14415 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14416 * state_get and @c del. The 3 first functions also receive a @c part
14417 * parameter described below. A brief description of these functions follows:
14419 * - @c label_get - The @c part parameter is the name string of one of the
14420 * existing text parts in the Edje group implementing the item's theme.
14421 * This function @b must return a strdup'()ed string, as the caller will
14422 * free() it when done. See #GenlistItemLabelGetFunc.
14423 * - @c icon_get - The @c part parameter is the name string of one of the
14424 * existing (icon) swallow parts in the Edje group implementing the item's
14425 * theme. It must return @c NULL, when no icon is desired, or a valid
14426 * object handle, otherwise. The object will be deleted by the genlist on
14427 * its deletion or when the item is "unrealized". See
14428 * #GenlistItemIconGetFunc.
14429 * - @c func.state_get - The @c part parameter is the name string of one of
14430 * the state parts in the Edje group implementing the item's theme. Return
14431 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14432 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14433 * and @c "elm" as "emission" and "source" arguments, respectively, when
14434 * the state is true (the default is false), where @c XXX is the name of
14435 * the (state) part. See #GenlistItemStateGetFunc.
14436 * - @c func.del - This is intended for use when genlist items are deleted,
14437 * so any data attached to the item (e.g. its data parameter on creation)
14438 * can be deleted. See #GenlistItemDelFunc.
14440 * available item styles:
14442 * - default_style - The text part is a textblock
14444 * @image html img/widget/genlist/preview-04.png
14445 * @image latex img/widget/genlist/preview-04.eps
14449 * @image html img/widget/genlist/preview-01.png
14450 * @image latex img/widget/genlist/preview-01.eps
14452 * - icon_top_text_bottom
14454 * @image html img/widget/genlist/preview-02.png
14455 * @image latex img/widget/genlist/preview-02.eps
14459 * @image html img/widget/genlist/preview-03.png
14460 * @image latex img/widget/genlist/preview-03.eps
14462 * @section Genlist_Items Structure of items
14464 * An item in a genlist can have 0 or more text labels (they can be regular
14465 * text or textblock Evas objects - that's up to the style to determine), 0
14466 * or more icons (which are simply objects swallowed into the genlist item's
14467 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14468 * behavior left to the user to define. The Edje part names for each of
14469 * these properties will be looked up, in the theme file for the genlist,
14470 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14471 * "states", respectively. For each of those properties, if more than one
14472 * part is provided, they must have names listed separated by spaces in the
14473 * data fields. For the default genlist item theme, we have @b one label
14474 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14475 * "elm.swallow.end") and @b no state parts.
14477 * A genlist item may be at one of several styles. Elementary provides one
14478 * by default - "default", but this can be extended by system or application
14479 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14482 * @section Genlist_Manipulation Editing and Navigating
14484 * Items can be added by several calls. All of them return a @ref
14485 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14486 * They all take a data parameter that is meant to be used for a handle to
14487 * the applications internal data (eg the struct with the original item
14488 * data). The parent parameter is the parent genlist item this belongs to if
14489 * it is a tree or an indexed group, and NULL if there is no parent. The
14490 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14491 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14492 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14493 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14494 * is set then this item is group index item that is displayed at the top
14495 * until the next group comes. The func parameter is a convenience callback
14496 * that is called when the item is selected and the data parameter will be
14497 * the func_data parameter, obj be the genlist object and event_info will be
14498 * the genlist item.
14500 * elm_genlist_item_append() adds an item to the end of the list, or if
14501 * there is a parent, to the end of all the child items of the parent.
14502 * elm_genlist_item_prepend() is the same but adds to the beginning of
14503 * the list or children list. elm_genlist_item_insert_before() inserts at
14504 * item before another item and elm_genlist_item_insert_after() inserts after
14505 * the indicated item.
14507 * The application can clear the list with elm_genlist_clear() which deletes
14508 * all the items in the list and elm_genlist_item_del() will delete a specific
14509 * item. elm_genlist_item_subitems_clear() will clear all items that are
14510 * children of the indicated parent item.
14512 * To help inspect list items you can jump to the item at the top of the list
14513 * with elm_genlist_first_item_get() which will return the item pointer, and
14514 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14515 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14516 * and previous items respectively relative to the indicated item. Using
14517 * these calls you can walk the entire item list/tree. Note that as a tree
14518 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14519 * let you know which item is the parent (and thus know how to skip them if
14522 * @section Genlist_Muti_Selection Multi-selection
14524 * If the application wants multiple items to be able to be selected,
14525 * elm_genlist_multi_select_set() can enable this. If the list is
14526 * single-selection only (the default), then elm_genlist_selected_item_get()
14527 * will return the selected item, if any, or NULL I none is selected. If the
14528 * list is multi-select then elm_genlist_selected_items_get() will return a
14529 * list (that is only valid as long as no items are modified (added, deleted,
14530 * selected or unselected)).
14532 * @section Genlist_Usage_Hints Usage hints
14534 * There are also convenience functions. elm_genlist_item_genlist_get() will
14535 * return the genlist object the item belongs to. elm_genlist_item_show()
14536 * will make the scroller scroll to show that specific item so its visible.
14537 * elm_genlist_item_data_get() returns the data pointer set by the item
14538 * creation functions.
14540 * If an item changes (state of boolean changes, label or icons change),
14541 * then use elm_genlist_item_update() to have genlist update the item with
14542 * the new state. Genlist will re-realize the item thus call the functions
14543 * in the _Elm_Genlist_Item_Class for that item.
14545 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14546 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14547 * to expand/contract an item and get its expanded state, use
14548 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14549 * again to make an item disabled (unable to be selected and appear
14550 * differently) use elm_genlist_item_disabled_set() to set this and
14551 * elm_genlist_item_disabled_get() to get the disabled state.
14553 * In general to indicate how the genlist should expand items horizontally to
14554 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14555 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14556 * mode means that if items are too wide to fit, the scroller will scroll
14557 * horizontally. Otherwise items are expanded to fill the width of the
14558 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14559 * to the viewport width and limited to that size. This can be combined with
14560 * a different style that uses edjes' ellipsis feature (cutting text off like
14563 * Items will only call their selection func and callback when first becoming
14564 * selected. Any further clicks will do nothing, unless you enable always
14565 * select with elm_genlist_always_select_mode_set(). This means even if
14566 * selected, every click will make the selected callbacks be called.
14567 * elm_genlist_no_select_mode_set() will turn off the ability to select
14568 * items entirely and they will neither appear selected nor call selected
14569 * callback functions.
14571 * Remember that you can create new styles and add your own theme augmentation
14572 * per application with elm_theme_extension_add(). If you absolutely must
14573 * have a specific style that overrides any theme the user or system sets up
14574 * you can use elm_theme_overlay_add() to add such a file.
14576 * @section Genlist_Implementation Implementation
14578 * Evas tracks every object you create. Every time it processes an event
14579 * (mouse move, down, up etc.) it needs to walk through objects and find out
14580 * what event that affects. Even worse every time it renders display updates,
14581 * in order to just calculate what to re-draw, it needs to walk through many
14582 * many many objects. Thus, the more objects you keep active, the more
14583 * overhead Evas has in just doing its work. It is advisable to keep your
14584 * active objects to the minimum working set you need. Also remember that
14585 * object creation and deletion carries an overhead, so there is a
14586 * middle-ground, which is not easily determined. But don't keep massive lists
14587 * of objects you can't see or use. Genlist does this with list objects. It
14588 * creates and destroys them dynamically as you scroll around. It groups them
14589 * into blocks so it can determine the visibility etc. of a whole block at
14590 * once as opposed to having to walk the whole list. This 2-level list allows
14591 * for very large numbers of items to be in the list (tests have used up to
14592 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14593 * may be different sizes, every item added needs to be calculated as to its
14594 * size and thus this presents a lot of overhead on populating the list, this
14595 * genlist employs a queue. Any item added is queued and spooled off over
14596 * time, actually appearing some time later, so if your list has many members
14597 * you may find it takes a while for them to all appear, with your process
14598 * consuming a lot of CPU while it is busy spooling.
14600 * Genlist also implements a tree structure, but it does so with callbacks to
14601 * the application, with the application filling in tree structures when
14602 * requested (allowing for efficient building of a very deep tree that could
14603 * even be used for file-management). See the above smart signal callbacks for
14606 * @section Genlist_Smart_Events Genlist smart events
14608 * Signals that you can add callbacks for are:
14609 * - @c "activated" - The user has double-clicked or pressed
14610 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14611 * item that was activated.
14612 * - @c "clicked,double" - The user has double-clicked an item. The @c
14613 * event_info parameter is the item that was double-clicked.
14614 * - @c "selected" - This is called when a user has made an item selected.
14615 * The event_info parameter is the genlist item that was selected.
14616 * - @c "unselected" - This is called when a user has made an item
14617 * unselected. The event_info parameter is the genlist item that was
14619 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14620 * called and the item is now meant to be expanded. The event_info
14621 * parameter is the genlist item that was indicated to expand. It is the
14622 * job of this callback to then fill in the child items.
14623 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14624 * called and the item is now meant to be contracted. The event_info
14625 * parameter is the genlist item that was indicated to contract. It is the
14626 * job of this callback to then delete the child items.
14627 * - @c "expand,request" - This is called when a user has indicated they want
14628 * to expand a tree branch item. The callback should decide if the item can
14629 * expand (has any children) and then call elm_genlist_item_expanded_set()
14630 * appropriately to set the state. The event_info parameter is the genlist
14631 * item that was indicated to expand.
14632 * - @c "contract,request" - This is called when a user has indicated they
14633 * want to contract a tree branch item. The callback should decide if the
14634 * item can contract (has any children) and then call
14635 * elm_genlist_item_expanded_set() appropriately to set the state. The
14636 * event_info parameter is the genlist item that was indicated to contract.
14637 * - @c "realized" - This is called when the item in the list is created as a
14638 * real evas object. event_info parameter is the genlist item that was
14639 * created. The object may be deleted at any time, so it is up to the
14640 * caller to not use the object pointer from elm_genlist_item_object_get()
14641 * in a way where it may point to freed objects.
14642 * - @c "unrealized" - This is called just before an item is unrealized.
14643 * After this call icon objects provided will be deleted and the item
14644 * object itself delete or be put into a floating cache.
14645 * - @c "drag,start,up" - This is called when the item in the list has been
14646 * dragged (not scrolled) up.
14647 * - @c "drag,start,down" - This is called when the item in the list has been
14648 * dragged (not scrolled) down.
14649 * - @c "drag,start,left" - This is called when the item in the list has been
14650 * dragged (not scrolled) left.
14651 * - @c "drag,start,right" - This is called when the item in the list has
14652 * been dragged (not scrolled) right.
14653 * - @c "drag,stop" - This is called when the item in the list has stopped
14655 * - @c "drag" - This is called when the item in the list is being dragged.
14656 * - @c "longpressed" - This is called when the item is pressed for a certain
14657 * amount of time. By default it's 1 second.
14658 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14660 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14661 * until the bottom edge.
14662 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14663 * until the left edge.
14664 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14665 * until the right edge.
14666 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14668 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14670 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14672 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14674 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14675 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14676 * multi-touch pinched in.
14677 * - @c "swipe" - This is called when the genlist is swiped.
14679 * @section Genlist_Examples Examples
14681 * Here is a list of examples that use the genlist, trying to show some of
14682 * its capabilities:
14683 * - @ref genlist_example_01
14684 * - @ref genlist_example_02
14685 * - @ref genlist_example_03
14686 * - @ref genlist_example_04
14687 * - @ref genlist_example_05
14691 * @addtogroup Genlist
14696 * @enum _Elm_Genlist_Item_Flags
14697 * @typedef Elm_Genlist_Item_Flags
14699 * Defines if the item is of any special type (has subitems or it's the
14700 * index of a group), or is just a simple item.
14704 typedef enum _Elm_Genlist_Item_Flags
14706 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14707 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14708 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14709 } Elm_Genlist_Item_Flags;
14710 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14711 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14712 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14713 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14714 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14715 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14716 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14717 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
14720 * @struct _Elm_Genlist_Item_Class
14722 * Genlist item class definition structs.
14724 * This struct contains the style and fetching functions that will define the
14725 * contents of each item.
14727 * @see @ref Genlist_Item_Class
14729 struct _Elm_Genlist_Item_Class
14731 const char *item_style; /**< style of this class. */
14734 GenlistItemLabelGetFunc label_get; /**< Label fetching class function for genlist item classes.*/
14735 GenlistItemIconGetFunc icon_get; /**< Icon fetching class function for genlist item classes. */
14736 GenlistItemStateGetFunc state_get; /**< State fetching class function for genlist item classes. */
14737 GenlistItemDelFunc del; /**< Deletion class function for genlist item classes. */
14738 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14740 const char *mode_item_style;
14744 * Add a new genlist widget to the given parent Elementary
14745 * (container) object
14747 * @param parent The parent object
14748 * @return a new genlist widget handle or @c NULL, on errors
14750 * This function inserts a new genlist widget on the canvas.
14752 * @see elm_genlist_item_append()
14753 * @see elm_genlist_item_del()
14754 * @see elm_genlist_clear()
14758 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14760 * Remove all items from a given genlist widget.
14762 * @param obj The genlist object
14764 * This removes (and deletes) all items in @p obj, leaving it empty.
14766 * @see elm_genlist_item_del(), to remove just one item.
14770 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14772 * Enable or disable multi-selection in the genlist
14774 * @param obj The genlist object
14775 * @param multi Multi-select enable/disable. Default is disabled.
14777 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14778 * the list. This allows more than 1 item to be selected. To retrieve the list
14779 * of selected items, use elm_genlist_selected_items_get().
14781 * @see elm_genlist_selected_items_get()
14782 * @see elm_genlist_multi_select_get()
14786 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14788 * Gets if multi-selection in genlist is enabled or disabled.
14790 * @param obj The genlist object
14791 * @return Multi-select enabled/disabled
14792 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14794 * @see elm_genlist_multi_select_set()
14798 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14800 * This sets the horizontal stretching mode.
14802 * @param obj The genlist object
14803 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14805 * This sets the mode used for sizing items horizontally. Valid modes
14806 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14807 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14808 * the scroller will scroll horizontally. Otherwise items are expanded
14809 * to fill the width of the viewport of the scroller. If it is
14810 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14811 * limited to that size.
14813 * @see elm_genlist_horizontal_get()
14817 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14818 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14820 * Gets the horizontal stretching mode.
14822 * @param obj The genlist object
14823 * @return The mode to use
14824 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14826 * @see elm_genlist_horizontal_set()
14830 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14831 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14833 * Set the always select mode.
14835 * @param obj The genlist object
14836 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14837 * EINA_FALSE = off). Default is @c EINA_FALSE.
14839 * Items will only call their selection func and callback when first
14840 * becoming selected. Any further clicks will do nothing, unless you
14841 * enable always select with elm_genlist_always_select_mode_set().
14842 * This means that, even if selected, every click will make the selected
14843 * callbacks be called.
14845 * @see elm_genlist_always_select_mode_get()
14849 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14851 * Get the always select mode.
14853 * @param obj The genlist object
14854 * @return The always select mode
14855 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14857 * @see elm_genlist_always_select_mode_set()
14861 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14863 * Enable/disable the no select mode.
14865 * @param obj The genlist object
14866 * @param no_select The no select mode
14867 * (EINA_TRUE = on, EINA_FALSE = off)
14869 * This will turn off the ability to select items entirely and they
14870 * will neither appear selected nor call selected callback functions.
14872 * @see elm_genlist_no_select_mode_get()
14876 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14878 * Gets whether the no select mode is enabled.
14880 * @param obj The genlist object
14881 * @return The no select mode
14882 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14884 * @see elm_genlist_no_select_mode_set()
14888 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14890 * Enable/disable compress mode.
14892 * @param obj The genlist object
14893 * @param compress The compress mode
14894 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14896 * This will enable the compress mode where items are "compressed"
14897 * horizontally to fit the genlist scrollable viewport width. This is
14898 * special for genlist. Do not rely on
14899 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14900 * work as genlist needs to handle it specially.
14902 * @see elm_genlist_compress_mode_get()
14906 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14908 * Get whether the compress mode is enabled.
14910 * @param obj The genlist object
14911 * @return The compress mode
14912 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14914 * @see elm_genlist_compress_mode_set()
14918 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14920 * Enable/disable height-for-width mode.
14922 * @param obj The genlist object
14923 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14924 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14926 * With height-for-width mode the item width will be fixed (restricted
14927 * to a minimum of) to the list width when calculating its size in
14928 * order to allow the height to be calculated based on it. This allows,
14929 * for instance, text block to wrap lines if the Edje part is
14930 * configured with "text.min: 0 1".
14932 * @note This mode will make list resize slower as it will have to
14933 * recalculate every item height again whenever the list width
14936 * @note When height-for-width mode is enabled, it also enables
14937 * compress mode (see elm_genlist_compress_mode_set()) and
14938 * disables homogeneous (see elm_genlist_homogeneous_set()).
14942 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14944 * Get whether the height-for-width mode is enabled.
14946 * @param obj The genlist object
14947 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14952 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14954 * Enable/disable horizontal and vertical bouncing effect.
14956 * @param obj The genlist object
14957 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14958 * EINA_FALSE = off). Default is @c EINA_FALSE.
14959 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14960 * EINA_FALSE = off). Default is @c EINA_TRUE.
14962 * This will enable or disable the scroller bouncing effect for the
14963 * genlist. See elm_scroller_bounce_set() for details.
14965 * @see elm_scroller_bounce_set()
14966 * @see elm_genlist_bounce_get()
14970 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14972 * Get whether the horizontal and vertical bouncing effect is enabled.
14974 * @param obj The genlist object
14975 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14977 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14980 * @see elm_genlist_bounce_set()
14984 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14986 * Enable/disable homogenous mode.
14988 * @param obj The genlist object
14989 * @param homogeneous Assume the items within the genlist are of the
14990 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14993 * This will enable the homogeneous mode where items are of the same
14994 * height and width so that genlist may do the lazy-loading at its
14995 * maximum (which increases the performance for scrolling the list). This
14996 * implies 'compressed' mode.
14998 * @see elm_genlist_compress_mode_set()
14999 * @see elm_genlist_homogeneous_get()
15003 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15005 * Get whether the homogenous mode is enabled.
15007 * @param obj The genlist object
15008 * @return Assume the items within the genlist are of the same height
15009 * and width (EINA_TRUE = on, EINA_FALSE = off)
15011 * @see elm_genlist_homogeneous_set()
15015 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15017 * Set the maximum number of items within an item block
15019 * @param obj The genlist object
15020 * @param n Maximum number of items within an item block. Default is 32.
15022 * This will configure the block count to tune to the target with
15023 * particular performance matrix.
15025 * A block of objects will be used to reduce the number of operations due to
15026 * many objects in the screen. It can determine the visibility, or if the
15027 * object has changed, it theme needs to be updated, etc. doing this kind of
15028 * calculation to the entire block, instead of per object.
15030 * The default value for the block count is enough for most lists, so unless
15031 * you know you will have a lot of objects visible in the screen at the same
15032 * time, don't try to change this.
15034 * @see elm_genlist_block_count_get()
15035 * @see @ref Genlist_Implementation
15039 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
15041 * Get the maximum number of items within an item block
15043 * @param obj The genlist object
15044 * @return Maximum number of items within an item block
15046 * @see elm_genlist_block_count_set()
15050 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15052 * Set the timeout in seconds for the longpress event.
15054 * @param obj The genlist object
15055 * @param timeout timeout in seconds. Default is 1.
15057 * This option will change how long it takes to send an event "longpressed"
15058 * after the mouse down signal is sent to the list. If this event occurs, no
15059 * "clicked" event will be sent.
15061 * @see elm_genlist_longpress_timeout_set()
15065 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
15067 * Get the timeout in seconds for the longpress event.
15069 * @param obj The genlist object
15070 * @return timeout in seconds
15072 * @see elm_genlist_longpress_timeout_get()
15076 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15078 * Append a new item in a given genlist widget.
15080 * @param obj The genlist object
15081 * @param itc The item class for the item
15082 * @param data The item data
15083 * @param parent The parent item, or NULL if none
15084 * @param flags Item flags
15085 * @param func Convenience function called when the item is selected
15086 * @param func_data Data passed to @p func above.
15087 * @return A handle to the item added or @c NULL if not possible
15089 * This adds the given item to the end of the list or the end of
15090 * the children list if the @p parent is given.
15092 * @see elm_genlist_item_prepend()
15093 * @see elm_genlist_item_insert_before()
15094 * @see elm_genlist_item_insert_after()
15095 * @see elm_genlist_item_del()
15099 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);
15101 * Prepend a new item in a given genlist widget.
15103 * @param obj The genlist object
15104 * @param itc The item class for the item
15105 * @param data The item data
15106 * @param parent The parent item, or NULL if none
15107 * @param flags Item flags
15108 * @param func Convenience function called when the item is selected
15109 * @param func_data Data passed to @p func above.
15110 * @return A handle to the item added or NULL if not possible
15112 * This adds an item to the beginning of the list or beginning of the
15113 * children of the parent if given.
15115 * @see elm_genlist_item_append()
15116 * @see elm_genlist_item_insert_before()
15117 * @see elm_genlist_item_insert_after()
15118 * @see elm_genlist_item_del()
15122 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);
15124 * Insert an item before another in a genlist widget
15126 * @param obj The genlist object
15127 * @param itc The item class for the item
15128 * @param data The item data
15129 * @param before The item to place this new one before.
15130 * @param flags Item flags
15131 * @param func Convenience function called when the item is selected
15132 * @param func_data Data passed to @p func above.
15133 * @return A handle to the item added or @c NULL if not possible
15135 * This inserts an item before another in the list. It will be in the
15136 * same tree level or group as the item it is inserted before.
15138 * @see elm_genlist_item_append()
15139 * @see elm_genlist_item_prepend()
15140 * @see elm_genlist_item_insert_after()
15141 * @see elm_genlist_item_del()
15145 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);
15147 * Insert an item after another in a genlist widget
15149 * @param obj The genlist object
15150 * @param itc The item class for the item
15151 * @param data The item data
15152 * @param after The item to place this new one after.
15153 * @param flags Item flags
15154 * @param func Convenience function called when the item is selected
15155 * @param func_data Data passed to @p func above.
15156 * @return A handle to the item added or @c NULL if not possible
15158 * This inserts an item after another in the list. It will be in the
15159 * same tree level or group as the item it is inserted after.
15161 * @see elm_genlist_item_append()
15162 * @see elm_genlist_item_prepend()
15163 * @see elm_genlist_item_insert_before()
15164 * @see elm_genlist_item_del()
15168 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);
15170 * Insert a new item into the sorted genlist object
15172 * @param obj The genlist object
15173 * @param itc The item class for the item
15174 * @param data The item data
15175 * @param parent The parent item, or NULL if none
15176 * @param flags Item flags
15177 * @param comp The function called for the sort
15178 * @param func Convenience function called when item selected
15179 * @param func_data Data passed to @p func above.
15180 * @return A handle to the item added or NULL if not possible
15184 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);
15185 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);
15186 /* operations to retrieve existing items */
15188 * Get the selectd item in the genlist.
15190 * @param obj The genlist object
15191 * @return The selected item, or NULL if none is selected.
15193 * This gets the selected item in the list (if multi-selection is enabled, only
15194 * the item that was first selected in the list is returned - which is not very
15195 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
15198 * If no item is selected, NULL is returned.
15200 * @see elm_genlist_selected_items_get()
15204 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15206 * Get a list of selected items in the genlist.
15208 * @param obj The genlist object
15209 * @return The list of selected items, or NULL if none are selected.
15211 * It returns a list of the selected items. This list pointer is only valid so
15212 * long as the selection doesn't change (no items are selected or unselected, or
15213 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
15214 * pointers. The order of the items in this list is the order which they were
15215 * selected, i.e. the first item in this list is the first item that was
15216 * selected, and so on.
15218 * @note If not in multi-select mode, consider using function
15219 * elm_genlist_selected_item_get() instead.
15221 * @see elm_genlist_multi_select_set()
15222 * @see elm_genlist_selected_item_get()
15226 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15228 * Get a list of realized items in genlist
15230 * @param obj The genlist object
15231 * @return The list of realized items, nor NULL if none are realized.
15233 * This returns a list of the realized items in the genlist. The list
15234 * contains Elm_Genlist_Item pointers. The list must be freed by the
15235 * caller when done with eina_list_free(). The item pointers in the
15236 * list are only valid so long as those items are not deleted or the
15237 * genlist is not deleted.
15239 * @see elm_genlist_realized_items_update()
15243 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15245 * Get the item that is at the x, y canvas coords.
15247 * @param obj The gelinst object.
15248 * @param x The input x coordinate
15249 * @param y The input y coordinate
15250 * @param posret The position relative to the item returned here
15251 * @return The item at the coordinates or NULL if none
15253 * This returns the item at the given coordinates (which are canvas
15254 * relative, not object-relative). If an item is at that coordinate,
15255 * that item handle is returned, and if @p posret is not NULL, the
15256 * integer pointed to is set to a value of -1, 0 or 1, depending if
15257 * the coordinate is on the upper portion of that item (-1), on the
15258 * middle section (0) or on the lower part (1). If NULL is returned as
15259 * an item (no item found there), then posret may indicate -1 or 1
15260 * based if the coordinate is above or below all items respectively in
15265 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);
15267 * Get the first item in the genlist
15269 * This returns the first item in the list.
15271 * @param obj The genlist object
15272 * @return The first item, or NULL if none
15276 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15278 * Get the last item in the genlist
15280 * This returns the last item in the list.
15282 * @return The last item, or NULL if none
15286 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15288 * Set the scrollbar policy
15290 * @param obj The genlist object
15291 * @param policy_h Horizontal scrollbar policy.
15292 * @param policy_v Vertical scrollbar policy.
15294 * This sets the scrollbar visibility policy for the given genlist
15295 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15296 * made visible if it is needed, and otherwise kept hidden.
15297 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15298 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15299 * respectively for the horizontal and vertical scrollbars. Default is
15300 * #ELM_SMART_SCROLLER_POLICY_AUTO
15302 * @see elm_genlist_scroller_policy_get()
15306 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15308 * Get the scrollbar policy
15310 * @param obj The genlist object
15311 * @param policy_h Pointer to store the horizontal scrollbar policy.
15312 * @param policy_v Pointer to store the vertical scrollbar policy.
15314 * @see elm_genlist_scroller_policy_set()
15318 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);
15320 * Get the @b next item in a genlist widget's internal list of items,
15321 * given a handle to one of those items.
15323 * @param item The genlist item to fetch next from
15324 * @return The item after @p item, or @c NULL if there's none (and
15327 * This returns the item placed after the @p item, on the container
15330 * @see elm_genlist_item_prev_get()
15334 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15336 * Get the @b previous item in a genlist widget's internal list of items,
15337 * given a handle to one of those items.
15339 * @param item The genlist item to fetch previous from
15340 * @return The item before @p item, or @c NULL if there's none (and
15343 * This returns the item placed before the @p item, on the container
15346 * @see elm_genlist_item_next_get()
15350 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15352 * Get the genlist object's handle which contains a given genlist
15355 * @param item The item to fetch the container from
15356 * @return The genlist (parent) object
15358 * This returns the genlist object itself that an item belongs to.
15362 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15364 * Get the parent item of the given item
15366 * @param it The item
15367 * @return The parent of the item or @c NULL if it has no parent.
15369 * This returns the item that was specified as parent of the item @p it on
15370 * elm_genlist_item_append() and insertion related functions.
15374 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15376 * Remove all sub-items (children) of the given item
15378 * @param it The item
15380 * This removes all items that are children (and their descendants) of the
15381 * given item @p it.
15383 * @see elm_genlist_clear()
15384 * @see elm_genlist_item_del()
15388 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15390 * Set whether a given genlist item is selected or not
15392 * @param it The item
15393 * @param selected Use @c EINA_TRUE, to make it selected, @c
15394 * EINA_FALSE to make it unselected
15396 * This sets the selected state of an item. If multi selection is
15397 * not enabled on the containing genlist and @p selected is @c
15398 * EINA_TRUE, any other previously selected items will get
15399 * unselected in favor of this new one.
15401 * @see elm_genlist_item_selected_get()
15405 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15407 * Get whether a given genlist item is selected or not
15409 * @param it The item
15410 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15412 * @see elm_genlist_item_selected_set() for more details
15416 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15418 * Sets the expanded state of an item.
15420 * @param it The item
15421 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15423 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15426 * The theme will respond to this change visually, and a signal "expanded" or
15427 * "contracted" will be sent from the genlist with a pointer to the item that
15428 * has been expanded/contracted.
15430 * Calling this function won't show or hide any child of this item (if it is
15431 * a parent). You must manually delete and create them on the callbacks fo
15432 * the "expanded" or "contracted" signals.
15434 * @see elm_genlist_item_expanded_get()
15438 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15440 * Get the expanded state of an item
15442 * @param it The item
15443 * @return The expanded state
15445 * This gets the expanded state of an item.
15447 * @see elm_genlist_item_expanded_set()
15451 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15453 * Get the depth of expanded item
15455 * @param it The genlist item object
15456 * @return The depth of expanded item
15460 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15462 * Set whether a given genlist item is disabled or not.
15464 * @param it The item
15465 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15466 * to enable it back.
15468 * A disabled item cannot be selected or unselected. It will also
15469 * change its appearance, to signal the user it's disabled.
15471 * @see elm_genlist_item_disabled_get()
15475 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15477 * Get whether a given genlist item is disabled or not.
15479 * @param it The item
15480 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15483 * @see elm_genlist_item_disabled_set() for more details
15487 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15489 * Sets the display only state of an item.
15491 * @param it The item
15492 * @param display_only @c EINA_TRUE if the item is display only, @c
15493 * EINA_FALSE otherwise.
15495 * A display only item cannot be selected or unselected. It is for
15496 * display only and not selecting or otherwise clicking, dragging
15497 * etc. by the user, thus finger size rules will not be applied to
15500 * It's good to set group index items to display only state.
15502 * @see elm_genlist_item_display_only_get()
15506 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15508 * Get the display only state of an item
15510 * @param it The item
15511 * @return @c EINA_TRUE if the item is display only, @c
15512 * EINA_FALSE otherwise.
15514 * @see elm_genlist_item_display_only_set()
15518 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15520 * Show the portion of a genlist's internal list containing a given
15521 * item, immediately.
15523 * @param it The item to display
15525 * This causes genlist to jump to the given item @p it and show it (by
15526 * immediately scrolling to that position), if it is not fully visible.
15528 * @see elm_genlist_item_bring_in()
15529 * @see elm_genlist_item_top_show()
15530 * @see elm_genlist_item_middle_show()
15534 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15536 * Animatedly bring in, to the visible are of a genlist, a given
15539 * @param it The item to display
15541 * This causes genlist to jump to the given item @p it and show it (by
15542 * animatedly scrolling), if it is not fully visible. This may use animation
15543 * to do so and take a period of time
15545 * @see elm_genlist_item_show()
15546 * @see elm_genlist_item_top_bring_in()
15547 * @see elm_genlist_item_middle_bring_in()
15551 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15553 * Show the portion of a genlist's internal list containing a given
15554 * item, immediately.
15556 * @param it The item to display
15558 * This causes genlist to jump to the given item @p it and show it (by
15559 * immediately scrolling to that position), if it is not fully visible.
15561 * The item will be positioned at the top of the genlist viewport.
15563 * @see elm_genlist_item_show()
15564 * @see elm_genlist_item_top_bring_in()
15568 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15570 * Animatedly bring in, to the visible are of a genlist, a given
15573 * @param it The item
15575 * This causes genlist to jump to the given item @p it and show it (by
15576 * animatedly scrolling), if it is not fully visible. This may use animation
15577 * to do so and take a period of time
15579 * The item will be positioned at the top of the genlist viewport.
15581 * @see elm_genlist_item_bring_in()
15582 * @see elm_genlist_item_top_show()
15586 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15588 * Show the portion of a genlist's internal list containing a given
15589 * item, immediately.
15591 * @param it The item to display
15593 * This causes genlist to jump to the given item @p it and show it (by
15594 * immediately scrolling to that position), if it is not fully visible.
15596 * The item will be positioned at the middle of the genlist viewport.
15598 * @see elm_genlist_item_show()
15599 * @see elm_genlist_item_middle_bring_in()
15603 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15605 * Animatedly bring in, to the visible are of a genlist, a given
15608 * @param it The item
15610 * This causes genlist to jump to the given item @p it and show it (by
15611 * animatedly scrolling), if it is not fully visible. This may use animation
15612 * to do so and take a period of time
15614 * The item will be positioned at the middle of the genlist viewport.
15616 * @see elm_genlist_item_bring_in()
15617 * @see elm_genlist_item_middle_show()
15621 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15623 * Remove a genlist item from the its parent, deleting it.
15625 * @param item The item to be removed.
15626 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15628 * @see elm_genlist_clear(), to remove all items in a genlist at
15633 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15635 * Return the data associated to a given genlist item
15637 * @param item The genlist item.
15638 * @return the data associated to this item.
15640 * This returns the @c data value passed on the
15641 * elm_genlist_item_append() and related item addition calls.
15643 * @see elm_genlist_item_append()
15644 * @see elm_genlist_item_data_set()
15648 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15650 * Set the data associated to a given genlist item
15652 * @param item The genlist item
15653 * @param data The new data pointer to set on it
15655 * This @b overrides the @c data value passed on the
15656 * elm_genlist_item_append() and related item addition calls. This
15657 * function @b won't call elm_genlist_item_update() automatically,
15658 * so you'd issue it afterwards if you want to hove the item
15659 * updated to reflect the that new data.
15661 * @see elm_genlist_item_data_get()
15665 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15667 * Tells genlist to "orphan" icons fetchs by the item class
15669 * @param it The item
15671 * This instructs genlist to release references to icons in the item,
15672 * meaning that they will no longer be managed by genlist and are
15673 * floating "orphans" that can be re-used elsewhere if the user wants
15678 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15680 * Get the real Evas object created to implement the view of a
15681 * given genlist item
15683 * @param item The genlist item.
15684 * @return the Evas object implementing this item's view.
15686 * This returns the actual Evas object used to implement the
15687 * specified genlist item's view. This may be @c NULL, as it may
15688 * not have been created or may have been deleted, at any time, by
15689 * the genlist. <b>Do not modify this object</b> (move, resize,
15690 * show, hide, etc.), as the genlist is controlling it. This
15691 * function is for querying, emitting custom signals or hooking
15692 * lower level callbacks for events on that object. Do not delete
15693 * this object under any circumstances.
15695 * @see elm_genlist_item_data_get()
15699 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15701 * Update the contents of an item
15703 * @param it The item
15705 * This updates an item by calling all the item class functions again
15706 * to get the icons, labels and states. Use this when the original
15707 * item data has changed and the changes are desired to be reflected.
15709 * Use elm_genlist_realized_items_update() to update all already realized
15712 * @see elm_genlist_realized_items_update()
15716 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15718 * Update the item class of an item
15720 * @param it The item
15721 * @param itc The item class for the item
15723 * This sets another class fo the item, changing the way that it is
15724 * displayed. After changing the item class, elm_genlist_item_update() is
15725 * called on the item @p it.
15729 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15730 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15732 * Set the text to be shown in a given genlist item's tooltips.
15734 * @param item The genlist item
15735 * @param text The text to set in the content
15737 * This call will setup the text to be used as tooltip to that item
15738 * (analogous to elm_object_tooltip_text_set(), but being item
15739 * tooltips with higher precedence than object tooltips). It can
15740 * have only one tooltip at a time, so any previous tooltip data
15741 * will get removed.
15743 * In order to set an icon or something else as a tooltip, look at
15744 * elm_genlist_item_tooltip_content_cb_set().
15748 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15750 * Set the content to be shown in a given genlist item's tooltips
15752 * @param item The genlist item.
15753 * @param func The function returning the tooltip contents.
15754 * @param data What to provide to @a func as callback data/context.
15755 * @param del_cb Called when data is not needed anymore, either when
15756 * another callback replaces @p func, the tooltip is unset with
15757 * elm_genlist_item_tooltip_unset() or the owner @p item
15758 * dies. This callback receives as its first parameter the
15759 * given @p data, being @c event_info the item handle.
15761 * This call will setup the tooltip's contents to @p item
15762 * (analogous to elm_object_tooltip_content_cb_set(), but being
15763 * item tooltips with higher precedence than object tooltips). It
15764 * can have only one tooltip at a time, so any previous tooltip
15765 * content will get removed. @p func (with @p data) will be called
15766 * every time Elementary needs to show the tooltip and it should
15767 * return a valid Evas object, which will be fully managed by the
15768 * tooltip system, getting deleted when the tooltip is gone.
15770 * In order to set just a text as a tooltip, look at
15771 * elm_genlist_item_tooltip_text_set().
15775 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);
15777 * Unset a tooltip from a given genlist item
15779 * @param item genlist item to remove a previously set tooltip from.
15781 * This call removes any tooltip set on @p item. The callback
15782 * provided as @c del_cb to
15783 * elm_genlist_item_tooltip_content_cb_set() will be called to
15784 * notify it is not used anymore (and have resources cleaned, if
15787 * @see elm_genlist_item_tooltip_content_cb_set()
15791 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15793 * Set a different @b style for a given genlist item's tooltip.
15795 * @param item genlist item with tooltip set
15796 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15797 * "default", @c "transparent", etc)
15799 * Tooltips can have <b>alternate styles</b> to be displayed on,
15800 * which are defined by the theme set on Elementary. This function
15801 * works analogously as elm_object_tooltip_style_set(), but here
15802 * applied only to genlist item objects. The default style for
15803 * tooltips is @c "default".
15805 * @note before you set a style you should define a tooltip with
15806 * elm_genlist_item_tooltip_content_cb_set() or
15807 * elm_genlist_item_tooltip_text_set()
15809 * @see elm_genlist_item_tooltip_style_get()
15813 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15815 * Get the style set a given genlist item's tooltip.
15817 * @param item genlist item with tooltip already set on.
15818 * @return style the theme style in use, which defaults to
15819 * "default". If the object does not have a tooltip set,
15820 * then @c NULL is returned.
15822 * @see elm_genlist_item_tooltip_style_set() for more details
15826 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15828 * @brief Disable size restrictions on an object's tooltip
15829 * @param item The tooltip's anchor object
15830 * @param disable If EINA_TRUE, size restrictions are disabled
15831 * @return EINA_FALSE on failure, EINA_TRUE on success
15833 * This function allows a tooltip to expand beyond its parant window's canvas.
15834 * It will instead be limited only by the size of the display.
15836 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15838 * @brief Retrieve size restriction state of an object's tooltip
15839 * @param item The tooltip's anchor object
15840 * @return If EINA_TRUE, size restrictions are disabled
15842 * This function returns whether a tooltip is allowed to expand beyond
15843 * its parant window's canvas.
15844 * It will instead be limited only by the size of the display.
15846 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15848 * Set the type of mouse pointer/cursor decoration to be shown,
15849 * when the mouse pointer is over the given genlist widget item
15851 * @param item genlist item to customize cursor on
15852 * @param cursor the cursor type's name
15854 * This function works analogously as elm_object_cursor_set(), but
15855 * here the cursor's changing area is restricted to the item's
15856 * area, and not the whole widget's. Note that that item cursors
15857 * have precedence over widget cursors, so that a mouse over @p
15858 * item will always show cursor @p type.
15860 * If this function is called twice for an object, a previously set
15861 * cursor will be unset on the second call.
15863 * @see elm_object_cursor_set()
15864 * @see elm_genlist_item_cursor_get()
15865 * @see elm_genlist_item_cursor_unset()
15869 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15871 * Get the type of mouse pointer/cursor decoration set to be shown,
15872 * when the mouse pointer is over the given genlist widget item
15874 * @param item genlist item with custom cursor set
15875 * @return the cursor type's name or @c NULL, if no custom cursors
15876 * were set to @p item (and on errors)
15878 * @see elm_object_cursor_get()
15879 * @see elm_genlist_item_cursor_set() for more details
15880 * @see elm_genlist_item_cursor_unset()
15884 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15886 * Unset any custom mouse pointer/cursor decoration set to be
15887 * shown, when the mouse pointer is over the given genlist widget
15888 * item, thus making it show the @b default cursor again.
15890 * @param item a genlist item
15892 * Use this call to undo any custom settings on this item's cursor
15893 * decoration, bringing it back to defaults (no custom style set).
15895 * @see elm_object_cursor_unset()
15896 * @see elm_genlist_item_cursor_set() for more details
15900 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15902 * Set a different @b style for a given custom cursor set for a
15905 * @param item genlist item with custom cursor set
15906 * @param style the <b>theme style</b> to use (e.g. @c "default",
15907 * @c "transparent", etc)
15909 * This function only makes sense when one is using custom mouse
15910 * cursor decorations <b>defined in a theme file</b> , which can
15911 * have, given a cursor name/type, <b>alternate styles</b> on
15912 * it. It works analogously as elm_object_cursor_style_set(), but
15913 * here applied only to genlist item objects.
15915 * @warning Before you set a cursor style you should have defined a
15916 * custom cursor previously on the item, with
15917 * elm_genlist_item_cursor_set()
15919 * @see elm_genlist_item_cursor_engine_only_set()
15920 * @see elm_genlist_item_cursor_style_get()
15924 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15926 * Get the current @b style set for a given genlist item's custom
15929 * @param item genlist item with custom cursor set.
15930 * @return style the cursor style in use. If the object does not
15931 * have a cursor set, then @c NULL is returned.
15933 * @see elm_genlist_item_cursor_style_set() for more details
15937 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15939 * Set if the (custom) cursor for a given genlist item should be
15940 * searched in its theme, also, or should only rely on the
15941 * rendering engine.
15943 * @param item item with custom (custom) cursor already set on
15944 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15945 * only on those provided by the rendering engine, @c EINA_FALSE to
15946 * have them searched on the widget's theme, as well.
15948 * @note This call is of use only if you've set a custom cursor
15949 * for genlist items, with elm_genlist_item_cursor_set().
15951 * @note By default, cursors will only be looked for between those
15952 * provided by the rendering engine.
15956 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15958 * Get if the (custom) cursor for a given genlist item is being
15959 * searched in its theme, also, or is only relying on the rendering
15962 * @param item a genlist item
15963 * @return @c EINA_TRUE, if cursors are being looked for only on
15964 * those provided by the rendering engine, @c EINA_FALSE if they
15965 * are being searched on the widget's theme, as well.
15967 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15971 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15973 * Update the contents of all realized items.
15975 * @param obj The genlist object.
15977 * This updates all realized items by calling all the item class functions again
15978 * to get the icons, labels and states. Use this when the original
15979 * item data has changed and the changes are desired to be reflected.
15981 * To update just one item, use elm_genlist_item_update().
15983 * @see elm_genlist_realized_items_get()
15984 * @see elm_genlist_item_update()
15988 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15990 * Activate a genlist mode on an item
15992 * @param item The genlist item
15993 * @param mode Mode name
15994 * @param mode_set Boolean to define set or unset mode.
15996 * A genlist mode is a different way of selecting an item. Once a mode is
15997 * activated on an item, any other selected item is immediately unselected.
15998 * This feature provides an easy way of implementing a new kind of animation
15999 * for selecting an item, without having to entirely rewrite the item style
16000 * theme. However, the elm_genlist_selected_* API can't be used to get what
16001 * item is activate for a mode.
16003 * The current item style will still be used, but applying a genlist mode to
16004 * an item will select it using a different kind of animation.
16006 * The current active item for a mode can be found by
16007 * elm_genlist_mode_item_get().
16009 * The characteristics of genlist mode are:
16010 * - Only one mode can be active at any time, and for only one item.
16011 * - Genlist handles deactivating other items when one item is activated.
16012 * - A mode is defined in the genlist theme (edc), and more modes can easily
16014 * - A mode style and the genlist item style are different things. They
16015 * can be combined to provide a default style to the item, with some kind
16016 * of animation for that item when the mode is activated.
16018 * When a mode is activated on an item, a new view for that item is created.
16019 * The theme of this mode defines the animation that will be used to transit
16020 * the item from the old view to the new view. This second (new) view will be
16021 * active for that item while the mode is active on the item, and will be
16022 * destroyed after the mode is totally deactivated from that item.
16024 * @see elm_genlist_mode_get()
16025 * @see elm_genlist_mode_item_get()
16029 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
16031 * Get the last (or current) genlist mode used.
16033 * @param obj The genlist object
16035 * This function just returns the name of the last used genlist mode. It will
16036 * be the current mode if it's still active.
16038 * @see elm_genlist_item_mode_set()
16039 * @see elm_genlist_mode_item_get()
16043 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16045 * Get active genlist mode item
16047 * @param obj The genlist object
16048 * @return The active item for that current mode. Or @c NULL if no item is
16049 * activated with any mode.
16051 * This function returns the item that was activated with a mode, by the
16052 * function elm_genlist_item_mode_set().
16054 * @see elm_genlist_item_mode_set()
16055 * @see elm_genlist_mode_get()
16059 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16060 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
16061 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16068 * @defgroup Check Check
16070 * @image html img/widget/check/preview-00.png
16071 * @image latex img/widget/check/preview-00.eps
16072 * @image html img/widget/check/preview-01.png
16073 * @image latex img/widget/check/preview-01.eps
16074 * @image html img/widget/check/preview-02.png
16075 * @image latex img/widget/check/preview-02.eps
16077 * @brief The check widget allows for toggling a value between true and
16080 * Check objects are a lot like radio objects in layout and functionality
16081 * except they do not work as a group, but independently and only toggle the
16082 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
16083 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
16084 * returns the current state. For convenience, like the radio objects, you
16085 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
16086 * for it to modify.
16088 * Signals that you can add callbacks for are:
16089 * "changed" - This is called whenever the user changes the state of one of
16090 * the check object(event_info is NULL).
16092 * @ref tutorial_check should give you a firm grasp of how to use this widget.
16096 * @brief Add a new Check object
16098 * @param parent The parent object
16099 * @return The new object or NULL if it cannot be created
16101 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16103 * @brief Set the text label of the check object
16105 * @param obj The check object
16106 * @param label The text label string in UTF-8
16108 * @deprecated use elm_object_text_set() instead.
16110 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16112 * @brief Get the text label of the check object
16114 * @param obj The check object
16115 * @return The text label string in UTF-8
16117 * @deprecated use elm_object_text_get() instead.
16119 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16121 * @brief Set the icon object of the check object
16123 * @param obj The check object
16124 * @param icon The icon object
16126 * Once the icon object is set, a previously set one will be deleted.
16127 * If you want to keep that old content object, use the
16128 * elm_check_icon_unset() function.
16130 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16132 * @brief Get the icon object of the check object
16134 * @param obj The check object
16135 * @return The icon object
16137 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16139 * @brief Unset the icon used for the check object
16141 * @param obj The check object
16142 * @return The icon object that was being used
16144 * Unparent and return the icon object which was set for this widget.
16146 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16148 * @brief Set the on/off state of the check object
16150 * @param obj The check object
16151 * @param state The state to use (1 == on, 0 == off)
16153 * This sets the state of the check. If set
16154 * with elm_check_state_pointer_set() the state of that variable is also
16155 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
16157 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
16159 * @brief Get the state of the check object
16161 * @param obj The check object
16162 * @return The boolean state
16164 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16166 * @brief Set a convenience pointer to a boolean to change
16168 * @param obj The check object
16169 * @param statep Pointer to the boolean to modify
16171 * This sets a pointer to a boolean, that, in addition to the check objects
16172 * state will also be modified directly. To stop setting the object pointed
16173 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
16174 * then when this is called, the check objects state will also be modified to
16175 * reflect the value of the boolean @p statep points to, just like calling
16176 * elm_check_state_set().
16178 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
16184 * @defgroup Radio Radio
16186 * @image html img/widget/radio/preview-00.png
16187 * @image latex img/widget/radio/preview-00.eps
16189 * @brief Radio is a widget that allows for 1 or more options to be displayed
16190 * and have the user choose only 1 of them.
16192 * A radio object contains an indicator, an optional Label and an optional
16193 * icon object. While it's possible to have a group of only one radio they,
16194 * are normally used in groups of 2 or more. To add a radio to a group use
16195 * elm_radio_group_add(). The radio object(s) will select from one of a set
16196 * of integer values, so any value they are configuring needs to be mapped to
16197 * a set of integers. To configure what value that radio object represents,
16198 * use elm_radio_state_value_set() to set the integer it represents. To set
16199 * the value the whole group(which one is currently selected) is to indicate
16200 * use elm_radio_value_set() on any group member, and to get the groups value
16201 * use elm_radio_value_get(). For convenience the radio objects are also able
16202 * to directly set an integer(int) to the value that is selected. To specify
16203 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
16204 * The radio objects will modify this directly. That implies the pointer must
16205 * point to valid memory for as long as the radio objects exist.
16207 * Signals that you can add callbacks for are:
16208 * @li changed - This is called whenever the user changes the state of one of
16209 * the radio objects within the group of radio objects that work together.
16211 * @ref tutorial_radio show most of this API in action.
16215 * @brief Add a new radio to the parent
16217 * @param parent The parent object
16218 * @return The new object or NULL if it cannot be created
16220 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16222 * @brief Set the text label of the radio object
16224 * @param obj The radio object
16225 * @param label The text label string in UTF-8
16227 * @deprecated use elm_object_text_set() instead.
16229 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16231 * @brief Get the text label of the radio object
16233 * @param obj The radio object
16234 * @return The text label string in UTF-8
16236 * @deprecated use elm_object_text_set() instead.
16238 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16240 * @brief Set the icon object of the radio object
16242 * @param obj The radio object
16243 * @param icon The icon object
16245 * Once the icon object is set, a previously set one will be deleted. If you
16246 * want to keep that old content object, use the elm_radio_icon_unset()
16249 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16251 * @brief Get the icon object of the radio object
16253 * @param obj The radio object
16254 * @return The icon object
16256 * @see elm_radio_icon_set()
16258 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16260 * @brief Unset the icon used for the radio object
16262 * @param obj The radio object
16263 * @return The icon object that was being used
16265 * Unparent and return the icon object which was set for this widget.
16267 * @see elm_radio_icon_set()
16269 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16271 * @brief Add this radio to a group of other radio objects
16273 * @param obj The radio object
16274 * @param group Any object whose group the @p obj is to join.
16276 * Radio objects work in groups. Each member should have a different integer
16277 * value assigned. In order to have them work as a group, they need to know
16278 * about each other. This adds the given radio object to the group of which
16279 * the group object indicated is a member.
16281 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16283 * @brief Set the integer value that this radio object represents
16285 * @param obj The radio object
16286 * @param value The value to use if this radio object is selected
16288 * This sets the value of the radio.
16290 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16292 * @brief Get the integer value that this radio object represents
16294 * @param obj The radio object
16295 * @return The value used if this radio object is selected
16297 * This gets the value of the radio.
16299 * @see elm_radio_value_set()
16301 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16303 * @brief Set the value of the radio.
16305 * @param obj The radio object
16306 * @param value The value to use for the group
16308 * This sets the value of the radio group and will also set the value if
16309 * pointed to, to the value supplied, but will not call any callbacks.
16311 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16313 * @brief Get the state of the radio object
16315 * @param obj The radio object
16316 * @return The integer state
16318 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16320 * @brief Set a convenience pointer to a integer to change
16322 * @param obj The radio object
16323 * @param valuep Pointer to the integer to modify
16325 * This sets a pointer to a integer, that, in addition to the radio objects
16326 * state will also be modified directly. To stop setting the object pointed
16327 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16328 * when this is called, the radio objects state will also be modified to
16329 * reflect the value of the integer valuep points to, just like calling
16330 * elm_radio_value_set().
16332 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16338 * @defgroup Pager Pager
16340 * @image html img/widget/pager/preview-00.png
16341 * @image latex img/widget/pager/preview-00.eps
16343 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16345 * The flipping between “pages” of objects is animated. All content in pager
16346 * is kept in a stack, the last content to be added will be on the top of the
16347 * stack(be visible).
16349 * Objects can be pushed or popped from the stack or deleted as normal.
16350 * Pushes and pops will animate (and a pop will delete the object once the
16351 * animation is finished). Any object already in the pager can be promoted to
16352 * the top(from its current stacking position) through the use of
16353 * elm_pager_content_promote(). Objects are pushed to the top with
16354 * elm_pager_content_push() and when the top item is no longer wanted, simply
16355 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16356 * object is no longer needed and is not the top item, just delete it as
16357 * normal. You can query which objects are the top and bottom with
16358 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16360 * Signals that you can add callbacks for are:
16361 * "hide,finished" - when the previous page is hided
16363 * This widget has the following styles available:
16366 * @li fade_translucide
16367 * @li fade_invisible
16368 * @note This styles affect only the flipping animations, the appearance when
16369 * not animating is unaffected by styles.
16371 * @ref tutorial_pager gives a good overview of the usage of the API.
16375 * Add a new pager to the parent
16377 * @param parent The parent object
16378 * @return The new object or NULL if it cannot be created
16382 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16384 * @brief Push an object to the top of the pager stack (and show it).
16386 * @param obj The pager object
16387 * @param content The object to push
16389 * The object pushed becomes a child of the pager, it will be controlled and
16390 * deleted when the pager is deleted.
16392 * @note If the content is already in the stack use
16393 * elm_pager_content_promote().
16394 * @warning Using this function on @p content already in the stack results in
16395 * undefined behavior.
16397 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16399 * @brief Pop the object that is on top of the stack
16401 * @param obj The pager object
16403 * This pops the object that is on the top(visible) of the pager, makes it
16404 * disappear, then deletes the object. The object that was underneath it on
16405 * the stack will become visible.
16407 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16409 * @brief Moves an object already in the pager stack to the top of the stack.
16411 * @param obj The pager object
16412 * @param content The object to promote
16414 * This will take the @p content and move it to the top of the stack as
16415 * if it had been pushed there.
16417 * @note If the content isn't already in the stack use
16418 * elm_pager_content_push().
16419 * @warning Using this function on @p content not already in the stack
16420 * results in undefined behavior.
16422 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16424 * @brief Return the object at the bottom of the pager stack
16426 * @param obj The pager object
16427 * @return The bottom object or NULL if none
16429 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16431 * @brief Return the object at the top of the pager stack
16433 * @param obj The pager object
16434 * @return The top object or NULL if none
16436 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16442 * @defgroup Slideshow Slideshow
16444 * @image html img/widget/slideshow/preview-00.png
16445 * @image latex img/widget/slideshow/preview-00.eps
16447 * This widget, as the name indicates, is a pre-made image
16448 * slideshow panel, with API functions acting on (child) image
16449 * items presentation. Between those actions, are:
16450 * - advance to next/previous image
16451 * - select the style of image transition animation
16452 * - set the exhibition time for each image
16453 * - start/stop the slideshow
16455 * The transition animations are defined in the widget's theme,
16456 * consequently new animations can be added without having to
16457 * update the widget's code.
16459 * @section Slideshow_Items Slideshow items
16461 * For slideshow items, just like for @ref Genlist "genlist" ones,
16462 * the user defines a @b classes, specifying functions that will be
16463 * called on the item's creation and deletion times.
16465 * The #Elm_Slideshow_Item_Class structure contains the following
16468 * - @c func.get - When an item is displayed, this function is
16469 * called, and it's where one should create the item object, de
16470 * facto. For example, the object can be a pure Evas image object
16471 * or an Elementary @ref Photocam "photocam" widget. See
16472 * #SlideshowItemGetFunc.
16473 * - @c func.del - When an item is no more displayed, this function
16474 * is called, where the user must delete any data associated to
16475 * the item. See #SlideshowItemDelFunc.
16477 * @section Slideshow_Caching Slideshow caching
16479 * The slideshow provides facilities to have items adjacent to the
16480 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16481 * you, so that the system does not have to decode image data
16482 * anymore at the time it has to actually switch images on its
16483 * viewport. The user is able to set the numbers of items to be
16484 * cached @b before and @b after the current item, in the widget's
16487 * Smart events one can add callbacks for are:
16489 * - @c "changed" - when the slideshow switches its view to a new
16492 * List of examples for the slideshow widget:
16493 * @li @ref slideshow_example
16497 * @addtogroup Slideshow
16501 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16502 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16503 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16504 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16505 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16508 * @struct _Elm_Slideshow_Item_Class
16510 * Slideshow item class definition. See @ref Slideshow_Items for
16513 struct _Elm_Slideshow_Item_Class
16515 struct _Elm_Slideshow_Item_Class_Func
16517 SlideshowItemGetFunc get;
16518 SlideshowItemDelFunc del;
16520 }; /**< #Elm_Slideshow_Item_Class member definitions */
16523 * Add a new slideshow widget to the given parent Elementary
16524 * (container) object
16526 * @param parent The parent object
16527 * @return A new slideshow widget handle or @c NULL, on errors
16529 * This function inserts a new slideshow widget on the canvas.
16531 * @ingroup Slideshow
16533 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16536 * Add (append) a new item in a given slideshow widget.
16538 * @param obj The slideshow object
16539 * @param itc The item class for the item
16540 * @param data The item's data
16541 * @return A handle to the item added or @c NULL, on errors
16543 * Add a new item to @p obj's internal list of items, appending it.
16544 * The item's class must contain the function really fetching the
16545 * image object to show for this item, which could be an Evas image
16546 * object or an Elementary photo, for example. The @p data
16547 * parameter is going to be passed to both class functions of the
16550 * @see #Elm_Slideshow_Item_Class
16551 * @see elm_slideshow_item_sorted_insert()
16553 * @ingroup Slideshow
16555 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16558 * Insert a new item into the given slideshow widget, using the @p func
16559 * function to sort items (by item handles).
16561 * @param obj The slideshow object
16562 * @param itc The item class for the item
16563 * @param data The item's data
16564 * @param func The comparing function to be used to sort slideshow
16565 * items <b>by #Elm_Slideshow_Item item handles</b>
16566 * @return Returns The slideshow item handle, on success, or
16567 * @c NULL, on errors
16569 * Add a new item to @p obj's internal list of items, in a position
16570 * determined by the @p func comparing function. The item's class
16571 * must contain the function really fetching the image object to
16572 * show for this item, which could be an Evas image object or an
16573 * Elementary photo, for example. The @p data parameter is going to
16574 * be passed to both class functions of the item.
16576 * @see #Elm_Slideshow_Item_Class
16577 * @see elm_slideshow_item_add()
16579 * @ingroup Slideshow
16581 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);
16584 * Display a given slideshow widget's item, programmatically.
16586 * @param obj The slideshow object
16587 * @param item The item to display on @p obj's viewport
16589 * The change between the current item and @p item will use the
16590 * transition @p obj is set to use (@see
16591 * elm_slideshow_transition_set()).
16593 * @ingroup Slideshow
16595 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16598 * Slide to the @b next item, in a given slideshow widget
16600 * @param obj The slideshow object
16602 * The sliding animation @p obj is set to use will be the
16603 * transition effect used, after this call is issued.
16605 * @note If the end of the slideshow's internal list of items is
16606 * reached, it'll wrap around to the list's beginning, again.
16608 * @ingroup Slideshow
16610 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16613 * Slide to the @b previous item, in a given slideshow widget
16615 * @param obj The slideshow object
16617 * The sliding animation @p obj is set to use will be the
16618 * transition effect used, after this call is issued.
16620 * @note If the beginning of the slideshow's internal list of items
16621 * is reached, it'll wrap around to the list's end, again.
16623 * @ingroup Slideshow
16625 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16628 * Returns the list of sliding transition/effect names available, for a
16629 * given slideshow widget.
16631 * @param obj The slideshow object
16632 * @return The list of transitions (list of @b stringshared strings
16635 * The transitions, which come from @p obj's theme, must be an EDC
16636 * data item named @c "transitions" on the theme file, with (prefix)
16637 * names of EDC programs actually implementing them.
16639 * The available transitions for slideshows on the default theme are:
16640 * - @c "fade" - the current item fades out, while the new one
16641 * fades in to the slideshow's viewport.
16642 * - @c "black_fade" - the current item fades to black, and just
16643 * then, the new item will fade in.
16644 * - @c "horizontal" - the current item slides horizontally, until
16645 * it gets out of the slideshow's viewport, while the new item
16646 * comes from the left to take its place.
16647 * - @c "vertical" - the current item slides vertically, until it
16648 * gets out of the slideshow's viewport, while the new item comes
16649 * from the bottom to take its place.
16650 * - @c "square" - the new item starts to appear from the middle of
16651 * the current one, but with a tiny size, growing until its
16652 * target (full) size and covering the old one.
16654 * @warning The stringshared strings get no new references
16655 * exclusive to the user grabbing the list, here, so if you'd like
16656 * to use them out of this call's context, you'd better @c
16657 * eina_stringshare_ref() them.
16659 * @see elm_slideshow_transition_set()
16661 * @ingroup Slideshow
16663 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16666 * Set the current slide transition/effect in use for a given
16669 * @param obj The slideshow object
16670 * @param transition The new transition's name string
16672 * If @p transition is implemented in @p obj's theme (i.e., is
16673 * contained in the list returned by
16674 * elm_slideshow_transitions_get()), this new sliding effect will
16675 * be used on the widget.
16677 * @see elm_slideshow_transitions_get() for more details
16679 * @ingroup Slideshow
16681 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16684 * Get the current slide transition/effect in use for a given
16687 * @param obj The slideshow object
16688 * @return The current transition's name
16690 * @see elm_slideshow_transition_set() for more details
16692 * @ingroup Slideshow
16694 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16697 * Set the interval between each image transition on a given
16698 * slideshow widget, <b>and start the slideshow, itself</b>
16700 * @param obj The slideshow object
16701 * @param timeout The new displaying timeout for images
16703 * After this call, the slideshow widget will start cycling its
16704 * view, sequentially and automatically, with the images of the
16705 * items it has. The time between each new image displayed is going
16706 * to be @p timeout, in @b seconds. If a different timeout was set
16707 * previously and an slideshow was in progress, it will continue
16708 * with the new time between transitions, after this call.
16710 * @note A value less than or equal to 0 on @p timeout will disable
16711 * the widget's internal timer, thus halting any slideshow which
16712 * could be happening on @p obj.
16714 * @see elm_slideshow_timeout_get()
16716 * @ingroup Slideshow
16718 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16721 * Get the interval set for image transitions on a given slideshow
16724 * @param obj The slideshow object
16725 * @return Returns the timeout set on it
16727 * @see elm_slideshow_timeout_set() for more details
16729 * @ingroup Slideshow
16731 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16734 * Set if, after a slideshow is started, for a given slideshow
16735 * widget, its items should be displayed cyclically or not.
16737 * @param obj The slideshow object
16738 * @param loop Use @c EINA_TRUE to make it cycle through items or
16739 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16742 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16743 * ignore what is set by this functions, i.e., they'll @b always
16744 * cycle through items. This affects only the "automatic"
16745 * slideshow, as set by elm_slideshow_timeout_set().
16747 * @see elm_slideshow_loop_get()
16749 * @ingroup Slideshow
16751 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16754 * Get if, after a slideshow is started, for a given slideshow
16755 * widget, its items are to be displayed cyclically or not.
16757 * @param obj The slideshow object
16758 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16759 * through or @c EINA_FALSE, otherwise
16761 * @see elm_slideshow_loop_set() for more details
16763 * @ingroup Slideshow
16765 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16768 * Remove all items from a given slideshow widget
16770 * @param obj The slideshow object
16772 * This removes (and deletes) all items in @p obj, leaving it
16775 * @see elm_slideshow_item_del(), to remove just one item.
16777 * @ingroup Slideshow
16779 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16782 * Get the internal list of items in a given slideshow widget.
16784 * @param obj The slideshow object
16785 * @return The list of items (#Elm_Slideshow_Item as data) or
16786 * @c NULL on errors.
16788 * This list is @b not to be modified in any way and must not be
16789 * freed. Use the list members with functions like
16790 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16792 * @warning This list is only valid until @p obj object's internal
16793 * items list is changed. It should be fetched again with another
16794 * call to this function when changes happen.
16796 * @ingroup Slideshow
16798 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16801 * Delete a given item from a slideshow widget.
16803 * @param item The slideshow item
16805 * @ingroup Slideshow
16807 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16810 * Return the data associated with a given slideshow item
16812 * @param item The slideshow item
16813 * @return Returns the data associated to this item
16815 * @ingroup Slideshow
16817 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16820 * Returns the currently displayed item, in a given slideshow widget
16822 * @param obj The slideshow object
16823 * @return A handle to the item being displayed in @p obj or
16824 * @c NULL, if none is (and on errors)
16826 * @ingroup Slideshow
16828 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16831 * Get the real Evas object created to implement the view of a
16832 * given slideshow item
16834 * @param item The slideshow item.
16835 * @return the Evas object implementing this item's view.
16837 * This returns the actual Evas object used to implement the
16838 * specified slideshow item's view. This may be @c NULL, as it may
16839 * not have been created or may have been deleted, at any time, by
16840 * the slideshow. <b>Do not modify this object</b> (move, resize,
16841 * show, hide, etc.), as the slideshow is controlling it. This
16842 * function is for querying, emitting custom signals or hooking
16843 * lower level callbacks for events on that object. Do not delete
16844 * this object under any circumstances.
16846 * @see elm_slideshow_item_data_get()
16848 * @ingroup Slideshow
16850 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16853 * Get the the item, in a given slideshow widget, placed at
16854 * position @p nth, in its internal items list
16856 * @param obj The slideshow object
16857 * @param nth The number of the item to grab a handle to (0 being
16859 * @return The item stored in @p obj at position @p nth or @c NULL,
16860 * if there's no item with that index (and on errors)
16862 * @ingroup Slideshow
16864 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16867 * Set the current slide layout in use for a given slideshow widget
16869 * @param obj The slideshow object
16870 * @param layout The new layout's name string
16872 * If @p layout is implemented in @p obj's theme (i.e., is contained
16873 * in the list returned by elm_slideshow_layouts_get()), this new
16874 * images layout will be used on the widget.
16876 * @see elm_slideshow_layouts_get() for more details
16878 * @ingroup Slideshow
16880 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16883 * Get the current slide layout in use for a given slideshow widget
16885 * @param obj The slideshow object
16886 * @return The current layout's name
16888 * @see elm_slideshow_layout_set() for more details
16890 * @ingroup Slideshow
16892 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16895 * Returns the list of @b layout names available, for a given
16896 * slideshow widget.
16898 * @param obj The slideshow object
16899 * @return The list of layouts (list of @b stringshared strings
16902 * Slideshow layouts will change how the widget is to dispose each
16903 * image item in its viewport, with regard to cropping, scaling,
16906 * The layouts, which come from @p obj's theme, must be an EDC
16907 * data item name @c "layouts" on the theme file, with (prefix)
16908 * names of EDC programs actually implementing them.
16910 * The available layouts for slideshows on the default theme are:
16911 * - @c "fullscreen" - item images with original aspect, scaled to
16912 * touch top and down slideshow borders or, if the image's heigh
16913 * is not enough, left and right slideshow borders.
16914 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16915 * one, but always leaving 10% of the slideshow's dimensions of
16916 * distance between the item image's borders and the slideshow
16917 * borders, for each axis.
16919 * @warning The stringshared strings get no new references
16920 * exclusive to the user grabbing the list, here, so if you'd like
16921 * to use them out of this call's context, you'd better @c
16922 * eina_stringshare_ref() them.
16924 * @see elm_slideshow_layout_set()
16926 * @ingroup Slideshow
16928 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16931 * Set the number of items to cache, on a given slideshow widget,
16932 * <b>before the current item</b>
16934 * @param obj The slideshow object
16935 * @param count Number of items to cache before the current one
16937 * The default value for this property is @c 2. See
16938 * @ref Slideshow_Caching "slideshow caching" for more details.
16940 * @see elm_slideshow_cache_before_get()
16942 * @ingroup Slideshow
16944 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16947 * Retrieve the number of items to cache, on a given slideshow widget,
16948 * <b>before the current item</b>
16950 * @param obj The slideshow object
16951 * @return The number of items set to be cached before the current one
16953 * @see elm_slideshow_cache_before_set() for more details
16955 * @ingroup Slideshow
16957 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16960 * Set the number of items to cache, on a given slideshow widget,
16961 * <b>after the current item</b>
16963 * @param obj The slideshow object
16964 * @param count Number of items to cache after the current one
16966 * The default value for this property is @c 2. See
16967 * @ref Slideshow_Caching "slideshow caching" for more details.
16969 * @see elm_slideshow_cache_after_get()
16971 * @ingroup Slideshow
16973 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16976 * Retrieve the number of items to cache, on a given slideshow widget,
16977 * <b>after the current item</b>
16979 * @param obj The slideshow object
16980 * @return The number of items set to be cached after the current one
16982 * @see elm_slideshow_cache_after_set() for more details
16984 * @ingroup Slideshow
16986 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16989 * Get the number of items stored in a given slideshow widget
16991 * @param obj The slideshow object
16992 * @return The number of items on @p obj, at the moment of this call
16994 * @ingroup Slideshow
16996 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17003 * @defgroup Fileselector File Selector
17005 * @image html img/widget/fileselector/preview-00.png
17006 * @image latex img/widget/fileselector/preview-00.eps
17008 * A file selector is a widget that allows a user to navigate
17009 * through a file system, reporting file selections back via its
17012 * It contains shortcut buttons for home directory (@c ~) and to
17013 * jump one directory upwards (..), as well as cancel/ok buttons to
17014 * confirm/cancel a given selection. After either one of those two
17015 * former actions, the file selector will issue its @c "done" smart
17018 * There's a text entry on it, too, showing the name of the current
17019 * selection. There's the possibility of making it editable, so it
17020 * is useful on file saving dialogs on applications, where one
17021 * gives a file name to save contents to, in a given directory in
17022 * the system. This custom file name will be reported on the @c
17023 * "done" smart callback (explained in sequence).
17025 * Finally, it has a view to display file system items into in two
17030 * If Elementary is built with support of the Ethumb thumbnailing
17031 * library, the second form of view will display preview thumbnails
17032 * of files which it supports.
17034 * Smart callbacks one can register to:
17036 * - @c "selected" - the user has clicked on a file (when not in
17037 * folders-only mode) or directory (when in folders-only mode)
17038 * - @c "directory,open" - the list has been populated with new
17039 * content (@c event_info is a pointer to the directory's
17040 * path, a @b stringshared string)
17041 * - @c "done" - the user has clicked on the "ok" or "cancel"
17042 * buttons (@c event_info is a pointer to the selection's
17043 * path, a @b stringshared string)
17045 * Here is an example on its usage:
17046 * @li @ref fileselector_example
17050 * @addtogroup Fileselector
17055 * Defines how a file selector widget is to layout its contents
17056 * (file system entries).
17058 typedef enum _Elm_Fileselector_Mode
17060 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
17061 ELM_FILESELECTOR_GRID, /**< layout as a grid */
17062 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
17063 } Elm_Fileselector_Mode;
17066 * Add a new file selector widget to the given parent Elementary
17067 * (container) object
17069 * @param parent The parent object
17070 * @return a new file selector widget handle or @c NULL, on errors
17072 * This function inserts a new file selector widget on the canvas.
17074 * @ingroup Fileselector
17076 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17079 * Enable/disable the file name entry box where the user can type
17080 * in a name for a file, in a given file selector widget
17082 * @param obj The file selector object
17083 * @param is_save @c EINA_TRUE to make the file selector a "saving
17084 * dialog", @c EINA_FALSE otherwise
17086 * Having the entry editable is useful on file saving dialogs on
17087 * applications, where one gives a file name to save contents to,
17088 * in a given directory in the system. This custom file name will
17089 * be reported on the @c "done" smart callback.
17091 * @see elm_fileselector_is_save_get()
17093 * @ingroup Fileselector
17095 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
17098 * Get whether the given file selector is in "saving dialog" mode
17100 * @param obj The file selector object
17101 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
17102 * mode, @c EINA_FALSE otherwise (and on errors)
17104 * @see elm_fileselector_is_save_set() for more details
17106 * @ingroup Fileselector
17108 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17111 * Enable/disable folder-only view for a given file selector widget
17113 * @param obj The file selector object
17114 * @param only @c EINA_TRUE to make @p obj only display
17115 * directories, @c EINA_FALSE to make files to be displayed in it
17118 * If enabled, the widget's view will only display folder items,
17121 * @see elm_fileselector_folder_only_get()
17123 * @ingroup Fileselector
17125 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
17128 * Get whether folder-only view is set for a given file selector
17131 * @param obj The file selector object
17132 * @return only @c EINA_TRUE if @p obj is only displaying
17133 * directories, @c EINA_FALSE if files are being displayed in it
17134 * too (and on errors)
17136 * @see elm_fileselector_folder_only_get()
17138 * @ingroup Fileselector
17140 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17143 * Enable/disable the "ok" and "cancel" buttons on a given file
17146 * @param obj The file selector object
17147 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
17149 * @note A file selector without those buttons will never emit the
17150 * @c "done" smart event, and is only usable if one is just hooking
17151 * to the other two events.
17153 * @see elm_fileselector_buttons_ok_cancel_get()
17155 * @ingroup Fileselector
17157 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
17160 * Get whether the "ok" and "cancel" buttons on a given file
17161 * selector widget are being shown.
17163 * @param obj The file selector object
17164 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
17165 * otherwise (and on errors)
17167 * @see elm_fileselector_buttons_ok_cancel_set() for more details
17169 * @ingroup Fileselector
17171 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17174 * Enable/disable a tree view in the given file selector widget,
17175 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
17177 * @param obj The file selector object
17178 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
17181 * In a tree view, arrows are created on the sides of directories,
17182 * allowing them to expand in place.
17184 * @note If it's in other mode, the changes made by this function
17185 * will only be visible when one switches back to "list" mode.
17187 * @see elm_fileselector_expandable_get()
17189 * @ingroup Fileselector
17191 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
17194 * Get whether tree view is enabled for the given file selector
17197 * @param obj The file selector object
17198 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
17199 * otherwise (and or errors)
17201 * @see elm_fileselector_expandable_set() for more details
17203 * @ingroup Fileselector
17205 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17208 * Set, programmatically, the @b directory that a given file
17209 * selector widget will display contents from
17211 * @param obj The file selector object
17212 * @param path The path to display in @p obj
17214 * This will change the @b directory that @p obj is displaying. It
17215 * will also clear the text entry area on the @p obj object, which
17216 * displays select files' names.
17218 * @see elm_fileselector_path_get()
17220 * @ingroup Fileselector
17222 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17225 * Get the parent directory's path that a given file selector
17226 * widget is displaying
17228 * @param obj The file selector object
17229 * @return The (full) path of the directory the file selector is
17230 * displaying, a @b stringshared string
17232 * @see elm_fileselector_path_set()
17234 * @ingroup Fileselector
17236 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17239 * Set, programmatically, the currently selected file/directory in
17240 * the given file selector widget
17242 * @param obj The file selector object
17243 * @param path The (full) path to a file or directory
17244 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
17245 * latter case occurs if the directory or file pointed to do not
17248 * @see elm_fileselector_selected_get()
17250 * @ingroup Fileselector
17252 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17255 * Get the currently selected item's (full) path, in the given file
17258 * @param obj The file selector object
17259 * @return The absolute path of the selected item, a @b
17260 * stringshared string
17262 * @note Custom editions on @p obj object's text entry, if made,
17263 * will appear on the return string of this function, naturally.
17265 * @see elm_fileselector_selected_set() for more details
17267 * @ingroup Fileselector
17269 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17272 * Set the mode in which a given file selector widget will display
17273 * (layout) file system entries in its view
17275 * @param obj The file selector object
17276 * @param mode The mode of the fileselector, being it one of
17277 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17278 * first one, naturally, will display the files in a list. The
17279 * latter will make the widget to display its entries in a grid
17282 * @note By using elm_fileselector_expandable_set(), the user may
17283 * trigger a tree view for that list.
17285 * @note If Elementary is built with support of the Ethumb
17286 * thumbnailing library, the second form of view will display
17287 * preview thumbnails of files which it supports. You must have
17288 * elm_need_ethumb() called in your Elementary for thumbnailing to
17291 * @see elm_fileselector_expandable_set().
17292 * @see elm_fileselector_mode_get().
17294 * @ingroup Fileselector
17296 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17299 * Get the mode in which a given file selector widget is displaying
17300 * (layouting) file system entries in its view
17302 * @param obj The fileselector object
17303 * @return The mode in which the fileselector is at
17305 * @see elm_fileselector_mode_set() for more details
17307 * @ingroup Fileselector
17309 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17316 * @defgroup Progressbar Progress bar
17318 * The progress bar is a widget for visually representing the
17319 * progress status of a given job/task.
17321 * A progress bar may be horizontal or vertical. It may display an
17322 * icon besides it, as well as primary and @b units labels. The
17323 * former is meant to label the widget as a whole, while the
17324 * latter, which is formatted with floating point values (and thus
17325 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17326 * units"</c>), is meant to label the widget's <b>progress
17327 * value</b>. Label, icon and unit strings/objects are @b optional
17328 * for progress bars.
17330 * A progress bar may be @b inverted, in which state it gets its
17331 * values inverted, with high values being on the left or top and
17332 * low values on the right or bottom, as opposed to normally have
17333 * the low values on the former and high values on the latter,
17334 * respectively, for horizontal and vertical modes.
17336 * The @b span of the progress, as set by
17337 * elm_progressbar_span_size_set(), is its length (horizontally or
17338 * vertically), unless one puts size hints on the widget to expand
17339 * on desired directions, by any container. That length will be
17340 * scaled by the object or applications scaling factor. At any
17341 * point code can query the progress bar for its value with
17342 * elm_progressbar_value_get().
17344 * Available widget styles for progress bars:
17346 * - @c "wheel" (simple style, no text, no progression, only
17347 * "pulse" effect is available)
17349 * Here is an example on its usage:
17350 * @li @ref progressbar_example
17354 * Add a new progress bar widget to the given parent Elementary
17355 * (container) object
17357 * @param parent The parent object
17358 * @return a new progress bar widget handle or @c NULL, on errors
17360 * This function inserts a new progress bar widget on the canvas.
17362 * @ingroup Progressbar
17364 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17367 * Set whether a given progress bar widget is at "pulsing mode" or
17370 * @param obj The progress bar object
17371 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17372 * @c EINA_FALSE to put it back to its default one
17374 * By default, progress bars will display values from the low to
17375 * high value boundaries. There are, though, contexts in which the
17376 * state of progression of a given task is @b unknown. For those,
17377 * one can set a progress bar widget to a "pulsing state", to give
17378 * the user an idea that some computation is being held, but
17379 * without exact progress values. In the default theme it will
17380 * animate its bar with the contents filling in constantly and back
17381 * to non-filled, in a loop. To start and stop this pulsing
17382 * animation, one has to explicitly call elm_progressbar_pulse().
17384 * @see elm_progressbar_pulse_get()
17385 * @see elm_progressbar_pulse()
17387 * @ingroup Progressbar
17389 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17392 * Get whether a given progress bar widget is at "pulsing mode" or
17395 * @param obj The progress bar object
17396 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17397 * if it's in the default one (and on errors)
17399 * @ingroup Progressbar
17401 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17404 * Start/stop a given progress bar "pulsing" animation, if its
17407 * @param obj The progress bar object
17408 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17409 * @c EINA_FALSE to @b stop it
17411 * @note This call won't do anything if @p obj is not under "pulsing mode".
17413 * @see elm_progressbar_pulse_set() for more details.
17415 * @ingroup Progressbar
17417 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17420 * Set the progress value (in percentage) on a given progress bar
17423 * @param obj The progress bar object
17424 * @param val The progress value (@b must be between @c 0.0 and @c
17427 * Use this call to set progress bar levels.
17429 * @note If you passes a value out of the specified range for @p
17430 * val, it will be interpreted as the @b closest of the @b boundary
17431 * values in the range.
17433 * @ingroup Progressbar
17435 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17438 * Get the progress value (in percentage) on a given progress bar
17441 * @param obj The progress bar object
17442 * @return The value of the progressbar
17444 * @see elm_progressbar_value_set() for more details
17446 * @ingroup Progressbar
17448 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17451 * Set the label of a given progress bar widget
17453 * @param obj The progress bar object
17454 * @param label The text label string, in UTF-8
17456 * @ingroup Progressbar
17457 * @deprecated use elm_object_text_set() instead.
17459 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17462 * Get the label of a given progress bar widget
17464 * @param obj The progressbar object
17465 * @return The text label string, in UTF-8
17467 * @ingroup Progressbar
17468 * @deprecated use elm_object_text_set() instead.
17470 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17473 * Set the icon object of a given progress bar widget
17475 * @param obj The progress bar object
17476 * @param icon The icon object
17478 * Use this call to decorate @p obj with an icon next to it.
17480 * @note Once the icon object is set, a previously set one will be
17481 * deleted. If you want to keep that old content object, use the
17482 * elm_progressbar_icon_unset() function.
17484 * @see elm_progressbar_icon_get()
17486 * @ingroup Progressbar
17488 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17491 * Retrieve the icon object set for a given progress bar widget
17493 * @param obj The progress bar object
17494 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17495 * otherwise (and on errors)
17497 * @see elm_progressbar_icon_set() for more details
17499 * @ingroup Progressbar
17501 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17504 * Unset an icon set on a given progress bar widget
17506 * @param obj The progress bar object
17507 * @return The icon object that was being used, if any was set, or
17508 * @c NULL, otherwise (and on errors)
17510 * This call will unparent and return the icon object which was set
17511 * for this widget, previously, on success.
17513 * @see elm_progressbar_icon_set() for more details
17515 * @ingroup Progressbar
17517 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17520 * Set the (exact) length of the bar region of a given progress bar
17523 * @param obj The progress bar object
17524 * @param size The length of the progress bar's bar region
17526 * This sets the minimum width (when in horizontal mode) or height
17527 * (when in vertical mode) of the actual bar area of the progress
17528 * bar @p obj. This in turn affects the object's minimum size. Use
17529 * this when you're not setting other size hints expanding on the
17530 * given direction (like weight and alignment hints) and you would
17531 * like it to have a specific size.
17533 * @note Icon, label and unit text around @p obj will require their
17534 * own space, which will make @p obj to require more the @p size,
17537 * @see elm_progressbar_span_size_get()
17539 * @ingroup Progressbar
17541 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17544 * Get the length set for the bar region of a given progress bar
17547 * @param obj The progress bar object
17548 * @return The length of the progress bar's bar region
17550 * If that size was not set previously, with
17551 * elm_progressbar_span_size_set(), this call will return @c 0.
17553 * @ingroup Progressbar
17555 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17558 * Set the format string for a given progress bar widget's units
17561 * @param obj The progress bar object
17562 * @param format The format string for @p obj's units label
17564 * If @c NULL is passed on @p format, it will make @p obj's units
17565 * area to be hidden completely. If not, it'll set the <b>format
17566 * string</b> for the units label's @b text. The units label is
17567 * provided a floating point value, so the units text is up display
17568 * at most one floating point falue. Note that the units label is
17569 * optional. Use a format string such as "%1.2f meters" for
17572 * @note The default format string for a progress bar is an integer
17573 * percentage, as in @c "%.0f %%".
17575 * @see elm_progressbar_unit_format_get()
17577 * @ingroup Progressbar
17579 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17582 * Retrieve the format string set for a given progress bar widget's
17585 * @param obj The progress bar object
17586 * @return The format set string for @p obj's units label or
17587 * @c NULL, if none was set (and on errors)
17589 * @see elm_progressbar_unit_format_set() for more details
17591 * @ingroup Progressbar
17593 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17596 * Set the orientation of a given progress bar widget
17598 * @param obj The progress bar object
17599 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17600 * @b horizontal, @c EINA_FALSE to make it @b vertical
17602 * Use this function to change how your progress bar is to be
17603 * disposed: vertically or horizontally.
17605 * @see elm_progressbar_horizontal_get()
17607 * @ingroup Progressbar
17609 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17612 * Retrieve the orientation of a given progress bar widget
17614 * @param obj The progress bar object
17615 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17616 * @c EINA_FALSE if it's @b vertical (and on errors)
17618 * @see elm_progressbar_horizontal_set() for more details
17620 * @ingroup Progressbar
17622 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17625 * Invert a given progress bar widget's displaying values order
17627 * @param obj The progress bar object
17628 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17629 * @c EINA_FALSE to bring it back to default, non-inverted values.
17631 * A progress bar may be @b inverted, in which state it gets its
17632 * values inverted, with high values being on the left or top and
17633 * low values on the right or bottom, as opposed to normally have
17634 * the low values on the former and high values on the latter,
17635 * respectively, for horizontal and vertical modes.
17637 * @see elm_progressbar_inverted_get()
17639 * @ingroup Progressbar
17641 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17644 * Get whether a given progress bar widget's displaying values are
17647 * @param obj The progress bar object
17648 * @return @c EINA_TRUE, if @p obj has inverted values,
17649 * @c EINA_FALSE otherwise (and on errors)
17651 * @see elm_progressbar_inverted_set() for more details
17653 * @ingroup Progressbar
17655 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17658 * @defgroup Separator Separator
17660 * @brief Separator is a very thin object used to separate other objects.
17662 * A separator can be vertical or horizontal.
17664 * @ref tutorial_separator is a good example of how to use a separator.
17668 * @brief Add a separator object to @p parent
17670 * @param parent The parent object
17672 * @return The separator object, or NULL upon failure
17674 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17676 * @brief Set the horizontal mode of a separator object
17678 * @param obj The separator object
17679 * @param horizontal If true, the separator is horizontal
17681 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17683 * @brief Get the horizontal mode of a separator object
17685 * @param obj The separator object
17686 * @return If true, the separator is horizontal
17688 * @see elm_separator_horizontal_set()
17690 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17696 * @defgroup Spinner Spinner
17697 * @ingroup Elementary
17699 * @image html img/widget/spinner/preview-00.png
17700 * @image latex img/widget/spinner/preview-00.eps
17702 * A spinner is a widget which allows the user to increase or decrease
17703 * numeric values using arrow buttons, or edit values directly, clicking
17704 * over it and typing the new value.
17706 * By default the spinner will not wrap and has a label
17707 * of "%.0f" (just showing the integer value of the double).
17709 * A spinner has a label that is formatted with floating
17710 * point values and thus accepts a printf-style format string, like
17713 * It also allows specific values to be replaced by pre-defined labels.
17715 * Smart callbacks one can register to:
17717 * - "changed" - Whenever the spinner value is changed.
17718 * - "delay,changed" - A short time after the value is changed by the user.
17719 * This will be called only when the user stops dragging for a very short
17720 * period or when they release their finger/mouse, so it avoids possibly
17721 * expensive reactions to the value change.
17723 * Available styles for it:
17725 * - @c "vertical": up/down buttons at the right side and text left aligned.
17727 * Here is an example on its usage:
17728 * @ref spinner_example
17732 * @addtogroup Spinner
17737 * Add a new spinner widget to the given parent Elementary
17738 * (container) object.
17740 * @param parent The parent object.
17741 * @return a new spinner widget handle or @c NULL, on errors.
17743 * This function inserts a new spinner widget on the canvas.
17748 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17751 * Set the format string of the displayed label.
17753 * @param obj The spinner object.
17754 * @param fmt The format string for the label display.
17756 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17757 * string for the label text. The label text is provided a floating point
17758 * value, so the label text can display up to 1 floating point value.
17759 * Note that this is optional.
17761 * Use a format string such as "%1.2f meters" for example, and it will
17762 * display values like: "3.14 meters" for a value equal to 3.14159.
17764 * Default is "%0.f".
17766 * @see elm_spinner_label_format_get()
17770 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17773 * Get the label format of the spinner.
17775 * @param obj The spinner object.
17776 * @return The text label format string in UTF-8.
17778 * @see elm_spinner_label_format_set() for details.
17782 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17785 * Set the minimum and maximum values for the spinner.
17787 * @param obj The spinner object.
17788 * @param min The minimum value.
17789 * @param max The maximum value.
17791 * Define the allowed range of values to be selected by the user.
17793 * If actual value is less than @p min, it will be updated to @p min. If it
17794 * is bigger then @p max, will be updated to @p max. Actual value can be
17795 * get with elm_spinner_value_get().
17797 * By default, min is equal to 0, and max is equal to 100.
17799 * @warning Maximum must be greater than minimum.
17801 * @see elm_spinner_min_max_get()
17805 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17808 * Get the minimum and maximum values of the spinner.
17810 * @param obj The spinner object.
17811 * @param min Pointer where to store the minimum value.
17812 * @param max Pointer where to store the maximum value.
17814 * @note If only one value is needed, the other pointer can be passed
17817 * @see elm_spinner_min_max_set() for details.
17821 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17824 * Set the step used to increment or decrement the spinner value.
17826 * @param obj The spinner object.
17827 * @param step The step value.
17829 * This value will be incremented or decremented to the displayed value.
17830 * It will be incremented while the user keep right or top arrow pressed,
17831 * and will be decremented while the user keep left or bottom arrow pressed.
17833 * The interval to increment / decrement can be set with
17834 * elm_spinner_interval_set().
17836 * By default step value is equal to 1.
17838 * @see elm_spinner_step_get()
17842 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17845 * Get the step used to increment or decrement the spinner value.
17847 * @param obj The spinner object.
17848 * @return The step value.
17850 * @see elm_spinner_step_get() for more details.
17854 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17857 * Set the value the spinner displays.
17859 * @param obj The spinner object.
17860 * @param val The value to be displayed.
17862 * Value will be presented on the label following format specified with
17863 * elm_spinner_format_set().
17865 * @warning The value must to be between min and max values. This values
17866 * are set by elm_spinner_min_max_set().
17868 * @see elm_spinner_value_get().
17869 * @see elm_spinner_format_set().
17870 * @see elm_spinner_min_max_set().
17874 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17877 * Get the value displayed by the spinner.
17879 * @param obj The spinner object.
17880 * @return The value displayed.
17882 * @see elm_spinner_value_set() for details.
17886 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17889 * Set whether the spinner should wrap when it reaches its
17890 * minimum or maximum value.
17892 * @param obj The spinner object.
17893 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17896 * Disabled by default. If disabled, when the user tries to increment the
17898 * but displayed value plus step value is bigger than maximum value,
17900 * won't allow it. The same happens when the user tries to decrement it,
17901 * but the value less step is less than minimum value.
17903 * When wrap is enabled, in such situations it will allow these changes,
17904 * but will get the value that would be less than minimum and subtracts
17905 * from maximum. Or add the value that would be more than maximum to
17909 * @li min value = 10
17910 * @li max value = 50
17911 * @li step value = 20
17912 * @li displayed value = 20
17914 * When the user decrement value (using left or bottom arrow), it will
17915 * displays @c 40, because max - (min - (displayed - step)) is
17916 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17918 * @see elm_spinner_wrap_get().
17922 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17925 * Get whether the spinner should wrap when it reaches its
17926 * minimum or maximum value.
17928 * @param obj The spinner object
17929 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17930 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17932 * @see elm_spinner_wrap_set() for details.
17936 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17939 * Set whether the spinner can be directly edited by the user or not.
17941 * @param obj The spinner object.
17942 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17943 * don't allow users to edit it directly.
17945 * Spinner objects can have edition @b disabled, in which state they will
17946 * be changed only by arrows.
17947 * Useful for contexts
17948 * where you don't want your users to interact with it writting the value.
17950 * when using special values, the user can see real value instead
17951 * of special label on edition.
17953 * It's enabled by default.
17955 * @see elm_spinner_editable_get()
17959 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17962 * Get whether the spinner can be directly edited by the user or not.
17964 * @param obj The spinner object.
17965 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17966 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17968 * @see elm_spinner_editable_set() for details.
17972 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17975 * Set a special string to display in the place of the numerical value.
17977 * @param obj The spinner object.
17978 * @param value The value to be replaced.
17979 * @param label The label to be used.
17981 * It's useful for cases when a user should select an item that is
17982 * better indicated by a label than a value. For example, weekdays or months.
17986 * sp = elm_spinner_add(win);
17987 * elm_spinner_min_max_set(sp, 1, 3);
17988 * elm_spinner_special_value_add(sp, 1, "January");
17989 * elm_spinner_special_value_add(sp, 2, "February");
17990 * elm_spinner_special_value_add(sp, 3, "March");
17991 * evas_object_show(sp);
17996 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17999 * Set the interval on time updates for an user mouse button hold
18000 * on spinner widgets' arrows.
18002 * @param obj The spinner object.
18003 * @param interval The (first) interval value in seconds.
18005 * This interval value is @b decreased while the user holds the
18006 * mouse pointer either incrementing or decrementing spinner's value.
18008 * This helps the user to get to a given value distant from the
18009 * current one easier/faster, as it will start to change quicker and
18010 * quicker on mouse button holds.
18012 * The calculation for the next change interval value, starting from
18013 * the one set with this call, is the previous interval divided by
18014 * @c 1.05, so it decreases a little bit.
18016 * The default starting interval value for automatic changes is
18019 * @see elm_spinner_interval_get()
18023 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
18026 * Get the interval on time updates for an user mouse button hold
18027 * on spinner widgets' arrows.
18029 * @param obj The spinner object.
18030 * @return The (first) interval value, in seconds, set on it.
18032 * @see elm_spinner_interval_set() for more details.
18036 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18043 * @defgroup Index Index
18045 * @image html img/widget/index/preview-00.png
18046 * @image latex img/widget/index/preview-00.eps
18048 * An index widget gives you an index for fast access to whichever
18049 * group of other UI items one might have. It's a list of text
18050 * items (usually letters, for alphabetically ordered access).
18052 * Index widgets are by default hidden and just appear when the
18053 * user clicks over it's reserved area in the canvas. In its
18054 * default theme, it's an area one @ref Fingers "finger" wide on
18055 * the right side of the index widget's container.
18057 * When items on the index are selected, smart callbacks get
18058 * called, so that its user can make other container objects to
18059 * show a given area or child object depending on the index item
18060 * selected. You'd probably be using an index together with @ref
18061 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
18064 * Smart events one can add callbacks for are:
18065 * - @c "changed" - When the selected index item changes. @c
18066 * event_info is the selected item's data pointer.
18067 * - @c "delay,changed" - When the selected index item changes, but
18068 * after a small idling period. @c event_info is the selected
18069 * item's data pointer.
18070 * - @c "selected" - When the user releases a mouse button and
18071 * selects an item. @c event_info is the selected item's data
18073 * - @c "level,up" - when the user moves a finger from the first
18074 * level to the second level
18075 * - @c "level,down" - when the user moves a finger from the second
18076 * level to the first level
18078 * The @c "delay,changed" event is so that it'll wait a small time
18079 * before actually reporting those events and, moreover, just the
18080 * last event happening on those time frames will actually be
18083 * Here are some examples on its usage:
18084 * @li @ref index_example_01
18085 * @li @ref index_example_02
18089 * @addtogroup Index
18093 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
18096 * Add a new index widget to the given parent Elementary
18097 * (container) object
18099 * @param parent The parent object
18100 * @return a new index widget handle or @c NULL, on errors
18102 * This function inserts a new index widget on the canvas.
18106 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18109 * Set whether a given index widget is or not visible,
18112 * @param obj The index object
18113 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
18115 * Not to be confused with visible as in @c evas_object_show() --
18116 * visible with regard to the widget's auto hiding feature.
18118 * @see elm_index_active_get()
18122 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
18125 * Get whether a given index widget is currently visible or not.
18127 * @param obj The index object
18128 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
18130 * @see elm_index_active_set() for more details
18134 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18137 * Set the items level for a given index widget.
18139 * @param obj The index object.
18140 * @param level @c 0 or @c 1, the currently implemented levels.
18142 * @see elm_index_item_level_get()
18146 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18149 * Get the items level set for a given index widget.
18151 * @param obj The index object.
18152 * @return @c 0 or @c 1, which are the levels @p obj might be at.
18154 * @see elm_index_item_level_set() for more information
18158 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18161 * Returns the last selected item's data, for a given index widget.
18163 * @param obj The index object.
18164 * @return The item @b data associated to the last selected item on
18165 * @p obj (or @c NULL, on errors).
18167 * @warning The returned value is @b not an #Elm_Index_Item item
18168 * handle, but the data associated to it (see the @c item parameter
18169 * in elm_index_item_append(), as an example).
18173 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18176 * Append a new item on a given index widget.
18178 * @param obj The index object.
18179 * @param letter Letter under which the item should be indexed
18180 * @param item The item data to set for the index's item
18182 * Despite the most common usage of the @p letter argument is for
18183 * single char strings, one could use arbitrary strings as index
18186 * @c item will be the pointer returned back on @c "changed", @c
18187 * "delay,changed" and @c "selected" smart events.
18191 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18194 * Prepend a new item on a given index widget.
18196 * @param obj The index object.
18197 * @param letter Letter under which the item should be indexed
18198 * @param item The item data to set for the index's item
18200 * Despite the most common usage of the @p letter argument is for
18201 * single char strings, one could use arbitrary strings as index
18204 * @c item will be the pointer returned back on @c "changed", @c
18205 * "delay,changed" and @c "selected" smart events.
18209 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18212 * Append a new item, on a given index widget, <b>after the item
18213 * having @p relative as data</b>.
18215 * @param obj The index object.
18216 * @param letter Letter under which the item should be indexed
18217 * @param item The item data to set for the index's item
18218 * @param relative The item data of the index item to be the
18219 * predecessor of this new one
18221 * Despite the most common usage of the @p letter argument is for
18222 * single char strings, one could use arbitrary strings as index
18225 * @c item will be the pointer returned back on @c "changed", @c
18226 * "delay,changed" and @c "selected" smart events.
18228 * @note If @p relative is @c NULL or if it's not found to be data
18229 * set on any previous item on @p obj, this function will behave as
18230 * elm_index_item_append().
18234 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18237 * Prepend a new item, on a given index widget, <b>after the item
18238 * having @p relative as data</b>.
18240 * @param obj The index object.
18241 * @param letter Letter under which the item should be indexed
18242 * @param item The item data to set for the index's item
18243 * @param relative The item data of the index item to be the
18244 * successor of this new one
18246 * Despite the most common usage of the @p letter argument is for
18247 * single char strings, one could use arbitrary strings as index
18250 * @c item will be the pointer returned back on @c "changed", @c
18251 * "delay,changed" and @c "selected" smart events.
18253 * @note If @p relative is @c NULL or if it's not found to be data
18254 * set on any previous item on @p obj, this function will behave as
18255 * elm_index_item_prepend().
18259 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18262 * Insert a new item into the given index widget, using @p cmp_func
18263 * function to sort items (by item handles).
18265 * @param obj The index object.
18266 * @param letter Letter under which the item should be indexed
18267 * @param item The item data to set for the index's item
18268 * @param cmp_func The comparing function to be used to sort index
18269 * items <b>by #Elm_Index_Item item handles</b>
18270 * @param cmp_data_func A @b fallback function to be called for the
18271 * sorting of index items <b>by item data</b>). It will be used
18272 * when @p cmp_func returns @c 0 (equality), which means an index
18273 * item with provided item data already exists. To decide which
18274 * data item should be pointed to by the index item in question, @p
18275 * cmp_data_func will be used. If @p cmp_data_func returns a
18276 * non-negative value, the previous index item data will be
18277 * replaced by the given @p item pointer. If the previous data need
18278 * to be freed, it should be done by the @p cmp_data_func function,
18279 * because all references to it will be lost. If this function is
18280 * not provided (@c NULL is given), index items will be @b
18281 * duplicated, if @p cmp_func returns @c 0.
18283 * Despite the most common usage of the @p letter argument is for
18284 * single char strings, one could use arbitrary strings as index
18287 * @c item will be the pointer returned back on @c "changed", @c
18288 * "delay,changed" and @c "selected" smart events.
18292 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);
18295 * Remove an item from a given index widget, <b>to be referenced by
18296 * it's data value</b>.
18298 * @param obj The index object
18299 * @param item The item's data pointer for the item to be removed
18302 * If a deletion callback is set, via elm_index_item_del_cb_set(),
18303 * that callback function will be called by this one.
18305 * @warning The item to be removed from @p obj will be found via
18306 * its item data pointer, and not by an #Elm_Index_Item handle.
18310 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18313 * Find a given index widget's item, <b>using item data</b>.
18315 * @param obj The index object
18316 * @param item The item data pointed to by the desired index item
18317 * @return The index item handle, if found, or @c NULL otherwise
18321 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18324 * Removes @b all items from a given index widget.
18326 * @param obj The index object.
18328 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18329 * that callback function will be called for each item in @p obj.
18333 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18336 * Go to a given items level on a index widget
18338 * @param obj The index object
18339 * @param level The index level (one of @c 0 or @c 1)
18343 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18346 * Return the data associated with a given index widget item
18348 * @param it The index widget item handle
18349 * @return The data associated with @p it
18351 * @see elm_index_item_data_set()
18355 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18358 * Set the data associated with a given index widget item
18360 * @param it The index widget item handle
18361 * @param data The new data pointer to set to @p it
18363 * This sets new item data on @p it.
18365 * @warning The old data pointer won't be touched by this function, so
18366 * the user had better to free that old data himself/herself.
18370 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18373 * Set the function to be called when a given index widget item is freed.
18375 * @param it The item to set the callback on
18376 * @param func The function to call on the item's deletion
18378 * When called, @p func will have both @c data and @c event_info
18379 * arguments with the @p it item's data value and, naturally, the
18380 * @c obj argument with a handle to the parent index widget.
18384 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18387 * Get the letter (string) set on a given index widget item.
18389 * @param it The index item handle
18390 * @return The letter string set on @p it
18394 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18401 * @defgroup Photocam Photocam
18403 * @image html img/widget/photocam/preview-00.png
18404 * @image latex img/widget/photocam/preview-00.eps
18406 * This is a widget specifically for displaying high-resolution digital
18407 * camera photos giving speedy feedback (fast load), low memory footprint
18408 * and zooming and panning as well as fitting logic. It is entirely focused
18409 * on jpeg images, and takes advantage of properties of the jpeg format (via
18410 * evas loader features in the jpeg loader).
18412 * Signals that you can add callbacks for are:
18413 * @li "clicked" - This is called when a user has clicked the photo without
18415 * @li "press" - This is called when a user has pressed down on the photo.
18416 * @li "longpressed" - This is called when a user has pressed down on the
18417 * photo for a long time without dragging around.
18418 * @li "clicked,double" - This is called when a user has double-clicked the
18420 * @li "load" - Photo load begins.
18421 * @li "loaded" - This is called when the image file load is complete for the
18422 * first view (low resolution blurry version).
18423 * @li "load,detail" - Photo detailed data load begins.
18424 * @li "loaded,detail" - This is called when the image file load is complete
18425 * for the detailed image data (full resolution needed).
18426 * @li "zoom,start" - Zoom animation started.
18427 * @li "zoom,stop" - Zoom animation stopped.
18428 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18429 * @li "scroll" - the content has been scrolled (moved)
18430 * @li "scroll,anim,start" - scrolling animation has started
18431 * @li "scroll,anim,stop" - scrolling animation has stopped
18432 * @li "scroll,drag,start" - dragging the contents around has started
18433 * @li "scroll,drag,stop" - dragging the contents around has stopped
18435 * @ref tutorial_photocam shows the API in action.
18439 * @brief Types of zoom available.
18441 typedef enum _Elm_Photocam_Zoom_Mode
18443 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18444 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18445 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18446 ELM_PHOTOCAM_ZOOM_MODE_LAST
18447 } Elm_Photocam_Zoom_Mode;
18449 * @brief Add a new Photocam object
18451 * @param parent The parent object
18452 * @return The new object or NULL if it cannot be created
18454 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18456 * @brief Set the photo file to be shown
18458 * @param obj The photocam object
18459 * @param file The photo file
18460 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18462 * This sets (and shows) the specified file (with a relative or absolute
18463 * path) and will return a load error (same error that
18464 * evas_object_image_load_error_get() will return). The image will change and
18465 * adjust its size at this point and begin a background load process for this
18466 * photo that at some time in the future will be displayed at the full
18469 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18471 * @brief Returns the path of the current image file
18473 * @param obj The photocam object
18474 * @return Returns the path
18476 * @see elm_photocam_file_set()
18478 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18480 * @brief Set the zoom level of the photo
18482 * @param obj The photocam object
18483 * @param zoom The zoom level to set
18485 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18486 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18487 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18488 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18491 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18493 * @brief Get the zoom level of the photo
18495 * @param obj The photocam object
18496 * @return The current zoom level
18498 * This returns the current zoom level of the photocam object. Note that if
18499 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18500 * (which is the default), the zoom level may be changed at any time by the
18501 * photocam object itself to account for photo size and photocam viewpoer
18504 * @see elm_photocam_zoom_set()
18505 * @see elm_photocam_zoom_mode_set()
18507 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18509 * @brief Set the zoom mode
18511 * @param obj The photocam object
18512 * @param mode The desired mode
18514 * This sets the zoom mode to manual or one of several automatic levels.
18515 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18516 * elm_photocam_zoom_set() and will stay at that level until changed by code
18517 * or until zoom mode is changed. This is the default mode. The Automatic
18518 * modes will allow the photocam object to automatically adjust zoom mode
18519 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18520 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18521 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18522 * pixels within the frame are left unfilled.
18524 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18526 * @brief Get the zoom mode
18528 * @param obj The photocam object
18529 * @return The current zoom mode
18531 * This gets the current zoom mode of the photocam object.
18533 * @see elm_photocam_zoom_mode_set()
18535 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18537 * @brief Get the current image pixel width and height
18539 * @param obj The photocam object
18540 * @param w A pointer to the width return
18541 * @param h A pointer to the height return
18543 * This gets the current photo pixel width and height (for the original).
18544 * The size will be returned in the integers @p w and @p h that are pointed
18547 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18549 * @brief Get the area of the image that is currently shown
18552 * @param x A pointer to the X-coordinate of region
18553 * @param y A pointer to the Y-coordinate of region
18554 * @param w A pointer to the width
18555 * @param h A pointer to the height
18557 * @see elm_photocam_image_region_show()
18558 * @see elm_photocam_image_region_bring_in()
18560 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18562 * @brief Set the viewed portion of the image
18564 * @param obj The photocam object
18565 * @param x X-coordinate of region in image original pixels
18566 * @param y Y-coordinate of region in image original pixels
18567 * @param w Width of region in image original pixels
18568 * @param h Height of region in image original pixels
18570 * This shows the region of the image without using animation.
18572 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18574 * @brief Bring in the viewed portion of the image
18576 * @param obj The photocam object
18577 * @param x X-coordinate of region in image original pixels
18578 * @param y Y-coordinate of region in image original pixels
18579 * @param w Width of region in image original pixels
18580 * @param h Height of region in image original pixels
18582 * This shows the region of the image using animation.
18584 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18586 * @brief Set the paused state for photocam
18588 * @param obj The photocam object
18589 * @param paused The pause state to set
18591 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18592 * photocam. The default is off. This will stop zooming using animation on
18593 * zoom levels changes and change instantly. This will stop any existing
18594 * animations that are running.
18596 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18598 * @brief Get the paused state for photocam
18600 * @param obj The photocam object
18601 * @return The current paused state
18603 * This gets the current paused state for the photocam object.
18605 * @see elm_photocam_paused_set()
18607 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18609 * @brief Get the internal low-res image used for photocam
18611 * @param obj The photocam object
18612 * @return The internal image object handle, or NULL if none exists
18614 * This gets the internal image object inside photocam. Do not modify it. It
18615 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18616 * deleted at any time as well.
18618 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18620 * @brief Set the photocam scrolling bouncing.
18622 * @param obj The photocam object
18623 * @param h_bounce bouncing for horizontal
18624 * @param v_bounce bouncing for vertical
18626 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18628 * @brief Get the photocam scrolling bouncing.
18630 * @param obj The photocam object
18631 * @param h_bounce bouncing for horizontal
18632 * @param v_bounce bouncing for vertical
18634 * @see elm_photocam_bounce_set()
18636 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18642 * @defgroup Map Map
18643 * @ingroup Elementary
18645 * @image html img/widget/map/preview-00.png
18646 * @image latex img/widget/map/preview-00.eps
18648 * This is a widget specifically for displaying a map. It uses basically
18649 * OpenStreetMap provider http://www.openstreetmap.org/,
18650 * but custom providers can be added.
18652 * It supports some basic but yet nice features:
18653 * @li zoom and scroll
18654 * @li markers with content to be displayed when user clicks over it
18655 * @li group of markers
18658 * Smart callbacks one can listen to:
18660 * - "clicked" - This is called when a user has clicked the map without
18662 * - "press" - This is called when a user has pressed down on the map.
18663 * - "longpressed" - This is called when a user has pressed down on the map
18664 * for a long time without dragging around.
18665 * - "clicked,double" - This is called when a user has double-clicked
18667 * - "load,detail" - Map detailed data load begins.
18668 * - "loaded,detail" - This is called when all currently visible parts of
18669 * the map are loaded.
18670 * - "zoom,start" - Zoom animation started.
18671 * - "zoom,stop" - Zoom animation stopped.
18672 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18673 * - "scroll" - the content has been scrolled (moved).
18674 * - "scroll,anim,start" - scrolling animation has started.
18675 * - "scroll,anim,stop" - scrolling animation has stopped.
18676 * - "scroll,drag,start" - dragging the contents around has started.
18677 * - "scroll,drag,stop" - dragging the contents around has stopped.
18678 * - "downloaded" - This is called when all currently required map images
18680 * - "route,load" - This is called when route request begins.
18681 * - "route,loaded" - This is called when route request ends.
18682 * - "name,load" - This is called when name request begins.
18683 * - "name,loaded- This is called when name request ends.
18685 * Available style for map widget:
18688 * Available style for markers:
18693 * Available style for marker bubble:
18696 * List of examples:
18697 * @li @ref map_example_01
18698 * @li @ref map_example_02
18699 * @li @ref map_example_03
18708 * @enum _Elm_Map_Zoom_Mode
18709 * @typedef Elm_Map_Zoom_Mode
18711 * Set map's zoom behavior. It can be set to manual or automatic.
18713 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18715 * Values <b> don't </b> work as bitmask, only one can be choosen.
18717 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18718 * than the scroller view.
18720 * @see elm_map_zoom_mode_set()
18721 * @see elm_map_zoom_mode_get()
18725 typedef enum _Elm_Map_Zoom_Mode
18727 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18728 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18729 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18730 ELM_MAP_ZOOM_MODE_LAST
18731 } Elm_Map_Zoom_Mode;
18734 * @enum _Elm_Map_Route_Sources
18735 * @typedef Elm_Map_Route_Sources
18737 * Set route service to be used. By default used source is
18738 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18740 * @see elm_map_route_source_set()
18741 * @see elm_map_route_source_get()
18745 typedef enum _Elm_Map_Route_Sources
18747 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18748 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. */
18749 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18750 ELM_MAP_ROUTE_SOURCE_LAST
18751 } Elm_Map_Route_Sources;
18753 typedef enum _Elm_Map_Name_Sources
18755 ELM_MAP_NAME_SOURCE_NOMINATIM,
18756 ELM_MAP_NAME_SOURCE_LAST
18757 } Elm_Map_Name_Sources;
18760 * @enum _Elm_Map_Route_Type
18761 * @typedef Elm_Map_Route_Type
18763 * Set type of transport used on route.
18765 * @see elm_map_route_add()
18769 typedef enum _Elm_Map_Route_Type
18771 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18772 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18773 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18774 ELM_MAP_ROUTE_TYPE_LAST
18775 } Elm_Map_Route_Type;
18778 * @enum _Elm_Map_Route_Method
18779 * @typedef Elm_Map_Route_Method
18781 * Set the routing method, what should be priorized, time or distance.
18783 * @see elm_map_route_add()
18787 typedef enum _Elm_Map_Route_Method
18789 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18790 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18791 ELM_MAP_ROUTE_METHOD_LAST
18792 } Elm_Map_Route_Method;
18794 typedef enum _Elm_Map_Name_Method
18796 ELM_MAP_NAME_METHOD_SEARCH,
18797 ELM_MAP_NAME_METHOD_REVERSE,
18798 ELM_MAP_NAME_METHOD_LAST
18799 } Elm_Map_Name_Method;
18801 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(). */
18802 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(). */
18803 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(). */
18804 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(). */
18805 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18806 typedef struct _Elm_Map_Track Elm_Map_Track;
18808 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. */
18809 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18810 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18811 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18813 typedef char *(*ElmMapModuleSourceFunc) (void);
18814 typedef int (*ElmMapModuleZoomMinFunc) (void);
18815 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18816 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18817 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18818 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18819 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18820 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18821 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18824 * Add a new map widget to the given parent Elementary (container) object.
18826 * @param parent The parent object.
18827 * @return a new map widget handle or @c NULL, on errors.
18829 * This function inserts a new map widget on the canvas.
18833 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18836 * Set the zoom level of the map.
18838 * @param obj The map object.
18839 * @param zoom The zoom level to set.
18841 * This sets the zoom level.
18843 * It will respect limits defined by elm_map_source_zoom_min_set() and
18844 * elm_map_source_zoom_max_set().
18846 * By default these values are 0 (world map) and 18 (maximum zoom).
18848 * This function should be used when zoom mode is set to
18849 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18850 * with elm_map_zoom_mode_set().
18852 * @see elm_map_zoom_mode_set().
18853 * @see elm_map_zoom_get().
18857 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18860 * Get the zoom level of the map.
18862 * @param obj The map object.
18863 * @return The current zoom level.
18865 * This returns the current zoom level of the map object.
18867 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18868 * (which is the default), the zoom level may be changed at any time by the
18869 * map object itself to account for map size and map viewport size.
18871 * @see elm_map_zoom_set() for details.
18875 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18878 * Set the zoom mode used by the map object.
18880 * @param obj The map object.
18881 * @param mode The zoom mode of the map, being it one of
18882 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18883 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18885 * This sets the zoom mode to manual or one of the automatic levels.
18886 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18887 * elm_map_zoom_set() and will stay at that level until changed by code
18888 * or until zoom mode is changed. This is the default mode.
18890 * The Automatic modes will allow the map object to automatically
18891 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18892 * adjust zoom so the map fits inside the scroll frame with no pixels
18893 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18894 * ensure no pixels within the frame are left unfilled. Do not forget that
18895 * the valid sizes are 2^zoom, consequently the map may be smaller than
18896 * the scroller view.
18898 * @see elm_map_zoom_set()
18902 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18905 * Get the zoom mode used by the map object.
18907 * @param obj The map object.
18908 * @return The zoom mode of the map, being it one of
18909 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18910 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18912 * This function returns the current zoom mode used by the map object.
18914 * @see elm_map_zoom_mode_set() for more details.
18918 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18921 * Get the current coordinates of the map.
18923 * @param obj The map object.
18924 * @param lon Pointer where to store longitude.
18925 * @param lat Pointer where to store latitude.
18927 * This gets the current center coordinates of the map object. It can be
18928 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18930 * @see elm_map_geo_region_bring_in()
18931 * @see elm_map_geo_region_show()
18935 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18938 * Animatedly bring in given coordinates to the center of the map.
18940 * @param obj The map object.
18941 * @param lon Longitude to center at.
18942 * @param lat Latitude to center at.
18944 * This causes map to jump to the given @p lat and @p lon coordinates
18945 * and show it (by scrolling) in the center of the viewport, if it is not
18946 * already centered. This will use animation to do so and take a period
18947 * of time to complete.
18949 * @see elm_map_geo_region_show() for a function to avoid animation.
18950 * @see elm_map_geo_region_get()
18954 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18957 * Show the given coordinates at the center of the map, @b immediately.
18959 * @param obj The map object.
18960 * @param lon Longitude to center at.
18961 * @param lat Latitude to center at.
18963 * This causes map to @b redraw its viewport's contents to the
18964 * region contining the given @p lat and @p lon, that will be moved to the
18965 * center of the map.
18967 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18968 * @see elm_map_geo_region_get()
18972 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18975 * Pause or unpause the map.
18977 * @param obj The map object.
18978 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18981 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18984 * The default is off.
18986 * This will stop zooming using animation, changing zoom levels will
18987 * change instantly. This will stop any existing animations that are running.
18989 * @see elm_map_paused_get()
18993 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18996 * Get a value whether map is paused or not.
18998 * @param obj The map object.
18999 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
19000 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
19002 * This gets the current paused state for the map object.
19004 * @see elm_map_paused_set() for details.
19008 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19011 * Set to show markers during zoom level changes or not.
19013 * @param obj The map object.
19014 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
19017 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
19020 * The default is off.
19022 * This will stop zooming using animation, changing zoom levels will
19023 * change instantly. This will stop any existing animations that are running.
19025 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
19028 * The default is off.
19030 * Enabling it will force the map to stop displaying the markers during
19031 * zoom level changes. Set to on if you have a large number of markers.
19033 * @see elm_map_paused_markers_get()
19037 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
19040 * Get a value whether markers will be displayed on zoom level changes or not
19042 * @param obj The map object.
19043 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
19044 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
19046 * This gets the current markers paused state for the map object.
19048 * @see elm_map_paused_markers_set() for details.
19052 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19055 * Get the information of downloading status.
19057 * @param obj The map object.
19058 * @param try_num Pointer where to store number of tiles being downloaded.
19059 * @param finish_num Pointer where to store number of tiles successfully
19062 * This gets the current downloading status for the map object, the number
19063 * of tiles being downloaded and the number of tiles already downloaded.
19067 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
19070 * Convert a pixel coordinate (x,y) into a geographic coordinate
19071 * (longitude, latitude).
19073 * @param obj The map object.
19074 * @param x the coordinate.
19075 * @param y the coordinate.
19076 * @param size the size in pixels of the map.
19077 * The map is a square and generally his size is : pow(2.0, zoom)*256.
19078 * @param lon Pointer where to store the longitude that correspond to x.
19079 * @param lat Pointer where to store the latitude that correspond to y.
19081 * @note Origin pixel point is the top left corner of the viewport.
19082 * Map zoom and size are taken on account.
19084 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
19088 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);
19091 * Convert a geographic coordinate (longitude, latitude) into a pixel
19092 * coordinate (x, y).
19094 * @param obj The map object.
19095 * @param lon the longitude.
19096 * @param lat the latitude.
19097 * @param size the size in pixels of the map. The map is a square
19098 * and generally his size is : pow(2.0, zoom)*256.
19099 * @param x Pointer where to store the horizontal pixel coordinate that
19100 * correspond to the longitude.
19101 * @param y Pointer where to store the vertical pixel coordinate that
19102 * correspond to the latitude.
19104 * @note Origin pixel point is the top left corner of the viewport.
19105 * Map zoom and size are taken on account.
19107 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
19111 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);
19114 * Convert a geographic coordinate (longitude, latitude) into a name
19117 * @param obj The map object.
19118 * @param lon the longitude.
19119 * @param lat the latitude.
19120 * @return name A #Elm_Map_Name handle for this coordinate.
19122 * To get the string for this address, elm_map_name_address_get()
19125 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
19129 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
19132 * Convert a name (address) into a geographic coordinate
19133 * (longitude, latitude).
19135 * @param obj The map object.
19136 * @param name The address.
19137 * @return name A #Elm_Map_Name handle for this address.
19139 * To get the longitude and latitude, elm_map_name_region_get()
19142 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
19146 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
19149 * Convert a pixel coordinate into a rotated pixel coordinate.
19151 * @param obj The map object.
19152 * @param x horizontal coordinate of the point to rotate.
19153 * @param y vertical coordinate of the point to rotate.
19154 * @param cx rotation's center horizontal position.
19155 * @param cy rotation's center vertical position.
19156 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
19157 * @param xx Pointer where to store rotated x.
19158 * @param yy Pointer where to store rotated y.
19162 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);
19165 * Add a new marker to the map object.
19167 * @param obj The map object.
19168 * @param lon The longitude of the marker.
19169 * @param lat The latitude of the marker.
19170 * @param clas The class, to use when marker @b isn't grouped to others.
19171 * @param clas_group The class group, to use when marker is grouped to others
19172 * @param data The data passed to the callbacks.
19174 * @return The created marker or @c NULL upon failure.
19176 * A marker will be created and shown in a specific point of the map, defined
19177 * by @p lon and @p lat.
19179 * It will be displayed using style defined by @p class when this marker
19180 * is displayed alone (not grouped). A new class can be created with
19181 * elm_map_marker_class_new().
19183 * If the marker is grouped to other markers, it will be displayed with
19184 * style defined by @p class_group. Markers with the same group are grouped
19185 * if they are close. A new group class can be created with
19186 * elm_map_marker_group_class_new().
19188 * Markers created with this method can be deleted with
19189 * elm_map_marker_remove().
19191 * A marker can have associated content to be displayed by a bubble,
19192 * when a user click over it, as well as an icon. These objects will
19193 * be fetch using class' callback functions.
19195 * @see elm_map_marker_class_new()
19196 * @see elm_map_marker_group_class_new()
19197 * @see elm_map_marker_remove()
19201 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);
19204 * Set the maximum numbers of markers' content to be displayed in a group.
19206 * @param obj The map object.
19207 * @param max The maximum numbers of items displayed in a bubble.
19209 * A bubble will be displayed when the user clicks over the group,
19210 * and will place the content of markers that belong to this group
19213 * A group can have a long list of markers, consequently the creation
19214 * of the content of the bubble can be very slow.
19216 * In order to avoid this, a maximum number of items is displayed
19219 * By default this number is 30.
19221 * Marker with the same group class are grouped if they are close.
19223 * @see elm_map_marker_add()
19227 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
19230 * Remove a marker from the map.
19232 * @param marker The marker to remove.
19234 * @see elm_map_marker_add()
19238 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19241 * Get the current coordinates of the marker.
19243 * @param marker marker.
19244 * @param lat Pointer where to store the marker's latitude.
19245 * @param lon Pointer where to store the marker's longitude.
19247 * These values are set when adding markers, with function
19248 * elm_map_marker_add().
19250 * @see elm_map_marker_add()
19254 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19257 * Animatedly bring in given marker to the center of the map.
19259 * @param marker The marker to center at.
19261 * This causes map to jump to the given @p marker's coordinates
19262 * and show it (by scrolling) in the center of the viewport, if it is not
19263 * already centered. This will use animation to do so and take a period
19264 * of time to complete.
19266 * @see elm_map_marker_show() for a function to avoid animation.
19267 * @see elm_map_marker_region_get()
19271 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19274 * Show the given marker at the center of the map, @b immediately.
19276 * @param marker The marker to center at.
19278 * This causes map to @b redraw its viewport's contents to the
19279 * region contining the given @p marker's coordinates, that will be
19280 * moved to the center of the map.
19282 * @see elm_map_marker_bring_in() for a function to move with animation.
19283 * @see elm_map_markers_list_show() if more than one marker need to be
19285 * @see elm_map_marker_region_get()
19289 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19292 * Move and zoom the map to display a list of markers.
19294 * @param markers A list of #Elm_Map_Marker handles.
19296 * The map will be centered on the center point of the markers in the list.
19297 * Then the map will be zoomed in order to fit the markers using the maximum
19298 * zoom which allows display of all the markers.
19300 * @warning All the markers should belong to the same map object.
19302 * @see elm_map_marker_show() to show a single marker.
19303 * @see elm_map_marker_bring_in()
19307 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19310 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19312 * @param marker The marker wich content should be returned.
19313 * @return Return the evas object if it exists, else @c NULL.
19315 * To set callback function #ElmMapMarkerGetFunc for the marker class,
19316 * elm_map_marker_class_get_cb_set() should be used.
19318 * This content is what will be inside the bubble that will be displayed
19319 * when an user clicks over the marker.
19321 * This returns the actual Evas object used to be placed inside
19322 * the bubble. This may be @c NULL, as it may
19323 * not have been created or may have been deleted, at any time, by
19324 * the map. <b>Do not modify this object</b> (move, resize,
19325 * show, hide, etc.), as the map is controlling it. This
19326 * function is for querying, emitting custom signals or hooking
19327 * lower level callbacks for events on that object. Do not delete
19328 * this object under any circumstances.
19332 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19335 * Update the marker
19337 * @param marker The marker to be updated.
19339 * If a content is set to this marker, it will call function to delete it,
19340 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19341 * #ElmMapMarkerGetFunc.
19343 * These functions are set for the marker class with
19344 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19348 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19351 * Close all the bubbles opened by the user.
19353 * @param obj The map object.
19355 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19356 * when the user clicks on a marker.
19358 * This functions is set for the marker class with
19359 * elm_map_marker_class_get_cb_set().
19363 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19366 * Create a new group class.
19368 * @param obj The map object.
19369 * @return Returns the new group class.
19371 * Each marker must be associated to a group class. Markers in the same
19372 * group are grouped if they are close.
19374 * The group class defines the style of the marker when a marker is grouped
19375 * to others markers. When it is alone, another class will be used.
19377 * A group class will need to be provided when creating a marker with
19378 * elm_map_marker_add().
19380 * Some properties and functions can be set by class, as:
19381 * - style, with elm_map_group_class_style_set()
19382 * - data - to be associated to the group class. It can be set using
19383 * elm_map_group_class_data_set().
19384 * - min zoom to display markers, set with
19385 * elm_map_group_class_zoom_displayed_set().
19386 * - max zoom to group markers, set using
19387 * elm_map_group_class_zoom_grouped_set().
19388 * - visibility - set if markers will be visible or not, set with
19389 * elm_map_group_class_hide_set().
19390 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19391 * It can be set using elm_map_group_class_icon_cb_set().
19393 * @see elm_map_marker_add()
19394 * @see elm_map_group_class_style_set()
19395 * @see elm_map_group_class_data_set()
19396 * @see elm_map_group_class_zoom_displayed_set()
19397 * @see elm_map_group_class_zoom_grouped_set()
19398 * @see elm_map_group_class_hide_set()
19399 * @see elm_map_group_class_icon_cb_set()
19403 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19406 * Set the marker's style of a group class.
19408 * @param clas The group class.
19409 * @param style The style to be used by markers.
19411 * Each marker must be associated to a group class, and will use the style
19412 * defined by such class when grouped to other markers.
19414 * The following styles are provided by default theme:
19415 * @li @c radio - blue circle
19416 * @li @c radio2 - green circle
19419 * @see elm_map_group_class_new() for more details.
19420 * @see elm_map_marker_add()
19424 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19427 * Set the icon callback function of a group class.
19429 * @param clas The group class.
19430 * @param icon_get The callback function that will return the icon.
19432 * Each marker must be associated to a group class, and it can display a
19433 * custom icon. The function @p icon_get must return this icon.
19435 * @see elm_map_group_class_new() for more details.
19436 * @see elm_map_marker_add()
19440 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19443 * Set the data associated to the group class.
19445 * @param clas The group class.
19446 * @param data The new user data.
19448 * This data will be passed for callback functions, like icon get callback,
19449 * that can be set with elm_map_group_class_icon_cb_set().
19451 * If a data was previously set, the object will lose the pointer for it,
19452 * so if needs to be freed, you must do it yourself.
19454 * @see elm_map_group_class_new() for more details.
19455 * @see elm_map_group_class_icon_cb_set()
19456 * @see elm_map_marker_add()
19460 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19463 * Set the minimum zoom from where the markers are displayed.
19465 * @param clas The group class.
19466 * @param zoom The minimum zoom.
19468 * Markers only will be displayed when the map is displayed at @p zoom
19471 * @see elm_map_group_class_new() for more details.
19472 * @see elm_map_marker_add()
19476 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19479 * Set the zoom from where the markers are no more grouped.
19481 * @param clas The group class.
19482 * @param zoom The maximum zoom.
19484 * Markers only will be grouped when the map is displayed at
19485 * less than @p zoom.
19487 * @see elm_map_group_class_new() for more details.
19488 * @see elm_map_marker_add()
19492 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19495 * Set if the markers associated to the group class @clas are hidden or not.
19497 * @param clas The group class.
19498 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19501 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19506 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19509 * Create a new marker class.
19511 * @param obj The map object.
19512 * @return Returns the new group class.
19514 * Each marker must be associated to a class.
19516 * The marker class defines the style of the marker when a marker is
19517 * displayed alone, i.e., not grouped to to others markers. When grouped
19518 * it will use group class style.
19520 * A marker class will need to be provided when creating a marker with
19521 * elm_map_marker_add().
19523 * Some properties and functions can be set by class, as:
19524 * - style, with elm_map_marker_class_style_set()
19525 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19526 * It can be set using elm_map_marker_class_icon_cb_set().
19527 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19528 * Set using elm_map_marker_class_get_cb_set().
19529 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19530 * Set using elm_map_marker_class_del_cb_set().
19532 * @see elm_map_marker_add()
19533 * @see elm_map_marker_class_style_set()
19534 * @see elm_map_marker_class_icon_cb_set()
19535 * @see elm_map_marker_class_get_cb_set()
19536 * @see elm_map_marker_class_del_cb_set()
19540 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19543 * Set the marker's style of a marker class.
19545 * @param clas The marker class.
19546 * @param style The style to be used by markers.
19548 * Each marker must be associated to a marker class, and will use the style
19549 * defined by such class when alone, i.e., @b not grouped to other markers.
19551 * The following styles are provided by default theme:
19556 * @see elm_map_marker_class_new() for more details.
19557 * @see elm_map_marker_add()
19561 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19564 * Set the icon callback function of a marker class.
19566 * @param clas The marker class.
19567 * @param icon_get The callback function that will return the icon.
19569 * Each marker must be associated to a marker class, and it can display a
19570 * custom icon. The function @p icon_get must return this icon.
19572 * @see elm_map_marker_class_new() for more details.
19573 * @see elm_map_marker_add()
19577 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19580 * Set the bubble content callback function of a marker class.
19582 * @param clas The marker class.
19583 * @param get The callback function that will return the content.
19585 * Each marker must be associated to a marker class, and it can display a
19586 * a content on a bubble that opens when the user click over the marker.
19587 * The function @p get must return this content object.
19589 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19592 * @see elm_map_marker_class_new() for more details.
19593 * @see elm_map_marker_class_del_cb_set()
19594 * @see elm_map_marker_add()
19598 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19601 * Set the callback function used to delete bubble content of a marker class.
19603 * @param clas The marker class.
19604 * @param del The callback function that will delete the content.
19606 * Each marker must be associated to a marker class, and it can display a
19607 * a content on a bubble that opens when the user click over the marker.
19608 * The function to return such content can be set with
19609 * elm_map_marker_class_get_cb_set().
19611 * If this content must be freed, a callback function need to be
19612 * set for that task with this function.
19614 * If this callback is defined it will have to delete (or not) the
19615 * object inside, but if the callback is not defined the object will be
19616 * destroyed with evas_object_del().
19618 * @see elm_map_marker_class_new() for more details.
19619 * @see elm_map_marker_class_get_cb_set()
19620 * @see elm_map_marker_add()
19624 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19627 * Get the list of available sources.
19629 * @param obj The map object.
19630 * @return The source names list.
19632 * It will provide a list with all available sources, that can be set as
19633 * current source with elm_map_source_name_set(), or get with
19634 * elm_map_source_name_get().
19636 * Available sources:
19642 * @see elm_map_source_name_set() for more details.
19643 * @see elm_map_source_name_get()
19647 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19650 * Set the source of the map.
19652 * @param obj The map object.
19653 * @param source The source to be used.
19655 * Map widget retrieves images that composes the map from a web service.
19656 * This web service can be set with this method.
19658 * A different service can return a different maps with different
19659 * information and it can use different zoom values.
19661 * The @p source_name need to match one of the names provided by
19662 * elm_map_source_names_get().
19664 * The current source can be get using elm_map_source_name_get().
19666 * @see elm_map_source_names_get()
19667 * @see elm_map_source_name_get()
19672 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19675 * Get the name of currently used source.
19677 * @param obj The map object.
19678 * @return Returns the name of the source in use.
19680 * @see elm_map_source_name_set() for more details.
19684 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19687 * Set the source of the route service to be used by the map.
19689 * @param obj The map object.
19690 * @param source The route service to be used, being it one of
19691 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19692 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19694 * Each one has its own algorithm, so the route retrieved may
19695 * differ depending on the source route. Now, only the default is working.
19697 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19698 * http://www.yournavigation.org/.
19700 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19701 * assumptions. Its routing core is based on Contraction Hierarchies.
19703 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19705 * @see elm_map_route_source_get().
19709 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19712 * Get the current route source.
19714 * @param obj The map object.
19715 * @return The source of the route service used by the map.
19717 * @see elm_map_route_source_set() for details.
19721 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19724 * Set the minimum zoom of the source.
19726 * @param obj The map object.
19727 * @param zoom New minimum zoom value to be used.
19729 * By default, it's 0.
19733 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19736 * Get the minimum zoom of the source.
19738 * @param obj The map object.
19739 * @return Returns the minimum zoom of the source.
19741 * @see elm_map_source_zoom_min_set() for details.
19745 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19748 * Set the maximum zoom of the source.
19750 * @param obj The map object.
19751 * @param zoom New maximum zoom value to be used.
19753 * By default, it's 18.
19757 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19760 * Get the maximum zoom of the source.
19762 * @param obj The map object.
19763 * @return Returns the maximum zoom of the source.
19765 * @see elm_map_source_zoom_min_set() for details.
19769 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19772 * Set the user agent used by the map object to access routing services.
19774 * @param obj The map object.
19775 * @param user_agent The user agent to be used by the map.
19777 * User agent is a client application implementing a network protocol used
19778 * in communications within a client–server distributed computing system
19780 * The @p user_agent identification string will transmitted in a header
19781 * field @c User-Agent.
19783 * @see elm_map_user_agent_get()
19787 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19790 * Get the user agent used by the map object.
19792 * @param obj The map object.
19793 * @return The user agent identification string used by the map.
19795 * @see elm_map_user_agent_set() for details.
19799 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19802 * Add a new route to the map object.
19804 * @param obj The map object.
19805 * @param type The type of transport to be considered when tracing a route.
19806 * @param method The routing method, what should be priorized.
19807 * @param flon The start longitude.
19808 * @param flat The start latitude.
19809 * @param tlon The destination longitude.
19810 * @param tlat The destination latitude.
19812 * @return The created route or @c NULL upon failure.
19814 * A route will be traced by point on coordinates (@p flat, @p flon)
19815 * to point on coordinates (@p tlat, @p tlon), using the route service
19816 * set with elm_map_route_source_set().
19818 * It will take @p type on consideration to define the route,
19819 * depending if the user will be walking or driving, the route may vary.
19820 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19821 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19823 * Another parameter is what the route should priorize, the minor distance
19824 * or the less time to be spend on the route. So @p method should be one
19825 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19827 * Routes created with this method can be deleted with
19828 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19829 * and distance can be get with elm_map_route_distance_get().
19831 * @see elm_map_route_remove()
19832 * @see elm_map_route_color_set()
19833 * @see elm_map_route_distance_get()
19834 * @see elm_map_route_source_set()
19838 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);
19841 * Remove a route from the map.
19843 * @param route The route to remove.
19845 * @see elm_map_route_add()
19849 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19852 * Set the route color.
19854 * @param route The route object.
19855 * @param r Red channel value, from 0 to 255.
19856 * @param g Green channel value, from 0 to 255.
19857 * @param b Blue channel value, from 0 to 255.
19858 * @param a Alpha channel value, from 0 to 255.
19860 * It uses an additive color model, so each color channel represents
19861 * how much of each primary colors must to be used. 0 represents
19862 * ausence of this color, so if all of the three are set to 0,
19863 * the color will be black.
19865 * These component values should be integers in the range 0 to 255,
19866 * (single 8-bit byte).
19868 * This sets the color used for the route. By default, it is set to
19869 * solid red (r = 255, g = 0, b = 0, a = 255).
19871 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19873 * @see elm_map_route_color_get()
19877 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19880 * Get the route color.
19882 * @param route The route object.
19883 * @param r Pointer where to store the red channel value.
19884 * @param g Pointer where to store the green channel value.
19885 * @param b Pointer where to store the blue channel value.
19886 * @param a Pointer where to store the alpha channel value.
19888 * @see elm_map_route_color_set() for details.
19892 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19895 * Get the route distance in kilometers.
19897 * @param route The route object.
19898 * @return The distance of route (unit : km).
19902 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19905 * Get the information of route nodes.
19907 * @param route The route object.
19908 * @return Returns a string with the nodes of route.
19912 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19915 * Get the information of route waypoint.
19917 * @param route the route object.
19918 * @return Returns a string with information about waypoint of route.
19922 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19925 * Get the address of the name.
19927 * @param name The name handle.
19928 * @return Returns the address string of @p name.
19930 * This gets the coordinates of the @p name, created with one of the
19931 * conversion functions.
19933 * @see elm_map_utils_convert_name_into_coord()
19934 * @see elm_map_utils_convert_coord_into_name()
19938 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19941 * Get the current coordinates of the name.
19943 * @param name The name handle.
19944 * @param lat Pointer where to store the latitude.
19945 * @param lon Pointer where to store The longitude.
19947 * This gets the coordinates of the @p name, created with one of the
19948 * conversion functions.
19950 * @see elm_map_utils_convert_name_into_coord()
19951 * @see elm_map_utils_convert_coord_into_name()
19955 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19958 * Remove a name from the map.
19960 * @param name The name to remove.
19962 * Basically the struct handled by @p name will be freed, so convertions
19963 * between address and coordinates will be lost.
19965 * @see elm_map_utils_convert_name_into_coord()
19966 * @see elm_map_utils_convert_coord_into_name()
19970 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19975 * @param obj The map object.
19976 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19977 * @param cx Rotation's center horizontal position.
19978 * @param cy Rotation's center vertical position.
19980 * @see elm_map_rotate_get()
19984 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19987 * Get the rotate degree of the map
19989 * @param obj The map object
19990 * @param degree Pointer where to store degrees from 0.0 to 360.0
19991 * to rotate arount Z axis.
19992 * @param cx Pointer where to store rotation's center horizontal position.
19993 * @param cy Pointer where to store rotation's center vertical position.
19995 * @see elm_map_rotate_set() to set map rotation.
19999 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);
20002 * Enable or disable mouse wheel to be used to zoom in / out the map.
20004 * @param obj The map object.
20005 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
20008 * Mouse wheel can be used for the user to zoom in or zoom out the map.
20010 * It's disabled by default.
20012 * @see elm_map_wheel_disabled_get()
20016 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20019 * Get a value whether mouse wheel is enabled or not.
20021 * @param obj The map object.
20022 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
20023 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20025 * Mouse wheel can be used for the user to zoom in or zoom out the map.
20027 * @see elm_map_wheel_disabled_set() for details.
20031 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20035 * Add a track on the map
20037 * @param obj The map object.
20038 * @param emap The emap route object.
20039 * @return The route object. This is an elm object of type Route.
20041 * @see elm_route_add() for details.
20045 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
20049 * Remove a track from the map
20051 * @param obj The map object.
20052 * @param route The track to remove.
20056 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
20063 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
20065 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
20067 EAPI double elm_route_lon_min_get(Evas_Object *obj);
20068 EAPI double elm_route_lat_min_get(Evas_Object *obj);
20069 EAPI double elm_route_lon_max_get(Evas_Object *obj);
20070 EAPI double elm_route_lat_max_get(Evas_Object *obj);
20074 * @defgroup Panel Panel
20076 * @image html img/widget/panel/preview-00.png
20077 * @image latex img/widget/panel/preview-00.eps
20079 * @brief A panel is a type of animated container that contains subobjects.
20080 * It can be expanded or contracted by clicking the button on it's edge.
20082 * Orientations are as follows:
20083 * @li ELM_PANEL_ORIENT_TOP
20084 * @li ELM_PANEL_ORIENT_LEFT
20085 * @li ELM_PANEL_ORIENT_RIGHT
20087 * @ref tutorial_panel shows one way to use this widget.
20090 typedef enum _Elm_Panel_Orient
20092 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
20093 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
20094 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
20095 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
20096 } Elm_Panel_Orient;
20098 * @brief Adds a panel object
20100 * @param parent The parent object
20102 * @return The panel object, or NULL on failure
20104 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20106 * @brief Sets the orientation of the panel
20108 * @param parent The parent object
20109 * @param orient The panel orientation. Can be one of the following:
20110 * @li ELM_PANEL_ORIENT_TOP
20111 * @li ELM_PANEL_ORIENT_LEFT
20112 * @li ELM_PANEL_ORIENT_RIGHT
20114 * Sets from where the panel will (dis)appear.
20116 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
20118 * @brief Get the orientation of the panel.
20120 * @param obj The panel object
20121 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
20123 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20125 * @brief Set the content of the panel.
20127 * @param obj The panel object
20128 * @param content The panel content
20130 * Once the content object is set, a previously set one will be deleted.
20131 * If you want to keep that old content object, use the
20132 * elm_panel_content_unset() function.
20134 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20136 * @brief Get the content of the panel.
20138 * @param obj The panel object
20139 * @return The content that is being used
20141 * Return the content object which is set for this widget.
20143 * @see elm_panel_content_set()
20145 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20147 * @brief Unset the content of the panel.
20149 * @param obj The panel object
20150 * @return The content that was being used
20152 * Unparent and return the content object which was set for this widget.
20154 * @see elm_panel_content_set()
20156 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @brief Set the state of the panel.
20160 * @param obj The panel object
20161 * @param hidden If true, the panel will run the animation to contract
20163 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
20165 * @brief Get the state of the panel.
20167 * @param obj The panel object
20168 * @param hidden If true, the panel is in the "hide" state
20170 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20172 * @brief Toggle the hidden state of the panel from code
20174 * @param obj The panel object
20176 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
20182 * @defgroup Panes Panes
20183 * @ingroup Elementary
20185 * @image html img/widget/panes/preview-00.png
20186 * @image latex img/widget/panes/preview-00.eps width=\textwidth
20188 * @image html img/panes.png
20189 * @image latex img/panes.eps width=\textwidth
20191 * The panes adds a dragable bar between two contents. When dragged
20192 * this bar will resize contents size.
20194 * Panes can be displayed vertically or horizontally, and contents
20195 * size proportion can be customized (homogeneous by default).
20197 * Smart callbacks one can listen to:
20198 * - "press" - The panes has been pressed (button wasn't released yet).
20199 * - "unpressed" - The panes was released after being pressed.
20200 * - "clicked" - The panes has been clicked>
20201 * - "clicked,double" - The panes has been double clicked
20203 * Available styles for it:
20206 * Here is an example on its usage:
20207 * @li @ref panes_example
20211 * @addtogroup Panes
20216 * Add a new panes widget to the given parent Elementary
20217 * (container) object.
20219 * @param parent The parent object.
20220 * @return a new panes widget handle or @c NULL, on errors.
20222 * This function inserts a new panes widget on the canvas.
20226 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20229 * Set the left content of the panes widget.
20231 * @param obj The panes object.
20232 * @param content The new left content object.
20234 * Once the content object is set, a previously set one will be deleted.
20235 * If you want to keep that old content object, use the
20236 * elm_panes_content_left_unset() function.
20238 * If panes is displayed vertically, left content will be displayed at
20241 * @see elm_panes_content_left_get()
20242 * @see elm_panes_content_right_set() to set content on the other side.
20246 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20249 * Set the right content of the panes widget.
20251 * @param obj The panes object.
20252 * @param content The new right content object.
20254 * Once the content object is set, a previously set one will be deleted.
20255 * If you want to keep that old content object, use the
20256 * elm_panes_content_right_unset() function.
20258 * If panes is displayed vertically, left content will be displayed at
20261 * @see elm_panes_content_right_get()
20262 * @see elm_panes_content_left_set() to set content on the other side.
20266 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20269 * Get the left content of the panes.
20271 * @param obj The panes object.
20272 * @return The left content object that is being used.
20274 * Return the left content object which is set for this widget.
20276 * @see elm_panes_content_left_set() for details.
20280 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20283 * Get the right content of the panes.
20285 * @param obj The panes object
20286 * @return The right content object that is being used
20288 * Return the right content object which is set for this widget.
20290 * @see elm_panes_content_right_set() for details.
20294 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20297 * Unset the left content used for the panes.
20299 * @param obj The panes object.
20300 * @return The left content object that was being used.
20302 * Unparent and return the left content object which was set for this widget.
20304 * @see elm_panes_content_left_set() for details.
20305 * @see elm_panes_content_left_get().
20309 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20312 * Unset the right content used for the panes.
20314 * @param obj The panes object.
20315 * @return The right content object that was being used.
20317 * Unparent and return the right content object which was set for this
20320 * @see elm_panes_content_right_set() for details.
20321 * @see elm_panes_content_right_get().
20325 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20328 * Get the size proportion of panes widget's left side.
20330 * @param obj The panes object.
20331 * @return float value between 0.0 and 1.0 representing size proportion
20334 * @see elm_panes_content_left_size_set() for more details.
20338 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20341 * Set the size proportion of panes widget's left side.
20343 * @param obj The panes object.
20344 * @param size Value between 0.0 and 1.0 representing size proportion
20347 * By default it's homogeneous, i.e., both sides have the same size.
20349 * If something different is required, it can be set with this function.
20350 * For example, if the left content should be displayed over
20351 * 75% of the panes size, @p size should be passed as @c 0.75.
20352 * This way, right content will be resized to 25% of panes size.
20354 * If displayed vertically, left content is displayed at top, and
20355 * right content at bottom.
20357 * @note This proportion will change when user drags the panes bar.
20359 * @see elm_panes_content_left_size_get()
20363 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20366 * Set the orientation of a given panes widget.
20368 * @param obj The panes object.
20369 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20370 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20372 * Use this function to change how your panes is to be
20373 * disposed: vertically or horizontally.
20375 * By default it's displayed horizontally.
20377 * @see elm_panes_horizontal_get()
20381 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20384 * Retrieve the orientation of a given panes widget.
20386 * @param obj The panes object.
20387 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20388 * @c EINA_FALSE if it's @b vertical (and on errors).
20390 * @see elm_panes_horizontal_set() for more details.
20394 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20401 * @defgroup Flip Flip
20403 * @image html img/widget/flip/preview-00.png
20404 * @image latex img/widget/flip/preview-00.eps
20406 * This widget holds 2 content objects(Evas_Object): one on the front and one
20407 * on the back. It allows you to flip from front to back and vice-versa using
20408 * various animations.
20410 * If either the front or back contents are not set the flip will treat that
20411 * as transparent. So if you wore to set the front content but not the back,
20412 * and then call elm_flip_go() you would see whatever is below the flip.
20414 * For a list of supported animations see elm_flip_go().
20416 * Signals that you can add callbacks for are:
20417 * "animate,begin" - when a flip animation was started
20418 * "animate,done" - when a flip animation is finished
20420 * @ref tutorial_flip show how to use most of the API.
20424 typedef enum _Elm_Flip_Mode
20426 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20427 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20428 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20429 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20430 ELM_FLIP_CUBE_LEFT,
20431 ELM_FLIP_CUBE_RIGHT,
20433 ELM_FLIP_CUBE_DOWN,
20434 ELM_FLIP_PAGE_LEFT,
20435 ELM_FLIP_PAGE_RIGHT,
20439 typedef enum _Elm_Flip_Interaction
20441 ELM_FLIP_INTERACTION_NONE,
20442 ELM_FLIP_INTERACTION_ROTATE,
20443 ELM_FLIP_INTERACTION_CUBE,
20444 ELM_FLIP_INTERACTION_PAGE
20445 } Elm_Flip_Interaction;
20446 typedef enum _Elm_Flip_Direction
20448 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20449 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20450 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20451 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20452 } Elm_Flip_Direction;
20454 * @brief Add a new flip to the parent
20456 * @param parent The parent object
20457 * @return The new object or NULL if it cannot be created
20459 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20461 * @brief Set the front content of the flip widget.
20463 * @param obj The flip object
20464 * @param content The new front content object
20466 * Once the content object is set, a previously set one will be deleted.
20467 * If you want to keep that old content object, use the
20468 * elm_flip_content_front_unset() function.
20470 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20472 * @brief Set the back content of the flip widget.
20474 * @param obj The flip object
20475 * @param content The new back content object
20477 * Once the content object is set, a previously set one will be deleted.
20478 * If you want to keep that old content object, use the
20479 * elm_flip_content_back_unset() function.
20481 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20483 * @brief Get the front content used for the flip
20485 * @param obj The flip object
20486 * @return The front content object that is being used
20488 * Return the front content object which is set for this widget.
20490 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20492 * @brief Get the back content used for the flip
20494 * @param obj The flip object
20495 * @return The back content object that is being used
20497 * Return the back content object which is set for this widget.
20499 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20501 * @brief Unset the front content used for the flip
20503 * @param obj The flip object
20504 * @return The front content object that was being used
20506 * Unparent and return the front content object which was set for this widget.
20508 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20510 * @brief Unset the back content used for the flip
20512 * @param obj The flip object
20513 * @return The back content object that was being used
20515 * Unparent and return the back content object which was set for this widget.
20517 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20519 * @brief Get flip front visibility state
20521 * @param obj The flip objct
20522 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20525 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20527 * @brief Set flip perspective
20529 * @param obj The flip object
20530 * @param foc The coordinate to set the focus on
20531 * @param x The X coordinate
20532 * @param y The Y coordinate
20534 * @warning This function currently does nothing.
20536 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20538 * @brief Runs the flip animation
20540 * @param obj The flip object
20541 * @param mode The mode type
20543 * Flips the front and back contents using the @p mode animation. This
20544 * efectively hides the currently visible content and shows the hidden one.
20546 * There a number of possible animations to use for the flipping:
20547 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20548 * around a horizontal axis in the middle of its height, the other content
20549 * is shown as the other side of the flip.
20550 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20551 * around a vertical axis in the middle of its width, the other content is
20552 * shown as the other side of the flip.
20553 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20554 * around a diagonal axis in the middle of its width, the other content is
20555 * shown as the other side of the flip.
20556 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20557 * around a diagonal axis in the middle of its height, the other content is
20558 * shown as the other side of the flip.
20559 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20560 * as if the flip was a cube, the other content is show as the right face of
20562 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20563 * right as if the flip was a cube, the other content is show as the left
20564 * face of the cube.
20565 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20566 * flip was a cube, the other content is show as the bottom face of the cube.
20567 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20568 * the flip was a cube, the other content is show as the upper face of the
20570 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20571 * if the flip was a book, the other content is shown as the page below that.
20572 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20573 * as if the flip was a book, the other content is shown as the page below
20575 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20576 * flip was a book, the other content is shown as the page below that.
20577 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20578 * flip was a book, the other content is shown as the page below that.
20580 * @image html elm_flip.png
20581 * @image latex elm_flip.eps width=\textwidth
20583 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20585 * @brief Set the interactive flip mode
20587 * @param obj The flip object
20588 * @param mode The interactive flip mode to use
20590 * This sets if the flip should be interactive (allow user to click and
20591 * drag a side of the flip to reveal the back page and cause it to flip).
20592 * By default a flip is not interactive. You may also need to set which
20593 * sides of the flip are "active" for flipping and how much space they use
20594 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20595 * and elm_flip_interacton_direction_hitsize_set()
20597 * The four avilable mode of interaction are:
20598 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20599 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20600 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20601 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20603 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20604 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20605 * happen, those can only be acheived with elm_flip_go();
20607 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20609 * @brief Get the interactive flip mode
20611 * @param obj The flip object
20612 * @return The interactive flip mode
20614 * Returns the interactive flip mode set by elm_flip_interaction_set()
20616 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20618 * @brief Set which directions of the flip respond to interactive flip
20620 * @param obj The flip object
20621 * @param dir The direction to change
20622 * @param enabled If that direction is enabled or not
20624 * By default all directions are disabled, so you may want to enable the
20625 * desired directions for flipping if you need interactive flipping. You must
20626 * call this function once for each direction that should be enabled.
20628 * @see elm_flip_interaction_set()
20630 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20632 * @brief Get the enabled state of that flip direction
20634 * @param obj The flip object
20635 * @param dir The direction to check
20636 * @return If that direction is enabled or not
20638 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20640 * @see elm_flip_interaction_set()
20642 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20644 * @brief Set the amount of the flip that is sensitive to interactive flip
20646 * @param obj The flip object
20647 * @param dir The direction to modify
20648 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20650 * Set the amount of the flip that is sensitive to interactive flip, with 0
20651 * representing no area in the flip and 1 representing the entire flip. There
20652 * is however a consideration to be made in that the area will never be
20653 * smaller than the finger size set(as set in your Elementary configuration).
20655 * @see elm_flip_interaction_set()
20657 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20659 * @brief Get the amount of the flip that is sensitive to interactive flip
20661 * @param obj The flip object
20662 * @param dir The direction to check
20663 * @return The size set for that direction
20665 * Returns the amount os sensitive area set by
20666 * elm_flip_interacton_direction_hitsize_set().
20668 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20673 /* scrolledentry */
20674 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20675 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20676 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20677 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20678 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20679 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20680 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20681 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20682 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20683 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20684 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20685 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20686 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20687 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20688 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20689 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20690 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20691 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20692 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20693 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20694 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20695 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20696 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20697 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20698 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20699 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20700 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20701 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20702 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20703 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20704 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20705 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20706 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20707 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20708 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20709 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);
20710 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20711 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20712 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);
20713 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20714 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);
20715 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20716 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20717 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20718 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20719 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20720 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20721 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20722 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20723 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);
20724 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);
20725 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);
20726 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);
20727 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);
20728 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);
20729 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20730 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20731 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20732 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20733 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20734 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20735 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20738 * @defgroup Conformant Conformant
20739 * @ingroup Elementary
20741 * @image html img/widget/conformant/preview-00.png
20742 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20744 * @image html img/conformant.png
20745 * @image latex img/conformant.eps width=\textwidth
20747 * The aim is to provide a widget that can be used in elementary apps to
20748 * account for space taken up by the indicator, virtual keypad & softkey
20749 * windows when running the illume2 module of E17.
20751 * So conformant content will be sized and positioned considering the
20752 * space required for such stuff, and when they popup, as a keyboard
20753 * shows when an entry is selected, conformant content won't change.
20755 * Available styles for it:
20758 * See how to use this widget in this example:
20759 * @ref conformant_example
20763 * @addtogroup Conformant
20768 * Add a new conformant widget to the given parent Elementary
20769 * (container) object.
20771 * @param parent The parent object.
20772 * @return A new conformant widget handle or @c NULL, on errors.
20774 * This function inserts a new conformant widget on the canvas.
20776 * @ingroup Conformant
20778 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20781 * Set the content of the conformant widget.
20783 * @param obj The conformant object.
20784 * @param content The content to be displayed by the conformant.
20786 * Content will be sized and positioned considering the space required
20787 * to display a virtual keyboard. So it won't fill all the conformant
20788 * size. This way is possible to be sure that content won't resize
20789 * or be re-positioned after the keyboard is displayed.
20791 * Once the content object is set, a previously set one will be deleted.
20792 * If you want to keep that old content object, use the
20793 * elm_conformat_content_unset() function.
20795 * @see elm_conformant_content_unset()
20796 * @see elm_conformant_content_get()
20798 * @ingroup Conformant
20800 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20803 * Get the content of the conformant widget.
20805 * @param obj The conformant object.
20806 * @return The content that is being used.
20808 * Return the content object which is set for this widget.
20809 * It won't be unparent from conformant. For that, use
20810 * elm_conformant_content_unset().
20812 * @see elm_conformant_content_set() for more details.
20813 * @see elm_conformant_content_unset()
20815 * @ingroup Conformant
20817 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20820 * Unset the content of the conformant widget.
20822 * @param obj The conformant object.
20823 * @return The content that was being used.
20825 * Unparent and return the content object which was set for this widget.
20827 * @see elm_conformant_content_set() for more details.
20829 * @ingroup Conformant
20831 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20834 * Returns the Evas_Object that represents the content area.
20836 * @param obj The conformant object.
20837 * @return The content area of the widget.
20839 * @ingroup Conformant
20841 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20848 * @defgroup Mapbuf Mapbuf
20849 * @ingroup Elementary
20851 * @image html img/widget/mapbuf/preview-00.png
20852 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20854 * This holds one content object and uses an Evas Map of transformation
20855 * points to be later used with this content. So the content will be
20856 * moved, resized, etc as a single image. So it will improve performance
20857 * when you have a complex interafce, with a lot of elements, and will
20858 * need to resize or move it frequently (the content object and its
20861 * See how to use this widget in this example:
20862 * @ref mapbuf_example
20866 * @addtogroup Mapbuf
20871 * Add a new mapbuf widget to the given parent Elementary
20872 * (container) object.
20874 * @param parent The parent object.
20875 * @return A new mapbuf widget handle or @c NULL, on errors.
20877 * This function inserts a new mapbuf widget on the canvas.
20881 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20884 * Set the content of the mapbuf.
20886 * @param obj The mapbuf object.
20887 * @param content The content that will be filled in this mapbuf object.
20889 * Once the content object is set, a previously set one will be deleted.
20890 * If you want to keep that old content object, use the
20891 * elm_mapbuf_content_unset() function.
20893 * To enable map, elm_mapbuf_enabled_set() should be used.
20897 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20900 * Get the content of the mapbuf.
20902 * @param obj The mapbuf object.
20903 * @return The content that is being used.
20905 * Return the content object which is set for this widget.
20907 * @see elm_mapbuf_content_set() for details.
20911 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20914 * Unset the content of the mapbuf.
20916 * @param obj The mapbuf object.
20917 * @return The content that was being used.
20919 * Unparent and return the content object which was set for this widget.
20921 * @see elm_mapbuf_content_set() for details.
20925 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20928 * Enable or disable the map.
20930 * @param obj The mapbuf object.
20931 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20933 * This enables the map that is set or disables it. On enable, the object
20934 * geometry will be saved, and the new geometry will change (position and
20935 * size) to reflect the map geometry set.
20937 * Also, when enabled, alpha and smooth states will be used, so if the
20938 * content isn't solid, alpha should be enabled, for example, otherwise
20939 * a black retangle will fill the content.
20941 * When disabled, the stored map will be freed and geometry prior to
20942 * enabling the map will be restored.
20944 * It's disabled by default.
20946 * @see elm_mapbuf_alpha_set()
20947 * @see elm_mapbuf_smooth_set()
20951 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20954 * Get a value whether map is enabled or not.
20956 * @param obj The mapbuf object.
20957 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20958 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20960 * @see elm_mapbuf_enabled_set() for details.
20964 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20967 * Enable or disable smooth map rendering.
20969 * @param obj The mapbuf object.
20970 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20973 * This sets smoothing for map rendering. If the object is a type that has
20974 * its own smoothing settings, then both the smooth settings for this object
20975 * and the map must be turned off.
20977 * By default smooth maps are enabled.
20981 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20984 * Get a value whether smooth map rendering is enabled or not.
20986 * @param obj The mapbuf object.
20987 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20988 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20990 * @see elm_mapbuf_smooth_set() for details.
20994 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20997 * Set or unset alpha flag for map rendering.
20999 * @param obj The mapbuf object.
21000 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
21003 * This sets alpha flag for map rendering. If the object is a type that has
21004 * its own alpha settings, then this will take precedence. Only image objects
21005 * have this currently. It stops alpha blending of the map area, and is
21006 * useful if you know the object and/or all sub-objects is 100% solid.
21008 * Alpha is enabled by default.
21012 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
21015 * Get a value whether alpha blending is enabled or not.
21017 * @param obj The mapbuf object.
21018 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
21019 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21021 * @see elm_mapbuf_alpha_set() for details.
21025 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21032 * @defgroup Flipselector Flip Selector
21034 * @image html img/widget/flipselector/preview-00.png
21035 * @image latex img/widget/flipselector/preview-00.eps
21037 * A flip selector is a widget to show a set of @b text items, one
21038 * at a time, with the same sheet switching style as the @ref Clock
21039 * "clock" widget, when one changes the current displaying sheet
21040 * (thus, the "flip" in the name).
21042 * User clicks to flip sheets which are @b held for some time will
21043 * make the flip selector to flip continuosly and automatically for
21044 * the user. The interval between flips will keep growing in time,
21045 * so that it helps the user to reach an item which is distant from
21046 * the current selection.
21048 * Smart callbacks one can register to:
21049 * - @c "selected" - when the widget's selected text item is changed
21050 * - @c "overflowed" - when the widget's current selection is changed
21051 * from the first item in its list to the last
21052 * - @c "underflowed" - when the widget's current selection is changed
21053 * from the last item in its list to the first
21055 * Available styles for it:
21058 * Here is an example on its usage:
21059 * @li @ref flipselector_example
21063 * @addtogroup Flipselector
21067 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
21070 * Add a new flip selector widget to the given parent Elementary
21071 * (container) widget
21073 * @param parent The parent object
21074 * @return a new flip selector widget handle or @c NULL, on errors
21076 * This function inserts a new flip selector widget on the canvas.
21078 * @ingroup Flipselector
21080 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21083 * Programmatically select the next item of a flip selector widget
21085 * @param obj The flipselector object
21087 * @note The selection will be animated. Also, if it reaches the
21088 * end of its list of member items, it will continue with the first
21091 * @ingroup Flipselector
21093 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
21096 * Programmatically select the previous item of a flip selector
21099 * @param obj The flipselector object
21101 * @note The selection will be animated. Also, if it reaches the
21102 * beginning of its list of member items, it will continue with the
21103 * last one backwards.
21105 * @ingroup Flipselector
21107 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
21110 * Append 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 appended 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 appending an
21125 * 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_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21136 * Prepend a (text) item to a flip selector widget
21138 * @param obj The flipselector object
21139 * @param label The (text) label of the new item
21140 * @param func Convenience callback function to take place when
21142 * @param data Data passed to @p func, above
21143 * @return A handle to the item added or @c NULL, on errors
21145 * The widget's list of labels to show will be prepended with the
21146 * given value. If the user wishes so, a callback function pointer
21147 * can be passed, which will get called when this same item is
21150 * @note The current selection @b won't be modified by prepending
21151 * an element to the list.
21153 * @note The maximum length of the text label is going to be
21154 * determined <b>by the widget's theme</b>. Strings larger than
21155 * that value are going to be @b truncated.
21157 * @ingroup Flipselector
21159 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21162 * Get the internal list of items in a given flip selector widget.
21164 * @param obj The flipselector object
21165 * @return The list of items (#Elm_Flipselector_Item as data) or
21166 * @c NULL on errors.
21168 * This list is @b not to be modified in any way and must not be
21169 * freed. Use the list members with functions like
21170 * elm_flipselector_item_label_set(),
21171 * elm_flipselector_item_label_get(),
21172 * elm_flipselector_item_del(),
21173 * elm_flipselector_item_selected_get(),
21174 * elm_flipselector_item_selected_set().
21176 * @warning This list is only valid until @p obj object's internal
21177 * items list is changed. It should be fetched again with another
21178 * call to this function when changes happen.
21180 * @ingroup Flipselector
21182 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21185 * Get the first item in the given flip selector widget's list of
21188 * @param obj The flipselector object
21189 * @return The first item or @c NULL, if it has no items (and on
21192 * @see elm_flipselector_item_append()
21193 * @see elm_flipselector_last_item_get()
21195 * @ingroup Flipselector
21197 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21200 * Get the last item in the given flip selector widget's list of
21203 * @param obj The flipselector object
21204 * @return The last item or @c NULL, if it has no items (and on
21207 * @see elm_flipselector_item_prepend()
21208 * @see elm_flipselector_first_item_get()
21210 * @ingroup Flipselector
21212 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21215 * Get the currently selected item in a flip selector widget.
21217 * @param obj The flipselector object
21218 * @return The selected item or @c NULL, if the widget has no items
21221 * @ingroup Flipselector
21223 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21226 * Set whether a given flip selector widget's item should be the
21227 * currently selected one.
21229 * @param item The flip selector item
21230 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
21232 * This sets whether @p item is or not the selected (thus, under
21233 * display) one. If @p item is different than one under display,
21234 * the latter will be unselected. If the @p item is set to be
21235 * unselected, on the other hand, the @b first item in the widget's
21236 * internal members list will be the new selected one.
21238 * @see elm_flipselector_item_selected_get()
21240 * @ingroup Flipselector
21242 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
21245 * Get whether a given flip selector widget's item is the currently
21248 * @param item The flip selector item
21249 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
21252 * @see elm_flipselector_item_selected_set()
21254 * @ingroup Flipselector
21256 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21259 * Delete a given item from a flip selector widget.
21261 * @param item The item to delete
21263 * @ingroup Flipselector
21265 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21268 * Get the label of a given flip selector widget's item.
21270 * @param item The item to get label from
21271 * @return The text label of @p item or @c NULL, on errors
21273 * @see elm_flipselector_item_label_set()
21275 * @ingroup Flipselector
21277 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21280 * Set the label of a given flip selector widget's item.
21282 * @param item The item to set label on
21283 * @param label The text label string, in UTF-8 encoding
21285 * @see elm_flipselector_item_label_get()
21287 * @ingroup Flipselector
21289 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21292 * Gets the item before @p item in a flip selector widget's
21293 * internal list of items.
21295 * @param item The item to fetch previous from
21296 * @return The item before the @p item, in its parent's list. If
21297 * there is no previous item for @p item or there's an
21298 * error, @c NULL is returned.
21300 * @see elm_flipselector_item_next_get()
21302 * @ingroup Flipselector
21304 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21307 * Gets the item after @p item in a flip selector widget's
21308 * internal list of items.
21310 * @param item The item to fetch next from
21311 * @return The item after the @p item, in its parent's list. If
21312 * there is no next item for @p item or there's an
21313 * error, @c NULL is returned.
21315 * @see elm_flipselector_item_next_get()
21317 * @ingroup Flipselector
21319 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21322 * Set the interval on time updates for an user mouse button hold
21323 * on a flip selector widget.
21325 * @param obj The flip selector object
21326 * @param interval The (first) interval value in seconds
21328 * This interval value is @b decreased while the user holds the
21329 * mouse pointer either flipping up or flipping doww a given flip
21332 * This helps the user to get to a given item distant from the
21333 * current one easier/faster, as it will start to flip quicker and
21334 * quicker on mouse button holds.
21336 * The calculation for the next flip interval value, starting from
21337 * the one set with this call, is the previous interval divided by
21338 * 1.05, so it decreases a little bit.
21340 * The default starting interval value for automatic flips is
21343 * @see elm_flipselector_interval_get()
21345 * @ingroup Flipselector
21347 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21350 * Get the interval on time updates for an user mouse button hold
21351 * on a flip selector widget.
21353 * @param obj The flip selector object
21354 * @return The (first) interval value, in seconds, set on it
21356 * @see elm_flipselector_interval_set() for more details
21358 * @ingroup Flipselector
21360 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21363 * @addtogroup Calendar
21368 * @enum _Elm_Calendar_Mark_Repeat
21369 * @typedef Elm_Calendar_Mark_Repeat
21371 * Event periodicity, used to define if a mark should be repeated
21372 * @b beyond event's day. It's set when a mark is added.
21374 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21375 * there will be marks every week after this date. Marks will be displayed
21376 * at 13th, 20th, 27th, 3rd June ...
21378 * Values don't work as bitmask, only one can be choosen.
21380 * @see elm_calendar_mark_add()
21382 * @ingroup Calendar
21384 typedef enum _Elm_Calendar_Mark_Repeat
21386 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21387 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21388 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21389 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*/
21390 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. */
21391 } Elm_Calendar_Mark_Repeat;
21393 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(). */
21396 * Add a new calendar widget to the given parent Elementary
21397 * (container) object.
21399 * @param parent The parent object.
21400 * @return a new calendar widget handle or @c NULL, on errors.
21402 * This function inserts a new calendar widget on the canvas.
21404 * @ref calendar_example_01
21406 * @ingroup Calendar
21408 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21411 * Get weekdays names displayed by the calendar.
21413 * @param obj The calendar object.
21414 * @return Array of seven strings to be used as weekday names.
21416 * By default, weekdays abbreviations get from system are displayed:
21417 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21418 * The first string is related to Sunday, the second to Monday...
21420 * @see elm_calendar_weekdays_name_set()
21422 * @ref calendar_example_05
21424 * @ingroup Calendar
21426 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21429 * Set weekdays names to be displayed by the calendar.
21431 * @param obj The calendar object.
21432 * @param weekdays Array of seven strings to be used as weekday names.
21433 * @warning It must have 7 elements, or it will access invalid memory.
21434 * @warning The strings must be NULL terminated ('@\0').
21436 * By default, weekdays abbreviations get from system are displayed:
21437 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21439 * The first string should be related to Sunday, the second to Monday...
21441 * The usage should be like this:
21443 * const char *weekdays[] =
21445 * "Sunday", "Monday", "Tuesday", "Wednesday",
21446 * "Thursday", "Friday", "Saturday"
21448 * elm_calendar_weekdays_names_set(calendar, weekdays);
21451 * @see elm_calendar_weekdays_name_get()
21453 * @ref calendar_example_02
21455 * @ingroup Calendar
21457 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21460 * Set the minimum and maximum values for the year
21462 * @param obj The calendar object
21463 * @param min The minimum year, greater than 1901;
21464 * @param max The maximum year;
21466 * Maximum must be greater than minimum, except if you don't wan't to set
21468 * Default values are 1902 and -1.
21470 * If the maximum year is a negative value, it will be limited depending
21471 * on the platform architecture (year 2037 for 32 bits);
21473 * @see elm_calendar_min_max_year_get()
21475 * @ref calendar_example_03
21477 * @ingroup Calendar
21479 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21482 * Get the minimum and maximum values for the year
21484 * @param obj The calendar object.
21485 * @param min The minimum year.
21486 * @param max The maximum year.
21488 * Default values are 1902 and -1.
21490 * @see elm_calendar_min_max_year_get() for more details.
21492 * @ref calendar_example_05
21494 * @ingroup Calendar
21496 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21499 * Enable or disable day selection
21501 * @param obj The calendar object.
21502 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21505 * Enabled by default. If disabled, the user still can select months,
21506 * but not days. Selected days are highlighted on calendar.
21507 * It should be used if you won't need such selection for the widget usage.
21509 * When a day is selected, or month is changed, smart callbacks for
21510 * signal "changed" will be called.
21512 * @see elm_calendar_day_selection_enable_get()
21514 * @ref calendar_example_04
21516 * @ingroup Calendar
21518 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21521 * Get a value whether day selection is enabled or not.
21523 * @see elm_calendar_day_selection_enable_set() for details.
21525 * @param obj The calendar object.
21526 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21527 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21529 * @ref calendar_example_05
21531 * @ingroup Calendar
21533 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21537 * Set selected date to be highlighted on calendar.
21539 * @param obj The calendar object.
21540 * @param selected_time A @b tm struct to represent the selected date.
21542 * Set the selected date, changing the displayed month if needed.
21543 * Selected date changes when the user goes to next/previous month or
21544 * select a day pressing over it on calendar.
21546 * @see elm_calendar_selected_time_get()
21548 * @ref calendar_example_04
21550 * @ingroup Calendar
21552 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21555 * Get selected date.
21557 * @param obj The calendar object
21558 * @param selected_time A @b tm struct to point to selected date
21559 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21562 * Get date selected by the user or set by function
21563 * elm_calendar_selected_time_set().
21564 * Selected date changes when the user goes to next/previous month or
21565 * select a day pressing over it on calendar.
21567 * @see elm_calendar_selected_time_get()
21569 * @ref calendar_example_05
21571 * @ingroup Calendar
21573 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21576 * Set a function to format the string that will be used to display
21579 * @param obj The calendar object
21580 * @param format_function Function to set the month-year string given
21581 * the selected date
21583 * By default it uses strftime with "%B %Y" format string.
21584 * It should allocate the memory that will be used by the string,
21585 * that will be freed by the widget after usage.
21586 * A pointer to the string and a pointer to the time struct will be provided.
21591 * _format_month_year(struct tm *selected_time)
21594 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21595 * return strdup(buf);
21598 * elm_calendar_format_function_set(calendar, _format_month_year);
21601 * @ref calendar_example_02
21603 * @ingroup Calendar
21605 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21608 * Add a new mark to the calendar
21610 * @param obj The calendar object
21611 * @param mark_type A string used to define the type of mark. It will be
21612 * emitted to the theme, that should display a related modification on these
21613 * days representation.
21614 * @param mark_time A time struct to represent the date of inclusion of the
21615 * mark. For marks that repeats it will just be displayed after the inclusion
21616 * date in the calendar.
21617 * @param repeat Repeat the event following this periodicity. Can be a unique
21618 * mark (that don't repeat), daily, weekly, monthly or annually.
21619 * @return The created mark or @p NULL upon failure.
21621 * Add a mark that will be drawn in the calendar respecting the insertion
21622 * time and periodicity. It will emit the type as signal to the widget theme.
21623 * Default theme supports "holiday" and "checked", but it can be extended.
21625 * It won't immediately update the calendar, drawing the marks.
21626 * For this, call elm_calendar_marks_draw(). However, when user selects
21627 * next or previous month calendar forces marks drawn.
21629 * Marks created with this method can be deleted with
21630 * elm_calendar_mark_del().
21634 * struct tm selected_time;
21635 * time_t current_time;
21637 * current_time = time(NULL) + 5 * 84600;
21638 * localtime_r(¤t_time, &selected_time);
21639 * elm_calendar_mark_add(cal, "holiday", selected_time,
21640 * ELM_CALENDAR_ANNUALLY);
21642 * current_time = time(NULL) + 1 * 84600;
21643 * localtime_r(¤t_time, &selected_time);
21644 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21646 * elm_calendar_marks_draw(cal);
21649 * @see elm_calendar_marks_draw()
21650 * @see elm_calendar_mark_del()
21652 * @ref calendar_example_06
21654 * @ingroup Calendar
21656 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);
21659 * Delete mark from the calendar.
21661 * @param mark The mark to be deleted.
21663 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21664 * should be used instead of getting marks list and deleting each one.
21666 * @see elm_calendar_mark_add()
21668 * @ref calendar_example_06
21670 * @ingroup Calendar
21672 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21675 * Remove all calendar's marks
21677 * @param obj The calendar object.
21679 * @see elm_calendar_mark_add()
21680 * @see elm_calendar_mark_del()
21682 * @ingroup Calendar
21684 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21688 * Get a list of all the calendar marks.
21690 * @param obj The calendar object.
21691 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21693 * @see elm_calendar_mark_add()
21694 * @see elm_calendar_mark_del()
21695 * @see elm_calendar_marks_clear()
21697 * @ingroup Calendar
21699 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21702 * Draw calendar marks.
21704 * @param obj The calendar object.
21706 * Should be used after adding, removing or clearing marks.
21707 * It will go through the entire marks list updating the calendar.
21708 * If lots of marks will be added, add all the marks and then call
21711 * When the month is changed, i.e. user selects next or previous month,
21712 * marks will be drawed.
21714 * @see elm_calendar_mark_add()
21715 * @see elm_calendar_mark_del()
21716 * @see elm_calendar_marks_clear()
21718 * @ref calendar_example_06
21720 * @ingroup Calendar
21722 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21725 * Set a day text color to the same that represents Saturdays.
21727 * @param obj The calendar object.
21728 * @param pos The text position. Position is the cell counter, from left
21729 * to right, up to down. It starts on 0 and ends on 41.
21731 * @deprecated use elm_calendar_mark_add() instead like:
21734 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21735 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21738 * @see elm_calendar_mark_add()
21740 * @ingroup Calendar
21742 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21745 * Set a day text color to the same that represents Sundays.
21747 * @param obj The calendar object.
21748 * @param pos The text position. Position is the cell counter, from left
21749 * to right, up to down. It starts on 0 and ends on 41.
21751 * @deprecated use elm_calendar_mark_add() instead like:
21754 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21755 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21758 * @see elm_calendar_mark_add()
21760 * @ingroup Calendar
21762 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21765 * Set a day text color to the same that represents Weekdays.
21767 * @param obj The calendar object
21768 * @param pos The text position. Position is the cell counter, from left
21769 * to right, up to down. It starts on 0 and ends on 41.
21771 * @deprecated use elm_calendar_mark_add() instead like:
21774 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21776 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21777 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21778 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21779 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21780 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21781 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21782 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21783 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21784 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21787 * @see elm_calendar_mark_add()
21789 * @ingroup Calendar
21791 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21794 * Set the interval on time updates for an user mouse button hold
21795 * on calendar widgets' month selection.
21797 * @param obj The calendar object
21798 * @param interval The (first) interval value in seconds
21800 * This interval value is @b decreased while the user holds the
21801 * mouse pointer either selecting next or previous month.
21803 * This helps the user to get to a given month distant from the
21804 * current one easier/faster, as it will start to change quicker and
21805 * quicker on mouse button holds.
21807 * The calculation for the next change interval value, starting from
21808 * the one set with this call, is the previous interval divided by
21809 * 1.05, so it decreases a little bit.
21811 * The default starting interval value for automatic changes is
21814 * @see elm_calendar_interval_get()
21816 * @ingroup Calendar
21818 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21821 * Get the interval on time updates for an user mouse button hold
21822 * on calendar widgets' month selection.
21824 * @param obj The calendar object
21825 * @return The (first) interval value, in seconds, set on it
21827 * @see elm_calendar_interval_set() for more details
21829 * @ingroup Calendar
21831 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21838 * @defgroup Diskselector Diskselector
21839 * @ingroup Elementary
21841 * @image html img/widget/diskselector/preview-00.png
21842 * @image latex img/widget/diskselector/preview-00.eps
21844 * A diskselector is a kind of list widget. It scrolls horizontally,
21845 * and can contain label and icon objects. Three items are displayed
21846 * with the selected one in the middle.
21848 * It can act like a circular list with round mode and labels can be
21849 * reduced for a defined length for side items.
21851 * Smart callbacks one can listen to:
21852 * - "selected" - when item is selected, i.e. scroller stops.
21854 * Available styles for it:
21857 * List of examples:
21858 * @li @ref diskselector_example_01
21859 * @li @ref diskselector_example_02
21863 * @addtogroup Diskselector
21867 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(). */
21870 * Add a new diskselector widget to the given parent Elementary
21871 * (container) object.
21873 * @param parent The parent object.
21874 * @return a new diskselector widget handle or @c NULL, on errors.
21876 * This function inserts a new diskselector widget on the canvas.
21878 * @ingroup Diskselector
21880 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21883 * Enable or disable round mode.
21885 * @param obj The diskselector object.
21886 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21889 * Disabled by default. If round mode is enabled the items list will
21890 * work like a circle list, so when the user reaches the last item,
21891 * the first one will popup.
21893 * @see elm_diskselector_round_get()
21895 * @ingroup Diskselector
21897 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21900 * Get a value whether round mode is enabled or not.
21902 * @see elm_diskselector_round_set() for details.
21904 * @param obj The diskselector object.
21905 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21906 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21908 * @ingroup Diskselector
21910 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21913 * Get the side labels max length.
21915 * @deprecated use elm_diskselector_side_label_length_get() instead:
21917 * @param obj The diskselector object.
21918 * @return The max length defined for side labels, or 0 if not a valid
21921 * @ingroup Diskselector
21923 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21926 * Set the side labels max length.
21928 * @deprecated use elm_diskselector_side_label_length_set() instead:
21930 * @param obj The diskselector object.
21931 * @param len The max length defined for side labels.
21933 * @ingroup Diskselector
21935 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21938 * Get the side labels max length.
21940 * @see elm_diskselector_side_label_length_set() for details.
21942 * @param obj The diskselector object.
21943 * @return The max length defined for side labels, or 0 if not a valid
21946 * @ingroup Diskselector
21948 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21951 * Set the side labels max length.
21953 * @param obj The diskselector object.
21954 * @param len The max length defined for side labels.
21956 * Length is the number of characters of items' label that will be
21957 * visible when it's set on side positions. It will just crop
21958 * the string after defined size. E.g.:
21960 * An item with label "January" would be displayed on side position as
21961 * "Jan" if max length is set to 3, or "Janu", if this property
21964 * When it's selected, the entire label will be displayed, except for
21965 * width restrictions. In this case label will be cropped and "..."
21966 * will be concatenated.
21968 * Default side label max length is 3.
21970 * This property will be applyed over all items, included before or
21971 * later this function call.
21973 * @ingroup Diskselector
21975 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21978 * Set the number of items to be displayed.
21980 * @param obj The diskselector object.
21981 * @param num The number of items the diskselector will display.
21983 * Default value is 3, and also it's the minimun. If @p num is less
21984 * than 3, it will be set to 3.
21986 * Also, it can be set on theme, using data item @c display_item_num
21987 * on group "elm/diskselector/item/X", where X is style set.
21990 * group { name: "elm/diskselector/item/X";
21992 * item: "display_item_num" "5";
21995 * @ingroup Diskselector
21997 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
22000 * Set bouncing behaviour when the scrolled content reaches an edge.
22002 * Tell the internal scroller object whether it should bounce or not
22003 * when it reaches the respective edges for each axis.
22005 * @param obj The diskselector object.
22006 * @param h_bounce Whether to bounce or not in the horizontal axis.
22007 * @param v_bounce Whether to bounce or not in the vertical axis.
22009 * @see elm_scroller_bounce_set()
22011 * @ingroup Diskselector
22013 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22016 * Get the bouncing behaviour of the internal scroller.
22018 * Get whether the internal scroller should bounce when the edge of each
22019 * axis is reached scrolling.
22021 * @param obj The diskselector object.
22022 * @param h_bounce Pointer where to store the bounce state of the horizontal
22024 * @param v_bounce Pointer where to store the bounce state of the vertical
22027 * @see elm_scroller_bounce_get()
22028 * @see elm_diskselector_bounce_set()
22030 * @ingroup Diskselector
22032 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22035 * Get the scrollbar policy.
22037 * @see elm_diskselector_scroller_policy_get() for details.
22039 * @param obj The diskselector object.
22040 * @param policy_h Pointer where to store horizontal scrollbar policy.
22041 * @param policy_v Pointer where to store vertical scrollbar policy.
22043 * @ingroup Diskselector
22045 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);
22048 * Set the scrollbar policy.
22050 * @param obj The diskselector object.
22051 * @param policy_h Horizontal scrollbar policy.
22052 * @param policy_v Vertical scrollbar policy.
22054 * This sets the scrollbar visibility policy for the given scroller.
22055 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
22056 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
22057 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
22058 * This applies respectively for the horizontal and vertical scrollbars.
22060 * The both are disabled by default, i.e., are set to
22061 * #ELM_SCROLLER_POLICY_OFF.
22063 * @ingroup Diskselector
22065 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
22068 * Remove all diskselector's items.
22070 * @param obj The diskselector object.
22072 * @see elm_diskselector_item_del()
22073 * @see elm_diskselector_item_append()
22075 * @ingroup Diskselector
22077 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22080 * Get a list of all the diskselector items.
22082 * @param obj The diskselector object.
22083 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
22084 * or @c NULL on failure.
22086 * @see elm_diskselector_item_append()
22087 * @see elm_diskselector_item_del()
22088 * @see elm_diskselector_clear()
22090 * @ingroup Diskselector
22092 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22095 * Appends a new item to the diskselector object.
22097 * @param obj The diskselector object.
22098 * @param label The label of the diskselector item.
22099 * @param icon The icon object to use at left side of the item. An
22100 * icon can be any Evas object, but usually it is an icon created
22101 * with elm_icon_add().
22102 * @param func The function to call when the item is selected.
22103 * @param data The data to associate with the item for related callbacks.
22105 * @return The created item or @c NULL upon failure.
22107 * A new item will be created and appended to the diskselector, i.e., will
22108 * be set as last item. Also, if there is no selected item, it will
22109 * be selected. This will always happens for the first appended item.
22111 * If no icon is set, label will be centered on item position, otherwise
22112 * the icon will be placed at left of the label, that will be shifted
22115 * Items created with this method can be deleted with
22116 * elm_diskselector_item_del().
22118 * Associated @p data can be properly freed when item is deleted if a
22119 * callback function is set with elm_diskselector_item_del_cb_set().
22121 * If a function is passed as argument, it will be called everytime this item
22122 * is selected, i.e., the user stops the diskselector with this
22123 * item on center position. If such function isn't needed, just passing
22124 * @c NULL as @p func is enough. The same should be done for @p data.
22126 * Simple example (with no function callback or data associated):
22128 * disk = elm_diskselector_add(win);
22129 * ic = elm_icon_add(win);
22130 * elm_icon_file_set(ic, "path/to/image", NULL);
22131 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22132 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22135 * @see elm_diskselector_item_del()
22136 * @see elm_diskselector_item_del_cb_set()
22137 * @see elm_diskselector_clear()
22138 * @see elm_icon_add()
22140 * @ingroup Diskselector
22142 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);
22146 * Delete them item from the diskselector.
22148 * @param it The item of diskselector to be deleted.
22150 * If deleting all diskselector items is required, elm_diskselector_clear()
22151 * should be used instead of getting items list and deleting each one.
22153 * @see elm_diskselector_clear()
22154 * @see elm_diskselector_item_append()
22155 * @see elm_diskselector_item_del_cb_set()
22157 * @ingroup Diskselector
22159 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22162 * Set the function called when a diskselector item is freed.
22164 * @param it The item to set the callback on
22165 * @param func The function called
22167 * If there is a @p func, then it will be called prior item's memory release.
22168 * That will be called with the following arguments:
22170 * @li item's Evas object;
22173 * This way, a data associated to a diskselector item could be properly
22176 * @ingroup Diskselector
22178 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22181 * Get the data associated to the item.
22183 * @param it The diskselector item
22184 * @return The data associated to @p it
22186 * The return value is a pointer to data associated to @p item when it was
22187 * created, with function elm_diskselector_item_append(). If no data
22188 * was passed as argument, it will return @c NULL.
22190 * @see elm_diskselector_item_append()
22192 * @ingroup Diskselector
22194 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22197 * Set the icon associated to the item.
22199 * @param it The diskselector item
22200 * @param icon The icon object to associate with @p it
22202 * The icon object to use at left side of the item. An
22203 * icon can be any Evas object, but usually it is an icon created
22204 * with elm_icon_add().
22206 * Once the icon object is set, a previously set one will be deleted.
22207 * @warning Setting the same icon for two items will cause the icon to
22208 * dissapear from the first item.
22210 * If an icon was passed as argument on item creation, with function
22211 * elm_diskselector_item_append(), it will be already
22212 * associated to the item.
22214 * @see elm_diskselector_item_append()
22215 * @see elm_diskselector_item_icon_get()
22217 * @ingroup Diskselector
22219 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22222 * Get the icon associated to the item.
22224 * @param it The diskselector item
22225 * @return The icon associated to @p it
22227 * The return value is a pointer to the icon associated to @p item when it was
22228 * created, with function elm_diskselector_item_append(), or later
22229 * with function elm_diskselector_item_icon_set. If no icon
22230 * was passed as argument, it will return @c NULL.
22232 * @see elm_diskselector_item_append()
22233 * @see elm_diskselector_item_icon_set()
22235 * @ingroup Diskselector
22237 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22240 * Set the label of item.
22242 * @param it The item of diskselector.
22243 * @param label The label of item.
22245 * The label to be displayed by the item.
22247 * If no icon is set, label will be centered on item position, otherwise
22248 * the icon will be placed at left of the label, that will be shifted
22251 * An item with label "January" would be displayed on side position as
22252 * "Jan" if max length is set to 3 with function
22253 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22256 * When this @p item is selected, the entire label will be displayed,
22257 * except for width restrictions.
22258 * In this case label will be cropped and "..." will be concatenated,
22259 * but only for display purposes. It will keep the entire string, so
22260 * if diskselector is resized the remaining characters will be displayed.
22262 * If a label was passed as argument on item creation, with function
22263 * elm_diskselector_item_append(), it will be already
22264 * displayed by the item.
22266 * @see elm_diskselector_side_label_lenght_set()
22267 * @see elm_diskselector_item_label_get()
22268 * @see elm_diskselector_item_append()
22270 * @ingroup Diskselector
22272 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22275 * Get the label of item.
22277 * @param it The item of diskselector.
22278 * @return The label of item.
22280 * The return value is a pointer to the label associated to @p item when it was
22281 * created, with function elm_diskselector_item_append(), or later
22282 * with function elm_diskselector_item_label_set. If no label
22283 * was passed as argument, it will return @c NULL.
22285 * @see elm_diskselector_item_label_set() for more details.
22286 * @see elm_diskselector_item_append()
22288 * @ingroup Diskselector
22290 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22293 * Get the selected item.
22295 * @param obj The diskselector object.
22296 * @return The selected diskselector item.
22298 * The selected item can be unselected with function
22299 * elm_diskselector_item_selected_set(), and the first item of
22300 * diskselector will be selected.
22302 * The selected item always will be centered on diskselector, with
22303 * full label displayed, i.e., max lenght set to side labels won't
22304 * apply on the selected item. More details on
22305 * elm_diskselector_side_label_length_set().
22307 * @ingroup Diskselector
22309 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22312 * Set the selected state of an item.
22314 * @param it The diskselector item
22315 * @param selected The selected state
22317 * This sets the selected state of the given item @p it.
22318 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22320 * If a new item is selected the previosly selected will be unselected.
22321 * Previoulsy selected item can be get with function
22322 * elm_diskselector_selected_item_get().
22324 * If the item @p it is unselected, the first item of diskselector will
22327 * Selected items will be visible on center position of diskselector.
22328 * So if it was on another position before selected, or was invisible,
22329 * diskselector will animate items until the selected item reaches center
22332 * @see elm_diskselector_item_selected_get()
22333 * @see elm_diskselector_selected_item_get()
22335 * @ingroup Diskselector
22337 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22340 * Get whether the @p item is selected or not.
22342 * @param it The diskselector item.
22343 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22344 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22346 * @see elm_diskselector_selected_item_set() for details.
22347 * @see elm_diskselector_item_selected_get()
22349 * @ingroup Diskselector
22351 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22354 * Get the first item of the diskselector.
22356 * @param obj The diskselector object.
22357 * @return The first item, or @c NULL if none.
22359 * The list of items follows append order. So it will return the first
22360 * item appended to the widget that wasn't deleted.
22362 * @see elm_diskselector_item_append()
22363 * @see elm_diskselector_items_get()
22365 * @ingroup Diskselector
22367 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22370 * Get the last item of the diskselector.
22372 * @param obj The diskselector object.
22373 * @return The last item, or @c NULL if none.
22375 * The list of items follows append order. So it will return last first
22376 * item appended to the widget that wasn't deleted.
22378 * @see elm_diskselector_item_append()
22379 * @see elm_diskselector_items_get()
22381 * @ingroup Diskselector
22383 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22386 * Get the item before @p item in diskselector.
22388 * @param it The diskselector item.
22389 * @return The item before @p item, or @c NULL if none or on failure.
22391 * The list of items follows append order. So it will return item appended
22392 * just before @p item and that wasn't deleted.
22394 * If it is the first item, @c NULL will be returned.
22395 * First item can be get by elm_diskselector_first_item_get().
22397 * @see elm_diskselector_item_append()
22398 * @see elm_diskselector_items_get()
22400 * @ingroup Diskselector
22402 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22405 * Get the item after @p item in diskselector.
22407 * @param it The diskselector item.
22408 * @return The item after @p item, or @c NULL if none or on failure.
22410 * The list of items follows append order. So it will return item appended
22411 * just after @p item and that wasn't deleted.
22413 * If it is the last item, @c NULL will be returned.
22414 * Last item can be get by elm_diskselector_last_item_get().
22416 * @see elm_diskselector_item_append()
22417 * @see elm_diskselector_items_get()
22419 * @ingroup Diskselector
22421 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22424 * Set the text to be shown in the diskselector item.
22426 * @param item Target item
22427 * @param text The text to set in the content
22429 * Setup the text as tooltip to object. The item can have only one tooltip,
22430 * so any previous tooltip data is removed.
22432 * @see elm_object_tooltip_text_set() for more details.
22434 * @ingroup Diskselector
22436 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22439 * Set the content to be shown in the tooltip item.
22441 * Setup the tooltip to item. The item can have only one tooltip,
22442 * so any previous tooltip data is removed. @p func(with @p data) will
22443 * be called every time that need show the tooltip and it should
22444 * return a valid Evas_Object. This object is then managed fully by
22445 * tooltip system and is deleted when the tooltip is gone.
22447 * @param item the diskselector item being attached a tooltip.
22448 * @param func the function used to create the tooltip contents.
22449 * @param data what to provide to @a func as callback data/context.
22450 * @param del_cb called when data is not needed anymore, either when
22451 * another callback replaces @p func, the tooltip is unset with
22452 * elm_diskselector_item_tooltip_unset() or the owner @a item
22453 * dies. This callback receives as the first parameter the
22454 * given @a data, and @c event_info is the item.
22456 * @see elm_object_tooltip_content_cb_set() for more details.
22458 * @ingroup Diskselector
22460 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);
22463 * Unset tooltip from item.
22465 * @param item diskselector item to remove previously set tooltip.
22467 * Remove tooltip from item. The callback provided as del_cb to
22468 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22469 * it is not used anymore.
22471 * @see elm_object_tooltip_unset() for more details.
22472 * @see elm_diskselector_item_tooltip_content_cb_set()
22474 * @ingroup Diskselector
22476 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22480 * Sets a different style for this item tooltip.
22482 * @note before you set a style you should define a tooltip with
22483 * elm_diskselector_item_tooltip_content_cb_set() or
22484 * elm_diskselector_item_tooltip_text_set()
22486 * @param item diskselector item with tooltip already set.
22487 * @param style the theme style to use (default, transparent, ...)
22489 * @see elm_object_tooltip_style_set() for more details.
22491 * @ingroup Diskselector
22493 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22496 * Get the style for this item tooltip.
22498 * @param item diskselector item with tooltip already set.
22499 * @return style the theme style in use, defaults to "default". If the
22500 * object does not have a tooltip set, then NULL is returned.
22502 * @see elm_object_tooltip_style_get() for more details.
22503 * @see elm_diskselector_item_tooltip_style_set()
22505 * @ingroup Diskselector
22507 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22510 * Set the cursor to be shown when mouse is over the diskselector item
22512 * @param item Target item
22513 * @param cursor the cursor name to be used.
22515 * @see elm_object_cursor_set() for more details.
22517 * @ingroup Diskselector
22519 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22522 * Get the cursor to be shown when mouse is over the diskselector item
22524 * @param item diskselector item with cursor already set.
22525 * @return the cursor name.
22527 * @see elm_object_cursor_get() for more details.
22528 * @see elm_diskselector_cursor_set()
22530 * @ingroup Diskselector
22532 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22536 * Unset the cursor to be shown when mouse is over the diskselector item
22538 * @param item Target item
22540 * @see elm_object_cursor_unset() for more details.
22541 * @see elm_diskselector_cursor_set()
22543 * @ingroup Diskselector
22545 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22548 * Sets a different style for this item cursor.
22550 * @note before you set a style you should define a cursor with
22551 * elm_diskselector_item_cursor_set()
22553 * @param item diskselector item with cursor already set.
22554 * @param style the theme style to use (default, transparent, ...)
22556 * @see elm_object_cursor_style_set() for more details.
22558 * @ingroup Diskselector
22560 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22564 * Get the style for this item cursor.
22566 * @param item diskselector item with cursor already set.
22567 * @return style the theme style in use, defaults to "default". If the
22568 * object does not have a cursor set, then @c NULL is returned.
22570 * @see elm_object_cursor_style_get() for more details.
22571 * @see elm_diskselector_item_cursor_style_set()
22573 * @ingroup Diskselector
22575 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22579 * Set if the cursor set should be searched on the theme or should use
22580 * the provided by the engine, only.
22582 * @note before you set if should look on theme you should define a cursor
22583 * with elm_diskselector_item_cursor_set().
22584 * By default it will only look for cursors provided by the engine.
22586 * @param item widget item with cursor already set.
22587 * @param engine_only boolean to define if cursors set with
22588 * elm_diskselector_item_cursor_set() should be searched only
22589 * between cursors provided by the engine or searched on widget's
22592 * @see elm_object_cursor_engine_only_set() for more details.
22594 * @ingroup Diskselector
22596 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22599 * Get the cursor engine only usage for this item cursor.
22601 * @param item widget item with cursor already set.
22602 * @return engine_only boolean to define it cursors should be looked only
22603 * between the provided by the engine or searched on widget's theme as well.
22604 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22606 * @see elm_object_cursor_engine_only_get() for more details.
22607 * @see elm_diskselector_item_cursor_engine_only_set()
22609 * @ingroup Diskselector
22611 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22618 * @defgroup Colorselector Colorselector
22622 * @image html img/widget/colorselector/preview-00.png
22623 * @image latex img/widget/colorselector/preview-00.eps
22625 * @brief Widget for user to select a color.
22627 * Signals that you can add callbacks for are:
22628 * "changed" - When the color value changes(event_info is NULL).
22630 * See @ref tutorial_colorselector.
22633 * @brief Add a new colorselector to the parent
22635 * @param parent The parent object
22636 * @return The new object or NULL if it cannot be created
22638 * @ingroup Colorselector
22640 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22642 * Set a color for the colorselector
22644 * @param obj Colorselector object
22645 * @param r r-value of color
22646 * @param g g-value of color
22647 * @param b b-value of color
22648 * @param a a-value of color
22650 * @ingroup Colorselector
22652 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22654 * Get a color from the colorselector
22656 * @param obj Colorselector object
22657 * @param r integer pointer for r-value of color
22658 * @param g integer pointer for g-value of color
22659 * @param b integer pointer for b-value of color
22660 * @param a integer pointer for a-value of color
22662 * @ingroup Colorselector
22664 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22670 * @defgroup Ctxpopup Ctxpopup
22672 * @image html img/widget/ctxpopup/preview-00.png
22673 * @image latex img/widget/ctxpopup/preview-00.eps
22675 * @brief Context popup widet.
22677 * A ctxpopup is a widget that, when shown, pops up a list of items.
22678 * It automatically chooses an area inside its parent object's view
22679 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22680 * optimally fit into it. In the default theme, it will also point an
22681 * arrow to it's top left position at the time one shows it. Ctxpopup
22682 * items have a label and/or an icon. It is intended for a small
22683 * number of items (hence the use of list, not genlist).
22685 * @note Ctxpopup is a especialization of @ref Hover.
22687 * Signals that you can add callbacks for are:
22688 * "dismissed" - the ctxpopup was dismissed
22690 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22693 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22695 typedef enum _Elm_Ctxpopup_Direction
22697 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22699 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22700 the clicked area */
22701 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22702 the clicked area */
22703 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22705 } Elm_Ctxpopup_Direction;
22708 * @brief Add a new Ctxpopup object to the parent.
22710 * @param parent Parent object
22711 * @return New object or @c NULL, if it cannot be created
22713 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22715 * @brief Set the Ctxpopup's parent
22717 * @param obj The ctxpopup object
22718 * @param area The parent to use
22720 * Set the parent object.
22722 * @note elm_ctxpopup_add() will automatically call this function
22723 * with its @c parent argument.
22725 * @see elm_ctxpopup_add()
22726 * @see elm_hover_parent_set()
22728 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22730 * @brief Get the Ctxpopup's parent
22732 * @param obj The ctxpopup object
22734 * @see elm_ctxpopup_hover_parent_set() for more information
22736 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22738 * @brief Clear all items in the given ctxpopup object.
22740 * @param obj Ctxpopup object
22742 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22744 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22746 * @param obj Ctxpopup object
22747 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22749 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22751 * @brief Get the value of current ctxpopup object's orientation.
22753 * @param obj Ctxpopup object
22754 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22756 * @see elm_ctxpopup_horizontal_set()
22758 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22760 * @brief Add a new item to a ctxpopup object.
22762 * @param obj Ctxpopup object
22763 * @param icon Icon to be set on new item
22764 * @param label The Label of the new item
22765 * @param func Convenience function called when item selected
22766 * @param data Data passed to @p func
22767 * @return A handle to the item added or @c NULL, on errors
22769 * @warning Ctxpopup can't hold both an item list and a content at the same
22770 * time. When an item is added, any previous content will be removed.
22772 * @see elm_ctxpopup_content_set()
22774 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);
22776 * @brief Delete the given item in a ctxpopup object.
22778 * @param item Ctxpopup item to be deleted
22780 * @see elm_ctxpopup_item_append()
22782 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22784 * @brief Set the ctxpopup item's state as disabled or enabled.
22786 * @param item Ctxpopup item to be enabled/disabled
22787 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22789 * When disabled the item is greyed out to indicate it's state.
22791 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22793 * @brief Get the ctxpopup item's disabled/enabled state.
22795 * @param item Ctxpopup item to be enabled/disabled
22796 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22798 * @see elm_ctxpopup_item_disabled_set()
22800 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22802 * @brief Get the icon object for the given ctxpopup item.
22804 * @param item Ctxpopup item
22805 * @return icon object or @c NULL, if the item does not have icon or an error
22808 * @see elm_ctxpopup_item_append()
22809 * @see elm_ctxpopup_item_icon_set()
22811 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22813 * @brief Sets the side icon associated with the ctxpopup item
22815 * @param item Ctxpopup item
22816 * @param icon Icon object to be set
22818 * Once the icon object is set, a previously set one will be deleted.
22819 * @warning Setting the same icon for two items will cause the icon to
22820 * dissapear from the first item.
22822 * @see elm_ctxpopup_item_append()
22824 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22826 * @brief Get the label for the given ctxpopup item.
22828 * @param item Ctxpopup item
22829 * @return label string or @c NULL, if the item does not have label or an
22832 * @see elm_ctxpopup_item_append()
22833 * @see elm_ctxpopup_item_label_set()
22835 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22837 * @brief (Re)set the label on the given ctxpopup item.
22839 * @param item Ctxpopup item
22840 * @param label String to set as label
22842 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22844 * @brief Set an elm widget as the content of the ctxpopup.
22846 * @param obj Ctxpopup object
22847 * @param content Content to be swallowed
22849 * If the content object is already set, a previous one will bedeleted. If
22850 * you want to keep that old content object, use the
22851 * elm_ctxpopup_content_unset() function.
22853 * @deprecated use elm_object_content_set()
22855 * @warning Ctxpopup can't hold both a item list and a content at the same
22856 * time. When a content is set, any previous items will be removed.
22858 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22860 * @brief Unset the ctxpopup content
22862 * @param obj Ctxpopup object
22863 * @return The content that was being used
22865 * Unparent and return the content object which was set for this widget.
22867 * @deprecated use elm_object_content_unset()
22869 * @see elm_ctxpopup_content_set()
22871 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22873 * @brief Set the direction priority of a ctxpopup.
22875 * @param obj Ctxpopup object
22876 * @param first 1st priority of direction
22877 * @param second 2nd priority of direction
22878 * @param third 3th priority of direction
22879 * @param fourth 4th priority of direction
22881 * This functions gives a chance to user to set the priority of ctxpopup
22882 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22883 * requested direction.
22885 * @see Elm_Ctxpopup_Direction
22887 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);
22889 * @brief Get the direction priority of a ctxpopup.
22891 * @param obj Ctxpopup object
22892 * @param first 1st priority of direction to be returned
22893 * @param second 2nd priority of direction to be returned
22894 * @param third 3th priority of direction to be returned
22895 * @param fourth 4th priority of direction to be returned
22897 * @see elm_ctxpopup_direction_priority_set() for more information.
22899 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);
22907 * @defgroup Transit Transit
22908 * @ingroup Elementary
22910 * Transit is designed to apply various animated transition effects to @c
22911 * Evas_Object, such like translation, rotation, etc. For using these
22912 * effects, create an @ref Elm_Transit and add the desired transition effects.
22914 * Once the effects are added into transit, they will be automatically
22915 * managed (their callback will be called until the duration is ended, and
22916 * they will be deleted on completion).
22920 * Elm_Transit *trans = elm_transit_add();
22921 * elm_transit_object_add(trans, obj);
22922 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22923 * elm_transit_duration_set(transit, 1);
22924 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22925 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22926 * elm_transit_repeat_times_set(transit, 3);
22929 * Some transition effects are used to change the properties of objects. They
22931 * @li @ref elm_transit_effect_translation_add
22932 * @li @ref elm_transit_effect_color_add
22933 * @li @ref elm_transit_effect_rotation_add
22934 * @li @ref elm_transit_effect_wipe_add
22935 * @li @ref elm_transit_effect_zoom_add
22936 * @li @ref elm_transit_effect_resizing_add
22938 * Other transition effects are used to make one object disappear and another
22939 * object appear on its old place. These effects are:
22941 * @li @ref elm_transit_effect_flip_add
22942 * @li @ref elm_transit_effect_resizable_flip_add
22943 * @li @ref elm_transit_effect_fade_add
22944 * @li @ref elm_transit_effect_blend_add
22946 * It's also possible to make a transition chain with @ref
22947 * elm_transit_chain_transit_add.
22949 * @warning We strongly recommend to use elm_transit just when edje can not do
22950 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22951 * animations can be manipulated inside the theme.
22953 * List of examples:
22954 * @li @ref transit_example_01_explained
22955 * @li @ref transit_example_02_explained
22956 * @li @ref transit_example_03_c
22957 * @li @ref transit_example_04_c
22963 * @enum Elm_Transit_Tween_Mode
22965 * The type of acceleration used in the transition.
22969 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22970 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22971 over time, then decrease again
22973 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22975 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22977 } Elm_Transit_Tween_Mode;
22980 * @enum Elm_Transit_Effect_Flip_Axis
22982 * The axis where flip effect should be applied.
22986 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22987 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22988 } Elm_Transit_Effect_Flip_Axis;
22990 * @enum Elm_Transit_Effect_Wipe_Dir
22992 * The direction where the wipe effect should occur.
22996 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22997 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22998 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22999 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
23000 } Elm_Transit_Effect_Wipe_Dir;
23001 /** @enum Elm_Transit_Effect_Wipe_Type
23003 * Whether the wipe effect should show or hide the object.
23007 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
23009 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
23011 } Elm_Transit_Effect_Wipe_Type;
23014 * @typedef Elm_Transit
23016 * The Transit created with elm_transit_add(). This type has the information
23017 * about the objects which the transition will be applied, and the
23018 * transition effects that will be used. It also contains info about
23019 * duration, number of repetitions, auto-reverse, etc.
23021 typedef struct _Elm_Transit Elm_Transit;
23022 typedef void Elm_Transit_Effect;
23024 * @typedef Elm_Transit_Effect_Transition_Cb
23026 * Transition callback called for this effect on each transition iteration.
23028 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
23030 * Elm_Transit_Effect_End_Cb
23032 * Transition callback called for this effect when the transition is over.
23034 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
23037 * Elm_Transit_Del_Cb
23039 * A callback called when the transit is deleted.
23041 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
23046 * @note Is not necessary to delete the transit object, it will be deleted at
23047 * the end of its operation.
23048 * @note The transit will start playing when the program enter in the main loop, is not
23049 * necessary to give a start to the transit.
23051 * @return The transit object.
23055 EAPI Elm_Transit *elm_transit_add(void);
23058 * Stops the animation and delete the @p transit object.
23060 * Call this function if you wants to stop the animation before the duration
23061 * time. Make sure the @p transit object is still alive with
23062 * elm_transit_del_cb_set() function.
23063 * All added effects will be deleted, calling its repective data_free_cb
23064 * functions. The function setted by elm_transit_del_cb_set() will be called.
23066 * @see elm_transit_del_cb_set()
23068 * @param transit The transit object to be deleted.
23071 * @warning Just call this function if you are sure the transit is alive.
23073 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23076 * Add a new effect to the transit.
23078 * @note The cb function and the data are the key to the effect. If you try to
23079 * add an already added effect, nothing is done.
23080 * @note After the first addition of an effect in @p transit, if its
23081 * effect list become empty again, the @p transit will be killed by
23082 * elm_transit_del(transit) function.
23086 * Elm_Transit *transit = elm_transit_add();
23087 * elm_transit_effect_add(transit,
23088 * elm_transit_effect_blend_op,
23089 * elm_transit_effect_blend_context_new(),
23090 * elm_transit_effect_blend_context_free);
23093 * @param transit The transit object.
23094 * @param transition_cb The operation function. It is called when the
23095 * animation begins, it is the function that actually performs the animation.
23096 * It is called with the @p data, @p transit and the time progression of the
23097 * animation (a double value between 0.0 and 1.0).
23098 * @param effect The context data of the effect.
23099 * @param end_cb The function to free the context data, it will be called
23100 * at the end of the effect, it must finalize the animation and free the
23104 * @warning The transit free the context data at the and of the transition with
23105 * the data_free_cb function, do not use the context data in another transit.
23107 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);
23110 * Delete an added effect.
23112 * This function will remove the effect from the @p transit, calling the
23113 * data_free_cb to free the @p data.
23115 * @see elm_transit_effect_add()
23117 * @note If the effect is not found, nothing is done.
23118 * @note If the effect list become empty, this function will call
23119 * elm_transit_del(transit), that is, it will kill the @p transit.
23121 * @param transit The transit object.
23122 * @param transition_cb The operation function.
23123 * @param effect The context data of the effect.
23127 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);
23130 * Add new object to apply the effects.
23132 * @note After the first addition of an object in @p transit, if its
23133 * object list become empty again, the @p transit will be killed by
23134 * elm_transit_del(transit) function.
23135 * @note If the @p obj belongs to another transit, the @p obj will be
23136 * removed from it and it will only belong to the @p transit. If the old
23137 * transit stays without objects, it will die.
23138 * @note When you add an object into the @p transit, its state from
23139 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23140 * transit ends, if you change this state whith evas_object_pass_events_set()
23141 * after add the object, this state will change again when @p transit stops to
23144 * @param transit The transit object.
23145 * @param obj Object to be animated.
23148 * @warning It is not allowed to add a new object after transit begins to go.
23150 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23153 * Removes an added object from the transit.
23155 * @note If the @p obj is not in the @p transit, nothing is done.
23156 * @note If the list become empty, this function will call
23157 * elm_transit_del(transit), that is, it will kill the @p transit.
23159 * @param transit The transit object.
23160 * @param obj Object to be removed from @p transit.
23163 * @warning It is not allowed to remove objects after transit begins to go.
23165 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23168 * Get the objects of the transit.
23170 * @param transit The transit object.
23171 * @return a Eina_List with the objects from the transit.
23175 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23178 * Enable/disable keeping up the objects states.
23179 * If it is not kept, the objects states will be reset when transition ends.
23181 * @note @p transit can not be NULL.
23182 * @note One state includes geometry, color, map data.
23184 * @param transit The transit object.
23185 * @param state_keep Keeping or Non Keeping.
23189 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23192 * Get a value whether the objects states will be reset or not.
23194 * @note @p transit can not be NULL
23196 * @see elm_transit_objects_final_state_keep_set()
23198 * @param transit The transit object.
23199 * @return EINA_TRUE means the states of the objects will be reset.
23200 * If @p transit is NULL, EINA_FALSE is returned
23204 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23207 * Set the event enabled when transit is operating.
23209 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23210 * events from mouse and keyboard during the animation.
23211 * @note When you add an object with elm_transit_object_add(), its state from
23212 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23213 * transit ends, if you change this state with evas_object_pass_events_set()
23214 * after adding the object, this state will change again when @p transit stops
23217 * @param transit The transit object.
23218 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23219 * ignored otherwise.
23223 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23226 * Get the value of event enabled status.
23228 * @see elm_transit_event_enabled_set()
23230 * @param transit The Transit object
23231 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23232 * EINA_FALSE is returned
23236 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23239 * Set the user-callback function when the transit is deleted.
23241 * @note Using this function twice will overwrite the first function setted.
23242 * @note the @p transit object will be deleted after call @p cb function.
23244 * @param transit The transit object.
23245 * @param cb Callback function pointer. This function will be called before
23246 * the deletion of the transit.
23247 * @param data Callback funtion user data. It is the @p op parameter.
23251 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23254 * Set reverse effect automatically.
23256 * If auto reverse is setted, after running the effects with the progress
23257 * parameter from 0 to 1, it will call the effecs again with the progress
23258 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23259 * where the duration was setted with the function elm_transit_add and
23260 * the repeat with the function elm_transit_repeat_times_set().
23262 * @param transit The transit object.
23263 * @param reverse EINA_TRUE means the auto_reverse is on.
23267 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23270 * Get if the auto reverse is on.
23272 * @see elm_transit_auto_reverse_set()
23274 * @param transit The transit object.
23275 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23276 * EINA_FALSE is returned
23280 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23283 * Set the transit repeat count. Effect will be repeated by repeat count.
23285 * This function sets the number of repetition the transit will run after
23286 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23287 * If the @p repeat is a negative number, it will repeat infinite times.
23289 * @note If this function is called during the transit execution, the transit
23290 * will run @p repeat times, ignoring the times it already performed.
23292 * @param transit The transit object
23293 * @param repeat Repeat count
23297 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23300 * Get the transit repeat count.
23302 * @see elm_transit_repeat_times_set()
23304 * @param transit The Transit object.
23305 * @return The repeat count. If @p transit is NULL
23310 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23313 * Set the transit animation acceleration type.
23315 * This function sets the tween mode of the transit that can be:
23316 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23317 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23318 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23319 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23321 * @param transit The transit object.
23322 * @param tween_mode The tween type.
23326 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23329 * Get the transit animation acceleration type.
23331 * @note @p transit can not be NULL
23333 * @param transit The transit object.
23334 * @return The tween type. If @p transit is NULL
23335 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23339 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23342 * Set the transit animation time
23344 * @note @p transit can not be NULL
23346 * @param transit The transit object.
23347 * @param duration The animation time.
23351 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23354 * Get the transit animation time
23356 * @note @p transit can not be NULL
23358 * @param transit The transit object.
23360 * @return The transit animation time.
23364 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23367 * Starts the transition.
23368 * Once this API is called, the transit begins to measure the time.
23370 * @note @p transit can not be NULL
23372 * @param transit The transit object.
23376 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23379 * Pause/Resume the transition.
23381 * If you call elm_transit_go again, the transit will be started from the
23382 * beginning, and will be unpaused.
23384 * @note @p transit can not be NULL
23386 * @param transit The transit object.
23387 * @param paused Whether the transition should be paused or not.
23391 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23394 * Get the value of paused status.
23396 * @see elm_transit_paused_set()
23398 * @note @p transit can not be NULL
23400 * @param transit The transit object.
23401 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23402 * EINA_FALSE is returned
23406 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23409 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23411 * The value returned is a fraction (current time / total time). It
23412 * represents the progression position relative to the total.
23414 * @note @p transit can not be NULL
23416 * @param transit The transit object.
23418 * @return The time progression value. If @p transit is NULL
23423 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23426 * Makes the chain relationship between two transits.
23428 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23429 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23431 * @param transit The transit object.
23432 * @param chain_transit The chain transit object. This transit will be operated
23433 * after transit is done.
23435 * This function adds @p chain_transit transition to a chain after the @p
23436 * transit, and will be started as soon as @p transit ends. See @ref
23437 * transit_example_02_explained for a full example.
23441 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23444 * Cut off the chain relationship between two transits.
23446 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23447 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23449 * @param transit The transit object.
23450 * @param chain_transit The chain transit object.
23452 * This function remove the @p chain_transit transition from the @p transit.
23456 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23459 * Get the current chain transit list.
23461 * @note @p transit can not be NULL.
23463 * @param transit The transit object.
23464 * @return chain transit list.
23468 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23471 * Add the Resizing Effect to Elm_Transit.
23473 * @note This API is one of the facades. It creates resizing effect context
23474 * and add it's required APIs to elm_transit_effect_add.
23476 * @see elm_transit_effect_add()
23478 * @param transit Transit object.
23479 * @param from_w Object width size when effect begins.
23480 * @param from_h Object height size when effect begins.
23481 * @param to_w Object width size when effect ends.
23482 * @param to_h Object height size when effect ends.
23483 * @return Resizing effect context data.
23487 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);
23490 * Add the Translation Effect to Elm_Transit.
23492 * @note This API is one of the facades. It creates translation 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_dx X Position variation when effect begins.
23499 * @param from_dy Y Position variation when effect begins.
23500 * @param to_dx X Position variation when effect ends.
23501 * @param to_dy Y Position variation when effect ends.
23502 * @return Translation effect context data.
23505 * @warning It is highly recommended just create a transit with this effect when
23506 * the window that the objects of the transit belongs has already been created.
23507 * This is because this effect needs the geometry information about the objects,
23508 * and if the window was not created yet, it can get a wrong information.
23510 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);
23513 * Add the Zoom Effect to Elm_Transit.
23515 * @note This API is one of the facades. It creates zoom effect context
23516 * and add it's required APIs to elm_transit_effect_add.
23518 * @see elm_transit_effect_add()
23520 * @param transit Transit object.
23521 * @param from_rate Scale rate when effect begins (1 is current rate).
23522 * @param to_rate Scale rate when effect ends.
23523 * @return Zoom effect context data.
23526 * @warning It is highly recommended just create a transit with this effect when
23527 * the window that the objects of the transit belongs has already been created.
23528 * This is because this effect needs the geometry information about the objects,
23529 * and if the window was not created yet, it can get a wrong information.
23531 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23534 * Add the Flip Effect to Elm_Transit.
23536 * @note This API is one of the facades. It creates flip effect context
23537 * and add it's required APIs to elm_transit_effect_add.
23538 * @note This effect is applied to each pair of objects in the order they are listed
23539 * in the transit list of objects. The first object in the pair will be the
23540 * "front" object and the second will be the "back" object.
23542 * @see elm_transit_effect_add()
23544 * @param transit Transit object.
23545 * @param axis Flipping Axis(X or Y).
23546 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23547 * @return Flip effect context data.
23550 * @warning It is highly recommended just create a transit with this effect when
23551 * the window that the objects of the transit belongs has already been created.
23552 * This is because this effect needs the geometry information about the objects,
23553 * and if the window was not created yet, it can get a wrong information.
23555 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23558 * Add the Resizable Flip Effect to Elm_Transit.
23560 * @note This API is one of the facades. It creates resizable flip effect context
23561 * and add it's required APIs to elm_transit_effect_add.
23562 * @note This effect is applied to each pair of objects in the order they are listed
23563 * in the transit list of objects. The first object in the pair will be the
23564 * "front" object and the second will be the "back" object.
23566 * @see elm_transit_effect_add()
23568 * @param transit Transit object.
23569 * @param axis Flipping Axis(X or Y).
23570 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23571 * @return Resizable flip effect context data.
23574 * @warning It is highly recommended just create a transit with this effect when
23575 * the window that the objects of the transit belongs has already been created.
23576 * This is because this effect needs the geometry information about the objects,
23577 * and if the window was not created yet, it can get a wrong information.
23579 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23582 * Add the Wipe Effect to Elm_Transit.
23584 * @note This API is one of the facades. It creates wipe effect context
23585 * and add it's required APIs to elm_transit_effect_add.
23587 * @see elm_transit_effect_add()
23589 * @param transit Transit object.
23590 * @param type Wipe type. Hide or show.
23591 * @param dir Wipe Direction.
23592 * @return Wipe effect context data.
23595 * @warning It is highly recommended just create a transit with this effect when
23596 * the window that the objects of the transit belongs has already been created.
23597 * This is because this effect needs the geometry information about the objects,
23598 * and if the window was not created yet, it can get a wrong information.
23600 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23603 * Add the Color Effect to Elm_Transit.
23605 * @note This API is one of the facades. It creates color effect context
23606 * and add it's required APIs to elm_transit_effect_add.
23608 * @see elm_transit_effect_add()
23610 * @param transit Transit object.
23611 * @param from_r RGB R when effect begins.
23612 * @param from_g RGB G when effect begins.
23613 * @param from_b RGB B when effect begins.
23614 * @param from_a RGB A when effect begins.
23615 * @param to_r RGB R when effect ends.
23616 * @param to_g RGB G when effect ends.
23617 * @param to_b RGB B when effect ends.
23618 * @param to_a RGB A when effect ends.
23619 * @return Color effect context data.
23623 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);
23626 * Add the Fade Effect to Elm_Transit.
23628 * @note This API is one of the facades. It creates fade effect context
23629 * and add it's required APIs to elm_transit_effect_add.
23630 * @note This effect is applied to each pair of objects in the order they are listed
23631 * in the transit list of objects. The first object in the pair will be the
23632 * "before" object and the second will be the "after" object.
23634 * @see elm_transit_effect_add()
23636 * @param transit Transit object.
23637 * @return Fade effect context data.
23640 * @warning It is highly recommended just create a transit with this effect when
23641 * the window that the objects of the transit belongs has already been created.
23642 * This is because this effect needs the color information about the objects,
23643 * and if the window was not created yet, it can get a wrong information.
23645 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23648 * Add the Blend Effect to Elm_Transit.
23650 * @note This API is one of the facades. It creates blend effect context
23651 * and add it's required APIs to elm_transit_effect_add.
23652 * @note This effect is applied to each pair of objects in the order they are listed
23653 * in the transit list of objects. The first object in the pair will be the
23654 * "before" object and the second will be the "after" object.
23656 * @see elm_transit_effect_add()
23658 * @param transit Transit object.
23659 * @return Blend effect context data.
23662 * @warning It is highly recommended just create a transit with this effect when
23663 * the window that the objects of the transit belongs has already been created.
23664 * This is because this effect needs the color information about the objects,
23665 * and if the window was not created yet, it can get a wrong information.
23667 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23670 * Add the Rotation Effect to Elm_Transit.
23672 * @note This API is one of the facades. It creates rotation effect context
23673 * and add it's required APIs to elm_transit_effect_add.
23675 * @see elm_transit_effect_add()
23677 * @param transit Transit object.
23678 * @param from_degree Degree when effect begins.
23679 * @param to_degree Degree when effect is ends.
23680 * @return Rotation effect context data.
23683 * @warning It is highly recommended just create a transit with this effect when
23684 * the window that the objects of the transit belongs has already been created.
23685 * This is because this effect needs the geometry information about the objects,
23686 * and if the window was not created yet, it can get a wrong information.
23688 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23691 * Add the ImageAnimation Effect to Elm_Transit.
23693 * @note This API is one of the facades. It creates image animation effect context
23694 * and add it's required APIs to elm_transit_effect_add.
23695 * The @p images parameter is a list images paths. This list and
23696 * its contents will be deleted at the end of the effect by
23697 * elm_transit_effect_image_animation_context_free() function.
23701 * char buf[PATH_MAX];
23702 * Eina_List *images = NULL;
23703 * Elm_Transit *transi = elm_transit_add();
23705 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23706 * images = eina_list_append(images, eina_stringshare_add(buf));
23708 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23709 * images = eina_list_append(images, eina_stringshare_add(buf));
23710 * elm_transit_effect_image_animation_add(transi, images);
23714 * @see elm_transit_effect_add()
23716 * @param transit Transit object.
23717 * @param images Eina_List of images file paths. This list and
23718 * its contents will be deleted at the end of the effect by
23719 * elm_transit_effect_image_animation_context_free() function.
23720 * @return Image Animation effect context data.
23724 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23729 typedef struct _Elm_Store Elm_Store;
23730 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23731 typedef struct _Elm_Store_Item Elm_Store_Item;
23732 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23733 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23734 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23735 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23736 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23737 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23738 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23739 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23741 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23742 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23743 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23744 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23748 ELM_STORE_ITEM_MAPPING_NONE = 0,
23749 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23750 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23751 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23752 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23753 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23754 // can add more here as needed by common apps
23755 ELM_STORE_ITEM_MAPPING_LAST
23756 } Elm_Store_Item_Mapping_Type;
23758 struct _Elm_Store_Item_Mapping_Icon
23760 // FIXME: allow edje file icons
23762 Elm_Icon_Lookup_Order lookup_order;
23763 Eina_Bool standard_name : 1;
23764 Eina_Bool no_scale : 1;
23765 Eina_Bool smooth : 1;
23766 Eina_Bool scale_up : 1;
23767 Eina_Bool scale_down : 1;
23770 struct _Elm_Store_Item_Mapping_Empty
23775 struct _Elm_Store_Item_Mapping_Photo
23780 struct _Elm_Store_Item_Mapping_Custom
23782 Elm_Store_Item_Mapping_Cb func;
23785 struct _Elm_Store_Item_Mapping
23787 Elm_Store_Item_Mapping_Type type;
23792 Elm_Store_Item_Mapping_Empty empty;
23793 Elm_Store_Item_Mapping_Icon icon;
23794 Elm_Store_Item_Mapping_Photo photo;
23795 Elm_Store_Item_Mapping_Custom custom;
23796 // add more types here
23800 struct _Elm_Store_Item_Info
23802 Elm_Genlist_Item_Class *item_class;
23803 const Elm_Store_Item_Mapping *mapping;
23808 struct _Elm_Store_Item_Info_Filesystem
23810 Elm_Store_Item_Info base;
23814 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23815 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23817 EAPI void elm_store_free(Elm_Store *st);
23819 EAPI Elm_Store *elm_store_filesystem_new(void);
23820 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23821 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23822 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23824 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23826 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23827 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23828 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23829 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23830 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23831 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23833 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23834 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23835 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23836 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23837 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23838 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23839 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23842 * @defgroup SegmentControl SegmentControl
23843 * @ingroup Elementary
23845 * @image html img/widget/segment_control/preview-00.png
23846 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23848 * @image html img/segment_control.png
23849 * @image latex img/segment_control.eps width=\textwidth
23851 * Segment control widget is a horizontal control made of multiple segment
23852 * items, each segment item functioning similar to discrete two state button.
23853 * A segment control groups the items together and provides compact
23854 * single button with multiple equal size segments.
23856 * Segment item size is determined by base widget
23857 * size and the number of items added.
23858 * Only one segment item can be at selected state. A segment item can display
23859 * combination of Text and any Evas_Object like Images or other widget.
23861 * Smart callbacks one can listen to:
23862 * - "changed" - When the user clicks on a segment item which is not
23863 * previously selected and get selected. The event_info parameter is the
23864 * segment item index.
23866 * Available styles for it:
23869 * Here is an example on its usage:
23870 * @li @ref segment_control_example
23874 * @addtogroup SegmentControl
23878 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23881 * Add a new segment control widget to the given parent Elementary
23882 * (container) object.
23884 * @param parent The parent object.
23885 * @return a new segment control widget handle or @c NULL, on errors.
23887 * This function inserts a new segment control widget on the canvas.
23889 * @ingroup SegmentControl
23891 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23894 * Append a new item to the segment control object.
23896 * @param obj The segment control object.
23897 * @param icon The icon object to use for the left side of the item. An
23898 * icon can be any Evas object, but usually it is an icon created
23899 * with elm_icon_add().
23900 * @param label The label of the item.
23901 * Note that, NULL is different from empty string "".
23902 * @return The created item or @c NULL upon failure.
23904 * A new item will be created and appended to the segment control, i.e., will
23905 * be set as @b last item.
23907 * If it should be inserted at another position,
23908 * elm_segment_control_item_insert_at() should be used instead.
23910 * Items created with this function can be deleted with function
23911 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23913 * @note @p label set to @c NULL is different from empty string "".
23915 * only has icon, it will be displayed bigger and centered. If it has
23916 * icon and label, even that an empty string, icon will be smaller and
23917 * positioned at left.
23921 * sc = elm_segment_control_add(win);
23922 * ic = elm_icon_add(win);
23923 * elm_icon_file_set(ic, "path/to/image", NULL);
23924 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23925 * elm_segment_control_item_add(sc, ic, "label");
23926 * evas_object_show(sc);
23929 * @see elm_segment_control_item_insert_at()
23930 * @see elm_segment_control_item_del()
23932 * @ingroup SegmentControl
23934 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23937 * Insert a new item to the segment control object at specified position.
23939 * @param obj The segment control object.
23940 * @param icon The icon object to use for the left side of the item. An
23941 * icon can be any Evas object, but usually it is an icon created
23942 * with elm_icon_add().
23943 * @param label The label of the item.
23944 * @param index Item position. Value should be between 0 and items count.
23945 * @return The created item or @c NULL upon failure.
23947 * Index values must be between @c 0, when item will be prepended to
23948 * segment control, and items count, that can be get with
23949 * elm_segment_control_item_count_get(), case when item will be appended
23950 * to segment control, just like elm_segment_control_item_add().
23952 * Items created with this function can be deleted with function
23953 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23955 * @note @p label set to @c NULL is different from empty string "".
23957 * only has icon, it will be displayed bigger and centered. If it has
23958 * icon and label, even that an empty string, icon will be smaller and
23959 * positioned at left.
23961 * @see elm_segment_control_item_add()
23962 * @see elm_segment_control_count_get()
23963 * @see elm_segment_control_item_del()
23965 * @ingroup SegmentControl
23967 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);
23970 * Remove a segment control item from its parent, deleting it.
23972 * @param it The item to be removed.
23974 * Items can be added with elm_segment_control_item_add() or
23975 * elm_segment_control_item_insert_at().
23977 * @ingroup SegmentControl
23979 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23982 * Remove a segment control item at given index from its parent,
23985 * @param obj The segment control object.
23986 * @param index The position of the segment control item to be deleted.
23988 * Items can be added with elm_segment_control_item_add() or
23989 * elm_segment_control_item_insert_at().
23991 * @ingroup SegmentControl
23993 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23996 * Get the Segment items count from segment control.
23998 * @param obj The segment control object.
23999 * @return Segment items count.
24001 * It will just return the number of items added to segment control @p obj.
24003 * @ingroup SegmentControl
24005 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24008 * Get the item placed at specified index.
24010 * @param obj The segment control object.
24011 * @param index The index of the segment item.
24012 * @return The segment control item or @c NULL on failure.
24014 * Index is the position of an item in segment control widget. Its
24015 * range is from @c 0 to <tt> count - 1 </tt>.
24016 * Count is the number of items, that can be get with
24017 * elm_segment_control_item_count_get().
24019 * @ingroup SegmentControl
24021 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24024 * Get the label of item.
24026 * @param obj The segment control object.
24027 * @param index The index of the segment item.
24028 * @return The label of the item at @p index.
24030 * The return value is a pointer to the label associated to the item when
24031 * it was created, with function elm_segment_control_item_add(), or later
24032 * with function elm_segment_control_item_label_set. If no label
24033 * was passed as argument, it will return @c NULL.
24035 * @see elm_segment_control_item_label_set() for more details.
24036 * @see elm_segment_control_item_add()
24038 * @ingroup SegmentControl
24040 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24043 * Set the label of item.
24045 * @param it The item of segment control.
24046 * @param text The label of item.
24048 * The label to be displayed by the item.
24049 * Label will be at right of the icon (if set).
24051 * If a label was passed as argument on item creation, with function
24052 * elm_control_segment_item_add(), it will be already
24053 * displayed by the item.
24055 * @see elm_segment_control_item_label_get()
24056 * @see elm_segment_control_item_add()
24058 * @ingroup SegmentControl
24060 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
24063 * Get the icon associated to the item.
24065 * @param obj The segment control object.
24066 * @param index The index of the segment item.
24067 * @return The left side icon associated to the item at @p index.
24069 * The return value is a pointer to the icon associated to the item when
24070 * it was created, with function elm_segment_control_item_add(), or later
24071 * with function elm_segment_control_item_icon_set(). If no icon
24072 * was passed as argument, it will return @c NULL.
24074 * @see elm_segment_control_item_add()
24075 * @see elm_segment_control_item_icon_set()
24077 * @ingroup SegmentControl
24079 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
24082 * Set the icon associated to the item.
24084 * @param it The segment control item.
24085 * @param icon The icon object to associate with @p it.
24087 * The icon object to use at left side of the item. An
24088 * icon can be any Evas object, but usually it is an icon created
24089 * with elm_icon_add().
24091 * Once the icon object is set, a previously set one will be deleted.
24092 * @warning Setting the same icon for two items will cause the icon to
24093 * dissapear from the first item.
24095 * If an icon was passed as argument on item creation, with function
24096 * elm_segment_control_item_add(), it will be already
24097 * associated to the item.
24099 * @see elm_segment_control_item_add()
24100 * @see elm_segment_control_item_icon_get()
24102 * @ingroup SegmentControl
24104 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24107 * Get the index of an item.
24109 * @param it The segment control item.
24110 * @return The position of item in segment control widget.
24112 * Index is the position of an item in segment control widget. Its
24113 * range is from @c 0 to <tt> count - 1 </tt>.
24114 * Count is the number of items, that can be get with
24115 * elm_segment_control_item_count_get().
24117 * @ingroup SegmentControl
24119 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24122 * Get the base object of the item.
24124 * @param it The segment control item.
24125 * @return The base object associated with @p it.
24127 * Base object is the @c Evas_Object that represents that item.
24129 * @ingroup SegmentControl
24131 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24134 * Get the selected item.
24136 * @param obj The segment control object.
24137 * @return The selected item or @c NULL if none of segment items is
24140 * The selected item can be unselected with function
24141 * elm_segment_control_item_selected_set().
24143 * The selected item always will be highlighted on segment control.
24145 * @ingroup SegmentControl
24147 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24150 * Set the selected state of an item.
24152 * @param it The segment control item
24153 * @param select The selected state
24155 * This sets the selected state of the given item @p it.
24156 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24158 * If a new item is selected the previosly selected will be unselected.
24159 * Previoulsy selected item can be get with function
24160 * elm_segment_control_item_selected_get().
24162 * The selected item always will be highlighted on segment control.
24164 * @see elm_segment_control_item_selected_get()
24166 * @ingroup SegmentControl
24168 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24175 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24176 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24177 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24178 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24179 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24180 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24181 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24182 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24185 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
24186 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
24187 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
24189 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24190 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24191 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24192 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24193 EAPI void elm_video_play(Evas_Object *video);
24194 EAPI void elm_video_pause(Evas_Object *video);
24195 EAPI void elm_video_stop(Evas_Object *video);
24196 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24197 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24198 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24199 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24200 EAPI double elm_video_audio_level_get(Evas_Object *video);
24201 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24202 EAPI double elm_video_play_position_get(Evas_Object *video);
24203 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24204 EAPI double elm_video_play_length_get(Evas_Object *video);
24205 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24206 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24207 EAPI const char *elm_video_title_get(Evas_Object *video);
24209 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24210 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24213 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24214 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);
24215 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24216 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24217 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24218 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24219 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24220 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24221 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24222 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24223 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24224 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24225 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24226 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24227 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);