3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
35 @section license License
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
49 * @defgroup Start Getting Started
51 * To write an Elementary app, you can get started with the following:
54 * #include <Elementary.h>
56 * elm_main(int argc, char **argv)
58 * // create window(s) here and do any application init
59 * elm_run(); // run main loop
60 * elm_shutdown(); // after mainloop finishes running, shutdown
61 * return 0; // exit 0 for exit code
66 * To use autotools (which helps in many ways in the long run, like being able
67 * to immediately create releases of your software directly from your tree
68 * and ensure everything needed to buiuld it is there) you will need a
69 * configure.ac, Makefile.am and autogen.sh file.
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
90 INCLUDES = -I$(top_srcdir)
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
110 * To generate all the things needed to bootstrap just run:
116 * This will generate Makefile.in's, the confgure script and everything else.
117 * After this it works like all normal autotools projects:
124 * Note sudo was assumed to get root permissions, as this would install in
125 * /usr/local which is system-owned. Use any way you like to gain root, or
126 * specify a different prefix with configure:
129 ./confiugre --prefix=$HOME/mysoftware
132 * Also remember that autotools buys you some useful commands like:
137 * This uninstalls the software after it was installed with "make install".
138 * It is very useful to clear up what you built if you wish to clean the
145 * This firstly checks if your build tree is "clean" and ready for
146 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147 * ready to upload and distribute to the world, that contains the generated
148 * Makefile.in's and configure script. The users do not need to run
149 * autogen.sh - just configure and on. They don't need autotools installed.
150 * This tarball also builds cleanly, has all the sources it needs to build
151 * included (that is sources for your application, not libraries it depends
152 * on like Elementary). It builds cleanly in a buildroot and does not
153 * contain any files that are temporarily generated like binaries and other
154 * build-generated files, so the tarball is clean, and no need to worry
155 * about cleaning up your tree before packaging.
161 * This cleans up all build files (binaries, objects etc.) from the tree.
167 * This cleans out all files from the build and from configure's output too.
170 make maintainer-clean
173 * This deletes all the files autogen.sh will produce so the tree is clean
174 * to be put into a revision-control system (like CVS, SVN or GIT for example).
176 * There is a more advanced way of making use of the quicklaunch infrastructure
177 * in Elementary (which will not be covered here due to its more advanced
182 @page authors Authors
183 @author Carsten Haitzler <raster@@rasterman.com>
184 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
185 @author Cedric Bail <cedric.bail@@free.fr>
186 @author Vincent Torri <vtorri@@univ-evry.fr>
187 @author Daniel Kolesa <quaker66@@gmail.com>
188 @author Jaime Thomas <avi.thomas@@gmail.com>
189 @author Swisscom - http://www.swisscom.ch/
190 @author Christopher Michael <devilhorns@@comcast.net>
191 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
192 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
193 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
194 @author Brian Wang <brian.wang.0721@@gmail.com>
195 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
196 @author Samsung Electronics <tbd>
197 @author Samsung SAIT <tbd>
198 @author Brett Nash <nash@@nash.id.au>
199 @author Bruno Dilly <bdilly@@profusion.mobi>
200 @author Rafael Fonseca <rfonseca@@profusion.mobi>
201 @author Chuneon Park <hermet@@hermet.pe.kr>
202 @author Woohyun Jung <wh0705.jung@@samsung.com>
203 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
204 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
205 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
206 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
207 @author Gustavo Lima Chaves <glima@@profusion.mobi>
208 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
209 @author Tiago Falcão <tiago@@profusion.mobi>
210 @author Otavio Pontes <otavio@@profusion.mobi>
211 @author Viktor Kojouharov <vkojouharov@@gmail.com>
212 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
213 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
214 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
215 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
216 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
217 @author Jihoon Kim <jihoon48.kim@@samsung.com>
218 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
219 @author Tom Hacohen <tom@@stosb.com>
220 @author Aharon Hillel <a.hillel@@partner.samsung.com>
221 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
222 @author Shinwoo Kim <kimcinoo@@gmail.com>
223 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
224 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
226 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
227 contact with the developers and maintainers.
235 * @brief Elementary's API
240 @ELM_UNIX_DEF@ ELM_UNIX
241 @ELM_WIN32_DEF@ ELM_WIN32
242 @ELM_WINCE_DEF@ ELM_WINCE
243 @ELM_EDBUS_DEF@ ELM_EDBUS
244 @ELM_EFREET_DEF@ ELM_EFREET
245 @ELM_ETHUMB_DEF@ ELM_ETHUMB
246 @ELM_EMAP_DEF@ ELM_EMAP
247 @ELM_DEBUG_DEF@ ELM_DEBUG
248 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
249 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
251 /* Standard headers for standard system calls etc. */
256 #include <sys/types.h>
257 #include <sys/stat.h>
258 #include <sys/time.h>
259 #include <sys/param.h>
272 # ifdef ELM_LIBINTL_H
273 # include <libintl.h>
284 #if defined (ELM_WIN32) || defined (ELM_WINCE)
287 # define alloca _alloca
298 #include <Ecore_Evas.h>
299 #include <Ecore_File.h>
300 #include <Ecore_IMF.h>
301 #include <Ecore_Con.h>
310 # include <Efreet_Mime.h>
311 # include <Efreet_Trash.h>
315 # include <Ethumb_Client.h>
327 # ifdef ELEMENTARY_BUILD
329 # define EAPI __declspec(dllexport)
332 # endif /* ! DLL_EXPORT */
334 # define EAPI __declspec(dllimport)
335 # endif /* ! EFL_EVAS_BUILD */
339 # define EAPI __attribute__ ((visibility("default")))
346 #endif /* ! _WIN32 */
349 /* allow usage from c++ */
354 #define ELM_VERSION_MAJOR @VMAJ@
355 #define ELM_VERSION_MINOR @VMIN@
357 typedef struct _Elm_Version
365 EAPI extern Elm_Version *elm_version;
368 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
369 #define ELM_PI 3.14159265358979323846
372 * @defgroup General General
374 * @brief General Elementary API. Functions that don't relate to
375 * Elementary objects specifically.
377 * Here are documented functions which init/shutdown the library,
378 * that apply to generic Elementary objects, that deal with
379 * configuration, et cetera.
381 * @ref general_functions_example_page "This" example contemplates
382 * some of these functions.
386 * @addtogroup General
391 * Defines couple of standard Evas_Object layers to be used
392 * with evas_object_layer_set().
394 * @note whenever extending with new values, try to keep some padding
395 * to siblings so there is room for further extensions.
397 typedef enum _Elm_Object_Layer
399 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
400 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
401 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
402 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
403 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
404 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
407 /**************************************************************************/
408 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
411 * Emitted when any Elementary's policy value is changed.
413 EAPI extern int ELM_EVENT_POLICY_CHANGED;
416 * @typedef Elm_Event_Policy_Changed
418 * Data on the event when an Elementary policy has changed
420 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
423 * @struct _Elm_Event_Policy_Changed
425 * Data on the event when an Elementary policy has changed
427 struct _Elm_Event_Policy_Changed
429 unsigned int policy; /**< the policy identifier */
430 int new_value; /**< value the policy had before the change */
431 int old_value; /**< new value the policy got */
435 * Policy identifiers.
437 typedef enum _Elm_Policy
439 ELM_POLICY_QUIT, /**< under which circunstances the application
440 * should quit automatically. @see
444 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
447 typedef enum _Elm_Policy_Quit
449 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
451 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
453 * window is closed */
454 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
456 typedef enum _Elm_Focus_Direction
460 } Elm_Focus_Direction;
462 typedef enum _Elm_Text_Format
464 ELM_TEXT_FORMAT_PLAIN_UTF8,
465 ELM_TEXT_FORMAT_MARKUP_UTF8
469 * Line wrapping types.
471 typedef enum _Elm_Wrap_Type
473 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
474 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
475 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
476 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
481 * @typedef Elm_Object_Item
482 * An Elementary Object item handle.
485 typedef struct _Elm_Object_Item Elm_Object_Item;
489 * Called back when a widget's tooltip is activated and needs content.
490 * @param data user-data given to elm_object_tooltip_content_cb_set()
491 * @param obj owner widget.
492 * @param tooltip The tooltip object (affix content to this!)
494 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
497 * Called back when a widget's item tooltip is activated and needs content.
498 * @param data user-data given to elm_object_tooltip_content_cb_set()
499 * @param obj owner widget.
500 * @param tooltip The tooltip object (affix content to this!)
501 * @param item context dependent item. As an example, if tooltip was
502 * set on Elm_List_Item, then it is of this type.
504 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
506 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
508 #ifndef ELM_LIB_QUICKLAUNCH
509 #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 */
511 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
514 /**************************************************************************/
518 * Initialize Elementary
520 * @param[in] argc System's argument count value
521 * @param[in] argv System's pointer to array of argument strings
522 * @return The init counter value.
524 * This function initializes Elementary and increments a counter of
525 * the number of calls to it. It returs the new counter's value.
527 * @warning This call is exported only for use by the @c ELM_MAIN()
528 * macro. There is no need to use this if you use this macro (which
529 * is highly advisable). An elm_main() should contain the entry
530 * point code for your application, having the same prototype as
531 * elm_init(), and @b not being static (putting the @c EAPI symbol
532 * in front of its type declaration is advisable). The @c
533 * ELM_MAIN() call should be placed just after it.
536 * @dontinclude bg_example_01.c
540 * See the full @ref bg_example_01_c "example".
542 * @see elm_shutdown().
545 EAPI int elm_init(int argc, char **argv);
548 * Shut down Elementary
550 * @return The init counter value.
552 * This should be called at the end of your application, just
553 * before it ceases to do any more processing. This will clean up
554 * any permanent resources your application may have allocated via
555 * Elementary that would otherwise persist.
557 * @see elm_init() for an example
561 EAPI int elm_shutdown(void);
564 * Run Elementary's main loop
566 * This call should be issued just after all initialization is
567 * completed. This function will not return until elm_exit() is
568 * called. It will keep looping, running the main
569 * (event/processing) loop for Elementary.
571 * @see elm_init() for an example
575 EAPI void elm_run(void);
578 * Exit Elementary's main loop
580 * If this call is issued, it will flag the main loop to cease
581 * processing and return back to its parent function (usually your
582 * elm_main() function).
584 * @see elm_init() for an example. There, just after a request to
585 * close the window comes, the main loop will be left.
587 * @note By using the #ELM_POLICY_QUIT on your Elementary
588 * applications, you'll this function called automatically for you.
592 EAPI void elm_exit(void);
595 * Provide information in order to make Elementary determine the @b
596 * run time location of the software in question, so other data files
597 * such as images, sound files, executable utilities, libraries,
598 * modules and locale files can be found.
600 * @param mainfunc This is your application's main function name,
601 * whose binary's location is to be found. Providing @c NULL
602 * will make Elementary not to use it
603 * @param dom This will be used as the application's "domain", in the
604 * form of a prefix to any environment variables that may
605 * override prefix detection and the directory name, inside the
606 * standard share or data directories, where the software's
607 * data files will be looked for.
608 * @param checkfile This is an (optional) magic file's path to check
609 * for existence (and it must be located in the data directory,
610 * under the share directory provided above). Its presence will
611 * help determine the prefix found was correct. Pass @c NULL if
612 * the check is not to be done.
614 * This function allows one to re-locate the application somewhere
615 * else after compilation, if the developer wishes for easier
616 * distribution of pre-compiled binaries.
618 * The prefix system is designed to locate where the given software is
619 * installed (under a common path prefix) at run time and then report
620 * specific locations of this prefix and common directories inside
621 * this prefix like the binary, library, data and locale directories,
622 * through the @c elm_app_*_get() family of functions.
624 * Call elm_app_info_set() early on before you change working
625 * directory or anything about @c argv[0], so it gets accurate
628 * It will then try and trace back which file @p mainfunc comes from,
629 * if provided, to determine the application's prefix directory.
631 * The @p dom parameter provides a string prefix to prepend before
632 * environment variables, allowing a fallback to @b specific
633 * environment variables to locate the software. You would most
634 * probably provide a lowercase string there, because it will also
635 * serve as directory domain, explained next. For environment
636 * variables purposes, this string is made uppercase. For example if
637 * @c "myapp" is provided as the prefix, then the program would expect
638 * @c "MYAPP_PREFIX" as a master environment variable to specify the
639 * exact install prefix for the software, or more specific environment
640 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
641 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
642 * the user or scripts before launching. If not provided (@c NULL),
643 * environment variables will not be used to override compiled-in
644 * defaults or auto detections.
646 * The @p dom string also provides a subdirectory inside the system
647 * shared data directory for data files. For example, if the system
648 * directory is @c /usr/local/share, then this directory name is
649 * appended, creating @c /usr/local/share/myapp, if it @p was @c
650 * "myapp". It is expected the application installs data files in
653 * The @p checkfile is a file name or path of something inside the
654 * share or data directory to be used to test that the prefix
655 * detection worked. For example, your app will install a wallpaper
656 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
657 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
660 * @see elm_app_compile_bin_dir_set()
661 * @see elm_app_compile_lib_dir_set()
662 * @see elm_app_compile_data_dir_set()
663 * @see elm_app_compile_locale_set()
664 * @see elm_app_prefix_dir_get()
665 * @see elm_app_bin_dir_get()
666 * @see elm_app_lib_dir_get()
667 * @see elm_app_data_dir_get()
668 * @see elm_app_locale_dir_get()
670 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
673 * Provide information on the @b fallback application's binaries
674 * directory, on scenarios where they get overriden by
675 * elm_app_info_set().
677 * @param dir The path to the default binaries directory (compile time
680 * @note Elementary will as well use this path to determine actual
681 * names of binaries' directory paths, maybe changing it to be @c
682 * something/local/bin instead of @c something/bin, only, for
685 * @warning You should call this function @b before
686 * elm_app_info_set().
688 EAPI void elm_app_compile_bin_dir_set(const char *dir);
691 * Provide information on the @b fallback application's libraries
692 * directory, on scenarios where they get overriden by
693 * elm_app_info_set().
695 * @param dir The path to the default libraries directory (compile
698 * @note Elementary will as well use this path to determine actual
699 * names of libraries' directory paths, maybe changing it to be @c
700 * something/lib32 or @c something/lib64 instead of @c something/lib,
703 * @warning You should call this function @b before
704 * elm_app_info_set().
706 EAPI void elm_app_compile_lib_dir_set(const char *dir);
709 * Provide information on the @b fallback application's data
710 * directory, on scenarios where they get overriden by
711 * elm_app_info_set().
713 * @param dir The path to the default data directory (compile time
716 * @note Elementary will as well use this path to determine actual
717 * names of data directory paths, maybe changing it to be @c
718 * something/local/share instead of @c something/share, only, for
721 * @warning You should call this function @b before
722 * elm_app_info_set().
724 EAPI void elm_app_compile_data_dir_set(const char *dir);
727 * Provide information on the @b fallback application's locale
728 * directory, on scenarios where they get overriden by
729 * elm_app_info_set().
731 * @param dir The path to the default locale directory (compile time
734 * @warning You should call this function @b before
735 * elm_app_info_set().
737 EAPI void elm_app_compile_locale_set(const char *dir);
740 * Retrieve the application's run time prefix directory, as set by
741 * elm_app_info_set() and the way (environment) the application was
744 * @return The directory prefix the application is actually using
746 EAPI const char *elm_app_prefix_dir_get(void);
749 * Retrieve the application's run time binaries prefix directory, as
750 * set by elm_app_info_set() and the way (environment) the application
753 * @return The binaries directory prefix the application is actually
756 EAPI const char *elm_app_bin_dir_get(void);
759 * Retrieve the application's run time libraries prefix directory, as
760 * set by elm_app_info_set() and the way (environment) the application
763 * @return The libraries directory prefix the application is actually
766 EAPI const char *elm_app_lib_dir_get(void);
769 * Retrieve the application's run time data prefix directory, as
770 * set by elm_app_info_set() and the way (environment) the application
773 * @return The data directory prefix the application is actually
776 EAPI const char *elm_app_data_dir_get(void);
779 * Retrieve the application's run time locale prefix directory, as
780 * set by elm_app_info_set() and the way (environment) the application
783 * @return The locale directory prefix the application is actually
786 EAPI const char *elm_app_locale_dir_get(void);
788 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
789 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
790 EAPI int elm_quicklaunch_init(int argc, char **argv);
791 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
792 EAPI int elm_quicklaunch_sub_shutdown(void);
793 EAPI int elm_quicklaunch_shutdown(void);
794 EAPI void elm_quicklaunch_seed(void);
795 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
796 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
797 EAPI void elm_quicklaunch_cleanup(void);
798 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
799 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
801 EAPI Eina_Bool elm_need_efreet(void);
802 EAPI Eina_Bool elm_need_e_dbus(void);
803 EAPI Eina_Bool elm_need_ethumb(void);
806 * Set a new policy's value (for a given policy group/identifier).
808 * @param policy policy identifier, as in @ref Elm_Policy.
809 * @param value policy value, which depends on the identifier
811 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
813 * Elementary policies define applications' behavior,
814 * somehow. These behaviors are divided in policy groups (see
815 * #Elm_Policy enumeration). This call will emit the Ecore event
816 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
817 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
820 * @note Currently, we have only one policy identifier/group
821 * (#ELM_POLICY_QUIT), which has two possible values.
825 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
828 * Gets the policy value set for given policy identifier.
830 * @param policy policy identifier, as in #Elm_Policy.
831 * @return The currently set policy value, for that
832 * identifier. Will be @c 0 if @p policy passed is invalid.
836 EAPI int elm_policy_get(unsigned int policy);
839 * Set a label of an object
841 * @param obj The Elementary object
842 * @param part The text part name to set (NULL for the default label)
843 * @param label The new text of the label
845 * @note Elementary objects may have many labels (e.g. Action Slider)
849 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
851 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
854 * Get a label of an object
856 * @param obj The Elementary object
857 * @param part The text part name to get (NULL for the default label)
858 * @return text of the label or NULL for any error
860 * @note Elementary objects may have many labels (e.g. Action Slider)
864 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
866 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
869 * Set a content of an object
871 * @param obj The Elementary object
872 * @param part The content part name to set (NULL for the default content)
873 * @param content The new content of the object
875 * @note Elementary objects may have many contents
879 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
881 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
884 * Get a content of an object
886 * @param obj The Elementary object
887 * @param item The content part name to get (NULL for the default content)
888 * @return content of the object or NULL for any error
890 * @note Elementary objects may have many contents
894 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
896 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
899 * Unset a content of an object
901 * @param obj The Elementary object
902 * @param item The content part name to unset (NULL for the default content)
904 * @note Elementary objects may have many contents
908 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
910 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
913 * Set a content of an object item
915 * @param it The Elementary object item
916 * @param part The content part name to unset (NULL for the default content)
917 * @param content The new content of the object item
919 * @note Elementary object items may have many contents
923 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
925 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
928 * Get a content of an object item
930 * @param it The Elementary object item
931 * @param part The content part name to unset (NULL for the default content)
932 * @return content of the object item or NULL for any error
934 * @note Elementary object items may have many contents
938 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
940 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
943 * Unset a content of an object item
945 * @param it The Elementary object item
946 * @param part The content part name to unset (NULL for the default content)
948 * @note Elementary object items may have many contents
952 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
954 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
957 * Set a label of an objec itemt
959 * @param it The Elementary object item
960 * @param part The text part name to set (NULL for the default label)
961 * @param label The new text of the label
963 * @note Elementary object items may have many labels
967 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
969 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
972 * Get a label of an object
974 * @param it The Elementary object item
975 * @param part The text part name to get (NULL for the default label)
976 * @return text of the label or NULL for any error
978 * @note Elementary object items may have many labels
982 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
984 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
990 EAPI void elm_all_flush(void);
991 EAPI int elm_cache_flush_interval_get(void);
992 EAPI void elm_cache_flush_interval_set(int size);
993 EAPI void elm_cache_flush_interval_all_set(int size);
994 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
995 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
996 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
997 EAPI int elm_font_cache_get(void);
998 EAPI void elm_font_cache_set(int size);
999 EAPI void elm_font_cache_all_set(int size);
1000 EAPI int elm_image_cache_get(void);
1001 EAPI void elm_image_cache_set(int size);
1002 EAPI void elm_image_cache_all_set(int size);
1003 EAPI int elm_edje_file_cache_get(void);
1004 EAPI void elm_edje_file_cache_set(int size);
1005 EAPI void elm_edje_file_cache_all_set(int size);
1006 EAPI int elm_edje_collection_cache_get(void);
1007 EAPI void elm_edje_collection_cache_set(int size);
1008 EAPI void elm_edje_collection_cache_all_set(int size);
1011 * @defgroup Scaling Selective Widget Scaling
1013 * Different widgets can be scaled independently. These functions
1014 * allow you to manipulate this scaling on a per-widget basis. The
1015 * object and all its children get their scaling factors multiplied
1016 * by the scale factor set. This is multiplicative, in that if a
1017 * child also has a scale size set it is in turn multiplied by its
1018 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1019 * double size, @c 0.5 is half, etc.
1021 * @ref general_functions_example_page "This" example contemplates
1022 * some of these functions.
1026 * Set the scaling factor for a given Elementary object
1028 * @param obj The Elementary to operate on
1029 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1034 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1037 * Get the scaling factor for a given Elementary object
1039 * @param obj The object
1040 * @return The scaling factor set by elm_object_scale_set()
1044 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1045 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1046 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1047 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1048 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1050 * Set the style to use by a widget
1052 * Sets the style name that will define the appearance of a widget. Styles
1053 * vary from widget to widget and may also be defined by other themes
1054 * by means of extensions and overlays.
1056 * @param obj The Elementary widget to style
1057 * @param style The style name to use
1059 * @see elm_theme_extension_add()
1060 * @see elm_theme_overlay_add()
1064 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1066 * Get the style used by the widget
1068 * This gets the style being used for that widget. Note that the string
1069 * pointer is only valid as longas the object is valid and the style doesn't
1072 * @param obj The Elementary widget to query for its style
1073 * @return The style name used
1075 * @see elm_object_style_set()
1079 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1082 * @defgroup Styles Styles
1084 * Widgets can have different styles of look. These generic API's
1085 * set styles of widgets, if they support them (and if the theme(s)
1088 * @ref general_functions_example_page "This" example contemplates
1089 * some of these functions.
1093 * Set the disabled state of an Elementary object.
1095 * @param obj The Elementary object to operate on
1096 * @param disabled The state to put in in: @c EINA_TRUE for
1097 * disabled, @c EINA_FALSE for enabled
1099 * Elementary objects can be @b disabled, in which state they won't
1100 * receive input and, in general, will be themed differently from
1101 * their normal state, usually greyed out. Useful for contexts
1102 * where you don't want your users to interact with some of the
1103 * parts of you interface.
1105 * This sets the state for the widget, either disabling it or
1110 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1113 * Get the disabled state of an Elementary object.
1115 * @param obj The Elementary object to operate on
1116 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1117 * if it's enabled (or on errors)
1119 * This gets the state of the widget, which might be enabled or disabled.
1123 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1126 * @defgroup WidgetNavigation Widget Tree Navigation.
1128 * How to check if an Evas Object is an Elementary widget? How to
1129 * get the first elementary widget that is parent of the given
1130 * object? These are all covered in widget tree navigation.
1132 * @ref general_functions_example_page "This" example contemplates
1133 * some of these functions.
1136 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1139 * Get the first parent of the given object that is an Elementary
1142 * @param obj the Elementary object to query parent from.
1143 * @return the parent object that is an Elementary widget, or @c
1144 * NULL, if it was not found.
1146 * Use this to query for an object's parent widget.
1148 * @note Most of Elementary users wouldn't be mixing non-Elementary
1149 * smart objects in the objects tree of an application, as this is
1150 * an advanced usage of Elementary with Evas. So, except for the
1151 * application's window, which is the root of that tree, all other
1152 * objects would have valid Elementary widget parents.
1154 * @ingroup WidgetNavigation
1156 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1157 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1158 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1160 EAPI double elm_scale_get(void);
1161 EAPI void elm_scale_set(double scale);
1162 EAPI void elm_scale_all_set(double scale);
1164 EAPI Eina_Bool elm_mirrored_get(void);
1165 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1167 EAPI Eina_Bool elm_config_save(void);
1168 EAPI void elm_config_reload(void);
1170 EAPI const char *elm_profile_current_get(void);
1171 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1172 EAPI void elm_profile_dir_free(const char *p_dir);
1173 EAPI Eina_List *elm_profile_list_get(void);
1174 EAPI void elm_profile_list_free(Eina_List *l);
1175 EAPI void elm_profile_set(const char *profile);
1176 EAPI void elm_profile_all_set(const char *profile);
1178 EAPI const char *elm_engine_current_get(void);
1179 EAPI void elm_engine_set(const char *engine);
1181 typedef struct _Elm_Text_Class
1187 typedef struct _Elm_Font_Overlay
1189 const char *text_class;
1191 Evas_Font_Size size;
1194 typedef struct _Elm_Font_Properties
1198 } Elm_Font_Properties;
1200 EAPI const Eina_List *elm_text_classes_list_get(void);
1201 EAPI void elm_text_classes_list_free(const Eina_List *list);
1203 EAPI const Eina_List *elm_font_overlay_list_get(void);
1204 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1205 EAPI void elm_font_overlay_unset(const char *text_class);
1206 EAPI void elm_font_overlay_apply(void);
1207 EAPI void elm_font_overlay_all_apply(void);
1209 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1210 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1211 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1212 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1213 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1214 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1217 * @defgroup Fingers Fingers
1219 * Elementary is designed to be finger-friendly for touchscreens,
1220 * and so in addition to scaling for display resolution, it can
1221 * also scale based on finger "resolution" (or size). You can then
1222 * customize the granularity of the areas meant to receive clicks
1225 * Different profiles may have pre-set values for finger sizes.
1227 * @ref general_functions_example_page "This" example contemplates
1228 * some of these functions.
1232 * Get the configured "finger size"
1234 * @return The finger size
1236 * This gets the globally configured finger size, <b>in pixels</b>
1240 EAPI Evas_Coord elm_finger_size_get(void);
1241 EAPI void elm_finger_size_set(Evas_Coord size);
1242 EAPI void elm_finger_size_all_set(Evas_Coord size);
1245 * @defgroup Focus Focus
1247 * An Elementary application has, at all times, one (and only one)
1248 * @b focused object. This is what determines where the input
1249 * events go to within the application's window. Also, focused
1250 * objects can be decorated differently, in order to signal to the
1251 * user where the input is, at a given moment.
1253 * Elementary applications also have the concept of <b>focus
1254 * chain</b>: one can cycle through all the windows' focusable
1255 * objects by input (tab key) or programmatically. The default
1256 * focus chain for an application is the one define by the order in
1257 * which the widgets where added in code. One will cycle through
1258 * top level widgets, and, for each one containg sub-objects, cycle
1259 * through them all, before returning to the level
1260 * above. Elementary also allows one to set @b custom focus chains
1261 * for their applications.
1263 * Besides the focused decoration a widget may exhibit, when it
1264 * gets focus, Elementary has a @b global focus highlight object
1265 * that can be enabled for a window. If one chooses to do so, this
1266 * extra highlight effect will surround the current focused object,
1269 * @note Some Elementary widgets are @b unfocusable, after
1270 * creation, by their very nature: they are not meant to be
1271 * interacted with input events, but are there just for visual
1274 * @ref general_functions_example_page "This" example contemplates
1275 * some of these functions.
1278 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1279 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1280 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1281 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1284 * Get the whether an Elementary object has the focus or not.
1286 * @param obj The Elementary object to get the information from
1287 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1288 * not (and on errors).
1290 * @see elm_object_focus_set()
1294 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1297 * Set/unset focus to a given Elementary object.
1299 * @param obj The Elementary object to operate on.
1300 * @param enable @c EINA_TRUE Set focus to a given object,
1301 * @c EINA_FALSE Unset focus to a given object.
1303 * @note When you set focus to this object, if it can handle focus, will
1304 * take the focus away from the one who had it previously and will, for
1305 * now on, be the one receiving input events. Unsetting focus will remove
1306 * the focus from @p obj, passing it back to the previous element in the
1309 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
1313 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
1316 * Make a given Elementary object the focused one.
1318 * @param obj The Elementary object to make focused.
1320 * @note This object, if it can handle focus, will take the focus
1321 * away from the one who had it previously and will, for now on, be
1322 * the one receiving input events.
1324 * @see elm_object_focus_get()
1325 * @deprecated use elm_object_focus_set() instead.
1329 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1332 * Remove the focus from an Elementary object
1334 * @param obj The Elementary to take focus from
1336 * This removes the focus from @p obj, passing it back to the
1337 * previous element in the focus chain list.
1339 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1340 * @deprecated use elm_object_focus_set() instead.
1344 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1347 * Set the ability for an Element object to be focused
1349 * @param obj The Elementary object to operate on
1350 * @param enable @c EINA_TRUE if the object can be focused, @c
1351 * EINA_FALSE if not (and on errors)
1353 * This sets whether the object @p obj is able to take focus or
1354 * not. Unfocusable objects do nothing when programmatically
1355 * focused, being the nearest focusable parent object the one
1356 * really getting focus. Also, when they receive mouse input, they
1357 * will get the event, but not take away the focus from where it
1362 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1365 * Get whether an Elementary object is focusable or not
1367 * @param obj The Elementary object to operate on
1368 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1369 * EINA_FALSE if not (and on errors)
1371 * @note Objects which are meant to be interacted with by input
1372 * events are created able to be focused, by default. All the
1377 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1379 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1380 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1381 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1382 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1383 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1384 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1385 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1388 * Make the elementary object and its children to be unfocusable (or focusable).
1390 * @param obj The Elementary object to operate on
1391 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1392 * @c EINA_FALSE for focusable.
1394 * This sets whether the object @p obj and its children objects
1395 * are able to take focus or not. If the tree is set as unfocusable,
1396 * newest focused object which is not in this tree will get focus.
1397 * This API can be helpful for an object to be deleted.
1398 * When an object will be deleted soon, it and its children may not
1399 * want to get focus (by focus reverting or by other focus controls).
1400 * Then, just use this API before deleting.
1402 * @see elm_object_tree_unfocusable_get()
1406 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1409 * Get whether an Elementary object and its children are unfocusable or not.
1411 * @param obj The Elementary object to get the information from
1412 * @return @c EINA_TRUE, if the tree is unfocussable,
1413 * @c EINA_FALSE if not (and on errors).
1415 * @see elm_object_tree_unfocusable_set()
1419 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1421 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1422 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1423 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1424 EAPI double elm_scroll_bounce_friction_get(void);
1425 EAPI void elm_scroll_bounce_friction_set(double friction);
1426 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1427 EAPI double elm_scroll_page_scroll_friction_get(void);
1428 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1429 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1430 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1431 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1432 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1433 EAPI double elm_scroll_zoom_friction_get(void);
1434 EAPI void elm_scroll_zoom_friction_set(double friction);
1435 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1436 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1437 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1438 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1439 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1440 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1441 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1442 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1443 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1444 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1445 EAPI double elm_scroll_thumbscroll_friction_get(void);
1446 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1447 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1448 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1449 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1450 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1452 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1453 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1454 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1455 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1456 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1457 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1458 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1459 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1461 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1462 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);
1463 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);
1465 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1466 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1469 * Adjust size of an element for finger usage.
1471 * @param times_w How many fingers should fit horizontally
1472 * @param w Pointer to the width size to adjust
1473 * @param times_h How many fingers should fit vertically
1474 * @param h Pointer to the height size to adjust
1476 * This takes width and height sizes (in pixels) as input and a
1477 * size multiple (which is how many fingers you want to place
1478 * within the area, being "finger" the size set by
1479 * elm_finger_size_set()), and adjusts the size to be large enough
1480 * to accommodate the resulting size -- if it doesn't already
1481 * accommodate it. On return the @p w and @p h sizes pointed to by
1482 * these parameters will be modified, on those conditions.
1484 * @note This is kind of a low level Elementary call, most useful
1485 * on size evaluation times for widgets. An external user wouldn't
1486 * be calling, most of the time.
1490 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1492 EAPI double elm_longpress_timeout_get(void);
1493 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1496 * don't use it unless you are sure
1498 EAPI void elm_object_tree_dump(const Evas_Object *top);
1499 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1504 * @defgroup Theme Theme
1506 * Elementary uses Edje to theme its widgets, naturally. But for the most
1507 * part this is hidden behind a simpler interface that lets the user set
1508 * extensions and choose the style of widgets in a much easier way.
1510 * Instead of thinking in terms of paths to Edje files and their groups
1511 * each time you want to change the appearance of a widget, Elementary
1512 * works so you can add any theme file with extensions or replace the
1513 * main theme at one point in the application, and then just set the style
1514 * of widgets with elm_object_style_set() and related functions. Elementary
1515 * will then look in its list of themes for a matching group and apply it,
1516 * and when the theme changes midway through the application, all widgets
1517 * will be updated accordingly.
1519 * There are three concepts you need to know to understand how Elementary
1520 * theming works: default theme, extensions and overlays.
1522 * Default theme, obviously enough, is the one that provides the default
1523 * look of all widgets. End users can change the theme used by Elementary
1524 * by setting the @c ELM_THEME environment variable before running an
1525 * application, or globally for all programs using the @c elementary_config
1526 * utility. Applications can change the default theme using elm_theme_set(),
1527 * but this can go against the user wishes, so it's not an adviced practice.
1529 * Ideally, applications should find everything they need in the already
1530 * provided theme, but there may be occasions when that's not enough and
1531 * custom styles are required to correctly express the idea. For this
1532 * cases, Elementary has extensions.
1534 * Extensions allow the application developer to write styles of its own
1535 * to apply to some widgets. This requires knowledge of how each widget
1536 * is themed, as extensions will always replace the entire group used by
1537 * the widget, so important signals and parts need to be there for the
1538 * object to behave properly (see documentation of Edje for details).
1539 * Once the theme for the extension is done, the application needs to add
1540 * it to the list of themes Elementary will look into, using
1541 * elm_theme_extension_add(), and set the style of the desired widgets as
1542 * he would normally with elm_object_style_set().
1544 * Overlays, on the other hand, can replace the look of all widgets by
1545 * overriding the default style. Like extensions, it's up to the application
1546 * developer to write the theme for the widgets it wants, the difference
1547 * being that when looking for the theme, Elementary will check first the
1548 * list of overlays, then the set theme and lastly the list of extensions,
1549 * so with overlays it's possible to replace the default view and every
1550 * widget will be affected. This is very much alike to setting the whole
1551 * theme for the application and will probably clash with the end user
1552 * options, not to mention the risk of ending up with not matching styles
1553 * across the program. Unless there's a very special reason to use them,
1554 * overlays should be avoided for the resons exposed before.
1556 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1557 * keeps one default internally and every function that receives one of
1558 * these can be called with NULL to refer to this default (except for
1559 * elm_theme_free()). It's possible to create a new instance of a
1560 * ::Elm_Theme to set other theme for a specific widget (and all of its
1561 * children), but this is as discouraged, if not even more so, than using
1562 * overlays. Don't use this unless you really know what you are doing.
1564 * But to be less negative about things, you can look at the following
1566 * @li @ref theme_example_01 "Using extensions"
1567 * @li @ref theme_example_02 "Using overlays"
1572 * @typedef Elm_Theme
1574 * Opaque handler for the list of themes Elementary looks for when
1575 * rendering widgets.
1577 * Stay out of this unless you really know what you are doing. For most
1578 * cases, sticking to the default is all a developer needs.
1580 typedef struct _Elm_Theme Elm_Theme;
1583 * Create a new specific theme
1585 * This creates an empty specific theme that only uses the default theme. A
1586 * specific theme has its own private set of extensions and overlays too
1587 * (which are empty by default). Specific themes do not fall back to themes
1588 * of parent objects. They are not intended for this use. Use styles, overlays
1589 * and extensions when needed, but avoid specific themes unless there is no
1590 * other way (example: you want to have a preview of a new theme you are
1591 * selecting in a "theme selector" window. The preview is inside a scroller
1592 * and should display what the theme you selected will look like, but not
1593 * actually apply it yet. The child of the scroller will have a specific
1594 * theme set to show this preview before the user decides to apply it to all
1597 EAPI Elm_Theme *elm_theme_new(void);
1599 * Free a specific theme
1601 * @param th The theme to free
1603 * This frees a theme created with elm_theme_new().
1605 EAPI void elm_theme_free(Elm_Theme *th);
1607 * Copy the theme fom the source to the destination theme
1609 * @param th The source theme to copy from
1610 * @param thdst The destination theme to copy data to
1612 * This makes a one-time static copy of all the theme config, extensions
1613 * and overlays from @p th to @p thdst. If @p th references a theme, then
1614 * @p thdst is also set to reference it, with all the theme settings,
1615 * overlays and extensions that @p th had.
1617 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1619 * Tell the source theme to reference the ref theme
1621 * @param th The theme that will do the referencing
1622 * @param thref The theme that is the reference source
1624 * This clears @p th to be empty and then sets it to refer to @p thref
1625 * so @p th acts as an override to @p thref, but where its overrides
1626 * don't apply, it will fall through to @p thref for configuration.
1628 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1630 * Return the theme referred to
1632 * @param th The theme to get the reference from
1633 * @return The referenced theme handle
1635 * This gets the theme set as the reference theme by elm_theme_ref_set().
1636 * If no theme is set as a reference, NULL is returned.
1638 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1640 * Return the default theme
1642 * @return The default theme handle
1644 * This returns the internal default theme setup handle that all widgets
1645 * use implicitly unless a specific theme is set. This is also often use
1646 * as a shorthand of NULL.
1648 EAPI Elm_Theme *elm_theme_default_get(void);
1650 * Prepends a theme overlay to the list of overlays
1652 * @param th The theme to add to, or if NULL, the default theme
1653 * @param item The Edje file path to be used
1655 * Use this if your application needs to provide some custom overlay theme
1656 * (An Edje file that replaces some default styles of widgets) where adding
1657 * new styles, or changing system theme configuration is not possible. Do
1658 * NOT use this instead of a proper system theme configuration. Use proper
1659 * configuration files, profiles, environment variables etc. to set a theme
1660 * so that the theme can be altered by simple confiugration by a user. Using
1661 * this call to achieve that effect is abusing the API and will create lots
1664 * @see elm_theme_extension_add()
1666 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1668 * Delete a theme overlay from the list of overlays
1670 * @param th The theme to delete from, or if NULL, the default theme
1671 * @param item The name of the theme overlay
1673 * @see elm_theme_overlay_add()
1675 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1677 * Appends a theme extension to the list of extensions.
1679 * @param th The theme to add to, or if NULL, the default theme
1680 * @param item The Edje file path to be used
1682 * This is intended when an application needs more styles of widgets or new
1683 * widget themes that the default does not provide (or may not provide). The
1684 * application has "extended" usage by coming up with new custom style names
1685 * for widgets for specific uses, but as these are not "standard", they are
1686 * not guaranteed to be provided by a default theme. This means the
1687 * application is required to provide these extra elements itself in specific
1688 * Edje files. This call adds one of those Edje files to the theme search
1689 * path to be search after the default theme. The use of this call is
1690 * encouraged when default styles do not meet the needs of the application.
1691 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1693 * @see elm_object_style_set()
1695 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1697 * Deletes a theme extension from the list of extensions.
1699 * @param th The theme to delete from, or if NULL, the default theme
1700 * @param item The name of the theme extension
1702 * @see elm_theme_extension_add()
1704 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1706 * Set the theme search order for the given theme
1708 * @param th The theme to set the search order, or if NULL, the default theme
1709 * @param theme Theme search string
1711 * This sets the search string for the theme in path-notation from first
1712 * theme to search, to last, delimited by the : character. Example:
1714 * "shiny:/path/to/file.edj:default"
1716 * See the ELM_THEME environment variable for more information.
1718 * @see elm_theme_get()
1719 * @see elm_theme_list_get()
1721 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1723 * Return the theme search order
1725 * @param th The theme to get the search order, or if NULL, the default theme
1726 * @return The internal search order path
1728 * This function returns a colon separated string of theme elements as
1729 * returned by elm_theme_list_get().
1731 * @see elm_theme_set()
1732 * @see elm_theme_list_get()
1734 EAPI const char *elm_theme_get(Elm_Theme *th);
1736 * Return a list of theme elements to be used in a theme.
1738 * @param th Theme to get the list of theme elements from.
1739 * @return The internal list of theme elements
1741 * This returns the internal list of theme elements (will only be valid as
1742 * long as the theme is not modified by elm_theme_set() or theme is not
1743 * freed by elm_theme_free(). This is a list of strings which must not be
1744 * altered as they are also internal. If @p th is NULL, then the default
1745 * theme element list is returned.
1747 * A theme element can consist of a full or relative path to a .edj file,
1748 * or a name, without extension, for a theme to be searched in the known
1749 * theme paths for Elemementary.
1751 * @see elm_theme_set()
1752 * @see elm_theme_get()
1754 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1756 * Return the full patrh for a theme element
1758 * @param f The theme element name
1759 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1760 * @return The full path to the file found.
1762 * This returns a string you should free with free() on success, NULL on
1763 * failure. This will search for the given theme element, and if it is a
1764 * full or relative path element or a simple searchable name. The returned
1765 * path is the full path to the file, if searched, and the file exists, or it
1766 * is simply the full path given in the element or a resolved path if
1767 * relative to home. The @p in_search_path boolean pointed to is set to
1768 * EINA_TRUE if the file was a searchable file andis in the search path,
1769 * and EINA_FALSE otherwise.
1771 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
1773 * Flush the current theme.
1775 * @param th Theme to flush
1777 * This flushes caches that let elementary know where to find theme elements
1778 * in the given theme. If @p th is NULL, then the default theme is flushed.
1779 * Call this function if source theme data has changed in such a way as to
1780 * make any caches Elementary kept invalid.
1782 EAPI void elm_theme_flush(Elm_Theme *th);
1784 * This flushes all themes (default and specific ones).
1786 * This will flush all themes in the current application context, by calling
1787 * elm_theme_flush() on each of them.
1789 EAPI void elm_theme_full_flush(void);
1791 * Set the theme for all elementary using applications on the current display
1793 * @param theme The name of the theme to use. Format same as the ELM_THEME
1794 * environment variable.
1796 EAPI void elm_theme_all_set(const char *theme);
1798 * Return a list of theme elements in the theme search path
1800 * @return A list of strings that are the theme element names.
1802 * This lists all available theme files in the standard Elementary search path
1803 * for theme elements, and returns them in alphabetical order as theme
1804 * element names in a list of strings. Free this with
1805 * elm_theme_name_available_list_free() when you are done with the list.
1807 EAPI Eina_List *elm_theme_name_available_list_new(void);
1809 * Free the list returned by elm_theme_name_available_list_new()
1811 * This frees the list of themes returned by
1812 * elm_theme_name_available_list_new(). Once freed the list should no longer
1813 * be used. a new list mys be created.
1815 EAPI void elm_theme_name_available_list_free(Eina_List *list);
1817 * Set a specific theme to be used for this object and its children
1819 * @param obj The object to set the theme on
1820 * @param th The theme to set
1822 * This sets a specific theme that will be used for the given object and any
1823 * child objects it has. If @p th is NULL then the theme to be used is
1824 * cleared and the object will inherit its theme from its parent (which
1825 * ultimately will use the default theme if no specific themes are set).
1827 * Use special themes with great care as this will annoy users and make
1828 * configuration difficult. Avoid any custom themes at all if it can be
1831 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
1833 * Get the specific theme to be used
1835 * @param obj The object to get the specific theme from
1836 * @return The specifc theme set.
1838 * This will return a specific theme set, or NULL if no specific theme is
1839 * set on that object. It will not return inherited themes from parents, only
1840 * the specific theme set for that specific object. See elm_object_theme_set()
1841 * for more information.
1843 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1849 /** @defgroup Win Win
1851 * @image html img/widget/win/preview-00.png
1852 * @image latex img/widget/win/preview-00.eps
1854 * The window class of Elementary. Contains functions to manipulate
1855 * windows. The Evas engine used to render the window contents is specified
1856 * in the system or user elementary config files (whichever is found last),
1857 * and can be overridden with the ELM_ENGINE environment variable for
1858 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
1859 * compilation setup and modules actually installed at runtime) are (listed
1860 * in order of best supported and most likely to be complete and work to
1863 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
1864 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
1866 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
1868 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
1870 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
1872 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
1873 * rendering using SDL as the buffer)
1874 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
1875 * GDI with software)
1876 * @li "dfb", "directfb" (Rendering to a DirectFB window)
1877 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
1878 * grayscale using dedicated 8bit software engine in X11)
1879 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
1880 * X11 using 16bit software engine)
1881 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
1882 * (Windows CE rendering via GDI with 16bit software renderer)
1883 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
1884 * buffer with 16bit software renderer)
1886 * All engines use a simple string to select the engine to render, EXCEPT
1887 * the "shot" engine. This actually encodes the output of the virtual
1888 * screenshot and how long to delay in the engine string. The engine string
1889 * is encoded in the following way:
1891 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
1893 * Where options are separated by a ":" char if more than one option is
1894 * given, with delay, if provided being the first option and file the last
1895 * (order is important). The delay specifies how long to wait after the
1896 * window is shown before doing the virtual "in memory" rendering and then
1897 * save the output to the file specified by the file option (and then exit).
1898 * If no delay is given, the default is 0.5 seconds. If no file is given the
1899 * default output file is "out.png". Repeat option is for continous
1900 * capturing screenshots. Repeat range is from 1 to 999 and filename is
1901 * fixed to "out001.png" Some examples of using the shot engine:
1903 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
1904 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
1905 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
1906 * ELM_ENGINE="shot:delay=2.0" elementary_test
1907 * ELM_ENGINE="shot:" elementary_test
1909 * Signals that you can add callbacks for are:
1911 * @li "delete,request": the user requested to close the window. See
1912 * elm_win_autodel_set().
1913 * @li "focus,in": window got focus
1914 * @li "focus,out": window lost focus
1915 * @li "moved": window that holds the canvas was moved
1918 * @li @ref win_example_01
1923 * Defines the types of window that can be created
1925 * These are hints set on the window so that a running Window Manager knows
1926 * how the window should be handled and/or what kind of decorations it
1929 * Currently, only the X11 backed engines use them.
1931 typedef enum _Elm_Win_Type
1933 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
1934 window. Almost every window will be created with this
1936 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
1937 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
1938 window holding desktop icons. */
1939 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
1940 be kept on top of any other window by the Window
1942 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
1944 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
1945 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
1947 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
1948 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
1949 entry in a menubar is clicked. Typically used
1950 with elm_win_override_set(). This hint exists
1951 for completion only, as the EFL way of
1952 implementing a menu would not normally use a
1953 separate window for its contents. */
1954 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
1955 triggered by right-clicking an object. */
1956 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
1957 explanatory text that typically appear after the
1958 mouse cursor hovers over an object for a while.
1959 Typically used with elm_win_override_set() and also
1960 not very commonly used in the EFL. */
1961 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
1962 battery life or a new E-Mail received. */
1963 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
1964 usually used in the EFL. */
1965 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
1966 object being dragged across different windows, or even
1967 applications. Typically used with
1968 elm_win_override_set(). */
1969 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
1970 buffer. No actual window is created for this
1971 type, instead the window and all of its
1972 contents will be rendered to an image buffer.
1973 This allows to have children window inside a
1974 parent one just like any other object would
1975 be, and do other things like applying @c
1976 Evas_Map effects to it. This is the only type
1977 of window that requires the @c parent
1978 parameter of elm_win_add() to be a valid @c
1983 * The differents layouts that can be requested for the virtual keyboard.
1985 * When the application window is being managed by Illume, it may request
1986 * any of the following layouts for the virtual keyboard.
1988 typedef enum _Elm_Win_Keyboard_Mode
1990 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
1991 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
1992 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
1993 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
1994 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
1995 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
1996 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
1997 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
1998 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
1999 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
2000 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
2001 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
2002 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
2003 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
2004 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
2005 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
2006 } Elm_Win_Keyboard_Mode;
2009 * Available commands that can be sent to the Illume manager.
2011 * When running under an Illume session, a window may send commands to the
2012 * Illume manager to perform different actions.
2014 typedef enum _Elm_Illume_Command
2016 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
2018 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
2020 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
2022 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
2023 } Elm_Illume_Command;
2026 * Adds a window object. If this is the first window created, pass NULL as
2029 * @param parent Parent object to add the window to, or NULL
2030 * @param name The name of the window
2031 * @param type The window type, one of #Elm_Win_Type.
2033 * The @p parent paramter can be @c NULL for every window @p type except
2034 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
2035 * which the image object will be created.
2037 * @return The created object, or NULL on failure
2039 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
2041 * Add @p subobj as a resize object of window @p obj.
2044 * Setting an object as a resize object of the window means that the
2045 * @p subobj child's size and position will be controlled by the window
2046 * directly. That is, the object will be resized to match the window size
2047 * and should never be moved or resized manually by the developer.
2049 * In addition, resize objects of the window control what the minimum size
2050 * of it will be, as well as whether it can or not be resized by the user.
2052 * For the end user to be able to resize a window by dragging the handles
2053 * or borders provided by the Window Manager, or using any other similar
2054 * mechanism, all of the resize objects in the window should have their
2055 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
2057 * @param obj The window object
2058 * @param subobj The resize object to add
2060 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2062 * Delete @p subobj as a resize object of window @p obj.
2064 * This function removes the object @p subobj from the resize objects of
2065 * the window @p obj. It will not delete the object itself, which will be
2066 * left unmanaged and should be deleted by the developer, manually handled
2067 * or set as child of some other container.
2069 * @param obj The window object
2070 * @param subobj The resize object to add
2072 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2074 * Set the title of the window
2076 * @param obj The window object
2077 * @param title The title to set
2079 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2081 * Get the title of the window
2083 * The returned string is an internal one and should not be freed or
2084 * modified. It will also be rendered invalid if a new title is set or if
2085 * the window is destroyed.
2087 * @param obj The window object
2090 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2092 * Set the window's autodel state.
2094 * When closing the window in any way outside of the program control, like
2095 * pressing the X button in the titlebar or using a command from the
2096 * Window Manager, a "delete,request" signal is emitted to indicate that
2097 * this event occurred and the developer can take any action, which may
2098 * include, or not, destroying the window object.
2100 * When the @p autodel parameter is set, the window will be automatically
2101 * destroyed when this event occurs, after the signal is emitted.
2102 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
2103 * and is up to the program to do so when it's required.
2105 * @param obj The window object
2106 * @param autodel If true, the window will automatically delete itself when
2109 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
2111 * Get the window's autodel state.
2113 * @param obj The window object
2114 * @return If the window will automatically delete itself when closed
2116 * @see elm_win_autodel_set()
2118 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2120 * Activate a window object.
2122 * This function sends a request to the Window Manager to activate the
2123 * window pointed by @p obj. If honored by the WM, the window will receive
2124 * the keyboard focus.
2126 * @note This is just a request that a Window Manager may ignore, so calling
2127 * this function does not ensure in any way that the window will be the
2128 * active one after it.
2130 * @param obj The window object
2132 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2134 * Lower a window object.
2136 * Places the window pointed by @p obj at the bottom of the stack, so that
2137 * no other window is covered by it.
2139 * If elm_win_override_set() is not set, the Window Manager may ignore this
2142 * @param obj The window object
2144 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2146 * Raise a window object.
2148 * Places the window pointed by @p obj at the top of the stack, so that it's
2149 * not covered by any other window.
2151 * If elm_win_override_set() is not set, the Window Manager may ignore this
2154 * @param obj The window object
2156 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2158 * Set the borderless state of a window.
2160 * This function requests the Window Manager to not draw any decoration
2161 * around the window.
2163 * @param obj The window object
2164 * @param borderless If true, the window is borderless
2166 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2168 * Get the borderless state of a window.
2170 * @param obj The window object
2171 * @return If true, the window is borderless
2173 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2175 * Set the shaped state of a window.
2177 * Shaped windows, when supported, will render the parts of the window that
2178 * has no content, transparent.
2180 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
2181 * background object or cover the entire window in any other way, or the
2182 * parts of the canvas that have no data will show framebuffer artifacts.
2184 * @param obj The window object
2185 * @param shaped If true, the window is shaped
2187 * @see elm_win_alpha_set()
2189 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2191 * Get the shaped state of a window.
2193 * @param obj The window object
2194 * @return If true, the window is shaped
2196 * @see elm_win_shaped_set()
2198 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2200 * Set the alpha channel state of a window.
2202 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
2203 * possibly making parts of the window completely or partially transparent.
2204 * This is also subject to the underlying system supporting it, like for
2205 * example, running under a compositing manager. If no compositing is
2206 * available, enabling this option will instead fallback to using shaped
2207 * windows, with elm_win_shaped_set().
2209 * @param obj The window object
2210 * @param alpha If true, the window has an alpha channel
2212 * @see elm_win_alpha_set()
2214 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2216 * Get the transparency state of a window.
2218 * @param obj The window object
2219 * @return If true, the window is transparent
2221 * @see elm_win_transparent_set()
2223 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2225 * Set the transparency state of a window.
2227 * Use elm_win_alpha_set() instead.
2229 * @param obj The window object
2230 * @param transparent If true, the window is transparent
2232 * @see elm_win_alpha_set()
2234 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2236 * Get the alpha channel state of a window.
2238 * @param obj The window object
2239 * @return If true, the window has an alpha channel
2241 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2243 * Set the override state of a window.
2245 * A window with @p override set to EINA_TRUE will not be managed by the
2246 * Window Manager. This means that no decorations of any kind will be shown
2247 * for it, moving and resizing must be handled by the application, as well
2248 * as the window visibility.
2250 * This should not be used for normal windows, and even for not so normal
2251 * ones, it should only be used when there's a good reason and with a lot
2252 * of care. Mishandling override windows may result situations that
2253 * disrupt the normal workflow of the end user.
2255 * @param obj The window object
2256 * @param override If true, the window is overridden
2258 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2260 * Get the override state of a window.
2262 * @param obj The window object
2263 * @return If true, the window is overridden
2265 * @see elm_win_override_set()
2267 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2269 * Set the fullscreen state of a window.
2271 * @param obj The window object
2272 * @param fullscreen If true, the window is fullscreen
2274 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2276 * Get the fullscreen state of a window.
2278 * @param obj The window object
2279 * @return If true, the window is fullscreen
2281 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2283 * Set the maximized state of a window.
2285 * @param obj The window object
2286 * @param maximized If true, the window is maximized
2288 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2290 * Get the maximized state of a window.
2292 * @param obj The window object
2293 * @return If true, the window is maximized
2295 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2297 * Set the iconified state of a window.
2299 * @param obj The window object
2300 * @param iconified If true, the window is iconified
2302 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2304 * Get the iconified state of a window.
2306 * @param obj The window object
2307 * @return If true, the window is iconified
2309 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2311 * Set the layer of the window.
2313 * What this means exactly will depend on the underlying engine used.
2315 * In the case of X11 backed engines, the value in @p layer has the
2316 * following meanings:
2317 * @li < 3: The window will be placed below all others.
2318 * @li > 5: The window will be placed above all others.
2319 * @li other: The window will be placed in the default layer.
2321 * @param obj The window object
2322 * @param layer The layer of the window
2324 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2326 * Get the layer of the window.
2328 * @param obj The window object
2329 * @return The layer of the window
2331 * @see elm_win_layer_set()
2333 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2335 * Set the rotation of the window.
2337 * Most engines only work with multiples of 90.
2339 * This function is used to set the orientation of the window @p obj to
2340 * match that of the screen. The window itself will be resized to adjust
2341 * to the new geometry of its contents. If you want to keep the window size,
2342 * see elm_win_rotation_with_resize_set().
2344 * @param obj The window object
2345 * @param rotation The rotation of the window, in degrees (0-360),
2346 * counter-clockwise.
2348 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2350 * Rotates the window and resizes it.
2352 * Like elm_win_rotation_set(), but it also resizes the window's contents so
2353 * that they fit inside the current window geometry.
2355 * @param obj The window object
2356 * @param layer The rotation of the window in degrees (0-360),
2357 * counter-clockwise.
2359 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2361 * Get the rotation of the window.
2363 * @param obj The window object
2364 * @return The rotation of the window in degrees (0-360)
2366 * @see elm_win_rotation_set()
2367 * @see elm_win_rotation_with_resize_set()
2369 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2371 * Set the sticky state of the window.
2373 * Hints the Window Manager that the window in @p obj should be left fixed
2374 * at its position even when the virtual desktop it's on moves or changes.
2376 * @param obj The window object
2377 * @param sticky If true, the window's sticky state is enabled
2379 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2381 * Get the sticky state of the window.
2383 * @param obj The window object
2384 * @return If true, the window's sticky state is enabled
2386 * @see elm_win_sticky_set()
2388 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2390 * Set if this window is an illume conformant window
2392 * @param obj The window object
2393 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
2395 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2397 * Get if this window is an illume conformant window
2399 * @param obj The window object
2400 * @return A boolean if this window is illume conformant or not
2402 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2404 * Set a window to be an illume quickpanel window
2406 * By default window objects are not quickpanel windows.
2408 * @param obj The window object
2409 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
2411 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2413 * Get if this window is a quickpanel or not
2415 * @param obj The window object
2416 * @return A boolean if this window is a quickpanel or not
2418 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2420 * Set the major priority of a quickpanel window
2422 * @param obj The window object
2423 * @param priority The major priority for this quickpanel
2425 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2427 * Get the major priority of a quickpanel window
2429 * @param obj The window object
2430 * @return The major priority of this quickpanel
2432 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2434 * Set the minor priority of a quickpanel window
2436 * @param obj The window object
2437 * @param priority The minor priority for this quickpanel
2439 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2441 * Get the minor priority of a quickpanel window
2443 * @param obj The window object
2444 * @return The minor priority of this quickpanel
2446 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2448 * Set which zone this quickpanel should appear in
2450 * @param obj The window object
2451 * @param zone The requested zone for this quickpanel
2453 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2455 * Get which zone this quickpanel should appear in
2457 * @param obj The window object
2458 * @return The requested zone for this quickpanel
2460 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2462 * Set the window to be skipped by keyboard focus
2464 * This sets the window to be skipped by normal keyboard input. This means
2465 * a window manager will be asked to not focus this window as well as omit
2466 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
2468 * Call this and enable it on a window BEFORE you show it for the first time,
2469 * otherwise it may have no effect.
2471 * Use this for windows that have only output information or might only be
2472 * interacted with by the mouse or fingers, and never for typing input.
2473 * Be careful that this may have side-effects like making the window
2474 * non-accessible in some cases unless the window is specially handled. Use
2477 * @param obj The window object
2478 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
2480 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2482 * Send a command to the windowing environment
2484 * This is intended to work in touchscreen or small screen device
2485 * environments where there is a more simplistic window management policy in
2486 * place. This uses the window object indicated to select which part of the
2487 * environment to control (the part that this window lives in), and provides
2488 * a command and an optional parameter structure (use NULL for this if not
2491 * @param obj The window object that lives in the environment to control
2492 * @param command The command to send
2493 * @param params Optional parameters for the command
2495 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2497 * Get the inlined image object handle
2499 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
2500 * then the window is in fact an evas image object inlined in the parent
2501 * canvas. You can get this object (be careful to not manipulate it as it
2502 * is under control of elementary), and use it to do things like get pixel
2503 * data, save the image to a file, etc.
2505 * @param obj The window object to get the inlined image from
2506 * @return The inlined image object, or NULL if none exists
2508 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2510 * Set the enabled status for the focus highlight in a window
2512 * This function will enable or disable the focus highlight only for the
2513 * given window, regardless of the global setting for it
2515 * @param obj The window where to enable the highlight
2516 * @param enabled The enabled value for the highlight
2518 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2520 * Get the enabled value of the focus highlight for this window
2522 * @param obj The window in which to check if the focus highlight is enabled
2524 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
2526 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2528 * Set the style for the focus highlight on this window
2530 * Sets the style to use for theming the highlight of focused objects on
2531 * the given window. If @p style is NULL, the default will be used.
2533 * @param obj The window where to set the style
2534 * @param style The style to set
2536 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2538 * Get the style set for the focus highlight object
2540 * Gets the style set for this windows highilght object, or NULL if none
2543 * @param obj The window to retrieve the highlights style from
2545 * @return The style set or NULL if none was. Default is used in that case.
2547 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2549 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2550 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2551 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2552 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2553 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2554 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2555 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2557 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2558 * (blank mouse, private mouse obj, defaultmouse)
2562 * Sets the keyboard mode of the window.
2564 * @param obj The window object
2565 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
2567 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2569 * Gets the keyboard mode of the window.
2571 * @param obj The window object
2572 * @return The mode, one of #Elm_Win_Keyboard_Mode
2574 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2576 * Sets whether the window is a keyboard.
2578 * @param obj The window object
2579 * @param is_keyboard If true, the window is a virtual keyboard
2581 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2583 * Gets whether the window is a keyboard.
2585 * @param obj The window object
2586 * @return If the window is a virtual keyboard
2588 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2591 * Get the screen position of a window.
2593 * @param obj The window object
2594 * @param x The int to store the x coordinate to
2595 * @param y The int to store the y coordinate to
2597 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2603 * @defgroup Inwin Inwin
2605 * @image html img/widget/inwin/preview-00.png
2606 * @image latex img/widget/inwin/preview-00.eps
2607 * @image html img/widget/inwin/preview-01.png
2608 * @image latex img/widget/inwin/preview-01.eps
2609 * @image html img/widget/inwin/preview-02.png
2610 * @image latex img/widget/inwin/preview-02.eps
2612 * An inwin is a window inside a window that is useful for a quick popup.
2613 * It does not hover.
2615 * It works by creating an object that will occupy the entire window, so it
2616 * must be created using an @ref Win "elm_win" as parent only. The inwin
2617 * object can be hidden or restacked below every other object if it's
2618 * needed to show what's behind it without destroying it. If this is done,
2619 * the elm_win_inwin_activate() function can be used to bring it back to
2620 * full visibility again.
2622 * There are three styles available in the default theme. These are:
2623 * @li default: The inwin is sized to take over most of the window it's
2625 * @li minimal: The size of the inwin will be the minimum necessary to show
2627 * @li minimal_vertical: Horizontally, the inwin takes as much space as
2628 * possible, but it's sized vertically the most it needs to fit its\
2631 * Some examples of Inwin can be found in the following:
2632 * @li @ref inwin_example_01
2637 * Adds an inwin to the current window
2639 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
2640 * Never call this function with anything other than the top-most window
2641 * as its parameter, unless you are fond of undefined behavior.
2643 * After creating the object, the widget will set itself as resize object
2644 * for the window with elm_win_resize_object_add(), so when shown it will
2645 * appear to cover almost the entire window (how much of it depends on its
2646 * content and the style used). It must not be added into other container
2647 * objects and it needs not be moved or resized manually.
2649 * @param parent The parent object
2650 * @return The new object or NULL if it cannot be created
2652 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2654 * Activates an inwin object, ensuring its visibility
2656 * This function will make sure that the inwin @p obj is completely visible
2657 * by calling evas_object_show() and evas_object_raise() on it, to bring it
2658 * to the front. It also sets the keyboard focus to it, which will be passed
2661 * The object's theme will also receive the signal "elm,action,show" with
2664 * @param obj The inwin to activate
2666 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2668 * Set the content of an inwin object.
2670 * Once the content object is set, a previously set one will be deleted.
2671 * If you want to keep that old content object, use the
2672 * elm_win_inwin_content_unset() function.
2674 * @param obj The inwin object
2675 * @param content The object to set as content
2677 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2679 * Get the content of an inwin object.
2681 * Return the content object which is set for this widget.
2683 * The returned object is valid as long as the inwin is still alive and no
2684 * other content is set on it. Deleting the object will notify the inwin
2685 * about it and this one will be left empty.
2687 * If you need to remove an inwin's content to be reused somewhere else,
2688 * see elm_win_inwin_content_unset().
2690 * @param obj The inwin object
2691 * @return The content that is being used
2693 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2695 * Unset the content of an inwin object.
2697 * Unparent and return the content object which was set for this widget.
2699 * @param obj The inwin object
2700 * @return The content that was being used
2702 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2706 /* X specific calls - won't work on non-x engines (return 0) */
2707 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2708 /* smart callbacks called:
2709 * "delete,request" - the user requested to delete the window
2710 * "focus,in" - window got focus
2711 * "focus,out" - window lost focus
2712 * "moved" - window that holds the canvas was moved
2718 * @image html img/widget/bg/preview-00.png
2719 * @image latex img/widget/bg/preview-00.eps
2721 * @brief Background object, used for setting a solid color, image or Edje
2722 * group as background to a window or any container object.
2724 * The bg object is used for setting a solid background to a window or
2725 * packing into any container object. It works just like an image, but has
2726 * some properties useful to a background, like setting it to tiled,
2727 * centered, scaled or stretched.
2729 * Here is some sample code using it:
2730 * @li @ref bg_01_example_page
2731 * @li @ref bg_02_example_page
2732 * @li @ref bg_03_example_page
2736 typedef enum _Elm_Bg_Option
2738 ELM_BG_OPTION_CENTER, /**< center the background */
2739 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2740 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2741 ELM_BG_OPTION_TILE /**< tile background at its original size */
2745 * Add a new background to the parent
2747 * @param parent The parent object
2748 * @return The new object or NULL if it cannot be created
2752 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2755 * Set the file (image or edje) used for the background
2757 * @param obj The bg object
2758 * @param file The file path
2759 * @param group Optional key (group in Edje) within the file
2761 * This sets the image file used in the background object. The image (or edje)
2762 * will be stretched (retaining aspect if its an image file) to completely fill
2763 * the bg object. This may mean some parts are not visible.
2765 * @note Once the image of @p obj is set, a previously set one will be deleted,
2766 * even if @p file is NULL.
2770 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2773 * Get the file (image or edje) used for the background
2775 * @param obj The bg object
2776 * @param file The file path
2777 * @param group Optional key (group in Edje) within the file
2781 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2784 * Set the option used for the background image
2786 * @param obj The bg object
2787 * @param option The desired background option (TILE, SCALE)
2789 * This sets the option used for manipulating the display of the background
2790 * image. The image can be tiled or scaled.
2794 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2797 * Get the option used for the background image
2799 * @param obj The bg object
2800 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2804 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2806 * Set the option used for the background color
2808 * @param obj The bg object
2813 * This sets the color used for the background rectangle. Its range goes
2818 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2820 * Get the option used for the background color
2822 * @param obj The bg object
2829 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2832 * Set the overlay object used for the background object.
2834 * @param obj The bg object
2835 * @param overlay The overlay object
2837 * This provides a way for elm_bg to have an 'overlay' that will be on top
2838 * of the bg. Once the over object is set, a previously set one will be
2839 * deleted, even if you set the new one to NULL. If you want to keep that
2840 * old content object, use the elm_bg_overlay_unset() function.
2845 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2848 * Get the overlay object used for the background object.
2850 * @param obj The bg object
2851 * @return The content that is being used
2853 * Return the content object which is set for this widget
2857 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2860 * Get the overlay object used for the background object.
2862 * @param obj The bg object
2863 * @return The content that was being used
2865 * Unparent and return the overlay object which was set for this widget
2869 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2872 * Set the size of the pixmap representation of the image.
2874 * This option just makes sense if an image is going to be set in the bg.
2876 * @param obj The bg object
2877 * @param w The new width of the image pixmap representation.
2878 * @param h The new height of the image pixmap representation.
2880 * This function sets a new size for pixmap representation of the given bg
2881 * image. It allows the image to be loaded already in the specified size,
2882 * reducing the memory usage and load time when loading a big image with load
2883 * size set to a smaller size.
2885 * NOTE: this is just a hint, the real size of the pixmap may differ
2886 * depending on the type of image being loaded, being bigger than requested.
2890 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2891 /* smart callbacks called:
2895 * @defgroup Icon Icon
2897 * @image html img/widget/icon/preview-00.png
2898 * @image latex img/widget/icon/preview-00.eps
2900 * An object that provides standard icon images (delete, edit, arrows, etc.)
2901 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
2903 * The icon image requested can be in the elementary theme, or in the
2904 * freedesktop.org paths. It's possible to set the order of preference from
2905 * where the image will be used.
2907 * This API is very similar to @ref Image, but with ready to use images.
2909 * Default images provided by the theme are described below.
2911 * The first list contains icons that were first intended to be used in
2912 * toolbars, but can be used in many other places too:
2928 * Now some icons that were designed to be used in menus (but again, you can
2929 * use them anywhere else):
2934 * @li menu/arrow_down
2935 * @li menu/arrow_left
2936 * @li menu/arrow_right
2945 * And here we have some media player specific icons:
2946 * @li media_player/forward
2947 * @li media_player/info
2948 * @li media_player/next
2949 * @li media_player/pause
2950 * @li media_player/play
2951 * @li media_player/prev
2952 * @li media_player/rewind
2953 * @li media_player/stop
2955 * Signals that you can add callbacks for are:
2957 * "clicked" - This is called when a user has clicked the icon
2959 * An example of usage for this API follows:
2960 * @li @ref tutorial_icon
2968 typedef enum _Elm_Icon_Type
2975 * @enum _Elm_Icon_Lookup_Order
2976 * @typedef Elm_Icon_Lookup_Order
2978 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
2979 * theme, FDO paths, or both?
2983 typedef enum _Elm_Icon_Lookup_Order
2985 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2986 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2987 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2988 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2989 } Elm_Icon_Lookup_Order;
2992 * Add a new icon object to the parent.
2994 * @param parent The parent object
2995 * @return The new object or NULL if it cannot be created
2997 * @see elm_icon_file_set()
3001 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3003 * Set the file that will be used as icon.
3005 * @param obj The icon object
3006 * @param file The path to file that will be used as icon image
3007 * @param group The group that the icon belongs to in edje file
3009 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3011 * @note The icon image set by this function can be changed by
3012 * elm_icon_standard_set().
3014 * @see elm_icon_file_get()
3018 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3020 * Set a location in memory to be used as an icon
3022 * @param obj The icon object
3023 * @param img The binary data that will be used as an image
3024 * @param size The size of binary data @p img
3025 * @param format Optional format of @p img to pass to the image loader
3026 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
3028 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3030 * @note The icon image set by this function can be changed by
3031 * elm_icon_standard_set().
3035 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);
3037 * Get the file that will be used as icon.
3039 * @param obj The icon object
3040 * @param file The path to file that will be used as icon icon image
3041 * @param group The group that the icon belongs to in edje file
3043 * @see elm_icon_file_set()
3047 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3048 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3050 * Set the icon by icon standards names.
3052 * @param obj The icon object
3053 * @param name The icon name
3055 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3057 * For example, freedesktop.org defines standard icon names such as "home",
3058 * "network", etc. There can be different icon sets to match those icon
3059 * keys. The @p name given as parameter is one of these "keys", and will be
3060 * used to look in the freedesktop.org paths and elementary theme. One can
3061 * change the lookup order with elm_icon_order_lookup_set().
3063 * If name is not found in any of the expected locations and it is the
3064 * absolute path of an image file, this image will be used.
3066 * @note The icon image set by this function can be changed by
3067 * elm_icon_file_set().
3069 * @see elm_icon_standard_get()
3070 * @see elm_icon_file_set()
3074 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
3076 * Get the icon name set by icon standard names.
3078 * @param obj The icon object
3079 * @return The icon name
3081 * If the icon image was set using elm_icon_file_set() instead of
3082 * elm_icon_standard_set(), then this function will return @c NULL.
3084 * @see elm_icon_standard_set()
3088 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3090 * Set the smooth effect for an icon object.
3092 * @param obj The icon object
3093 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3094 * otherwise. Default is @c EINA_TRUE.
3096 * Set the scaling algorithm to be used when scaling the icon image. Smooth
3097 * scaling provides a better resulting image, but is slower.
3099 * The smooth scaling should be disabled when making animations that change
3100 * the icon size, since they will be faster. Animations that don't require
3101 * resizing of the icon can keep the smooth scaling enabled (even if the icon
3102 * is already scaled, since the scaled icon image will be cached).
3104 * @see elm_icon_smooth_get()
3108 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3110 * Get the smooth effect for an icon object.
3112 * @param obj The icon object
3113 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3115 * @see elm_icon_smooth_set()
3119 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3121 * Disable scaling of this object.
3123 * @param obj The icon object.
3124 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3125 * otherwise. Default is @c EINA_FALSE.
3127 * This function disables scaling of the icon object through the function
3128 * elm_object_scale_set(). However, this does not affect the object
3129 * size/resize in any way. For that effect, take a look at
3130 * elm_icon_scale_set().
3132 * @see elm_icon_no_scale_get()
3133 * @see elm_icon_scale_set()
3134 * @see elm_object_scale_set()
3138 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3140 * Get whether scaling is disabled on the object.
3142 * @param obj The icon object
3143 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3145 * @see elm_icon_no_scale_set()
3149 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3151 * Set if the object is (up/down) resizeable.
3153 * @param obj The icon object
3154 * @param scale_up A bool to set if the object is resizeable up. Default is
3156 * @param scale_down A bool to set if the object is resizeable down. Default
3159 * This function limits the icon object resize ability. If @p scale_up is set to
3160 * @c EINA_FALSE, the object can't have its height or width resized to a value
3161 * higher than the original icon size. Same is valid for @p scale_down.
3163 * @see elm_icon_scale_get()
3167 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3169 * Get if the object is (up/down) resizeable.
3171 * @param obj The icon object
3172 * @param scale_up A bool to set if the object is resizeable up
3173 * @param scale_down A bool to set if the object is resizeable down
3175 * @see elm_icon_scale_set()
3179 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3181 * Get the object's image size
3183 * @param obj The icon object
3184 * @param w A pointer to store the width in
3185 * @param h A pointer to store the height in
3189 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3191 * Set if the icon fill the entire object area.
3193 * @param obj The icon object
3194 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3195 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3197 * When the icon object is resized to a different aspect ratio from the
3198 * original icon image, the icon image will still keep its aspect. This flag
3199 * tells how the image should fill the object's area. They are: keep the
3200 * entire icon inside the limits of height and width of the object (@p
3201 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
3202 * of the object, and the icon will fill the entire object (@p fill_outside
3205 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
3206 * retain property to false. Thus, the icon image will always keep its
3207 * original aspect ratio.
3209 * @see elm_icon_fill_outside_get()
3210 * @see elm_image_fill_outside_set()
3214 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3216 * Get if the object is filled outside.
3218 * @param obj The icon object
3219 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3221 * @see elm_icon_fill_outside_set()
3225 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3227 * Set the prescale size for the icon.
3229 * @param obj The icon object
3230 * @param size The prescale size. This value is used for both width and
3233 * This function sets a new size for pixmap representation of the given
3234 * icon. It allows the icon to be loaded already in the specified size,
3235 * reducing the memory usage and load time when loading a big icon with load
3236 * size set to a smaller size.
3238 * It's equivalent to the elm_bg_load_size_set() function for bg.
3240 * @note this is just a hint, the real size of the pixmap may differ
3241 * depending on the type of icon being loaded, being bigger than requested.
3243 * @see elm_icon_prescale_get()
3244 * @see elm_bg_load_size_set()
3248 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3250 * Get the prescale size for the icon.
3252 * @param obj The icon object
3253 * @return The prescale size
3255 * @see elm_icon_prescale_set()
3259 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3261 * Sets the icon lookup order used by elm_icon_standard_set().
3263 * @param obj The icon object
3264 * @param order The icon lookup order (can be one of
3265 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
3266 * or ELM_ICON_LOOKUP_THEME)
3268 * @see elm_icon_order_lookup_get()
3269 * @see Elm_Icon_Lookup_Order
3273 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
3275 * Gets the icon lookup order.
3277 * @param obj The icon object
3278 * @return The icon lookup order
3280 * @see elm_icon_order_lookup_set()
3281 * @see Elm_Icon_Lookup_Order
3285 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3292 * @defgroup Image Image
3294 * @image html img/widget/image/preview-00.png
3295 * @image latex img/widget/image/preview-00.eps
3297 * An object that allows one to load an image file to it. It can be used
3298 * anywhere like any other elementary widget.
3300 * This widget provides most of the functionality provided from @ref Bg or @ref
3301 * Icon, but with a slightly different API (use the one that fits better your
3304 * The features not provided by those two other image widgets are:
3305 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
3306 * @li change the object orientation with elm_image_orient_set();
3307 * @li and turning the image editable with elm_image_editable_set().
3309 * Signals that you can add callbacks for are:
3311 * @li @c "clicked" - This is called when a user has clicked the image
3313 * An example of usage for this API follows:
3314 * @li @ref tutorial_image
3323 * @enum _Elm_Image_Orient
3324 * @typedef Elm_Image_Orient
3326 * Possible orientation options for elm_image_orient_set().
3328 * @image html elm_image_orient_set.png
3329 * @image latex elm_image_orient_set.eps width=\textwidth
3333 typedef enum _Elm_Image_Orient
3335 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
3336 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
3337 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
3338 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
3339 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
3340 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
3341 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
3342 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
3346 * Add a new image to the parent.
3348 * @param parent The parent object
3349 * @return The new object or NULL if it cannot be created
3351 * @see elm_image_file_set()
3355 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3357 * Set the file that will be used as image.
3359 * @param obj The image object
3360 * @param file The path to file that will be used as image
3361 * @param group The group that the image belongs in edje file (if it's an
3364 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
3366 * @see elm_image_file_get()
3370 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
3372 * Get the file that will be used as image.
3374 * @param obj The image object
3375 * @param file The path to file
3376 * @param group The group that the image belongs in edje file
3378 * @see elm_image_file_set()
3382 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
3384 * Set the smooth effect for an image.
3386 * @param obj The image object
3387 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
3388 * otherwise. Default is @c EINA_TRUE.
3390 * Set the scaling algorithm to be used when scaling the image. Smooth
3391 * scaling provides a better resulting image, but is slower.
3393 * The smooth scaling should be disabled when making animations that change
3394 * the image size, since it will be faster. Animations that don't require
3395 * resizing of the image can keep the smooth scaling enabled (even if the
3396 * image is already scaled, since the scaled image will be cached).
3398 * @see elm_image_smooth_get()
3402 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
3404 * Get the smooth effect for an image.
3406 * @param obj The image object
3407 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
3409 * @see elm_image_smooth_get()
3413 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3415 * Gets the current size of the image.
3417 * @param obj The image object.
3418 * @param w Pointer to store width, or NULL.
3419 * @param h Pointer to store height, or NULL.
3421 * This is the real size of the image, not the size of the object.
3423 * On error, neither w or h will be written.
3427 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
3429 * Disable scaling of this object.
3431 * @param obj The image object.
3432 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
3433 * otherwise. Default is @c EINA_FALSE.
3435 * This function disables scaling of the elm_image widget through the
3436 * function elm_object_scale_set(). However, this does not affect the widget
3437 * size/resize in any way. For that effect, take a look at
3438 * elm_image_scale_set().
3440 * @see elm_image_no_scale_get()
3441 * @see elm_image_scale_set()
3442 * @see elm_object_scale_set()
3446 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
3448 * Get whether scaling is disabled on the object.
3450 * @param obj The image object
3451 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
3453 * @see elm_image_no_scale_set()
3457 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3459 * Set if the object is (up/down) resizeable.
3461 * @param obj The image object
3462 * @param scale_up A bool to set if the object is resizeable up. Default is
3464 * @param scale_down A bool to set if the object is resizeable down. Default
3467 * This function limits the image resize ability. If @p scale_up is set to
3468 * @c EINA_FALSE, the object can't have its height or width resized to a value
3469 * higher than the original image size. Same is valid for @p scale_down.
3471 * @see elm_image_scale_get()
3475 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
3477 * Get if the object is (up/down) resizeable.
3479 * @param obj The image object
3480 * @param scale_up A bool to set if the object is resizeable up
3481 * @param scale_down A bool to set if the object is resizeable down
3483 * @see elm_image_scale_set()
3487 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
3489 * Set if the image fill the entire object area when keeping the aspect ratio.
3491 * @param obj The image object
3492 * @param fill_outside @c EINA_TRUE if the object is filled outside,
3493 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
3495 * When the image should keep its aspect ratio even if resized to another
3496 * aspect ratio, there are two possibilities to resize it: keep the entire
3497 * image inside the limits of height and width of the object (@p fill_outside
3498 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
3499 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
3501 * @note This option will have no effect if
3502 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
3504 * @see elm_image_fill_outside_get()
3505 * @see elm_image_aspect_ratio_retained_set()
3509 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
3511 * Get if the object is filled outside
3513 * @param obj The image object
3514 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
3516 * @see elm_image_fill_outside_set()
3520 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3522 * Set the prescale size for the image
3524 * @param obj The image object
3525 * @param size The prescale size. This value is used for both width and
3528 * This function sets a new size for pixmap representation of the given
3529 * image. It allows the image to be loaded already in the specified size,
3530 * reducing the memory usage and load time when loading a big image with load
3531 * size set to a smaller size.
3533 * It's equivalent to the elm_bg_load_size_set() function for bg.
3535 * @note this is just a hint, the real size of the pixmap may differ
3536 * depending on the type of image being loaded, being bigger than requested.
3538 * @see elm_image_prescale_get()
3539 * @see elm_bg_load_size_set()
3543 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
3545 * Get the prescale size for the image
3547 * @param obj The image object
3548 * @return The prescale size
3550 * @see elm_image_prescale_set()
3554 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3556 * Set the image orientation.
3558 * @param obj The image object
3559 * @param orient The image orientation
3560 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3561 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3562 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3563 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
3564 * Default is #ELM_IMAGE_ORIENT_NONE.
3566 * This function allows to rotate or flip the given image.
3568 * @see elm_image_orient_get()
3569 * @see @ref Elm_Image_Orient
3573 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
3575 * Get the image orientation.
3577 * @param obj The image object
3578 * @return The image orientation
3579 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
3580 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
3581 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
3582 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
3584 * @see elm_image_orient_set()
3585 * @see @ref Elm_Image_Orient
3589 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3591 * Make the image 'editable'.
3593 * @param obj Image object.
3594 * @param set Turn on or off editability. Default is @c EINA_FALSE.
3596 * This means the image is a valid drag target for drag and drop, and can be
3597 * cut or pasted too.
3601 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
3603 * Make the image 'editable'.
3605 * @param obj Image object.
3606 * @return Editability.
3608 * This means the image is a valid drag target for drag and drop, and can be
3609 * cut or pasted too.
3613 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3615 * Get the basic Evas_Image object from this object (widget).
3617 * @param obj The image object to get the inlined image from
3618 * @return The inlined image object, or NULL if none exists
3620 * This function allows one to get the underlying @c Evas_Object of type
3621 * Image from this elementary widget. It can be useful to do things like get
3622 * the pixel data, save the image to a file, etc.
3624 * @note Be careful to not manipulate it, as it is under control of
3629 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3631 * Set whether the original aspect ratio of the image should be kept on resize.
3633 * @param obj The image object.
3634 * @param retained @c EINA_TRUE if the image should retain the aspect,
3635 * @c EINA_FALSE otherwise.
3637 * The original aspect ratio (width / height) of the image is usually
3638 * distorted to match the object's size. Enabling this option will retain
3639 * this original aspect, and the way that the image is fit into the object's
3640 * area depends on the option set by elm_image_fill_outside_set().
3642 * @see elm_image_aspect_ratio_retained_get()
3643 * @see elm_image_fill_outside_set()
3647 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
3649 * Get if the object retains the original aspect ratio.
3651 * @param obj The image object.
3652 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
3657 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3659 /* smart callbacks called:
3660 * "clicked" - the user clicked the image
3668 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
3670 typedef enum _Elm_GLView_Mode
3672 ELM_GLVIEW_ALPHA = 1,
3673 ELM_GLVIEW_DEPTH = 2,
3674 ELM_GLVIEW_STENCIL = 4
3678 * Defines a policy for the glview resizing.
3680 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
3682 typedef enum _Elm_GLView_Resize_Policy
3684 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
3685 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
3686 } Elm_GLView_Resize_Policy;
3688 typedef enum _Elm_GLView_Render_Policy
3690 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
3691 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
3692 } Elm_GLView_Render_Policy;
3695 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3696 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3697 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3698 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3699 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
3700 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
3701 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
3702 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3703 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3704 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3705 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
3706 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
3712 * @image html img/widget/box/preview-00.png
3713 * @image latex img/widget/box/preview-00.eps width=\textwidth
3715 * @image html img/box.png
3716 * @image latex img/box.eps width=\textwidth
3718 * A box arranges objects in a linear fashion, governed by a layout function
3719 * that defines the details of this arrangement.
3721 * By default, the box will use an internal function to set the layout to
3722 * a single row, either vertical or horizontal. This layout is affected
3723 * by a number of parameters, such as the homogeneous flag set by
3724 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
3725 * elm_box_align_set() and the hints set to each object in the box.
3727 * For this default layout, it's possible to change the orientation with
3728 * elm_box_horizontal_set(). The box will start in the vertical orientation,
3729 * placing its elements ordered from top to bottom. When horizontal is set,
3730 * the order will go from left to right. If the box is set to be
3731 * homogeneous, every object in it will be assigned the same space, that
3732 * of the largest object. Padding can be used to set some spacing between
3733 * the cell given to each object. The alignment of the box, set with
3734 * elm_box_align_set(), determines how the bounding box of all the elements
3735 * will be placed within the space given to the box widget itself.
3737 * The size hints of each object also affect how they are placed and sized
3738 * within the box. evas_object_size_hint_min_set() will give the minimum
3739 * size the object can have, and the box will use it as the basis for all
3740 * latter calculations. Elementary widgets set their own minimum size as
3741 * needed, so there's rarely any need to use it manually.
3743 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
3744 * used to tell whether the object will be allocated the minimum size it
3745 * needs or if the space given to it should be expanded. It's important
3746 * to realize that expanding the size given to the object is not the same
3747 * thing as resizing the object. It could very well end being a small
3748 * widget floating in a much larger empty space. If not set, the weight
3749 * for objects will normally be 0.0 for both axis, meaning the widget will
3750 * not be expanded. To take as much space possible, set the weight to
3751 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
3753 * Besides how much space each object is allocated, it's possible to control
3754 * how the widget will be placed within that space using
3755 * evas_object_size_hint_align_set(). By default, this value will be 0.5
3756 * for both axis, meaning the object will be centered, but any value from
3757 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
3758 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
3759 * is -1.0, means the object will be resized to fill the entire space it
3762 * In addition, customized functions to define the layout can be set, which
3763 * allow the application developer to organize the objects within the box
3764 * in any number of ways.
3766 * The special elm_box_layout_transition() function can be used
3767 * to switch from one layout to another, animating the motion of the
3768 * children of the box.
3770 * @note Objects should not be added to box objects using _add() calls.
3772 * Some examples on how to use boxes follow:
3773 * @li @ref box_example_01
3774 * @li @ref box_example_02
3779 * @typedef Elm_Box_Transition
3781 * Opaque handler containing the parameters to perform an animated
3782 * transition of the layout the box uses.
3784 * @see elm_box_transition_new()
3785 * @see elm_box_layout_set()
3786 * @see elm_box_layout_transition()
3788 typedef struct _Elm_Box_Transition Elm_Box_Transition;
3791 * Add a new box to the parent
3793 * By default, the box will be in vertical mode and non-homogeneous.
3795 * @param parent The parent object
3796 * @return The new object or NULL if it cannot be created
3798 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3800 * Set the horizontal orientation
3802 * By default, box object arranges their contents vertically from top to
3804 * By calling this function with @p horizontal as EINA_TRUE, the box will
3805 * become horizontal, arranging contents from left to right.
3807 * @note This flag is ignored if a custom layout function is set.
3809 * @param obj The box object
3810 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
3811 * EINA_FALSE = vertical)
3813 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
3815 * Get the horizontal orientation
3817 * @param obj The box object
3818 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
3820 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3822 * Set the box to arrange its children homogeneously
3824 * If enabled, homogeneous layout makes all items the same size, according
3825 * to the size of the largest of its children.
3827 * @note This flag is ignored if a custom layout function is set.
3829 * @param obj The box object
3830 * @param homogeneous The homogeneous flag
3832 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3834 * Get whether the box is using homogeneous mode or not
3836 * @param obj The box object
3837 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3839 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3840 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3841 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3843 * Add an object to the beginning of the pack list
3845 * Pack @p subobj into the box @p obj, placing it first in the list of
3846 * children objects. The actual position the object will get on screen
3847 * depends on the layout used. If no custom layout is set, it will be at
3848 * the top or left, depending if the box is vertical or horizontal,
3851 * @param obj The box object
3852 * @param subobj The object to add to the box
3854 * @see elm_box_pack_end()
3855 * @see elm_box_pack_before()
3856 * @see elm_box_pack_after()
3857 * @see elm_box_unpack()
3858 * @see elm_box_unpack_all()
3859 * @see elm_box_clear()
3861 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3863 * Add an object at the end of the pack list
3865 * Pack @p subobj into the box @p obj, placing it last in the list of
3866 * children objects. The actual position the object will get on screen
3867 * depends on the layout used. If no custom layout is set, it will be at
3868 * the bottom or right, depending if the box is vertical or horizontal,
3871 * @param obj The box object
3872 * @param subobj The object to add to the box
3874 * @see elm_box_pack_start()
3875 * @see elm_box_pack_before()
3876 * @see elm_box_pack_after()
3877 * @see elm_box_unpack()
3878 * @see elm_box_unpack_all()
3879 * @see elm_box_clear()
3881 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3883 * Adds an object to the box before the indicated object
3885 * This will add the @p subobj to the box indicated before the object
3886 * indicated with @p before. If @p before is not already in the box, results
3887 * are undefined. Before means either to the left of the indicated object or
3888 * above it depending on orientation.
3890 * @param obj The box object
3891 * @param subobj The object to add to the box
3892 * @param before The object before which to add it
3894 * @see elm_box_pack_start()
3895 * @see elm_box_pack_end()
3896 * @see elm_box_pack_after()
3897 * @see elm_box_unpack()
3898 * @see elm_box_unpack_all()
3899 * @see elm_box_clear()
3901 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3903 * Adds an object to the box after the indicated object
3905 * This will add the @p subobj to the box indicated after the object
3906 * indicated with @p after. If @p after is not already in the box, results
3907 * are undefined. After means either to the right of the indicated object or
3908 * below it depending on orientation.
3910 * @param obj The box object
3911 * @param subobj The object to add to the box
3912 * @param after The object after which to add it
3914 * @see elm_box_pack_start()
3915 * @see elm_box_pack_end()
3916 * @see elm_box_pack_before()
3917 * @see elm_box_unpack()
3918 * @see elm_box_unpack_all()
3919 * @see elm_box_clear()
3921 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3923 * Clear the box of all children
3925 * Remove all the elements contained by the box, deleting the respective
3928 * @param obj The box object
3930 * @see elm_box_unpack()
3931 * @see elm_box_unpack_all()
3933 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3937 * Remove the object given by @p subobj from the box @p obj without
3940 * @param obj The box object
3942 * @see elm_box_unpack_all()
3943 * @see elm_box_clear()
3945 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3947 * Remove all items from the box, without deleting them
3949 * Clear the box from all children, but don't delete the respective objects.
3950 * If no other references of the box children exist, the objects will never
3951 * be deleted, and thus the application will leak the memory. Make sure
3952 * when using this function that you hold a reference to all the objects
3953 * in the box @p obj.
3955 * @param obj The box object
3957 * @see elm_box_clear()
3958 * @see elm_box_unpack()
3960 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3962 * Retrieve a list of the objects packed into the box
3964 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3965 * The order of the list corresponds to the packing order the box uses.
3967 * You must free this list with eina_list_free() once you are done with it.
3969 * @param obj The box object
3971 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3973 * Set the space (padding) between the box's elements.
3975 * Extra space in pixels that will be added between a box child and its
3976 * neighbors after its containing cell has been calculated. This padding
3977 * is set for all elements in the box, besides any possible padding that
3978 * individual elements may have through their size hints.
3980 * @param obj The box object
3981 * @param horizontal The horizontal space between elements
3982 * @param vertical The vertical space between elements
3984 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3986 * Get the space (padding) between the box's elements.
3988 * @param obj The box object
3989 * @param horizontal The horizontal space between elements
3990 * @param vertical The vertical space between elements
3992 * @see elm_box_padding_set()
3994 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3996 * Set the alignment of the whole bouding box of contents.
3998 * Sets how the bounding box containing all the elements of the box, after
3999 * their sizes and position has been calculated, will be aligned within
4000 * the space given for the whole box widget.
4002 * @param obj The box object
4003 * @param horizontal The horizontal alignment of elements
4004 * @param vertical The vertical alignment of elements
4006 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
4008 * Get the alignment of the whole bouding box of contents.
4010 * @param obj The box object
4011 * @param horizontal The horizontal alignment of elements
4012 * @param vertical The vertical alignment of elements
4014 * @see elm_box_align_set()
4016 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
4019 * Set the layout defining function to be used by the box
4021 * Whenever anything changes that requires the box in @p obj to recalculate
4022 * the size and position of its elements, the function @p cb will be called
4023 * to determine what the layout of the children will be.
4025 * Once a custom function is set, everything about the children layout
4026 * is defined by it. The flags set by elm_box_horizontal_set() and
4027 * elm_box_homogeneous_set() no longer have any meaning, and the values
4028 * given by elm_box_padding_set() and elm_box_align_set() are up to this
4029 * layout function to decide if they are used and how. These last two
4030 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
4031 * passed to @p cb. The @c Evas_Object the function receives is not the
4032 * Elementary widget, but the internal Evas Box it uses, so none of the
4033 * functions described here can be used on it.
4035 * Any of the layout functions in @c Evas can be used here, as well as the
4036 * special elm_box_layout_transition().
4038 * The final @p data argument received by @p cb is the same @p data passed
4039 * here, and the @p free_data function will be called to free it
4040 * whenever the box is destroyed or another layout function is set.
4042 * Setting @p cb to NULL will revert back to the default layout function.
4044 * @param obj The box object
4045 * @param cb The callback function used for layout
4046 * @param data Data that will be passed to layout function
4047 * @param free_data Function called to free @p data
4049 * @see elm_box_layout_transition()
4051 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);
4053 * Special layout function that animates the transition from one layout to another
4055 * Normally, when switching the layout function for a box, this will be
4056 * reflected immediately on screen on the next render, but it's also
4057 * possible to do this through an animated transition.
4059 * This is done by creating an ::Elm_Box_Transition and setting the box
4060 * layout to this function.
4064 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
4065 * evas_object_box_layout_vertical, // start
4066 * NULL, // data for initial layout
4067 * NULL, // free function for initial data
4068 * evas_object_box_layout_horizontal, // end
4069 * NULL, // data for final layout
4070 * NULL, // free function for final data
4071 * anim_end, // will be called when animation ends
4072 * NULL); // data for anim_end function\
4073 * elm_box_layout_set(box, elm_box_layout_transition, t,
4074 * elm_box_transition_free);
4077 * @note This function can only be used with elm_box_layout_set(). Calling
4078 * it directly will not have the expected results.
4080 * @see elm_box_transition_new
4081 * @see elm_box_transition_free
4082 * @see elm_box_layout_set
4084 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
4086 * Create a new ::Elm_Box_Transition to animate the switch of layouts
4088 * If you want to animate the change from one layout to another, you need
4089 * to set the layout function of the box to elm_box_layout_transition(),
4090 * passing as user data to it an instance of ::Elm_Box_Transition with the
4091 * necessary information to perform this animation. The free function to
4092 * set for the layout is elm_box_transition_free().
4094 * The parameters to create an ::Elm_Box_Transition sum up to how long
4095 * will it be, in seconds, a layout function to describe the initial point,
4096 * another for the final position of the children and one function to be
4097 * called when the whole animation ends. This last function is useful to
4098 * set the definitive layout for the box, usually the same as the end
4099 * layout for the animation, but could be used to start another transition.
4101 * @param start_layout The layout function that will be used to start the animation
4102 * @param start_layout_data The data to be passed the @p start_layout function
4103 * @param start_layout_free_data Function to free @p start_layout_data
4104 * @param end_layout The layout function that will be used to end the animation
4105 * @param end_layout_free_data The data to be passed the @p end_layout function
4106 * @param end_layout_free_data Function to free @p end_layout_data
4107 * @param transition_end_cb Callback function called when animation ends
4108 * @param transition_end_data Data to be passed to @p transition_end_cb
4109 * @return An instance of ::Elm_Box_Transition
4111 * @see elm_box_transition_new
4112 * @see elm_box_layout_transition
4114 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);
4116 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
4118 * This function is mostly useful as the @c free_data parameter in
4119 * elm_box_layout_set() when elm_box_layout_transition().
4121 * @param data The Elm_Box_Transition instance to be freed.
4123 * @see elm_box_transition_new
4124 * @see elm_box_layout_transition
4126 EAPI void elm_box_transition_free(void *data);
4133 * @defgroup Button Button
4135 * @image html img/widget/button/preview-00.png
4136 * @image latex img/widget/button/preview-00.eps
4137 * @image html img/widget/button/preview-01.png
4138 * @image latex img/widget/button/preview-01.eps
4139 * @image html img/widget/button/preview-02.png
4140 * @image latex img/widget/button/preview-02.eps
4142 * This is a push-button. Press it and run some function. It can contain
4143 * a simple label and icon object and it also has an autorepeat feature.
4145 * This widgets emits the following signals:
4146 * @li "clicked": the user clicked the button (press/release).
4147 * @li "repeated": the user pressed the button without releasing it.
4148 * @li "pressed": button was pressed.
4149 * @li "unpressed": button was released after being pressed.
4150 * In all three cases, the @c event parameter of the callback will be
4153 * Also, defined in the default theme, the button has the following styles
4155 * @li default: a normal button.
4156 * @li anchor: Like default, but the button fades away when the mouse is not
4157 * over it, leaving only the text or icon.
4158 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
4159 * continuous look across its options.
4160 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
4162 * Follow through a complete example @ref button_example_01 "here".
4166 * Add a new button to the parent's canvas
4168 * @param parent The parent object
4169 * @return The new object or NULL if it cannot be created
4171 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4173 * Set the label used in the button
4175 * The passed @p label can be NULL to clean any existing text in it and
4176 * leave the button as an icon only object.
4178 * @param obj The button object
4179 * @param label The text will be written on the button
4180 * @deprecated use elm_object_text_set() instead.
4182 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4184 * Get the label set for the button
4186 * The string returned is an internal pointer and should not be freed or
4187 * altered. It will also become invalid when the button is destroyed.
4188 * The string returned, if not NULL, is a stringshare, so if you need to
4189 * keep it around even after the button is destroyed, you can use
4190 * eina_stringshare_ref().
4192 * @param obj The button object
4193 * @return The text set to the label, or NULL if nothing is set
4194 * @deprecated use elm_object_text_set() instead.
4196 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4198 * Set the icon used for the button
4200 * Setting a new icon will delete any other that was previously set, making
4201 * any reference to them invalid. If you need to maintain the previous
4202 * object alive, unset it first with elm_button_icon_unset().
4204 * @param obj The button object
4205 * @param icon The icon object for the button
4207 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4209 * Get the icon used for the button
4211 * Return the icon object which is set for this widget. If the button is
4212 * destroyed or another icon is set, the returned object will be deleted
4213 * and any reference to it will be invalid.
4215 * @param obj The button object
4216 * @return The icon object that is being used
4218 * @see elm_button_icon_unset()
4220 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4222 * Remove the icon set without deleting it and return the object
4224 * This function drops the reference the button holds of the icon object
4225 * and returns this last object. It is used in case you want to remove any
4226 * icon, or set another one, without deleting the actual object. The button
4227 * will be left without an icon set.
4229 * @param obj The button object
4230 * @return The icon object that was being used
4232 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4234 * Turn on/off the autorepeat event generated when the button is kept pressed
4236 * When off, no autorepeat is performed and buttons emit a normal @c clicked
4237 * signal when they are clicked.
4239 * When on, keeping a button pressed will continuously emit a @c repeated
4240 * signal until the button is released. The time it takes until it starts
4241 * emitting the signal is given by
4242 * elm_button_autorepeat_initial_timeout_set(), and the time between each
4243 * new emission by elm_button_autorepeat_gap_timeout_set().
4245 * @param obj The button object
4246 * @param on A bool to turn on/off the event
4248 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
4250 * Get whether the autorepeat feature is enabled
4252 * @param obj The button object
4253 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
4255 * @see elm_button_autorepeat_set()
4257 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4259 * Set the initial timeout before the autorepeat event is generated
4261 * Sets the timeout, in seconds, since the button is pressed until the
4262 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
4263 * won't be any delay and the even will be fired the moment the button is
4266 * @param obj The button object
4267 * @param t Timeout in seconds
4269 * @see elm_button_autorepeat_set()
4270 * @see elm_button_autorepeat_gap_timeout_set()
4272 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4274 * Get the initial timeout before the autorepeat event is generated
4276 * @param obj The button object
4277 * @return Timeout in seconds
4279 * @see elm_button_autorepeat_initial_timeout_set()
4281 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4283 * Set the interval between each generated autorepeat event
4285 * After the first @c repeated event is fired, all subsequent ones will
4286 * follow after a delay of @p t seconds for each.
4288 * @param obj The button object
4289 * @param t Interval in seconds
4291 * @see elm_button_autorepeat_initial_timeout_set()
4293 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
4295 * Get the interval between each generated autorepeat event
4297 * @param obj The button object
4298 * @return Interval in seconds
4300 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4306 * @defgroup File_Selector_Button File Selector Button
4308 * @image html img/widget/fileselector_button/preview-00.png
4309 * @image latex img/widget/fileselector_button/preview-00.eps
4310 * @image html img/widget/fileselector_button/preview-01.png
4311 * @image latex img/widget/fileselector_button/preview-01.eps
4312 * @image html img/widget/fileselector_button/preview-02.png
4313 * @image latex img/widget/fileselector_button/preview-02.eps
4315 * This is a button that, when clicked, creates an Elementary
4316 * window (or inner window) <b> with a @ref Fileselector "file
4317 * selector widget" within</b>. When a file is chosen, the (inner)
4318 * window is closed and the button emits a signal having the
4319 * selected file as it's @c event_info.
4321 * This widget encapsulates operations on its internal file
4322 * selector on its own API. There is less control over its file
4323 * selector than that one would have instatiating one directly.
4325 * The following styles are available for this button:
4328 * @li @c "hoversel_vertical"
4329 * @li @c "hoversel_vertical_entry"
4331 * Smart callbacks one can register to:
4332 * - @c "file,chosen" - the user has selected a path, whose string
4333 * pointer comes as the @c event_info data (a stringshared
4336 * Here is an example on its usage:
4337 * @li @ref fileselector_button_example
4339 * @see @ref File_Selector_Entry for a similar widget.
4344 * Add a new file selector button widget to the given parent
4345 * Elementary (container) object
4347 * @param parent The parent object
4348 * @return a new file selector button widget handle or @c NULL, on
4351 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4354 * Set the label for a given file selector button widget
4356 * @param obj The file selector button widget
4357 * @param label The text label to be displayed on @p obj
4359 * @deprecated use elm_object_text_set() instead.
4361 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4364 * Get the label set for a given file selector button widget
4366 * @param obj The file selector button widget
4367 * @return The button label
4369 * @deprecated use elm_object_text_set() instead.
4371 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4374 * Set the icon on a given file selector button widget
4376 * @param obj The file selector button widget
4377 * @param icon The icon object for the button
4379 * Once the icon object is set, a previously set one will be
4380 * deleted. If you want to keep the latter, use the
4381 * elm_fileselector_button_icon_unset() function.
4383 * @see elm_fileselector_button_icon_get()
4385 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4388 * Get the icon set for a given file selector button widget
4390 * @param obj The file selector button widget
4391 * @return The icon object currently set on @p obj or @c NULL, if
4394 * @see elm_fileselector_button_icon_set()
4396 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4399 * Unset the icon used in a given file selector button widget
4401 * @param obj The file selector button widget
4402 * @return The icon object that was being used on @p obj or @c
4405 * Unparent and return the icon object which was set for this
4408 * @see elm_fileselector_button_icon_set()
4410 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4413 * Set the title for a given file selector button widget's window
4415 * @param obj The file selector button widget
4416 * @param title The title string
4418 * This will change the window's title, when the file selector pops
4419 * out after a click on the button. Those windows have the default
4420 * (unlocalized) value of @c "Select a file" as titles.
4422 * @note It will only take any effect if the file selector
4423 * button widget is @b not under "inwin mode".
4425 * @see elm_fileselector_button_window_title_get()
4427 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4430 * Get the title set for a given file selector button widget's
4433 * @param obj The file selector button widget
4434 * @return Title of the file selector button's window
4436 * @see elm_fileselector_button_window_title_get() for more details
4438 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4441 * Set the size of a given file selector button widget's window,
4442 * holding the file selector itself.
4444 * @param obj The file selector button widget
4445 * @param width The window's width
4446 * @param height The window's height
4448 * @note it will only take any effect if the file selector button
4449 * widget is @b not under "inwin mode". The default size for the
4450 * window (when applicable) is 400x400 pixels.
4452 * @see elm_fileselector_button_window_size_get()
4454 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4457 * Get the size of a given file selector button widget's window,
4458 * holding the file selector itself.
4460 * @param obj The file selector button widget
4461 * @param width Pointer into which to store the width value
4462 * @param height Pointer into which to store the height value
4464 * @note Use @c NULL pointers on the size values you're not
4465 * interested in: they'll be ignored by the function.
4467 * @see elm_fileselector_button_window_size_set(), for more details
4469 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4472 * Set the initial file system path for a given file selector
4475 * @param obj The file selector button widget
4476 * @param path The path string
4478 * It must be a <b>directory</b> path, which will have the contents
4479 * displayed initially in the file selector's view, when invoked
4480 * from @p obj. The default initial path is the @c "HOME"
4481 * environment variable's value.
4483 * @see elm_fileselector_button_path_get()
4485 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4488 * Get the initial file system path set for a given file selector
4491 * @param obj The file selector button widget
4492 * @return path The path string
4494 * @see elm_fileselector_button_path_set() for more details
4496 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4499 * Enable/disable a tree view in the given file selector button
4500 * widget's internal file selector
4502 * @param obj The file selector button widget
4503 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4506 * This has the same effect as elm_fileselector_expandable_set(),
4507 * but now applied to a file selector button's internal file
4510 * @note There's no way to put a file selector button's internal
4511 * file selector in "grid mode", as one may do with "pure" file
4514 * @see elm_fileselector_expandable_get()
4516 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4519 * Get whether tree view is enabled for the given file selector
4520 * button widget's internal file selector
4522 * @param obj The file selector button widget
4523 * @return @c EINA_TRUE if @p obj widget's internal file selector
4524 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4526 * @see elm_fileselector_expandable_set() for more details
4528 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4531 * Set whether a given file selector button widget's internal file
4532 * selector is to display folders only or the directory contents,
4535 * @param obj The file selector button widget
4536 * @param only @c EINA_TRUE to make @p obj widget's internal file
4537 * selector only display directories, @c EINA_FALSE to make files
4538 * to be displayed in it too
4540 * This has the same effect as elm_fileselector_folder_only_set(),
4541 * but now applied to a file selector button's internal file
4544 * @see elm_fileselector_folder_only_get()
4546 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4549 * Get whether a given file selector button widget's internal file
4550 * selector is displaying folders only or the directory contents,
4553 * @param obj The file selector button widget
4554 * @return @c EINA_TRUE if @p obj widget's internal file
4555 * selector is only displaying directories, @c EINA_FALSE if files
4556 * are being displayed in it too (and on errors)
4558 * @see elm_fileselector_button_folder_only_set() for more details
4560 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4563 * Enable/disable the file name entry box where the user can type
4564 * in a name for a file, in a given file selector button widget's
4565 * internal file selector.
4567 * @param obj The file selector button widget
4568 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4569 * file selector a "saving dialog", @c EINA_FALSE otherwise
4571 * This has the same effect as elm_fileselector_is_save_set(),
4572 * but now applied to a file selector button's internal file
4575 * @see elm_fileselector_is_save_get()
4577 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4580 * Get whether the given file selector button widget's internal
4581 * file selector is in "saving dialog" mode
4583 * @param obj The file selector button widget
4584 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4585 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4588 * @see elm_fileselector_button_is_save_set() for more details
4590 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4593 * Set whether a given file selector button widget's internal file
4594 * selector will raise an Elementary "inner window", instead of a
4595 * dedicated Elementary window. By default, it won't.
4597 * @param obj The file selector button widget
4598 * @param value @c EINA_TRUE to make it use an inner window, @c
4599 * EINA_TRUE to make it use a dedicated window
4601 * @see elm_win_inwin_add() for more information on inner windows
4602 * @see elm_fileselector_button_inwin_mode_get()
4604 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4607 * Get whether a given file selector button widget's internal file
4608 * selector will raise an Elementary "inner window", instead of a
4609 * dedicated Elementary window.
4611 * @param obj The file selector button widget
4612 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4613 * if it will use a dedicated window
4615 * @see elm_fileselector_button_inwin_mode_set() for more details
4617 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4624 * @defgroup File_Selector_Entry File Selector Entry
4626 * @image html img/widget/fileselector_entry/preview-00.png
4627 * @image latex img/widget/fileselector_entry/preview-00.eps
4629 * This is an entry made to be filled with or display a <b>file
4630 * system path string</b>. Besides the entry itself, the widget has
4631 * a @ref File_Selector_Button "file selector button" on its side,
4632 * which will raise an internal @ref Fileselector "file selector widget",
4633 * when clicked, for path selection aided by file system
4636 * This file selector may appear in an Elementary window or in an
4637 * inner window. When a file is chosen from it, the (inner) window
4638 * is closed and the selected file's path string is exposed both as
4639 * an smart event and as the new text on the entry.
4641 * This widget encapsulates operations on its internal file
4642 * selector on its own API. There is less control over its file
4643 * selector than that one would have instatiating one directly.
4645 * Smart callbacks one can register to:
4646 * - @c "changed" - The text within the entry was changed
4647 * - @c "activated" - The entry has had editing finished and
4648 * changes are to be "committed"
4649 * - @c "press" - The entry has been clicked
4650 * - @c "longpressed" - The entry has been clicked (and held) for a
4652 * - @c "clicked" - The entry has been clicked
4653 * - @c "clicked,double" - The entry has been double clicked
4654 * - @c "focused" - The entry has received focus
4655 * - @c "unfocused" - The entry has lost focus
4656 * - @c "selection,paste" - A paste action has occurred on the
4658 * - @c "selection,copy" - A copy action has occurred on the entry
4659 * - @c "selection,cut" - A cut action has occurred on the entry
4660 * - @c "unpressed" - The file selector entry's button was released
4661 * after being pressed.
4662 * - @c "file,chosen" - The user has selected a path via the file
4663 * selector entry's internal file selector, whose string pointer
4664 * comes as the @c event_info data (a stringshared string)
4666 * Here is an example on its usage:
4667 * @li @ref fileselector_entry_example
4669 * @see @ref File_Selector_Button for a similar widget.
4674 * Add a new file selector entry widget to the given parent
4675 * Elementary (container) object
4677 * @param parent The parent object
4678 * @return a new file selector entry widget handle or @c NULL, on
4681 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4684 * Set the label for a given file selector entry widget's button
4686 * @param obj The file selector entry widget
4687 * @param label The text label to be displayed on @p obj widget's
4690 * @deprecated use elm_object_text_set() instead.
4692 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4695 * Get the label set for a given file selector entry widget's button
4697 * @param obj The file selector entry widget
4698 * @return The widget button's label
4700 * @deprecated use elm_object_text_set() instead.
4702 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4705 * Set the icon on a given file selector entry widget's button
4707 * @param obj The file selector entry widget
4708 * @param icon The icon object for the entry's button
4710 * Once the icon object is set, a previously set one will be
4711 * deleted. If you want to keep the latter, use the
4712 * elm_fileselector_entry_button_icon_unset() function.
4714 * @see elm_fileselector_entry_button_icon_get()
4716 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4719 * Get the icon set for a given file selector entry widget's button
4721 * @param obj The file selector entry widget
4722 * @return The icon object currently set on @p obj widget's button
4723 * or @c NULL, if none is
4725 * @see elm_fileselector_entry_button_icon_set()
4727 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4730 * Unset the icon used in a given file selector entry widget's
4733 * @param obj The file selector entry widget
4734 * @return The icon object that was being used on @p obj widget's
4735 * button or @c NULL, on errors
4737 * Unparent and return the icon object which was set for this
4740 * @see elm_fileselector_entry_button_icon_set()
4742 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4745 * Set the title for a given file selector entry widget's window
4747 * @param obj The file selector entry widget
4748 * @param title The title string
4750 * This will change the window's title, when the file selector pops
4751 * out after a click on the entry's button. Those windows have the
4752 * default (unlocalized) value of @c "Select a file" as titles.
4754 * @note It will only take any effect if the file selector
4755 * entry widget is @b not under "inwin mode".
4757 * @see elm_fileselector_entry_window_title_get()
4759 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4762 * Get the title set for a given file selector entry widget's
4765 * @param obj The file selector entry widget
4766 * @return Title of the file selector entry's window
4768 * @see elm_fileselector_entry_window_title_get() for more details
4770 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4773 * Set the size of a given file selector entry widget's window,
4774 * holding the file selector itself.
4776 * @param obj The file selector entry widget
4777 * @param width The window's width
4778 * @param height The window's height
4780 * @note it will only take any effect if the file selector entry
4781 * widget is @b not under "inwin mode". The default size for the
4782 * window (when applicable) is 400x400 pixels.
4784 * @see elm_fileselector_entry_window_size_get()
4786 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
4789 * Get the size of a given file selector entry widget's window,
4790 * holding the file selector itself.
4792 * @param obj The file selector entry widget
4793 * @param width Pointer into which to store the width value
4794 * @param height Pointer into which to store the height value
4796 * @note Use @c NULL pointers on the size values you're not
4797 * interested in: they'll be ignored by the function.
4799 * @see elm_fileselector_entry_window_size_set(), for more details
4801 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
4804 * Set the initial file system path and the entry's path string for
4805 * a given file selector entry widget
4807 * @param obj The file selector entry widget
4808 * @param path The path string
4810 * It must be a <b>directory</b> path, which will have the contents
4811 * displayed initially in the file selector's view, when invoked
4812 * from @p obj. The default initial path is the @c "HOME"
4813 * environment variable's value.
4815 * @see elm_fileselector_entry_path_get()
4817 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4820 * Get the entry's path string for a given file selector entry
4823 * @param obj The file selector entry widget
4824 * @return path The path string
4826 * @see elm_fileselector_entry_path_set() for more details
4828 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4831 * Enable/disable a tree view in the given file selector entry
4832 * widget's internal file selector
4834 * @param obj The file selector entry widget
4835 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
4838 * This has the same effect as elm_fileselector_expandable_set(),
4839 * but now applied to a file selector entry's internal file
4842 * @note There's no way to put a file selector entry's internal
4843 * file selector in "grid mode", as one may do with "pure" file
4846 * @see elm_fileselector_expandable_get()
4848 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4851 * Get whether tree view is enabled for the given file selector
4852 * entry widget's internal file selector
4854 * @param obj The file selector entry widget
4855 * @return @c EINA_TRUE if @p obj widget's internal file selector
4856 * is in tree view, @c EINA_FALSE otherwise (and or errors)
4858 * @see elm_fileselector_expandable_set() for more details
4860 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4863 * Set whether a given file selector entry widget's internal file
4864 * selector is to display folders only or the directory contents,
4867 * @param obj The file selector entry widget
4868 * @param only @c EINA_TRUE to make @p obj widget's internal file
4869 * selector only display directories, @c EINA_FALSE to make files
4870 * to be displayed in it too
4872 * This has the same effect as elm_fileselector_folder_only_set(),
4873 * but now applied to a file selector entry's internal file
4876 * @see elm_fileselector_folder_only_get()
4878 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4881 * Get whether a given file selector entry widget's internal file
4882 * selector is displaying folders only or the directory contents,
4885 * @param obj The file selector entry widget
4886 * @return @c EINA_TRUE if @p obj widget's internal file
4887 * selector is only displaying directories, @c EINA_FALSE if files
4888 * are being displayed in it too (and on errors)
4890 * @see elm_fileselector_entry_folder_only_set() for more details
4892 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4895 * Enable/disable the file name entry box where the user can type
4896 * in a name for a file, in a given file selector entry widget's
4897 * internal file selector.
4899 * @param obj The file selector entry widget
4900 * @param is_save @c EINA_TRUE to make @p obj widget's internal
4901 * file selector a "saving dialog", @c EINA_FALSE otherwise
4903 * This has the same effect as elm_fileselector_is_save_set(),
4904 * but now applied to a file selector entry's internal file
4907 * @see elm_fileselector_is_save_get()
4909 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4912 * Get whether the given file selector entry widget's internal
4913 * file selector is in "saving dialog" mode
4915 * @param obj The file selector entry widget
4916 * @return @c EINA_TRUE, if @p obj widget's internal file selector
4917 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
4920 * @see elm_fileselector_entry_is_save_set() for more details
4922 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4925 * Set whether a given file selector entry widget's internal file
4926 * selector will raise an Elementary "inner window", instead of a
4927 * dedicated Elementary window. By default, it won't.
4929 * @param obj The file selector entry widget
4930 * @param value @c EINA_TRUE to make it use an inner window, @c
4931 * EINA_TRUE to make it use a dedicated window
4933 * @see elm_win_inwin_add() for more information on inner windows
4934 * @see elm_fileselector_entry_inwin_mode_get()
4936 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
4939 * Get whether a given file selector entry widget's internal file
4940 * selector will raise an Elementary "inner window", instead of a
4941 * dedicated Elementary window.
4943 * @param obj The file selector entry widget
4944 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
4945 * if it will use a dedicated window
4947 * @see elm_fileselector_entry_inwin_mode_set() for more details
4949 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4952 * Set the initial file system path for a given file selector entry
4955 * @param obj The file selector entry widget
4956 * @param path The path string
4958 * It must be a <b>directory</b> path, which will have the contents
4959 * displayed initially in the file selector's view, when invoked
4960 * from @p obj. The default initial path is the @c "HOME"
4961 * environment variable's value.
4963 * @see elm_fileselector_entry_path_get()
4965 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
4968 * Get the parent directory's path to the latest file selection on
4969 * a given filer selector entry widget
4971 * @param obj The file selector object
4972 * @return The (full) path of the directory of the last selection
4973 * on @p obj widget, a @b stringshared string
4975 * @see elm_fileselector_entry_path_set()
4977 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4984 * @defgroup Scroller Scroller
4986 * A scroller holds a single object and "scrolls it around". This means that
4987 * it allows the user to use a scrollbar (or a finger) to drag the viewable
4988 * region around, allowing to move through a much larger object that is
4989 * contained in the scroller. The scroiller will always have a small minimum
4990 * size by default as it won't be limited by the contents of the scroller.
4992 * Signals that you can add callbacks for are:
4993 * @li "edge,left" - the left edge of the content has been reached
4994 * @li "edge,right" - the right edge of the content has been reached
4995 * @li "edge,top" - the top edge of the content has been reached
4996 * @li "edge,bottom" - the bottom edge of the content has been reached
4997 * @li "scroll" - the content has been scrolled (moved)
4998 * @li "scroll,anim,start" - scrolling animation has started
4999 * @li "scroll,anim,stop" - scrolling animation has stopped
5000 * @li "scroll,drag,start" - dragging the contents around has started
5001 * @li "scroll,drag,stop" - dragging the contents around has stopped
5002 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
5005 * @note When Elemementary is in embedded mode the scrollbars will not be
5006 * dragable, they appear merely as indicators of how much has been scrolled.
5007 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
5008 * fingerscroll) won't work.
5010 * In @ref tutorial_scroller you'll find an example of how to use most of
5015 * @brief Type that controls when scrollbars should appear.
5017 * @see elm_scroller_policy_set()
5019 typedef enum _Elm_Scroller_Policy
5021 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
5022 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
5023 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
5024 ELM_SCROLLER_POLICY_LAST
5025 } Elm_Scroller_Policy;
5027 * @brief Add a new scroller to the parent
5029 * @param parent The parent object
5030 * @return The new object or NULL if it cannot be created
5032 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5034 * @brief Set the content of the scroller widget (the object to be scrolled around).
5036 * @param obj The scroller object
5037 * @param content The new content object
5039 * Once the content object is set, a previously set one will be deleted.
5040 * If you want to keep that old content object, use the
5041 * elm_scroller_content_unset() function.
5043 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
5045 * @brief Get the content of the scroller widget
5047 * @param obj The slider object
5048 * @return The content that is being used
5050 * Return the content object which is set for this widget
5052 * @see elm_scroller_content_set()
5054 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5056 * @brief Unset the content of the scroller widget
5058 * @param obj The slider object
5059 * @return The content that was being used
5061 * Unparent and return the content object which was set for this widget
5063 * @see elm_scroller_content_set()
5065 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5067 * @brief Set custom theme elements for the scroller
5069 * @param obj The scroller object
5070 * @param widget The widget name to use (default is "scroller")
5071 * @param base The base name to use (default is "base")
5073 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
5075 * @brief Make the scroller minimum size limited to the minimum size of the content
5077 * @param obj The scroller object
5078 * @param w Enable limiting minimum size horizontally
5079 * @param h Enable limiting minimum size vertically
5081 * By default the scroller will be as small as its design allows,
5082 * irrespective of its content. This will make the scroller minimum size the
5083 * right size horizontally and/or vertically to perfectly fit its content in
5086 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
5088 * @brief Show a specific virtual region within the scroller content object
5090 * @param obj The scroller object
5091 * @param x X coordinate of the region
5092 * @param y Y coordinate of the region
5093 * @param w Width of the region
5094 * @param h Height of the region
5096 * This will ensure all (or part if it does not fit) of the designated
5097 * region in the virtual content object (0, 0 starting at the top-left of the
5098 * virtual content object) is shown within the scroller.
5100 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);
5102 * @brief Set the scrollbar visibility policy
5104 * @param obj The scroller object
5105 * @param policy_h Horizontal scrollbar policy
5106 * @param policy_v Vertical scrollbar policy
5108 * This sets the scrollbar visibility policy for the given scroller.
5109 * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
5110 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
5111 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
5112 * respectively for the horizontal and vertical scrollbars.
5114 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5116 * @brief Gets scrollbar visibility policy
5118 * @param obj The scroller object
5119 * @param policy_h Horizontal scrollbar policy
5120 * @param policy_v Vertical scrollbar policy
5122 * @see elm_scroller_policy_set()
5124 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
5126 * @brief Get the currently visible content region
5128 * @param obj The scroller object
5129 * @param x X coordinate of the region
5130 * @param y Y coordinate of the region
5131 * @param w Width of the region
5132 * @param h Height of the region
5134 * This gets the current region in the content object that is visible through
5135 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
5136 * w, @p h values pointed to.
5138 * @note All coordinates are relative to the content.
5140 * @see elm_scroller_region_show()
5142 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);
5144 * @brief Get the size of the content object
5146 * @param obj The scroller object
5147 * @param w Width return
5148 * @param h Height return
5150 * This gets the size of the content object of the scroller.
5152 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
5154 * @brief Set bouncing behavior
5156 * @param obj The scroller object
5157 * @param h_bounce Will the scroller bounce horizontally or not
5158 * @param v_bounce Will the scroller bounce vertically or not
5160 * When scrolling, the scroller may "bounce" when reaching an edge of the
5161 * content object. This is a visual way to indicate the end has been reached.
5162 * This is enabled by default for both axis. This will set if it is enabled
5163 * for that axis with the boolean parameters for each axis.
5165 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5167 * @brief Get the bounce mode
5169 * @param obj The Scroller object
5170 * @param h_bounce Allow bounce horizontally
5171 * @param v_bounce Allow bounce vertically
5173 * @see elm_scroller_bounce_set()
5175 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5177 * @brief Set scroll page size relative to viewport size.
5179 * @param obj The scroller object
5180 * @param h_pagerel The horizontal page relative size
5181 * @param v_pagerel The vertical page relative size
5183 * The scroller is capable of limiting scrolling by the user to "pages". That
5184 * is to jump by and only show a "whole page" at a time as if the continuous
5185 * area of the scroller content is split into page sized pieces. This sets
5186 * the size of a page relative to the viewport of the scroller. 1.0 is "1
5187 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
5188 * axis. This is mutually exclusive with page size
5189 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
5190 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
5191 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
5194 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
5196 * @brief Set scroll page size.
5198 * @param obj The scroller object
5199 * @param h_pagesize The horizontal page size
5200 * @param v_pagesize The vertical page size
5202 * This sets the page size to an absolute fixed value, with 0 turning it off
5205 * @see elm_scroller_page_relative_set()
5207 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
5209 * @brief Show a specific virtual region within the scroller content object.
5211 * @param obj The scroller object
5212 * @param x X coordinate of the region
5213 * @param y Y coordinate of the region
5214 * @param w Width of the region
5215 * @param h Height of the region
5217 * This will ensure all (or part if it does not fit) of the designated
5218 * region in the virtual content object (0, 0 starting at the top-left of the
5219 * virtual content object) is shown within the scroller. Unlike
5220 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
5221 * to this location (if configuration in general calls for transitions). It
5222 * may not jump immediately to the new location and make take a while and
5223 * show other content along the way.
5225 * @see elm_scroller_region_show()
5227 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);
5229 * @brief Set event propagation on a scroller
5231 * @param obj The scroller object
5232 * @param propagation If propagation is enabled or not
5234 * This enables or disabled event propagation from the scroller content to
5235 * the scroller and its parent. By default event propagation is disabled.
5237 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
5239 * @brief Get event propagation for a scroller
5241 * @param obj The scroller object
5242 * @return The propagation state
5244 * This gets the event propagation for a scroller.
5246 * @see elm_scroller_propagate_events_set()
5248 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
5254 * @defgroup Label Label
5256 * @image html img/widget/label/preview-00.png
5257 * @image latex img/widget/label/preview-00.eps
5259 * @brief Widget to display text, with simple html-like markup.
5261 * The Label widget @b doesn't allow text to overflow its boundaries, if the
5262 * text doesn't fit the geometry of the label it will be ellipsized or be
5263 * cut. Elementary provides several themes for this widget:
5264 * @li default - No animation
5265 * @li marker - Centers the text in the label and make it bold by default
5266 * @li slide_long - The entire text appears from the right of the screen and
5267 * slides until it disappears in the left of the screen(reappering on the
5269 * @li slide_short - The text appears in the left of the label and slides to
5270 * the right to show the overflow. When all of the text has been shown the
5271 * position is reset.
5272 * @li slide_bounce - The text appears in the left of the label and slides to
5273 * the right to show the overflow. When all of the text has been shown the
5274 * animation reverses, moving the text to the left.
5276 * Custom themes can of course invent new markup tags and style them any way
5279 * See @ref tutorial_label for a demonstration of how to use a label widget.
5283 * @brief Add a new label to the parent
5285 * @param parent The parent object
5286 * @return The new object or NULL if it cannot be created
5288 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5290 * @brief Set the label on the label object
5292 * @param obj The label object
5293 * @param label The label will be used on the label object
5294 * @deprecated See elm_object_text_set()
5296 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 */
5298 * @brief Get the label used on the label object
5300 * @param obj The label object
5301 * @return The string inside the label
5302 * @deprecated See elm_object_text_get()
5304 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
5306 * @brief Set the wrapping behavior of the label
5308 * @param obj The label object
5309 * @param wrap To wrap text or not
5311 * By default no wrapping is done. Possible values for @p wrap are:
5312 * @li ELM_WRAP_NONE - No wrapping
5313 * @li ELM_WRAP_CHAR - wrap between characters
5314 * @li ELM_WRAP_WORD - wrap between words
5315 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
5317 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
5319 * @brief Get the wrapping behavior of the label
5321 * @param obj The label object
5324 * @see elm_label_line_wrap_set()
5326 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5328 * @brief Set wrap width of the label
5330 * @param obj The label object
5331 * @param w The wrap width in pixels at a minimum where words need to wrap
5333 * This function sets the maximum width size hint of the label.
5335 * @warning This is only relevant if the label is inside a container.
5337 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
5339 * @brief Get wrap width of the label
5341 * @param obj The label object
5342 * @return The wrap width in pixels at a minimum where words need to wrap
5344 * @see elm_label_wrap_width_set()
5346 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5348 * @brief Set wrap height of the label
5350 * @param obj The label object
5351 * @param h The wrap height in pixels at a minimum where words need to wrap
5353 * This function sets the maximum height size hint of the label.
5355 * @warning This is only relevant if the label is inside a container.
5357 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
5359 * @brief get wrap width of the label
5361 * @param obj The label object
5362 * @return The wrap height in pixels at a minimum where words need to wrap
5364 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5366 * @brief Set the font size on the label object.
5368 * @param obj The label object
5369 * @param size font size
5371 * @warning NEVER use this. It is for hyper-special cases only. use styles
5372 * instead. e.g. "big", "medium", "small" - or better name them by use:
5373 * "title", "footnote", "quote" etc.
5375 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
5377 * @brief Set the text color on the label object
5379 * @param obj The label object
5380 * @param r Red property background color of The label object
5381 * @param g Green property background color of The label object
5382 * @param b Blue property background color of The label object
5383 * @param a Alpha property background color of The label object
5385 * @warning NEVER use this. It is for hyper-special cases only. use styles
5386 * instead. e.g. "big", "medium", "small" - or better name them by use:
5387 * "title", "footnote", "quote" etc.
5389 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);
5391 * @brief Set the text align on the label object
5393 * @param obj The label object
5394 * @param align align mode ("left", "center", "right")
5396 * @warning NEVER use this. It is for hyper-special cases only. use styles
5397 * instead. e.g. "big", "medium", "small" - or better name them by use:
5398 * "title", "footnote", "quote" etc.
5400 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
5402 * @brief Set background color of the label
5404 * @param obj The label object
5405 * @param r Red property background color of The label object
5406 * @param g Green property background color of The label object
5407 * @param b Blue property background color of The label object
5408 * @param a Alpha property background alpha of The label object
5410 * @warning NEVER use this. It is for hyper-special cases only. use styles
5411 * instead. e.g. "big", "medium", "small" - or better name them by use:
5412 * "title", "footnote", "quote" etc.
5414 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);
5416 * @brief Set the ellipsis behavior of the label
5418 * @param obj The label object
5419 * @param ellipsis To ellipsis text or not
5421 * If set to true and the text doesn't fit in the label an ellipsis("...")
5422 * will be shown at the end of the widget.
5424 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
5425 * choosen wrap method was ELM_WRAP_WORD.
5427 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
5429 * @brief Set the text slide of the label
5431 * @param obj The label object
5432 * @param slide To start slide or stop
5434 * If set to true the text of the label will slide throught the length of
5437 * @warning This only work with the themes "slide_short", "slide_long" and
5440 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
5442 * @brief Get the text slide mode of the label
5444 * @param obj The label object
5445 * @return slide slide mode value
5447 * @see elm_label_slide_set()
5449 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5451 * @brief Set the slide duration(speed) of the label
5453 * @param obj The label object
5454 * @return The duration in seconds in moving text from slide begin position
5455 * to slide end position
5457 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
5459 * @brief Get the slide duration(speed) of the label
5461 * @param obj The label object
5462 * @return The duration time in moving text from slide begin position to slide end position
5464 * @see elm_label_slide_duration_set()
5466 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5472 * @defgroup Toggle Toggle
5474 * @image html img/widget/toggle/preview-00.png
5475 * @image latex img/widget/toggle/preview-00.eps
5477 * @brief A toggle is a slider which can be used to toggle between
5478 * two values. It has two states: on and off.
5480 * Signals that you can add callbacks for are:
5481 * @li "changed" - Whenever the toggle value has been changed. Is not called
5482 * until the toggle is released by the cursor (assuming it
5483 * has been triggered by the cursor in the first place).
5485 * @ref tutorial_toggle show how to use a toggle.
5489 * @brief Add a toggle to @p parent.
5491 * @param parent The parent object
5493 * @return The toggle object
5495 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5497 * @brief Sets the label to be displayed with the toggle.
5499 * @param obj The toggle object
5500 * @param label The label to be displayed
5502 * @deprecated use elm_object_text_set() instead.
5504 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5506 * @brief Gets the label of the toggle
5508 * @param obj toggle object
5509 * @return The label of the toggle
5511 * @deprecated use elm_object_text_get() instead.
5513 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5515 * @brief Set the icon used for the toggle
5517 * @param obj The toggle object
5518 * @param icon The icon object for the button
5520 * Once the icon object is set, a previously set one will be deleted
5521 * If you want to keep that old content object, use the
5522 * elm_toggle_icon_unset() function.
5524 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5526 * @brief Get the icon used for the toggle
5528 * @param obj The toggle object
5529 * @return The icon object that is being used
5531 * Return the icon object which is set for this widget.
5533 * @see elm_toggle_icon_set()
5535 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5537 * @brief Unset the icon used for the toggle
5539 * @param obj The toggle object
5540 * @return The icon object that was being used
5542 * Unparent and return the icon object which was set for this widget.
5544 * @see elm_toggle_icon_set()
5546 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5548 * @brief Sets the labels to be associated with the on and off states of the toggle.
5550 * @param obj The toggle object
5551 * @param onlabel The label displayed when the toggle is in the "on" state
5552 * @param offlabel The label displayed when the toggle is in the "off" state
5554 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
5556 * @brief Gets the labels associated with the on and off states of the toggle.
5558 * @param obj The toggle object
5559 * @param onlabel A char** to place the onlabel of @p obj into
5560 * @param offlabel A char** to place the offlabel of @p obj into
5562 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
5564 * @brief Sets the state of the toggle to @p state.
5566 * @param obj The toggle object
5567 * @param state The state of @p obj
5569 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
5571 * @brief Gets the state of the toggle to @p state.
5573 * @param obj The toggle object
5574 * @return The state of @p obj
5576 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5578 * @brief Sets the state pointer of the toggle to @p statep.
5580 * @param obj The toggle object
5581 * @param statep The state pointer of @p obj
5583 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
5589 * @defgroup Frame Frame
5591 * @image html img/widget/frame/preview-00.png
5592 * @image latex img/widget/frame/preview-00.eps
5594 * @brief Frame is a widget that holds some content and has a title.
5596 * The default look is a frame with a title, but Frame supports multple
5604 * @li outdent_bottom
5606 * Of all this styles only default shows the title. Frame emits no signals.
5608 * For a detailed example see the @ref tutorial_frame.
5613 * @brief Add a new frame to the parent
5615 * @param parent The parent object
5616 * @return The new object or NULL if it cannot be created
5618 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5620 * @brief Set the frame label
5622 * @param obj The frame object
5623 * @param label The label of this frame object
5625 * @deprecated use elm_object_text_set() instead.
5627 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5629 * @brief Get the frame label
5631 * @param obj The frame object
5633 * @return The label of this frame objet or NULL if unable to get frame
5635 * @deprecated use elm_object_text_get() instead.
5637 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5639 * @brief Set the content of the frame widget
5641 * Once the content object is set, a previously set one will be deleted.
5642 * If you want to keep that old content object, use the
5643 * elm_frame_content_unset() function.
5645 * @param obj The frame object
5646 * @param content The content will be filled in this frame object
5648 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5650 * @brief Get the content of the frame widget
5652 * Return the content object which is set for this widget
5654 * @param obj The frame object
5655 * @return The content that is being used
5657 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5659 * @brief Unset the content of the frame widget
5661 * Unparent and return the content object which was set for this widget
5663 * @param obj The frame object
5664 * @return The content that was being used
5666 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5672 * @defgroup Table Table
5674 * A container widget to arrange other widgets in a table where items can
5675 * also span multiple columns or rows - even overlap (and then be raised or
5676 * lowered accordingly to adjust stacking if they do overlap).
5678 * The followin are examples of how to use a table:
5679 * @li @ref tutorial_table_01
5680 * @li @ref tutorial_table_02
5685 * @brief Add a new table to the parent
5687 * @param parent The parent object
5688 * @return The new object or NULL if it cannot be created
5690 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5692 * @brief Set the homogeneous layout in the table
5694 * @param obj The layout object
5695 * @param homogeneous A boolean to set if the layout is homogeneous in the
5696 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5698 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5700 * @brief Get the current table homogeneous mode.
5702 * @param obj The table object
5703 * @return A boolean to indicating if the layout is homogeneous in the table
5704 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
5706 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5708 * @warning <b>Use elm_table_homogeneous_set() instead</b>
5710 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5712 * @warning <b>Use elm_table_homogeneous_get() instead</b>
5714 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5716 * @brief Set padding between cells.
5718 * @param obj The layout object.
5719 * @param horizontal set the horizontal padding.
5720 * @param vertical set the vertical padding.
5722 * Default value is 0.
5724 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5726 * @brief Get padding between cells.
5728 * @param obj The layout object.
5729 * @param horizontal set the horizontal padding.
5730 * @param vertical set the vertical padding.
5732 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5734 * @brief Add a subobject on the table with the coordinates passed
5736 * @param obj The table object
5737 * @param subobj The subobject to be added to the table
5738 * @param x Row number
5739 * @param y Column number
5743 * @note All positioning inside the table is relative to rows and columns, so
5744 * a value of 0 for x and y, means the top left cell of the table, and a
5745 * value of 1 for w and h means @p subobj only takes that 1 cell.
5747 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5749 * @brief Remove child from table.
5751 * @param obj The table object
5752 * @param subobj The subobject
5754 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5756 * @brief Faster way to remove all child objects from a table object.
5758 * @param obj The table object
5759 * @param clear If true, will delete children, else just remove from table.
5761 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
5763 * @brief Set the packing location of an existing child of the table
5765 * @param subobj The subobject to be modified in the table
5766 * @param x Row number
5767 * @param y Column number
5771 * Modifies the position of an object already in the table.
5773 * @note All positioning inside the table is relative to rows and columns, so
5774 * a value of 0 for x and y, means the top left cell of the table, and a
5775 * value of 1 for w and h means @p subobj only takes that 1 cell.
5777 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
5779 * @brief Get the packing location of an existing child of the table
5781 * @param subobj The subobject to be modified in the table
5782 * @param x Row number
5783 * @param y Column number
5787 * @see elm_table_pack_set()
5789 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
5795 * @defgroup Gengrid Gengrid (Generic grid)
5797 * This widget aims to position objects in a grid layout while
5798 * actually creating and rendering only the visible ones, using the
5799 * same idea as the @ref Genlist "genlist": the user defines a @b
5800 * class for each item, specifying functions that will be called at
5801 * object creation, deletion, etc. When those items are selected by
5802 * the user, a callback function is issued. Users may interact with
5803 * a gengrid via the mouse (by clicking on items to select them and
5804 * clicking on the grid's viewport and swiping to pan the whole
5805 * view) or via the keyboard, navigating through item with the
5808 * @section Gengrid_Layouts Gengrid layouts
5810 * Gengrids may layout its items in one of two possible layouts:
5814 * When in "horizontal mode", items will be placed in @b columns,
5815 * from top to bottom and, when the space for a column is filled,
5816 * another one is started on the right, thus expanding the grid
5817 * horizontally, making for horizontal scrolling. When in "vertical
5818 * mode" , though, items will be placed in @b rows, from left to
5819 * right and, when the space for a row is filled, another one is
5820 * started below, thus expanding the grid vertically (and making
5821 * for vertical scrolling).
5823 * @section Gengrid_Items Gengrid items
5825 * An item in a gengrid can have 0 or more text labels (they can be
5826 * regular text or textblock Evas objects - that's up to the style
5827 * to determine), 0 or more icons (which are simply objects
5828 * swallowed into the gengrid item's theming Edje object) and 0 or
5829 * more <b>boolean states</b>, which have the behavior left to the
5830 * user to define. The Edje part names for each of these properties
5831 * will be looked up, in the theme file for the gengrid, under the
5832 * Edje (string) data items named @c "labels", @c "icons" and @c
5833 * "states", respectively. For each of those properties, if more
5834 * than one part is provided, they must have names listed separated
5835 * by spaces in the data fields. For the default gengrid item
5836 * theme, we have @b one label part (@c "elm.text"), @b two icon
5837 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
5840 * A gengrid item may be at one of several styles. Elementary
5841 * provides one by default - "default", but this can be extended by
5842 * system or application custom themes/overlays/extensions (see
5843 * @ref Theme "themes" for more details).
5845 * @section Gengrid_Item_Class Gengrid item classes
5847 * In order to have the ability to add and delete items on the fly,
5848 * gengrid implements a class (callback) system where the
5849 * application provides a structure with information about that
5850 * type of item (gengrid may contain multiple different items with
5851 * different classes, states and styles). Gengrid will call the
5852 * functions in this struct (methods) when an item is "realized"
5853 * (i.e., created dynamically, while the user is scrolling the
5854 * grid). All objects will simply be deleted when no longer needed
5855 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
5856 * contains the following members:
5857 * - @c item_style - This is a constant string and simply defines
5858 * the name of the item style. It @b must be specified and the
5859 * default should be @c "default".
5860 * - @c func.label_get - This function is called when an item
5861 * object is actually created. The @c data parameter will point to
5862 * the same data passed to elm_gengrid_item_append() and related
5863 * item creation functions. The @c obj parameter is the gengrid
5864 * object itself, while the @c part one is the name string of one
5865 * of the existing text parts in the Edje group implementing the
5866 * item's theme. This function @b must return a strdup'()ed string,
5867 * as the caller will free() it when done. See
5868 * #Elm_Gengrid_Item_Label_Get_Cb.
5869 * - @c func.icon_get - This function is called when an item object
5870 * is actually created. The @c data parameter will point to the
5871 * same data passed to elm_gengrid_item_append() and related item
5872 * creation functions. The @c obj parameter is the gengrid object
5873 * itself, while the @c part one is the name string of one of the
5874 * existing (icon) swallow parts in the Edje group implementing the
5875 * item's theme. It must return @c NULL, when no icon is desired,
5876 * or a valid object handle, otherwise. The object will be deleted
5877 * by the gengrid on its deletion or when the item is "unrealized".
5878 * See #Elm_Gengrid_Item_Icon_Get_Cb.
5879 * - @c func.state_get - This function is called when an item
5880 * object is actually created. The @c data parameter will point to
5881 * the same data passed to elm_gengrid_item_append() and related
5882 * item creation functions. The @c obj parameter is the gengrid
5883 * object itself, while the @c part one is the name string of one
5884 * of the state parts in the Edje group implementing the item's
5885 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
5886 * true/on. Gengrids will emit a signal to its theming Edje object
5887 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
5888 * "source" arguments, respectively, when the state is true (the
5889 * default is false), where @c XXX is the name of the (state) part.
5890 * See #Elm_Gengrid_Item_State_Get_Cb.
5891 * - @c func.del - This is called when elm_gengrid_item_del() is
5892 * called on an item or elm_gengrid_clear() is called on the
5893 * gengrid. This is intended for use when gengrid items are
5894 * deleted, so any data attached to the item (e.g. its data
5895 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
5897 * @section Gengrid_Usage_Hints Usage hints
5899 * If the user wants to have multiple items selected at the same
5900 * time, elm_gengrid_multi_select_set() will permit it. If the
5901 * gengrid is single-selection only (the default), then
5902 * elm_gengrid_select_item_get() will return the selected item or
5903 * @c NULL, if none is selected. If the gengrid is under
5904 * multi-selection, then elm_gengrid_selected_items_get() will
5905 * return a list (that is only valid as long as no items are
5906 * modified (added, deleted, selected or unselected) of child items
5909 * If an item changes (internal (boolean) state, label or icon
5910 * changes), then use elm_gengrid_item_update() to have gengrid
5911 * update the item with the new state. A gengrid will re-"realize"
5912 * the item, thus calling the functions in the
5913 * #Elm_Gengrid_Item_Class set for that item.
5915 * To programmatically (un)select an item, use
5916 * elm_gengrid_item_selected_set(). To get its selected state use
5917 * elm_gengrid_item_selected_get(). To make an item disabled
5918 * (unable to be selected and appear differently) use
5919 * elm_gengrid_item_disabled_set() to set this and
5920 * elm_gengrid_item_disabled_get() to get the disabled state.
5922 * Grid cells will only have their selection smart callbacks called
5923 * when firstly getting selected. Any further clicks will do
5924 * nothing, unless you enable the "always select mode", with
5925 * elm_gengrid_always_select_mode_set(), thus making every click to
5926 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
5927 * turn off the ability to select items entirely in the widget and
5928 * they will neither appear selected nor call the selection smart
5931 * Remember that you can create new styles and add your own theme
5932 * augmentation per application with elm_theme_extension_add(). If
5933 * you absolutely must have a specific style that overrides any
5934 * theme the user or system sets up you can use
5935 * elm_theme_overlay_add() to add such a file.
5937 * @section Gengrid_Smart_Events Gengrid smart events
5939 * Smart events that you can add callbacks for are:
5940 * - @c "activated" - The user has double-clicked or pressed
5941 * (enter|return|spacebar) on an item. The @c event_info parameter
5942 * is the gengrid item that was activated.
5943 * - @c "clicked,double" - The user has double-clicked an item.
5944 * The @c event_info parameter is the gengrid item that was double-clicked.
5945 * - @c "selected" - The user has made an item selected. The
5946 * @c event_info parameter is the gengrid item that was selected.
5947 * - @c "unselected" - The user has made an item unselected. The
5948 * @c event_info parameter is the gengrid item that was unselected.
5949 * - @c "realized" - This is called when the item in the gengrid
5950 * has its implementing Evas object instantiated, de facto. @c
5951 * event_info is the gengrid item that was created. The object
5952 * may be deleted at any time, so it is highly advised to the
5953 * caller @b not to use the object pointer returned from
5954 * elm_gengrid_item_object_get(), because it may point to freed
5956 * - @c "unrealized" - This is called when the implementing Evas
5957 * object for this item is deleted. @c event_info is the gengrid
5958 * item that was deleted.
5959 * - @c "changed" - Called when an item is added, removed, resized
5960 * or moved and when the gengrid is resized or gets "horizontal"
5962 * - @c "drag,start,up" - Called when the item in the gengrid has
5963 * been dragged (not scrolled) up.
5964 * - @c "drag,start,down" - Called when the item in the gengrid has
5965 * been dragged (not scrolled) down.
5966 * - @c "drag,start,left" - Called when the item in the gengrid has
5967 * been dragged (not scrolled) left.
5968 * - @c "drag,start,right" - Called when the item in the gengrid has
5969 * been dragged (not scrolled) right.
5970 * - @c "drag,stop" - Called when the item in the gengrid has
5971 * stopped being dragged.
5972 * - @c "drag" - Called when the item in the gengrid is being
5974 * - @c "scroll" - called when the content has been scrolled
5976 * - @c "scroll,drag,start" - called when dragging the content has
5978 * - @c "scroll,drag,stop" - called when dragging the content has
5981 * List of gendrid examples:
5982 * @li @ref gengrid_example
5986 * @addtogroup Gengrid
5990 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
5991 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
5992 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
5993 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
5994 typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
5995 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
5996 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
5998 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
5999 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
6000 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
6001 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
6004 * @struct _Elm_Gengrid_Item_Class
6006 * Gengrid item class definition. See @ref Gengrid_Item_Class for
6009 struct _Elm_Gengrid_Item_Class
6011 const char *item_style;
6012 struct _Elm_Gengrid_Item_Class_Func
6014 Elm_Gengrid_Item_Label_Get_Cb label_get;
6015 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
6016 Elm_Gengrid_Item_State_Get_Cb state_get;
6017 Elm_Gengrid_Item_Del_Cb del;
6019 }; /**< #Elm_Gengrid_Item_Class member definitions */
6022 * Add a new gengrid widget to the given parent Elementary
6023 * (container) object
6025 * @param parent The parent object
6026 * @return a new gengrid widget handle or @c NULL, on errors
6028 * This function inserts a new gengrid widget on the canvas.
6030 * @see elm_gengrid_item_size_set()
6031 * @see elm_gengrid_horizontal_set()
6032 * @see elm_gengrid_item_append()
6033 * @see elm_gengrid_item_del()
6034 * @see elm_gengrid_clear()
6038 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6041 * Set the size for the items of a given gengrid widget
6043 * @param obj The gengrid object.
6044 * @param w The items' width.
6045 * @param h The items' height;
6047 * A gengrid, after creation, has still no information on the size
6048 * to give to each of its cells. So, you most probably will end up
6049 * with squares one @ref Fingers "finger" wide, the default
6050 * size. Use this function to force a custom size for you items,
6051 * making them as big as you wish.
6053 * @see elm_gengrid_item_size_get()
6057 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
6060 * Get the size set for the items of a given gengrid widget
6062 * @param obj The gengrid object.
6063 * @param w Pointer to a variable where to store the items' width.
6064 * @param h Pointer to a variable where to store the items' height.
6066 * @note Use @c NULL pointers on the size values you're not
6067 * interested in: they'll be ignored by the function.
6069 * @see elm_gengrid_item_size_get() for more details
6073 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6076 * Set the items grid's alignment within a given gengrid widget
6078 * @param obj The gengrid object.
6079 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
6080 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
6082 * This sets the alignment of the whole grid of items of a gengrid
6083 * within its given viewport. By default, those values are both
6084 * 0.5, meaning that the gengrid will have its items grid placed
6085 * exactly in the middle of its viewport.
6087 * @note If given alignment values are out of the cited ranges,
6088 * they'll be changed to the nearest boundary values on the valid
6091 * @see elm_gengrid_align_get()
6095 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
6098 * Get the items grid's alignment values within a given gengrid
6101 * @param obj The gengrid object.
6102 * @param align_x Pointer to a variable where to store the
6103 * horizontal alignment.
6104 * @param align_y Pointer to a variable where to store the vertical
6107 * @note Use @c NULL pointers on the alignment values you're not
6108 * interested in: they'll be ignored by the function.
6110 * @see elm_gengrid_align_set() for more details
6114 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
6117 * Set whether a given gengrid widget is or not able have items
6120 * @param obj The gengrid object
6121 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
6122 * @c EINA_FALSE to turn it off
6124 * If a gengrid is set to allow reordering, a click held for more
6125 * than 0.5 over a given item will highlight it specially,
6126 * signalling the gengrid has entered the reordering state. From
6127 * that time on, the user will be able to, while still holding the
6128 * mouse button down, move the item freely in the gengrid's
6129 * viewport, replacing to said item to the locations it goes to.
6130 * The replacements will be animated and, whenever the user
6131 * releases the mouse button, the item being replaced gets a new
6132 * definitive place in the grid.
6134 * @see elm_gengrid_reorder_mode_get()
6138 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6141 * Get whether a given gengrid widget is or not able have items
6144 * @param obj The gengrid object
6145 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
6148 * @see elm_gengrid_reorder_mode_set() for more details
6152 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6155 * Append a new item in a given gengrid widget.
6157 * @param obj The gengrid object.
6158 * @param gic The item class for the item.
6159 * @param data The item data.
6160 * @param func Convenience function called when the item is
6162 * @param func_data Data to be passed to @p func.
6163 * @return A handle to the item added or @c NULL, on errors.
6165 * This adds an item to the beginning of the gengrid.
6167 * @see elm_gengrid_item_prepend()
6168 * @see elm_gengrid_item_insert_before()
6169 * @see elm_gengrid_item_insert_after()
6170 * @see elm_gengrid_item_del()
6174 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);
6177 * Prepend a new item in a given gengrid widget.
6179 * @param obj The gengrid object.
6180 * @param gic The item class for the item.
6181 * @param data The item data.
6182 * @param func Convenience function called when the item is
6184 * @param func_data Data to be passed to @p func.
6185 * @return A handle to the item added or @c NULL, on errors.
6187 * This adds an item to the end of the gengrid.
6189 * @see elm_gengrid_item_append()
6190 * @see elm_gengrid_item_insert_before()
6191 * @see elm_gengrid_item_insert_after()
6192 * @see elm_gengrid_item_del()
6196 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);
6199 * Insert an item before another in a gengrid widget
6201 * @param obj The gengrid object.
6202 * @param gic The item class for the item.
6203 * @param data The item data.
6204 * @param relative The item to place this new one before.
6205 * @param func Convenience function called when the item is
6207 * @param func_data Data to be passed to @p func.
6208 * @return A handle to the item added or @c NULL, on errors.
6210 * This inserts an item before another in the gengrid.
6212 * @see elm_gengrid_item_append()
6213 * @see elm_gengrid_item_prepend()
6214 * @see elm_gengrid_item_insert_after()
6215 * @see elm_gengrid_item_del()
6219 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);
6222 * Insert an item after another in a gengrid widget
6224 * @param obj The gengrid object.
6225 * @param gic The item class for the item.
6226 * @param data The item data.
6227 * @param relative The item to place this new one after.
6228 * @param func Convenience function called when the item is
6230 * @param func_data Data to be passed to @p func.
6231 * @return A handle to the item added or @c NULL, on errors.
6233 * This inserts an item after another in the gengrid.
6235 * @see elm_gengrid_item_append()
6236 * @see elm_gengrid_item_prepend()
6237 * @see elm_gengrid_item_insert_after()
6238 * @see elm_gengrid_item_del()
6242 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);
6244 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);
6246 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);
6249 * Set whether items on a given gengrid widget are to get their
6250 * selection callbacks issued for @b every subsequent selection
6251 * click on them or just for the first click.
6253 * @param obj The gengrid object
6254 * @param always_select @c EINA_TRUE to make items "always
6255 * selected", @c EINA_FALSE, otherwise
6257 * By default, grid items will only call their selection callback
6258 * function when firstly getting selected, any subsequent further
6259 * clicks will do nothing. With this call, you make those
6260 * subsequent clicks also to issue the selection callbacks.
6262 * @note <b>Double clicks</b> will @b always be reported on items.
6264 * @see elm_gengrid_always_select_mode_get()
6268 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6271 * Get whether items on a given gengrid widget have their selection
6272 * callbacks issued for @b every subsequent selection click on them
6273 * or just for the first click.
6275 * @param obj The gengrid object.
6276 * @return @c EINA_TRUE if the gengrid items are "always selected",
6277 * @c EINA_FALSE, otherwise
6279 * @see elm_gengrid_always_select_mode_set() for more details
6283 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6286 * Set whether items on a given gengrid widget can be selected or not.
6288 * @param obj The gengrid object
6289 * @param no_select @c EINA_TRUE to make items selectable,
6290 * @c EINA_FALSE otherwise
6292 * This will make items in @p obj selectable or not. In the latter
6293 * case, any user interacion on the gendrid items will neither make
6294 * them appear selected nor them call their selection callback
6297 * @see elm_gengrid_no_select_mode_get()
6301 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6304 * Get whether items on a given gengrid widget can be selected or
6307 * @param obj The gengrid object
6308 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
6311 * @see elm_gengrid_no_select_mode_set() for more details
6315 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6318 * Enable or disable multi-selection in a given gengrid widget
6320 * @param obj The gengrid object.
6321 * @param multi @c EINA_TRUE, to enable multi-selection,
6322 * @c EINA_FALSE to disable it.
6324 * Multi-selection is the ability for one to have @b more than one
6325 * item selected, on a given gengrid, simultaneously. When it is
6326 * enabled, a sequence of clicks on different items will make them
6327 * all selected, progressively. A click on an already selected item
6328 * will unselect it. If interecting via the keyboard,
6329 * multi-selection is enabled while holding the "Shift" key.
6331 * @note By default, multi-selection is @b disabled on gengrids
6333 * @see elm_gengrid_multi_select_get()
6337 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6340 * Get whether multi-selection is enabled or disabled for a given
6343 * @param obj The gengrid object.
6344 * @return @c EINA_TRUE, if multi-selection is enabled, @c
6345 * EINA_FALSE otherwise
6347 * @see elm_gengrid_multi_select_set() for more details
6351 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6354 * Enable or disable bouncing effect for a given gengrid widget
6356 * @param obj The gengrid object
6357 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
6358 * @c EINA_FALSE to disable it
6359 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
6360 * @c EINA_FALSE to disable it
6362 * The bouncing effect occurs whenever one reaches the gengrid's
6363 * edge's while panning it -- it will scroll past its limits a
6364 * little bit and return to the edge again, in a animated for,
6367 * @note By default, gengrids have bouncing enabled on both axis
6369 * @see elm_gengrid_bounce_get()
6373 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6376 * Get whether bouncing effects are enabled or disabled, for a
6377 * given gengrid widget, on each axis
6379 * @param obj The gengrid object
6380 * @param h_bounce Pointer to a variable where to store the
6381 * horizontal bouncing flag.
6382 * @param v_bounce Pointer to a variable where to store the
6383 * vertical bouncing flag.
6385 * @see elm_gengrid_bounce_set() for more details
6389 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6392 * Set a given gengrid widget's scrolling page size, relative to
6393 * its viewport size.
6395 * @param obj The gengrid object
6396 * @param h_pagerel The horizontal page (relative) size
6397 * @param v_pagerel The vertical page (relative) size
6399 * The gengrid's scroller is capable of binding scrolling by the
6400 * user to "pages". It means that, while scrolling and, specially
6401 * after releasing the mouse button, the grid will @b snap to the
6402 * nearest displaying page's area. When page sizes are set, the
6403 * grid's continuous content area is split into (equal) page sized
6406 * This function sets the size of a page <b>relatively to the
6407 * viewport dimensions</b> of the gengrid, for each axis. A value
6408 * @c 1.0 means "the exact viewport's size", in that axis, while @c
6409 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
6410 * a viewport". Sane usable values are, than, between @c 0.0 and @c
6411 * 1.0. Values beyond those will make it behave behave
6412 * inconsistently. If you only want one axis to snap to pages, use
6413 * the value @c 0.0 for the other one.
6415 * There is a function setting page size values in @b absolute
6416 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
6417 * is mutually exclusive to this one.
6419 * @see elm_gengrid_page_relative_get()
6423 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6426 * Get a given gengrid widget's scrolling page size, relative to
6427 * its viewport size.
6429 * @param obj The gengrid object
6430 * @param h_pagerel Pointer to a variable where to store the
6431 * horizontal page (relative) size
6432 * @param v_pagerel Pointer to a variable where to store the
6433 * vertical page (relative) size
6435 * @see elm_gengrid_page_relative_set() for more details
6439 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
6442 * Set a given gengrid widget's scrolling page size
6444 * @param obj The gengrid object
6445 * @param h_pagerel The horizontal page size, in pixels
6446 * @param v_pagerel The vertical page size, in pixels
6448 * The gengrid's scroller is capable of binding scrolling by the
6449 * user to "pages". It means that, while scrolling and, specially
6450 * after releasing the mouse button, the grid will @b snap to the
6451 * nearest displaying page's area. When page sizes are set, the
6452 * grid's continuous content area is split into (equal) page sized
6455 * This function sets the size of a page of the gengrid, in pixels,
6456 * for each axis. Sane usable values are, between @c 0 and the
6457 * dimensions of @p obj, for each axis. Values beyond those will
6458 * make it behave behave inconsistently. If you only want one axis
6459 * to snap to pages, use the value @c 0 for the other one.
6461 * There is a function setting page size values in @b relative
6462 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
6463 * use is mutually exclusive to this one.
6467 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6470 * Set for what direction a given gengrid widget will expand while
6471 * placing its items.
6473 * @param obj The gengrid object.
6474 * @param setting @c EINA_TRUE to make the gengrid expand
6475 * horizontally, @c EINA_FALSE to expand vertically.
6477 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
6478 * in @b columns, from top to bottom and, when the space for a
6479 * column is filled, another one is started on the right, thus
6480 * expanding the grid horizontally. When in "vertical mode"
6481 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
6482 * to right and, when the space for a row is filled, another one is
6483 * started below, thus expanding the grid vertically.
6485 * @see elm_gengrid_horizontal_get()
6489 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6492 * Get for what direction a given gengrid widget will expand while
6493 * placing its items.
6495 * @param obj The gengrid object.
6496 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
6497 * @c EINA_FALSE if it's set to expand vertically.
6499 * @see elm_gengrid_horizontal_set() for more detais
6503 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6506 * Get the first item in a given gengrid widget
6508 * @param obj The gengrid object
6509 * @return The first item's handle or @c NULL, if there are no
6510 * items in @p obj (and on errors)
6512 * This returns the first item in the @p obj's internal list of
6515 * @see elm_gengrid_last_item_get()
6519 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6522 * Get the last item in a given gengrid widget
6524 * @param obj The gengrid object
6525 * @return The last item's handle or @c NULL, if there are no
6526 * items in @p obj (and on errors)
6528 * This returns the last item in the @p obj's internal list of
6531 * @see elm_gengrid_first_item_get()
6535 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6538 * Get the @b next item in a gengrid widget's internal list of items,
6539 * given a handle to one of those items.
6541 * @param item The gengrid item to fetch next from
6542 * @return The item after @p item, or @c NULL if there's none (and
6545 * This returns the item placed after the @p item, on the container
6548 * @see elm_gengrid_item_prev_get()
6552 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6555 * Get the @b previous item in a gengrid widget's internal list of items,
6556 * given a handle to one of those items.
6558 * @param item The gengrid item to fetch previous from
6559 * @return The item before @p item, or @c NULL if there's none (and
6562 * This returns the item placed before the @p item, on the container
6565 * @see elm_gengrid_item_next_get()
6569 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6572 * Get the gengrid object's handle which contains a given gengrid
6575 * @param item The item to fetch the container from
6576 * @return The gengrid (parent) object
6578 * This returns the gengrid object itself that an item belongs to.
6582 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6585 * Remove a gengrid item from the its parent, deleting it.
6587 * @param item The item to be removed.
6588 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
6590 * @see elm_gengrid_clear(), to remove all items in a gengrid at
6595 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6598 * Update the contents of a given gengrid item
6600 * @param item The gengrid item
6602 * This updates an item by calling all the item class functions
6603 * again to get the icons, labels and states. Use this when the
6604 * original item data has changed and you want thta changes to be
6609 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6610 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6611 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
6614 * Return the data associated to a given gengrid item
6616 * @param item The gengrid item.
6617 * @return the data associated to this item.
6619 * This returns the @c data value passed on the
6620 * elm_gengrid_item_append() and related item addition calls.
6622 * @see elm_gengrid_item_append()
6623 * @see elm_gengrid_item_data_set()
6627 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6630 * Set the data associated to a given gengrid item
6632 * @param item The gengrid item
6633 * @param data The new data pointer to set on it
6635 * This @b overrides the @c data value passed on the
6636 * elm_gengrid_item_append() and related item addition calls. This
6637 * function @b won't call elm_gengrid_item_update() automatically,
6638 * so you'd issue it afterwards if you want to hove the item
6639 * updated to reflect the that new data.
6641 * @see elm_gengrid_item_data_get()
6645 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
6648 * Get a given gengrid item's position, relative to the whole
6649 * gengrid's grid area.
6651 * @param item The Gengrid item.
6652 * @param x Pointer to variable where to store the item's <b>row
6654 * @param y Pointer to variable where to store the item's <b>column
6657 * This returns the "logical" position of the item whithin the
6658 * gengrid. For example, @c (0, 1) would stand for first row,
6663 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
6666 * Set whether a given gengrid item is selected or not
6668 * @param item The gengrid item
6669 * @param selected Use @c EINA_TRUE, to make it selected, @c
6670 * EINA_FALSE to make it unselected
6672 * This sets the selected state of an item. If multi selection is
6673 * not enabled on the containing gengrid and @p selected is @c
6674 * EINA_TRUE, any other previously selected items will get
6675 * unselected in favor of this new one.
6677 * @see elm_gengrid_item_selected_get()
6681 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6684 * Get whether a given gengrid item is selected or not
6686 * @param item The gengrid item
6687 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6689 * @see elm_gengrid_item_selected_set() for more details
6693 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6696 * Get the real Evas object created to implement the view of a
6697 * given gengrid item
6699 * @param item The gengrid item.
6700 * @return the Evas object implementing this item's view.
6702 * This returns the actual Evas object used to implement the
6703 * specified gengrid item's view. This may be @c NULL, as it may
6704 * not have been created or may have been deleted, at any time, by
6705 * the gengrid. <b>Do not modify this object</b> (move, resize,
6706 * show, hide, etc.), as the gengrid is controlling it. This
6707 * function is for querying, emitting custom signals or hooking
6708 * lower level callbacks for events on that object. Do not delete
6709 * this object under any circumstances.
6711 * @see elm_gengrid_item_data_get()
6715 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6718 * Show the portion of a gengrid's internal grid containing a given
6719 * item, @b immediately.
6721 * @param item The item to display
6723 * This causes gengrid to @b redraw its viewport's contents to the
6724 * region contining the given @p item item, if it is not fully
6727 * @see elm_gengrid_item_bring_in()
6731 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6734 * Animatedly bring in, to the visible are of a gengrid, a given
6737 * @param item The gengrid item to display
6739 * This causes gengrig to jump to the given @p item item and show
6740 * it (by scrolling), if it is not fully visible. This will use
6741 * animation to do so and take a period of time to complete.
6743 * @see elm_gengrid_item_show()
6747 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6750 * Set whether a given gengrid item is disabled or not.
6752 * @param item The gengrid item
6753 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
6754 * to enable it back.
6756 * A disabled item cannot be selected or unselected. It will also
6757 * change its appearance, to signal the user it's disabled.
6759 * @see elm_gengrid_item_disabled_get()
6763 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6766 * Get whether a given gengrid item is disabled or not.
6768 * @param item The gengrid item
6769 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
6772 * @see elm_gengrid_item_disabled_set() for more details
6776 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6779 * Set the text to be shown in a given gengrid item's tooltips.
6781 * @param item The gengrid item
6782 * @param text The text to set in the content
6784 * This call will setup the text to be used as tooltip to that item
6785 * (analogous to elm_object_tooltip_text_set(), but being item
6786 * tooltips with higher precedence than object tooltips). It can
6787 * have only one tooltip at a time, so any previous tooltip data
6792 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
6795 * Set the content to be shown in a given gengrid item's tooltips
6797 * @param item The gengrid item.
6798 * @param func The function returning the tooltip contents.
6799 * @param data What to provide to @a func as callback data/context.
6800 * @param del_cb Called when data is not needed anymore, either when
6801 * another callback replaces @p func, the tooltip is unset with
6802 * elm_gengrid_item_tooltip_unset() or the owner @p item
6803 * dies. This callback receives as its first parameter the
6804 * given @p data, being @c event_info the item handle.
6806 * This call will setup the tooltip's contents to @p item
6807 * (analogous to elm_object_tooltip_content_cb_set(), but being
6808 * item tooltips with higher precedence than object tooltips). It
6809 * can have only one tooltip at a time, so any previous tooltip
6810 * content will get removed. @p func (with @p data) will be called
6811 * every time Elementary needs to show the tooltip and it should
6812 * return a valid Evas object, which will be fully managed by the
6813 * tooltip system, getting deleted when the tooltip is gone.
6817 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);
6820 * Unset a tooltip from a given gengrid item
6822 * @param item gengrid item to remove a previously set tooltip from.
6824 * This call removes any tooltip set on @p item. The callback
6825 * provided as @c del_cb to
6826 * elm_gengrid_item_tooltip_content_cb_set() will be called to
6827 * notify it is not used anymore (and have resources cleaned, if
6830 * @see elm_gengrid_item_tooltip_content_cb_set()
6834 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6837 * Set a different @b style for a given gengrid item's tooltip.
6839 * @param item gengrid item with tooltip set
6840 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
6841 * "default", @c "transparent", etc)
6843 * Tooltips can have <b>alternate styles</b> to be displayed on,
6844 * which are defined by the theme set on Elementary. This function
6845 * works analogously as elm_object_tooltip_style_set(), but here
6846 * applied only to gengrid item objects. The default style for
6847 * tooltips is @c "default".
6849 * @note before you set a style you should define a tooltip with
6850 * elm_gengrid_item_tooltip_content_cb_set() or
6851 * elm_gengrid_item_tooltip_text_set()
6853 * @see elm_gengrid_item_tooltip_style_get()
6857 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6860 * Get the style set a given gengrid item's tooltip.
6862 * @param item gengrid item with tooltip already set on.
6863 * @return style the theme style in use, which defaults to
6864 * "default". If the object does not have a tooltip set,
6865 * then @c NULL is returned.
6867 * @see elm_gengrid_item_tooltip_style_set() for more details
6871 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6873 * @brief Disable size restrictions on an object's tooltip
6874 * @param item The tooltip's anchor object
6875 * @param disable If EINA_TRUE, size restrictions are disabled
6876 * @return EINA_FALSE on failure, EINA_TRUE on success
6878 * This function allows a tooltip to expand beyond its parant window's canvas.
6879 * It will instead be limited only by the size of the display.
6881 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
6883 * @brief Retrieve size restriction state of an object's tooltip
6884 * @param item The tooltip's anchor object
6885 * @return If EINA_TRUE, size restrictions are disabled
6887 * This function returns whether a tooltip is allowed to expand beyond
6888 * its parant window's canvas.
6889 * It will instead be limited only by the size of the display.
6891 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
6893 * Set the type of mouse pointer/cursor decoration to be shown,
6894 * when the mouse pointer is over the given gengrid widget item
6896 * @param item gengrid item to customize cursor on
6897 * @param cursor the cursor type's name
6899 * This function works analogously as elm_object_cursor_set(), but
6900 * here the cursor's changing area is restricted to the item's
6901 * area, and not the whole widget's. Note that that item cursors
6902 * have precedence over widget cursors, so that a mouse over @p
6903 * item will always show cursor @p type.
6905 * If this function is called twice for an object, a previously set
6906 * cursor will be unset on the second call.
6908 * @see elm_object_cursor_set()
6909 * @see elm_gengrid_item_cursor_get()
6910 * @see elm_gengrid_item_cursor_unset()
6914 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6917 * Get the type of mouse pointer/cursor decoration set to be shown,
6918 * when the mouse pointer is over the given gengrid widget item
6920 * @param item gengrid item with custom cursor set
6921 * @return the cursor type's name or @c NULL, if no custom cursors
6922 * were set to @p item (and on errors)
6924 * @see elm_object_cursor_get()
6925 * @see elm_gengrid_item_cursor_set() for more details
6926 * @see elm_gengrid_item_cursor_unset()
6930 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6933 * Unset any custom mouse pointer/cursor decoration set to be
6934 * shown, when the mouse pointer is over the given gengrid widget
6935 * item, thus making it show the @b default cursor again.
6937 * @param item a gengrid item
6939 * Use this call to undo any custom settings on this item's cursor
6940 * decoration, bringing it back to defaults (no custom style set).
6942 * @see elm_object_cursor_unset()
6943 * @see elm_gengrid_item_cursor_set() for more details
6947 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6950 * Set a different @b style for a given custom cursor set for a
6953 * @param item gengrid item with custom cursor set
6954 * @param style the <b>theme style</b> to use (e.g. @c "default",
6955 * @c "transparent", etc)
6957 * This function only makes sense when one is using custom mouse
6958 * cursor decorations <b>defined in a theme file</b> , which can
6959 * have, given a cursor name/type, <b>alternate styles</b> on
6960 * it. It works analogously as elm_object_cursor_style_set(), but
6961 * here applied only to gengrid item objects.
6963 * @warning Before you set a cursor style you should have defined a
6964 * custom cursor previously on the item, with
6965 * elm_gengrid_item_cursor_set()
6967 * @see elm_gengrid_item_cursor_engine_only_set()
6968 * @see elm_gengrid_item_cursor_style_get()
6972 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
6975 * Get the current @b style set for a given gengrid item's custom
6978 * @param item gengrid item with custom cursor set.
6979 * @return style the cursor style in use. If the object does not
6980 * have a cursor set, then @c NULL is returned.
6982 * @see elm_gengrid_item_cursor_style_set() for more details
6986 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
6989 * Set if the (custom) cursor for a given gengrid item should be
6990 * searched in its theme, also, or should only rely on the
6993 * @param item item with custom (custom) cursor already set on
6994 * @param engine_only Use @c EINA_TRUE to have cursors looked for
6995 * only on those provided by the rendering engine, @c EINA_FALSE to
6996 * have them searched on the widget's theme, as well.
6998 * @note This call is of use only if you've set a custom cursor
6999 * for gengrid items, with elm_gengrid_item_cursor_set().
7001 * @note By default, cursors will only be looked for between those
7002 * provided by the rendering engine.
7006 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7009 * Get if the (custom) cursor for a given gengrid item is being
7010 * searched in its theme, also, or is only relying on the rendering
7013 * @param item a gengrid item
7014 * @return @c EINA_TRUE, if cursors are being looked for only on
7015 * those provided by the rendering engine, @c EINA_FALSE if they
7016 * are being searched on the widget's theme, as well.
7018 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
7022 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
7025 * Remove all items from a given gengrid widget
7027 * @param obj The gengrid object.
7029 * This removes (and deletes) all items in @p obj, leaving it
7032 * @see elm_gengrid_item_del(), to remove just one item.
7036 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7039 * Get the selected item in a given gengrid widget
7041 * @param obj The gengrid object.
7042 * @return The selected item's handleor @c NULL, if none is
7043 * selected at the moment (and on errors)
7045 * This returns the selected item in @p obj. If multi selection is
7046 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
7047 * the first item in the list is selected, which might not be very
7048 * useful. For that case, see elm_gengrid_selected_items_get().
7052 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7055 * Get <b>a list</b> of selected items in a given gengrid
7057 * @param obj The gengrid object.
7058 * @return The list of selected items or @c NULL, if none is
7059 * selected at the moment (and on errors)
7061 * This returns a list of the selected items, in the order that
7062 * they appear in the grid. This list is only valid as long as no
7063 * more items are selected or unselected (or unselected implictly
7064 * by deletion). The list contains #Elm_Gengrid_Item pointers as
7067 * @see elm_gengrid_selected_item_get()
7071 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7078 * @defgroup Clock Clock
7080 * @image html img/widget/clock/preview-00.png
7081 * @image latex img/widget/clock/preview-00.eps
7083 * This is a @b digital clock widget. In its default theme, it has a
7084 * vintage "flipping numbers clock" appearance, which will animate
7085 * sheets of individual algarisms individually as time goes by.
7087 * A newly created clock will fetch system's time (already
7088 * considering local time adjustments) to start with, and will tick
7089 * accondingly. It may or may not show seconds.
7091 * Clocks have an @b edition mode. When in it, the sheets will
7092 * display extra arrow indications on the top and bottom and the
7093 * user may click on them to raise or lower the time values. After
7094 * it's told to exit edition mode, it will keep ticking with that
7095 * new time set (it keeps the difference from local time).
7097 * Also, when under edition mode, user clicks on the cited arrows
7098 * which are @b held for some time will make the clock to flip the
7099 * sheet, thus editing the time, continuosly and automatically for
7100 * the user. The interval between sheet flips will keep growing in
7101 * time, so that it helps the user to reach a time which is distant
7104 * The time display is, by default, in military mode (24h), but an
7105 * am/pm indicator may be optionally shown, too, when it will
7108 * Smart callbacks one can register to:
7109 * - "changed" - the clock's user changed the time
7111 * Here is an example on its usage:
7112 * @li @ref clock_example
7121 * Identifiers for which clock digits should be editable, when a
7122 * clock widget is in edition mode. Values may be ORed together to
7123 * make a mask, naturally.
7125 * @see elm_clock_edit_set()
7126 * @see elm_clock_digit_edit_set()
7128 typedef enum _Elm_Clock_Digedit
7130 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
7131 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
7132 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
7133 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
7134 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
7135 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
7136 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
7137 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
7138 } Elm_Clock_Digedit;
7141 * Add a new clock widget to the given parent Elementary
7142 * (container) object
7144 * @param parent The parent object
7145 * @return a new clock widget handle or @c NULL, on errors
7147 * This function inserts a new clock widget on the canvas.
7151 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7154 * Set a clock widget's time, programmatically
7156 * @param obj The clock widget object
7157 * @param hrs The hours to set
7158 * @param min The minutes to set
7159 * @param sec The secondes to set
7161 * This function updates the time that is showed by the clock
7164 * Values @b must be set within the following ranges:
7165 * - 0 - 23, for hours
7166 * - 0 - 59, for minutes
7167 * - 0 - 59, for seconds,
7169 * even if the clock is not in "military" mode.
7171 * @warning The behavior for values set out of those ranges is @b
7176 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
7179 * Get a clock widget's time values
7181 * @param obj The clock object
7182 * @param[out] hrs Pointer to the variable to get the hours value
7183 * @param[out] min Pointer to the variable to get the minutes value
7184 * @param[out] sec Pointer to the variable to get the seconds value
7186 * This function gets the time set for @p obj, returning
7187 * it on the variables passed as the arguments to function
7189 * @note Use @c NULL pointers on the time values you're not
7190 * interested in: they'll be ignored by the function.
7194 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
7197 * Set whether a given clock widget is under <b>edition mode</b> or
7198 * under (default) displaying-only mode.
7200 * @param obj The clock object
7201 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
7202 * put it back to "displaying only" mode
7204 * This function makes a clock's time to be editable or not <b>by
7205 * user interaction</b>. When in edition mode, clocks @b stop
7206 * ticking, until one brings them back to canonical mode. The
7207 * elm_clock_digit_edit_set() function will influence which digits
7208 * of the clock will be editable. By default, all of them will be
7209 * (#ELM_CLOCK_NONE).
7211 * @note am/pm sheets, if being shown, will @b always be editable
7212 * under edition mode.
7214 * @see elm_clock_edit_get()
7218 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
7221 * Retrieve whether a given clock widget is under <b>edition
7222 * mode</b> or under (default) displaying-only mode.
7224 * @param obj The clock object
7225 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
7228 * This function retrieves whether the clock's time can be edited
7229 * or not by user interaction.
7231 * @see elm_clock_edit_set() for more details
7235 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7238 * Set what digits of the given clock widget should be editable
7239 * when in edition mode.
7241 * @param obj The clock object
7242 * @param digedit Bit mask indicating the digits to be editable
7243 * (values in #Elm_Clock_Digedit).
7245 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
7246 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
7249 * @see elm_clock_digit_edit_get()
7253 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
7256 * Retrieve what digits of the given clock widget should be
7257 * editable when in edition mode.
7259 * @param obj The clock object
7260 * @return Bit mask indicating the digits to be editable
7261 * (values in #Elm_Clock_Digedit).
7263 * @see elm_clock_digit_edit_set() for more details
7267 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7270 * Set if the given clock widget must show hours in military or
7273 * @param obj The clock object
7274 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
7277 * This function sets if the clock must show hours in military or
7278 * am/pm mode. In some countries like Brazil the military mode
7279 * (00-24h-format) is used, in opposition to the USA, where the
7280 * am/pm mode is more commonly used.
7282 * @see elm_clock_show_am_pm_get()
7286 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
7289 * Get if the given clock widget shows hours in military or am/pm
7292 * @param obj The clock object
7293 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
7296 * This function gets if the clock shows hours in military or am/pm
7299 * @see elm_clock_show_am_pm_set() for more details
7303 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7306 * Set if the given clock widget must show time with seconds or not
7308 * @param obj The clock object
7309 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
7311 * This function sets if the given clock must show or not elapsed
7312 * seconds. By default, they are @b not shown.
7314 * @see elm_clock_show_seconds_get()
7318 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
7321 * Get whether the given clock widget is showing time with seconds
7324 * @param obj The clock object
7325 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
7327 * This function gets whether @p obj is showing or not the elapsed
7330 * @see elm_clock_show_seconds_set()
7334 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7337 * Set the interval on time updates for an user mouse button hold
7338 * on clock widgets' time edition.
7340 * @param obj The clock object
7341 * @param interval The (first) interval value in seconds
7343 * This interval value is @b decreased while the user holds the
7344 * mouse pointer either incrementing or decrementing a given the
7345 * clock digit's value.
7347 * This helps the user to get to a given time distant from the
7348 * current one easier/faster, as it will start to flip quicker and
7349 * quicker on mouse button holds.
7351 * The calculation for the next flip interval value, starting from
7352 * the one set with this call, is the previous interval divided by
7353 * 1.05, so it decreases a little bit.
7355 * The default starting interval value for automatic flips is
7358 * @see elm_clock_interval_get()
7362 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7365 * Get the interval on time updates for an user mouse button hold
7366 * on clock widgets' time edition.
7368 * @param obj The clock object
7369 * @return The (first) interval value, in seconds, set on it
7371 * @see elm_clock_interval_set() for more details
7375 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7382 * @defgroup Layout Layout
7384 * @image html img/widget/layout/preview-00.png
7385 * @image latex img/widget/layout/preview-00.eps width=\textwidth
7387 * @image html img/layout-predefined.png
7388 * @image latex img/layout-predefined.eps width=\textwidth
7390 * This is a container widget that takes a standard Edje design file and
7391 * wraps it very thinly in a widget.
7393 * An Edje design (theme) file has a very wide range of possibilities to
7394 * describe the behavior of elements added to the Layout. Check out the Edje
7395 * documentation and the EDC reference to get more information about what can
7396 * be done with Edje.
7398 * Just like @ref List, @ref Box, and other container widgets, any
7399 * object added to the Layout will become its child, meaning that it will be
7400 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
7402 * The Layout widget can contain as many Contents, Boxes or Tables as
7403 * described in its theme file. For instance, objects can be added to
7404 * different Tables by specifying the respective Table part names. The same
7405 * is valid for Content and Box.
7407 * The objects added as child of the Layout will behave as described in the
7408 * part description where they were added. There are 3 possible types of
7409 * parts where a child can be added:
7411 * @section secContent Content (SWALLOW part)
7413 * Only one object can be added to the @c SWALLOW part (but you still can
7414 * have many @c SWALLOW parts and one object on each of them). Use the @c
7415 * elm_layout_content_* set of functions to set, retrieve and unset objects
7416 * as content of the @c SWALLOW. After being set to this part, the object
7417 * size, position, visibility, clipping and other description properties
7418 * will be totally controled by the description of the given part (inside
7419 * the Edje theme file).
7421 * One can use @c evas_object_size_hint_* functions on the child to have some
7422 * kind of control over its behavior, but the resulting behavior will still
7423 * depend heavily on the @c SWALLOW part description.
7425 * The Edje theme also can change the part description, based on signals or
7426 * scripts running inside the theme. This change can also be animated. All of
7427 * this will affect the child object set as content accordingly. The object
7428 * size will be changed if the part size is changed, it will animate move if
7429 * the part is moving, and so on.
7431 * The following picture demonstrates a Layout widget with a child object
7432 * added to its @c SWALLOW:
7434 * @image html layout_swallow.png
7435 * @image latex layout_swallow.eps width=\textwidth
7437 * @section secBox Box (BOX part)
7439 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
7440 * allows one to add objects to the box and have them distributed along its
7441 * area, accordingly to the specified @a layout property (now by @a layout we
7442 * mean the chosen layouting design of the Box, not the Layout widget
7445 * A similar effect for having a box with its position, size and other things
7446 * controled by the Layout theme would be to create an Elementary @ref Box
7447 * widget and add it as a Content in the @c SWALLOW part.
7449 * The main difference of using the Layout Box is that its behavior, the box
7450 * properties like layouting format, padding, align, etc. will be all
7451 * controled by the theme. This means, for example, that a signal could be
7452 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
7453 * handled the signal by changing the box padding, or align, or both. Using
7454 * the Elementary @ref Box widget is not necessarily harder or easier, it
7455 * just depends on the circunstances and requirements.
7457 * The Layout Box can be used through the @c elm_layout_box_* set of
7460 * The following picture demonstrates a Layout widget with many child objects
7461 * added to its @c BOX part:
7463 * @image html layout_box.png
7464 * @image latex layout_box.eps width=\textwidth
7466 * @section secTable Table (TABLE part)
7468 * Just like the @ref secBox, the Layout Table is very similar to the
7469 * Elementary @ref Table widget. It allows one to add objects to the Table
7470 * specifying the row and column where the object should be added, and any
7471 * column or row span if necessary.
7473 * Again, we could have this design by adding a @ref Table widget to the @c
7474 * SWALLOW part using elm_layout_content_set(). The same difference happens
7475 * here when choosing to use the Layout Table (a @c TABLE part) instead of
7476 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
7478 * The Layout Table can be used through the @c elm_layout_table_* set of
7481 * The following picture demonstrates a Layout widget with many child objects
7482 * added to its @c TABLE part:
7484 * @image html layout_table.png
7485 * @image latex layout_table.eps width=\textwidth
7487 * @section secPredef Predefined Layouts
7489 * Another interesting thing about the Layout widget is that it offers some
7490 * predefined themes that come with the default Elementary theme. These
7491 * themes can be set by the call elm_layout_theme_set(), and provide some
7492 * basic functionality depending on the theme used.
7494 * Most of them already send some signals, some already provide a toolbar or
7495 * back and next buttons.
7497 * These are available predefined theme layouts. All of them have class = @c
7498 * layout, group = @c application, and style = one of the following options:
7500 * @li @c toolbar-content - application with toolbar and main content area
7501 * @li @c toolbar-content-back - application with toolbar and main content
7502 * area with a back button and title area
7503 * @li @c toolbar-content-back-next - application with toolbar and main
7504 * content area with a back and next buttons and title area
7505 * @li @c content-back - application with a main content area with a back
7506 * button and title area
7507 * @li @c content-back-next - application with a main content area with a
7508 * back and next buttons and title area
7509 * @li @c toolbar-vbox - application with toolbar and main content area as a
7511 * @li @c toolbar-table - application with toolbar and main content area as a
7514 * @section secExamples Examples
7516 * Some examples of the Layout widget can be found here:
7517 * @li @ref layout_example_01
7518 * @li @ref layout_example_02
7519 * @li @ref layout_example_03
7520 * @li @ref layout_example_edc
7525 * Add a new layout to the parent
7527 * @param parent The parent object
7528 * @return The new object or NULL if it cannot be created
7530 * @see elm_layout_file_set()
7531 * @see elm_layout_theme_set()
7535 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7537 * Set the file that will be used as layout
7539 * @param obj The layout object
7540 * @param file The path to file (edj) that will be used as layout
7541 * @param group The group that the layout belongs in edje file
7543 * @return (1 = success, 0 = error)
7547 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
7549 * Set the edje group from the elementary theme that will be used as layout
7551 * @param obj The layout object
7552 * @param clas the clas of the group
7553 * @param group the group
7554 * @param style the style to used
7556 * @return (1 = success, 0 = error)
7560 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
7562 * Set the layout content.
7564 * @param obj The layout object
7565 * @param swallow The swallow part name in the edje file
7566 * @param content The child that will be added in this layout object
7568 * Once the content object is set, a previously set one will be deleted.
7569 * If you want to keep that old content object, use the
7570 * elm_layout_content_unset() function.
7572 * @note In an Edje theme, the part used as a content container is called @c
7573 * SWALLOW. This is why the parameter name is called @p swallow, but it is
7574 * expected to be a part name just like the second parameter of
7575 * elm_layout_box_append().
7577 * @see elm_layout_box_append()
7578 * @see elm_layout_content_get()
7579 * @see elm_layout_content_unset()
7584 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
7586 * Get the child object in the given content part.
7588 * @param obj The layout object
7589 * @param swallow The SWALLOW part to get its content
7591 * @return The swallowed object or NULL if none or an error occurred
7593 * @see elm_layout_content_set()
7597 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7599 * Unset the layout content.
7601 * @param obj The layout object
7602 * @param swallow The swallow part name in the edje file
7603 * @return The content that was being used
7605 * Unparent and return the content object which was set for this part.
7607 * @see elm_layout_content_set()
7611 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
7613 * Set the text of the given part
7615 * @param obj The layout object
7616 * @param part The TEXT part where to set the text
7617 * @param text The text to set
7620 * @deprecated use elm_object_text_* instead.
7622 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
7624 * Get the text set in the given part
7626 * @param obj The layout object
7627 * @param part The TEXT part to retrieve the text off
7629 * @return The text set in @p part
7632 * @deprecated use elm_object_text_* instead.
7634 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
7636 * Append child to layout box part.
7638 * @param obj the layout object
7639 * @param part the box part to which the object will be appended.
7640 * @param child the child object to append to box.
7642 * Once the object is appended, it will become child of the layout. Its
7643 * lifetime will be bound to the layout, whenever the layout dies the child
7644 * will be deleted automatically. One should use elm_layout_box_remove() to
7645 * make this layout forget about the object.
7647 * @see elm_layout_box_prepend()
7648 * @see elm_layout_box_insert_before()
7649 * @see elm_layout_box_insert_at()
7650 * @see elm_layout_box_remove()
7654 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7656 * Prepend child to layout box part.
7658 * @param obj the layout object
7659 * @param part the box part to prepend.
7660 * @param child the child object to prepend to box.
7662 * Once the object is prepended, it will become child of the layout. Its
7663 * lifetime will be bound to the layout, whenever the layout dies the child
7664 * will be deleted automatically. One should use elm_layout_box_remove() to
7665 * make this layout forget about the object.
7667 * @see elm_layout_box_append()
7668 * @see elm_layout_box_insert_before()
7669 * @see elm_layout_box_insert_at()
7670 * @see elm_layout_box_remove()
7674 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
7676 * Insert child to layout box part before a reference object.
7678 * @param obj the layout object
7679 * @param part the box part to insert.
7680 * @param child the child object to insert into box.
7681 * @param reference another reference object to insert before in box.
7683 * Once the object is inserted, it will become child of the layout. Its
7684 * lifetime will be bound to the layout, whenever the layout dies the child
7685 * will be deleted automatically. One should use elm_layout_box_remove() to
7686 * make this layout forget about the object.
7688 * @see elm_layout_box_append()
7689 * @see elm_layout_box_prepend()
7690 * @see elm_layout_box_insert_before()
7691 * @see elm_layout_box_remove()
7695 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
7697 * Insert child to layout box part at a given position.
7699 * @param obj the layout object
7700 * @param part the box part to insert.
7701 * @param child the child object to insert into box.
7702 * @param pos the numeric position >=0 to insert the child.
7704 * Once the object is inserted, it will become child of the layout. Its
7705 * lifetime will be bound to the layout, whenever the layout dies the child
7706 * will be deleted automatically. One should use elm_layout_box_remove() to
7707 * make this layout forget about the object.
7709 * @see elm_layout_box_append()
7710 * @see elm_layout_box_prepend()
7711 * @see elm_layout_box_insert_before()
7712 * @see elm_layout_box_remove()
7716 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
7718 * Remove a child of the given part box.
7720 * @param obj The layout object
7721 * @param part The box part name to remove child.
7722 * @param child The object to remove from box.
7723 * @return The object that was being used, or NULL if not found.
7725 * The object will be removed from the box part and its lifetime will
7726 * not be handled by the layout anymore. This is equivalent to
7727 * elm_layout_content_unset() for box.
7729 * @see elm_layout_box_append()
7730 * @see elm_layout_box_remove_all()
7734 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
7736 * Remove all child of the given part box.
7738 * @param obj The layout object
7739 * @param part The box part name to remove child.
7740 * @param clear If EINA_TRUE, then all objects will be deleted as
7741 * well, otherwise they will just be removed and will be
7742 * dangling on the canvas.
7744 * The objects will be removed from the box part and their lifetime will
7745 * not be handled by the layout anymore. This is equivalent to
7746 * elm_layout_box_remove() for all box children.
7748 * @see elm_layout_box_append()
7749 * @see elm_layout_box_remove()
7753 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7755 * Insert child to layout table part.
7757 * @param obj the layout object
7758 * @param part the box part to pack child.
7759 * @param child_obj the child object to pack into table.
7760 * @param col the column to which the child should be added. (>= 0)
7761 * @param row the row to which the child should be added. (>= 0)
7762 * @param colspan how many columns should be used to store this object. (>=
7764 * @param rowspan how many rows should be used to store this object. (>= 1)
7766 * Once the object is inserted, it will become child of the table. Its
7767 * lifetime will be bound to the layout, and whenever the layout dies the
7768 * child will be deleted automatically. One should use
7769 * elm_layout_table_remove() to make this layout forget about the object.
7771 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
7772 * more space than a single cell. For instance, the following code:
7774 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
7777 * Would result in an object being added like the following picture:
7779 * @image html layout_colspan.png
7780 * @image latex layout_colspan.eps width=\textwidth
7782 * @see elm_layout_table_unpack()
7783 * @see elm_layout_table_clear()
7787 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);
7789 * Unpack (remove) a child of the given part table.
7791 * @param obj The layout object
7792 * @param part The table part name to remove child.
7793 * @param child_obj The object to remove from table.
7794 * @return The object that was being used, or NULL if not found.
7796 * The object will be unpacked from the table part and its lifetime
7797 * will not be handled by the layout anymore. This is equivalent to
7798 * elm_layout_content_unset() for table.
7800 * @see elm_layout_table_pack()
7801 * @see elm_layout_table_clear()
7805 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
7807 * Remove all child of the given part table.
7809 * @param obj The layout object
7810 * @param part The table part name to remove child.
7811 * @param clear If EINA_TRUE, then all objects will be deleted as
7812 * well, otherwise they will just be removed and will be
7813 * dangling on the canvas.
7815 * The objects will be removed from the table part and their lifetime will
7816 * not be handled by the layout anymore. This is equivalent to
7817 * elm_layout_table_unpack() for all table children.
7819 * @see elm_layout_table_pack()
7820 * @see elm_layout_table_unpack()
7824 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
7826 * Get the edje layout
7828 * @param obj The layout object
7830 * @return A Evas_Object with the edje layout settings loaded
7831 * with function elm_layout_file_set
7833 * This returns the edje object. It is not expected to be used to then
7834 * swallow objects via edje_object_part_swallow() for example. Use
7835 * elm_layout_content_set() instead so child object handling and sizing is
7838 * @note This function should only be used if you really need to call some
7839 * low level Edje function on this edje object. All the common stuff (setting
7840 * text, emitting signals, hooking callbacks to signals, etc.) can be done
7841 * with proper elementary functions.
7843 * @see elm_object_signal_callback_add()
7844 * @see elm_object_signal_emit()
7845 * @see elm_object_text_part_set()
7846 * @see elm_layout_content_set()
7847 * @see elm_layout_box_append()
7848 * @see elm_layout_table_pack()
7849 * @see elm_layout_data_get()
7853 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7855 * Get the edje data from the given layout
7857 * @param obj The layout object
7858 * @param key The data key
7860 * @return The edje data string
7862 * This function fetches data specified inside the edje theme of this layout.
7863 * This function return NULL if data is not found.
7865 * In EDC this comes from a data block within the group block that @p
7866 * obj was loaded from. E.g.
7873 * item: "key1" "value1";
7874 * item: "key2" "value2";
7882 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
7886 * @param obj The layout object
7888 * Manually forces a sizing re-evaluation. This is useful when the minimum
7889 * size required by the edje theme of this layout has changed. The change on
7890 * the minimum size required by the edje theme is not immediately reported to
7891 * the elementary layout, so one needs to call this function in order to tell
7892 * the widget (layout) that it needs to reevaluate its own size.
7894 * The minimum size of the theme is calculated based on minimum size of
7895 * parts, the size of elements inside containers like box and table, etc. All
7896 * of this can change due to state changes, and that's when this function
7899 * Also note that a standard signal of "size,eval" "elm" emitted from the
7900 * edje object will cause this to happen too.
7904 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
7905 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
7906 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7907 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7908 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
7909 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7910 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);
7911 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
7913 * @def elm_layout_icon_set
7914 * Convienience macro to set the icon object in a layout that follows the
7915 * Elementary naming convention for its parts.
7919 #define elm_layout_icon_set(_ly, _obj) \
7922 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
7923 if ((_obj)) sig = "elm,state,icon,visible"; \
7924 else sig = "elm,state,icon,hidden"; \
7925 elm_object_signal_emit((_ly), sig, "elm"); \
7929 * @def elm_layout_icon_get
7930 * Convienience macro to get the icon object from a layout that follows the
7931 * Elementary naming convention for its parts.
7935 #define elm_layout_icon_get(_ly) \
7936 elm_layout_content_get((_ly), "elm.swallow.icon")
7939 * @def elm_layout_end_set
7940 * Convienience macro to set the end object in a layout that follows the
7941 * Elementary naming convention for its parts.
7945 #define elm_layout_end_set(_ly, _obj) \
7948 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
7949 if ((_obj)) sig = "elm,state,end,visible"; \
7950 else sig = "elm,state,end,hidden"; \
7951 elm_object_signal_emit((_ly), sig, "elm"); \
7955 * @def elm_layout_end_get
7956 * Convienience macro to get the end object in a layout that follows the
7957 * Elementary naming convention for its parts.
7961 #define elm_layout_end_get(_ly) \
7962 elm_layout_content_get((_ly), "elm.swallow.end")
7965 * @def elm_layout_label_set
7966 * Convienience macro to set the label in a layout that follows the
7967 * Elementary naming convention for its parts.
7970 * @deprecated use elm_object_text_* instead.
7972 #define elm_layout_label_set(_ly, _txt) \
7973 elm_layout_text_set((_ly), "elm.text", (_txt))
7976 * @def elm_layout_label_get
7977 * Convienience macro to get the label in a layout that follows the
7978 * Elementary naming convention for its parts.
7981 * @deprecated use elm_object_text_* instead.
7983 #define elm_layout_label_get(_ly) \
7984 elm_layout_text_get((_ly), "elm.text")
7986 /* smart callbacks called:
7987 * "theme,changed" - when elm theme is changed.
7991 * @defgroup Notify Notify
7993 * @image html img/widget/notify/preview-00.png
7994 * @image latex img/widget/notify/preview-00.eps
7996 * Display a container in a particular region of the parent(top, bottom,
7997 * etc. A timeout can be set to automatically hide the notify. This is so
7998 * that, after an evas_object_show() on a notify object, if a timeout was set
7999 * on it, it will @b automatically get hidden after that time.
8001 * Signals that you can add callbacks for are:
8002 * @li "timeout" - when timeout happens on notify and it's hidden
8003 * @li "block,clicked" - when a click outside of the notify happens
8005 * @ref tutorial_notify show usage of the API.
8010 * @brief Possible orient values for notify.
8012 * This values should be used in conjunction to elm_notify_orient_set() to
8013 * set the position in which the notify should appear(relative to its parent)
8014 * and in conjunction with elm_notify_orient_get() to know where the notify
8017 typedef enum _Elm_Notify_Orient
8019 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
8020 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
8021 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
8022 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
8023 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
8024 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
8025 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
8026 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
8027 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
8028 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
8029 } Elm_Notify_Orient;
8031 * @brief Add a new notify to the parent
8033 * @param parent The parent object
8034 * @return The new object or NULL if it cannot be created
8036 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8038 * @brief Set the content of the notify widget
8040 * @param obj The notify object
8041 * @param content The content will be filled in this notify object
8043 * Once the content object is set, a previously set one will be deleted. If
8044 * you want to keep that old content object, use the
8045 * elm_notify_content_unset() function.
8047 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
8049 * @brief Unset the content of the notify widget
8051 * @param obj The notify object
8052 * @return The content that was being used
8054 * Unparent and return the content object which was set for this widget
8056 * @see elm_notify_content_set()
8058 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
8060 * @brief Return the content of the notify widget
8062 * @param obj The notify object
8063 * @return The content that is being used
8065 * @see elm_notify_content_set()
8067 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8069 * @brief Set the notify parent
8071 * @param obj The notify object
8072 * @param content The new parent
8074 * Once the parent object is set, a previously set one will be disconnected
8077 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8079 * @brief Get the notify parent
8081 * @param obj The notify object
8082 * @return The parent
8084 * @see elm_notify_parent_set()
8086 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8088 * @brief Set the orientation
8090 * @param obj The notify object
8091 * @param orient The new orientation
8093 * Sets the position in which the notify will appear in its parent.
8095 * @see @ref Elm_Notify_Orient for possible values.
8097 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
8099 * @brief Return the orientation
8100 * @param obj The notify object
8101 * @return The orientation of the notification
8103 * @see elm_notify_orient_set()
8104 * @see Elm_Notify_Orient
8106 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8108 * @brief Set the time interval after which the notify window is going to be
8111 * @param obj The notify object
8112 * @param time The timeout in seconds
8114 * This function sets a timeout and starts the timer controlling when the
8115 * notify is hidden. Since calling evas_object_show() on a notify restarts
8116 * the timer controlling when the notify is hidden, setting this before the
8117 * notify is shown will in effect mean starting the timer when the notify is
8120 * @note Set a value <= 0.0 to disable a running timer.
8122 * @note If the value > 0.0 and the notify is previously visible, the
8123 * timer will be started with this value, canceling any running timer.
8125 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
8127 * @brief Return the timeout value (in seconds)
8128 * @param obj the notify object
8130 * @see elm_notify_timeout_set()
8132 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8134 * @brief Sets whether events should be passed to by a click outside
8137 * @param obj The notify object
8138 * @param repeats EINA_TRUE Events are repeats, else no
8140 * When true if the user clicks outside the window the events will be caught
8141 * by the others widgets, else the events are blocked.
8143 * @note The default value is EINA_TRUE.
8145 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
8147 * @brief Return true if events are repeat below the notify object
8148 * @param obj the notify object
8150 * @see elm_notify_repeat_events_set()
8152 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8158 * @defgroup Hover Hover
8160 * @image html img/widget/hover/preview-00.png
8161 * @image latex img/widget/hover/preview-00.eps
8163 * A Hover object will hover over its @p parent object at the @p target
8164 * location. Anything in the background will be given a darker coloring to
8165 * indicate that the hover object is on top (at the default theme). When the
8166 * hover is clicked it is dismissed(hidden), if the contents of the hover are
8167 * clicked that @b doesn't cause the hover to be dismissed.
8169 * @note The hover object will take up the entire space of @p target
8172 * Elementary has the following styles for the hover widget:
8176 * @li hoversel_vertical
8178 * The following are the available position for content:
8190 * Signals that you can add callbacks for are:
8191 * @li "clicked" - the user clicked the empty space in the hover to dismiss
8192 * @li "smart,changed" - a content object placed under the "smart"
8193 * policy was replaced to a new slot direction.
8195 * See @ref tutorial_hover for more information.
8199 typedef enum _Elm_Hover_Axis
8201 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
8202 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
8203 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
8204 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
8207 * @brief Adds a hover object to @p parent
8209 * @param parent The parent object
8210 * @return The hover object or NULL if one could not be created
8212 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8214 * @brief Sets the target object for the hover.
8216 * @param obj The hover object
8217 * @param target The object to center the hover onto. The hover
8219 * This function will cause the hover to be centered on the target object.
8221 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
8223 * @brief Gets the target object for the hover.
8225 * @param obj The hover object
8226 * @param parent The object to locate the hover over.
8228 * @see elm_hover_target_set()
8230 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8232 * @brief Sets the parent object for the hover.
8234 * @param obj The hover object
8235 * @param parent The object to locate the hover over.
8237 * This function will cause the hover to take up the entire space that the
8238 * parent object fills.
8240 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
8242 * @brief Gets the parent object for the hover.
8244 * @param obj The hover object
8245 * @return The parent object to locate the hover over.
8247 * @see elm_hover_parent_set()
8249 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8251 * @brief Sets the content of the hover object and the direction in which it
8254 * @param obj The hover object
8255 * @param swallow The direction that the object will be displayed
8256 * at. Accepted values are "left", "top-left", "top", "top-right",
8257 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
8259 * @param content The content to place at @p swallow
8261 * Once the content object is set for a given direction, a previously
8262 * set one (on the same direction) will be deleted. If you want to
8263 * keep that old content object, use the elm_hover_content_unset()
8266 * All directions may have contents at the same time, except for
8267 * "smart". This is a special placement hint and its use case
8268 * independs of the calculations coming from
8269 * elm_hover_best_content_location_get(). Its use is for cases when
8270 * one desires only one hover content, but with a dinamic special
8271 * placement within the hover area. The content's geometry, whenever
8272 * it changes, will be used to decide on a best location not
8273 * extrapolating the hover's parent object view to show it in (still
8274 * being the hover's target determinant of its medium part -- move and
8275 * resize it to simulate finger sizes, for example). If one of the
8276 * directions other than "smart" are used, a previously content set
8277 * using it will be deleted, and vice-versa.
8279 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
8281 * @brief Get the content of the hover object, in a given direction.
8283 * Return the content object which was set for this widget in the
8284 * @p swallow direction.
8286 * @param obj The hover object
8287 * @param swallow The direction that the object was display at.
8288 * @return The content that was being used
8290 * @see elm_hover_content_set()
8292 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8294 * @brief Unset the content of the hover object, in a given direction.
8296 * Unparent and return the content object set at @p swallow direction.
8298 * @param obj The hover object
8299 * @param swallow The direction that the object was display at.
8300 * @return The content that was being used.
8302 * @see elm_hover_content_set()
8304 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
8306 * @brief Returns the best swallow location for content in the hover.
8308 * @param obj The hover object
8309 * @param pref_axis The preferred orientation axis for the hover object to use
8310 * @return The edje location to place content into the hover or @c
8313 * Best is defined here as the location at which there is the most available
8316 * @p pref_axis may be one of
8317 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
8318 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
8319 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
8320 * - @c ELM_HOVER_AXIS_BOTH -- both
8322 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
8323 * nescessarily be along the horizontal axis("left" or "right"). If
8324 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
8325 * be along the vertical axis("top" or "bottom"). Chossing
8326 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
8327 * returned position may be in either axis.
8329 * @see elm_hover_content_set()
8331 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
8338 * @defgroup Entry Entry
8340 * @image html img/widget/entry/preview-00.png
8341 * @image latex img/widget/entry/preview-00.eps width=\textwidth
8342 * @image html img/widget/entry/preview-01.png
8343 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8344 * @image html img/widget/entry/preview-02.png
8345 * @image latex img/widget/entry/preview-02.eps width=\textwidth
8346 * @image html img/widget/entry/preview-03.png
8347 * @image latex img/widget/entry/preview-03.eps width=\textwidth
8349 * An entry is a convenience widget which shows a box that the user can
8350 * enter text into. Entries by default don't scroll, so they grow to
8351 * accomodate the entire text, resizing the parent window as needed. This
8352 * can be changed with the elm_entry_scrollable_set() function.
8354 * They can also be single line or multi line (the default) and when set
8355 * to multi line mode they support text wrapping in any of the modes
8356 * indicated by #Elm_Wrap_Type.
8358 * Other features include password mode, filtering of inserted text with
8359 * elm_entry_text_filter_append() and related functions, inline "items" and
8360 * formatted markup text.
8362 * @section entry-markup Formatted text
8364 * The markup tags supported by the Entry are defined by the theme, but
8365 * even when writing new themes or extensions it's a good idea to stick to
8366 * a sane default, to maintain coherency and avoid application breakages.
8367 * Currently defined by the default theme are the following tags:
8368 * @li \<br\>: Inserts a line break.
8369 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
8371 * @li \<tab\>: Inserts a tab.
8372 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
8374 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
8375 * @li \<link\>...\</link\>: Underlines the enclosed text.
8376 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
8378 * @section entry-special Special markups
8380 * Besides those used to format text, entries support two special markup
8381 * tags used to insert clickable portions of text or items inlined within
8384 * @subsection entry-anchors Anchors
8386 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
8387 * \</a\> tags and an event will be generated when this text is clicked,
8391 * This text is outside <a href=anc-01>but this one is an anchor</a>
8394 * The @c href attribute in the opening tag gives the name that will be
8395 * used to identify the anchor and it can be any valid utf8 string.
8397 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
8398 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
8399 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
8400 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
8403 * @subsection entry-items Items
8405 * Inlined in the text, any other @c Evas_Object can be inserted by using
8406 * \<item\> tags this way:
8409 * <item size=16x16 vsize=full href=emoticon/haha></item>
8412 * Just like with anchors, the @c href identifies each item, but these need,
8413 * in addition, to indicate their size, which is done using any one of
8414 * @c size, @c absize or @c relsize attributes. These attributes take their
8415 * value in the WxH format, where W is the width and H the height of the
8418 * @li absize: Absolute pixel size for the item. Whatever value is set will
8419 * be the item's size regardless of any scale value the object may have
8420 * been set to. The final line height will be adjusted to fit larger items.
8421 * @li size: Similar to @c absize, but it's adjusted to the scale value set
8423 * @li relsize: Size is adjusted for the item to fit within the current
8426 * Besides their size, items are specificed a @c vsize value that affects
8427 * how their final size and position are calculated. The possible values
8429 * @li ascent: Item will be placed within the line's baseline and its
8430 * ascent. That is, the height between the line where all characters are
8431 * positioned and the highest point in the line. For @c size and @c absize
8432 * items, the descent value will be added to the total line height to make
8433 * them fit. @c relsize items will be adjusted to fit within this space.
8434 * @li full: Items will be placed between the descent and ascent, or the
8435 * lowest point in the line and its highest.
8437 * The next image shows different configurations of items and how they
8438 * are the previously mentioned options affect their sizes. In all cases,
8439 * the green line indicates the ascent, blue for the baseline and red for
8442 * @image html entry_item.png
8443 * @image latex entry_item.eps width=\textwidth
8445 * And another one to show how size differs from absize. In the first one,
8446 * the scale value is set to 1.0, while the second one is using one of 2.0.
8448 * @image html entry_item_scale.png
8449 * @image latex entry_item_scale.eps width=\textwidth
8451 * After the size for an item is calculated, the entry will request an
8452 * object to place in its space. For this, the functions set with
8453 * elm_entry_item_provider_append() and related functions will be called
8454 * in order until one of them returns a @c non-NULL value. If no providers
8455 * are available, or all of them return @c NULL, then the entry falls back
8456 * to one of the internal defaults, provided the name matches with one of
8459 * All of the following are currently supported:
8462 * - emoticon/angry-shout
8463 * - emoticon/crazy-laugh
8464 * - emoticon/evil-laugh
8466 * - emoticon/goggle-smile
8468 * - emoticon/grumpy-smile
8470 * - emoticon/guilty-smile
8472 * - emoticon/half-smile
8473 * - emoticon/happy-panting
8475 * - emoticon/indifferent
8477 * - emoticon/knowing-grin
8479 * - emoticon/little-bit-sorry
8480 * - emoticon/love-lots
8482 * - emoticon/minimal-smile
8483 * - emoticon/not-happy
8484 * - emoticon/not-impressed
8486 * - emoticon/opensmile
8489 * - emoticon/squint-laugh
8490 * - emoticon/surprised
8491 * - emoticon/suspicious
8492 * - emoticon/tongue-dangling
8493 * - emoticon/tongue-poke
8495 * - emoticon/unhappy
8496 * - emoticon/very-sorry
8499 * - emoticon/worried
8502 * Alternatively, an item may reference an image by its path, using
8503 * the URI form @c file:///path/to/an/image.png and the entry will then
8504 * use that image for the item.
8506 * @section entry-files Loading and saving files
8508 * Entries have convinience functions to load text from a file and save
8509 * changes back to it after a short delay. The automatic saving is enabled
8510 * by default, but can be disabled with elm_entry_autosave_set() and files
8511 * can be loaded directly as plain text or have any markup in them
8512 * recognized. See elm_entry_file_set() for more details.
8514 * @section entry-signals Emitted signals
8516 * This widget emits the following signals:
8518 * @li "changed": The text within the entry was changed.
8519 * @li "changed,user": The text within the entry was changed because of user interaction.
8520 * @li "activated": The enter key was pressed on a single line entry.
8521 * @li "press": A mouse button has been pressed on the entry.
8522 * @li "longpressed": A mouse button has been pressed and held for a couple
8524 * @li "clicked": The entry has been clicked (mouse press and release).
8525 * @li "clicked,double": The entry has been double clicked.
8526 * @li "clicked,triple": The entry has been triple clicked.
8527 * @li "focused": The entry has received focus.
8528 * @li "unfocused": The entry has lost focus.
8529 * @li "selection,paste": A paste of the clipboard contents was requested.
8530 * @li "selection,copy": A copy of the selected text into the clipboard was
8532 * @li "selection,cut": A cut of the selected text into the clipboard was
8534 * @li "selection,start": A selection has begun and no previous selection
8536 * @li "selection,changed": The current selection has changed.
8537 * @li "selection,cleared": The current selection has been cleared.
8538 * @li "cursor,changed": The cursor has changed position.
8539 * @li "anchor,clicked": An anchor has been clicked. The event_info
8540 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8541 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
8542 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8543 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
8544 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8545 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
8546 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8547 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
8548 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
8549 * @li "preedit,changed": The preedit string has changed.
8551 * @section entry-examples
8553 * An overview of the Entry API can be seen in @ref entry_example_01
8558 * @typedef Elm_Entry_Anchor_Info
8560 * The info sent in the callback for the "anchor,clicked" signals emitted
8563 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
8565 * @struct _Elm_Entry_Anchor_Info
8567 * The info sent in the callback for the "anchor,clicked" signals emitted
8570 struct _Elm_Entry_Anchor_Info
8572 const char *name; /**< The name of the anchor, as stated in its href */
8573 int button; /**< The mouse button used to click on it */
8574 Evas_Coord x, /**< Anchor geometry, relative to canvas */
8575 y, /**< Anchor geometry, relative to canvas */
8576 w, /**< Anchor geometry, relative to canvas */
8577 h; /**< Anchor geometry, relative to canvas */
8580 * @typedef Elm_Entry_Filter_Cb
8581 * This callback type is used by entry filters to modify text.
8582 * @param data The data specified as the last param when adding the filter
8583 * @param entry The entry object
8584 * @param text A pointer to the location of the text being filtered. This data can be modified,
8585 * but any additional allocations must be managed by the user.
8586 * @see elm_entry_text_filter_append
8587 * @see elm_entry_text_filter_prepend
8589 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
8592 * This adds an entry to @p parent object.
8594 * By default, entries are:
8598 * @li autosave is enabled
8600 * @param parent The parent object
8601 * @return The new object or NULL if it cannot be created
8603 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8605 * Sets the entry to single line mode.
8607 * In single line mode, entries don't ever wrap when the text reaches the
8608 * edge, and instead they keep growing horizontally. Pressing the @c Enter
8609 * key will generate an @c "activate" event instead of adding a new line.
8611 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
8612 * and pressing enter will break the text into a different line
8613 * without generating any events.
8615 * @param obj The entry object
8616 * @param single_line If true, the text in the entry
8617 * will be on a single line.
8619 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
8621 * Gets whether the entry is set to be single line.
8623 * @param obj The entry object
8624 * @return single_line If true, the text in the entry is set to display
8627 * @see elm_entry_single_line_set()
8629 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8631 * Sets the entry to password mode.
8633 * In password mode, entries are implicitly single line and the display of
8634 * any text in them is replaced with asterisks (*).
8636 * @param obj The entry object
8637 * @param password If true, password mode is enabled.
8639 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
8641 * Gets whether the entry is set to password mode.
8643 * @param obj The entry object
8644 * @return If true, the entry is set to display all characters
8647 * @see elm_entry_password_set()
8649 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8651 * This sets the text displayed within the entry to @p entry.
8653 * @param obj The entry object
8654 * @param entry The text to be displayed
8656 * @deprecated Use elm_object_text_set() instead.
8658 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8660 * This returns the text currently shown in object @p entry.
8661 * See also elm_entry_entry_set().
8663 * @param obj The entry object
8664 * @return The currently displayed text or NULL on failure
8666 * @deprecated Use elm_object_text_get() instead.
8668 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8670 * Appends @p entry to the text of the entry.
8672 * Adds the text in @p entry to the end of any text already present in the
8675 * The appended text is subject to any filters set for the widget.
8677 * @param obj The entry object
8678 * @param entry The text to be displayed
8680 * @see elm_entry_text_filter_append()
8682 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8684 * Gets whether the entry is empty.
8686 * Empty means no text at all. If there are any markup tags, like an item
8687 * tag for which no provider finds anything, and no text is displayed, this
8688 * function still returns EINA_FALSE.
8690 * @param obj The entry object
8691 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
8693 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8695 * Gets any selected text within the entry.
8697 * If there's any selected text in the entry, this function returns it as
8698 * a string in markup format. NULL is returned if no selection exists or
8699 * if an error occurred.
8701 * The returned value points to an internal string and should not be freed
8702 * or modified in any way. If the @p entry object is deleted or its
8703 * contents are changed, the returned pointer should be considered invalid.
8705 * @param obj The entry object
8706 * @return The selected text within the entry or NULL on failure
8708 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8710 * Inserts the given text into the entry at the current cursor position.
8712 * This inserts text at the cursor position as if it was typed
8713 * by the user (note that this also allows markup which a user
8714 * can't just "type" as it would be converted to escaped text, so this
8715 * call can be used to insert things like emoticon items or bold push/pop
8716 * tags, other font and color change tags etc.)
8718 * If any selection exists, it will be replaced by the inserted text.
8720 * The inserted text is subject to any filters set for the widget.
8722 * @param obj The entry object
8723 * @param entry The text to insert
8725 * @see elm_entry_text_filter_append()
8727 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
8729 * Set the line wrap type to use on multi-line entries.
8731 * Sets the wrap type used by the entry to any of the specified in
8732 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
8733 * line (without inserting a line break or paragraph separator) when it
8734 * reaches the far edge of the widget.
8736 * Note that this only makes sense for multi-line entries. A widget set
8737 * to be single line will never wrap.
8739 * @param obj The entry object
8740 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
8742 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
8744 * Gets the wrap mode the entry was set to use.
8746 * @param obj The entry object
8749 * @see also elm_entry_line_wrap_set()
8751 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8753 * Sets if the entry is to be editable or not.
8755 * By default, entries are editable and when focused, any text input by the
8756 * user will be inserted at the current cursor position. But calling this
8757 * function with @p editable as EINA_FALSE will prevent the user from
8758 * inputting text into the entry.
8760 * The only way to change the text of a non-editable entry is to use
8761 * elm_object_text_set(), elm_entry_entry_insert() and other related
8764 * @param obj The entry object
8765 * @param editable If EINA_TRUE, user input will be inserted in the entry,
8766 * if not, the entry is read-only and no user input is allowed.
8768 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
8770 * Gets whether the entry is editable or not.
8772 * @param obj The entry object
8773 * @return If true, the entry is editable by the user.
8774 * If false, it is not editable by the user
8776 * @see elm_entry_editable_set()
8778 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8780 * This drops any existing text selection within the entry.
8782 * @param obj The entry object
8784 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
8786 * This selects all text within the entry.
8788 * @param obj The entry object
8790 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
8792 * This moves the cursor one place to the right within the entry.
8794 * @param obj The entry object
8795 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8797 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
8799 * This moves the cursor one place to the left within the entry.
8801 * @param obj The entry object
8802 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8804 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
8806 * This moves the cursor one line up within the entry.
8808 * @param obj The entry object
8809 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8811 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
8813 * This moves the cursor one line down within the entry.
8815 * @param obj The entry object
8816 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8818 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
8820 * This moves the cursor to the beginning of the entry.
8822 * @param obj The entry object
8824 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8826 * This moves the cursor to the end of the entry.
8828 * @param obj The entry object
8830 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8832 * This moves the cursor to the beginning of the current line.
8834 * @param obj The entry object
8836 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8838 * This moves the cursor to the end of the current line.
8840 * @param obj The entry object
8842 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
8844 * This begins a selection within the entry as though
8845 * the user were holding down the mouse button to make a selection.
8847 * @param obj The entry object
8849 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
8851 * This ends a selection within the entry as though
8852 * the user had just released the mouse button while making a selection.
8854 * @param obj The entry object
8856 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
8858 * Gets whether a format node exists at the current cursor position.
8860 * A format node is anything that defines how the text is rendered. It can
8861 * be a visible format node, such as a line break or a paragraph separator,
8862 * or an invisible one, such as bold begin or end tag.
8863 * This function returns whether any format node exists at the current
8866 * @param obj The entry object
8867 * @return EINA_TRUE if the current cursor position contains a format node,
8868 * EINA_FALSE otherwise.
8870 * @see elm_entry_cursor_is_visible_format_get()
8872 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8874 * Gets if the current cursor position holds a visible format node.
8876 * @param obj The entry object
8877 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
8878 * if it's an invisible one or no format exists.
8880 * @see elm_entry_cursor_is_format_get()
8882 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8884 * Gets the character pointed by the cursor at its current position.
8886 * This function returns a string with the utf8 character stored at the
8887 * current cursor position.
8888 * Only the text is returned, any format that may exist will not be part
8889 * of the return value.
8891 * @param obj The entry object
8892 * @return The text pointed by the cursors.
8894 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8896 * This function returns the geometry of the cursor.
8898 * It's useful if you want to draw something on the cursor (or where it is),
8899 * or for example in the case of scrolled entry where you want to show the
8902 * @param obj The entry object
8903 * @param x returned geometry
8904 * @param y returned geometry
8905 * @param w returned geometry
8906 * @param h returned geometry
8907 * @return EINA_TRUE upon success, EINA_FALSE upon failure
8909 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);
8911 * Sets the cursor position in the entry to the given value
8913 * The value in @p pos is the index of the character position within the
8914 * contents of the string as returned by elm_entry_cursor_pos_get().
8916 * @param obj The entry object
8917 * @param pos The position of the cursor
8919 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
8921 * Retrieves the current position of the cursor in the entry
8923 * @param obj The entry object
8924 * @return The cursor position
8926 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8928 * This executes a "cut" action on the selected text in the entry.
8930 * @param obj The entry object
8932 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
8934 * This executes a "copy" action on the selected text in the entry.
8936 * @param obj The entry object
8938 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
8940 * This executes a "paste" action in the entry.
8942 * @param obj The entry object
8944 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
8946 * This clears and frees the items in a entry's contextual (longpress)
8949 * @param obj The entry object
8951 * @see elm_entry_context_menu_item_add()
8953 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8955 * This adds an item to the entry's contextual menu.
8957 * A longpress on an entry will make the contextual menu show up, if this
8958 * hasn't been disabled with elm_entry_context_menu_disabled_set().
8959 * By default, this menu provides a few options like enabling selection mode,
8960 * which is useful on embedded devices that need to be explicit about it,
8961 * and when a selection exists it also shows the copy and cut actions.
8963 * With this function, developers can add other options to this menu to
8964 * perform any action they deem necessary.
8966 * @param obj The entry object
8967 * @param label The item's text label
8968 * @param icon_file The item's icon file
8969 * @param icon_type The item's icon type
8970 * @param func The callback to execute when the item is clicked
8971 * @param data The data to associate with the item for related functions
8973 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);
8975 * This disables the entry's contextual (longpress) menu.
8977 * @param obj The entry object
8978 * @param disabled If true, the menu is disabled
8980 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8982 * This returns whether the entry's contextual (longpress) menu is
8985 * @param obj The entry object
8986 * @return If true, the menu is disabled
8988 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8990 * This appends a custom item provider to the list for that entry
8992 * This appends the given callback. The list is walked from beginning to end
8993 * with each function called given the item href string in the text. If the
8994 * function returns an object handle other than NULL (it should create an
8995 * object to do this), then this object is used to replace that item. If
8996 * not the next provider is called until one provides an item object, or the
8997 * default provider in entry does.
8999 * @param obj The entry object
9000 * @param func The function called to provide the item object
9001 * @param data The data passed to @p func
9003 * @see @ref entry-items
9005 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);
9007 * This prepends a custom item provider to the list for that entry
9009 * This prepends the given callback. See elm_entry_item_provider_append() for
9012 * @param obj The entry object
9013 * @param func The function called to provide the item object
9014 * @param data The data passed to @p func
9016 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);
9018 * This removes a custom item provider to the list for that entry
9020 * This removes the given callback. See elm_entry_item_provider_append() for
9023 * @param obj The entry object
9024 * @param func The function called to provide the item object
9025 * @param data The data passed to @p func
9027 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);
9029 * Append a filter function for text inserted in the entry
9031 * Append the given callback to the list. This functions will be called
9032 * whenever any text is inserted into the entry, with the text to be inserted
9033 * as a parameter. The callback function is free to alter the text in any way
9034 * it wants, but it must remember to free the given pointer and update it.
9035 * If the new text is to be discarded, the function can free it and set its
9036 * text parameter to NULL. This will also prevent any following filters from
9039 * @param obj The entry object
9040 * @param func The function to use as text filter
9041 * @param data User data to pass to @p func
9043 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9045 * Prepend a filter function for text insdrted in the entry
9047 * Prepend the given callback to the list. See elm_entry_text_filter_append()
9048 * for more information
9050 * @param obj The entry object
9051 * @param func The function to use as text filter
9052 * @param data User data to pass to @p func
9054 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9056 * Remove a filter from the list
9058 * Removes the given callback from the filter list. See
9059 * elm_entry_text_filter_append() for more information.
9061 * @param obj The entry object
9062 * @param func The filter function to remove
9063 * @param data The user data passed when adding the function
9065 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
9067 * This converts a markup (HTML-like) string into UTF-8.
9069 * The returned string is a malloc'ed buffer and it should be freed when
9070 * not needed anymore.
9072 * @param s The string (in markup) to be converted
9073 * @return The converted string (in UTF-8). It should be freed.
9075 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9077 * This converts a UTF-8 string into markup (HTML-like).
9079 * The returned string is a malloc'ed buffer and it should be freed when
9080 * not needed anymore.
9082 * @param s The string (in UTF-8) to be converted
9083 * @return The converted string (in markup). It should be freed.
9085 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
9087 * This sets the file (and implicitly loads it) for the text to display and
9088 * then edit. All changes are written back to the file after a short delay if
9089 * the entry object is set to autosave (which is the default).
9091 * If the entry had any other file set previously, any changes made to it
9092 * will be saved if the autosave feature is enabled, otherwise, the file
9093 * will be silently discarded and any non-saved changes will be lost.
9095 * @param obj The entry object
9096 * @param file The path to the file to load and save
9097 * @param format The file format
9099 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
9101 * Gets the file being edited by the entry.
9103 * This function can be used to retrieve any file set on the entry for
9104 * edition, along with the format used to load and save it.
9106 * @param obj The entry object
9107 * @param file The path to the file to load and save
9108 * @param format The file format
9110 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
9112 * This function writes any changes made to the file set with
9113 * elm_entry_file_set()
9115 * @param obj The entry object
9117 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
9119 * This sets the entry object to 'autosave' the loaded text file or not.
9121 * @param obj The entry object
9122 * @param autosave Autosave the loaded file or not
9124 * @see elm_entry_file_set()
9126 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
9128 * This gets the entry object's 'autosave' status.
9130 * @param obj The entry object
9131 * @return Autosave the loaded file or not
9133 * @see elm_entry_file_set()
9135 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9137 * Control pasting of text and images for the widget.
9139 * Normally the entry allows both text and images to be pasted. By setting
9140 * textonly to be true, this prevents images from being pasted.
9142 * Note this only changes the behaviour of text.
9144 * @param obj The entry object
9145 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
9148 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
9150 * Getting elm_entry text paste/drop mode.
9152 * In textonly mode, only text may be pasted or dropped into the widget.
9154 * @param obj The entry object
9155 * @return If the widget only accepts text from pastes.
9157 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9159 * Enable or disable scrolling in entry
9161 * Normally the entry is not scrollable unless you enable it with this call.
9163 * @param obj The entry object
9164 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
9166 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
9168 * Get the scrollable state of the entry
9170 * Normally the entry is not scrollable. This gets the scrollable state
9171 * of the entry. See elm_entry_scrollable_set() for more information.
9173 * @param obj The entry object
9174 * @return The scrollable state
9176 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
9178 * This sets a widget to be displayed to the left of a scrolled entry.
9180 * @param obj The scrolled entry object
9181 * @param icon The widget to display on the left side of the scrolled
9184 * @note A previously set widget will be destroyed.
9185 * @note If the object being set does not have minimum size hints set,
9186 * it won't get properly displayed.
9188 * @see elm_entry_end_set()
9190 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
9192 * Gets the leftmost widget of the scrolled entry. This object is
9193 * owned by the scrolled entry and should not be modified.
9195 * @param obj The scrolled entry object
9196 * @return the left widget inside the scroller
9198 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
9200 * Unset the leftmost widget of the scrolled entry, unparenting and
9203 * @param obj The scrolled entry object
9204 * @return the previously set icon sub-object of this entry, on
9207 * @see elm_entry_icon_set()
9209 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
9211 * Sets the visibility of the left-side widget of the scrolled entry,
9212 * set by elm_entry_icon_set().
9214 * @param obj The scrolled entry object
9215 * @param setting EINA_TRUE if the object should be displayed,
9216 * EINA_FALSE if not.
9218 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
9220 * This sets a widget to be displayed to the end of a scrolled entry.
9222 * @param obj The scrolled entry object
9223 * @param end The widget to display on the right side of the scrolled
9226 * @note A previously set widget will be destroyed.
9227 * @note If the object being set does not have minimum size hints set,
9228 * it won't get properly displayed.
9230 * @see elm_entry_icon_set
9232 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
9234 * Gets the endmost widget of the scrolled entry. This object is owned
9235 * by the scrolled entry and should not be modified.
9237 * @param obj The scrolled entry object
9238 * @return the right widget inside the scroller
9240 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
9242 * Unset the endmost widget of the scrolled entry, unparenting and
9245 * @param obj The scrolled entry object
9246 * @return the previously set icon sub-object of this entry, on
9249 * @see elm_entry_icon_set()
9251 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
9253 * Sets the visibility of the end widget of the scrolled entry, set by
9254 * elm_entry_end_set().
9256 * @param obj The scrolled entry object
9257 * @param setting EINA_TRUE if the object should be displayed,
9258 * EINA_FALSE if not.
9260 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
9262 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
9265 * Setting an entry to single-line mode with elm_entry_single_line_set()
9266 * will automatically disable the display of scrollbars when the entry
9267 * moves inside its scroller.
9269 * @param obj The scrolled entry object
9270 * @param h The horizontal scrollbar policy to apply
9271 * @param v The vertical scrollbar policy to apply
9273 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
9275 * This enables/disables bouncing within the entry.
9277 * This function sets whether the entry will bounce when scrolling reaches
9278 * the end of the contained entry.
9280 * @param obj The scrolled entry object
9281 * @param h The horizontal bounce state
9282 * @param v The vertical bounce state
9284 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
9286 * Get the bounce mode
9288 * @param obj The Entry object
9289 * @param h_bounce Allow bounce horizontally
9290 * @param v_bounce Allow bounce vertically
9292 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
9294 /* pre-made filters for entries */
9296 * @typedef Elm_Entry_Filter_Limit_Size
9298 * Data for the elm_entry_filter_limit_size() entry filter.
9300 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
9302 * @struct _Elm_Entry_Filter_Limit_Size
9304 * Data for the elm_entry_filter_limit_size() entry filter.
9306 struct _Elm_Entry_Filter_Limit_Size
9308 int max_char_count; /**< The maximum number of characters allowed. */
9309 int max_byte_count; /**< The maximum number of bytes allowed*/
9312 * Filter inserted text based on user defined character and byte limits
9314 * Add this filter to an entry to limit the characters that it will accept
9315 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
9316 * The funtion works on the UTF-8 representation of the string, converting
9317 * it from the set markup, thus not accounting for any format in it.
9319 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
9320 * it as data when setting the filter. In it, it's possible to set limits
9321 * by character count or bytes (any of them is disabled if 0), and both can
9322 * be set at the same time. In that case, it first checks for characters,
9325 * The function will cut the inserted text in order to allow only the first
9326 * number of characters that are still allowed. The cut is made in
9327 * characters, even when limiting by bytes, in order to always contain
9328 * valid ones and avoid half unicode characters making it in.
9330 * This filter, like any others, does not apply when setting the entry text
9331 * directly with elm_object_text_set() (or the deprecated
9332 * elm_entry_entry_set()).
9334 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
9336 * @typedef Elm_Entry_Filter_Accept_Set
9338 * Data for the elm_entry_filter_accept_set() entry filter.
9340 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
9342 * @struct _Elm_Entry_Filter_Accept_Set
9344 * Data for the elm_entry_filter_accept_set() entry filter.
9346 struct _Elm_Entry_Filter_Accept_Set
9348 const char *accepted; /**< Set of characters accepted in the entry. */
9349 const char *rejected; /**< Set of characters rejected from the entry. */
9352 * Filter inserted text based on accepted or rejected sets of characters
9354 * Add this filter to an entry to restrict the set of accepted characters
9355 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
9356 * This structure contains both accepted and rejected sets, but they are
9357 * mutually exclusive.
9359 * The @c accepted set takes preference, so if it is set, the filter will
9360 * only work based on the accepted characters, ignoring anything in the
9361 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
9363 * In both cases, the function filters by matching utf8 characters to the
9364 * raw markup text, so it can be used to remove formatting tags.
9366 * This filter, like any others, does not apply when setting the entry text
9367 * directly with elm_object_text_set() (or the deprecated
9368 * elm_entry_entry_set()).
9370 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
9375 /* composite widgets - these basically put together basic widgets above
9376 * in convenient packages that do more than basic stuff */
9380 * @defgroup Anchorview Anchorview
9382 * @image html img/widget/anchorview/preview-00.png
9383 * @image latex img/widget/anchorview/preview-00.eps
9385 * Anchorview is for displaying text that contains markup with anchors
9386 * like <c>\<a href=1234\>something\</\></c> in it.
9388 * Besides being styled differently, the anchorview widget provides the
9389 * necessary functionality so that clicking on these anchors brings up a
9390 * popup with user defined content such as "call", "add to contacts" or
9391 * "open web page". This popup is provided using the @ref Hover widget.
9393 * This widget is very similar to @ref Anchorblock, so refer to that
9394 * widget for an example. The only difference Anchorview has is that the
9395 * widget is already provided with scrolling functionality, so if the
9396 * text set to it is too large to fit in the given space, it will scroll,
9397 * whereas the @ref Anchorblock widget will keep growing to ensure all the
9398 * text can be displayed.
9400 * This widget emits the following signals:
9401 * @li "anchor,clicked": will be called when an anchor is clicked. The
9402 * @p event_info parameter on the callback will be a pointer of type
9403 * ::Elm_Entry_Anchorview_Info.
9405 * See @ref Anchorblock for an example on how to use both of them.
9414 * @typedef Elm_Entry_Anchorview_Info
9416 * The info sent in the callback for "anchor,clicked" signals emitted by
9417 * the Anchorview widget.
9419 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
9421 * @struct _Elm_Entry_Anchorview_Info
9423 * The info sent in the callback for "anchor,clicked" signals emitted by
9424 * the Anchorview widget.
9426 struct _Elm_Entry_Anchorview_Info
9428 const char *name; /**< Name of the anchor, as indicated in its href
9430 int button; /**< The mouse button used to click on it */
9431 Evas_Object *hover; /**< The hover object to use for the popup */
9433 Evas_Coord x, y, w, h;
9434 } anchor, /**< Geometry selection of text used as anchor */
9435 hover_parent; /**< Geometry of the object used as parent by the
9437 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9438 for content on the left side of
9439 the hover. Before calling the
9440 callback, the widget will make the
9441 necessary calculations to check
9442 which sides are fit to be set with
9443 content, based on the position the
9444 hover is activated and its distance
9445 to the edges of its parent object
9447 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9448 the right side of the hover.
9449 See @ref hover_left */
9450 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9451 of the hover. See @ref hover_left */
9452 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9453 below the hover. See @ref
9457 * Add a new Anchorview object
9459 * @param parent The parent object
9460 * @return The new object or NULL if it cannot be created
9462 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9464 * Set the text to show in the anchorview
9466 * Sets the text of the anchorview to @p text. This text can include markup
9467 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
9468 * text that will be specially styled and react to click events, ended with
9469 * either of \</a\> or \</\>. When clicked, the anchor will emit an
9470 * "anchor,clicked" signal that you can attach a callback to with
9471 * evas_object_smart_callback_add(). The name of the anchor given in the
9472 * event info struct will be the one set in the href attribute, in this
9475 * Other markup can be used to style the text in different ways, but it's
9476 * up to the style defined in the theme which tags do what.
9477 * @deprecated use elm_object_text_set() instead.
9479 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9481 * Get the markup text set for the anchorview
9483 * Retrieves the text set on the anchorview, with markup tags included.
9485 * @param obj The anchorview object
9486 * @return The markup text set or @c NULL if nothing was set or an error
9488 * @deprecated use elm_object_text_set() instead.
9490 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9492 * Set the parent of the hover popup
9494 * Sets the parent object to use by the hover created by the anchorview
9495 * when an anchor is clicked. See @ref Hover for more details on this.
9496 * If no parent is set, the same anchorview object will be used.
9498 * @param obj The anchorview object
9499 * @param parent The object to use as parent for the hover
9501 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9503 * Get the parent of the hover popup
9505 * Get the object used as parent for the hover created by the anchorview
9506 * widget. See @ref Hover for more details on this.
9508 * @param obj The anchorview object
9509 * @return The object used as parent for the hover, NULL if none is set.
9511 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9513 * Set the style that the hover should use
9515 * When creating the popup hover, anchorview will request that it's
9516 * themed according to @p style.
9518 * @param obj The anchorview object
9519 * @param style The style to use for the underlying hover
9521 * @see elm_object_style_set()
9523 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9525 * Get the style that the hover should use
9527 * Get the style the hover created by anchorview will use.
9529 * @param obj The anchorview object
9530 * @return The style to use by the hover. NULL means the default is used.
9532 * @see elm_object_style_set()
9534 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9536 * Ends the hover popup in the anchorview
9538 * When an anchor is clicked, the anchorview widget will create a hover
9539 * object to use as a popup with user provided content. This function
9540 * terminates this popup, returning the anchorview to its normal state.
9542 * @param obj The anchorview object
9544 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9546 * Set bouncing behaviour when the scrolled content reaches an edge
9548 * Tell the internal scroller object whether it should bounce or not
9549 * when it reaches the respective edges for each axis.
9551 * @param obj The anchorview object
9552 * @param h_bounce Whether to bounce or not in the horizontal axis
9553 * @param v_bounce Whether to bounce or not in the vertical axis
9555 * @see elm_scroller_bounce_set()
9557 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
9559 * Get the set bouncing behaviour of the internal scroller
9561 * Get whether the internal scroller should bounce when the edge of each
9562 * axis is reached scrolling.
9564 * @param obj The anchorview object
9565 * @param h_bounce Pointer where to store the bounce state of the horizontal
9567 * @param v_bounce Pointer where to store the bounce state of the vertical
9570 * @see elm_scroller_bounce_get()
9572 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
9574 * Appends a custom item provider to the given anchorview
9576 * Appends the given function to the list of items providers. This list is
9577 * called, one function at a time, with the given @p data pointer, the
9578 * anchorview object and, in the @p item parameter, the item name as
9579 * referenced in its href string. Following functions in the list will be
9580 * called in order until one of them returns something different to NULL,
9581 * which should be an Evas_Object which will be used in place of the item
9584 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9585 * href=item/name\>\</item\>
9587 * @param obj The anchorview object
9588 * @param func The function to add to the list of providers
9589 * @param data User data that will be passed to the callback function
9591 * @see elm_entry_item_provider_append()
9593 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);
9595 * Prepend a custom item provider to the given anchorview
9597 * Like elm_anchorview_item_provider_append(), but it adds the function
9598 * @p func to the beginning of the list, instead of the end.
9600 * @param obj The anchorview object
9601 * @param func The function to add to the list of providers
9602 * @param data User data that will be passed to the callback function
9604 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);
9606 * Remove a custom item provider from the list of the given anchorview
9608 * Removes the function and data pairing that matches @p func and @p data.
9609 * That is, unless the same function and same user data are given, the
9610 * function will not be removed from the list. This allows us to add the
9611 * same callback several times, with different @p data pointers and be
9612 * able to remove them later without conflicts.
9614 * @param obj The anchorview object
9615 * @param func The function to remove from the list
9616 * @param data The data matching the function to remove from the list
9618 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);
9625 * @defgroup Anchorblock Anchorblock
9627 * @image html img/widget/anchorblock/preview-00.png
9628 * @image latex img/widget/anchorblock/preview-00.eps
9630 * Anchorblock is for displaying text that contains markup with anchors
9631 * like <c>\<a href=1234\>something\</\></c> in it.
9633 * Besides being styled differently, the anchorblock widget provides the
9634 * necessary functionality so that clicking on these anchors brings up a
9635 * popup with user defined content such as "call", "add to contacts" or
9636 * "open web page". This popup is provided using the @ref Hover widget.
9638 * This widget emits the following signals:
9639 * @li "anchor,clicked": will be called when an anchor is clicked. The
9640 * @p event_info parameter on the callback will be a pointer of type
9641 * ::Elm_Entry_Anchorblock_Info.
9647 * Since examples are usually better than plain words, we might as well
9648 * try @ref tutorial_anchorblock_example "one".
9651 * @addtogroup Anchorblock
9655 * @typedef Elm_Entry_Anchorblock_Info
9657 * The info sent in the callback for "anchor,clicked" signals emitted by
9658 * the Anchorblock widget.
9660 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
9662 * @struct _Elm_Entry_Anchorblock_Info
9664 * The info sent in the callback for "anchor,clicked" signals emitted by
9665 * the Anchorblock widget.
9667 struct _Elm_Entry_Anchorblock_Info
9669 const char *name; /**< Name of the anchor, as indicated in its href
9671 int button; /**< The mouse button used to click on it */
9672 Evas_Object *hover; /**< The hover object to use for the popup */
9674 Evas_Coord x, y, w, h;
9675 } anchor, /**< Geometry selection of text used as anchor */
9676 hover_parent; /**< Geometry of the object used as parent by the
9678 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
9679 for content on the left side of
9680 the hover. Before calling the
9681 callback, the widget will make the
9682 necessary calculations to check
9683 which sides are fit to be set with
9684 content, based on the position the
9685 hover is activated and its distance
9686 to the edges of its parent object
9688 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
9689 the right side of the hover.
9690 See @ref hover_left */
9691 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
9692 of the hover. See @ref hover_left */
9693 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
9694 below the hover. See @ref
9698 * Add a new Anchorblock object
9700 * @param parent The parent object
9701 * @return The new object or NULL if it cannot be created
9703 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9705 * Set the text to show in the anchorblock
9707 * Sets the text of the anchorblock to @p text. This text can include markup
9708 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
9709 * of text that will be specially styled and react to click events, ended
9710 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
9711 * "anchor,clicked" signal that you can attach a callback to with
9712 * evas_object_smart_callback_add(). The name of the anchor given in the
9713 * event info struct will be the one set in the href attribute, in this
9716 * Other markup can be used to style the text in different ways, but it's
9717 * up to the style defined in the theme which tags do what.
9718 * @deprecated use elm_object_text_set() instead.
9720 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
9722 * Get the markup text set for the anchorblock
9724 * Retrieves the text set on the anchorblock, with markup tags included.
9726 * @param obj The anchorblock object
9727 * @return The markup text set or @c NULL if nothing was set or an error
9729 * @deprecated use elm_object_text_set() instead.
9731 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9733 * Set the parent of the hover popup
9735 * Sets the parent object to use by the hover created by the anchorblock
9736 * when an anchor is clicked. See @ref Hover for more details on this.
9738 * @param obj The anchorblock object
9739 * @param parent The object to use as parent for the hover
9741 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9743 * Get the parent of the hover popup
9745 * Get the object used as parent for the hover created by the anchorblock
9746 * widget. See @ref Hover for more details on this.
9747 * If no parent is set, the same anchorblock object will be used.
9749 * @param obj The anchorblock object
9750 * @return The object used as parent for the hover, NULL if none is set.
9752 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9754 * Set the style that the hover should use
9756 * When creating the popup hover, anchorblock will request that it's
9757 * themed according to @p style.
9759 * @param obj The anchorblock object
9760 * @param style The style to use for the underlying hover
9762 * @see elm_object_style_set()
9764 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
9766 * Get the style that the hover should use
9768 * Get the style the hover created by anchorblock will use.
9770 * @param obj The anchorblock object
9771 * @return The style to use by the hover. NULL means the default is used.
9773 * @see elm_object_style_set()
9775 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9777 * Ends the hover popup in the anchorblock
9779 * When an anchor is clicked, the anchorblock widget will create a hover
9780 * object to use as a popup with user provided content. This function
9781 * terminates this popup, returning the anchorblock to its normal state.
9783 * @param obj The anchorblock object
9785 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
9787 * Appends a custom item provider to the given anchorblock
9789 * Appends the given function to the list of items providers. This list is
9790 * called, one function at a time, with the given @p data pointer, the
9791 * anchorblock object and, in the @p item parameter, the item name as
9792 * referenced in its href string. Following functions in the list will be
9793 * called in order until one of them returns something different to NULL,
9794 * which should be an Evas_Object which will be used in place of the item
9797 * Items in the markup text take the form \<item relsize=16x16 vsize=full
9798 * href=item/name\>\</item\>
9800 * @param obj The anchorblock object
9801 * @param func The function to add to the list of providers
9802 * @param data User data that will be passed to the callback function
9804 * @see elm_entry_item_provider_append()
9806 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);
9808 * Prepend a custom item provider to the given anchorblock
9810 * Like elm_anchorblock_item_provider_append(), but it adds the function
9811 * @p func to the beginning of the list, instead of the end.
9813 * @param obj The anchorblock object
9814 * @param func The function to add to the list of providers
9815 * @param data User data that will be passed to the callback function
9817 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);
9819 * Remove a custom item provider from the list of the given anchorblock
9821 * Removes the function and data pairing that matches @p func and @p data.
9822 * That is, unless the same function and same user data are given, the
9823 * function will not be removed from the list. This allows us to add the
9824 * same callback several times, with different @p data pointers and be
9825 * able to remove them later without conflicts.
9827 * @param obj The anchorblock object
9828 * @param func The function to remove from the list
9829 * @param data The data matching the function to remove from the list
9831 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);
9837 * @defgroup Bubble Bubble
9839 * @image html img/widget/bubble/preview-00.png
9840 * @image latex img/widget/bubble/preview-00.eps
9841 * @image html img/widget/bubble/preview-01.png
9842 * @image latex img/widget/bubble/preview-01.eps
9843 * @image html img/widget/bubble/preview-02.png
9844 * @image latex img/widget/bubble/preview-02.eps
9846 * @brief The Bubble is a widget to show text similarly to how speech is
9847 * represented in comics.
9849 * The bubble widget contains 5 important visual elements:
9850 * @li The frame is a rectangle with rounded rectangles and an "arrow".
9851 * @li The @p icon is an image to which the frame's arrow points to.
9852 * @li The @p label is a text which appears to the right of the icon if the
9853 * corner is "top_left" or "bottom_left" and is right aligned to the frame
9855 * @li The @p info is a text which appears to the right of the label. Info's
9856 * font is of a ligther color than label.
9857 * @li The @p content is an evas object that is shown inside the frame.
9859 * The position of the arrow, icon, label and info depends on which corner is
9860 * selected. The four available corners are:
9861 * @li "top_left" - Default
9864 * @li "bottom_right"
9866 * Signals that you can add callbacks for are:
9867 * @li "clicked" - This is called when a user has clicked the bubble.
9869 * For an example of using a buble see @ref bubble_01_example_page "this".
9874 * Add a new bubble to the parent
9876 * @param parent The parent object
9877 * @return The new object or NULL if it cannot be created
9879 * This function adds a text bubble to the given parent evas object.
9881 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9883 * Set the label of the bubble
9885 * @param obj The bubble object
9886 * @param label The string to set in the label
9888 * This function sets the title of the bubble. Where this appears depends on
9889 * the selected corner.
9890 * @deprecated use elm_object_text_set() instead.
9892 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9894 * Get the label of the bubble
9896 * @param obj The bubble object
9897 * @return The string of set in the label
9899 * This function gets the title of the bubble.
9900 * @deprecated use elm_object_text_get() instead.
9902 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9904 * Set the info of the bubble
9906 * @param obj The bubble object
9907 * @param info The given info about the bubble
9909 * This function sets the info of the bubble. Where this appears depends on
9910 * the selected corner.
9911 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
9913 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
9915 * Get the info of the bubble
9917 * @param obj The bubble object
9919 * @return The "info" string of the bubble
9921 * This function gets the info text.
9922 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
9924 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9926 * Set the content to be shown in the bubble
9928 * Once the content object is set, a previously set one will be deleted.
9929 * If you want to keep the old content object, use the
9930 * elm_bubble_content_unset() function.
9932 * @param obj The bubble object
9933 * @param content The given content of the bubble
9935 * This function sets the content shown on the middle of the bubble.
9937 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9939 * Get the content shown in the bubble
9941 * Return the content object which is set for this widget.
9943 * @param obj The bubble object
9944 * @return The content that is being used
9946 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9948 * Unset the content shown in the bubble
9950 * Unparent and return the content object which was set for this widget.
9952 * @param obj The bubble object
9953 * @return The content that was being used
9955 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9957 * Set the icon of the bubble
9959 * Once the icon object is set, a previously set one will be deleted.
9960 * If you want to keep the old content object, use the
9961 * elm_icon_content_unset() function.
9963 * @param obj The bubble object
9964 * @param icon The given icon for the bubble
9966 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9968 * Get the icon of the bubble
9970 * @param obj The bubble object
9971 * @return The icon for the bubble
9973 * This function gets the icon shown on the top left of bubble.
9975 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9977 * Unset the icon of the bubble
9979 * Unparent and return the icon object which was set for this widget.
9981 * @param obj The bubble object
9982 * @return The icon that was being used
9984 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9986 * Set the corner of the bubble
9988 * @param obj The bubble object.
9989 * @param corner The given corner for the bubble.
9991 * This function sets the corner of the bubble. The corner will be used to
9992 * determine where the arrow in the frame points to and where label, icon and
9995 * Possible values for corner are:
9996 * @li "top_left" - Default
9999 * @li "bottom_right"
10001 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
10003 * Get the corner of the bubble
10005 * @param obj The bubble object.
10006 * @return The given corner for the bubble.
10008 * This function gets the selected corner of the bubble.
10010 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10016 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10017 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
10018 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
10019 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
10020 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
10021 /* smart callbacks called:
10022 * "clicked" - the user clicked the icon
10023 * "drag,start" - Someone started dragging the image out of the object
10024 * "drag,end" - Dragged item was dropped (somewhere)
10027 /* gesture layer */
10029 * @defgroup Elm_Gesture_Layer Gesture Layer
10030 * Gesture Layer Usage:
10032 * Use Gesture Layer to detect gestures.
10033 * The advantage is that you don't have to implement
10034 * gesture detection, just set callbacks of gesture state.
10035 * By using gesture layer we make standard interface.
10037 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
10038 * with a parent object parameter.
10039 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
10040 * call. Usually with same object as target (2nd parameter).
10042 * Now you need to tell gesture layer what gestures you follow.
10043 * This is done with @ref elm_gesture_layer_cb_set call.
10044 * By setting the callback you actually saying to gesture layer:
10045 * I would like to know when the gesture @ref Elm_Gesture_Types
10046 * switches to state @ref Elm_Gesture_State.
10048 * Next, you need to implement the actual action that follows the input
10049 * in your callback.
10051 * Note that if you like to stop being reported about a gesture, just set
10052 * all callbacks referring this gesture to NULL.
10053 * (again with @ref elm_gesture_layer_cb_set)
10055 * The information reported by gesture layer to your callback is depending
10056 * on @ref Elm_Gesture_Types:
10057 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
10058 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
10059 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
10061 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
10062 * @ref ELM_GESTURE_MOMENTUM.
10064 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
10065 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
10066 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
10067 * Note that we consider a flick as a line-gesture that should be completed
10068 * in flick-time-limit as defined in @ref Config.
10070 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
10072 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
10076 * @enum _Elm_Gesture_Types
10077 * Enum of supported gesture types.
10078 * @ingroup Elm_Gesture_Layer
10080 enum _Elm_Gesture_Types
10082 ELM_GESTURE_FIRST = 0,
10084 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
10085 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
10086 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
10087 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
10089 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
10091 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
10092 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
10094 ELM_GESTURE_ZOOM, /**< Zoom */
10095 ELM_GESTURE_ROTATE, /**< Rotate */
10101 * @typedef Elm_Gesture_Types
10102 * gesture types enum
10103 * @ingroup Elm_Gesture_Layer
10105 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
10108 * @enum _Elm_Gesture_State
10109 * Enum of gesture states.
10110 * @ingroup Elm_Gesture_Layer
10112 enum _Elm_Gesture_State
10114 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
10115 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
10116 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
10117 ELM_GESTURE_STATE_END, /**< Gesture completed */
10118 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
10122 * @typedef Elm_Gesture_State
10123 * gesture states enum
10124 * @ingroup Elm_Gesture_Layer
10126 typedef enum _Elm_Gesture_State Elm_Gesture_State;
10129 * @struct _Elm_Gesture_Taps_Info
10130 * Struct holds taps info for user
10131 * @ingroup Elm_Gesture_Layer
10133 struct _Elm_Gesture_Taps_Info
10135 Evas_Coord x, y; /**< Holds center point between fingers */
10136 unsigned int n; /**< Number of fingers tapped */
10137 unsigned int timestamp; /**< event timestamp */
10141 * @typedef Elm_Gesture_Taps_Info
10142 * holds taps info for user
10143 * @ingroup Elm_Gesture_Layer
10145 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
10148 * @struct _Elm_Gesture_Momentum_Info
10149 * Struct holds momentum info for user
10150 * x1 and y1 are not necessarily in sync
10151 * x1 holds x value of x direction starting point
10152 * and same holds for y1.
10153 * This is noticeable when doing V-shape movement
10154 * @ingroup Elm_Gesture_Layer
10156 struct _Elm_Gesture_Momentum_Info
10157 { /* Report line ends, timestamps, and momentum computed */
10158 Evas_Coord x1; /**< Final-swipe direction starting point on X */
10159 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
10160 Evas_Coord x2; /**< Final-swipe direction ending point on X */
10161 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
10163 unsigned int tx; /**< Timestamp of start of final x-swipe */
10164 unsigned int ty; /**< Timestamp of start of final y-swipe */
10166 Evas_Coord mx; /**< Momentum on X */
10167 Evas_Coord my; /**< Momentum on Y */
10171 * @typedef Elm_Gesture_Momentum_Info
10172 * holds momentum info for user
10173 * @ingroup Elm_Gesture_Layer
10175 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
10178 * @struct _Elm_Gesture_Line_Info
10179 * Struct holds line info for user
10180 * @ingroup Elm_Gesture_Layer
10182 struct _Elm_Gesture_Line_Info
10183 { /* Report line ends, timestamps, and momentum computed */
10184 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
10185 unsigned int n; /**< Number of fingers (lines) */
10186 /* FIXME should be radians, bot degrees */
10187 double angle; /**< Angle (direction) of lines */
10191 * @typedef Elm_Gesture_Line_Info
10192 * Holds line info for user
10193 * @ingroup Elm_Gesture_Layer
10195 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
10198 * @struct _Elm_Gesture_Zoom_Info
10199 * Struct holds zoom info for user
10200 * @ingroup Elm_Gesture_Layer
10202 struct _Elm_Gesture_Zoom_Info
10204 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10205 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10206 double zoom; /**< Zoom value: 1.0 means no zoom */
10207 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
10211 * @typedef Elm_Gesture_Zoom_Info
10212 * Holds zoom info for user
10213 * @ingroup Elm_Gesture_Layer
10215 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
10218 * @struct _Elm_Gesture_Rotate_Info
10219 * Struct holds rotation info for user
10220 * @ingroup Elm_Gesture_Layer
10222 struct _Elm_Gesture_Rotate_Info
10224 Evas_Coord x, y; /**< Holds zoom center point reported to user */
10225 Evas_Coord radius; /**< Holds radius between fingers reported to user */
10226 double base_angle; /**< Holds start-angle */
10227 double angle; /**< Rotation value: 0.0 means no rotation */
10228 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
10232 * @typedef Elm_Gesture_Rotate_Info
10233 * Holds rotation info for user
10234 * @ingroup Elm_Gesture_Layer
10236 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
10239 * @typedef Elm_Gesture_Event_Cb
10240 * User callback used to stream gesture info from gesture layer
10241 * @param data user data
10242 * @param event_info gesture report info
10243 * Returns a flag field to be applied on the causing event.
10244 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
10245 * upon the event, in an irreversible way.
10247 * @ingroup Elm_Gesture_Layer
10249 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
10252 * Use function to set callbacks to be notified about
10253 * change of state of gesture.
10254 * When a user registers a callback with this function
10255 * this means this gesture has to be tested.
10257 * When ALL callbacks for a gesture are set to NULL
10258 * it means user isn't interested in gesture-state
10259 * and it will not be tested.
10261 * @param obj Pointer to gesture-layer.
10262 * @param idx The gesture you would like to track its state.
10263 * @param cb callback function pointer.
10264 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
10265 * @param data user info to be sent to callback (usually, Smart Data)
10267 * @ingroup Elm_Gesture_Layer
10269 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);
10272 * Call this function to get repeat-events settings.
10274 * @param obj Pointer to gesture-layer.
10276 * @return repeat events settings.
10277 * @see elm_gesture_layer_hold_events_set()
10278 * @ingroup Elm_Gesture_Layer
10280 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
10283 * This function called in order to make gesture-layer repeat events.
10284 * Set this of you like to get the raw events only if gestures were not detected.
10285 * Clear this if you like gesture layer to fwd events as testing gestures.
10287 * @param obj Pointer to gesture-layer.
10288 * @param r Repeat: TRUE/FALSE
10290 * @ingroup Elm_Gesture_Layer
10292 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
10295 * This function sets step-value for zoom action.
10296 * Set step to any positive value.
10297 * Cancel step setting by setting to 0.0
10299 * @param obj Pointer to gesture-layer.
10300 * @param s new zoom step value.
10302 * @ingroup Elm_Gesture_Layer
10304 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10307 * This function sets step-value for rotate action.
10308 * Set step to any positive value.
10309 * Cancel step setting by setting to 0.0
10311 * @param obj Pointer to gesture-layer.
10312 * @param s new roatate step value.
10314 * @ingroup Elm_Gesture_Layer
10316 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
10319 * This function called to attach gesture-layer to an Evas_Object.
10320 * @param obj Pointer to gesture-layer.
10321 * @param t Pointer to underlying object (AKA Target)
10323 * @return TRUE, FALSE on success, failure.
10325 * @ingroup Elm_Gesture_Layer
10327 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
10330 * Call this function to construct a new gesture-layer object.
10331 * This does not activate the gesture layer. You have to
10332 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
10334 * @param parent the parent object.
10336 * @return Pointer to new gesture-layer object.
10338 * @ingroup Elm_Gesture_Layer
10340 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10343 * @defgroup Thumb Thumb
10345 * @image html img/widget/thumb/preview-00.png
10346 * @image latex img/widget/thumb/preview-00.eps
10348 * A thumb object is used for displaying the thumbnail of an image or video.
10349 * You must have compiled Elementary with Ethumb_Client support and the DBus
10350 * service must be present and auto-activated in order to have thumbnails to
10353 * Once the thumbnail object becomes visible, it will check if there is a
10354 * previously generated thumbnail image for the file set on it. If not, it
10355 * will start generating this thumbnail.
10357 * Different config settings will cause different thumbnails to be generated
10358 * even on the same file.
10360 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
10361 * Ethumb documentation to change this path, and to see other configuration
10364 * Signals that you can add callbacks for are:
10366 * - "clicked" - This is called when a user has clicked the thumb without dragging
10368 * - "clicked,double" - This is called when a user has double-clicked the thumb.
10369 * - "press" - This is called when a user has pressed down the thumb.
10370 * - "generate,start" - The thumbnail generation started.
10371 * - "generate,stop" - The generation process stopped.
10372 * - "generate,error" - The generation failed.
10373 * - "load,error" - The thumbnail image loading failed.
10375 * available styles:
10379 * An example of use of thumbnail:
10381 * - @ref thumb_example_01
10385 * @addtogroup Thumb
10390 * @enum _Elm_Thumb_Animation_Setting
10391 * @typedef Elm_Thumb_Animation_Setting
10393 * Used to set if a video thumbnail is animating or not.
10397 typedef enum _Elm_Thumb_Animation_Setting
10399 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
10400 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
10401 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
10402 ELM_THUMB_ANIMATION_LAST
10403 } Elm_Thumb_Animation_Setting;
10406 * Add a new thumb object to the parent.
10408 * @param parent The parent object.
10409 * @return The new object or NULL if it cannot be created.
10411 * @see elm_thumb_file_set()
10412 * @see elm_thumb_ethumb_client_get()
10416 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10418 * Reload thumbnail if it was generated before.
10420 * @param obj The thumb object to reload
10422 * This is useful if the ethumb client configuration changed, like its
10423 * size, aspect or any other property one set in the handle returned
10424 * by elm_thumb_ethumb_client_get().
10426 * If the options didn't change, the thumbnail won't be generated again, but
10427 * the old one will still be used.
10429 * @see elm_thumb_file_set()
10433 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
10435 * Set the file that will be used as thumbnail.
10437 * @param obj The thumb object.
10438 * @param file The path to file that will be used as thumb.
10439 * @param key The key used in case of an EET file.
10441 * The file can be an image or a video (in that case, acceptable extensions are:
10442 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
10443 * function elm_thumb_animate().
10445 * @see elm_thumb_file_get()
10446 * @see elm_thumb_reload()
10447 * @see elm_thumb_animate()
10451 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
10453 * Get the image or video path and key used to generate the thumbnail.
10455 * @param obj The thumb object.
10456 * @param file Pointer to filename.
10457 * @param key Pointer to key.
10459 * @see elm_thumb_file_set()
10460 * @see elm_thumb_path_get()
10464 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10466 * Get the path and key to the image or video generated by ethumb.
10468 * One just need to make sure that the thumbnail was generated before getting
10469 * its path; otherwise, the path will be NULL. One way to do that is by asking
10470 * for the path when/after the "generate,stop" smart callback is called.
10472 * @param obj The thumb object.
10473 * @param file Pointer to thumb path.
10474 * @param key Pointer to thumb key.
10476 * @see elm_thumb_file_get()
10480 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
10482 * Set the animation state for the thumb object. If its content is an animated
10483 * video, you may start/stop the animation or tell it to play continuously and
10486 * @param obj The thumb object.
10487 * @param setting The animation setting.
10489 * @see elm_thumb_file_set()
10493 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
10495 * Get the animation state for the thumb object.
10497 * @param obj The thumb object.
10498 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
10501 * @see elm_thumb_animate_set()
10505 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10507 * Get the ethumb_client handle so custom configuration can be made.
10509 * @return Ethumb_Client instance or NULL.
10511 * This must be called before the objects are created to be sure no object is
10512 * visible and no generation started.
10514 * Example of usage:
10517 * #include <Elementary.h>
10518 * #ifndef ELM_LIB_QUICKLAUNCH
10520 * elm_main(int argc, char **argv)
10522 * Ethumb_Client *client;
10524 * elm_need_ethumb();
10528 * client = elm_thumb_ethumb_client_get();
10531 * ERR("could not get ethumb_client");
10534 * ethumb_client_size_set(client, 100, 100);
10535 * ethumb_client_crop_align_set(client, 0.5, 0.5);
10538 * // Create elm_thumb objects here
10548 * @note There's only one client handle for Ethumb, so once a configuration
10549 * change is done to it, any other request for thumbnails (for any thumbnail
10550 * object) will use that configuration. Thus, this configuration is global.
10554 EAPI void *elm_thumb_ethumb_client_get(void);
10556 * Get the ethumb_client connection state.
10558 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
10561 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
10563 * Make the thumbnail 'editable'.
10565 * @param obj Thumb object.
10566 * @param set Turn on or off editability. Default is @c EINA_FALSE.
10568 * This means the thumbnail is a valid drag target for drag and drop, and can be
10569 * cut or pasted too.
10571 * @see elm_thumb_editable_get()
10575 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
10577 * Make the thumbnail 'editable'.
10579 * @param obj Thumb object.
10580 * @return Editability.
10582 * This means the thumbnail is a valid drag target for drag and drop, and can be
10583 * cut or pasted too.
10585 * @see elm_thumb_editable_set()
10589 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10596 * @defgroup Hoversel Hoversel
10598 * @image html img/widget/hoversel/preview-00.png
10599 * @image latex img/widget/hoversel/preview-00.eps
10601 * A hoversel is a button that pops up a list of items (automatically
10602 * choosing the direction to display) that have a label and, optionally, an
10603 * icon to select from. It is a convenience widget to avoid the need to do
10604 * all the piecing together yourself. It is intended for a small number of
10605 * items in the hoversel menu (no more than 8), though is capable of many
10608 * Signals that you can add callbacks for are:
10609 * "clicked" - the user clicked the hoversel button and popped up the sel
10610 * "selected" - an item in the hoversel list is selected. event_info is the item
10611 * "dismissed" - the hover is dismissed
10613 * See @ref tutorial_hoversel for an example.
10616 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
10618 * @brief Add a new Hoversel object
10620 * @param parent The parent object
10621 * @return The new object or NULL if it cannot be created
10623 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10625 * @brief This sets the hoversel to expand horizontally.
10627 * @param obj The hoversel object
10628 * @param horizontal If true, the hover will expand horizontally to the
10631 * @note The initial button will display horizontally regardless of this
10634 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
10636 * @brief This returns whether the hoversel is set to expand horizontally.
10638 * @param obj The hoversel object
10639 * @return If true, the hover will expand horizontally to the right.
10641 * @see elm_hoversel_horizontal_set()
10643 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10645 * @brief Set the Hover parent
10647 * @param obj The hoversel object
10648 * @param parent The parent to use
10650 * Sets the hover parent object, the area that will be darkened when the
10651 * hoversel is clicked. Should probably be the window that the hoversel is
10652 * in. See @ref Hover objects for more information.
10654 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10656 * @brief Get the Hover parent
10658 * @param obj The hoversel object
10659 * @return The used parent
10661 * Gets the hover parent object.
10663 * @see elm_hoversel_hover_parent_set()
10665 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10667 * @brief Set the hoversel button label
10669 * @param obj The hoversel object
10670 * @param label The label text.
10672 * This sets the label of the button that is always visible (before it is
10673 * clicked and expanded).
10675 * @deprecated elm_object_text_set()
10677 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
10679 * @brief Get the hoversel button label
10681 * @param obj The hoversel object
10682 * @return The label text.
10684 * @deprecated elm_object_text_get()
10686 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10688 * @brief Set the icon of the hoversel button
10690 * @param obj The hoversel object
10691 * @param icon The icon object
10693 * Sets the icon of the button that is always visible (before it is clicked
10694 * and expanded). Once the icon object is set, a previously set one will be
10695 * deleted, if you want to keep that old content object, use the
10696 * elm_hoversel_icon_unset() function.
10698 * @see elm_button_icon_set()
10700 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
10702 * @brief Get the icon of the hoversel button
10704 * @param obj The hoversel object
10705 * @return The icon object
10707 * Get the icon of the button that is always visible (before it is clicked
10708 * and expanded). Also see elm_button_icon_get().
10710 * @see elm_hoversel_icon_set()
10712 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10714 * @brief Get and unparent the icon of the hoversel button
10716 * @param obj The hoversel object
10717 * @return The icon object that was being used
10719 * Unparent and return the icon of the button that is always visible
10720 * (before it is clicked and expanded).
10722 * @see elm_hoversel_icon_set()
10723 * @see elm_button_icon_unset()
10725 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10727 * @brief This triggers the hoversel popup from code, the same as if the user
10728 * had clicked the button.
10730 * @param obj The hoversel object
10732 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10734 * @brief This dismisses the hoversel popup as if the user had clicked
10735 * outside the hover.
10737 * @param obj The hoversel object
10739 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10741 * @brief Returns whether the hoversel is expanded.
10743 * @param obj The hoversel object
10744 * @return This will return EINA_TRUE if the hoversel is expanded or
10745 * EINA_FALSE if it is not expanded.
10747 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10749 * @brief This will remove all the children items from the hoversel.
10751 * @param obj The hoversel object
10753 * @warning Should @b not be called while the hoversel is active; use
10754 * elm_hoversel_expanded_get() to check first.
10756 * @see elm_hoversel_item_del_cb_set()
10757 * @see elm_hoversel_item_del()
10759 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10761 * @brief Get the list of items within the given hoversel.
10763 * @param obj The hoversel object
10764 * @return Returns a list of Elm_Hoversel_Item*
10766 * @see elm_hoversel_item_add()
10768 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10770 * @brief Add an item to the hoversel button
10772 * @param obj The hoversel object
10773 * @param label The text label to use for the item (NULL if not desired)
10774 * @param icon_file An image file path on disk to use for the icon or standard
10775 * icon name (NULL if not desired)
10776 * @param icon_type The icon type if relevant
10777 * @param func Convenience function to call when this item is selected
10778 * @param data Data to pass to item-related functions
10779 * @return A handle to the item added.
10781 * This adds an item to the hoversel to show when it is clicked. Note: if you
10782 * need to use an icon from an edje file then use
10783 * elm_hoversel_item_icon_set() right after the this function, and set
10784 * icon_file to NULL here.
10786 * For more information on what @p icon_file and @p icon_type are see the
10787 * @ref Icon "icon documentation".
10789 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);
10791 * @brief Delete an item from the hoversel
10793 * @param item The item to delete
10795 * This deletes the item from the hoversel (should not be called while the
10796 * hoversel is active; use elm_hoversel_expanded_get() to check first).
10798 * @see elm_hoversel_item_add()
10799 * @see elm_hoversel_item_del_cb_set()
10801 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
10803 * @brief Set the function to be called when an item from the hoversel is
10806 * @param item The item to set the callback on
10807 * @param func The function called
10809 * That function will receive these parameters:
10810 * @li void *item_data
10811 * @li Evas_Object *the_item_object
10812 * @li Elm_Hoversel_Item *the_object_struct
10814 * @see elm_hoversel_item_add()
10816 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
10818 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
10819 * that will be passed to associated function callbacks.
10821 * @param item The item to get the data from
10822 * @return The data pointer set with elm_hoversel_item_add()
10824 * @see elm_hoversel_item_add()
10826 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10828 * @brief This returns the label text of the given hoversel item.
10830 * @param item The item to get the label
10831 * @return The label text of the hoversel item
10833 * @see elm_hoversel_item_add()
10835 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
10837 * @brief This sets the icon for the given hoversel item.
10839 * @param item The item to set the icon
10840 * @param icon_file An image file path on disk to use for the icon or standard
10842 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
10843 * to NULL if the icon is not an edje file
10844 * @param icon_type The icon type
10846 * The icon can be loaded from the standard set, from an image file, or from
10849 * @see elm_hoversel_item_add()
10851 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);
10853 * @brief Get the icon object of the hoversel item
10855 * @param item The item to get the icon from
10856 * @param icon_file The image file path on disk used for the icon or standard
10858 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
10859 * if the icon is not an edje file
10860 * @param icon_type The icon type
10862 * @see elm_hoversel_item_icon_set()
10863 * @see elm_hoversel_item_add()
10865 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);
10871 * @defgroup Toolbar Toolbar
10872 * @ingroup Elementary
10874 * @image html img/widget/toolbar/preview-00.png
10875 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
10877 * @image html img/toolbar.png
10878 * @image latex img/toolbar.eps width=\textwidth
10880 * A toolbar is a widget that displays a list of items inside
10881 * a box. It can be scrollable, show a menu with items that don't fit
10882 * to toolbar size or even crop them.
10884 * Only one item can be selected at a time.
10886 * Items can have multiple states, or show menus when selected by the user.
10888 * Smart callbacks one can listen to:
10889 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
10891 * Available styles for it:
10893 * - @c "transparent" - no background or shadow, just show the content
10895 * List of examples:
10896 * @li @ref toolbar_example_01
10897 * @li @ref toolbar_example_02
10898 * @li @ref toolbar_example_03
10902 * @addtogroup Toolbar
10907 * @enum _Elm_Toolbar_Shrink_Mode
10908 * @typedef Elm_Toolbar_Shrink_Mode
10910 * Set toolbar's items display behavior, it can be scrollabel,
10911 * show a menu with exceeding items, or simply hide them.
10913 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
10916 * Values <b> don't </b> work as bitmask, only one can be choosen.
10918 * @see elm_toolbar_mode_shrink_set()
10919 * @see elm_toolbar_mode_shrink_get()
10923 typedef enum _Elm_Toolbar_Shrink_Mode
10925 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
10926 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
10927 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
10928 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
10929 } Elm_Toolbar_Shrink_Mode;
10931 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(). */
10933 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(). */
10936 * Add a new toolbar widget to the given parent Elementary
10937 * (container) object.
10939 * @param parent The parent object.
10940 * @return a new toolbar widget handle or @c NULL, on errors.
10942 * This function inserts a new toolbar widget on the canvas.
10946 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10949 * Set the icon size, in pixels, to be used by toolbar items.
10951 * @param obj The toolbar object
10952 * @param icon_size The icon size in pixels
10954 * @note Default value is @c 32. It reads value from elm config.
10956 * @see elm_toolbar_icon_size_get()
10960 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
10963 * Get the icon size, in pixels, to be used by toolbar items.
10965 * @param obj The toolbar object.
10966 * @return The icon size in pixels.
10968 * @see elm_toolbar_icon_size_set() for details.
10972 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10975 * Sets icon lookup order, for toolbar items' icons.
10977 * @param obj The toolbar object.
10978 * @param order The icon lookup order.
10980 * Icons added before calling this function will not be affected.
10981 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
10983 * @see elm_toolbar_icon_order_lookup_get()
10987 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
10990 * Gets the icon lookup order.
10992 * @param obj The toolbar object.
10993 * @return The icon lookup order.
10995 * @see elm_toolbar_icon_order_lookup_set() for details.
10999 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11002 * Set whether the toolbar items' should be selected by the user or not.
11004 * @param obj The toolbar object.
11005 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
11008 * This will turn off the ability to select items entirely and they will
11009 * neither appear selected nor emit selected signals. The clicked
11010 * callback function will still be called.
11012 * Selection is enabled by default.
11014 * @see elm_toolbar_no_select_mode_get().
11018 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
11021 * Set whether the toolbar items' should be selected by the user or not.
11023 * @param obj The toolbar object.
11024 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
11025 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
11027 * @see elm_toolbar_no_select_mode_set() for details.
11031 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11034 * Append item to the toolbar.
11036 * @param obj The toolbar object.
11037 * @param icon A string with icon name or the absolute path of an image file.
11038 * @param label The label of the item.
11039 * @param func The function to call when the item is clicked.
11040 * @param data The data to associate with the item for related callbacks.
11041 * @return The created item or @c NULL upon failure.
11043 * A new item will be created and appended to the toolbar, i.e., will
11044 * be set as @b last item.
11046 * Items created with this method can be deleted with
11047 * elm_toolbar_item_del().
11049 * Associated @p data can be properly freed when item is deleted if a
11050 * callback function is set with elm_toolbar_item_del_cb_set().
11052 * If a function is passed as argument, it will be called everytime this item
11053 * is selected, i.e., the user clicks over an unselected item.
11054 * If such function isn't needed, just passing
11055 * @c NULL as @p func is enough. The same should be done for @p data.
11057 * Toolbar will load icon image from fdo or current theme.
11058 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11059 * If an absolute path is provided it will load it direct from a file.
11061 * @see elm_toolbar_item_icon_set()
11062 * @see elm_toolbar_item_del()
11063 * @see elm_toolbar_item_del_cb_set()
11067 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);
11070 * Prepend item to the toolbar.
11072 * @param obj The toolbar object.
11073 * @param icon A string with icon name or the absolute path of an image file.
11074 * @param label The label of the item.
11075 * @param func The function to call when the item is clicked.
11076 * @param data The data to associate with the item for related callbacks.
11077 * @return The created item or @c NULL upon failure.
11079 * A new item will be created and prepended to the toolbar, i.e., will
11080 * be set as @b first item.
11082 * Items created with this method can be deleted with
11083 * elm_toolbar_item_del().
11085 * Associated @p data can be properly freed when item is deleted if a
11086 * callback function is set with elm_toolbar_item_del_cb_set().
11088 * If a function is passed as argument, it will be called everytime this item
11089 * is selected, i.e., the user clicks over an unselected item.
11090 * If such function isn't needed, just passing
11091 * @c NULL as @p func is enough. The same should be done for @p data.
11093 * Toolbar will load icon image from fdo or current theme.
11094 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11095 * If an absolute path is provided it will load it direct from a file.
11097 * @see elm_toolbar_item_icon_set()
11098 * @see elm_toolbar_item_del()
11099 * @see elm_toolbar_item_del_cb_set()
11103 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);
11106 * Insert a new item into the toolbar object before item @p before.
11108 * @param obj The toolbar object.
11109 * @param before The toolbar item to insert before.
11110 * @param icon A string with icon name or the absolute path of an image file.
11111 * @param label The label of the item.
11112 * @param func The function to call when the item is clicked.
11113 * @param data The data to associate with the item for related callbacks.
11114 * @return The created item or @c NULL upon failure.
11116 * A new item will be created and added to the toolbar. Its position in
11117 * this toolbar will be just before item @p before.
11119 * Items created with this method can be deleted with
11120 * elm_toolbar_item_del().
11122 * Associated @p data can be properly freed when item is deleted if a
11123 * callback function is set with elm_toolbar_item_del_cb_set().
11125 * If a function is passed as argument, it will be called everytime this item
11126 * is selected, i.e., the user clicks over an unselected item.
11127 * If such function isn't needed, just passing
11128 * @c NULL as @p func is enough. The same should be done for @p data.
11130 * Toolbar will load icon image from fdo or current theme.
11131 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11132 * If an absolute path is provided it will load it direct from a file.
11134 * @see elm_toolbar_item_icon_set()
11135 * @see elm_toolbar_item_del()
11136 * @see elm_toolbar_item_del_cb_set()
11140 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);
11143 * Insert a new item into the toolbar object after item @p after.
11145 * @param obj The toolbar object.
11146 * @param before The toolbar item to insert before.
11147 * @param icon A string with icon name or the absolute path of an image file.
11148 * @param label The label of the item.
11149 * @param func The function to call when the item is clicked.
11150 * @param data The data to associate with the item for related callbacks.
11151 * @return The created item or @c NULL upon failure.
11153 * A new item will be created and added to the toolbar. Its position in
11154 * this toolbar will be just after item @p after.
11156 * Items created with this method can be deleted with
11157 * elm_toolbar_item_del().
11159 * Associated @p data can be properly freed when item is deleted if a
11160 * callback function is set with elm_toolbar_item_del_cb_set().
11162 * If a function is passed as argument, it will be called everytime this item
11163 * is selected, i.e., the user clicks over an unselected item.
11164 * If such function isn't needed, just passing
11165 * @c NULL as @p func is enough. The same should be done for @p data.
11167 * Toolbar will load icon image from fdo or current theme.
11168 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11169 * If an absolute path is provided it will load it direct from a file.
11171 * @see elm_toolbar_item_icon_set()
11172 * @see elm_toolbar_item_del()
11173 * @see elm_toolbar_item_del_cb_set()
11177 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);
11180 * Get the first item in the given toolbar widget's list of
11183 * @param obj The toolbar object
11184 * @return The first item or @c NULL, if it has no items (and on
11187 * @see elm_toolbar_item_append()
11188 * @see elm_toolbar_last_item_get()
11192 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11195 * Get the last item in the given toolbar widget's list of
11198 * @param obj The toolbar object
11199 * @return The last item or @c NULL, if it has no items (and on
11202 * @see elm_toolbar_item_prepend()
11203 * @see elm_toolbar_first_item_get()
11207 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11210 * Get the item after @p item in toolbar.
11212 * @param item The toolbar item.
11213 * @return The item after @p item, or @c NULL if none or on failure.
11215 * @note If it is the last item, @c NULL will be returned.
11217 * @see elm_toolbar_item_append()
11221 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11224 * Get the item before @p item in toolbar.
11226 * @param item The toolbar item.
11227 * @return The item before @p item, or @c NULL if none or on failure.
11229 * @note If it is the first item, @c NULL will be returned.
11231 * @see elm_toolbar_item_prepend()
11235 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11238 * Get the toolbar object from an item.
11240 * @param item The item.
11241 * @return The toolbar object.
11243 * This returns the toolbar object itself that an item belongs to.
11247 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11250 * Set the priority of a toolbar item.
11252 * @param item The toolbar item.
11253 * @param priority The item priority. The default is zero.
11255 * This is used only when the toolbar shrink mode is set to
11256 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
11257 * When space is less than required, items with low priority
11258 * will be removed from the toolbar and added to a dynamically-created menu,
11259 * while items with higher priority will remain on the toolbar,
11260 * with the same order they were added.
11262 * @see elm_toolbar_item_priority_get()
11266 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
11269 * Get the priority of a toolbar item.
11271 * @param item The toolbar item.
11272 * @return The @p item priority, or @c 0 on failure.
11274 * @see elm_toolbar_item_priority_set() for details.
11278 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11281 * Get the label of item.
11283 * @param item The item of toolbar.
11284 * @return The label of item.
11286 * The return value is a pointer to the label associated to @p item when
11287 * it was created, with function elm_toolbar_item_append() or similar,
11289 * with function elm_toolbar_item_label_set. If no label
11290 * was passed as argument, it will return @c NULL.
11292 * @see elm_toolbar_item_label_set() for more details.
11293 * @see elm_toolbar_item_append()
11297 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11300 * Set the label of item.
11302 * @param item The item of toolbar.
11303 * @param text The label of item.
11305 * The label to be displayed by the item.
11306 * Label will be placed at icons bottom (if set).
11308 * If a label was passed as argument on item creation, with function
11309 * elm_toolbar_item_append() or similar, it will be already
11310 * displayed by the item.
11312 * @see elm_toolbar_item_label_get()
11313 * @see elm_toolbar_item_append()
11317 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
11320 * Return the data associated with a given toolbar widget item.
11322 * @param item The toolbar widget item handle.
11323 * @return The data associated with @p item.
11325 * @see elm_toolbar_item_data_set()
11329 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11332 * Set the data associated with a given toolbar widget item.
11334 * @param item The toolbar widget item handle.
11335 * @param data The new data pointer to set to @p item.
11337 * This sets new item data on @p item.
11339 * @warning The old data pointer won't be touched by this function, so
11340 * the user had better to free that old data himself/herself.
11344 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
11347 * Returns a pointer to a toolbar item by its label.
11349 * @param obj The toolbar object.
11350 * @param label The label of the item to find.
11352 * @return The pointer to the toolbar item matching @p label or @c NULL
11357 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11360 * Get whether the @p item is selected or not.
11362 * @param item The toolbar item.
11363 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
11364 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
11366 * @see elm_toolbar_selected_item_set() for details.
11367 * @see elm_toolbar_item_selected_get()
11371 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11374 * Set the selected state of an item.
11376 * @param item The toolbar item
11377 * @param selected The selected state
11379 * This sets the selected state of the given item @p it.
11380 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
11382 * If a new item is selected the previosly selected will be unselected.
11383 * Previoulsy selected item can be get with function
11384 * elm_toolbar_selected_item_get().
11386 * Selected items will be highlighted.
11388 * @see elm_toolbar_item_selected_get()
11389 * @see elm_toolbar_selected_item_get()
11393 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
11396 * Get the selected item.
11398 * @param obj The toolbar object.
11399 * @return The selected toolbar item.
11401 * The selected item can be unselected with function
11402 * elm_toolbar_item_selected_set().
11404 * The selected item always will be highlighted on toolbar.
11406 * @see elm_toolbar_selected_items_get()
11410 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11413 * Set the icon associated with @p item.
11415 * @param obj The parent of this item.
11416 * @param item The toolbar item.
11417 * @param icon A string with icon name or the absolute path of an image file.
11419 * Toolbar will load icon image from fdo or current theme.
11420 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11421 * If an absolute path is provided it will load it direct from a file.
11423 * @see elm_toolbar_icon_order_lookup_set()
11424 * @see elm_toolbar_icon_order_lookup_get()
11428 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
11431 * Get the string used to set the icon of @p item.
11433 * @param item The toolbar item.
11434 * @return The string associated with the icon object.
11436 * @see elm_toolbar_item_icon_set() for details.
11440 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11443 * Delete them item from the toolbar.
11445 * @param item The item of toolbar to be deleted.
11447 * @see elm_toolbar_item_append()
11448 * @see elm_toolbar_item_del_cb_set()
11452 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11455 * Set the function called when a toolbar item is freed.
11457 * @param item The item to set the callback on.
11458 * @param func The function called.
11460 * If there is a @p func, then it will be called prior item's memory release.
11461 * That will be called with the following arguments:
11463 * @li item's Evas object;
11466 * This way, a data associated to a toolbar item could be properly freed.
11470 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
11473 * Get a value whether toolbar item is disabled or not.
11475 * @param item The item.
11476 * @return The disabled state.
11478 * @see elm_toolbar_item_disabled_set() for more details.
11482 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11485 * Sets the disabled/enabled state of a toolbar item.
11487 * @param item The item.
11488 * @param disabled The disabled state.
11490 * A disabled item cannot be selected or unselected. It will also
11491 * change its appearance (generally greyed out). This sets the
11492 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
11497 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11500 * Set or unset item as a separator.
11502 * @param item The toolbar item.
11503 * @param setting @c EINA_TRUE to set item @p item as separator or
11504 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
11506 * Items aren't set as separator by default.
11508 * If set as separator it will display separator theme, so won't display
11511 * @see elm_toolbar_item_separator_get()
11515 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
11518 * Get a value whether item is a separator or not.
11520 * @param item The toolbar item.
11521 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
11522 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
11524 * @see elm_toolbar_item_separator_set() for details.
11528 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11531 * Set the shrink state of toolbar @p obj.
11533 * @param obj The toolbar object.
11534 * @param shrink_mode Toolbar's items display behavior.
11536 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
11537 * but will enforce a minimun size so all the items will fit, won't scroll
11538 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
11539 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
11540 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
11544 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
11547 * Get the shrink mode of toolbar @p obj.
11549 * @param obj The toolbar object.
11550 * @return Toolbar's items display behavior.
11552 * @see elm_toolbar_mode_shrink_set() for details.
11556 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11559 * Enable/disable homogenous mode.
11561 * @param obj The toolbar object
11562 * @param homogeneous Assume the items within the toolbar are of the
11563 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11565 * This will enable the homogeneous mode where items are of the same size.
11566 * @see elm_toolbar_homogeneous_get()
11570 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
11573 * Get whether the homogenous mode is enabled.
11575 * @param obj The toolbar object.
11576 * @return Assume the items within the toolbar are of the same height
11577 * and width (EINA_TRUE = on, EINA_FALSE = off).
11579 * @see elm_toolbar_homogeneous_set()
11583 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11586 * Enable/disable homogenous mode.
11588 * @param obj The toolbar object
11589 * @param homogeneous Assume the items within the toolbar are of the
11590 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
11592 * This will enable the homogeneous mode where items are of the same size.
11593 * @see elm_toolbar_homogeneous_get()
11595 * @deprecated use elm_toolbar_homogeneous_set() instead.
11599 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
11602 * Get whether the homogenous mode is enabled.
11604 * @param obj The toolbar object.
11605 * @return Assume the items within the toolbar are of the same height
11606 * and width (EINA_TRUE = on, EINA_FALSE = off).
11608 * @see elm_toolbar_homogeneous_set()
11609 * @deprecated use elm_toolbar_homogeneous_get() instead.
11613 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11616 * Set the parent object of the toolbar items' menus.
11618 * @param obj The toolbar object.
11619 * @param parent The parent of the menu objects.
11621 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
11623 * For more details about setting the parent for toolbar menus, see
11624 * elm_menu_parent_set().
11626 * @see elm_menu_parent_set() for details.
11627 * @see elm_toolbar_item_menu_set() for details.
11631 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11634 * Get the parent object of the toolbar items' menus.
11636 * @param obj The toolbar object.
11637 * @return The parent of the menu objects.
11639 * @see elm_toolbar_menu_parent_set() for details.
11643 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11646 * Set the alignment of the items.
11648 * @param obj The toolbar object.
11649 * @param align The new alignment, a float between <tt> 0.0 </tt>
11650 * and <tt> 1.0 </tt>.
11652 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
11653 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
11656 * Centered items by default.
11658 * @see elm_toolbar_align_get()
11662 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
11665 * Get the alignment of the items.
11667 * @param obj The toolbar object.
11668 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
11671 * @see elm_toolbar_align_set() for details.
11675 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11678 * Set whether the toolbar item opens a menu.
11680 * @param item The toolbar item.
11681 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
11683 * A toolbar item can be set to be a menu, using this function.
11685 * Once it is set to be a menu, it can be manipulated through the
11686 * menu-like function elm_toolbar_menu_parent_set() and the other
11687 * elm_menu functions, using the Evas_Object @c menu returned by
11688 * elm_toolbar_item_menu_get().
11690 * So, items to be displayed in this item's menu should be added with
11691 * elm_menu_item_add().
11693 * The following code exemplifies the most basic usage:
11695 * tb = elm_toolbar_add(win)
11696 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
11697 * elm_toolbar_item_menu_set(item, EINA_TRUE);
11698 * elm_toolbar_menu_parent_set(tb, win);
11699 * menu = elm_toolbar_item_menu_get(item);
11700 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
11701 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
11705 * @see elm_toolbar_item_menu_get()
11709 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
11712 * Get toolbar item's menu.
11714 * @param item The toolbar item.
11715 * @return Item's menu object or @c NULL on failure.
11717 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
11718 * this function will set it.
11720 * @see elm_toolbar_item_menu_set() for details.
11724 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11727 * Add a new state to @p item.
11729 * @param item The item.
11730 * @param icon A string with icon name or the absolute path of an image file.
11731 * @param label The label of the new state.
11732 * @param func The function to call when the item is clicked when this
11733 * state is selected.
11734 * @param data The data to associate with the state.
11735 * @return The toolbar item state, or @c NULL upon failure.
11737 * Toolbar will load icon image from fdo or current theme.
11738 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
11739 * If an absolute path is provided it will load it direct from a file.
11741 * States created with this function can be removed with
11742 * elm_toolbar_item_state_del().
11744 * @see elm_toolbar_item_state_del()
11745 * @see elm_toolbar_item_state_sel()
11746 * @see elm_toolbar_item_state_get()
11750 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);
11753 * Delete a previoulsy added state to @p item.
11755 * @param item The toolbar item.
11756 * @param state The state to be deleted.
11757 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11759 * @see elm_toolbar_item_state_add()
11761 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11764 * Set @p state as the current state of @p it.
11766 * @param it The item.
11767 * @param state The state to use.
11768 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
11770 * If @p state is @c NULL, it won't select any state and the default item's
11771 * icon and label will be used. It's the same behaviour than
11772 * elm_toolbar_item_state_unser().
11774 * @see elm_toolbar_item_state_unset()
11778 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
11781 * Unset the state of @p it.
11783 * @param it The item.
11785 * The default icon and label from this item will be displayed.
11787 * @see elm_toolbar_item_state_set() for more details.
11791 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11794 * Get the current state of @p it.
11796 * @param item The item.
11797 * @return The selected state or @c NULL if none is selected or on failure.
11799 * @see elm_toolbar_item_state_set() for details.
11800 * @see elm_toolbar_item_state_unset()
11801 * @see elm_toolbar_item_state_add()
11805 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11808 * Get the state after selected state in toolbar's @p item.
11810 * @param it The toolbar item to change state.
11811 * @return The state after current state, or @c NULL on failure.
11813 * If last state is selected, this function will return first state.
11815 * @see elm_toolbar_item_state_set()
11816 * @see elm_toolbar_item_state_add()
11820 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11823 * Get the state before selected state in toolbar's @p item.
11825 * @param it The toolbar item to change state.
11826 * @return The state before current state, or @c NULL on failure.
11828 * If first state is selected, this function will return last state.
11830 * @see elm_toolbar_item_state_set()
11831 * @see elm_toolbar_item_state_add()
11835 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
11838 * Set the text to be shown in a given toolbar item's tooltips.
11840 * @param item Target item.
11841 * @param text The text to set in the content.
11843 * Setup the text as tooltip to object. The item can have only one tooltip,
11844 * so any previous tooltip data - set with this function or
11845 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
11847 * @see elm_object_tooltip_text_set() for more details.
11851 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
11854 * Set the content to be shown in the tooltip item.
11856 * Setup the tooltip to item. The item can have only one tooltip,
11857 * so any previous tooltip data is removed. @p func(with @p data) will
11858 * be called every time that need show the tooltip and it should
11859 * return a valid Evas_Object. This object is then managed fully by
11860 * tooltip system and is deleted when the tooltip is gone.
11862 * @param item the toolbar item being attached a tooltip.
11863 * @param func the function used to create the tooltip contents.
11864 * @param data what to provide to @a func as callback data/context.
11865 * @param del_cb called when data is not needed anymore, either when
11866 * another callback replaces @a func, the tooltip is unset with
11867 * elm_toolbar_item_tooltip_unset() or the owner @a item
11868 * dies. This callback receives as the first parameter the
11869 * given @a data, and @c event_info is the item.
11871 * @see elm_object_tooltip_content_cb_set() for more details.
11875 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);
11878 * Unset tooltip from item.
11880 * @param item toolbar item to remove previously set tooltip.
11882 * Remove tooltip from item. The callback provided as del_cb to
11883 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
11884 * it is not used anymore.
11886 * @see elm_object_tooltip_unset() for more details.
11887 * @see elm_toolbar_item_tooltip_content_cb_set()
11891 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11894 * Sets a different style for this item tooltip.
11896 * @note before you set a style you should define a tooltip with
11897 * elm_toolbar_item_tooltip_content_cb_set() or
11898 * elm_toolbar_item_tooltip_text_set()
11900 * @param item toolbar item with tooltip already set.
11901 * @param style the theme style to use (default, transparent, ...)
11903 * @see elm_object_tooltip_style_set() for more details.
11907 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
11910 * Get the style for this item tooltip.
11912 * @param item toolbar item with tooltip already set.
11913 * @return style the theme style in use, defaults to "default". If the
11914 * object does not have a tooltip set, then NULL is returned.
11916 * @see elm_object_tooltip_style_get() for more details.
11917 * @see elm_toolbar_item_tooltip_style_set()
11921 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11924 * Set the type of mouse pointer/cursor decoration to be shown,
11925 * when the mouse pointer is over the given toolbar widget item
11927 * @param item toolbar item to customize cursor on
11928 * @param cursor the cursor type's name
11930 * This function works analogously as elm_object_cursor_set(), but
11931 * here the cursor's changing area is restricted to the item's
11932 * area, and not the whole widget's. Note that that item cursors
11933 * have precedence over widget cursors, so that a mouse over an
11934 * item with custom cursor set will always show @b that cursor.
11936 * If this function is called twice for an object, a previously set
11937 * cursor will be unset on the second call.
11939 * @see elm_object_cursor_set()
11940 * @see elm_toolbar_item_cursor_get()
11941 * @see elm_toolbar_item_cursor_unset()
11945 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
11948 * Get the type of mouse pointer/cursor decoration set to be shown,
11949 * when the mouse pointer is over the given toolbar widget item
11951 * @param item toolbar item with custom cursor set
11952 * @return the cursor type's name or @c NULL, if no custom cursors
11953 * were set to @p item (and on errors)
11955 * @see elm_object_cursor_get()
11956 * @see elm_toolbar_item_cursor_set()
11957 * @see elm_toolbar_item_cursor_unset()
11961 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11964 * Unset any custom mouse pointer/cursor decoration set to be
11965 * shown, when the mouse pointer is over the given toolbar widget
11966 * item, thus making it show the @b default cursor again.
11968 * @param item a toolbar item
11970 * Use this call to undo any custom settings on this item's cursor
11971 * decoration, bringing it back to defaults (no custom style set).
11973 * @see elm_object_cursor_unset()
11974 * @see elm_toolbar_item_cursor_set()
11978 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
11981 * Set a different @b style for a given custom cursor set for a
11984 * @param item toolbar item with custom cursor set
11985 * @param style the <b>theme style</b> to use (e.g. @c "default",
11986 * @c "transparent", etc)
11988 * This function only makes sense when one is using custom mouse
11989 * cursor decorations <b>defined in a theme file</b>, which can have,
11990 * given a cursor name/type, <b>alternate styles</b> on it. It
11991 * works analogously as elm_object_cursor_style_set(), but here
11992 * applyed only to toolbar item objects.
11994 * @warning Before you set a cursor style you should have definen a
11995 * custom cursor previously on the item, with
11996 * elm_toolbar_item_cursor_set()
11998 * @see elm_toolbar_item_cursor_engine_only_set()
11999 * @see elm_toolbar_item_cursor_style_get()
12003 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
12006 * Get the current @b style set for a given toolbar item's custom
12009 * @param item toolbar item with custom cursor set.
12010 * @return style the cursor style in use. If the object does not
12011 * have a cursor set, then @c NULL is returned.
12013 * @see elm_toolbar_item_cursor_style_set() for more details
12017 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12020 * Set if the (custom)cursor for a given toolbar item should be
12021 * searched in its theme, also, or should only rely on the
12022 * rendering engine.
12024 * @param item item with custom (custom) cursor already set on
12025 * @param engine_only Use @c EINA_TRUE to have cursors looked for
12026 * only on those provided by the rendering engine, @c EINA_FALSE to
12027 * have them searched on the widget's theme, as well.
12029 * @note This call is of use only if you've set a custom cursor
12030 * for toolbar items, with elm_toolbar_item_cursor_set().
12032 * @note By default, cursors will only be looked for between those
12033 * provided by the rendering engine.
12037 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12040 * Get if the (custom) cursor for a given toolbar item is being
12041 * searched in its theme, also, or is only relying on the rendering
12044 * @param item a toolbar item
12045 * @return @c EINA_TRUE, if cursors are being looked for only on
12046 * those provided by the rendering engine, @c EINA_FALSE if they
12047 * are being searched on the widget's theme, as well.
12049 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
12053 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12056 * Change a toolbar's orientation
12057 * @param obj The toolbar object
12058 * @param vertical If @c EINA_TRUE, the toolbar is vertical
12059 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
12062 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
12065 * Get a toolbar's orientation
12066 * @param obj The toolbar object
12067 * @return If @c EINA_TRUE, the toolbar is vertical
12068 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
12071 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12078 EAPI double elm_tooltip_delay_get(void);
12079 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
12080 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
12081 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
12082 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
12083 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);
12084 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12085 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12086 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12087 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
12088 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12089 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12090 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12091 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12092 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
12093 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12094 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
12095 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
12098 EAPI int elm_cursor_engine_only_get(void);
12099 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
12102 * @defgroup Menu Menu
12104 * @image html img/widget/menu/preview-00.png
12105 * @image latex img/widget/menu/preview-00.eps
12107 * A menu is a list of items displayed above its parent. When the menu is
12108 * showing its parent is darkened. Each item can have a sub-menu. The menu
12109 * object can be used to display a menu on a right click event, in a toolbar,
12112 * Signals that you can add callbacks for are:
12113 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
12114 * event_info is NULL.
12116 * @see @ref tutorial_menu
12119 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
12121 * @brief Add a new menu to the parent
12123 * @param parent The parent object.
12124 * @return The new object or NULL if it cannot be created.
12126 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12128 * @brief Set the parent for the given menu widget
12130 * @param obj The menu object.
12131 * @param parent The new parent.
12133 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12135 * @brief Get the parent for the given menu widget
12137 * @param obj The menu object.
12138 * @return The parent.
12140 * @see elm_menu_parent_set()
12142 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12144 * @brief Move the menu to a new position
12146 * @param obj The menu object.
12147 * @param x The new position.
12148 * @param y The new position.
12150 * Sets the top-left position of the menu to (@p x,@p y).
12152 * @note @p x and @p y coordinates are relative to parent.
12154 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
12156 * @brief Close a opened menu
12158 * @param obj the menu object
12161 * Hides the menu and all it's sub-menus.
12163 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
12165 * @brief Returns a list of @p item's items.
12167 * @param obj The menu object
12168 * @return An Eina_List* of @p item's items
12170 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12172 * @brief Get the Evas_Object of an Elm_Menu_Item
12174 * @param item The menu item object.
12175 * @return The edje object containing the swallowed content
12177 * @warning Don't manipulate this object!
12179 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12181 * @brief Add an item at the end of the given menu widget
12183 * @param obj The menu object.
12184 * @param parent The parent menu item (optional)
12185 * @param icon A icon display on the item. The icon will be destryed by the menu.
12186 * @param label The label of the item.
12187 * @param func Function called when the user select the item.
12188 * @param data Data sent by the callback.
12189 * @return Returns the new item.
12191 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);
12193 * @brief Add an object swallowed in an item at the end of the given menu
12196 * @param obj The menu object.
12197 * @param parent The parent menu item (optional)
12198 * @param subobj The object to swallow
12199 * @param func Function called when the user select the item.
12200 * @param data Data sent by the callback.
12201 * @return Returns the new item.
12203 * Add an evas object as an item to the menu.
12205 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);
12207 * @brief Set the label of a menu item
12209 * @param item The menu item object.
12210 * @param label The label to set for @p item
12212 * @warning Don't use this funcion on items created with
12213 * elm_menu_item_add_object() or elm_menu_item_separator_add().
12215 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
12217 * @brief Get the label of a menu item
12219 * @param item The menu item object.
12220 * @return The label of @p item
12222 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12224 * @brief Set the icon of a menu item to the standard icon with name @p icon
12226 * @param item The menu item object.
12227 * @param icon The icon object to set for the content of @p item
12229 * Once this icon is set, any previously set icon will be deleted.
12231 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
12233 * @brief Get the string representation from the icon of a menu item
12235 * @param item The menu item object.
12236 * @return The string representation of @p item's icon or NULL
12238 * @see elm_menu_item_object_icon_name_set()
12240 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12242 * @brief Set the content object of a menu item
12244 * @param item The menu item object
12245 * @param The content object or NULL
12246 * @return EINA_TRUE on success, else EINA_FALSE
12248 * Use this function to change the object swallowed by a menu item, deleting
12249 * any previously swallowed object.
12251 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
12253 * @brief Get the content object of a menu item
12255 * @param item The menu item object
12256 * @return The content object or NULL
12257 * @note If @p item was added with elm_menu_item_add_object, this
12258 * function will return the object passed, else it will return the
12261 * @see elm_menu_item_object_content_set()
12263 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12265 * @brief Set the selected state of @p item.
12267 * @param item The menu item object.
12268 * @param selected The selected/unselected state of the item
12270 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
12272 * @brief Get the selected state of @p item.
12274 * @param item The menu item object.
12275 * @return The selected/unselected state of the item
12277 * @see elm_menu_item_selected_set()
12279 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12281 * @brief Set the disabled state of @p item.
12283 * @param item The menu item object.
12284 * @param disabled The enabled/disabled state of the item
12286 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
12288 * @brief Get the disabled state of @p item.
12290 * @param item The menu item object.
12291 * @return The enabled/disabled state of the item
12293 * @see elm_menu_item_disabled_set()
12295 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12297 * @brief Add a separator item to menu @p obj under @p parent.
12299 * @param obj The menu object
12300 * @param parent The item to add the separator under
12301 * @return The created item or NULL on failure
12303 * This is item is a @ref Separator.
12305 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
12307 * @brief Returns whether @p item is a separator.
12309 * @param item The item to check
12310 * @return If true, @p item is a separator
12312 * @see elm_menu_item_separator_add()
12314 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12316 * @brief Deletes an item from the menu.
12318 * @param item The item to delete.
12320 * @see elm_menu_item_add()
12322 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12324 * @brief Set the function called when a menu item is deleted.
12326 * @param item The item to set the callback on
12327 * @param func The function called
12329 * @see elm_menu_item_add()
12330 * @see elm_menu_item_del()
12332 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12334 * @brief Returns the data associated with menu item @p item.
12336 * @param item The item
12337 * @return The data associated with @p item or NULL if none was set.
12339 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
12341 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12343 * @brief Sets the data to be associated with menu item @p item.
12345 * @param item The item
12346 * @param data The data to be associated with @p item
12348 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
12350 * @brief Returns a list of @p item's subitems.
12352 * @param item The item
12353 * @return An Eina_List* of @p item's subitems
12355 * @see elm_menu_add()
12357 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
12359 * @brief Get the position of a menu item
12361 * @param item The menu item
12362 * @return The item's index
12364 * This function returns the index position of a menu item in a menu.
12365 * For a sub-menu, this number is relative to the first item in the sub-menu.
12367 * @note Index values begin with 0
12369 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12371 * @brief @brief Return a menu item's owner menu
12373 * @param item The menu item
12374 * @return The menu object owning @p item, or NULL on failure
12376 * Use this function to get the menu object owning an item.
12378 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
12380 * @brief Get the selected item in the menu
12382 * @param obj The menu object
12383 * @return The selected item, or NULL if none
12385 * @see elm_menu_item_selected_get()
12386 * @see elm_menu_item_selected_set()
12388 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12390 * @brief Get the last item in the menu
12392 * @param obj The menu object
12393 * @return The last item, or NULL if none
12395 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12397 * @brief Get the first item in the menu
12399 * @param obj The menu object
12400 * @return The first item, or NULL if none
12402 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
12404 * @brief Get the next item in the menu.
12406 * @param item The menu item object.
12407 * @return The item after it, or NULL if none
12409 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12411 * @brief Get the previous item in the menu.
12413 * @param item The menu item object.
12414 * @return The item before it, or NULL if none
12416 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
12422 * @defgroup List List
12423 * @ingroup Elementary
12425 * @image html img/widget/list/preview-00.png
12426 * @image latex img/widget/list/preview-00.eps width=\textwidth
12428 * @image html img/list.png
12429 * @image latex img/list.eps width=\textwidth
12431 * A list widget is a container whose children are displayed vertically or
12432 * horizontally, in order, and can be selected.
12433 * The list can accept only one or multiple items selection. Also has many
12434 * modes of items displaying.
12436 * A list is a very simple type of list widget. For more robust
12437 * lists, @ref Genlist should probably be used.
12439 * Smart callbacks one can listen to:
12440 * - @c "activated" - The user has double-clicked or pressed
12441 * (enter|return|spacebar) on an item. The @c event_info parameter
12442 * is the item that was activated.
12443 * - @c "clicked,double" - The user has double-clicked an item.
12444 * The @c event_info parameter is the item that was double-clicked.
12445 * - "selected" - when the user selected an item
12446 * - "unselected" - when the user unselected an item
12447 * - "longpressed" - an item in the list is long-pressed
12448 * - "scroll,edge,top" - the list is scrolled until the top edge
12449 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
12450 * - "scroll,edge,left" - the list is scrolled until the left edge
12451 * - "scroll,edge,right" - the list is scrolled until the right edge
12453 * Available styles for it:
12456 * List of examples:
12457 * @li @ref list_example_01
12458 * @li @ref list_example_02
12459 * @li @ref list_example_03
12468 * @enum _Elm_List_Mode
12469 * @typedef Elm_List_Mode
12471 * Set list's resize behavior, transverse axis scroll and
12472 * items cropping. See each mode's description for more details.
12474 * @note Default value is #ELM_LIST_SCROLL.
12476 * Values <b> don't </b> work as bitmask, only one can be choosen.
12478 * @see elm_list_mode_set()
12479 * @see elm_list_mode_get()
12483 typedef enum _Elm_List_Mode
12485 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. */
12486 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). */
12487 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. */
12488 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. */
12489 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
12492 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(). */
12495 * Add a new list widget to the given parent Elementary
12496 * (container) object.
12498 * @param parent The parent object.
12499 * @return a new list widget handle or @c NULL, on errors.
12501 * This function inserts a new list widget on the canvas.
12505 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12510 * @param obj The list object
12512 * @note Call before running show() on the list object.
12513 * @warning If not called, it won't display the list properly.
12516 * li = elm_list_add(win);
12517 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
12518 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
12520 * evas_object_show(li);
12525 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
12528 * Enable or disable multiple items selection on the list object.
12530 * @param obj The list object
12531 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
12534 * Disabled by default. If disabled, the user can select a single item of
12535 * the list each time. Selected items are highlighted on list.
12536 * If enabled, many items can be selected.
12538 * If a selected item is selected again, it will be unselected.
12540 * @see elm_list_multi_select_get()
12544 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
12547 * Get a value whether multiple items selection is enabled or not.
12549 * @see elm_list_multi_select_set() for details.
12551 * @param obj The list object.
12552 * @return @c EINA_TRUE means multiple items selection is enabled.
12553 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12554 * @c EINA_FALSE is returned.
12558 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12561 * Set which mode to use for the list object.
12563 * @param obj The list object
12564 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12565 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
12567 * Set list's resize behavior, transverse axis scroll and
12568 * items cropping. See each mode's description for more details.
12570 * @note Default value is #ELM_LIST_SCROLL.
12572 * Only one can be set, if a previous one was set, it will be changed
12573 * by the new mode set. Bitmask won't work as well.
12575 * @see elm_list_mode_get()
12579 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
12582 * Get the mode the list is at.
12584 * @param obj The list object
12585 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
12586 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
12588 * @note see elm_list_mode_set() for more information.
12592 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12595 * Enable or disable horizontal mode on the list object.
12597 * @param obj The list object.
12598 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
12599 * disable it, i.e., to enable vertical mode.
12601 * @note Vertical mode is set by default.
12603 * On horizontal mode items are displayed on list from left to right,
12604 * instead of from top to bottom. Also, the list will scroll horizontally.
12605 * Each item will presents left icon on top and right icon, or end, at
12608 * @see elm_list_horizontal_get()
12612 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12615 * Get a value whether horizontal mode is enabled or not.
12617 * @param obj The list object.
12618 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12619 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12620 * @c EINA_FALSE is returned.
12622 * @see elm_list_horizontal_set() for details.
12626 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12629 * Enable or disable always select mode on the list object.
12631 * @param obj The list object
12632 * @param always_select @c EINA_TRUE to enable always select mode or
12633 * @c EINA_FALSE to disable it.
12635 * @note Always select mode is disabled by default.
12637 * Default behavior of list items is to only call its callback function
12638 * the first time it's pressed, i.e., when it is selected. If a selected
12639 * item is pressed again, and multi-select is disabled, it won't call
12640 * this function (if multi-select is enabled it will unselect the item).
12642 * If always select is enabled, it will call the callback function
12643 * everytime a item is pressed, so it will call when the item is selected,
12644 * and again when a selected item is pressed.
12646 * @see elm_list_always_select_mode_get()
12647 * @see elm_list_multi_select_set()
12651 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
12654 * Get a value whether always select mode is enabled or not, meaning that
12655 * an item will always call its callback function, even if already selected.
12657 * @param obj The list object
12658 * @return @c EINA_TRUE means horizontal mode selection is enabled.
12659 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
12660 * @c EINA_FALSE is returned.
12662 * @see elm_list_always_select_mode_set() for details.
12666 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12669 * Set bouncing behaviour when the scrolled content reaches an edge.
12671 * Tell the internal scroller object whether it should bounce or not
12672 * when it reaches the respective edges for each axis.
12674 * @param obj The list object
12675 * @param h_bounce Whether to bounce or not in the horizontal axis.
12676 * @param v_bounce Whether to bounce or not in the vertical axis.
12678 * @see elm_scroller_bounce_set()
12682 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12685 * Get the bouncing behaviour of the internal scroller.
12687 * Get whether the internal scroller should bounce when the edge of each
12688 * axis is reached scrolling.
12690 * @param obj The list object.
12691 * @param h_bounce Pointer where to store the bounce state of the horizontal
12693 * @param v_bounce Pointer where to store the bounce state of the vertical
12696 * @see elm_scroller_bounce_get()
12697 * @see elm_list_bounce_set()
12701 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12704 * Set the scrollbar policy.
12706 * @param obj The list object
12707 * @param policy_h Horizontal scrollbar policy.
12708 * @param policy_v Vertical scrollbar policy.
12710 * This sets the scrollbar visibility policy for the given scroller.
12711 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
12712 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
12713 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
12714 * This applies respectively for the horizontal and vertical scrollbars.
12716 * The both are disabled by default, i.e., are set to
12717 * #ELM_SCROLLER_POLICY_OFF.
12721 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
12724 * Get the scrollbar policy.
12726 * @see elm_list_scroller_policy_get() for details.
12728 * @param obj The list object.
12729 * @param policy_h Pointer where to store horizontal scrollbar policy.
12730 * @param policy_v Pointer where to store vertical scrollbar policy.
12734 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);
12737 * Append a new item to the list object.
12739 * @param obj The list object.
12740 * @param label The label of the list item.
12741 * @param icon The icon object to use for the left side of the item. An
12742 * icon can be any Evas object, but usually it is an icon created
12743 * with elm_icon_add().
12744 * @param end The icon object to use for the right side of the item. An
12745 * icon can be any Evas object.
12746 * @param func The function to call when the item is clicked.
12747 * @param data The data to associate with the item for related callbacks.
12749 * @return The created item or @c NULL upon failure.
12751 * A new item will be created and appended to the list, i.e., will
12752 * be set as @b last item.
12754 * Items created with this method can be deleted with
12755 * elm_list_item_del().
12757 * Associated @p data can be properly freed when item is deleted if a
12758 * callback function is set with elm_list_item_del_cb_set().
12760 * If a function is passed as argument, it will be called everytime this item
12761 * is selected, i.e., the user clicks over an unselected item.
12762 * If always select is enabled it will call this function every time
12763 * user clicks over an item (already selected or not).
12764 * If such function isn't needed, just passing
12765 * @c NULL as @p func is enough. The same should be done for @p data.
12767 * Simple example (with no function callback or data associated):
12769 * li = elm_list_add(win);
12770 * ic = elm_icon_add(win);
12771 * elm_icon_file_set(ic, "path/to/image", NULL);
12772 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
12773 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
12775 * evas_object_show(li);
12778 * @see elm_list_always_select_mode_set()
12779 * @see elm_list_item_del()
12780 * @see elm_list_item_del_cb_set()
12781 * @see elm_list_clear()
12782 * @see elm_icon_add()
12786 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);
12789 * Prepend a new item to the list object.
12791 * @param obj The list object.
12792 * @param label The label of the list item.
12793 * @param icon The icon object to use for the left side of the item. An
12794 * icon can be any Evas object, but usually it is an icon created
12795 * with elm_icon_add().
12796 * @param end The icon object to use for the right side of the item. An
12797 * icon can be any Evas object.
12798 * @param func The function to call when the item is clicked.
12799 * @param data The data to associate with the item for related callbacks.
12801 * @return The created item or @c NULL upon failure.
12803 * A new item will be created and prepended to the list, i.e., will
12804 * be set as @b first item.
12806 * Items created with this method can be deleted with
12807 * elm_list_item_del().
12809 * Associated @p data can be properly freed when item is deleted if a
12810 * callback function is set with elm_list_item_del_cb_set().
12812 * If a function is passed as argument, it will be called everytime this item
12813 * is selected, i.e., the user clicks over an unselected item.
12814 * If always select is enabled it will call this function every time
12815 * user clicks over an item (already selected or not).
12816 * If such function isn't needed, just passing
12817 * @c NULL as @p func is enough. The same should be done for @p data.
12819 * @see elm_list_item_append() for a simple code example.
12820 * @see elm_list_always_select_mode_set()
12821 * @see elm_list_item_del()
12822 * @see elm_list_item_del_cb_set()
12823 * @see elm_list_clear()
12824 * @see elm_icon_add()
12828 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);
12831 * Insert a new item into the list object before item @p before.
12833 * @param obj The list object.
12834 * @param before The list item to insert before.
12835 * @param label The label of the list item.
12836 * @param icon The icon object to use for the left side of the item. An
12837 * icon can be any Evas object, but usually it is an icon created
12838 * with elm_icon_add().
12839 * @param end The icon object to use for the right side of the item. An
12840 * icon can be any Evas object.
12841 * @param func The function to call when the item is clicked.
12842 * @param data The data to associate with the item for related callbacks.
12844 * @return The created item or @c NULL upon failure.
12846 * A new item will be created and added to the list. Its position in
12847 * this list will be just before item @p before.
12849 * Items created with this method can be deleted with
12850 * elm_list_item_del().
12852 * Associated @p data can be properly freed when item is deleted if a
12853 * callback function is set with elm_list_item_del_cb_set().
12855 * If a function is passed as argument, it will be called everytime this item
12856 * is selected, i.e., the user clicks over an unselected item.
12857 * If always select is enabled it will call this function every time
12858 * user clicks over an item (already selected or not).
12859 * If such function isn't needed, just passing
12860 * @c NULL as @p func is enough. The same should be done for @p data.
12862 * @see elm_list_item_append() for a simple code example.
12863 * @see elm_list_always_select_mode_set()
12864 * @see elm_list_item_del()
12865 * @see elm_list_item_del_cb_set()
12866 * @see elm_list_clear()
12867 * @see elm_icon_add()
12871 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);
12874 * Insert a new item into the list object after item @p after.
12876 * @param obj The list object.
12877 * @param after The list item to insert after.
12878 * @param label The label of the list item.
12879 * @param icon The icon object to use for the left side of the item. An
12880 * icon can be any Evas object, but usually it is an icon created
12881 * with elm_icon_add().
12882 * @param end The icon object to use for the right side of the item. An
12883 * icon can be any Evas object.
12884 * @param func The function to call when the item is clicked.
12885 * @param data The data to associate with the item for related callbacks.
12887 * @return The created item or @c NULL upon failure.
12889 * A new item will be created and added to the list. Its position in
12890 * this list will be just after item @p after.
12892 * Items created with this method can be deleted with
12893 * elm_list_item_del().
12895 * Associated @p data can be properly freed when item is deleted if a
12896 * callback function is set with elm_list_item_del_cb_set().
12898 * If a function is passed as argument, it will be called everytime this item
12899 * is selected, i.e., the user clicks over an unselected item.
12900 * If always select is enabled it will call this function every time
12901 * user clicks over an item (already selected or not).
12902 * If such function isn't needed, just passing
12903 * @c NULL as @p func is enough. The same should be done for @p data.
12905 * @see elm_list_item_append() for a simple code example.
12906 * @see elm_list_always_select_mode_set()
12907 * @see elm_list_item_del()
12908 * @see elm_list_item_del_cb_set()
12909 * @see elm_list_clear()
12910 * @see elm_icon_add()
12914 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);
12917 * Insert a new item into the sorted list object.
12919 * @param obj The list object.
12920 * @param label The label of the list item.
12921 * @param icon The icon object to use for the left side of the item. An
12922 * icon can be any Evas object, but usually it is an icon created
12923 * with elm_icon_add().
12924 * @param end The icon object to use for the right side of the item. An
12925 * icon can be any Evas object.
12926 * @param func The function to call when the item is clicked.
12927 * @param data The data to associate with the item for related callbacks.
12928 * @param cmp_func The comparing function to be used to sort list
12929 * items <b>by #Elm_List_Item item handles</b>. This function will
12930 * receive two items and compare them, returning a non-negative integer
12931 * if the second item should be place after the first, or negative value
12932 * if should be placed before.
12934 * @return The created item or @c NULL upon failure.
12936 * @note This function inserts values into a list object assuming it was
12937 * sorted and the result will be sorted.
12939 * A new item will be created and added to the list. Its position in
12940 * this list will be found comparing the new item with previously inserted
12941 * items using function @p cmp_func.
12943 * Items created with this method can be deleted with
12944 * elm_list_item_del().
12946 * Associated @p data can be properly freed when item is deleted if a
12947 * callback function is set with elm_list_item_del_cb_set().
12949 * If a function is passed as argument, it will be called everytime this item
12950 * is selected, i.e., the user clicks over an unselected item.
12951 * If always select is enabled it will call this function every time
12952 * user clicks over an item (already selected or not).
12953 * If such function isn't needed, just passing
12954 * @c NULL as @p func is enough. The same should be done for @p data.
12956 * @see elm_list_item_append() for a simple code example.
12957 * @see elm_list_always_select_mode_set()
12958 * @see elm_list_item_del()
12959 * @see elm_list_item_del_cb_set()
12960 * @see elm_list_clear()
12961 * @see elm_icon_add()
12965 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);
12968 * Remove all list's items.
12970 * @param obj The list object
12972 * @see elm_list_item_del()
12973 * @see elm_list_item_append()
12977 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12980 * Get a list of all the list items.
12982 * @param obj The list object
12983 * @return An @c Eina_List of list items, #Elm_List_Item,
12984 * or @c NULL on failure.
12986 * @see elm_list_item_append()
12987 * @see elm_list_item_del()
12988 * @see elm_list_clear()
12992 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12995 * Get the selected item.
12997 * @param obj The list object.
12998 * @return The selected list item.
13000 * The selected item can be unselected with function
13001 * elm_list_item_selected_set().
13003 * The selected item always will be highlighted on list.
13005 * @see elm_list_selected_items_get()
13009 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13012 * Return a list of the currently selected list items.
13014 * @param obj The list object.
13015 * @return An @c Eina_List of list items, #Elm_List_Item,
13016 * or @c NULL on failure.
13018 * Multiple items can be selected if multi select is enabled. It can be
13019 * done with elm_list_multi_select_set().
13021 * @see elm_list_selected_item_get()
13022 * @see elm_list_multi_select_set()
13026 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13029 * Set the selected state of an item.
13031 * @param item The list item
13032 * @param selected The selected state
13034 * This sets the selected state of the given item @p it.
13035 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13037 * If a new item is selected the previosly selected will be unselected,
13038 * unless multiple selection is enabled with elm_list_multi_select_set().
13039 * Previoulsy selected item can be get with function
13040 * elm_list_selected_item_get().
13042 * Selected items will be highlighted.
13044 * @see elm_list_item_selected_get()
13045 * @see elm_list_selected_item_get()
13046 * @see elm_list_multi_select_set()
13050 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13053 * Get whether the @p item is selected or not.
13055 * @param item The list item.
13056 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13057 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13059 * @see elm_list_selected_item_set() for details.
13060 * @see elm_list_item_selected_get()
13064 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13067 * Set or unset item as a separator.
13069 * @param it The list item.
13070 * @param setting @c EINA_TRUE to set item @p it as separator or
13071 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13073 * Items aren't set as separator by default.
13075 * If set as separator it will display separator theme, so won't display
13078 * @see elm_list_item_separator_get()
13082 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
13085 * Get a value whether item is a separator or not.
13087 * @see elm_list_item_separator_set() for details.
13089 * @param it The list item.
13090 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13091 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13095 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13098 * Show @p item in the list view.
13100 * @param item The list item to be shown.
13102 * It won't animate list until item is visible. If such behavior is wanted,
13103 * use elm_list_bring_in() intead.
13107 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13110 * Bring in the given item to list view.
13112 * @param item The item.
13114 * This causes list to jump to the given item @p item and show it
13115 * (by scrolling), if it is not fully visible.
13117 * This may use animation to do so and take a period of time.
13119 * If animation isn't wanted, elm_list_item_show() can be used.
13123 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13126 * Delete them item from the list.
13128 * @param item The item of list to be deleted.
13130 * If deleting all list items is required, elm_list_clear()
13131 * should be used instead of getting items list and deleting each one.
13133 * @see elm_list_clear()
13134 * @see elm_list_item_append()
13135 * @see elm_list_item_del_cb_set()
13139 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13142 * Set the function called when a list item is freed.
13144 * @param item The item to set the callback on
13145 * @param func The function called
13147 * If there is a @p func, then it will be called prior item's memory release.
13148 * That will be called with the following arguments:
13150 * @li item's Evas object;
13153 * This way, a data associated to a list item could be properly freed.
13157 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13160 * Get the data associated to the item.
13162 * @param item The list item
13163 * @return The data associated to @p item
13165 * The return value is a pointer to data associated to @p item when it was
13166 * created, with function elm_list_item_append() or similar. If no data
13167 * was passed as argument, it will return @c NULL.
13169 * @see elm_list_item_append()
13173 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13176 * Get the left side icon associated to the item.
13178 * @param item The list item
13179 * @return The left side icon associated to @p item
13181 * The return value is a pointer to the icon associated to @p item when
13183 * created, with function elm_list_item_append() or similar, or later
13184 * with function elm_list_item_icon_set(). If no icon
13185 * was passed as argument, it will return @c NULL.
13187 * @see elm_list_item_append()
13188 * @see elm_list_item_icon_set()
13192 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13195 * Set the left side icon associated to the item.
13197 * @param item The list item
13198 * @param icon The left side icon object to associate with @p item
13200 * The icon object to use at left side of the item. An
13201 * icon can be any Evas object, but usually it is an icon created
13202 * with elm_icon_add().
13204 * Once the icon object is set, a previously set one will be deleted.
13205 * @warning Setting the same icon for two items will cause the icon to
13206 * dissapear from the first item.
13208 * If an icon was passed as argument on item creation, with function
13209 * elm_list_item_append() or similar, it will be already
13210 * associated to the item.
13212 * @see elm_list_item_append()
13213 * @see elm_list_item_icon_get()
13217 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
13220 * Get the right side icon associated to the item.
13222 * @param item The list item
13223 * @return The right side icon associated to @p item
13225 * The return value is a pointer to the icon associated to @p item when
13227 * created, with function elm_list_item_append() or similar, or later
13228 * with function elm_list_item_icon_set(). If no icon
13229 * was passed as argument, it will return @c NULL.
13231 * @see elm_list_item_append()
13232 * @see elm_list_item_icon_set()
13236 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13239 * Set the right side icon associated to the item.
13241 * @param item The list item
13242 * @param end The right side icon object to associate with @p item
13244 * The icon object to use at right side of the item. An
13245 * icon can be any Evas object, but usually it is an icon created
13246 * with elm_icon_add().
13248 * Once the icon object is set, a previously set one will be deleted.
13249 * @warning Setting the same icon for two items will cause the icon to
13250 * dissapear from the first item.
13252 * If an icon was passed as argument on item creation, with function
13253 * elm_list_item_append() or similar, it will be already
13254 * associated to the item.
13256 * @see elm_list_item_append()
13257 * @see elm_list_item_end_get()
13261 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
13264 * Gets the base object of the item.
13266 * @param item The list item
13267 * @return The base object associated with @p item
13269 * Base object is the @c Evas_Object that represents that item.
13273 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13276 * Get the label of item.
13278 * @param item The item of list.
13279 * @return The label of item.
13281 * The return value is a pointer to the label associated to @p item when
13282 * it was created, with function elm_list_item_append(), or later
13283 * with function elm_list_item_label_set. If no label
13284 * was passed as argument, it will return @c NULL.
13286 * @see elm_list_item_label_set() for more details.
13287 * @see elm_list_item_append()
13291 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13294 * Set the label of item.
13296 * @param item The item of list.
13297 * @param text The label of item.
13299 * The label to be displayed by the item.
13300 * Label will be placed between left and right side icons (if set).
13302 * If a label was passed as argument on item creation, with function
13303 * elm_list_item_append() or similar, it will be already
13304 * displayed by the item.
13306 * @see elm_list_item_label_get()
13307 * @see elm_list_item_append()
13311 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13315 * Get the item before @p it in list.
13317 * @param it The list item.
13318 * @return The item before @p it, or @c NULL if none or on failure.
13320 * @note If it is the first item, @c NULL will be returned.
13322 * @see elm_list_item_append()
13323 * @see elm_list_items_get()
13327 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13330 * Get the item after @p it in list.
13332 * @param it The list item.
13333 * @return The item after @p it, or @c NULL if none or on failure.
13335 * @note If it is the last item, @c NULL will be returned.
13337 * @see elm_list_item_append()
13338 * @see elm_list_items_get()
13342 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13345 * Sets the disabled/enabled state of a list item.
13347 * @param it The item.
13348 * @param disabled The disabled state.
13350 * A disabled item cannot be selected or unselected. It will also
13351 * change its appearance (generally greyed out). This sets the
13352 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13357 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13360 * Get a value whether list item is disabled or not.
13362 * @param it The item.
13363 * @return The disabled state.
13365 * @see elm_list_item_disabled_set() for more details.
13369 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
13372 * Set the text to be shown in a given list item's tooltips.
13374 * @param item Target item.
13375 * @param text The text to set in the content.
13377 * Setup the text as tooltip to object. The item can have only one tooltip,
13378 * so any previous tooltip data - set with this function or
13379 * elm_list_item_tooltip_content_cb_set() - is removed.
13381 * @see elm_object_tooltip_text_set() for more details.
13385 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
13389 * @brief Disable size restrictions on an object's tooltip
13390 * @param item The tooltip's anchor object
13391 * @param disable If EINA_TRUE, size restrictions are disabled
13392 * @return EINA_FALSE on failure, EINA_TRUE on success
13394 * This function allows a tooltip to expand beyond its parant window's canvas.
13395 * It will instead be limited only by the size of the display.
13397 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
13399 * @brief Retrieve size restriction state of an object's tooltip
13400 * @param obj The tooltip's anchor object
13401 * @return If EINA_TRUE, size restrictions are disabled
13403 * This function returns whether a tooltip is allowed to expand beyond
13404 * its parant window's canvas.
13405 * It will instead be limited only by the size of the display.
13407 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13410 * Set the content to be shown in the tooltip item.
13412 * Setup the tooltip to item. The item can have only one tooltip,
13413 * so any previous tooltip data is removed. @p func(with @p data) will
13414 * be called every time that need show the tooltip and it should
13415 * return a valid Evas_Object. This object is then managed fully by
13416 * tooltip system and is deleted when the tooltip is gone.
13418 * @param item the list item being attached a tooltip.
13419 * @param func the function used to create the tooltip contents.
13420 * @param data what to provide to @a func as callback data/context.
13421 * @param del_cb called when data is not needed anymore, either when
13422 * another callback replaces @a func, the tooltip is unset with
13423 * elm_list_item_tooltip_unset() or the owner @a item
13424 * dies. This callback receives as the first parameter the
13425 * given @a data, and @c event_info is the item.
13427 * @see elm_object_tooltip_content_cb_set() for more details.
13431 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);
13434 * Unset tooltip from item.
13436 * @param item list item to remove previously set tooltip.
13438 * Remove tooltip from item. The callback provided as del_cb to
13439 * elm_list_item_tooltip_content_cb_set() will be called to notify
13440 * it is not used anymore.
13442 * @see elm_object_tooltip_unset() for more details.
13443 * @see elm_list_item_tooltip_content_cb_set()
13447 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13450 * Sets a different style for this item tooltip.
13452 * @note before you set a style you should define a tooltip with
13453 * elm_list_item_tooltip_content_cb_set() or
13454 * elm_list_item_tooltip_text_set()
13456 * @param item list item with tooltip already set.
13457 * @param style the theme style to use (default, transparent, ...)
13459 * @see elm_object_tooltip_style_set() for more details.
13463 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13466 * Get the style for this item tooltip.
13468 * @param item list item with tooltip already set.
13469 * @return style the theme style in use, defaults to "default". If the
13470 * object does not have a tooltip set, then NULL is returned.
13472 * @see elm_object_tooltip_style_get() for more details.
13473 * @see elm_list_item_tooltip_style_set()
13477 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13480 * Set the type of mouse pointer/cursor decoration to be shown,
13481 * when the mouse pointer is over the given list widget item
13483 * @param item list item to customize cursor on
13484 * @param cursor the cursor type's name
13486 * This function works analogously as elm_object_cursor_set(), but
13487 * here the cursor's changing area is restricted to the item's
13488 * area, and not the whole widget's. Note that that item cursors
13489 * have precedence over widget cursors, so that a mouse over an
13490 * item with custom cursor set will always show @b that cursor.
13492 * If this function is called twice for an object, a previously set
13493 * cursor will be unset on the second call.
13495 * @see elm_object_cursor_set()
13496 * @see elm_list_item_cursor_get()
13497 * @see elm_list_item_cursor_unset()
13501 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13504 * Get the type of mouse pointer/cursor decoration set to be shown,
13505 * when the mouse pointer is over the given list widget item
13507 * @param item list item with custom cursor set
13508 * @return the cursor type's name or @c NULL, if no custom cursors
13509 * were set to @p item (and on errors)
13511 * @see elm_object_cursor_get()
13512 * @see elm_list_item_cursor_set()
13513 * @see elm_list_item_cursor_unset()
13517 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13520 * Unset any custom mouse pointer/cursor decoration set to be
13521 * shown, when the mouse pointer is over the given list widget
13522 * item, thus making it show the @b default cursor again.
13524 * @param item a list item
13526 * Use this call to undo any custom settings on this item's cursor
13527 * decoration, bringing it back to defaults (no custom style set).
13529 * @see elm_object_cursor_unset()
13530 * @see elm_list_item_cursor_set()
13534 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
13537 * Set a different @b style for a given custom cursor set for a
13540 * @param item list item with custom cursor set
13541 * @param style the <b>theme style</b> to use (e.g. @c "default",
13542 * @c "transparent", etc)
13544 * This function only makes sense when one is using custom mouse
13545 * cursor decorations <b>defined in a theme file</b>, which can have,
13546 * given a cursor name/type, <b>alternate styles</b> on it. It
13547 * works analogously as elm_object_cursor_style_set(), but here
13548 * applyed only to list item objects.
13550 * @warning Before you set a cursor style you should have definen a
13551 * custom cursor previously on the item, with
13552 * elm_list_item_cursor_set()
13554 * @see elm_list_item_cursor_engine_only_set()
13555 * @see elm_list_item_cursor_style_get()
13559 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
13562 * Get the current @b style set for a given list item's custom
13565 * @param item list item with custom cursor set.
13566 * @return style the cursor style in use. If the object does not
13567 * have a cursor set, then @c NULL is returned.
13569 * @see elm_list_item_cursor_style_set() for more details
13573 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13576 * Set if the (custom)cursor for a given list item should be
13577 * searched in its theme, also, or should only rely on the
13578 * rendering engine.
13580 * @param item item with custom (custom) cursor already set on
13581 * @param engine_only Use @c EINA_TRUE to have cursors looked for
13582 * only on those provided by the rendering engine, @c EINA_FALSE to
13583 * have them searched on the widget's theme, as well.
13585 * @note This call is of use only if you've set a custom cursor
13586 * for list items, with elm_list_item_cursor_set().
13588 * @note By default, cursors will only be looked for between those
13589 * provided by the rendering engine.
13593 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13596 * Get if the (custom) cursor for a given list item is being
13597 * searched in its theme, also, or is only relying on the rendering
13600 * @param item a list item
13601 * @return @c EINA_TRUE, if cursors are being looked for only on
13602 * those provided by the rendering engine, @c EINA_FALSE if they
13603 * are being searched on the widget's theme, as well.
13605 * @see elm_list_item_cursor_engine_only_set(), for more details
13609 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
13616 * @defgroup Slider Slider
13617 * @ingroup Elementary
13619 * @image html img/widget/slider/preview-00.png
13620 * @image latex img/widget/slider/preview-00.eps width=\textwidth
13622 * The slider adds a dragable “slider” widget for selecting the value of
13623 * something within a range.
13625 * A slider can be horizontal or vertical. It can contain an Icon and has a
13626 * primary label as well as a units label (that is formatted with floating
13627 * point values and thus accepts a printf-style format string, like
13628 * “%1.2f units”. There is also an indicator string that may be somewhere
13629 * else (like on the slider itself) that also accepts a format string like
13630 * units. Label, Icon Unit and Indicator strings/objects are optional.
13632 * A slider may be inverted which means values invert, with high vales being
13633 * on the left or top and low values on the right or bottom (as opposed to
13634 * normally being low on the left or top and high on the bottom and right).
13636 * The slider should have its minimum and maximum values set by the
13637 * application with elm_slider_min_max_set() and value should also be set by
13638 * the application before use with elm_slider_value_set(). The span of the
13639 * slider is its length (horizontally or vertically). This will be scaled by
13640 * the object or applications scaling factor. At any point code can query the
13641 * slider for its value with elm_slider_value_get().
13643 * Smart callbacks one can listen to:
13644 * - "changed" - Whenever the slider value is changed by the user.
13645 * - "slider,drag,start" - dragging the slider indicator around has started.
13646 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
13647 * - "delay,changed" - A short time after the value is changed by the user.
13648 * This will be called only when the user stops dragging for
13649 * a very short period or when they release their
13650 * finger/mouse, so it avoids possibly expensive reactions to
13651 * the value change.
13653 * Available styles for it:
13656 * Here is an example on its usage:
13657 * @li @ref slider_example
13661 * @addtogroup Slider
13666 * Add a new slider widget to the given parent Elementary
13667 * (container) object.
13669 * @param parent The parent object.
13670 * @return a new slider widget handle or @c NULL, on errors.
13672 * This function inserts a new slider widget on the canvas.
13676 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13679 * Set the label of a given slider widget
13681 * @param obj The progress bar object
13682 * @param label The text label string, in UTF-8
13685 * @deprecated use elm_object_text_set() instead.
13687 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13690 * Get the label of a given slider widget
13692 * @param obj The progressbar object
13693 * @return The text label string, in UTF-8
13696 * @deprecated use elm_object_text_get() instead.
13698 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13701 * Set the icon object of the slider object.
13703 * @param obj The slider object.
13704 * @param icon The icon object.
13706 * On horizontal mode, icon is placed at left, and on vertical mode,
13709 * @note Once the icon object is set, a previously set one will be deleted.
13710 * If you want to keep that old content object, use the
13711 * elm_slider_icon_unset() function.
13713 * @warning If the object being set does not have minimum size hints set,
13714 * it won't get properly displayed.
13718 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13721 * Unset an icon set on a given slider widget.
13723 * @param obj The slider object.
13724 * @return The icon object that was being used, if any was set, or
13725 * @c NULL, otherwise (and on errors).
13727 * On horizontal mode, icon is placed at left, and on vertical mode,
13730 * This call will unparent and return the icon object which was set
13731 * for this widget, previously, on success.
13733 * @see elm_slider_icon_set() for more details
13734 * @see elm_slider_icon_get()
13738 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13741 * Retrieve the icon object set for a given slider widget.
13743 * @param obj The slider object.
13744 * @return The icon object's handle, if @p obj had one set, or @c NULL,
13745 * otherwise (and on errors).
13747 * On horizontal mode, icon is placed at left, and on vertical mode,
13750 * @see elm_slider_icon_set() for more details
13751 * @see elm_slider_icon_unset()
13755 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13758 * Set the end object of the slider object.
13760 * @param obj The slider object.
13761 * @param end The end object.
13763 * On horizontal mode, end is placed at left, and on vertical mode,
13764 * placed at bottom.
13766 * @note Once the icon object is set, a previously set one will be deleted.
13767 * If you want to keep that old content object, use the
13768 * elm_slider_end_unset() function.
13770 * @warning If the object being set does not have minimum size hints set,
13771 * it won't get properly displayed.
13775 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
13778 * Unset an end object set on a given slider widget.
13780 * @param obj The slider object.
13781 * @return The end object that was being used, if any was set, or
13782 * @c NULL, otherwise (and on errors).
13784 * On horizontal mode, end is placed at left, and on vertical mode,
13785 * placed at bottom.
13787 * This call will unparent and return the icon object which was set
13788 * for this widget, previously, on success.
13790 * @see elm_slider_end_set() for more details.
13791 * @see elm_slider_end_get()
13795 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13798 * Retrieve the end object set for a given slider widget.
13800 * @param obj The slider object.
13801 * @return The end object's handle, if @p obj had one set, or @c NULL,
13802 * otherwise (and on errors).
13804 * On horizontal mode, icon is placed at right, and on vertical mode,
13805 * placed at bottom.
13807 * @see elm_slider_end_set() for more details.
13808 * @see elm_slider_end_unset()
13812 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13815 * Set the (exact) length of the bar region of a given slider widget.
13817 * @param obj The slider object.
13818 * @param size The length of the slider's bar region.
13820 * This sets the minimum width (when in horizontal mode) or height
13821 * (when in vertical mode) of the actual bar area of the slider
13822 * @p obj. This in turn affects the object's minimum size. Use
13823 * this when you're not setting other size hints expanding on the
13824 * given direction (like weight and alignment hints) and you would
13825 * like it to have a specific size.
13827 * @note Icon, end, label, indicator and unit text around @p obj
13828 * will require their
13829 * own space, which will make @p obj to require more the @p size,
13832 * @see elm_slider_span_size_get()
13836 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
13839 * Get the length set for the bar region of a given slider widget
13841 * @param obj The slider object.
13842 * @return The length of the slider's bar region.
13844 * If that size was not set previously, with
13845 * elm_slider_span_size_set(), this call will return @c 0.
13849 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13852 * Set the format string for the unit label.
13854 * @param obj The slider object.
13855 * @param format The format string for the unit display.
13857 * Unit label is displayed all the time, if set, after slider's bar.
13858 * In horizontal mode, at right and in vertical mode, at bottom.
13860 * If @c NULL, unit label won't be visible. If not it sets the format
13861 * string for the label text. To the label text is provided a floating point
13862 * value, so the label text can display up to 1 floating point value.
13863 * Note that this is optional.
13865 * Use a format string such as "%1.2f meters" for example, and it will
13866 * display values like: "3.14 meters" for a value equal to 3.14159.
13868 * Default is unit label disabled.
13870 * @see elm_slider_indicator_format_get()
13874 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
13877 * Get the unit label format of the slider.
13879 * @param obj The slider object.
13880 * @return The unit label format string in UTF-8.
13882 * Unit label is displayed all the time, if set, after slider's bar.
13883 * In horizontal mode, at right and in vertical mode, at bottom.
13885 * @see elm_slider_unit_format_set() for more
13886 * information on how this works.
13890 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13893 * Set the format string for the indicator label.
13895 * @param obj The slider object.
13896 * @param indicator The format string for the indicator display.
13898 * The slider may display its value somewhere else then unit label,
13899 * for example, above the slider knob that is dragged around. This function
13900 * sets the format string used for this.
13902 * If @c NULL, indicator label won't be visible. If not it sets the format
13903 * string for the label text. To the label text is provided a floating point
13904 * value, so the label text can display up to 1 floating point value.
13905 * Note that this is optional.
13907 * Use a format string such as "%1.2f meters" for example, and it will
13908 * display values like: "3.14 meters" for a value equal to 3.14159.
13910 * Default is indicator label disabled.
13912 * @see elm_slider_indicator_format_get()
13916 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
13919 * Get the indicator label format of the slider.
13921 * @param obj The slider object.
13922 * @return The indicator label format string in UTF-8.
13924 * The slider may display its value somewhere else then unit label,
13925 * for example, above the slider knob that is dragged around. This function
13926 * gets the format string used for this.
13928 * @see elm_slider_indicator_format_set() for more
13929 * information on how this works.
13933 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13936 * Set the format function pointer for the indicator label
13938 * @param obj The slider object.
13939 * @param func The indicator format function.
13940 * @param free_func The freeing function for the format string.
13942 * Set the callback function to format the indicator string.
13944 * @see elm_slider_indicator_format_set() for more info on how this works.
13948 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);
13951 * Set the format function pointer for the units label
13953 * @param obj The slider object.
13954 * @param func The units format function.
13955 * @param free_func The freeing function for the format string.
13957 * Set the callback function to format the indicator string.
13959 * @see elm_slider_units_format_set() for more info on how this works.
13963 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);
13966 * Set the orientation of a given slider widget.
13968 * @param obj The slider object.
13969 * @param horizontal Use @c EINA_TRUE to make @p obj to be
13970 * @b horizontal, @c EINA_FALSE to make it @b vertical.
13972 * Use this function to change how your slider is to be
13973 * disposed: vertically or horizontally.
13975 * By default it's displayed horizontally.
13977 * @see elm_slider_horizontal_get()
13981 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13984 * Retrieve the orientation of a given slider widget
13986 * @param obj The slider object.
13987 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
13988 * @c EINA_FALSE if it's @b vertical (and on errors).
13990 * @see elm_slider_horizontal_set() for more details.
13994 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13997 * Set the minimum and maximum values for the slider.
13999 * @param obj The slider object.
14000 * @param min The minimum value.
14001 * @param max The maximum value.
14003 * Define the allowed range of values to be selected by the user.
14005 * If actual value is less than @p min, it will be updated to @p min. If it
14006 * is bigger then @p max, will be updated to @p max. Actual value can be
14007 * get with elm_slider_value_get().
14009 * By default, min is equal to 0.0, and max is equal to 1.0.
14011 * @warning Maximum must be greater than minimum, otherwise behavior
14014 * @see elm_slider_min_max_get()
14018 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
14021 * Get the minimum and maximum values of the slider.
14023 * @param obj The slider object.
14024 * @param min Pointer where to store the minimum value.
14025 * @param max Pointer where to store the maximum value.
14027 * @note If only one value is needed, the other pointer can be passed
14030 * @see elm_slider_min_max_set() for details.
14034 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
14037 * Set the value the slider displays.
14039 * @param obj The slider object.
14040 * @param val The value to be displayed.
14042 * Value will be presented on the unit label following format specified with
14043 * elm_slider_unit_format_set() and on indicator with
14044 * elm_slider_indicator_format_set().
14046 * @warning The value must to be between min and max values. This values
14047 * are set by elm_slider_min_max_set().
14049 * @see elm_slider_value_get()
14050 * @see elm_slider_unit_format_set()
14051 * @see elm_slider_indicator_format_set()
14052 * @see elm_slider_min_max_set()
14056 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
14059 * Get the value displayed by the spinner.
14061 * @param obj The spinner object.
14062 * @return The value displayed.
14064 * @see elm_spinner_value_set() for details.
14068 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14071 * Invert a given slider widget's displaying values order
14073 * @param obj The slider object.
14074 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
14075 * @c EINA_FALSE to bring it back to default, non-inverted values.
14077 * A slider may be @b inverted, in which state it gets its
14078 * values inverted, with high vales being on the left or top and
14079 * low values on the right or bottom, as opposed to normally have
14080 * the low values on the former and high values on the latter,
14081 * respectively, for horizontal and vertical modes.
14083 * @see elm_slider_inverted_get()
14087 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
14090 * Get whether a given slider widget's displaying values are
14093 * @param obj The slider object.
14094 * @return @c EINA_TRUE, if @p obj has inverted values,
14095 * @c EINA_FALSE otherwise (and on errors).
14097 * @see elm_slider_inverted_set() for more details.
14101 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14104 * Set whether to enlarge slider indicator (augmented knob) or not.
14106 * @param obj The slider object.
14107 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
14108 * let the knob always at default size.
14110 * By default, indicator will be bigger while dragged by the user.
14112 * @warning It won't display values set with
14113 * elm_slider_indicator_format_set() if you disable indicator.
14117 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
14120 * Get whether a given slider widget's enlarging indicator or not.
14122 * @param obj The slider object.
14123 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
14124 * @c EINA_FALSE otherwise (and on errors).
14126 * @see elm_slider_indicator_show_set() for details.
14130 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14137 * @addtogroup Actionslider Actionslider
14139 * @image html img/widget/actionslider/preview-00.png
14140 * @image latex img/widget/actionslider/preview-00.eps
14142 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
14143 * properties. The indicator is the element the user drags to choose a label.
14144 * When the position is set with magnet, when released the indicator will be
14145 * moved to it if it's nearest the magnetized position.
14147 * @note By default all positions are set as enabled.
14149 * Signals that you can add callbacks for are:
14151 * "selected" - when user selects an enabled position (the label is passed
14154 * "pos_changed" - when the indicator reaches any of the positions("left",
14155 * "right" or "center").
14157 * See an example of actionslider usage @ref actionslider_example_page "here"
14160 typedef enum _Elm_Actionslider_Pos
14162 ELM_ACTIONSLIDER_NONE = 0,
14163 ELM_ACTIONSLIDER_LEFT = 1 << 0,
14164 ELM_ACTIONSLIDER_CENTER = 1 << 1,
14165 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
14166 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
14167 } Elm_Actionslider_Pos;
14170 * Add a new actionslider to the parent.
14172 * @param parent The parent object
14173 * @return The new actionslider object or NULL if it cannot be created
14175 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14177 * Set actionslider labels.
14179 * @param obj The actionslider object
14180 * @param left_label The label to be set on the left.
14181 * @param center_label The label to be set on the center.
14182 * @param right_label The label to be set on the right.
14183 * @deprecated use elm_object_text_set() instead.
14185 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);
14187 * Get actionslider labels.
14189 * @param obj The actionslider object
14190 * @param left_label A char** to place the left_label of @p obj into.
14191 * @param center_label A char** to place the center_label of @p obj into.
14192 * @param right_label A char** to place the right_label of @p obj into.
14193 * @deprecated use elm_object_text_set() instead.
14195 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);
14197 * Get actionslider selected label.
14199 * @param obj The actionslider object
14200 * @return The selected label
14202 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14204 * Set actionslider indicator position.
14206 * @param obj The actionslider object.
14207 * @param pos The position of the indicator.
14209 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14211 * Get actionslider indicator position.
14213 * @param obj The actionslider object.
14214 * @return The position of the indicator.
14216 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14218 * Set actionslider magnet position. To make multiple positions magnets @c or
14219 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
14221 * @param obj The actionslider object.
14222 * @param pos Bit mask indicating the magnet positions.
14224 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14226 * Get actionslider magnet position.
14228 * @param obj The actionslider object.
14229 * @return The positions with magnet property.
14231 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14233 * Set actionslider enabled position. To set multiple positions as enabled @c or
14234 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
14236 * @note All the positions are enabled by default.
14238 * @param obj The actionslider object.
14239 * @param pos Bit mask indicating the enabled positions.
14241 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
14243 * Get actionslider enabled position.
14245 * @param obj The actionslider object.
14246 * @return The enabled positions.
14248 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14250 * Set the label used on the indicator.
14252 * @param obj The actionslider object
14253 * @param label The label to be set on the indicator.
14254 * @deprecated use elm_object_text_set() instead.
14256 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14258 * Get the label used on the indicator object.
14260 * @param obj The actionslider object
14261 * @return The indicator label
14262 * @deprecated use elm_object_text_get() instead.
14264 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14270 * @defgroup Genlist Genlist
14272 * @image html img/widget/genlist/preview-00.png
14273 * @image latex img/widget/genlist/preview-00.eps
14274 * @image html img/genlist.png
14275 * @image latex img/genlist.eps
14277 * This widget aims to have more expansive list than the simple list in
14278 * Elementary that could have more flexible items and allow many more entries
14279 * while still being fast and low on memory usage. At the same time it was
14280 * also made to be able to do tree structures. But the price to pay is more
14281 * complexity when it comes to usage. If all you want is a simple list with
14282 * icons and a single label, use the normal @ref List object.
14284 * Genlist has a fairly large API, mostly because it's relatively complex,
14285 * trying to be both expansive, powerful and efficient. First we will begin
14286 * an overview on the theory behind genlist.
14288 * @section Genlist_Item_Class Genlist item classes - creating items
14290 * In order to have the ability to add and delete items on the fly, genlist
14291 * implements a class (callback) system where the application provides a
14292 * structure with information about that type of item (genlist may contain
14293 * multiple different items with different classes, states and styles).
14294 * Genlist will call the functions in this struct (methods) when an item is
14295 * "realized" (i.e., created dynamically, while the user is scrolling the
14296 * grid). All objects will simply be deleted when no longer needed with
14297 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
14298 * following members:
14299 * - @c item_style - This is a constant string and simply defines the name
14300 * of the item style. It @b must be specified and the default should be @c
14302 * - @c mode_item_style - This is a constant string and simply defines the
14303 * name of the style that will be used for mode animations. It can be left
14304 * as @c NULL if you don't plan to use Genlist mode. See
14305 * elm_genlist_item_mode_set() for more info.
14307 * - @c func - A struct with pointers to functions that will be called when
14308 * an item is going to be actually created. All of them receive a @c data
14309 * parameter that will point to the same data passed to
14310 * elm_genlist_item_append() and related item creation functions, and a @c
14311 * obj parameter that points to the genlist object itself.
14313 * The function pointers inside @c func are @c label_get, @c icon_get, @c
14314 * state_get and @c del. The 3 first functions also receive a @c part
14315 * parameter described below. A brief description of these functions follows:
14317 * - @c label_get - The @c part parameter is the name string of one of the
14318 * existing text parts in the Edje group implementing the item's theme.
14319 * This function @b must return a strdup'()ed string, as the caller will
14320 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
14321 * - @c icon_get - The @c part parameter is the name string of one of the
14322 * existing (icon) swallow parts in the Edje group implementing the item's
14323 * theme. It must return @c NULL, when no icon is desired, or a valid
14324 * object handle, otherwise. The object will be deleted by the genlist on
14325 * its deletion or when the item is "unrealized". See
14326 * #Elm_Genlist_Item_Icon_Get_Cb.
14327 * - @c func.state_get - The @c part parameter is the name string of one of
14328 * the state parts in the Edje group implementing the item's theme. Return
14329 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
14330 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
14331 * and @c "elm" as "emission" and "source" arguments, respectively, when
14332 * the state is true (the default is false), where @c XXX is the name of
14333 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
14334 * - @c func.del - This is intended for use when genlist items are deleted,
14335 * so any data attached to the item (e.g. its data parameter on creation)
14336 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
14338 * available item styles:
14340 * - default_style - The text part is a textblock
14342 * @image html img/widget/genlist/preview-04.png
14343 * @image latex img/widget/genlist/preview-04.eps
14347 * @image html img/widget/genlist/preview-01.png
14348 * @image latex img/widget/genlist/preview-01.eps
14350 * - icon_top_text_bottom
14352 * @image html img/widget/genlist/preview-02.png
14353 * @image latex img/widget/genlist/preview-02.eps
14357 * @image html img/widget/genlist/preview-03.png
14358 * @image latex img/widget/genlist/preview-03.eps
14360 * @section Genlist_Items Structure of items
14362 * An item in a genlist can have 0 or more text labels (they can be regular
14363 * text or textblock Evas objects - that's up to the style to determine), 0
14364 * or more icons (which are simply objects swallowed into the genlist item's
14365 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
14366 * behavior left to the user to define. The Edje part names for each of
14367 * these properties will be looked up, in the theme file for the genlist,
14368 * under the Edje (string) data items named @c "labels", @c "icons" and @c
14369 * "states", respectively. For each of those properties, if more than one
14370 * part is provided, they must have names listed separated by spaces in the
14371 * data fields. For the default genlist item theme, we have @b one label
14372 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
14373 * "elm.swallow.end") and @b no state parts.
14375 * A genlist item may be at one of several styles. Elementary provides one
14376 * by default - "default", but this can be extended by system or application
14377 * custom themes/overlays/extensions (see @ref Theme "themes" for more
14380 * @section Genlist_Manipulation Editing and Navigating
14382 * Items can be added by several calls. All of them return a @ref
14383 * Elm_Genlist_Item handle that is an internal member inside the genlist.
14384 * They all take a data parameter that is meant to be used for a handle to
14385 * the applications internal data (eg the struct with the original item
14386 * data). The parent parameter is the parent genlist item this belongs to if
14387 * it is a tree or an indexed group, and NULL if there is no parent. The
14388 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
14389 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
14390 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
14391 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
14392 * is set then this item is group index item that is displayed at the top
14393 * until the next group comes. The func parameter is a convenience callback
14394 * that is called when the item is selected and the data parameter will be
14395 * the func_data parameter, obj be the genlist object and event_info will be
14396 * the genlist item.
14398 * elm_genlist_item_append() adds an item to the end of the list, or if
14399 * there is a parent, to the end of all the child items of the parent.
14400 * elm_genlist_item_prepend() is the same but adds to the beginning of
14401 * the list or children list. elm_genlist_item_insert_before() inserts at
14402 * item before another item and elm_genlist_item_insert_after() inserts after
14403 * the indicated item.
14405 * The application can clear the list with elm_genlist_clear() which deletes
14406 * all the items in the list and elm_genlist_item_del() will delete a specific
14407 * item. elm_genlist_item_subitems_clear() will clear all items that are
14408 * children of the indicated parent item.
14410 * To help inspect list items you can jump to the item at the top of the list
14411 * with elm_genlist_first_item_get() which will return the item pointer, and
14412 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
14413 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
14414 * and previous items respectively relative to the indicated item. Using
14415 * these calls you can walk the entire item list/tree. Note that as a tree
14416 * the items are flattened in the list, so elm_genlist_item_parent_get() will
14417 * let you know which item is the parent (and thus know how to skip them if
14420 * @section Genlist_Muti_Selection Multi-selection
14422 * If the application wants multiple items to be able to be selected,
14423 * elm_genlist_multi_select_set() can enable this. If the list is
14424 * single-selection only (the default), then elm_genlist_selected_item_get()
14425 * will return the selected item, if any, or NULL I none is selected. If the
14426 * list is multi-select then elm_genlist_selected_items_get() will return a
14427 * list (that is only valid as long as no items are modified (added, deleted,
14428 * selected or unselected)).
14430 * @section Genlist_Usage_Hints Usage hints
14432 * There are also convenience functions. elm_genlist_item_genlist_get() will
14433 * return the genlist object the item belongs to. elm_genlist_item_show()
14434 * will make the scroller scroll to show that specific item so its visible.
14435 * elm_genlist_item_data_get() returns the data pointer set by the item
14436 * creation functions.
14438 * If an item changes (state of boolean changes, label or icons change),
14439 * then use elm_genlist_item_update() to have genlist update the item with
14440 * the new state. Genlist will re-realize the item thus call the functions
14441 * in the _Elm_Genlist_Item_Class for that item.
14443 * To programmatically (un)select an item use elm_genlist_item_selected_set().
14444 * To get its selected state use elm_genlist_item_selected_get(). Similarly
14445 * to expand/contract an item and get its expanded state, use
14446 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
14447 * again to make an item disabled (unable to be selected and appear
14448 * differently) use elm_genlist_item_disabled_set() to set this and
14449 * elm_genlist_item_disabled_get() to get the disabled state.
14451 * In general to indicate how the genlist should expand items horizontally to
14452 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
14453 * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
14454 * mode means that if items are too wide to fit, the scroller will scroll
14455 * horizontally. Otherwise items are expanded to fill the width of the
14456 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
14457 * to the viewport width and limited to that size. This can be combined with
14458 * a different style that uses edjes' ellipsis feature (cutting text off like
14461 * Items will only call their selection func and callback when first becoming
14462 * selected. Any further clicks will do nothing, unless you enable always
14463 * select with elm_genlist_always_select_mode_set(). This means even if
14464 * selected, every click will make the selected callbacks be called.
14465 * elm_genlist_no_select_mode_set() will turn off the ability to select
14466 * items entirely and they will neither appear selected nor call selected
14467 * callback functions.
14469 * Remember that you can create new styles and add your own theme augmentation
14470 * per application with elm_theme_extension_add(). If you absolutely must
14471 * have a specific style that overrides any theme the user or system sets up
14472 * you can use elm_theme_overlay_add() to add such a file.
14474 * @section Genlist_Implementation Implementation
14476 * Evas tracks every object you create. Every time it processes an event
14477 * (mouse move, down, up etc.) it needs to walk through objects and find out
14478 * what event that affects. Even worse every time it renders display updates,
14479 * in order to just calculate what to re-draw, it needs to walk through many
14480 * many many objects. Thus, the more objects you keep active, the more
14481 * overhead Evas has in just doing its work. It is advisable to keep your
14482 * active objects to the minimum working set you need. Also remember that
14483 * object creation and deletion carries an overhead, so there is a
14484 * middle-ground, which is not easily determined. But don't keep massive lists
14485 * of objects you can't see or use. Genlist does this with list objects. It
14486 * creates and destroys them dynamically as you scroll around. It groups them
14487 * into blocks so it can determine the visibility etc. of a whole block at
14488 * once as opposed to having to walk the whole list. This 2-level list allows
14489 * for very large numbers of items to be in the list (tests have used up to
14490 * 2,000,000 items). Also genlist employs a queue for adding items. As items
14491 * may be different sizes, every item added needs to be calculated as to its
14492 * size and thus this presents a lot of overhead on populating the list, this
14493 * genlist employs a queue. Any item added is queued and spooled off over
14494 * time, actually appearing some time later, so if your list has many members
14495 * you may find it takes a while for them to all appear, with your process
14496 * consuming a lot of CPU while it is busy spooling.
14498 * Genlist also implements a tree structure, but it does so with callbacks to
14499 * the application, with the application filling in tree structures when
14500 * requested (allowing for efficient building of a very deep tree that could
14501 * even be used for file-management). See the above smart signal callbacks for
14504 * @section Genlist_Smart_Events Genlist smart events
14506 * Signals that you can add callbacks for are:
14507 * - @c "activated" - The user has double-clicked or pressed
14508 * (enter|return|spacebar) on an item. The @c event_info parameter is the
14509 * item that was activated.
14510 * - @c "clicked,double" - The user has double-clicked an item. The @c
14511 * event_info parameter is the item that was double-clicked.
14512 * - @c "selected" - This is called when a user has made an item selected.
14513 * The event_info parameter is the genlist item that was selected.
14514 * - @c "unselected" - This is called when a user has made an item
14515 * unselected. The event_info parameter is the genlist item that was
14517 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
14518 * called and the item is now meant to be expanded. The event_info
14519 * parameter is the genlist item that was indicated to expand. It is the
14520 * job of this callback to then fill in the child items.
14521 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
14522 * called and the item is now meant to be contracted. The event_info
14523 * parameter is the genlist item that was indicated to contract. It is the
14524 * job of this callback to then delete the child items.
14525 * - @c "expand,request" - This is called when a user has indicated they want
14526 * to expand a tree branch item. The callback should decide if the item can
14527 * expand (has any children) and then call elm_genlist_item_expanded_set()
14528 * appropriately to set the state. The event_info parameter is the genlist
14529 * item that was indicated to expand.
14530 * - @c "contract,request" - This is called when a user has indicated they
14531 * want to contract a tree branch item. The callback should decide if the
14532 * item can contract (has any children) and then call
14533 * elm_genlist_item_expanded_set() appropriately to set the state. The
14534 * event_info parameter is the genlist item that was indicated to contract.
14535 * - @c "realized" - This is called when the item in the list is created as a
14536 * real evas object. event_info parameter is the genlist item that was
14537 * created. The object may be deleted at any time, so it is up to the
14538 * caller to not use the object pointer from elm_genlist_item_object_get()
14539 * in a way where it may point to freed objects.
14540 * - @c "unrealized" - This is called just before an item is unrealized.
14541 * After this call icon objects provided will be deleted and the item
14542 * object itself delete or be put into a floating cache.
14543 * - @c "drag,start,up" - This is called when the item in the list has been
14544 * dragged (not scrolled) up.
14545 * - @c "drag,start,down" - This is called when the item in the list has been
14546 * dragged (not scrolled) down.
14547 * - @c "drag,start,left" - This is called when the item in the list has been
14548 * dragged (not scrolled) left.
14549 * - @c "drag,start,right" - This is called when the item in the list has
14550 * been dragged (not scrolled) right.
14551 * - @c "drag,stop" - This is called when the item in the list has stopped
14553 * - @c "drag" - This is called when the item in the list is being dragged.
14554 * - @c "longpressed" - This is called when the item is pressed for a certain
14555 * amount of time. By default it's 1 second.
14556 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
14558 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
14559 * until the bottom edge.
14560 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
14561 * until the left edge.
14562 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
14563 * until the right edge.
14564 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
14566 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
14568 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
14570 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
14572 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
14573 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
14574 * multi-touch pinched in.
14575 * - @c "swipe" - This is called when the genlist is swiped.
14577 * @section Genlist_Examples Examples
14579 * Here is a list of examples that use the genlist, trying to show some of
14580 * its capabilities:
14581 * - @ref genlist_example_01
14582 * - @ref genlist_example_02
14583 * - @ref genlist_example_03
14584 * - @ref genlist_example_04
14585 * - @ref genlist_example_05
14589 * @addtogroup Genlist
14594 * @enum _Elm_Genlist_Item_Flags
14595 * @typedef Elm_Genlist_Item_Flags
14597 * Defines if the item is of any special type (has subitems or it's the
14598 * index of a group), or is just a simple item.
14602 typedef enum _Elm_Genlist_Item_Flags
14604 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
14605 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
14606 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
14607 } Elm_Genlist_Item_Flags;
14608 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
14609 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
14610 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
14611 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
14612 typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
14613 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
14614 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
14615 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
14617 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
14618 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
14619 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
14620 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
14623 * @struct _Elm_Genlist_Item_Class
14625 * Genlist item class definition structs.
14627 * This struct contains the style and fetching functions that will define the
14628 * contents of each item.
14630 * @see @ref Genlist_Item_Class
14632 struct _Elm_Genlist_Item_Class
14634 const char *item_style; /**< style of this class. */
14637 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
14638 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
14639 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
14640 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
14641 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
14643 const char *mode_item_style;
14647 * Add a new genlist widget to the given parent Elementary
14648 * (container) object
14650 * @param parent The parent object
14651 * @return a new genlist widget handle or @c NULL, on errors
14653 * This function inserts a new genlist widget on the canvas.
14655 * @see elm_genlist_item_append()
14656 * @see elm_genlist_item_del()
14657 * @see elm_genlist_clear()
14661 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14663 * Remove all items from a given genlist widget.
14665 * @param obj The genlist object
14667 * This removes (and deletes) all items in @p obj, leaving it empty.
14669 * @see elm_genlist_item_del(), to remove just one item.
14673 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14675 * Enable or disable multi-selection in the genlist
14677 * @param obj The genlist object
14678 * @param multi Multi-select enable/disable. Default is disabled.
14680 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
14681 * the list. This allows more than 1 item to be selected. To retrieve the list
14682 * of selected items, use elm_genlist_selected_items_get().
14684 * @see elm_genlist_selected_items_get()
14685 * @see elm_genlist_multi_select_get()
14689 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14691 * Gets if multi-selection in genlist is enabled or disabled.
14693 * @param obj The genlist object
14694 * @return Multi-select enabled/disabled
14695 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
14697 * @see elm_genlist_multi_select_set()
14701 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14703 * This sets the horizontal stretching mode.
14705 * @param obj The genlist object
14706 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
14708 * This sets the mode used for sizing items horizontally. Valid modes
14709 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
14710 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
14711 * the scroller will scroll horizontally. Otherwise items are expanded
14712 * to fill the width of the viewport of the scroller. If it is
14713 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
14714 * limited to that size.
14716 * @see elm_genlist_horizontal_get()
14720 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14721 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14723 * Gets the horizontal stretching mode.
14725 * @param obj The genlist object
14726 * @return The mode to use
14727 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
14729 * @see elm_genlist_horizontal_set()
14733 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14734 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14736 * Set the always select mode.
14738 * @param obj The genlist object
14739 * @param always_select The always select mode (@c EINA_TRUE = on, @c
14740 * EINA_FALSE = off). Default is @c EINA_FALSE.
14742 * Items will only call their selection func and callback when first
14743 * becoming selected. Any further clicks will do nothing, unless you
14744 * enable always select with elm_genlist_always_select_mode_set().
14745 * This means that, even if selected, every click will make the selected
14746 * callbacks be called.
14748 * @see elm_genlist_always_select_mode_get()
14752 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14754 * Get the always select mode.
14756 * @param obj The genlist object
14757 * @return The always select mode
14758 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14760 * @see elm_genlist_always_select_mode_set()
14764 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14766 * Enable/disable the no select mode.
14768 * @param obj The genlist object
14769 * @param no_select The no select mode
14770 * (EINA_TRUE = on, EINA_FALSE = off)
14772 * This will turn off the ability to select items entirely and they
14773 * will neither appear selected nor call selected callback functions.
14775 * @see elm_genlist_no_select_mode_get()
14779 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14781 * Gets whether the no select mode is enabled.
14783 * @param obj The genlist object
14784 * @return The no select mode
14785 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14787 * @see elm_genlist_no_select_mode_set()
14791 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14793 * Enable/disable compress mode.
14795 * @param obj The genlist object
14796 * @param compress The compress mode
14797 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
14799 * This will enable the compress mode where items are "compressed"
14800 * horizontally to fit the genlist scrollable viewport width. This is
14801 * special for genlist. Do not rely on
14802 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
14803 * work as genlist needs to handle it specially.
14805 * @see elm_genlist_compress_mode_get()
14809 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
14811 * Get whether the compress mode is enabled.
14813 * @param obj The genlist object
14814 * @return The compress mode
14815 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
14817 * @see elm_genlist_compress_mode_set()
14821 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14823 * Enable/disable height-for-width mode.
14825 * @param obj The genlist object
14826 * @param setting The height-for-width mode (@c EINA_TRUE = on,
14827 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
14829 * With height-for-width mode the item width will be fixed (restricted
14830 * to a minimum of) to the list width when calculating its size in
14831 * order to allow the height to be calculated based on it. This allows,
14832 * for instance, text block to wrap lines if the Edje part is
14833 * configured with "text.min: 0 1".
14835 * @note This mode will make list resize slower as it will have to
14836 * recalculate every item height again whenever the list width
14839 * @note When height-for-width mode is enabled, it also enables
14840 * compress mode (see elm_genlist_compress_mode_set()) and
14841 * disables homogeneous (see elm_genlist_homogeneous_set()).
14845 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
14847 * Get whether the height-for-width mode is enabled.
14849 * @param obj The genlist object
14850 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
14855 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14857 * Enable/disable horizontal and vertical bouncing effect.
14859 * @param obj The genlist object
14860 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
14861 * EINA_FALSE = off). Default is @c EINA_FALSE.
14862 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
14863 * EINA_FALSE = off). Default is @c EINA_TRUE.
14865 * This will enable or disable the scroller bouncing effect for the
14866 * genlist. See elm_scroller_bounce_set() for details.
14868 * @see elm_scroller_bounce_set()
14869 * @see elm_genlist_bounce_get()
14873 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14875 * Get whether the horizontal and vertical bouncing effect is enabled.
14877 * @param obj The genlist object
14878 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
14880 * @param v_bounce Pointer to a bool to receive if the bounce vertically
14883 * @see elm_genlist_bounce_set()
14887 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14889 * Enable/disable homogenous mode.
14891 * @param obj The genlist object
14892 * @param homogeneous Assume the items within the genlist are of the
14893 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
14896 * This will enable the homogeneous mode where items are of the same
14897 * height and width so that genlist may do the lazy-loading at its
14898 * maximum (which increases the performance for scrolling the list). This
14899 * implies 'compressed' mode.
14901 * @see elm_genlist_compress_mode_set()
14902 * @see elm_genlist_homogeneous_get()
14906 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14908 * Get whether the homogenous mode is enabled.
14910 * @param obj The genlist object
14911 * @return Assume the items within the genlist are of the same height
14912 * and width (EINA_TRUE = on, EINA_FALSE = off)
14914 * @see elm_genlist_homogeneous_set()
14918 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14920 * Set the maximum number of items within an item block
14922 * @param obj The genlist object
14923 * @param n Maximum number of items within an item block. Default is 32.
14925 * This will configure the block count to tune to the target with
14926 * particular performance matrix.
14928 * A block of objects will be used to reduce the number of operations due to
14929 * many objects in the screen. It can determine the visibility, or if the
14930 * object has changed, it theme needs to be updated, etc. doing this kind of
14931 * calculation to the entire block, instead of per object.
14933 * The default value for the block count is enough for most lists, so unless
14934 * you know you will have a lot of objects visible in the screen at the same
14935 * time, don't try to change this.
14937 * @see elm_genlist_block_count_get()
14938 * @see @ref Genlist_Implementation
14942 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
14944 * Get the maximum number of items within an item block
14946 * @param obj The genlist object
14947 * @return Maximum number of items within an item block
14949 * @see elm_genlist_block_count_set()
14953 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14955 * Set the timeout in seconds for the longpress event.
14957 * @param obj The genlist object
14958 * @param timeout timeout in seconds. Default is 1.
14960 * This option will change how long it takes to send an event "longpressed"
14961 * after the mouse down signal is sent to the list. If this event occurs, no
14962 * "clicked" event will be sent.
14964 * @see elm_genlist_longpress_timeout_set()
14968 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
14970 * Get the timeout in seconds for the longpress event.
14972 * @param obj The genlist object
14973 * @return timeout in seconds
14975 * @see elm_genlist_longpress_timeout_get()
14979 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14981 * Append a new item in a given genlist widget.
14983 * @param obj The genlist object
14984 * @param itc The item class for the item
14985 * @param data The item data
14986 * @param parent The parent item, or NULL if none
14987 * @param flags Item flags
14988 * @param func Convenience function called when the item is selected
14989 * @param func_data Data passed to @p func above.
14990 * @return A handle to the item added or @c NULL if not possible
14992 * This adds the given item to the end of the list or the end of
14993 * the children list if the @p parent is given.
14995 * @see elm_genlist_item_prepend()
14996 * @see elm_genlist_item_insert_before()
14997 * @see elm_genlist_item_insert_after()
14998 * @see elm_genlist_item_del()
15002 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);
15004 * Prepend a new item in a given genlist widget.
15006 * @param obj The genlist object
15007 * @param itc The item class for the item
15008 * @param data The item data
15009 * @param parent The parent item, or NULL if none
15010 * @param flags Item flags
15011 * @param func Convenience function called when the item is selected
15012 * @param func_data Data passed to @p func above.
15013 * @return A handle to the item added or NULL if not possible
15015 * This adds an item to the beginning of the list or beginning of the
15016 * children of the parent if given.
15018 * @see elm_genlist_item_append()
15019 * @see elm_genlist_item_insert_before()
15020 * @see elm_genlist_item_insert_after()
15021 * @see elm_genlist_item_del()
15025 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);
15027 * Insert an item before another in a genlist widget
15029 * @param obj The genlist object
15030 * @param itc The item class for the item
15031 * @param data The item data
15032 * @param before The item to place this new one before.
15033 * @param flags Item flags
15034 * @param func Convenience function called when the item is selected
15035 * @param func_data Data passed to @p func above.
15036 * @return A handle to the item added or @c NULL if not possible
15038 * This inserts an item before another in the list. It will be in the
15039 * same tree level or group as the item it is inserted before.
15041 * @see elm_genlist_item_append()
15042 * @see elm_genlist_item_prepend()
15043 * @see elm_genlist_item_insert_after()
15044 * @see elm_genlist_item_del()
15048 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);
15050 * Insert an item after another in a genlist widget
15052 * @param obj The genlist object
15053 * @param itc The item class for the item
15054 * @param data The item data
15055 * @param after The item to place this new one after.
15056 * @param flags Item flags
15057 * @param func Convenience function called when the item is selected
15058 * @param func_data Data passed to @p func above.
15059 * @return A handle to the item added or @c NULL if not possible
15061 * This inserts an item after another in the list. It will be in the
15062 * same tree level or group as the item it is inserted after.
15064 * @see elm_genlist_item_append()
15065 * @see elm_genlist_item_prepend()
15066 * @see elm_genlist_item_insert_before()
15067 * @see elm_genlist_item_del()
15071 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);
15073 * Insert a new item into the sorted genlist object
15075 * @param obj The genlist object
15076 * @param itc The item class for the item
15077 * @param data The item data
15078 * @param parent The parent item, or NULL if none
15079 * @param flags Item flags
15080 * @param comp The function called for the sort
15081 * @param func Convenience function called when item selected
15082 * @param func_data Data passed to @p func above.
15083 * @return A handle to the item added or NULL if not possible
15087 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);
15088 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);
15089 /* operations to retrieve existing items */
15091 * Get the selectd item in the genlist.
15093 * @param obj The genlist object
15094 * @return The selected item, or NULL if none is selected.
15096 * This gets the selected item in the list (if multi-selection is enabled, only
15097 * the item that was first selected in the list is returned - which is not very
15098 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
15101 * If no item is selected, NULL is returned.
15103 * @see elm_genlist_selected_items_get()
15107 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15109 * Get a list of selected items in the genlist.
15111 * @param obj The genlist object
15112 * @return The list of selected items, or NULL if none are selected.
15114 * It returns a list of the selected items. This list pointer is only valid so
15115 * long as the selection doesn't change (no items are selected or unselected, or
15116 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
15117 * pointers. The order of the items in this list is the order which they were
15118 * selected, i.e. the first item in this list is the first item that was
15119 * selected, and so on.
15121 * @note If not in multi-select mode, consider using function
15122 * elm_genlist_selected_item_get() instead.
15124 * @see elm_genlist_multi_select_set()
15125 * @see elm_genlist_selected_item_get()
15129 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15131 * Get a list of realized items in genlist
15133 * @param obj The genlist object
15134 * @return The list of realized items, nor NULL if none are realized.
15136 * This returns a list of the realized items in the genlist. The list
15137 * contains Elm_Genlist_Item pointers. The list must be freed by the
15138 * caller when done with eina_list_free(). The item pointers in the
15139 * list are only valid so long as those items are not deleted or the
15140 * genlist is not deleted.
15142 * @see elm_genlist_realized_items_update()
15146 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15148 * Get the item that is at the x, y canvas coords.
15150 * @param obj The gelinst object.
15151 * @param x The input x coordinate
15152 * @param y The input y coordinate
15153 * @param posret The position relative to the item returned here
15154 * @return The item at the coordinates or NULL if none
15156 * This returns the item at the given coordinates (which are canvas
15157 * relative, not object-relative). If an item is at that coordinate,
15158 * that item handle is returned, and if @p posret is not NULL, the
15159 * integer pointed to is set to a value of -1, 0 or 1, depending if
15160 * the coordinate is on the upper portion of that item (-1), on the
15161 * middle section (0) or on the lower part (1). If NULL is returned as
15162 * an item (no item found there), then posret may indicate -1 or 1
15163 * based if the coordinate is above or below all items respectively in
15168 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);
15170 * Get the first item in the genlist
15172 * This returns the first item in the list.
15174 * @param obj The genlist object
15175 * @return The first item, or NULL if none
15179 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15181 * Get the last item in the genlist
15183 * This returns the last item in the list.
15185 * @return The last item, or NULL if none
15189 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15191 * Set the scrollbar policy
15193 * @param obj The genlist object
15194 * @param policy_h Horizontal scrollbar policy.
15195 * @param policy_v Vertical scrollbar policy.
15197 * This sets the scrollbar visibility policy for the given genlist
15198 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
15199 * made visible if it is needed, and otherwise kept hidden.
15200 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
15201 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
15202 * respectively for the horizontal and vertical scrollbars. Default is
15203 * #ELM_SMART_SCROLLER_POLICY_AUTO
15205 * @see elm_genlist_scroller_policy_get()
15209 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15211 * Get the scrollbar policy
15213 * @param obj The genlist object
15214 * @param policy_h Pointer to store the horizontal scrollbar policy.
15215 * @param policy_v Pointer to store the vertical scrollbar policy.
15217 * @see elm_genlist_scroller_policy_set()
15221 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);
15223 * Get the @b next item in a genlist widget's internal list of items,
15224 * given a handle to one of those items.
15226 * @param item The genlist item to fetch next from
15227 * @return The item after @p item, or @c NULL if there's none (and
15230 * This returns the item placed after the @p item, on the container
15233 * @see elm_genlist_item_prev_get()
15237 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15239 * Get the @b previous item in a genlist widget's internal list of items,
15240 * given a handle to one of those items.
15242 * @param item The genlist item to fetch previous from
15243 * @return The item before @p item, or @c NULL if there's none (and
15246 * This returns the item placed before the @p item, on the container
15249 * @see elm_genlist_item_next_get()
15253 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15255 * Get the genlist object's handle which contains a given genlist
15258 * @param item The item to fetch the container from
15259 * @return The genlist (parent) object
15261 * This returns the genlist object itself that an item belongs to.
15265 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15267 * Get the parent item of the given item
15269 * @param it The item
15270 * @return The parent of the item or @c NULL if it has no parent.
15272 * This returns the item that was specified as parent of the item @p it on
15273 * elm_genlist_item_append() and insertion related functions.
15277 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15279 * Remove all sub-items (children) of the given item
15281 * @param it The item
15283 * This removes all items that are children (and their descendants) of the
15284 * given item @p it.
15286 * @see elm_genlist_clear()
15287 * @see elm_genlist_item_del()
15291 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15293 * Set whether a given genlist item is selected or not
15295 * @param it The item
15296 * @param selected Use @c EINA_TRUE, to make it selected, @c
15297 * EINA_FALSE to make it unselected
15299 * This sets the selected state of an item. If multi selection is
15300 * not enabled on the containing genlist and @p selected is @c
15301 * EINA_TRUE, any other previously selected items will get
15302 * unselected in favor of this new one.
15304 * @see elm_genlist_item_selected_get()
15308 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15310 * Get whether a given genlist item is selected or not
15312 * @param it The item
15313 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
15315 * @see elm_genlist_item_selected_set() for more details
15319 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15321 * Sets the expanded state of an item.
15323 * @param it The item
15324 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
15326 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
15329 * The theme will respond to this change visually, and a signal "expanded" or
15330 * "contracted" will be sent from the genlist with a pointer to the item that
15331 * has been expanded/contracted.
15333 * Calling this function won't show or hide any child of this item (if it is
15334 * a parent). You must manually delete and create them on the callbacks fo
15335 * the "expanded" or "contracted" signals.
15337 * @see elm_genlist_item_expanded_get()
15341 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
15343 * Get the expanded state of an item
15345 * @param it The item
15346 * @return The expanded state
15348 * This gets the expanded state of an item.
15350 * @see elm_genlist_item_expanded_set()
15354 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15356 * Get the depth of expanded item
15358 * @param it The genlist item object
15359 * @return The depth of expanded item
15363 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15365 * Set whether a given genlist item is disabled or not.
15367 * @param it The item
15368 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
15369 * to enable it back.
15371 * A disabled item cannot be selected or unselected. It will also
15372 * change its appearance, to signal the user it's disabled.
15374 * @see elm_genlist_item_disabled_get()
15378 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15380 * Get whether a given genlist item is disabled or not.
15382 * @param it The item
15383 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
15386 * @see elm_genlist_item_disabled_set() for more details
15390 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15392 * Sets the display only state of an item.
15394 * @param it The item
15395 * @param display_only @c EINA_TRUE if the item is display only, @c
15396 * EINA_FALSE otherwise.
15398 * A display only item cannot be selected or unselected. It is for
15399 * display only and not selecting or otherwise clicking, dragging
15400 * etc. by the user, thus finger size rules will not be applied to
15403 * It's good to set group index items to display only state.
15405 * @see elm_genlist_item_display_only_get()
15409 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
15411 * Get the display only state of an item
15413 * @param it The item
15414 * @return @c EINA_TRUE if the item is display only, @c
15415 * EINA_FALSE otherwise.
15417 * @see elm_genlist_item_display_only_set()
15421 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15423 * Show the portion of a genlist's internal list containing a given
15424 * item, immediately.
15426 * @param it The item to display
15428 * This causes genlist to jump to the given item @p it and show it (by
15429 * immediately scrolling to that position), if it is not fully visible.
15431 * @see elm_genlist_item_bring_in()
15432 * @see elm_genlist_item_top_show()
15433 * @see elm_genlist_item_middle_show()
15437 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15439 * Animatedly bring in, to the visible are of a genlist, a given
15442 * @param it The item to display
15444 * This causes genlist to jump to the given item @p it and show it (by
15445 * animatedly scrolling), if it is not fully visible. This may use animation
15446 * to do so and take a period of time
15448 * @see elm_genlist_item_show()
15449 * @see elm_genlist_item_top_bring_in()
15450 * @see elm_genlist_item_middle_bring_in()
15454 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15456 * Show the portion of a genlist's internal list containing a given
15457 * item, immediately.
15459 * @param it The item to display
15461 * This causes genlist to jump to the given item @p it and show it (by
15462 * immediately scrolling to that position), if it is not fully visible.
15464 * The item will be positioned at the top of the genlist viewport.
15466 * @see elm_genlist_item_show()
15467 * @see elm_genlist_item_top_bring_in()
15471 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15473 * Animatedly bring in, to the visible are of a genlist, a given
15476 * @param it The item
15478 * This causes genlist to jump to the given item @p it and show it (by
15479 * animatedly scrolling), if it is not fully visible. This may use animation
15480 * to do so and take a period of time
15482 * The item will be positioned at the top of the genlist viewport.
15484 * @see elm_genlist_item_bring_in()
15485 * @see elm_genlist_item_top_show()
15489 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15491 * Show the portion of a genlist's internal list containing a given
15492 * item, immediately.
15494 * @param it The item to display
15496 * This causes genlist to jump to the given item @p it and show it (by
15497 * immediately scrolling to that position), if it is not fully visible.
15499 * The item will be positioned at the middle of the genlist viewport.
15501 * @see elm_genlist_item_show()
15502 * @see elm_genlist_item_middle_bring_in()
15506 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15508 * Animatedly bring in, to the visible are of a genlist, a given
15511 * @param it The item
15513 * This causes genlist to jump to the given item @p it and show it (by
15514 * animatedly scrolling), if it is not fully visible. This may use animation
15515 * to do so and take a period of time
15517 * The item will be positioned at the middle of the genlist viewport.
15519 * @see elm_genlist_item_bring_in()
15520 * @see elm_genlist_item_middle_show()
15524 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15526 * Remove a genlist item from the its parent, deleting it.
15528 * @param item The item to be removed.
15529 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
15531 * @see elm_genlist_clear(), to remove all items in a genlist at
15536 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15538 * Return the data associated to a given genlist item
15540 * @param item The genlist item.
15541 * @return the data associated to this item.
15543 * This returns the @c data value passed on the
15544 * elm_genlist_item_append() and related item addition calls.
15546 * @see elm_genlist_item_append()
15547 * @see elm_genlist_item_data_set()
15551 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15553 * Set the data associated to a given genlist item
15555 * @param item The genlist item
15556 * @param data The new data pointer to set on it
15558 * This @b overrides the @c data value passed on the
15559 * elm_genlist_item_append() and related item addition calls. This
15560 * function @b won't call elm_genlist_item_update() automatically,
15561 * so you'd issue it afterwards if you want to hove the item
15562 * updated to reflect the that new data.
15564 * @see elm_genlist_item_data_get()
15568 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
15570 * Tells genlist to "orphan" icons fetchs by the item class
15572 * @param it The item
15574 * This instructs genlist to release references to icons in the item,
15575 * meaning that they will no longer be managed by genlist and are
15576 * floating "orphans" that can be re-used elsewhere if the user wants
15581 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15583 * Get the real Evas object created to implement the view of a
15584 * given genlist item
15586 * @param item The genlist item.
15587 * @return the Evas object implementing this item's view.
15589 * This returns the actual Evas object used to implement the
15590 * specified genlist item's view. This may be @c NULL, as it may
15591 * not have been created or may have been deleted, at any time, by
15592 * the genlist. <b>Do not modify this object</b> (move, resize,
15593 * show, hide, etc.), as the genlist is controlling it. This
15594 * function is for querying, emitting custom signals or hooking
15595 * lower level callbacks for events on that object. Do not delete
15596 * this object under any circumstances.
15598 * @see elm_genlist_item_data_get()
15602 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15604 * Update the contents of an item
15606 * @param it The item
15608 * This updates an item by calling all the item class functions again
15609 * to get the icons, labels and states. Use this when the original
15610 * item data has changed and the changes are desired to be reflected.
15612 * Use elm_genlist_realized_items_update() to update all already realized
15615 * @see elm_genlist_realized_items_update()
15619 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15621 * Update the item class of an item
15623 * @param it The item
15624 * @param itc The item class for the item
15626 * This sets another class fo the item, changing the way that it is
15627 * displayed. After changing the item class, elm_genlist_item_update() is
15628 * called on the item @p it.
15632 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
15633 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
15635 * Set the text to be shown in a given genlist item's tooltips.
15637 * @param item The genlist item
15638 * @param text The text to set in the content
15640 * This call will setup the text to be used as tooltip to that item
15641 * (analogous to elm_object_tooltip_text_set(), but being item
15642 * tooltips with higher precedence than object tooltips). It can
15643 * have only one tooltip at a time, so any previous tooltip data
15644 * will get removed.
15646 * In order to set an icon or something else as a tooltip, look at
15647 * elm_genlist_item_tooltip_content_cb_set().
15651 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
15653 * Set the content to be shown in a given genlist item's tooltips
15655 * @param item The genlist item.
15656 * @param func The function returning the tooltip contents.
15657 * @param data What to provide to @a func as callback data/context.
15658 * @param del_cb Called when data is not needed anymore, either when
15659 * another callback replaces @p func, the tooltip is unset with
15660 * elm_genlist_item_tooltip_unset() or the owner @p item
15661 * dies. This callback receives as its first parameter the
15662 * given @p data, being @c event_info the item handle.
15664 * This call will setup the tooltip's contents to @p item
15665 * (analogous to elm_object_tooltip_content_cb_set(), but being
15666 * item tooltips with higher precedence than object tooltips). It
15667 * can have only one tooltip at a time, so any previous tooltip
15668 * content will get removed. @p func (with @p data) will be called
15669 * every time Elementary needs to show the tooltip and it should
15670 * return a valid Evas object, which will be fully managed by the
15671 * tooltip system, getting deleted when the tooltip is gone.
15673 * In order to set just a text as a tooltip, look at
15674 * elm_genlist_item_tooltip_text_set().
15678 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);
15680 * Unset a tooltip from a given genlist item
15682 * @param item genlist item to remove a previously set tooltip from.
15684 * This call removes any tooltip set on @p item. The callback
15685 * provided as @c del_cb to
15686 * elm_genlist_item_tooltip_content_cb_set() will be called to
15687 * notify it is not used anymore (and have resources cleaned, if
15690 * @see elm_genlist_item_tooltip_content_cb_set()
15694 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15696 * Set a different @b style for a given genlist item's tooltip.
15698 * @param item genlist item with tooltip set
15699 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
15700 * "default", @c "transparent", etc)
15702 * Tooltips can have <b>alternate styles</b> to be displayed on,
15703 * which are defined by the theme set on Elementary. This function
15704 * works analogously as elm_object_tooltip_style_set(), but here
15705 * applied only to genlist item objects. The default style for
15706 * tooltips is @c "default".
15708 * @note before you set a style you should define a tooltip with
15709 * elm_genlist_item_tooltip_content_cb_set() or
15710 * elm_genlist_item_tooltip_text_set()
15712 * @see elm_genlist_item_tooltip_style_get()
15716 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15718 * Get the style set a given genlist item's tooltip.
15720 * @param item genlist item with tooltip already set on.
15721 * @return style the theme style in use, which defaults to
15722 * "default". If the object does not have a tooltip set,
15723 * then @c NULL is returned.
15725 * @see elm_genlist_item_tooltip_style_set() for more details
15729 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15731 * @brief Disable size restrictions on an object's tooltip
15732 * @param item The tooltip's anchor object
15733 * @param disable If EINA_TRUE, size restrictions are disabled
15734 * @return EINA_FALSE on failure, EINA_TRUE on success
15736 * This function allows a tooltip to expand beyond its parant window's canvas.
15737 * It will instead be limited only by the size of the display.
15739 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
15741 * @brief Retrieve size restriction state of an object's tooltip
15742 * @param item The tooltip's anchor object
15743 * @return If EINA_TRUE, size restrictions are disabled
15745 * This function returns whether a tooltip is allowed to expand beyond
15746 * its parant window's canvas.
15747 * It will instead be limited only by the size of the display.
15749 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
15751 * Set the type of mouse pointer/cursor decoration to be shown,
15752 * when the mouse pointer is over the given genlist widget item
15754 * @param item genlist item to customize cursor on
15755 * @param cursor the cursor type's name
15757 * This function works analogously as elm_object_cursor_set(), but
15758 * here the cursor's changing area is restricted to the item's
15759 * area, and not the whole widget's. Note that that item cursors
15760 * have precedence over widget cursors, so that a mouse over @p
15761 * item will always show cursor @p type.
15763 * If this function is called twice for an object, a previously set
15764 * cursor will be unset on the second call.
15766 * @see elm_object_cursor_set()
15767 * @see elm_genlist_item_cursor_get()
15768 * @see elm_genlist_item_cursor_unset()
15772 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15774 * Get the type of mouse pointer/cursor decoration set to be shown,
15775 * when the mouse pointer is over the given genlist widget item
15777 * @param item genlist item with custom cursor set
15778 * @return the cursor type's name or @c NULL, if no custom cursors
15779 * were set to @p item (and on errors)
15781 * @see elm_object_cursor_get()
15782 * @see elm_genlist_item_cursor_set() for more details
15783 * @see elm_genlist_item_cursor_unset()
15787 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15789 * Unset any custom mouse pointer/cursor decoration set to be
15790 * shown, when the mouse pointer is over the given genlist widget
15791 * item, thus making it show the @b default cursor again.
15793 * @param item a genlist item
15795 * Use this call to undo any custom settings on this item's cursor
15796 * decoration, bringing it back to defaults (no custom style set).
15798 * @see elm_object_cursor_unset()
15799 * @see elm_genlist_item_cursor_set() for more details
15803 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15805 * Set a different @b style for a given custom cursor set for a
15808 * @param item genlist item with custom cursor set
15809 * @param style the <b>theme style</b> to use (e.g. @c "default",
15810 * @c "transparent", etc)
15812 * This function only makes sense when one is using custom mouse
15813 * cursor decorations <b>defined in a theme file</b> , which can
15814 * have, given a cursor name/type, <b>alternate styles</b> on
15815 * it. It works analogously as elm_object_cursor_style_set(), but
15816 * here applied only to genlist item objects.
15818 * @warning Before you set a cursor style you should have defined a
15819 * custom cursor previously on the item, with
15820 * elm_genlist_item_cursor_set()
15822 * @see elm_genlist_item_cursor_engine_only_set()
15823 * @see elm_genlist_item_cursor_style_get()
15827 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
15829 * Get the current @b style set for a given genlist item's custom
15832 * @param item genlist item with custom cursor set.
15833 * @return style the cursor style in use. If the object does not
15834 * have a cursor set, then @c NULL is returned.
15836 * @see elm_genlist_item_cursor_style_set() for more details
15840 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15842 * Set if the (custom) cursor for a given genlist item should be
15843 * searched in its theme, also, or should only rely on the
15844 * rendering engine.
15846 * @param item item with custom (custom) cursor already set on
15847 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15848 * only on those provided by the rendering engine, @c EINA_FALSE to
15849 * have them searched on the widget's theme, as well.
15851 * @note This call is of use only if you've set a custom cursor
15852 * for genlist items, with elm_genlist_item_cursor_set().
15854 * @note By default, cursors will only be looked for between those
15855 * provided by the rendering engine.
15859 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15861 * Get if the (custom) cursor for a given genlist item is being
15862 * searched in its theme, also, or is only relying on the rendering
15865 * @param item a genlist item
15866 * @return @c EINA_TRUE, if cursors are being looked for only on
15867 * those provided by the rendering engine, @c EINA_FALSE if they
15868 * are being searched on the widget's theme, as well.
15870 * @see elm_genlist_item_cursor_engine_only_set(), for more details
15874 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
15876 * Update the contents of all realized items.
15878 * @param obj The genlist object.
15880 * This updates all realized items by calling all the item class functions again
15881 * to get the icons, labels and states. Use this when the original
15882 * item data has changed and the changes are desired to be reflected.
15884 * To update just one item, use elm_genlist_item_update().
15886 * @see elm_genlist_realized_items_get()
15887 * @see elm_genlist_item_update()
15891 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
15893 * Activate a genlist mode on an item
15895 * @param item The genlist item
15896 * @param mode Mode name
15897 * @param mode_set Boolean to define set or unset mode.
15899 * A genlist mode is a different way of selecting an item. Once a mode is
15900 * activated on an item, any other selected item is immediately unselected.
15901 * This feature provides an easy way of implementing a new kind of animation
15902 * for selecting an item, without having to entirely rewrite the item style
15903 * theme. However, the elm_genlist_selected_* API can't be used to get what
15904 * item is activate for a mode.
15906 * The current item style will still be used, but applying a genlist mode to
15907 * an item will select it using a different kind of animation.
15909 * The current active item for a mode can be found by
15910 * elm_genlist_mode_item_get().
15912 * The characteristics of genlist mode are:
15913 * - Only one mode can be active at any time, and for only one item.
15914 * - Genlist handles deactivating other items when one item is activated.
15915 * - A mode is defined in the genlist theme (edc), and more modes can easily
15917 * - A mode style and the genlist item style are different things. They
15918 * can be combined to provide a default style to the item, with some kind
15919 * of animation for that item when the mode is activated.
15921 * When a mode is activated on an item, a new view for that item is created.
15922 * The theme of this mode defines the animation that will be used to transit
15923 * the item from the old view to the new view. This second (new) view will be
15924 * active for that item while the mode is active on the item, and will be
15925 * destroyed after the mode is totally deactivated from that item.
15927 * @see elm_genlist_mode_get()
15928 * @see elm_genlist_mode_item_get()
15932 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
15934 * Get the last (or current) genlist mode used.
15936 * @param obj The genlist object
15938 * This function just returns the name of the last used genlist mode. It will
15939 * be the current mode if it's still active.
15941 * @see elm_genlist_item_mode_set()
15942 * @see elm_genlist_mode_item_get()
15946 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15948 * Get active genlist mode item
15950 * @param obj The genlist object
15951 * @return The active item for that current mode. Or @c NULL if no item is
15952 * activated with any mode.
15954 * This function returns the item that was activated with a mode, by the
15955 * function elm_genlist_item_mode_set().
15957 * @see elm_genlist_item_mode_set()
15958 * @see elm_genlist_mode_get()
15962 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15963 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
15964 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15971 * @defgroup Check Check
15973 * @image html img/widget/check/preview-00.png
15974 * @image latex img/widget/check/preview-00.eps
15975 * @image html img/widget/check/preview-01.png
15976 * @image latex img/widget/check/preview-01.eps
15977 * @image html img/widget/check/preview-02.png
15978 * @image latex img/widget/check/preview-02.eps
15980 * @brief The check widget allows for toggling a value between true and
15983 * Check objects are a lot like radio objects in layout and functionality
15984 * except they do not work as a group, but independently and only toggle the
15985 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
15986 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
15987 * returns the current state. For convenience, like the radio objects, you
15988 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
15989 * for it to modify.
15991 * Signals that you can add callbacks for are:
15992 * "changed" - This is called whenever the user changes the state of one of
15993 * the check object(event_info is NULL).
15995 * @ref tutorial_check should give you a firm grasp of how to use this widget.
15999 * @brief Add a new Check object
16001 * @param parent The parent object
16002 * @return The new object or NULL if it cannot be created
16004 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16006 * @brief Set the text label of the check object
16008 * @param obj The check object
16009 * @param label The text label string in UTF-8
16011 * @deprecated use elm_object_text_set() instead.
16013 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16015 * @brief Get the text label of the check object
16017 * @param obj The check object
16018 * @return The text label string in UTF-8
16020 * @deprecated use elm_object_text_get() instead.
16022 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16024 * @brief Set the icon object of the check object
16026 * @param obj The check object
16027 * @param icon The icon object
16029 * Once the icon object is set, a previously set one will be deleted.
16030 * If you want to keep that old content object, use the
16031 * elm_check_icon_unset() function.
16033 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16035 * @brief Get the icon object of the check object
16037 * @param obj The check object
16038 * @return The icon object
16040 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16042 * @brief Unset the icon used for the check object
16044 * @param obj The check object
16045 * @return The icon object that was being used
16047 * Unparent and return the icon object which was set for this widget.
16049 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16051 * @brief Set the on/off state of the check object
16053 * @param obj The check object
16054 * @param state The state to use (1 == on, 0 == off)
16056 * This sets the state of the check. If set
16057 * with elm_check_state_pointer_set() the state of that variable is also
16058 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
16060 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
16062 * @brief Get the state of the check object
16064 * @param obj The check object
16065 * @return The boolean state
16067 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16069 * @brief Set a convenience pointer to a boolean to change
16071 * @param obj The check object
16072 * @param statep Pointer to the boolean to modify
16074 * This sets a pointer to a boolean, that, in addition to the check objects
16075 * state will also be modified directly. To stop setting the object pointed
16076 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
16077 * then when this is called, the check objects state will also be modified to
16078 * reflect the value of the boolean @p statep points to, just like calling
16079 * elm_check_state_set().
16081 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
16087 * @defgroup Radio Radio
16089 * @image html img/widget/radio/preview-00.png
16090 * @image latex img/widget/radio/preview-00.eps
16092 * @brief Radio is a widget that allows for 1 or more options to be displayed
16093 * and have the user choose only 1 of them.
16095 * A radio object contains an indicator, an optional Label and an optional
16096 * icon object. While it's possible to have a group of only one radio they,
16097 * are normally used in groups of 2 or more. To add a radio to a group use
16098 * elm_radio_group_add(). The radio object(s) will select from one of a set
16099 * of integer values, so any value they are configuring needs to be mapped to
16100 * a set of integers. To configure what value that radio object represents,
16101 * use elm_radio_state_value_set() to set the integer it represents. To set
16102 * the value the whole group(which one is currently selected) is to indicate
16103 * use elm_radio_value_set() on any group member, and to get the groups value
16104 * use elm_radio_value_get(). For convenience the radio objects are also able
16105 * to directly set an integer(int) to the value that is selected. To specify
16106 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
16107 * The radio objects will modify this directly. That implies the pointer must
16108 * point to valid memory for as long as the radio objects exist.
16110 * Signals that you can add callbacks for are:
16111 * @li changed - This is called whenever the user changes the state of one of
16112 * the radio objects within the group of radio objects that work together.
16114 * @ref tutorial_radio show most of this API in action.
16118 * @brief Add a new radio to the parent
16120 * @param parent The parent object
16121 * @return The new object or NULL if it cannot be created
16123 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16125 * @brief Set the text label of the radio object
16127 * @param obj The radio object
16128 * @param label The text label string in UTF-8
16130 * @deprecated use elm_object_text_set() instead.
16132 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16134 * @brief Get the text label of the radio object
16136 * @param obj The radio object
16137 * @return The text label string in UTF-8
16139 * @deprecated use elm_object_text_set() instead.
16141 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16143 * @brief Set the icon object of the radio object
16145 * @param obj The radio object
16146 * @param icon The icon object
16148 * Once the icon object is set, a previously set one will be deleted. If you
16149 * want to keep that old content object, use the elm_radio_icon_unset()
16152 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16154 * @brief Get the icon object of the radio object
16156 * @param obj The radio object
16157 * @return The icon object
16159 * @see elm_radio_icon_set()
16161 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16163 * @brief Unset the icon used for the radio object
16165 * @param obj The radio object
16166 * @return The icon object that was being used
16168 * Unparent and return the icon object which was set for this widget.
16170 * @see elm_radio_icon_set()
16172 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16174 * @brief Add this radio to a group of other radio objects
16176 * @param obj The radio object
16177 * @param group Any object whose group the @p obj is to join.
16179 * Radio objects work in groups. Each member should have a different integer
16180 * value assigned. In order to have them work as a group, they need to know
16181 * about each other. This adds the given radio object to the group of which
16182 * the group object indicated is a member.
16184 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
16186 * @brief Set the integer value that this radio object represents
16188 * @param obj The radio object
16189 * @param value The value to use if this radio object is selected
16191 * This sets the value of the radio.
16193 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16195 * @brief Get the integer value that this radio object represents
16197 * @param obj The radio object
16198 * @return The value used if this radio object is selected
16200 * This gets the value of the radio.
16202 * @see elm_radio_value_set()
16204 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16206 * @brief Set the value of the radio.
16208 * @param obj The radio object
16209 * @param value The value to use for the group
16211 * This sets the value of the radio group and will also set the value if
16212 * pointed to, to the value supplied, but will not call any callbacks.
16214 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
16216 * @brief Get the state of the radio object
16218 * @param obj The radio object
16219 * @return The integer state
16221 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16223 * @brief Set a convenience pointer to a integer to change
16225 * @param obj The radio object
16226 * @param valuep Pointer to the integer to modify
16228 * This sets a pointer to a integer, that, in addition to the radio objects
16229 * state will also be modified directly. To stop setting the object pointed
16230 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
16231 * when this is called, the radio objects state will also be modified to
16232 * reflect the value of the integer valuep points to, just like calling
16233 * elm_radio_value_set().
16235 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
16241 * @defgroup Pager Pager
16243 * @image html img/widget/pager/preview-00.png
16244 * @image latex img/widget/pager/preview-00.eps
16246 * @brief Widget that allows flipping between 1 or more “pages” of objects.
16248 * The flipping between “pages” of objects is animated. All content in pager
16249 * is kept in a stack, the last content to be added will be on the top of the
16250 * stack(be visible).
16252 * Objects can be pushed or popped from the stack or deleted as normal.
16253 * Pushes and pops will animate (and a pop will delete the object once the
16254 * animation is finished). Any object already in the pager can be promoted to
16255 * the top(from its current stacking position) through the use of
16256 * elm_pager_content_promote(). Objects are pushed to the top with
16257 * elm_pager_content_push() and when the top item is no longer wanted, simply
16258 * pop it with elm_pager_content_pop() and it will also be deleted. If an
16259 * object is no longer needed and is not the top item, just delete it as
16260 * normal. You can query which objects are the top and bottom with
16261 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
16263 * Signals that you can add callbacks for are:
16264 * "hide,finished" - when the previous page is hided
16266 * This widget has the following styles available:
16269 * @li fade_translucide
16270 * @li fade_invisible
16271 * @note This styles affect only the flipping animations, the appearance when
16272 * not animating is unaffected by styles.
16274 * @ref tutorial_pager gives a good overview of the usage of the API.
16278 * Add a new pager to the parent
16280 * @param parent The parent object
16281 * @return The new object or NULL if it cannot be created
16285 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16287 * @brief Push an object to the top of the pager stack (and show it).
16289 * @param obj The pager object
16290 * @param content The object to push
16292 * The object pushed becomes a child of the pager, it will be controlled and
16293 * deleted when the pager is deleted.
16295 * @note If the content is already in the stack use
16296 * elm_pager_content_promote().
16297 * @warning Using this function on @p content already in the stack results in
16298 * undefined behavior.
16300 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16302 * @brief Pop the object that is on top of the stack
16304 * @param obj The pager object
16306 * This pops the object that is on the top(visible) of the pager, makes it
16307 * disappear, then deletes the object. The object that was underneath it on
16308 * the stack will become visible.
16310 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
16312 * @brief Moves an object already in the pager stack to the top of the stack.
16314 * @param obj The pager object
16315 * @param content The object to promote
16317 * This will take the @p content and move it to the top of the stack as
16318 * if it had been pushed there.
16320 * @note If the content isn't already in the stack use
16321 * elm_pager_content_push().
16322 * @warning Using this function on @p content not already in the stack
16323 * results in undefined behavior.
16325 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
16327 * @brief Return the object at the bottom of the pager stack
16329 * @param obj The pager object
16330 * @return The bottom object or NULL if none
16332 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16334 * @brief Return the object at the top of the pager stack
16336 * @param obj The pager object
16337 * @return The top object or NULL if none
16339 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16345 * @defgroup Slideshow Slideshow
16347 * @image html img/widget/slideshow/preview-00.png
16348 * @image latex img/widget/slideshow/preview-00.eps
16350 * This widget, as the name indicates, is a pre-made image
16351 * slideshow panel, with API functions acting on (child) image
16352 * items presentation. Between those actions, are:
16353 * - advance to next/previous image
16354 * - select the style of image transition animation
16355 * - set the exhibition time for each image
16356 * - start/stop the slideshow
16358 * The transition animations are defined in the widget's theme,
16359 * consequently new animations can be added without having to
16360 * update the widget's code.
16362 * @section Slideshow_Items Slideshow items
16364 * For slideshow items, just like for @ref Genlist "genlist" ones,
16365 * the user defines a @b classes, specifying functions that will be
16366 * called on the item's creation and deletion times.
16368 * The #Elm_Slideshow_Item_Class structure contains the following
16371 * - @c func.get - When an item is displayed, this function is
16372 * called, and it's where one should create the item object, de
16373 * facto. For example, the object can be a pure Evas image object
16374 * or an Elementary @ref Photocam "photocam" widget. See
16375 * #SlideshowItemGetFunc.
16376 * - @c func.del - When an item is no more displayed, this function
16377 * is called, where the user must delete any data associated to
16378 * the item. See #SlideshowItemDelFunc.
16380 * @section Slideshow_Caching Slideshow caching
16382 * The slideshow provides facilities to have items adjacent to the
16383 * one being displayed <b>already "realized"</b> (i.e. loaded) for
16384 * you, so that the system does not have to decode image data
16385 * anymore at the time it has to actually switch images on its
16386 * viewport. The user is able to set the numbers of items to be
16387 * cached @b before and @b after the current item, in the widget's
16390 * Smart events one can add callbacks for are:
16392 * - @c "changed" - when the slideshow switches its view to a new
16395 * List of examples for the slideshow widget:
16396 * @li @ref slideshow_example
16400 * @addtogroup Slideshow
16404 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
16405 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
16406 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
16407 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
16408 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
16411 * @struct _Elm_Slideshow_Item_Class
16413 * Slideshow item class definition. See @ref Slideshow_Items for
16416 struct _Elm_Slideshow_Item_Class
16418 struct _Elm_Slideshow_Item_Class_Func
16420 SlideshowItemGetFunc get;
16421 SlideshowItemDelFunc del;
16423 }; /**< #Elm_Slideshow_Item_Class member definitions */
16426 * Add a new slideshow widget to the given parent Elementary
16427 * (container) object
16429 * @param parent The parent object
16430 * @return A new slideshow widget handle or @c NULL, on errors
16432 * This function inserts a new slideshow widget on the canvas.
16434 * @ingroup Slideshow
16436 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16439 * Add (append) a new item in a given slideshow widget.
16441 * @param obj The slideshow object
16442 * @param itc The item class for the item
16443 * @param data The item's data
16444 * @return A handle to the item added or @c NULL, on errors
16446 * Add a new item to @p obj's internal list of items, appending it.
16447 * The item's class must contain the function really fetching the
16448 * image object to show for this item, which could be an Evas image
16449 * object or an Elementary photo, for example. The @p data
16450 * parameter is going to be passed to both class functions of the
16453 * @see #Elm_Slideshow_Item_Class
16454 * @see elm_slideshow_item_sorted_insert()
16456 * @ingroup Slideshow
16458 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
16461 * Insert a new item into the given slideshow widget, using the @p func
16462 * function to sort items (by item handles).
16464 * @param obj The slideshow object
16465 * @param itc The item class for the item
16466 * @param data The item's data
16467 * @param func The comparing function to be used to sort slideshow
16468 * items <b>by #Elm_Slideshow_Item item handles</b>
16469 * @return Returns The slideshow item handle, on success, or
16470 * @c NULL, on errors
16472 * Add a new item to @p obj's internal list of items, in a position
16473 * determined by the @p func comparing function. The item's class
16474 * must contain the function really fetching the image object to
16475 * show for this item, which could be an Evas image object or an
16476 * Elementary photo, for example. The @p data parameter is going to
16477 * be passed to both class functions of the item.
16479 * @see #Elm_Slideshow_Item_Class
16480 * @see elm_slideshow_item_add()
16482 * @ingroup Slideshow
16484 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);
16487 * Display a given slideshow widget's item, programmatically.
16489 * @param obj The slideshow object
16490 * @param item The item to display on @p obj's viewport
16492 * The change between the current item and @p item will use the
16493 * transition @p obj is set to use (@see
16494 * elm_slideshow_transition_set()).
16496 * @ingroup Slideshow
16498 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16501 * Slide to the @b next item, in a given slideshow widget
16503 * @param obj The slideshow object
16505 * The sliding animation @p obj is set to use will be the
16506 * transition effect used, after this call is issued.
16508 * @note If the end of the slideshow's internal list of items is
16509 * reached, it'll wrap around to the list's beginning, again.
16511 * @ingroup Slideshow
16513 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
16516 * Slide to the @b previous item, in a given slideshow widget
16518 * @param obj The slideshow object
16520 * The sliding animation @p obj is set to use will be the
16521 * transition effect used, after this call is issued.
16523 * @note If the beginning of the slideshow's internal list of items
16524 * is reached, it'll wrap around to the list's end, again.
16526 * @ingroup Slideshow
16528 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
16531 * Returns the list of sliding transition/effect names available, for a
16532 * given slideshow widget.
16534 * @param obj The slideshow object
16535 * @return The list of transitions (list of @b stringshared strings
16538 * The transitions, which come from @p obj's theme, must be an EDC
16539 * data item named @c "transitions" on the theme file, with (prefix)
16540 * names of EDC programs actually implementing them.
16542 * The available transitions for slideshows on the default theme are:
16543 * - @c "fade" - the current item fades out, while the new one
16544 * fades in to the slideshow's viewport.
16545 * - @c "black_fade" - the current item fades to black, and just
16546 * then, the new item will fade in.
16547 * - @c "horizontal" - the current item slides horizontally, until
16548 * it gets out of the slideshow's viewport, while the new item
16549 * comes from the left to take its place.
16550 * - @c "vertical" - the current item slides vertically, until it
16551 * gets out of the slideshow's viewport, while the new item comes
16552 * from the bottom to take its place.
16553 * - @c "square" - the new item starts to appear from the middle of
16554 * the current one, but with a tiny size, growing until its
16555 * target (full) size and covering the old one.
16557 * @warning The stringshared strings get no new references
16558 * exclusive to the user grabbing the list, here, so if you'd like
16559 * to use them out of this call's context, you'd better @c
16560 * eina_stringshare_ref() them.
16562 * @see elm_slideshow_transition_set()
16564 * @ingroup Slideshow
16566 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16569 * Set the current slide transition/effect in use for a given
16572 * @param obj The slideshow object
16573 * @param transition The new transition's name string
16575 * If @p transition is implemented in @p obj's theme (i.e., is
16576 * contained in the list returned by
16577 * elm_slideshow_transitions_get()), this new sliding effect will
16578 * be used on the widget.
16580 * @see elm_slideshow_transitions_get() for more details
16582 * @ingroup Slideshow
16584 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
16587 * Get the current slide transition/effect in use for a given
16590 * @param obj The slideshow object
16591 * @return The current transition's name
16593 * @see elm_slideshow_transition_set() for more details
16595 * @ingroup Slideshow
16597 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16600 * Set the interval between each image transition on a given
16601 * slideshow widget, <b>and start the slideshow, itself</b>
16603 * @param obj The slideshow object
16604 * @param timeout The new displaying timeout for images
16606 * After this call, the slideshow widget will start cycling its
16607 * view, sequentially and automatically, with the images of the
16608 * items it has. The time between each new image displayed is going
16609 * to be @p timeout, in @b seconds. If a different timeout was set
16610 * previously and an slideshow was in progress, it will continue
16611 * with the new time between transitions, after this call.
16613 * @note A value less than or equal to 0 on @p timeout will disable
16614 * the widget's internal timer, thus halting any slideshow which
16615 * could be happening on @p obj.
16617 * @see elm_slideshow_timeout_get()
16619 * @ingroup Slideshow
16621 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16624 * Get the interval set for image transitions on a given slideshow
16627 * @param obj The slideshow object
16628 * @return Returns the timeout set on it
16630 * @see elm_slideshow_timeout_set() for more details
16632 * @ingroup Slideshow
16634 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16637 * Set if, after a slideshow is started, for a given slideshow
16638 * widget, its items should be displayed cyclically or not.
16640 * @param obj The slideshow object
16641 * @param loop Use @c EINA_TRUE to make it cycle through items or
16642 * @c EINA_FALSE for it to stop at the end of @p obj's internal
16645 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
16646 * ignore what is set by this functions, i.e., they'll @b always
16647 * cycle through items. This affects only the "automatic"
16648 * slideshow, as set by elm_slideshow_timeout_set().
16650 * @see elm_slideshow_loop_get()
16652 * @ingroup Slideshow
16654 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
16657 * Get if, after a slideshow is started, for a given slideshow
16658 * widget, its items are to be displayed cyclically or not.
16660 * @param obj The slideshow object
16661 * @return @c EINA_TRUE, if the items in @p obj will be cycled
16662 * through or @c EINA_FALSE, otherwise
16664 * @see elm_slideshow_loop_set() for more details
16666 * @ingroup Slideshow
16668 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16671 * Remove all items from a given slideshow widget
16673 * @param obj The slideshow object
16675 * This removes (and deletes) all items in @p obj, leaving it
16678 * @see elm_slideshow_item_del(), to remove just one item.
16680 * @ingroup Slideshow
16682 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16685 * Get the internal list of items in a given slideshow widget.
16687 * @param obj The slideshow object
16688 * @return The list of items (#Elm_Slideshow_Item as data) or
16689 * @c NULL on errors.
16691 * This list is @b not to be modified in any way and must not be
16692 * freed. Use the list members with functions like
16693 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
16695 * @warning This list is only valid until @p obj object's internal
16696 * items list is changed. It should be fetched again with another
16697 * call to this function when changes happen.
16699 * @ingroup Slideshow
16701 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16704 * Delete a given item from a slideshow widget.
16706 * @param item The slideshow item
16708 * @ingroup Slideshow
16710 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16713 * Return the data associated with a given slideshow item
16715 * @param item The slideshow item
16716 * @return Returns the data associated to this item
16718 * @ingroup Slideshow
16720 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
16723 * Returns the currently displayed item, in a given slideshow widget
16725 * @param obj The slideshow object
16726 * @return A handle to the item being displayed in @p obj or
16727 * @c NULL, if none is (and on errors)
16729 * @ingroup Slideshow
16731 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16734 * Get the real Evas object created to implement the view of a
16735 * given slideshow item
16737 * @param item The slideshow item.
16738 * @return the Evas object implementing this item's view.
16740 * This returns the actual Evas object used to implement the
16741 * specified slideshow item's view. This may be @c NULL, as it may
16742 * not have been created or may have been deleted, at any time, by
16743 * the slideshow. <b>Do not modify this object</b> (move, resize,
16744 * show, hide, etc.), as the slideshow is controlling it. This
16745 * function is for querying, emitting custom signals or hooking
16746 * lower level callbacks for events on that object. Do not delete
16747 * this object under any circumstances.
16749 * @see elm_slideshow_item_data_get()
16751 * @ingroup Slideshow
16753 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
16756 * Get the the item, in a given slideshow widget, placed at
16757 * position @p nth, in its internal items list
16759 * @param obj The slideshow object
16760 * @param nth The number of the item to grab a handle to (0 being
16762 * @return The item stored in @p obj at position @p nth or @c NULL,
16763 * if there's no item with that index (and on errors)
16765 * @ingroup Slideshow
16767 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
16770 * Set the current slide layout in use for a given slideshow widget
16772 * @param obj The slideshow object
16773 * @param layout The new layout's name string
16775 * If @p layout is implemented in @p obj's theme (i.e., is contained
16776 * in the list returned by elm_slideshow_layouts_get()), this new
16777 * images layout will be used on the widget.
16779 * @see elm_slideshow_layouts_get() for more details
16781 * @ingroup Slideshow
16783 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
16786 * Get the current slide layout in use for a given slideshow widget
16788 * @param obj The slideshow object
16789 * @return The current layout's name
16791 * @see elm_slideshow_layout_set() for more details
16793 * @ingroup Slideshow
16795 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16798 * Returns the list of @b layout names available, for a given
16799 * slideshow widget.
16801 * @param obj The slideshow object
16802 * @return The list of layouts (list of @b stringshared strings
16805 * Slideshow layouts will change how the widget is to dispose each
16806 * image item in its viewport, with regard to cropping, scaling,
16809 * The layouts, which come from @p obj's theme, must be an EDC
16810 * data item name @c "layouts" on the theme file, with (prefix)
16811 * names of EDC programs actually implementing them.
16813 * The available layouts for slideshows on the default theme are:
16814 * - @c "fullscreen" - item images with original aspect, scaled to
16815 * touch top and down slideshow borders or, if the image's heigh
16816 * is not enough, left and right slideshow borders.
16817 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
16818 * one, but always leaving 10% of the slideshow's dimensions of
16819 * distance between the item image's borders and the slideshow
16820 * borders, for each axis.
16822 * @warning The stringshared strings get no new references
16823 * exclusive to the user grabbing the list, here, so if you'd like
16824 * to use them out of this call's context, you'd better @c
16825 * eina_stringshare_ref() them.
16827 * @see elm_slideshow_layout_set()
16829 * @ingroup Slideshow
16831 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16834 * Set the number of items to cache, on a given slideshow widget,
16835 * <b>before the current item</b>
16837 * @param obj The slideshow object
16838 * @param count Number of items to cache before the current one
16840 * The default value for this property is @c 2. See
16841 * @ref Slideshow_Caching "slideshow caching" for more details.
16843 * @see elm_slideshow_cache_before_get()
16845 * @ingroup Slideshow
16847 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16850 * Retrieve the number of items to cache, on a given slideshow widget,
16851 * <b>before the current item</b>
16853 * @param obj The slideshow object
16854 * @return The number of items set to be cached before the current one
16856 * @see elm_slideshow_cache_before_set() for more details
16858 * @ingroup Slideshow
16860 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16863 * Set the number of items to cache, on a given slideshow widget,
16864 * <b>after the current item</b>
16866 * @param obj The slideshow object
16867 * @param count Number of items to cache after the current one
16869 * The default value for this property is @c 2. See
16870 * @ref Slideshow_Caching "slideshow caching" for more details.
16872 * @see elm_slideshow_cache_after_get()
16874 * @ingroup Slideshow
16876 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
16879 * Retrieve the number of items to cache, on a given slideshow widget,
16880 * <b>after the current item</b>
16882 * @param obj The slideshow object
16883 * @return The number of items set to be cached after the current one
16885 * @see elm_slideshow_cache_after_set() for more details
16887 * @ingroup Slideshow
16889 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16892 * Get the number of items stored in a given slideshow widget
16894 * @param obj The slideshow object
16895 * @return The number of items on @p obj, at the moment of this call
16897 * @ingroup Slideshow
16899 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16906 * @defgroup Fileselector File Selector
16908 * @image html img/widget/fileselector/preview-00.png
16909 * @image latex img/widget/fileselector/preview-00.eps
16911 * A file selector is a widget that allows a user to navigate
16912 * through a file system, reporting file selections back via its
16915 * It contains shortcut buttons for home directory (@c ~) and to
16916 * jump one directory upwards (..), as well as cancel/ok buttons to
16917 * confirm/cancel a given selection. After either one of those two
16918 * former actions, the file selector will issue its @c "done" smart
16921 * There's a text entry on it, too, showing the name of the current
16922 * selection. There's the possibility of making it editable, so it
16923 * is useful on file saving dialogs on applications, where one
16924 * gives a file name to save contents to, in a given directory in
16925 * the system. This custom file name will be reported on the @c
16926 * "done" smart callback (explained in sequence).
16928 * Finally, it has a view to display file system items into in two
16933 * If Elementary is built with support of the Ethumb thumbnailing
16934 * library, the second form of view will display preview thumbnails
16935 * of files which it supports.
16937 * Smart callbacks one can register to:
16939 * - @c "selected" - the user has clicked on a file (when not in
16940 * folders-only mode) or directory (when in folders-only mode)
16941 * - @c "directory,open" - the list has been populated with new
16942 * content (@c event_info is a pointer to the directory's
16943 * path, a @b stringshared string)
16944 * - @c "done" - the user has clicked on the "ok" or "cancel"
16945 * buttons (@c event_info is a pointer to the selection's
16946 * path, a @b stringshared string)
16948 * Here is an example on its usage:
16949 * @li @ref fileselector_example
16953 * @addtogroup Fileselector
16958 * Defines how a file selector widget is to layout its contents
16959 * (file system entries).
16961 typedef enum _Elm_Fileselector_Mode
16963 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
16964 ELM_FILESELECTOR_GRID, /**< layout as a grid */
16965 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
16966 } Elm_Fileselector_Mode;
16969 * Add a new file selector widget to the given parent Elementary
16970 * (container) object
16972 * @param parent The parent object
16973 * @return a new file selector widget handle or @c NULL, on errors
16975 * This function inserts a new file selector widget on the canvas.
16977 * @ingroup Fileselector
16979 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16982 * Enable/disable the file name entry box where the user can type
16983 * in a name for a file, in a given file selector widget
16985 * @param obj The file selector object
16986 * @param is_save @c EINA_TRUE to make the file selector a "saving
16987 * dialog", @c EINA_FALSE otherwise
16989 * Having the entry editable is useful on file saving dialogs on
16990 * applications, where one gives a file name to save contents to,
16991 * in a given directory in the system. This custom file name will
16992 * be reported on the @c "done" smart callback.
16994 * @see elm_fileselector_is_save_get()
16996 * @ingroup Fileselector
16998 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
17001 * Get whether the given file selector is in "saving dialog" mode
17003 * @param obj The file selector object
17004 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
17005 * mode, @c EINA_FALSE otherwise (and on errors)
17007 * @see elm_fileselector_is_save_set() for more details
17009 * @ingroup Fileselector
17011 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17014 * Enable/disable folder-only view for a given file selector widget
17016 * @param obj The file selector object
17017 * @param only @c EINA_TRUE to make @p obj only display
17018 * directories, @c EINA_FALSE to make files to be displayed in it
17021 * If enabled, the widget's view will only display folder items,
17024 * @see elm_fileselector_folder_only_get()
17026 * @ingroup Fileselector
17028 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
17031 * Get whether folder-only view is set for a given file selector
17034 * @param obj The file selector object
17035 * @return only @c EINA_TRUE if @p obj is only displaying
17036 * directories, @c EINA_FALSE if files are being displayed in it
17037 * too (and on errors)
17039 * @see elm_fileselector_folder_only_get()
17041 * @ingroup Fileselector
17043 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17046 * Enable/disable the "ok" and "cancel" buttons on a given file
17049 * @param obj The file selector object
17050 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
17052 * @note A file selector without those buttons will never emit the
17053 * @c "done" smart event, and is only usable if one is just hooking
17054 * to the other two events.
17056 * @see elm_fileselector_buttons_ok_cancel_get()
17058 * @ingroup Fileselector
17060 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
17063 * Get whether the "ok" and "cancel" buttons on a given file
17064 * selector widget are being shown.
17066 * @param obj The file selector object
17067 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
17068 * otherwise (and on errors)
17070 * @see elm_fileselector_buttons_ok_cancel_set() for more details
17072 * @ingroup Fileselector
17074 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17077 * Enable/disable a tree view in the given file selector widget,
17078 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
17080 * @param obj The file selector object
17081 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
17084 * In a tree view, arrows are created on the sides of directories,
17085 * allowing them to expand in place.
17087 * @note If it's in other mode, the changes made by this function
17088 * will only be visible when one switches back to "list" mode.
17090 * @see elm_fileselector_expandable_get()
17092 * @ingroup Fileselector
17094 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
17097 * Get whether tree view is enabled for the given file selector
17100 * @param obj The file selector object
17101 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
17102 * otherwise (and or errors)
17104 * @see elm_fileselector_expandable_set() for more details
17106 * @ingroup Fileselector
17108 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17111 * Set, programmatically, the @b directory that a given file
17112 * selector widget will display contents from
17114 * @param obj The file selector object
17115 * @param path The path to display in @p obj
17117 * This will change the @b directory that @p obj is displaying. It
17118 * will also clear the text entry area on the @p obj object, which
17119 * displays select files' names.
17121 * @see elm_fileselector_path_get()
17123 * @ingroup Fileselector
17125 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17128 * Get the parent directory's path that a given file selector
17129 * widget is displaying
17131 * @param obj The file selector object
17132 * @return The (full) path of the directory the file selector is
17133 * displaying, a @b stringshared string
17135 * @see elm_fileselector_path_set()
17137 * @ingroup Fileselector
17139 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17142 * Set, programmatically, the currently selected file/directory in
17143 * the given file selector widget
17145 * @param obj The file selector object
17146 * @param path The (full) path to a file or directory
17147 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
17148 * latter case occurs if the directory or file pointed to do not
17151 * @see elm_fileselector_selected_get()
17153 * @ingroup Fileselector
17155 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
17158 * Get the currently selected item's (full) path, in the given file
17161 * @param obj The file selector object
17162 * @return The absolute path of the selected item, a @b
17163 * stringshared string
17165 * @note Custom editions on @p obj object's text entry, if made,
17166 * will appear on the return string of this function, naturally.
17168 * @see elm_fileselector_selected_set() for more details
17170 * @ingroup Fileselector
17172 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17175 * Set the mode in which a given file selector widget will display
17176 * (layout) file system entries in its view
17178 * @param obj The file selector object
17179 * @param mode The mode of the fileselector, being it one of
17180 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
17181 * first one, naturally, will display the files in a list. The
17182 * latter will make the widget to display its entries in a grid
17185 * @note By using elm_fileselector_expandable_set(), the user may
17186 * trigger a tree view for that list.
17188 * @note If Elementary is built with support of the Ethumb
17189 * thumbnailing library, the second form of view will display
17190 * preview thumbnails of files which it supports. You must have
17191 * elm_need_ethumb() called in your Elementary for thumbnailing to
17194 * @see elm_fileselector_expandable_set().
17195 * @see elm_fileselector_mode_get().
17197 * @ingroup Fileselector
17199 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
17202 * Get the mode in which a given file selector widget is displaying
17203 * (layouting) file system entries in its view
17205 * @param obj The fileselector object
17206 * @return The mode in which the fileselector is at
17208 * @see elm_fileselector_mode_set() for more details
17210 * @ingroup Fileselector
17212 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17219 * @defgroup Progressbar Progress bar
17221 * The progress bar is a widget for visually representing the
17222 * progress status of a given job/task.
17224 * A progress bar may be horizontal or vertical. It may display an
17225 * icon besides it, as well as primary and @b units labels. The
17226 * former is meant to label the widget as a whole, while the
17227 * latter, which is formatted with floating point values (and thus
17228 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
17229 * units"</c>), is meant to label the widget's <b>progress
17230 * value</b>. Label, icon and unit strings/objects are @b optional
17231 * for progress bars.
17233 * A progress bar may be @b inverted, in which state it gets its
17234 * values inverted, with high values being on the left or top and
17235 * low values on the right or bottom, as opposed to normally have
17236 * the low values on the former and high values on the latter,
17237 * respectively, for horizontal and vertical modes.
17239 * The @b span of the progress, as set by
17240 * elm_progressbar_span_size_set(), is its length (horizontally or
17241 * vertically), unless one puts size hints on the widget to expand
17242 * on desired directions, by any container. That length will be
17243 * scaled by the object or applications scaling factor. At any
17244 * point code can query the progress bar for its value with
17245 * elm_progressbar_value_get().
17247 * Available widget styles for progress bars:
17249 * - @c "wheel" (simple style, no text, no progression, only
17250 * "pulse" effect is available)
17252 * Here is an example on its usage:
17253 * @li @ref progressbar_example
17257 * Add a new progress bar widget to the given parent Elementary
17258 * (container) object
17260 * @param parent The parent object
17261 * @return a new progress bar widget handle or @c NULL, on errors
17263 * This function inserts a new progress bar widget on the canvas.
17265 * @ingroup Progressbar
17267 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17270 * Set whether a given progress bar widget is at "pulsing mode" or
17273 * @param obj The progress bar object
17274 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
17275 * @c EINA_FALSE to put it back to its default one
17277 * By default, progress bars will display values from the low to
17278 * high value boundaries. There are, though, contexts in which the
17279 * state of progression of a given task is @b unknown. For those,
17280 * one can set a progress bar widget to a "pulsing state", to give
17281 * the user an idea that some computation is being held, but
17282 * without exact progress values. In the default theme it will
17283 * animate its bar with the contents filling in constantly and back
17284 * to non-filled, in a loop. To start and stop this pulsing
17285 * animation, one has to explicitly call elm_progressbar_pulse().
17287 * @see elm_progressbar_pulse_get()
17288 * @see elm_progressbar_pulse()
17290 * @ingroup Progressbar
17292 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
17295 * Get whether a given progress bar widget is at "pulsing mode" or
17298 * @param obj The progress bar object
17299 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
17300 * if it's in the default one (and on errors)
17302 * @ingroup Progressbar
17304 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17307 * Start/stop a given progress bar "pulsing" animation, if its
17310 * @param obj The progress bar object
17311 * @param state @c EINA_TRUE, to @b start the pulsing animation,
17312 * @c EINA_FALSE to @b stop it
17314 * @note This call won't do anything if @p obj is not under "pulsing mode".
17316 * @see elm_progressbar_pulse_set() for more details.
17318 * @ingroup Progressbar
17320 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17323 * Set the progress value (in percentage) on a given progress bar
17326 * @param obj The progress bar object
17327 * @param val The progress value (@b must be between @c 0.0 and @c
17330 * Use this call to set progress bar levels.
17332 * @note If you passes a value out of the specified range for @p
17333 * val, it will be interpreted as the @b closest of the @b boundary
17334 * values in the range.
17336 * @ingroup Progressbar
17338 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17341 * Get the progress value (in percentage) on a given progress bar
17344 * @param obj The progress bar object
17345 * @return The value of the progressbar
17347 * @see elm_progressbar_value_set() for more details
17349 * @ingroup Progressbar
17351 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17354 * Set the label of a given progress bar widget
17356 * @param obj The progress bar object
17357 * @param label The text label string, in UTF-8
17359 * @ingroup Progressbar
17360 * @deprecated use elm_object_text_set() instead.
17362 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17365 * Get the label of a given progress bar widget
17367 * @param obj The progressbar object
17368 * @return The text label string, in UTF-8
17370 * @ingroup Progressbar
17371 * @deprecated use elm_object_text_set() instead.
17373 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17376 * Set the icon object of a given progress bar widget
17378 * @param obj The progress bar object
17379 * @param icon The icon object
17381 * Use this call to decorate @p obj with an icon next to it.
17383 * @note Once the icon object is set, a previously set one will be
17384 * deleted. If you want to keep that old content object, use the
17385 * elm_progressbar_icon_unset() function.
17387 * @see elm_progressbar_icon_get()
17389 * @ingroup Progressbar
17391 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17394 * Retrieve the icon object set for a given progress bar widget
17396 * @param obj The progress bar object
17397 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17398 * otherwise (and on errors)
17400 * @see elm_progressbar_icon_set() for more details
17402 * @ingroup Progressbar
17404 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17407 * Unset an icon set on a given progress bar widget
17409 * @param obj The progress bar object
17410 * @return The icon object that was being used, if any was set, or
17411 * @c NULL, otherwise (and on errors)
17413 * This call will unparent and return the icon object which was set
17414 * for this widget, previously, on success.
17416 * @see elm_progressbar_icon_set() for more details
17418 * @ingroup Progressbar
17420 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17423 * Set the (exact) length of the bar region of a given progress bar
17426 * @param obj The progress bar object
17427 * @param size The length of the progress bar's bar region
17429 * This sets the minimum width (when in horizontal mode) or height
17430 * (when in vertical mode) of the actual bar area of the progress
17431 * bar @p obj. This in turn affects the object's minimum size. Use
17432 * this when you're not setting other size hints expanding on the
17433 * given direction (like weight and alignment hints) and you would
17434 * like it to have a specific size.
17436 * @note Icon, label and unit text around @p obj will require their
17437 * own space, which will make @p obj to require more the @p size,
17440 * @see elm_progressbar_span_size_get()
17442 * @ingroup Progressbar
17444 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17447 * Get the length set for the bar region of a given progress bar
17450 * @param obj The progress bar object
17451 * @return The length of the progress bar's bar region
17453 * If that size was not set previously, with
17454 * elm_progressbar_span_size_set(), this call will return @c 0.
17456 * @ingroup Progressbar
17458 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17461 * Set the format string for a given progress bar widget's units
17464 * @param obj The progress bar object
17465 * @param format The format string for @p obj's units label
17467 * If @c NULL is passed on @p format, it will make @p obj's units
17468 * area to be hidden completely. If not, it'll set the <b>format
17469 * string</b> for the units label's @b text. The units label is
17470 * provided a floating point value, so the units text is up display
17471 * at most one floating point falue. Note that the units label is
17472 * optional. Use a format string such as "%1.2f meters" for
17475 * @note The default format string for a progress bar is an integer
17476 * percentage, as in @c "%.0f %%".
17478 * @see elm_progressbar_unit_format_get()
17480 * @ingroup Progressbar
17482 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17485 * Retrieve the format string set for a given progress bar widget's
17488 * @param obj The progress bar object
17489 * @return The format set string for @p obj's units label or
17490 * @c NULL, if none was set (and on errors)
17492 * @see elm_progressbar_unit_format_set() for more details
17494 * @ingroup Progressbar
17496 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17499 * Set the orientation of a given progress bar widget
17501 * @param obj The progress bar object
17502 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17503 * @b horizontal, @c EINA_FALSE to make it @b vertical
17505 * Use this function to change how your progress bar is to be
17506 * disposed: vertically or horizontally.
17508 * @see elm_progressbar_horizontal_get()
17510 * @ingroup Progressbar
17512 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17515 * Retrieve the orientation of a given progress bar widget
17517 * @param obj The progress bar object
17518 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17519 * @c EINA_FALSE if it's @b vertical (and on errors)
17521 * @see elm_progressbar_horizontal_set() for more details
17523 * @ingroup Progressbar
17525 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17528 * Invert a given progress bar widget's displaying values order
17530 * @param obj The progress bar object
17531 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17532 * @c EINA_FALSE to bring it back to default, non-inverted values.
17534 * A progress bar may be @b inverted, in which state it gets its
17535 * values inverted, with high values being on the left or top and
17536 * low values on the right or bottom, as opposed to normally have
17537 * the low values on the former and high values on the latter,
17538 * respectively, for horizontal and vertical modes.
17540 * @see elm_progressbar_inverted_get()
17542 * @ingroup Progressbar
17544 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17547 * Get whether a given progress bar widget's displaying values are
17550 * @param obj The progress bar object
17551 * @return @c EINA_TRUE, if @p obj has inverted values,
17552 * @c EINA_FALSE otherwise (and on errors)
17554 * @see elm_progressbar_inverted_set() for more details
17556 * @ingroup Progressbar
17558 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17561 * @defgroup Separator Separator
17563 * @brief Separator is a very thin object used to separate other objects.
17565 * A separator can be vertical or horizontal.
17567 * @ref tutorial_separator is a good example of how to use a separator.
17571 * @brief Add a separator object to @p parent
17573 * @param parent The parent object
17575 * @return The separator object, or NULL upon failure
17577 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17579 * @brief Set the horizontal mode of a separator object
17581 * @param obj The separator object
17582 * @param horizontal If true, the separator is horizontal
17584 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17586 * @brief Get the horizontal mode of a separator object
17588 * @param obj The separator object
17589 * @return If true, the separator is horizontal
17591 * @see elm_separator_horizontal_set()
17593 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17599 * @defgroup Spinner Spinner
17600 * @ingroup Elementary
17602 * @image html img/widget/spinner/preview-00.png
17603 * @image latex img/widget/spinner/preview-00.eps
17605 * A spinner is a widget which allows the user to increase or decrease
17606 * numeric values using arrow buttons, or edit values directly, clicking
17607 * over it and typing the new value.
17609 * By default the spinner will not wrap and has a label
17610 * of "%.0f" (just showing the integer value of the double).
17612 * A spinner has a label that is formatted with floating
17613 * point values and thus accepts a printf-style format string, like
17616 * It also allows specific values to be replaced by pre-defined labels.
17618 * Smart callbacks one can register to:
17620 * - "changed" - Whenever the spinner value is changed.
17621 * - "delay,changed" - A short time after the value is changed by the user.
17622 * This will be called only when the user stops dragging for a very short
17623 * period or when they release their finger/mouse, so it avoids possibly
17624 * expensive reactions to the value change.
17626 * Available styles for it:
17628 * - @c "vertical": up/down buttons at the right side and text left aligned.
17630 * Here is an example on its usage:
17631 * @ref spinner_example
17635 * @addtogroup Spinner
17640 * Add a new spinner widget to the given parent Elementary
17641 * (container) object.
17643 * @param parent The parent object.
17644 * @return a new spinner widget handle or @c NULL, on errors.
17646 * This function inserts a new spinner widget on the canvas.
17651 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17654 * Set the format string of the displayed label.
17656 * @param obj The spinner object.
17657 * @param fmt The format string for the label display.
17659 * If @c NULL, this sets the format to "%.0f". If not it sets the format
17660 * string for the label text. The label text is provided a floating point
17661 * value, so the label text can display up to 1 floating point value.
17662 * Note that this is optional.
17664 * Use a format string such as "%1.2f meters" for example, and it will
17665 * display values like: "3.14 meters" for a value equal to 3.14159.
17667 * Default is "%0.f".
17669 * @see elm_spinner_label_format_get()
17673 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
17676 * Get the label format of the spinner.
17678 * @param obj The spinner object.
17679 * @return The text label format string in UTF-8.
17681 * @see elm_spinner_label_format_set() for details.
17685 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17688 * Set the minimum and maximum values for the spinner.
17690 * @param obj The spinner object.
17691 * @param min The minimum value.
17692 * @param max The maximum value.
17694 * Define the allowed range of values to be selected by the user.
17696 * If actual value is less than @p min, it will be updated to @p min. If it
17697 * is bigger then @p max, will be updated to @p max. Actual value can be
17698 * get with elm_spinner_value_get().
17700 * By default, min is equal to 0, and max is equal to 100.
17702 * @warning Maximum must be greater than minimum.
17704 * @see elm_spinner_min_max_get()
17708 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17711 * Get the minimum and maximum values of the spinner.
17713 * @param obj The spinner object.
17714 * @param min Pointer where to store the minimum value.
17715 * @param max Pointer where to store the maximum value.
17717 * @note If only one value is needed, the other pointer can be passed
17720 * @see elm_spinner_min_max_set() for details.
17724 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17727 * Set the step used to increment or decrement the spinner value.
17729 * @param obj The spinner object.
17730 * @param step The step value.
17732 * This value will be incremented or decremented to the displayed value.
17733 * It will be incremented while the user keep right or top arrow pressed,
17734 * and will be decremented while the user keep left or bottom arrow pressed.
17736 * The interval to increment / decrement can be set with
17737 * elm_spinner_interval_set().
17739 * By default step value is equal to 1.
17741 * @see elm_spinner_step_get()
17745 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
17748 * Get the step used to increment or decrement the spinner value.
17750 * @param obj The spinner object.
17751 * @return The step value.
17753 * @see elm_spinner_step_get() for more details.
17757 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17760 * Set the value the spinner displays.
17762 * @param obj The spinner object.
17763 * @param val The value to be displayed.
17765 * Value will be presented on the label following format specified with
17766 * elm_spinner_format_set().
17768 * @warning The value must to be between min and max values. This values
17769 * are set by elm_spinner_min_max_set().
17771 * @see elm_spinner_value_get().
17772 * @see elm_spinner_format_set().
17773 * @see elm_spinner_min_max_set().
17777 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17780 * Get the value displayed by the spinner.
17782 * @param obj The spinner object.
17783 * @return The value displayed.
17785 * @see elm_spinner_value_set() for details.
17789 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17792 * Set whether the spinner should wrap when it reaches its
17793 * minimum or maximum value.
17795 * @param obj The spinner object.
17796 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
17799 * Disabled by default. If disabled, when the user tries to increment the
17801 * but displayed value plus step value is bigger than maximum value,
17803 * won't allow it. The same happens when the user tries to decrement it,
17804 * but the value less step is less than minimum value.
17806 * When wrap is enabled, in such situations it will allow these changes,
17807 * but will get the value that would be less than minimum and subtracts
17808 * from maximum. Or add the value that would be more than maximum to
17812 * @li min value = 10
17813 * @li max value = 50
17814 * @li step value = 20
17815 * @li displayed value = 20
17817 * When the user decrement value (using left or bottom arrow), it will
17818 * displays @c 40, because max - (min - (displayed - step)) is
17819 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
17821 * @see elm_spinner_wrap_get().
17825 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
17828 * Get whether the spinner should wrap when it reaches its
17829 * minimum or maximum value.
17831 * @param obj The spinner object
17832 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
17833 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17835 * @see elm_spinner_wrap_set() for details.
17839 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17842 * Set whether the spinner can be directly edited by the user or not.
17844 * @param obj The spinner object.
17845 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
17846 * don't allow users to edit it directly.
17848 * Spinner objects can have edition @b disabled, in which state they will
17849 * be changed only by arrows.
17850 * Useful for contexts
17851 * where you don't want your users to interact with it writting the value.
17853 * when using special values, the user can see real value instead
17854 * of special label on edition.
17856 * It's enabled by default.
17858 * @see elm_spinner_editable_get()
17862 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
17865 * Get whether the spinner can be directly edited by the user or not.
17867 * @param obj The spinner object.
17868 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
17869 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
17871 * @see elm_spinner_editable_set() for details.
17875 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17878 * Set a special string to display in the place of the numerical value.
17880 * @param obj The spinner object.
17881 * @param value The value to be replaced.
17882 * @param label The label to be used.
17884 * It's useful for cases when a user should select an item that is
17885 * better indicated by a label than a value. For example, weekdays or months.
17889 * sp = elm_spinner_add(win);
17890 * elm_spinner_min_max_set(sp, 1, 3);
17891 * elm_spinner_special_value_add(sp, 1, "January");
17892 * elm_spinner_special_value_add(sp, 2, "February");
17893 * elm_spinner_special_value_add(sp, 3, "March");
17894 * evas_object_show(sp);
17899 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
17902 * Set the interval on time updates for an user mouse button hold
17903 * on spinner widgets' arrows.
17905 * @param obj The spinner object.
17906 * @param interval The (first) interval value in seconds.
17908 * This interval value is @b decreased while the user holds the
17909 * mouse pointer either incrementing or decrementing spinner's value.
17911 * This helps the user to get to a given value distant from the
17912 * current one easier/faster, as it will start to change quicker and
17913 * quicker on mouse button holds.
17915 * The calculation for the next change interval value, starting from
17916 * the one set with this call, is the previous interval divided by
17917 * @c 1.05, so it decreases a little bit.
17919 * The default starting interval value for automatic changes is
17922 * @see elm_spinner_interval_get()
17926 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
17929 * Get the interval on time updates for an user mouse button hold
17930 * on spinner widgets' arrows.
17932 * @param obj The spinner object.
17933 * @return The (first) interval value, in seconds, set on it.
17935 * @see elm_spinner_interval_set() for more details.
17939 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17946 * @defgroup Index Index
17948 * @image html img/widget/index/preview-00.png
17949 * @image latex img/widget/index/preview-00.eps
17951 * An index widget gives you an index for fast access to whichever
17952 * group of other UI items one might have. It's a list of text
17953 * items (usually letters, for alphabetically ordered access).
17955 * Index widgets are by default hidden and just appear when the
17956 * user clicks over it's reserved area in the canvas. In its
17957 * default theme, it's an area one @ref Fingers "finger" wide on
17958 * the right side of the index widget's container.
17960 * When items on the index are selected, smart callbacks get
17961 * called, so that its user can make other container objects to
17962 * show a given area or child object depending on the index item
17963 * selected. You'd probably be using an index together with @ref
17964 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
17967 * Smart events one can add callbacks for are:
17968 * - @c "changed" - When the selected index item changes. @c
17969 * event_info is the selected item's data pointer.
17970 * - @c "delay,changed" - When the selected index item changes, but
17971 * after a small idling period. @c event_info is the selected
17972 * item's data pointer.
17973 * - @c "selected" - When the user releases a mouse button and
17974 * selects an item. @c event_info is the selected item's data
17976 * - @c "level,up" - when the user moves a finger from the first
17977 * level to the second level
17978 * - @c "level,down" - when the user moves a finger from the second
17979 * level to the first level
17981 * The @c "delay,changed" event is so that it'll wait a small time
17982 * before actually reporting those events and, moreover, just the
17983 * last event happening on those time frames will actually be
17986 * Here are some examples on its usage:
17987 * @li @ref index_example_01
17988 * @li @ref index_example_02
17992 * @addtogroup Index
17996 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
17999 * Add a new index widget to the given parent Elementary
18000 * (container) object
18002 * @param parent The parent object
18003 * @return a new index widget handle or @c NULL, on errors
18005 * This function inserts a new index widget on the canvas.
18009 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18012 * Set whether a given index widget is or not visible,
18015 * @param obj The index object
18016 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
18018 * Not to be confused with visible as in @c evas_object_show() --
18019 * visible with regard to the widget's auto hiding feature.
18021 * @see elm_index_active_get()
18025 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
18028 * Get whether a given index widget is currently visible or not.
18030 * @param obj The index object
18031 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
18033 * @see elm_index_active_set() for more details
18037 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18040 * Set the items level for a given index widget.
18042 * @param obj The index object.
18043 * @param level @c 0 or @c 1, the currently implemented levels.
18045 * @see elm_index_item_level_get()
18049 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18052 * Get the items level set for a given index widget.
18054 * @param obj The index object.
18055 * @return @c 0 or @c 1, which are the levels @p obj might be at.
18057 * @see elm_index_item_level_set() for more information
18061 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18064 * Returns the last selected item's data, for a given index widget.
18066 * @param obj The index object.
18067 * @return The item @b data associated to the last selected item on
18068 * @p obj (or @c NULL, on errors).
18070 * @warning The returned value is @b not an #Elm_Index_Item item
18071 * handle, but the data associated to it (see the @c item parameter
18072 * in elm_index_item_append(), as an example).
18076 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18079 * Append a new item on a given index widget.
18081 * @param obj The index object.
18082 * @param letter Letter under which the item should be indexed
18083 * @param item The item data to set for the index's item
18085 * Despite the most common usage of the @p letter argument is for
18086 * single char strings, one could use arbitrary strings as index
18089 * @c item will be the pointer returned back on @c "changed", @c
18090 * "delay,changed" and @c "selected" smart events.
18094 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18097 * Prepend a new item on a given index widget.
18099 * @param obj The index object.
18100 * @param letter Letter under which the item should be indexed
18101 * @param item The item data to set for the index's item
18103 * Despite the most common usage of the @p letter argument is for
18104 * single char strings, one could use arbitrary strings as index
18107 * @c item will be the pointer returned back on @c "changed", @c
18108 * "delay,changed" and @c "selected" smart events.
18112 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
18115 * Append a new item, on a given index widget, <b>after the item
18116 * having @p relative as data</b>.
18118 * @param obj The index object.
18119 * @param letter Letter under which the item should be indexed
18120 * @param item The item data to set for the index's item
18121 * @param relative The item data of the index item to be the
18122 * predecessor of this new one
18124 * Despite the most common usage of the @p letter argument is for
18125 * single char strings, one could use arbitrary strings as index
18128 * @c item will be the pointer returned back on @c "changed", @c
18129 * "delay,changed" and @c "selected" smart events.
18131 * @note If @p relative is @c NULL or if it's not found to be data
18132 * set on any previous item on @p obj, this function will behave as
18133 * elm_index_item_append().
18137 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18140 * Prepend a new item, on a given index widget, <b>after the item
18141 * having @p relative as data</b>.
18143 * @param obj The index object.
18144 * @param letter Letter under which the item should be indexed
18145 * @param item The item data to set for the index's item
18146 * @param relative The item data of the index item to be the
18147 * successor of this new one
18149 * Despite the most common usage of the @p letter argument is for
18150 * single char strings, one could use arbitrary strings as index
18153 * @c item will be the pointer returned back on @c "changed", @c
18154 * "delay,changed" and @c "selected" smart events.
18156 * @note If @p relative is @c NULL or if it's not found to be data
18157 * set on any previous item on @p obj, this function will behave as
18158 * elm_index_item_prepend().
18162 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
18165 * Insert a new item into the given index widget, using @p cmp_func
18166 * function to sort items (by item handles).
18168 * @param obj The index object.
18169 * @param letter Letter under which the item should be indexed
18170 * @param item The item data to set for the index's item
18171 * @param cmp_func The comparing function to be used to sort index
18172 * items <b>by #Elm_Index_Item item handles</b>
18173 * @param cmp_data_func A @b fallback function to be called for the
18174 * sorting of index items <b>by item data</b>). It will be used
18175 * when @p cmp_func returns @c 0 (equality), which means an index
18176 * item with provided item data already exists. To decide which
18177 * data item should be pointed to by the index item in question, @p
18178 * cmp_data_func will be used. If @p cmp_data_func returns a
18179 * non-negative value, the previous index item data will be
18180 * replaced by the given @p item pointer. If the previous data need
18181 * to be freed, it should be done by the @p cmp_data_func function,
18182 * because all references to it will be lost. If this function is
18183 * not provided (@c NULL is given), index items will be @b
18184 * duplicated, if @p cmp_func returns @c 0.
18186 * Despite the most common usage of the @p letter argument is for
18187 * single char strings, one could use arbitrary strings as index
18190 * @c item will be the pointer returned back on @c "changed", @c
18191 * "delay,changed" and @c "selected" smart events.
18195 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);
18198 * Remove an item from a given index widget, <b>to be referenced by
18199 * it's data value</b>.
18201 * @param obj The index object
18202 * @param item The item's data pointer for the item to be removed
18205 * If a deletion callback is set, via elm_index_item_del_cb_set(),
18206 * that callback function will be called by this one.
18208 * @warning The item to be removed from @p obj will be found via
18209 * its item data pointer, and not by an #Elm_Index_Item handle.
18213 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18216 * Find a given index widget's item, <b>using item data</b>.
18218 * @param obj The index object
18219 * @param item The item data pointed to by the desired index item
18220 * @return The index item handle, if found, or @c NULL otherwise
18224 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
18227 * Removes @b all items from a given index widget.
18229 * @param obj The index object.
18231 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
18232 * that callback function will be called for each item in @p obj.
18236 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18239 * Go to a given items level on a index widget
18241 * @param obj The index object
18242 * @param level The index level (one of @c 0 or @c 1)
18246 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
18249 * Return the data associated with a given index widget item
18251 * @param it The index widget item handle
18252 * @return The data associated with @p it
18254 * @see elm_index_item_data_set()
18258 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18261 * Set the data associated with a given index widget item
18263 * @param it The index widget item handle
18264 * @param data The new data pointer to set to @p it
18266 * This sets new item data on @p it.
18268 * @warning The old data pointer won't be touched by this function, so
18269 * the user had better to free that old data himself/herself.
18273 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
18276 * Set the function to be called when a given index widget item is freed.
18278 * @param it The item to set the callback on
18279 * @param func The function to call on the item's deletion
18281 * When called, @p func will have both @c data and @c event_info
18282 * arguments with the @p it item's data value and, naturally, the
18283 * @c obj argument with a handle to the parent index widget.
18287 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
18290 * Get the letter (string) set on a given index widget item.
18292 * @param it The index item handle
18293 * @return The letter string set on @p it
18297 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
18304 * @defgroup Photocam Photocam
18306 * @image html img/widget/photocam/preview-00.png
18307 * @image latex img/widget/photocam/preview-00.eps
18309 * This is a widget specifically for displaying high-resolution digital
18310 * camera photos giving speedy feedback (fast load), low memory footprint
18311 * and zooming and panning as well as fitting logic. It is entirely focused
18312 * on jpeg images, and takes advantage of properties of the jpeg format (via
18313 * evas loader features in the jpeg loader).
18315 * Signals that you can add callbacks for are:
18316 * @li "clicked" - This is called when a user has clicked the photo without
18318 * @li "press" - This is called when a user has pressed down on the photo.
18319 * @li "longpressed" - This is called when a user has pressed down on the
18320 * photo for a long time without dragging around.
18321 * @li "clicked,double" - This is called when a user has double-clicked the
18323 * @li "load" - Photo load begins.
18324 * @li "loaded" - This is called when the image file load is complete for the
18325 * first view (low resolution blurry version).
18326 * @li "load,detail" - Photo detailed data load begins.
18327 * @li "loaded,detail" - This is called when the image file load is complete
18328 * for the detailed image data (full resolution needed).
18329 * @li "zoom,start" - Zoom animation started.
18330 * @li "zoom,stop" - Zoom animation stopped.
18331 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
18332 * @li "scroll" - the content has been scrolled (moved)
18333 * @li "scroll,anim,start" - scrolling animation has started
18334 * @li "scroll,anim,stop" - scrolling animation has stopped
18335 * @li "scroll,drag,start" - dragging the contents around has started
18336 * @li "scroll,drag,stop" - dragging the contents around has stopped
18338 * @ref tutorial_photocam shows the API in action.
18342 * @brief Types of zoom available.
18344 typedef enum _Elm_Photocam_Zoom_Mode
18346 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
18347 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
18348 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
18349 ELM_PHOTOCAM_ZOOM_MODE_LAST
18350 } Elm_Photocam_Zoom_Mode;
18352 * @brief Add a new Photocam object
18354 * @param parent The parent object
18355 * @return The new object or NULL if it cannot be created
18357 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18359 * @brief Set the photo file to be shown
18361 * @param obj The photocam object
18362 * @param file The photo file
18363 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
18365 * This sets (and shows) the specified file (with a relative or absolute
18366 * path) and will return a load error (same error that
18367 * evas_object_image_load_error_get() will return). The image will change and
18368 * adjust its size at this point and begin a background load process for this
18369 * photo that at some time in the future will be displayed at the full
18372 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
18374 * @brief Returns the path of the current image file
18376 * @param obj The photocam object
18377 * @return Returns the path
18379 * @see elm_photocam_file_set()
18381 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18383 * @brief Set the zoom level of the photo
18385 * @param obj The photocam object
18386 * @param zoom The zoom level to set
18388 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
18389 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
18390 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
18391 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
18394 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
18396 * @brief Get the zoom level of the photo
18398 * @param obj The photocam object
18399 * @return The current zoom level
18401 * This returns the current zoom level of the photocam object. Note that if
18402 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
18403 * (which is the default), the zoom level may be changed at any time by the
18404 * photocam object itself to account for photo size and photocam viewpoer
18407 * @see elm_photocam_zoom_set()
18408 * @see elm_photocam_zoom_mode_set()
18410 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18412 * @brief Set the zoom mode
18414 * @param obj The photocam object
18415 * @param mode The desired mode
18417 * This sets the zoom mode to manual or one of several automatic levels.
18418 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
18419 * elm_photocam_zoom_set() and will stay at that level until changed by code
18420 * or until zoom mode is changed. This is the default mode. The Automatic
18421 * modes will allow the photocam object to automatically adjust zoom mode
18422 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
18423 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
18424 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
18425 * pixels within the frame are left unfilled.
18427 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18429 * @brief Get the zoom mode
18431 * @param obj The photocam object
18432 * @return The current zoom mode
18434 * This gets the current zoom mode of the photocam object.
18436 * @see elm_photocam_zoom_mode_set()
18438 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18440 * @brief Get the current image pixel width and height
18442 * @param obj The photocam object
18443 * @param w A pointer to the width return
18444 * @param h A pointer to the height return
18446 * This gets the current photo pixel width and height (for the original).
18447 * The size will be returned in the integers @p w and @p h that are pointed
18450 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
18452 * @brief Get the area of the image that is currently shown
18455 * @param x A pointer to the X-coordinate of region
18456 * @param y A pointer to the Y-coordinate of region
18457 * @param w A pointer to the width
18458 * @param h A pointer to the height
18460 * @see elm_photocam_image_region_show()
18461 * @see elm_photocam_image_region_bring_in()
18463 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
18465 * @brief Set the viewed portion of the image
18467 * @param obj The photocam object
18468 * @param x X-coordinate of region in image original pixels
18469 * @param y Y-coordinate of region in image original pixels
18470 * @param w Width of region in image original pixels
18471 * @param h Height of region in image original pixels
18473 * This shows the region of the image without using animation.
18475 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18477 * @brief Bring in the viewed portion of the image
18479 * @param obj The photocam object
18480 * @param x X-coordinate of region in image original pixels
18481 * @param y Y-coordinate of region in image original pixels
18482 * @param w Width of region in image original pixels
18483 * @param h Height of region in image original pixels
18485 * This shows the region of the image using animation.
18487 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
18489 * @brief Set the paused state for photocam
18491 * @param obj The photocam object
18492 * @param paused The pause state to set
18494 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
18495 * photocam. The default is off. This will stop zooming using animation on
18496 * zoom levels changes and change instantly. This will stop any existing
18497 * animations that are running.
18499 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18501 * @brief Get the paused state for photocam
18503 * @param obj The photocam object
18504 * @return The current paused state
18506 * This gets the current paused state for the photocam object.
18508 * @see elm_photocam_paused_set()
18510 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18512 * @brief Get the internal low-res image used for photocam
18514 * @param obj The photocam object
18515 * @return The internal image object handle, or NULL if none exists
18517 * This gets the internal image object inside photocam. Do not modify it. It
18518 * is for inspection only, and hooking callbacks to. Nothing else. It may be
18519 * deleted at any time as well.
18521 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18523 * @brief Set the photocam scrolling bouncing.
18525 * @param obj The photocam object
18526 * @param h_bounce bouncing for horizontal
18527 * @param v_bounce bouncing for vertical
18529 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18531 * @brief Get the photocam scrolling bouncing.
18533 * @param obj The photocam object
18534 * @param h_bounce bouncing for horizontal
18535 * @param v_bounce bouncing for vertical
18537 * @see elm_photocam_bounce_set()
18539 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18545 * @defgroup Map Map
18546 * @ingroup Elementary
18548 * @image html img/widget/map/preview-00.png
18549 * @image latex img/widget/map/preview-00.eps
18551 * This is a widget specifically for displaying a map. It uses basically
18552 * OpenStreetMap provider http://www.openstreetmap.org/,
18553 * but custom providers can be added.
18555 * It supports some basic but yet nice features:
18556 * @li zoom and scroll
18557 * @li markers with content to be displayed when user clicks over it
18558 * @li group of markers
18561 * Smart callbacks one can listen to:
18563 * - "clicked" - This is called when a user has clicked the map without
18565 * - "press" - This is called when a user has pressed down on the map.
18566 * - "longpressed" - This is called when a user has pressed down on the map
18567 * for a long time without dragging around.
18568 * - "clicked,double" - This is called when a user has double-clicked
18570 * - "load,detail" - Map detailed data load begins.
18571 * - "loaded,detail" - This is called when all currently visible parts of
18572 * the map are loaded.
18573 * - "zoom,start" - Zoom animation started.
18574 * - "zoom,stop" - Zoom animation stopped.
18575 * - "zoom,change" - Zoom changed when using an auto zoom mode.
18576 * - "scroll" - the content has been scrolled (moved).
18577 * - "scroll,anim,start" - scrolling animation has started.
18578 * - "scroll,anim,stop" - scrolling animation has stopped.
18579 * - "scroll,drag,start" - dragging the contents around has started.
18580 * - "scroll,drag,stop" - dragging the contents around has stopped.
18581 * - "downloaded" - This is called when all currently required map images
18583 * - "route,load" - This is called when route request begins.
18584 * - "route,loaded" - This is called when route request ends.
18585 * - "name,load" - This is called when name request begins.
18586 * - "name,loaded- This is called when name request ends.
18588 * Available style for map widget:
18591 * Available style for markers:
18596 * Available style for marker bubble:
18599 * List of examples:
18600 * @li @ref map_example_01
18601 * @li @ref map_example_02
18602 * @li @ref map_example_03
18611 * @enum _Elm_Map_Zoom_Mode
18612 * @typedef Elm_Map_Zoom_Mode
18614 * Set map's zoom behavior. It can be set to manual or automatic.
18616 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
18618 * Values <b> don't </b> work as bitmask, only one can be choosen.
18620 * @note Valid sizes are 2^zoom, consequently the map may be smaller
18621 * than the scroller view.
18623 * @see elm_map_zoom_mode_set()
18624 * @see elm_map_zoom_mode_get()
18628 typedef enum _Elm_Map_Zoom_Mode
18630 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
18631 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
18632 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
18633 ELM_MAP_ZOOM_MODE_LAST
18634 } Elm_Map_Zoom_Mode;
18637 * @enum _Elm_Map_Route_Sources
18638 * @typedef Elm_Map_Route_Sources
18640 * Set route service to be used. By default used source is
18641 * #ELM_MAP_ROUTE_SOURCE_YOURS.
18643 * @see elm_map_route_source_set()
18644 * @see elm_map_route_source_get()
18648 typedef enum _Elm_Map_Route_Sources
18650 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
18651 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. */
18652 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
18653 ELM_MAP_ROUTE_SOURCE_LAST
18654 } Elm_Map_Route_Sources;
18656 typedef enum _Elm_Map_Name_Sources
18658 ELM_MAP_NAME_SOURCE_NOMINATIM,
18659 ELM_MAP_NAME_SOURCE_LAST
18660 } Elm_Map_Name_Sources;
18663 * @enum _Elm_Map_Route_Type
18664 * @typedef Elm_Map_Route_Type
18666 * Set type of transport used on route.
18668 * @see elm_map_route_add()
18672 typedef enum _Elm_Map_Route_Type
18674 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
18675 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
18676 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
18677 ELM_MAP_ROUTE_TYPE_LAST
18678 } Elm_Map_Route_Type;
18681 * @enum _Elm_Map_Route_Method
18682 * @typedef Elm_Map_Route_Method
18684 * Set the routing method, what should be priorized, time or distance.
18686 * @see elm_map_route_add()
18690 typedef enum _Elm_Map_Route_Method
18692 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
18693 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
18694 ELM_MAP_ROUTE_METHOD_LAST
18695 } Elm_Map_Route_Method;
18697 typedef enum _Elm_Map_Name_Method
18699 ELM_MAP_NAME_METHOD_SEARCH,
18700 ELM_MAP_NAME_METHOD_REVERSE,
18701 ELM_MAP_NAME_METHOD_LAST
18702 } Elm_Map_Name_Method;
18704 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(). */
18705 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(). */
18706 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(). */
18707 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(). */
18708 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
18709 typedef struct _Elm_Map_Track Elm_Map_Track;
18711 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. */
18712 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
18713 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
18714 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
18716 typedef char *(*ElmMapModuleSourceFunc) (void);
18717 typedef int (*ElmMapModuleZoomMinFunc) (void);
18718 typedef int (*ElmMapModuleZoomMaxFunc) (void);
18719 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
18720 typedef int (*ElmMapModuleRouteSourceFunc) (void);
18721 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
18722 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
18723 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
18724 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
18727 * Add a new map widget to the given parent Elementary (container) object.
18729 * @param parent The parent object.
18730 * @return a new map widget handle or @c NULL, on errors.
18732 * This function inserts a new map widget on the canvas.
18736 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18739 * Set the zoom level of the map.
18741 * @param obj The map object.
18742 * @param zoom The zoom level to set.
18744 * This sets the zoom level.
18746 * It will respect limits defined by elm_map_source_zoom_min_set() and
18747 * elm_map_source_zoom_max_set().
18749 * By default these values are 0 (world map) and 18 (maximum zoom).
18751 * This function should be used when zoom mode is set to
18752 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
18753 * with elm_map_zoom_mode_set().
18755 * @see elm_map_zoom_mode_set().
18756 * @see elm_map_zoom_get().
18760 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
18763 * Get the zoom level of the map.
18765 * @param obj The map object.
18766 * @return The current zoom level.
18768 * This returns the current zoom level of the map object.
18770 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
18771 * (which is the default), the zoom level may be changed at any time by the
18772 * map object itself to account for map size and map viewport size.
18774 * @see elm_map_zoom_set() for details.
18778 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18781 * Set the zoom mode used by the map object.
18783 * @param obj The map object.
18784 * @param mode The zoom mode of the map, being it one of
18785 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18786 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18788 * This sets the zoom mode to manual or one of the automatic levels.
18789 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
18790 * elm_map_zoom_set() and will stay at that level until changed by code
18791 * or until zoom mode is changed. This is the default mode.
18793 * The Automatic modes will allow the map object to automatically
18794 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
18795 * adjust zoom so the map fits inside the scroll frame with no pixels
18796 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
18797 * ensure no pixels within the frame are left unfilled. Do not forget that
18798 * the valid sizes are 2^zoom, consequently the map may be smaller than
18799 * the scroller view.
18801 * @see elm_map_zoom_set()
18805 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
18808 * Get the zoom mode used by the map object.
18810 * @param obj The map object.
18811 * @return The zoom mode of the map, being it one of
18812 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
18813 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
18815 * This function returns the current zoom mode used by the map object.
18817 * @see elm_map_zoom_mode_set() for more details.
18821 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18824 * Get the current coordinates of the map.
18826 * @param obj The map object.
18827 * @param lon Pointer where to store longitude.
18828 * @param lat Pointer where to store latitude.
18830 * This gets the current center coordinates of the map object. It can be
18831 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
18833 * @see elm_map_geo_region_bring_in()
18834 * @see elm_map_geo_region_show()
18838 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
18841 * Animatedly bring in given coordinates to the center of the map.
18843 * @param obj The map object.
18844 * @param lon Longitude to center at.
18845 * @param lat Latitude to center at.
18847 * This causes map to jump to the given @p lat and @p lon coordinates
18848 * and show it (by scrolling) in the center of the viewport, if it is not
18849 * already centered. This will use animation to do so and take a period
18850 * of time to complete.
18852 * @see elm_map_geo_region_show() for a function to avoid animation.
18853 * @see elm_map_geo_region_get()
18857 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18860 * Show the given coordinates at the center of the map, @b immediately.
18862 * @param obj The map object.
18863 * @param lon Longitude to center at.
18864 * @param lat Latitude to center at.
18866 * This causes map to @b redraw its viewport's contents to the
18867 * region contining the given @p lat and @p lon, that will be moved to the
18868 * center of the map.
18870 * @see elm_map_geo_region_bring_in() for a function to move with animation.
18871 * @see elm_map_geo_region_get()
18875 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
18878 * Pause or unpause the map.
18880 * @param obj The map object.
18881 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
18884 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18887 * The default is off.
18889 * This will stop zooming using animation, changing zoom levels will
18890 * change instantly. This will stop any existing animations that are running.
18892 * @see elm_map_paused_get()
18896 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18899 * Get a value whether map is paused or not.
18901 * @param obj The map object.
18902 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
18903 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
18905 * This gets the current paused state for the map object.
18907 * @see elm_map_paused_set() for details.
18911 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18914 * Set to show markers during zoom level changes or not.
18916 * @param obj The map object.
18917 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
18920 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18923 * The default is off.
18925 * This will stop zooming using animation, changing zoom levels will
18926 * change instantly. This will stop any existing animations that are running.
18928 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
18931 * The default is off.
18933 * Enabling it will force the map to stop displaying the markers during
18934 * zoom level changes. Set to on if you have a large number of markers.
18936 * @see elm_map_paused_markers_get()
18940 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
18943 * Get a value whether markers will be displayed on zoom level changes or not
18945 * @param obj The map object.
18946 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
18947 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
18949 * This gets the current markers paused state for the map object.
18951 * @see elm_map_paused_markers_set() for details.
18955 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18958 * Get the information of downloading status.
18960 * @param obj The map object.
18961 * @param try_num Pointer where to store number of tiles being downloaded.
18962 * @param finish_num Pointer where to store number of tiles successfully
18965 * This gets the current downloading status for the map object, the number
18966 * of tiles being downloaded and the number of tiles already downloaded.
18970 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
18973 * Convert a pixel coordinate (x,y) into a geographic coordinate
18974 * (longitude, latitude).
18976 * @param obj The map object.
18977 * @param x the coordinate.
18978 * @param y the coordinate.
18979 * @param size the size in pixels of the map.
18980 * The map is a square and generally his size is : pow(2.0, zoom)*256.
18981 * @param lon Pointer where to store the longitude that correspond to x.
18982 * @param lat Pointer where to store the latitude that correspond to y.
18984 * @note Origin pixel point is the top left corner of the viewport.
18985 * Map zoom and size are taken on account.
18987 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
18991 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);
18994 * Convert a geographic coordinate (longitude, latitude) into a pixel
18995 * coordinate (x, y).
18997 * @param obj The map object.
18998 * @param lon the longitude.
18999 * @param lat the latitude.
19000 * @param size the size in pixels of the map. The map is a square
19001 * and generally his size is : pow(2.0, zoom)*256.
19002 * @param x Pointer where to store the horizontal pixel coordinate that
19003 * correspond to the longitude.
19004 * @param y Pointer where to store the vertical pixel coordinate that
19005 * correspond to the latitude.
19007 * @note Origin pixel point is the top left corner of the viewport.
19008 * Map zoom and size are taken on account.
19010 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
19014 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);
19017 * Convert a geographic coordinate (longitude, latitude) into a name
19020 * @param obj The map object.
19021 * @param lon the longitude.
19022 * @param lat the latitude.
19023 * @return name A #Elm_Map_Name handle for this coordinate.
19025 * To get the string for this address, elm_map_name_address_get()
19028 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
19032 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
19035 * Convert a name (address) into a geographic coordinate
19036 * (longitude, latitude).
19038 * @param obj The map object.
19039 * @param name The address.
19040 * @return name A #Elm_Map_Name handle for this address.
19042 * To get the longitude and latitude, elm_map_name_region_get()
19045 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
19049 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
19052 * Convert a pixel coordinate into a rotated pixel coordinate.
19054 * @param obj The map object.
19055 * @param x horizontal coordinate of the point to rotate.
19056 * @param y vertical coordinate of the point to rotate.
19057 * @param cx rotation's center horizontal position.
19058 * @param cy rotation's center vertical position.
19059 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
19060 * @param xx Pointer where to store rotated x.
19061 * @param yy Pointer where to store rotated y.
19065 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);
19068 * Add a new marker to the map object.
19070 * @param obj The map object.
19071 * @param lon The longitude of the marker.
19072 * @param lat The latitude of the marker.
19073 * @param clas The class, to use when marker @b isn't grouped to others.
19074 * @param clas_group The class group, to use when marker is grouped to others
19075 * @param data The data passed to the callbacks.
19077 * @return The created marker or @c NULL upon failure.
19079 * A marker will be created and shown in a specific point of the map, defined
19080 * by @p lon and @p lat.
19082 * It will be displayed using style defined by @p class when this marker
19083 * is displayed alone (not grouped). A new class can be created with
19084 * elm_map_marker_class_new().
19086 * If the marker is grouped to other markers, it will be displayed with
19087 * style defined by @p class_group. Markers with the same group are grouped
19088 * if they are close. A new group class can be created with
19089 * elm_map_marker_group_class_new().
19091 * Markers created with this method can be deleted with
19092 * elm_map_marker_remove().
19094 * A marker can have associated content to be displayed by a bubble,
19095 * when a user click over it, as well as an icon. These objects will
19096 * be fetch using class' callback functions.
19098 * @see elm_map_marker_class_new()
19099 * @see elm_map_marker_group_class_new()
19100 * @see elm_map_marker_remove()
19104 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);
19107 * Set the maximum numbers of markers' content to be displayed in a group.
19109 * @param obj The map object.
19110 * @param max The maximum numbers of items displayed in a bubble.
19112 * A bubble will be displayed when the user clicks over the group,
19113 * and will place the content of markers that belong to this group
19116 * A group can have a long list of markers, consequently the creation
19117 * of the content of the bubble can be very slow.
19119 * In order to avoid this, a maximum number of items is displayed
19122 * By default this number is 30.
19124 * Marker with the same group class are grouped if they are close.
19126 * @see elm_map_marker_add()
19130 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
19133 * Remove a marker from the map.
19135 * @param marker The marker to remove.
19137 * @see elm_map_marker_add()
19141 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19144 * Get the current coordinates of the marker.
19146 * @param marker marker.
19147 * @param lat Pointer where to store the marker's latitude.
19148 * @param lon Pointer where to store the marker's longitude.
19150 * These values are set when adding markers, with function
19151 * elm_map_marker_add().
19153 * @see elm_map_marker_add()
19157 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
19160 * Animatedly bring in given marker to the center of the map.
19162 * @param marker The marker to center at.
19164 * This causes map to jump to the given @p marker's coordinates
19165 * and show it (by scrolling) in the center of the viewport, if it is not
19166 * already centered. This will use animation to do so and take a period
19167 * of time to complete.
19169 * @see elm_map_marker_show() for a function to avoid animation.
19170 * @see elm_map_marker_region_get()
19174 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19177 * Show the given marker at the center of the map, @b immediately.
19179 * @param marker The marker to center at.
19181 * This causes map to @b redraw its viewport's contents to the
19182 * region contining the given @p marker's coordinates, that will be
19183 * moved to the center of the map.
19185 * @see elm_map_marker_bring_in() for a function to move with animation.
19186 * @see elm_map_markers_list_show() if more than one marker need to be
19188 * @see elm_map_marker_region_get()
19192 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19195 * Move and zoom the map to display a list of markers.
19197 * @param markers A list of #Elm_Map_Marker handles.
19199 * The map will be centered on the center point of the markers in the list.
19200 * Then the map will be zoomed in order to fit the markers using the maximum
19201 * zoom which allows display of all the markers.
19203 * @warning All the markers should belong to the same map object.
19205 * @see elm_map_marker_show() to show a single marker.
19206 * @see elm_map_marker_bring_in()
19210 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
19213 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
19215 * @param marker The marker wich content should be returned.
19216 * @return Return the evas object if it exists, else @c NULL.
19218 * To set callback function #ElmMapMarkerGetFunc for the marker class,
19219 * elm_map_marker_class_get_cb_set() should be used.
19221 * This content is what will be inside the bubble that will be displayed
19222 * when an user clicks over the marker.
19224 * This returns the actual Evas object used to be placed inside
19225 * the bubble. This may be @c NULL, as it may
19226 * not have been created or may have been deleted, at any time, by
19227 * the map. <b>Do not modify this object</b> (move, resize,
19228 * show, hide, etc.), as the map is controlling it. This
19229 * function is for querying, emitting custom signals or hooking
19230 * lower level callbacks for events on that object. Do not delete
19231 * this object under any circumstances.
19235 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19238 * Update the marker
19240 * @param marker The marker to be updated.
19242 * If a content is set to this marker, it will call function to delete it,
19243 * #ElmMapMarkerDelFunc, and then will fetch the content again with
19244 * #ElmMapMarkerGetFunc.
19246 * These functions are set for the marker class with
19247 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
19251 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
19254 * Close all the bubbles opened by the user.
19256 * @param obj The map object.
19258 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
19259 * when the user clicks on a marker.
19261 * This functions is set for the marker class with
19262 * elm_map_marker_class_get_cb_set().
19266 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
19269 * Create a new group class.
19271 * @param obj The map object.
19272 * @return Returns the new group class.
19274 * Each marker must be associated to a group class. Markers in the same
19275 * group are grouped if they are close.
19277 * The group class defines the style of the marker when a marker is grouped
19278 * to others markers. When it is alone, another class will be used.
19280 * A group class will need to be provided when creating a marker with
19281 * elm_map_marker_add().
19283 * Some properties and functions can be set by class, as:
19284 * - style, with elm_map_group_class_style_set()
19285 * - data - to be associated to the group class. It can be set using
19286 * elm_map_group_class_data_set().
19287 * - min zoom to display markers, set with
19288 * elm_map_group_class_zoom_displayed_set().
19289 * - max zoom to group markers, set using
19290 * elm_map_group_class_zoom_grouped_set().
19291 * - visibility - set if markers will be visible or not, set with
19292 * elm_map_group_class_hide_set().
19293 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
19294 * It can be set using elm_map_group_class_icon_cb_set().
19296 * @see elm_map_marker_add()
19297 * @see elm_map_group_class_style_set()
19298 * @see elm_map_group_class_data_set()
19299 * @see elm_map_group_class_zoom_displayed_set()
19300 * @see elm_map_group_class_zoom_grouped_set()
19301 * @see elm_map_group_class_hide_set()
19302 * @see elm_map_group_class_icon_cb_set()
19306 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19309 * Set the marker's style of a group class.
19311 * @param clas The group class.
19312 * @param style The style to be used by markers.
19314 * Each marker must be associated to a group class, and will use the style
19315 * defined by such class when grouped to other markers.
19317 * The following styles are provided by default theme:
19318 * @li @c radio - blue circle
19319 * @li @c radio2 - green circle
19322 * @see elm_map_group_class_new() for more details.
19323 * @see elm_map_marker_add()
19327 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19330 * Set the icon callback function of a group class.
19332 * @param clas The group class.
19333 * @param icon_get The callback function that will return the icon.
19335 * Each marker must be associated to a group class, and it can display a
19336 * custom icon. The function @p icon_get must return this icon.
19338 * @see elm_map_group_class_new() for more details.
19339 * @see elm_map_marker_add()
19343 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19346 * Set the data associated to the group class.
19348 * @param clas The group class.
19349 * @param data The new user data.
19351 * This data will be passed for callback functions, like icon get callback,
19352 * that can be set with elm_map_group_class_icon_cb_set().
19354 * If a data was previously set, the object will lose the pointer for it,
19355 * so if needs to be freed, you must do it yourself.
19357 * @see elm_map_group_class_new() for more details.
19358 * @see elm_map_group_class_icon_cb_set()
19359 * @see elm_map_marker_add()
19363 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
19366 * Set the minimum zoom from where the markers are displayed.
19368 * @param clas The group class.
19369 * @param zoom The minimum zoom.
19371 * Markers only will be displayed when the map is displayed at @p zoom
19374 * @see elm_map_group_class_new() for more details.
19375 * @see elm_map_marker_add()
19379 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19382 * Set the zoom from where the markers are no more grouped.
19384 * @param clas The group class.
19385 * @param zoom The maximum zoom.
19387 * Markers only will be grouped when the map is displayed at
19388 * less than @p zoom.
19390 * @see elm_map_group_class_new() for more details.
19391 * @see elm_map_marker_add()
19395 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
19398 * Set if the markers associated to the group class @clas are hidden or not.
19400 * @param clas The group class.
19401 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
19404 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
19409 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
19412 * Create a new marker class.
19414 * @param obj The map object.
19415 * @return Returns the new group class.
19417 * Each marker must be associated to a class.
19419 * The marker class defines the style of the marker when a marker is
19420 * displayed alone, i.e., not grouped to to others markers. When grouped
19421 * it will use group class style.
19423 * A marker class will need to be provided when creating a marker with
19424 * elm_map_marker_add().
19426 * Some properties and functions can be set by class, as:
19427 * - style, with elm_map_marker_class_style_set()
19428 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
19429 * It can be set using elm_map_marker_class_icon_cb_set().
19430 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
19431 * Set using elm_map_marker_class_get_cb_set().
19432 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
19433 * Set using elm_map_marker_class_del_cb_set().
19435 * @see elm_map_marker_add()
19436 * @see elm_map_marker_class_style_set()
19437 * @see elm_map_marker_class_icon_cb_set()
19438 * @see elm_map_marker_class_get_cb_set()
19439 * @see elm_map_marker_class_del_cb_set()
19443 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
19446 * Set the marker's style of a marker class.
19448 * @param clas The marker class.
19449 * @param style The style to be used by markers.
19451 * Each marker must be associated to a marker class, and will use the style
19452 * defined by such class when alone, i.e., @b not grouped to other markers.
19454 * The following styles are provided by default theme:
19459 * @see elm_map_marker_class_new() for more details.
19460 * @see elm_map_marker_add()
19464 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
19467 * Set the icon callback function of a marker class.
19469 * @param clas The marker class.
19470 * @param icon_get The callback function that will return the icon.
19472 * Each marker must be associated to a marker class, and it can display a
19473 * custom icon. The function @p icon_get must return this icon.
19475 * @see elm_map_marker_class_new() for more details.
19476 * @see elm_map_marker_add()
19480 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
19483 * Set the bubble content callback function of a marker class.
19485 * @param clas The marker class.
19486 * @param get The callback function that will return the content.
19488 * Each marker must be associated to a marker class, and it can display a
19489 * a content on a bubble that opens when the user click over the marker.
19490 * The function @p get must return this content object.
19492 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
19495 * @see elm_map_marker_class_new() for more details.
19496 * @see elm_map_marker_class_del_cb_set()
19497 * @see elm_map_marker_add()
19501 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
19504 * Set the callback function used to delete bubble content of a marker class.
19506 * @param clas The marker class.
19507 * @param del The callback function that will delete the content.
19509 * Each marker must be associated to a marker class, and it can display a
19510 * a content on a bubble that opens when the user click over the marker.
19511 * The function to return such content can be set with
19512 * elm_map_marker_class_get_cb_set().
19514 * If this content must be freed, a callback function need to be
19515 * set for that task with this function.
19517 * If this callback is defined it will have to delete (or not) the
19518 * object inside, but if the callback is not defined the object will be
19519 * destroyed with evas_object_del().
19521 * @see elm_map_marker_class_new() for more details.
19522 * @see elm_map_marker_class_get_cb_set()
19523 * @see elm_map_marker_add()
19527 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
19530 * Get the list of available sources.
19532 * @param obj The map object.
19533 * @return The source names list.
19535 * It will provide a list with all available sources, that can be set as
19536 * current source with elm_map_source_name_set(), or get with
19537 * elm_map_source_name_get().
19539 * Available sources:
19545 * @see elm_map_source_name_set() for more details.
19546 * @see elm_map_source_name_get()
19550 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19553 * Set the source of the map.
19555 * @param obj The map object.
19556 * @param source The source to be used.
19558 * Map widget retrieves images that composes the map from a web service.
19559 * This web service can be set with this method.
19561 * A different service can return a different maps with different
19562 * information and it can use different zoom values.
19564 * The @p source_name need to match one of the names provided by
19565 * elm_map_source_names_get().
19567 * The current source can be get using elm_map_source_name_get().
19569 * @see elm_map_source_names_get()
19570 * @see elm_map_source_name_get()
19575 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
19578 * Get the name of currently used source.
19580 * @param obj The map object.
19581 * @return Returns the name of the source in use.
19583 * @see elm_map_source_name_set() for more details.
19587 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19590 * Set the source of the route service to be used by the map.
19592 * @param obj The map object.
19593 * @param source The route service to be used, being it one of
19594 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
19595 * and #ELM_MAP_ROUTE_SOURCE_ORS.
19597 * Each one has its own algorithm, so the route retrieved may
19598 * differ depending on the source route. Now, only the default is working.
19600 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
19601 * http://www.yournavigation.org/.
19603 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
19604 * assumptions. Its routing core is based on Contraction Hierarchies.
19606 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
19608 * @see elm_map_route_source_get().
19612 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
19615 * Get the current route source.
19617 * @param obj The map object.
19618 * @return The source of the route service used by the map.
19620 * @see elm_map_route_source_set() for details.
19624 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19627 * Set the minimum zoom of the source.
19629 * @param obj The map object.
19630 * @param zoom New minimum zoom value to be used.
19632 * By default, it's 0.
19636 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19639 * Get the minimum zoom of the source.
19641 * @param obj The map object.
19642 * @return Returns the minimum zoom of the source.
19644 * @see elm_map_source_zoom_min_set() for details.
19648 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19651 * Set the maximum zoom of the source.
19653 * @param obj The map object.
19654 * @param zoom New maximum zoom value to be used.
19656 * By default, it's 18.
19660 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
19663 * Get the maximum zoom of the source.
19665 * @param obj The map object.
19666 * @return Returns the maximum zoom of the source.
19668 * @see elm_map_source_zoom_min_set() for details.
19672 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19675 * Set the user agent used by the map object to access routing services.
19677 * @param obj The map object.
19678 * @param user_agent The user agent to be used by the map.
19680 * User agent is a client application implementing a network protocol used
19681 * in communications within a client–server distributed computing system
19683 * The @p user_agent identification string will transmitted in a header
19684 * field @c User-Agent.
19686 * @see elm_map_user_agent_get()
19690 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
19693 * Get the user agent used by the map object.
19695 * @param obj The map object.
19696 * @return The user agent identification string used by the map.
19698 * @see elm_map_user_agent_set() for details.
19702 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19705 * Add a new route to the map object.
19707 * @param obj The map object.
19708 * @param type The type of transport to be considered when tracing a route.
19709 * @param method The routing method, what should be priorized.
19710 * @param flon The start longitude.
19711 * @param flat The start latitude.
19712 * @param tlon The destination longitude.
19713 * @param tlat The destination latitude.
19715 * @return The created route or @c NULL upon failure.
19717 * A route will be traced by point on coordinates (@p flat, @p flon)
19718 * to point on coordinates (@p tlat, @p tlon), using the route service
19719 * set with elm_map_route_source_set().
19721 * It will take @p type on consideration to define the route,
19722 * depending if the user will be walking or driving, the route may vary.
19723 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
19724 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
19726 * Another parameter is what the route should priorize, the minor distance
19727 * or the less time to be spend on the route. So @p method should be one
19728 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
19730 * Routes created with this method can be deleted with
19731 * elm_map_route_remove(), colored with elm_map_route_color_set(),
19732 * and distance can be get with elm_map_route_distance_get().
19734 * @see elm_map_route_remove()
19735 * @see elm_map_route_color_set()
19736 * @see elm_map_route_distance_get()
19737 * @see elm_map_route_source_set()
19741 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);
19744 * Remove a route from the map.
19746 * @param route The route to remove.
19748 * @see elm_map_route_add()
19752 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19755 * Set the route color.
19757 * @param route The route object.
19758 * @param r Red channel value, from 0 to 255.
19759 * @param g Green channel value, from 0 to 255.
19760 * @param b Blue channel value, from 0 to 255.
19761 * @param a Alpha channel value, from 0 to 255.
19763 * It uses an additive color model, so each color channel represents
19764 * how much of each primary colors must to be used. 0 represents
19765 * ausence of this color, so if all of the three are set to 0,
19766 * the color will be black.
19768 * These component values should be integers in the range 0 to 255,
19769 * (single 8-bit byte).
19771 * This sets the color used for the route. By default, it is set to
19772 * solid red (r = 255, g = 0, b = 0, a = 255).
19774 * For alpha channel, 0 represents completely transparent, and 255, opaque.
19776 * @see elm_map_route_color_get()
19780 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
19783 * Get the route color.
19785 * @param route The route object.
19786 * @param r Pointer where to store the red channel value.
19787 * @param g Pointer where to store the green channel value.
19788 * @param b Pointer where to store the blue channel value.
19789 * @param a Pointer where to store the alpha channel value.
19791 * @see elm_map_route_color_set() for details.
19795 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
19798 * Get the route distance in kilometers.
19800 * @param route The route object.
19801 * @return The distance of route (unit : km).
19805 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19808 * Get the information of route nodes.
19810 * @param route The route object.
19811 * @return Returns a string with the nodes of route.
19815 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19818 * Get the information of route waypoint.
19820 * @param route the route object.
19821 * @return Returns a string with information about waypoint of route.
19825 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
19828 * Get the address of the name.
19830 * @param name The name handle.
19831 * @return Returns the address string of @p name.
19833 * This gets the coordinates of the @p name, created with one of the
19834 * conversion functions.
19836 * @see elm_map_utils_convert_name_into_coord()
19837 * @see elm_map_utils_convert_coord_into_name()
19841 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19844 * Get the current coordinates of the name.
19846 * @param name The name handle.
19847 * @param lat Pointer where to store the latitude.
19848 * @param lon Pointer where to store The longitude.
19850 * This gets the coordinates of the @p name, created with one of the
19851 * conversion functions.
19853 * @see elm_map_utils_convert_name_into_coord()
19854 * @see elm_map_utils_convert_coord_into_name()
19858 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
19861 * Remove a name from the map.
19863 * @param name The name to remove.
19865 * Basically the struct handled by @p name will be freed, so convertions
19866 * between address and coordinates will be lost.
19868 * @see elm_map_utils_convert_name_into_coord()
19869 * @see elm_map_utils_convert_coord_into_name()
19873 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
19878 * @param obj The map object.
19879 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
19880 * @param cx Rotation's center horizontal position.
19881 * @param cy Rotation's center vertical position.
19883 * @see elm_map_rotate_get()
19887 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
19890 * Get the rotate degree of the map
19892 * @param obj The map object
19893 * @param degree Pointer where to store degrees from 0.0 to 360.0
19894 * to rotate arount Z axis.
19895 * @param cx Pointer where to store rotation's center horizontal position.
19896 * @param cy Pointer where to store rotation's center vertical position.
19898 * @see elm_map_rotate_set() to set map rotation.
19902 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);
19905 * Enable or disable mouse wheel to be used to zoom in / out the map.
19907 * @param obj The map object.
19908 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
19911 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19913 * It's disabled by default.
19915 * @see elm_map_wheel_disabled_get()
19919 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19922 * Get a value whether mouse wheel is enabled or not.
19924 * @param obj The map object.
19925 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
19926 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19928 * Mouse wheel can be used for the user to zoom in or zoom out the map.
19930 * @see elm_map_wheel_disabled_set() for details.
19934 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19938 * Add a track on the map
19940 * @param obj The map object.
19941 * @param emap The emap route object.
19942 * @return The route object. This is an elm object of type Route.
19944 * @see elm_route_add() for details.
19948 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
19952 * Remove a track from the map
19954 * @param obj The map object.
19955 * @param route The track to remove.
19959 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
19966 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
19968 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
19970 EAPI double elm_route_lon_min_get(Evas_Object *obj);
19971 EAPI double elm_route_lat_min_get(Evas_Object *obj);
19972 EAPI double elm_route_lon_max_get(Evas_Object *obj);
19973 EAPI double elm_route_lat_max_get(Evas_Object *obj);
19977 * @defgroup Panel Panel
19979 * @image html img/widget/panel/preview-00.png
19980 * @image latex img/widget/panel/preview-00.eps
19982 * @brief A panel is a type of animated container that contains subobjects.
19983 * It can be expanded or contracted by clicking the button on it's edge.
19985 * Orientations are as follows:
19986 * @li ELM_PANEL_ORIENT_TOP
19987 * @li ELM_PANEL_ORIENT_LEFT
19988 * @li ELM_PANEL_ORIENT_RIGHT
19990 * @ref tutorial_panel shows one way to use this widget.
19993 typedef enum _Elm_Panel_Orient
19995 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
19996 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
19997 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
19998 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
19999 } Elm_Panel_Orient;
20001 * @brief Adds a panel object
20003 * @param parent The parent object
20005 * @return The panel object, or NULL on failure
20007 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20009 * @brief Sets the orientation of the panel
20011 * @param parent The parent object
20012 * @param orient The panel orientation. Can be one of the following:
20013 * @li ELM_PANEL_ORIENT_TOP
20014 * @li ELM_PANEL_ORIENT_LEFT
20015 * @li ELM_PANEL_ORIENT_RIGHT
20017 * Sets from where the panel will (dis)appear.
20019 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
20021 * @brief Get the orientation of the panel.
20023 * @param obj The panel object
20024 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
20026 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20028 * @brief Set the content of the panel.
20030 * @param obj The panel object
20031 * @param content The panel content
20033 * Once the content object is set, a previously set one will be deleted.
20034 * If you want to keep that old content object, use the
20035 * elm_panel_content_unset() function.
20037 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20039 * @brief Get the content of the panel.
20041 * @param obj The panel object
20042 * @return The content that is being used
20044 * Return the content object which is set for this widget.
20046 * @see elm_panel_content_set()
20048 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20050 * @brief Unset the content of the panel.
20052 * @param obj The panel object
20053 * @return The content that was being used
20055 * Unparent and return the content object which was set for this widget.
20057 * @see elm_panel_content_set()
20059 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20061 * @brief Set the state of the panel.
20063 * @param obj The panel object
20064 * @param hidden If true, the panel will run the animation to contract
20066 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
20068 * @brief Get the state of the panel.
20070 * @param obj The panel object
20071 * @param hidden If true, the panel is in the "hide" state
20073 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20075 * @brief Toggle the hidden state of the panel from code
20077 * @param obj The panel object
20079 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
20085 * @defgroup Panes Panes
20086 * @ingroup Elementary
20088 * @image html img/widget/panes/preview-00.png
20089 * @image latex img/widget/panes/preview-00.eps width=\textwidth
20091 * @image html img/panes.png
20092 * @image latex img/panes.eps width=\textwidth
20094 * The panes adds a dragable bar between two contents. When dragged
20095 * this bar will resize contents size.
20097 * Panes can be displayed vertically or horizontally, and contents
20098 * size proportion can be customized (homogeneous by default).
20100 * Smart callbacks one can listen to:
20101 * - "press" - The panes has been pressed (button wasn't released yet).
20102 * - "unpressed" - The panes was released after being pressed.
20103 * - "clicked" - The panes has been clicked>
20104 * - "clicked,double" - The panes has been double clicked
20106 * Available styles for it:
20109 * Here is an example on its usage:
20110 * @li @ref panes_example
20114 * @addtogroup Panes
20119 * Add a new panes widget to the given parent Elementary
20120 * (container) object.
20122 * @param parent The parent object.
20123 * @return a new panes widget handle or @c NULL, on errors.
20125 * This function inserts a new panes widget on the canvas.
20129 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20132 * Set the left content of the panes widget.
20134 * @param obj The panes object.
20135 * @param content The new left content object.
20137 * Once the content object is set, a previously set one will be deleted.
20138 * If you want to keep that old content object, use the
20139 * elm_panes_content_left_unset() function.
20141 * If panes is displayed vertically, left content will be displayed at
20144 * @see elm_panes_content_left_get()
20145 * @see elm_panes_content_right_set() to set content on the other side.
20149 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20152 * Set the right content of the panes widget.
20154 * @param obj The panes object.
20155 * @param content The new right content object.
20157 * Once the content object is set, a previously set one will be deleted.
20158 * If you want to keep that old content object, use the
20159 * elm_panes_content_right_unset() function.
20161 * If panes is displayed vertically, left content will be displayed at
20164 * @see elm_panes_content_right_get()
20165 * @see elm_panes_content_left_set() to set content on the other side.
20169 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20172 * Get the left content of the panes.
20174 * @param obj The panes object.
20175 * @return The left content object that is being used.
20177 * Return the left content object which is set for this widget.
20179 * @see elm_panes_content_left_set() for details.
20183 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20186 * Get the right content of the panes.
20188 * @param obj The panes object
20189 * @return The right content object that is being used
20191 * Return the right content object which is set for this widget.
20193 * @see elm_panes_content_right_set() for details.
20197 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20200 * Unset the left content used for the panes.
20202 * @param obj The panes object.
20203 * @return The left content object that was being used.
20205 * Unparent and return the left content object which was set for this widget.
20207 * @see elm_panes_content_left_set() for details.
20208 * @see elm_panes_content_left_get().
20212 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20215 * Unset the right content used for the panes.
20217 * @param obj The panes object.
20218 * @return The right content object that was being used.
20220 * Unparent and return the right content object which was set for this
20223 * @see elm_panes_content_right_set() for details.
20224 * @see elm_panes_content_right_get().
20228 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20231 * Get the size proportion of panes widget's left side.
20233 * @param obj The panes object.
20234 * @return float value between 0.0 and 1.0 representing size proportion
20237 * @see elm_panes_content_left_size_set() for more details.
20241 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20244 * Set the size proportion of panes widget's left side.
20246 * @param obj The panes object.
20247 * @param size Value between 0.0 and 1.0 representing size proportion
20250 * By default it's homogeneous, i.e., both sides have the same size.
20252 * If something different is required, it can be set with this function.
20253 * For example, if the left content should be displayed over
20254 * 75% of the panes size, @p size should be passed as @c 0.75.
20255 * This way, right content will be resized to 25% of panes size.
20257 * If displayed vertically, left content is displayed at top, and
20258 * right content at bottom.
20260 * @note This proportion will change when user drags the panes bar.
20262 * @see elm_panes_content_left_size_get()
20266 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
20269 * Set the orientation of a given panes widget.
20271 * @param obj The panes object.
20272 * @param horizontal Use @c EINA_TRUE to make @p obj to be
20273 * @b horizontal, @c EINA_FALSE to make it @b vertical.
20275 * Use this function to change how your panes is to be
20276 * disposed: vertically or horizontally.
20278 * By default it's displayed horizontally.
20280 * @see elm_panes_horizontal_get()
20284 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20287 * Retrieve the orientation of a given panes widget.
20289 * @param obj The panes object.
20290 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20291 * @c EINA_FALSE if it's @b vertical (and on errors).
20293 * @see elm_panes_horizontal_set() for more details.
20297 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20304 * @defgroup Flip Flip
20306 * @image html img/widget/flip/preview-00.png
20307 * @image latex img/widget/flip/preview-00.eps
20309 * This widget holds 2 content objects(Evas_Object): one on the front and one
20310 * on the back. It allows you to flip from front to back and vice-versa using
20311 * various animations.
20313 * If either the front or back contents are not set the flip will treat that
20314 * as transparent. So if you wore to set the front content but not the back,
20315 * and then call elm_flip_go() you would see whatever is below the flip.
20317 * For a list of supported animations see elm_flip_go().
20319 * Signals that you can add callbacks for are:
20320 * "animate,begin" - when a flip animation was started
20321 * "animate,done" - when a flip animation is finished
20323 * @ref tutorial_flip show how to use most of the API.
20327 typedef enum _Elm_Flip_Mode
20329 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
20330 ELM_FLIP_ROTATE_X_CENTER_AXIS,
20331 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
20332 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
20333 ELM_FLIP_CUBE_LEFT,
20334 ELM_FLIP_CUBE_RIGHT,
20336 ELM_FLIP_CUBE_DOWN,
20337 ELM_FLIP_PAGE_LEFT,
20338 ELM_FLIP_PAGE_RIGHT,
20342 typedef enum _Elm_Flip_Interaction
20344 ELM_FLIP_INTERACTION_NONE,
20345 ELM_FLIP_INTERACTION_ROTATE,
20346 ELM_FLIP_INTERACTION_CUBE,
20347 ELM_FLIP_INTERACTION_PAGE
20348 } Elm_Flip_Interaction;
20349 typedef enum _Elm_Flip_Direction
20351 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
20352 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
20353 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
20354 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
20355 } Elm_Flip_Direction;
20357 * @brief Add a new flip to the parent
20359 * @param parent The parent object
20360 * @return The new object or NULL if it cannot be created
20362 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20364 * @brief Set the front content of the flip widget.
20366 * @param obj The flip object
20367 * @param content The new front content object
20369 * Once the content object is set, a previously set one will be deleted.
20370 * If you want to keep that old content object, use the
20371 * elm_flip_content_front_unset() function.
20373 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20375 * @brief Set the back content of the flip widget.
20377 * @param obj The flip object
20378 * @param content The new back content object
20380 * Once the content object is set, a previously set one will be deleted.
20381 * If you want to keep that old content object, use the
20382 * elm_flip_content_back_unset() function.
20384 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20386 * @brief Get the front content used for the flip
20388 * @param obj The flip object
20389 * @return The front content object that is being used
20391 * Return the front content object which is set for this widget.
20393 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20395 * @brief Get the back content used for the flip
20397 * @param obj The flip object
20398 * @return The back content object that is being used
20400 * Return the back content object which is set for this widget.
20402 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20404 * @brief Unset the front content used for the flip
20406 * @param obj The flip object
20407 * @return The front content object that was being used
20409 * Unparent and return the front content object which was set for this widget.
20411 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20413 * @brief Unset the back content used for the flip
20415 * @param obj The flip object
20416 * @return The back content object that was being used
20418 * Unparent and return the back content object which was set for this widget.
20420 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20422 * @brief Get flip front visibility state
20424 * @param obj The flip objct
20425 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
20428 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20430 * @brief Set flip perspective
20432 * @param obj The flip object
20433 * @param foc The coordinate to set the focus on
20434 * @param x The X coordinate
20435 * @param y The Y coordinate
20437 * @warning This function currently does nothing.
20439 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
20441 * @brief Runs the flip animation
20443 * @param obj The flip object
20444 * @param mode The mode type
20446 * Flips the front and back contents using the @p mode animation. This
20447 * efectively hides the currently visible content and shows the hidden one.
20449 * There a number of possible animations to use for the flipping:
20450 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
20451 * around a horizontal axis in the middle of its height, the other content
20452 * is shown as the other side of the flip.
20453 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
20454 * around a vertical axis in the middle of its width, the other content is
20455 * shown as the other side of the flip.
20456 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
20457 * around a diagonal axis in the middle of its width, the other content is
20458 * shown as the other side of the flip.
20459 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
20460 * around a diagonal axis in the middle of its height, the other content is
20461 * shown as the other side of the flip.
20462 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
20463 * as if the flip was a cube, the other content is show as the right face of
20465 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
20466 * right as if the flip was a cube, the other content is show as the left
20467 * face of the cube.
20468 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
20469 * flip was a cube, the other content is show as the bottom face of the cube.
20470 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
20471 * the flip was a cube, the other content is show as the upper face of the
20473 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
20474 * if the flip was a book, the other content is shown as the page below that.
20475 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
20476 * as if the flip was a book, the other content is shown as the page below
20478 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
20479 * flip was a book, the other content is shown as the page below that.
20480 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
20481 * flip was a book, the other content is shown as the page below that.
20483 * @image html elm_flip.png
20484 * @image latex elm_flip.eps width=\textwidth
20486 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
20488 * @brief Set the interactive flip mode
20490 * @param obj The flip object
20491 * @param mode The interactive flip mode to use
20493 * This sets if the flip should be interactive (allow user to click and
20494 * drag a side of the flip to reveal the back page and cause it to flip).
20495 * By default a flip is not interactive. You may also need to set which
20496 * sides of the flip are "active" for flipping and how much space they use
20497 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
20498 * and elm_flip_interacton_direction_hitsize_set()
20500 * The four avilable mode of interaction are:
20501 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
20502 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
20503 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
20504 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
20506 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
20507 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
20508 * happen, those can only be acheived with elm_flip_go();
20510 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
20512 * @brief Get the interactive flip mode
20514 * @param obj The flip object
20515 * @return The interactive flip mode
20517 * Returns the interactive flip mode set by elm_flip_interaction_set()
20519 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
20521 * @brief Set which directions of the flip respond to interactive flip
20523 * @param obj The flip object
20524 * @param dir The direction to change
20525 * @param enabled If that direction is enabled or not
20527 * By default all directions are disabled, so you may want to enable the
20528 * desired directions for flipping if you need interactive flipping. You must
20529 * call this function once for each direction that should be enabled.
20531 * @see elm_flip_interaction_set()
20533 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
20535 * @brief Get the enabled state of that flip direction
20537 * @param obj The flip object
20538 * @param dir The direction to check
20539 * @return If that direction is enabled or not
20541 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
20543 * @see elm_flip_interaction_set()
20545 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
20547 * @brief Set the amount of the flip that is sensitive to interactive flip
20549 * @param obj The flip object
20550 * @param dir The direction to modify
20551 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
20553 * Set the amount of the flip that is sensitive to interactive flip, with 0
20554 * representing no area in the flip and 1 representing the entire flip. There
20555 * is however a consideration to be made in that the area will never be
20556 * smaller than the finger size set(as set in your Elementary configuration).
20558 * @see elm_flip_interaction_set()
20560 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
20562 * @brief Get the amount of the flip that is sensitive to interactive flip
20564 * @param obj The flip object
20565 * @param dir The direction to check
20566 * @return The size set for that direction
20568 * Returns the amount os sensitive area set by
20569 * elm_flip_interacton_direction_hitsize_set().
20571 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
20576 /* scrolledentry */
20577 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20578 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
20579 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20580 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
20581 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20582 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20583 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20584 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20585 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20586 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20587 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
20588 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
20589 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20590 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20591 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
20592 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
20593 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20594 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
20595 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
20596 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
20597 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20598 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20599 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20600 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
20601 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
20602 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
20603 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20604 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20605 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20606 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
20607 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20608 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
20609 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
20610 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
20611 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20612 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);
20613 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
20614 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20615 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);
20616 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20617 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);
20618 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
20619 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20620 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20621 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20622 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
20623 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20624 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20625 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
20626 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);
20627 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);
20628 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);
20629 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);
20630 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);
20631 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);
20632 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
20633 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
20634 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
20635 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
20636 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20637 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
20638 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
20641 * @defgroup Conformant Conformant
20642 * @ingroup Elementary
20644 * @image html img/widget/conformant/preview-00.png
20645 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
20647 * @image html img/conformant.png
20648 * @image latex img/conformant.eps width=\textwidth
20650 * The aim is to provide a widget that can be used in elementary apps to
20651 * account for space taken up by the indicator, virtual keypad & softkey
20652 * windows when running the illume2 module of E17.
20654 * So conformant content will be sized and positioned considering the
20655 * space required for such stuff, and when they popup, as a keyboard
20656 * shows when an entry is selected, conformant content won't change.
20658 * Available styles for it:
20661 * See how to use this widget in this example:
20662 * @ref conformant_example
20666 * @addtogroup Conformant
20671 * Add a new conformant widget to the given parent Elementary
20672 * (container) object.
20674 * @param parent The parent object.
20675 * @return A new conformant widget handle or @c NULL, on errors.
20677 * This function inserts a new conformant widget on the canvas.
20679 * @ingroup Conformant
20681 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20684 * Set the content of the conformant widget.
20686 * @param obj The conformant object.
20687 * @param content The content to be displayed by the conformant.
20689 * Content will be sized and positioned considering the space required
20690 * to display a virtual keyboard. So it won't fill all the conformant
20691 * size. This way is possible to be sure that content won't resize
20692 * or be re-positioned after the keyboard is displayed.
20694 * Once the content object is set, a previously set one will be deleted.
20695 * If you want to keep that old content object, use the
20696 * elm_conformat_content_unset() function.
20698 * @see elm_conformant_content_unset()
20699 * @see elm_conformant_content_get()
20701 * @ingroup Conformant
20703 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20706 * Get the content of the conformant widget.
20708 * @param obj The conformant object.
20709 * @return The content that is being used.
20711 * Return the content object which is set for this widget.
20712 * It won't be unparent from conformant. For that, use
20713 * elm_conformant_content_unset().
20715 * @see elm_conformant_content_set() for more details.
20716 * @see elm_conformant_content_unset()
20718 * @ingroup Conformant
20720 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20723 * Unset the content of the conformant widget.
20725 * @param obj The conformant object.
20726 * @return The content that was being used.
20728 * Unparent and return the content object which was set for this widget.
20730 * @see elm_conformant_content_set() for more details.
20732 * @ingroup Conformant
20734 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20737 * Returns the Evas_Object that represents the content area.
20739 * @param obj The conformant object.
20740 * @return The content area of the widget.
20742 * @ingroup Conformant
20744 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20751 * @defgroup Mapbuf Mapbuf
20752 * @ingroup Elementary
20754 * @image html img/widget/mapbuf/preview-00.png
20755 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
20757 * This holds one content object and uses an Evas Map of transformation
20758 * points to be later used with this content. So the content will be
20759 * moved, resized, etc as a single image. So it will improve performance
20760 * when you have a complex interafce, with a lot of elements, and will
20761 * need to resize or move it frequently (the content object and its
20764 * See how to use this widget in this example:
20765 * @ref mapbuf_example
20769 * @addtogroup Mapbuf
20774 * Add a new mapbuf widget to the given parent Elementary
20775 * (container) object.
20777 * @param parent The parent object.
20778 * @return A new mapbuf widget handle or @c NULL, on errors.
20780 * This function inserts a new mapbuf widget on the canvas.
20784 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20787 * Set the content of the mapbuf.
20789 * @param obj The mapbuf object.
20790 * @param content The content that will be filled in this mapbuf object.
20792 * Once the content object is set, a previously set one will be deleted.
20793 * If you want to keep that old content object, use the
20794 * elm_mapbuf_content_unset() function.
20796 * To enable map, elm_mapbuf_enabled_set() should be used.
20800 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20803 * Get the content of the mapbuf.
20805 * @param obj The mapbuf object.
20806 * @return The content that is being used.
20808 * Return the content object which is set for this widget.
20810 * @see elm_mapbuf_content_set() for details.
20814 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20817 * Unset the content of the mapbuf.
20819 * @param obj The mapbuf object.
20820 * @return The content that was being used.
20822 * Unparent and return the content object which was set for this widget.
20824 * @see elm_mapbuf_content_set() for details.
20828 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20831 * Enable or disable the map.
20833 * @param obj The mapbuf object.
20834 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
20836 * This enables the map that is set or disables it. On enable, the object
20837 * geometry will be saved, and the new geometry will change (position and
20838 * size) to reflect the map geometry set.
20840 * Also, when enabled, alpha and smooth states will be used, so if the
20841 * content isn't solid, alpha should be enabled, for example, otherwise
20842 * a black retangle will fill the content.
20844 * When disabled, the stored map will be freed and geometry prior to
20845 * enabling the map will be restored.
20847 * It's disabled by default.
20849 * @see elm_mapbuf_alpha_set()
20850 * @see elm_mapbuf_smooth_set()
20854 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
20857 * Get a value whether map is enabled or not.
20859 * @param obj The mapbuf object.
20860 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
20861 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20863 * @see elm_mapbuf_enabled_set() for details.
20867 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20870 * Enable or disable smooth map rendering.
20872 * @param obj The mapbuf object.
20873 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
20876 * This sets smoothing for map rendering. If the object is a type that has
20877 * its own smoothing settings, then both the smooth settings for this object
20878 * and the map must be turned off.
20880 * By default smooth maps are enabled.
20884 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
20887 * Get a value whether smooth map rendering is enabled or not.
20889 * @param obj The mapbuf object.
20890 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
20891 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20893 * @see elm_mapbuf_smooth_set() for details.
20897 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20900 * Set or unset alpha flag for map rendering.
20902 * @param obj The mapbuf object.
20903 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
20906 * This sets alpha flag for map rendering. If the object is a type that has
20907 * its own alpha settings, then this will take precedence. Only image objects
20908 * have this currently. It stops alpha blending of the map area, and is
20909 * useful if you know the object and/or all sub-objects is 100% solid.
20911 * Alpha is enabled by default.
20915 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
20918 * Get a value whether alpha blending is enabled or not.
20920 * @param obj The mapbuf object.
20921 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
20922 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20924 * @see elm_mapbuf_alpha_set() for details.
20928 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20935 * @defgroup Flipselector Flip Selector
20937 * @image html img/widget/flipselector/preview-00.png
20938 * @image latex img/widget/flipselector/preview-00.eps
20940 * A flip selector is a widget to show a set of @b text items, one
20941 * at a time, with the same sheet switching style as the @ref Clock
20942 * "clock" widget, when one changes the current displaying sheet
20943 * (thus, the "flip" in the name).
20945 * User clicks to flip sheets which are @b held for some time will
20946 * make the flip selector to flip continuosly and automatically for
20947 * the user. The interval between flips will keep growing in time,
20948 * so that it helps the user to reach an item which is distant from
20949 * the current selection.
20951 * Smart callbacks one can register to:
20952 * - @c "selected" - when the widget's selected text item is changed
20953 * - @c "overflowed" - when the widget's current selection is changed
20954 * from the first item in its list to the last
20955 * - @c "underflowed" - when the widget's current selection is changed
20956 * from the last item in its list to the first
20958 * Available styles for it:
20961 * Here is an example on its usage:
20962 * @li @ref flipselector_example
20966 * @addtogroup Flipselector
20970 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
20973 * Add a new flip selector widget to the given parent Elementary
20974 * (container) widget
20976 * @param parent The parent object
20977 * @return a new flip selector widget handle or @c NULL, on errors
20979 * This function inserts a new flip selector widget on the canvas.
20981 * @ingroup Flipselector
20983 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20986 * Programmatically select the next item of a flip selector widget
20988 * @param obj The flipselector object
20990 * @note The selection will be animated. Also, if it reaches the
20991 * end of its list of member items, it will continue with the first
20994 * @ingroup Flipselector
20996 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20999 * Programmatically select the previous item of a flip selector
21002 * @param obj The flipselector object
21004 * @note The selection will be animated. Also, if it reaches the
21005 * beginning of its list of member items, it will continue with the
21006 * last one backwards.
21008 * @ingroup Flipselector
21010 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
21013 * Append a (text) item to a flip selector widget
21015 * @param obj The flipselector object
21016 * @param label The (text) label of the new item
21017 * @param func Convenience callback function to take place when
21019 * @param data Data passed to @p func, above
21020 * @return A handle to the item added or @c NULL, on errors
21022 * The widget's list of labels to show will be appended with the
21023 * given value. If the user wishes so, a callback function pointer
21024 * can be passed, which will get called when this same item is
21027 * @note The current selection @b won't be modified by appending an
21028 * element to the list.
21030 * @note The maximum length of the text label is going to be
21031 * determined <b>by the widget's theme</b>. Strings larger than
21032 * that value are going to be @b truncated.
21034 * @ingroup Flipselector
21036 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21039 * Prepend a (text) item to a flip selector widget
21041 * @param obj The flipselector object
21042 * @param label The (text) label of the new item
21043 * @param func Convenience callback function to take place when
21045 * @param data Data passed to @p func, above
21046 * @return A handle to the item added or @c NULL, on errors
21048 * The widget's list of labels to show will be prepended with the
21049 * given value. If the user wishes so, a callback function pointer
21050 * can be passed, which will get called when this same item is
21053 * @note The current selection @b won't be modified by prepending
21054 * an element to the list.
21056 * @note The maximum length of the text label is going to be
21057 * determined <b>by the widget's theme</b>. Strings larger than
21058 * that value are going to be @b truncated.
21060 * @ingroup Flipselector
21062 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
21065 * Get the internal list of items in a given flip selector widget.
21067 * @param obj The flipselector object
21068 * @return The list of items (#Elm_Flipselector_Item as data) or
21069 * @c NULL on errors.
21071 * This list is @b not to be modified in any way and must not be
21072 * freed. Use the list members with functions like
21073 * elm_flipselector_item_label_set(),
21074 * elm_flipselector_item_label_get(),
21075 * elm_flipselector_item_del(),
21076 * elm_flipselector_item_selected_get(),
21077 * elm_flipselector_item_selected_set().
21079 * @warning This list is only valid until @p obj object's internal
21080 * items list is changed. It should be fetched again with another
21081 * call to this function when changes happen.
21083 * @ingroup Flipselector
21085 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21088 * Get the first item in the given flip selector widget's list of
21091 * @param obj The flipselector object
21092 * @return The first item or @c NULL, if it has no items (and on
21095 * @see elm_flipselector_item_append()
21096 * @see elm_flipselector_last_item_get()
21098 * @ingroup Flipselector
21100 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21103 * Get the last item in the given flip selector widget's list of
21106 * @param obj The flipselector object
21107 * @return The last item or @c NULL, if it has no items (and on
21110 * @see elm_flipselector_item_prepend()
21111 * @see elm_flipselector_first_item_get()
21113 * @ingroup Flipselector
21115 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21118 * Get the currently selected item in a flip selector widget.
21120 * @param obj The flipselector object
21121 * @return The selected item or @c NULL, if the widget has no items
21124 * @ingroup Flipselector
21126 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21129 * Set whether a given flip selector widget's item should be the
21130 * currently selected one.
21132 * @param item The flip selector item
21133 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
21135 * This sets whether @p item is or not the selected (thus, under
21136 * display) one. If @p item is different than one under display,
21137 * the latter will be unselected. If the @p item is set to be
21138 * unselected, on the other hand, the @b first item in the widget's
21139 * internal members list will be the new selected one.
21141 * @see elm_flipselector_item_selected_get()
21143 * @ingroup Flipselector
21145 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
21148 * Get whether a given flip selector widget's item is the currently
21151 * @param item The flip selector item
21152 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
21155 * @see elm_flipselector_item_selected_set()
21157 * @ingroup Flipselector
21159 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21162 * Delete a given item from a flip selector widget.
21164 * @param item The item to delete
21166 * @ingroup Flipselector
21168 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21171 * Get the label of a given flip selector widget's item.
21173 * @param item The item to get label from
21174 * @return The text label of @p item or @c NULL, on errors
21176 * @see elm_flipselector_item_label_set()
21178 * @ingroup Flipselector
21180 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21183 * Set the label of a given flip selector widget's item.
21185 * @param item The item to set label on
21186 * @param label The text label string, in UTF-8 encoding
21188 * @see elm_flipselector_item_label_get()
21190 * @ingroup Flipselector
21192 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
21195 * Gets the item before @p item in a flip selector widget's
21196 * internal list of items.
21198 * @param item The item to fetch previous from
21199 * @return The item before the @p item, in its parent's list. If
21200 * there is no previous item for @p item or there's an
21201 * error, @c NULL is returned.
21203 * @see elm_flipselector_item_next_get()
21205 * @ingroup Flipselector
21207 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21210 * Gets the item after @p item in a flip selector widget's
21211 * internal list of items.
21213 * @param item The item to fetch next from
21214 * @return The item after the @p item, in its parent's list. If
21215 * there is no next item for @p item or there's an
21216 * error, @c NULL is returned.
21218 * @see elm_flipselector_item_next_get()
21220 * @ingroup Flipselector
21222 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
21225 * Set the interval on time updates for an user mouse button hold
21226 * on a flip selector widget.
21228 * @param obj The flip selector object
21229 * @param interval The (first) interval value in seconds
21231 * This interval value is @b decreased while the user holds the
21232 * mouse pointer either flipping up or flipping doww a given flip
21235 * This helps the user to get to a given item distant from the
21236 * current one easier/faster, as it will start to flip quicker and
21237 * quicker on mouse button holds.
21239 * The calculation for the next flip interval value, starting from
21240 * the one set with this call, is the previous interval divided by
21241 * 1.05, so it decreases a little bit.
21243 * The default starting interval value for automatic flips is
21246 * @see elm_flipselector_interval_get()
21248 * @ingroup Flipselector
21250 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21253 * Get the interval on time updates for an user mouse button hold
21254 * on a flip selector widget.
21256 * @param obj The flip selector object
21257 * @return The (first) interval value, in seconds, set on it
21259 * @see elm_flipselector_interval_set() for more details
21261 * @ingroup Flipselector
21263 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21266 * @addtogroup Calendar
21271 * @enum _Elm_Calendar_Mark_Repeat
21272 * @typedef Elm_Calendar_Mark_Repeat
21274 * Event periodicity, used to define if a mark should be repeated
21275 * @b beyond event's day. It's set when a mark is added.
21277 * So, for a mark added to 13th May with periodicity set to WEEKLY,
21278 * there will be marks every week after this date. Marks will be displayed
21279 * at 13th, 20th, 27th, 3rd June ...
21281 * Values don't work as bitmask, only one can be choosen.
21283 * @see elm_calendar_mark_add()
21285 * @ingroup Calendar
21287 typedef enum _Elm_Calendar_Mark_Repeat
21289 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
21290 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
21291 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
21292 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*/
21293 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. */
21294 } Elm_Calendar_Mark_Repeat;
21296 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(). */
21299 * Add a new calendar widget to the given parent Elementary
21300 * (container) object.
21302 * @param parent The parent object.
21303 * @return a new calendar widget handle or @c NULL, on errors.
21305 * This function inserts a new calendar widget on the canvas.
21307 * @ref calendar_example_01
21309 * @ingroup Calendar
21311 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21314 * Get weekdays names displayed by the calendar.
21316 * @param obj The calendar object.
21317 * @return Array of seven strings to be used as weekday names.
21319 * By default, weekdays abbreviations get from system are displayed:
21320 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21321 * The first string is related to Sunday, the second to Monday...
21323 * @see elm_calendar_weekdays_name_set()
21325 * @ref calendar_example_05
21327 * @ingroup Calendar
21329 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21332 * Set weekdays names to be displayed by the calendar.
21334 * @param obj The calendar object.
21335 * @param weekdays Array of seven strings to be used as weekday names.
21336 * @warning It must have 7 elements, or it will access invalid memory.
21337 * @warning The strings must be NULL terminated ('@\0').
21339 * By default, weekdays abbreviations get from system are displayed:
21340 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
21342 * The first string should be related to Sunday, the second to Monday...
21344 * The usage should be like this:
21346 * const char *weekdays[] =
21348 * "Sunday", "Monday", "Tuesday", "Wednesday",
21349 * "Thursday", "Friday", "Saturday"
21351 * elm_calendar_weekdays_names_set(calendar, weekdays);
21354 * @see elm_calendar_weekdays_name_get()
21356 * @ref calendar_example_02
21358 * @ingroup Calendar
21360 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
21363 * Set the minimum and maximum values for the year
21365 * @param obj The calendar object
21366 * @param min The minimum year, greater than 1901;
21367 * @param max The maximum year;
21369 * Maximum must be greater than minimum, except if you don't wan't to set
21371 * Default values are 1902 and -1.
21373 * If the maximum year is a negative value, it will be limited depending
21374 * on the platform architecture (year 2037 for 32 bits);
21376 * @see elm_calendar_min_max_year_get()
21378 * @ref calendar_example_03
21380 * @ingroup Calendar
21382 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
21385 * Get the minimum and maximum values for the year
21387 * @param obj The calendar object.
21388 * @param min The minimum year.
21389 * @param max The maximum year.
21391 * Default values are 1902 and -1.
21393 * @see elm_calendar_min_max_year_get() for more details.
21395 * @ref calendar_example_05
21397 * @ingroup Calendar
21399 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
21402 * Enable or disable day selection
21404 * @param obj The calendar object.
21405 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
21408 * Enabled by default. If disabled, the user still can select months,
21409 * but not days. Selected days are highlighted on calendar.
21410 * It should be used if you won't need such selection for the widget usage.
21412 * When a day is selected, or month is changed, smart callbacks for
21413 * signal "changed" will be called.
21415 * @see elm_calendar_day_selection_enable_get()
21417 * @ref calendar_example_04
21419 * @ingroup Calendar
21421 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
21424 * Get a value whether day selection is enabled or not.
21426 * @see elm_calendar_day_selection_enable_set() for details.
21428 * @param obj The calendar object.
21429 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
21430 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
21432 * @ref calendar_example_05
21434 * @ingroup Calendar
21436 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21440 * Set selected date to be highlighted on calendar.
21442 * @param obj The calendar object.
21443 * @param selected_time A @b tm struct to represent the selected date.
21445 * Set the selected date, changing the displayed month if needed.
21446 * Selected date changes when the user goes to next/previous month or
21447 * select a day pressing over it on calendar.
21449 * @see elm_calendar_selected_time_get()
21451 * @ref calendar_example_04
21453 * @ingroup Calendar
21455 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
21458 * Get selected date.
21460 * @param obj The calendar object
21461 * @param selected_time A @b tm struct to point to selected date
21462 * @return EINA_FALSE means an error ocurred and returned time shouldn't
21465 * Get date selected by the user or set by function
21466 * elm_calendar_selected_time_set().
21467 * Selected date changes when the user goes to next/previous month or
21468 * select a day pressing over it on calendar.
21470 * @see elm_calendar_selected_time_get()
21472 * @ref calendar_example_05
21474 * @ingroup Calendar
21476 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
21479 * Set a function to format the string that will be used to display
21482 * @param obj The calendar object
21483 * @param format_function Function to set the month-year string given
21484 * the selected date
21486 * By default it uses strftime with "%B %Y" format string.
21487 * It should allocate the memory that will be used by the string,
21488 * that will be freed by the widget after usage.
21489 * A pointer to the string and a pointer to the time struct will be provided.
21494 * _format_month_year(struct tm *selected_time)
21497 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
21498 * return strdup(buf);
21501 * elm_calendar_format_function_set(calendar, _format_month_year);
21504 * @ref calendar_example_02
21506 * @ingroup Calendar
21508 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
21511 * Add a new mark to the calendar
21513 * @param obj The calendar object
21514 * @param mark_type A string used to define the type of mark. It will be
21515 * emitted to the theme, that should display a related modification on these
21516 * days representation.
21517 * @param mark_time A time struct to represent the date of inclusion of the
21518 * mark. For marks that repeats it will just be displayed after the inclusion
21519 * date in the calendar.
21520 * @param repeat Repeat the event following this periodicity. Can be a unique
21521 * mark (that don't repeat), daily, weekly, monthly or annually.
21522 * @return The created mark or @p NULL upon failure.
21524 * Add a mark that will be drawn in the calendar respecting the insertion
21525 * time and periodicity. It will emit the type as signal to the widget theme.
21526 * Default theme supports "holiday" and "checked", but it can be extended.
21528 * It won't immediately update the calendar, drawing the marks.
21529 * For this, call elm_calendar_marks_draw(). However, when user selects
21530 * next or previous month calendar forces marks drawn.
21532 * Marks created with this method can be deleted with
21533 * elm_calendar_mark_del().
21537 * struct tm selected_time;
21538 * time_t current_time;
21540 * current_time = time(NULL) + 5 * 84600;
21541 * localtime_r(¤t_time, &selected_time);
21542 * elm_calendar_mark_add(cal, "holiday", selected_time,
21543 * ELM_CALENDAR_ANNUALLY);
21545 * current_time = time(NULL) + 1 * 84600;
21546 * localtime_r(¤t_time, &selected_time);
21547 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
21549 * elm_calendar_marks_draw(cal);
21552 * @see elm_calendar_marks_draw()
21553 * @see elm_calendar_mark_del()
21555 * @ref calendar_example_06
21557 * @ingroup Calendar
21559 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);
21562 * Delete mark from the calendar.
21564 * @param mark The mark to be deleted.
21566 * If deleting all calendar marks is required, elm_calendar_marks_clear()
21567 * should be used instead of getting marks list and deleting each one.
21569 * @see elm_calendar_mark_add()
21571 * @ref calendar_example_06
21573 * @ingroup Calendar
21575 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
21578 * Remove all calendar's marks
21580 * @param obj The calendar object.
21582 * @see elm_calendar_mark_add()
21583 * @see elm_calendar_mark_del()
21585 * @ingroup Calendar
21587 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21591 * Get a list of all the calendar marks.
21593 * @param obj The calendar object.
21594 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
21596 * @see elm_calendar_mark_add()
21597 * @see elm_calendar_mark_del()
21598 * @see elm_calendar_marks_clear()
21600 * @ingroup Calendar
21602 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21605 * Draw calendar marks.
21607 * @param obj The calendar object.
21609 * Should be used after adding, removing or clearing marks.
21610 * It will go through the entire marks list updating the calendar.
21611 * If lots of marks will be added, add all the marks and then call
21614 * When the month is changed, i.e. user selects next or previous month,
21615 * marks will be drawed.
21617 * @see elm_calendar_mark_add()
21618 * @see elm_calendar_mark_del()
21619 * @see elm_calendar_marks_clear()
21621 * @ref calendar_example_06
21623 * @ingroup Calendar
21625 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
21628 * Set a day text color to the same that represents Saturdays.
21630 * @param obj The calendar object.
21631 * @param pos The text position. Position is the cell counter, from left
21632 * to right, up to down. It starts on 0 and ends on 41.
21634 * @deprecated use elm_calendar_mark_add() instead like:
21637 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
21638 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21641 * @see elm_calendar_mark_add()
21643 * @ingroup Calendar
21645 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21648 * Set a day text color to the same that represents Sundays.
21650 * @param obj The calendar object.
21651 * @param pos The text position. Position is the cell counter, from left
21652 * to right, up to down. It starts on 0 and ends on 41.
21654 * @deprecated use elm_calendar_mark_add() instead like:
21657 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
21658 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
21661 * @see elm_calendar_mark_add()
21663 * @ingroup Calendar
21665 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21668 * Set a day text color to the same that represents Weekdays.
21670 * @param obj The calendar object
21671 * @param pos The text position. Position is the cell counter, from left
21672 * to right, up to down. It starts on 0 and ends on 41.
21674 * @deprecated use elm_calendar_mark_add() instead like:
21677 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
21679 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
21680 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21681 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
21682 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21683 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
21684 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21685 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
21686 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
21687 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
21690 * @see elm_calendar_mark_add()
21692 * @ingroup Calendar
21694 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
21697 * Set the interval on time updates for an user mouse button hold
21698 * on calendar widgets' month selection.
21700 * @param obj The calendar object
21701 * @param interval The (first) interval value in seconds
21703 * This interval value is @b decreased while the user holds the
21704 * mouse pointer either selecting next or previous month.
21706 * This helps the user to get to a given month distant from the
21707 * current one easier/faster, as it will start to change quicker and
21708 * quicker on mouse button holds.
21710 * The calculation for the next change interval value, starting from
21711 * the one set with this call, is the previous interval divided by
21712 * 1.05, so it decreases a little bit.
21714 * The default starting interval value for automatic changes is
21717 * @see elm_calendar_interval_get()
21719 * @ingroup Calendar
21721 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21724 * Get the interval on time updates for an user mouse button hold
21725 * on calendar widgets' month selection.
21727 * @param obj The calendar object
21728 * @return The (first) interval value, in seconds, set on it
21730 * @see elm_calendar_interval_set() for more details
21732 * @ingroup Calendar
21734 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21741 * @defgroup Diskselector Diskselector
21742 * @ingroup Elementary
21744 * @image html img/widget/diskselector/preview-00.png
21745 * @image latex img/widget/diskselector/preview-00.eps
21747 * A diskselector is a kind of list widget. It scrolls horizontally,
21748 * and can contain label and icon objects. Three items are displayed
21749 * with the selected one in the middle.
21751 * It can act like a circular list with round mode and labels can be
21752 * reduced for a defined length for side items.
21754 * Smart callbacks one can listen to:
21755 * - "selected" - when item is selected, i.e. scroller stops.
21757 * Available styles for it:
21760 * List of examples:
21761 * @li @ref diskselector_example_01
21762 * @li @ref diskselector_example_02
21766 * @addtogroup Diskselector
21770 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(). */
21773 * Add a new diskselector widget to the given parent Elementary
21774 * (container) object.
21776 * @param parent The parent object.
21777 * @return a new diskselector widget handle or @c NULL, on errors.
21779 * This function inserts a new diskselector widget on the canvas.
21781 * @ingroup Diskselector
21783 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21786 * Enable or disable round mode.
21788 * @param obj The diskselector object.
21789 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
21792 * Disabled by default. If round mode is enabled the items list will
21793 * work like a circle list, so when the user reaches the last item,
21794 * the first one will popup.
21796 * @see elm_diskselector_round_get()
21798 * @ingroup Diskselector
21800 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
21803 * Get a value whether round mode is enabled or not.
21805 * @see elm_diskselector_round_set() for details.
21807 * @param obj The diskselector object.
21808 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
21809 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21811 * @ingroup Diskselector
21813 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21816 * Get the side labels max length.
21818 * @deprecated use elm_diskselector_side_label_length_get() instead:
21820 * @param obj The diskselector object.
21821 * @return The max length defined for side labels, or 0 if not a valid
21824 * @ingroup Diskselector
21826 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21829 * Set the side labels max length.
21831 * @deprecated use elm_diskselector_side_label_length_set() instead:
21833 * @param obj The diskselector object.
21834 * @param len The max length defined for side labels.
21836 * @ingroup Diskselector
21838 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21841 * Get the side labels max length.
21843 * @see elm_diskselector_side_label_length_set() for details.
21845 * @param obj The diskselector object.
21846 * @return The max length defined for side labels, or 0 if not a valid
21849 * @ingroup Diskselector
21851 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21854 * Set the side labels max length.
21856 * @param obj The diskselector object.
21857 * @param len The max length defined for side labels.
21859 * Length is the number of characters of items' label that will be
21860 * visible when it's set on side positions. It will just crop
21861 * the string after defined size. E.g.:
21863 * An item with label "January" would be displayed on side position as
21864 * "Jan" if max length is set to 3, or "Janu", if this property
21867 * When it's selected, the entire label will be displayed, except for
21868 * width restrictions. In this case label will be cropped and "..."
21869 * will be concatenated.
21871 * Default side label max length is 3.
21873 * This property will be applyed over all items, included before or
21874 * later this function call.
21876 * @ingroup Diskselector
21878 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
21881 * Set the number of items to be displayed.
21883 * @param obj The diskselector object.
21884 * @param num The number of items the diskselector will display.
21886 * Default value is 3, and also it's the minimun. If @p num is less
21887 * than 3, it will be set to 3.
21889 * Also, it can be set on theme, using data item @c display_item_num
21890 * on group "elm/diskselector/item/X", where X is style set.
21893 * group { name: "elm/diskselector/item/X";
21895 * item: "display_item_num" "5";
21898 * @ingroup Diskselector
21900 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
21903 * Set bouncing behaviour when the scrolled content reaches an edge.
21905 * Tell the internal scroller object whether it should bounce or not
21906 * when it reaches the respective edges for each axis.
21908 * @param obj The diskselector object.
21909 * @param h_bounce Whether to bounce or not in the horizontal axis.
21910 * @param v_bounce Whether to bounce or not in the vertical axis.
21912 * @see elm_scroller_bounce_set()
21914 * @ingroup Diskselector
21916 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21919 * Get the bouncing behaviour of the internal scroller.
21921 * Get whether the internal scroller should bounce when the edge of each
21922 * axis is reached scrolling.
21924 * @param obj The diskselector object.
21925 * @param h_bounce Pointer where to store the bounce state of the horizontal
21927 * @param v_bounce Pointer where to store the bounce state of the vertical
21930 * @see elm_scroller_bounce_get()
21931 * @see elm_diskselector_bounce_set()
21933 * @ingroup Diskselector
21935 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
21938 * Get the scrollbar policy.
21940 * @see elm_diskselector_scroller_policy_get() for details.
21942 * @param obj The diskselector object.
21943 * @param policy_h Pointer where to store horizontal scrollbar policy.
21944 * @param policy_v Pointer where to store vertical scrollbar policy.
21946 * @ingroup Diskselector
21948 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);
21951 * Set the scrollbar policy.
21953 * @param obj The diskselector object.
21954 * @param policy_h Horizontal scrollbar policy.
21955 * @param policy_v Vertical scrollbar policy.
21957 * This sets the scrollbar visibility policy for the given scroller.
21958 * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
21959 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
21960 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
21961 * This applies respectively for the horizontal and vertical scrollbars.
21963 * The both are disabled by default, i.e., are set to
21964 * #ELM_SCROLLER_POLICY_OFF.
21966 * @ingroup Diskselector
21968 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
21971 * Remove all diskselector's items.
21973 * @param obj The diskselector object.
21975 * @see elm_diskselector_item_del()
21976 * @see elm_diskselector_item_append()
21978 * @ingroup Diskselector
21980 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21983 * Get a list of all the diskselector items.
21985 * @param obj The diskselector object.
21986 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
21987 * or @c NULL on failure.
21989 * @see elm_diskselector_item_append()
21990 * @see elm_diskselector_item_del()
21991 * @see elm_diskselector_clear()
21993 * @ingroup Diskselector
21995 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21998 * Appends a new item to the diskselector object.
22000 * @param obj The diskselector object.
22001 * @param label The label of the diskselector item.
22002 * @param icon The icon object to use at left side of the item. An
22003 * icon can be any Evas object, but usually it is an icon created
22004 * with elm_icon_add().
22005 * @param func The function to call when the item is selected.
22006 * @param data The data to associate with the item for related callbacks.
22008 * @return The created item or @c NULL upon failure.
22010 * A new item will be created and appended to the diskselector, i.e., will
22011 * be set as last item. Also, if there is no selected item, it will
22012 * be selected. This will always happens for the first appended item.
22014 * If no icon is set, label will be centered on item position, otherwise
22015 * the icon will be placed at left of the label, that will be shifted
22018 * Items created with this method can be deleted with
22019 * elm_diskselector_item_del().
22021 * Associated @p data can be properly freed when item is deleted if a
22022 * callback function is set with elm_diskselector_item_del_cb_set().
22024 * If a function is passed as argument, it will be called everytime this item
22025 * is selected, i.e., the user stops the diskselector with this
22026 * item on center position. If such function isn't needed, just passing
22027 * @c NULL as @p func is enough. The same should be done for @p data.
22029 * Simple example (with no function callback or data associated):
22031 * disk = elm_diskselector_add(win);
22032 * ic = elm_icon_add(win);
22033 * elm_icon_file_set(ic, "path/to/image", NULL);
22034 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
22035 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
22038 * @see elm_diskselector_item_del()
22039 * @see elm_diskselector_item_del_cb_set()
22040 * @see elm_diskselector_clear()
22041 * @see elm_icon_add()
22043 * @ingroup Diskselector
22045 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);
22049 * Delete them item from the diskselector.
22051 * @param it The item of diskselector to be deleted.
22053 * If deleting all diskselector items is required, elm_diskselector_clear()
22054 * should be used instead of getting items list and deleting each one.
22056 * @see elm_diskselector_clear()
22057 * @see elm_diskselector_item_append()
22058 * @see elm_diskselector_item_del_cb_set()
22060 * @ingroup Diskselector
22062 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22065 * Set the function called when a diskselector item is freed.
22067 * @param it The item to set the callback on
22068 * @param func The function called
22070 * If there is a @p func, then it will be called prior item's memory release.
22071 * That will be called with the following arguments:
22073 * @li item's Evas object;
22076 * This way, a data associated to a diskselector item could be properly
22079 * @ingroup Diskselector
22081 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22084 * Get the data associated to the item.
22086 * @param it The diskselector item
22087 * @return The data associated to @p it
22089 * The return value is a pointer to data associated to @p item when it was
22090 * created, with function elm_diskselector_item_append(). If no data
22091 * was passed as argument, it will return @c NULL.
22093 * @see elm_diskselector_item_append()
22095 * @ingroup Diskselector
22097 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22100 * Set the icon associated to the item.
22102 * @param it The diskselector item
22103 * @param icon The icon object to associate with @p it
22105 * The icon object to use at left side of the item. An
22106 * icon can be any Evas object, but usually it is an icon created
22107 * with elm_icon_add().
22109 * Once the icon object is set, a previously set one will be deleted.
22110 * @warning Setting the same icon for two items will cause the icon to
22111 * dissapear from the first item.
22113 * If an icon was passed as argument on item creation, with function
22114 * elm_diskselector_item_append(), it will be already
22115 * associated to the item.
22117 * @see elm_diskselector_item_append()
22118 * @see elm_diskselector_item_icon_get()
22120 * @ingroup Diskselector
22122 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22125 * Get the icon associated to the item.
22127 * @param it The diskselector item
22128 * @return The icon associated to @p it
22130 * The return value is a pointer to the icon associated to @p item when it was
22131 * created, with function elm_diskselector_item_append(), or later
22132 * with function elm_diskselector_item_icon_set. If no icon
22133 * was passed as argument, it will return @c NULL.
22135 * @see elm_diskselector_item_append()
22136 * @see elm_diskselector_item_icon_set()
22138 * @ingroup Diskselector
22140 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22143 * Set the label of item.
22145 * @param it The item of diskselector.
22146 * @param label The label of item.
22148 * The label to be displayed by the item.
22150 * If no icon is set, label will be centered on item position, otherwise
22151 * the icon will be placed at left of the label, that will be shifted
22154 * An item with label "January" would be displayed on side position as
22155 * "Jan" if max length is set to 3 with function
22156 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
22159 * When this @p item is selected, the entire label will be displayed,
22160 * except for width restrictions.
22161 * In this case label will be cropped and "..." will be concatenated,
22162 * but only for display purposes. It will keep the entire string, so
22163 * if diskselector is resized the remaining characters will be displayed.
22165 * If a label was passed as argument on item creation, with function
22166 * elm_diskselector_item_append(), it will be already
22167 * displayed by the item.
22169 * @see elm_diskselector_side_label_lenght_set()
22170 * @see elm_diskselector_item_label_get()
22171 * @see elm_diskselector_item_append()
22173 * @ingroup Diskselector
22175 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
22178 * Get the label of item.
22180 * @param it The item of diskselector.
22181 * @return The label of item.
22183 * The return value is a pointer to the label associated to @p item when it was
22184 * created, with function elm_diskselector_item_append(), or later
22185 * with function elm_diskselector_item_label_set. If no label
22186 * was passed as argument, it will return @c NULL.
22188 * @see elm_diskselector_item_label_set() for more details.
22189 * @see elm_diskselector_item_append()
22191 * @ingroup Diskselector
22193 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22196 * Get the selected item.
22198 * @param obj The diskselector object.
22199 * @return The selected diskselector item.
22201 * The selected item can be unselected with function
22202 * elm_diskselector_item_selected_set(), and the first item of
22203 * diskselector will be selected.
22205 * The selected item always will be centered on diskselector, with
22206 * full label displayed, i.e., max lenght set to side labels won't
22207 * apply on the selected item. More details on
22208 * elm_diskselector_side_label_length_set().
22210 * @ingroup Diskselector
22212 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22215 * Set the selected state of an item.
22217 * @param it The diskselector item
22218 * @param selected The selected state
22220 * This sets the selected state of the given item @p it.
22221 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
22223 * If a new item is selected the previosly selected will be unselected.
22224 * Previoulsy selected item can be get with function
22225 * elm_diskselector_selected_item_get().
22227 * If the item @p it is unselected, the first item of diskselector will
22230 * Selected items will be visible on center position of diskselector.
22231 * So if it was on another position before selected, or was invisible,
22232 * diskselector will animate items until the selected item reaches center
22235 * @see elm_diskselector_item_selected_get()
22236 * @see elm_diskselector_selected_item_get()
22238 * @ingroup Diskselector
22240 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
22243 * Get whether the @p item is selected or not.
22245 * @param it The diskselector item.
22246 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
22247 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22249 * @see elm_diskselector_selected_item_set() for details.
22250 * @see elm_diskselector_item_selected_get()
22252 * @ingroup Diskselector
22254 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22257 * Get the first item of the diskselector.
22259 * @param obj The diskselector object.
22260 * @return The first item, or @c NULL if none.
22262 * The list of items follows append order. So it will return the first
22263 * item appended to the widget that wasn't deleted.
22265 * @see elm_diskselector_item_append()
22266 * @see elm_diskselector_items_get()
22268 * @ingroup Diskselector
22270 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22273 * Get the last item of the diskselector.
22275 * @param obj The diskselector object.
22276 * @return The last item, or @c NULL if none.
22278 * The list of items follows append order. So it will return last first
22279 * item appended to the widget that wasn't deleted.
22281 * @see elm_diskselector_item_append()
22282 * @see elm_diskselector_items_get()
22284 * @ingroup Diskselector
22286 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22289 * Get the item before @p item in diskselector.
22291 * @param it The diskselector item.
22292 * @return The item before @p item, or @c NULL if none or on failure.
22294 * The list of items follows append order. So it will return item appended
22295 * just before @p item and that wasn't deleted.
22297 * If it is the first item, @c NULL will be returned.
22298 * First item can be get by elm_diskselector_first_item_get().
22300 * @see elm_diskselector_item_append()
22301 * @see elm_diskselector_items_get()
22303 * @ingroup Diskselector
22305 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22308 * Get the item after @p item in diskselector.
22310 * @param it The diskselector item.
22311 * @return The item after @p item, or @c NULL if none or on failure.
22313 * The list of items follows append order. So it will return item appended
22314 * just after @p item and that wasn't deleted.
22316 * If it is the last item, @c NULL will be returned.
22317 * Last item can be get by elm_diskselector_last_item_get().
22319 * @see elm_diskselector_item_append()
22320 * @see elm_diskselector_items_get()
22322 * @ingroup Diskselector
22324 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22327 * Set the text to be shown in the diskselector item.
22329 * @param item Target item
22330 * @param text The text to set in the content
22332 * Setup the text as tooltip to object. The item can have only one tooltip,
22333 * so any previous tooltip data is removed.
22335 * @see elm_object_tooltip_text_set() for more details.
22337 * @ingroup Diskselector
22339 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
22342 * Set the content to be shown in the tooltip item.
22344 * Setup the tooltip to item. The item can have only one tooltip,
22345 * so any previous tooltip data is removed. @p func(with @p data) will
22346 * be called every time that need show the tooltip and it should
22347 * return a valid Evas_Object. This object is then managed fully by
22348 * tooltip system and is deleted when the tooltip is gone.
22350 * @param item the diskselector item being attached a tooltip.
22351 * @param func the function used to create the tooltip contents.
22352 * @param data what to provide to @a func as callback data/context.
22353 * @param del_cb called when data is not needed anymore, either when
22354 * another callback replaces @p func, the tooltip is unset with
22355 * elm_diskselector_item_tooltip_unset() or the owner @a item
22356 * dies. This callback receives as the first parameter the
22357 * given @a data, and @c event_info is the item.
22359 * @see elm_object_tooltip_content_cb_set() for more details.
22361 * @ingroup Diskselector
22363 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);
22366 * Unset tooltip from item.
22368 * @param item diskselector item to remove previously set tooltip.
22370 * Remove tooltip from item. The callback provided as del_cb to
22371 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
22372 * it is not used anymore.
22374 * @see elm_object_tooltip_unset() for more details.
22375 * @see elm_diskselector_item_tooltip_content_cb_set()
22377 * @ingroup Diskselector
22379 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22383 * Sets a different style for this item tooltip.
22385 * @note before you set a style you should define a tooltip with
22386 * elm_diskselector_item_tooltip_content_cb_set() or
22387 * elm_diskselector_item_tooltip_text_set()
22389 * @param item diskselector item with tooltip already set.
22390 * @param style the theme style to use (default, transparent, ...)
22392 * @see elm_object_tooltip_style_set() for more details.
22394 * @ingroup Diskselector
22396 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22399 * Get the style for this item tooltip.
22401 * @param item diskselector item with tooltip already set.
22402 * @return style the theme style in use, defaults to "default". If the
22403 * object does not have a tooltip set, then NULL is returned.
22405 * @see elm_object_tooltip_style_get() for more details.
22406 * @see elm_diskselector_item_tooltip_style_set()
22408 * @ingroup Diskselector
22410 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22413 * Set the cursor to be shown when mouse is over the diskselector item
22415 * @param item Target item
22416 * @param cursor the cursor name to be used.
22418 * @see elm_object_cursor_set() for more details.
22420 * @ingroup Diskselector
22422 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
22425 * Get the cursor to be shown when mouse is over the diskselector item
22427 * @param item diskselector item with cursor already set.
22428 * @return the cursor name.
22430 * @see elm_object_cursor_get() for more details.
22431 * @see elm_diskselector_cursor_set()
22433 * @ingroup Diskselector
22435 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22439 * Unset the cursor to be shown when mouse is over the diskselector item
22441 * @param item Target item
22443 * @see elm_object_cursor_unset() for more details.
22444 * @see elm_diskselector_cursor_set()
22446 * @ingroup Diskselector
22448 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22451 * Sets a different style for this item cursor.
22453 * @note before you set a style you should define a cursor with
22454 * elm_diskselector_item_cursor_set()
22456 * @param item diskselector item with cursor already set.
22457 * @param style the theme style to use (default, transparent, ...)
22459 * @see elm_object_cursor_style_set() for more details.
22461 * @ingroup Diskselector
22463 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
22467 * Get the style for this item cursor.
22469 * @param item diskselector item with cursor already set.
22470 * @return style the theme style in use, defaults to "default". If the
22471 * object does not have a cursor set, then @c NULL is returned.
22473 * @see elm_object_cursor_style_get() for more details.
22474 * @see elm_diskselector_item_cursor_style_set()
22476 * @ingroup Diskselector
22478 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22482 * Set if the cursor set should be searched on the theme or should use
22483 * the provided by the engine, only.
22485 * @note before you set if should look on theme you should define a cursor
22486 * with elm_diskselector_item_cursor_set().
22487 * By default it will only look for cursors provided by the engine.
22489 * @param item widget item with cursor already set.
22490 * @param engine_only boolean to define if cursors set with
22491 * elm_diskselector_item_cursor_set() should be searched only
22492 * between cursors provided by the engine or searched on widget's
22495 * @see elm_object_cursor_engine_only_set() for more details.
22497 * @ingroup Diskselector
22499 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
22502 * Get the cursor engine only usage for this item cursor.
22504 * @param item widget item with cursor already set.
22505 * @return engine_only boolean to define it cursors should be looked only
22506 * between the provided by the engine or searched on widget's theme as well.
22507 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
22509 * @see elm_object_cursor_engine_only_get() for more details.
22510 * @see elm_diskselector_item_cursor_engine_only_set()
22512 * @ingroup Diskselector
22514 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
22521 * @defgroup Colorselector Colorselector
22525 * @image html img/widget/colorselector/preview-00.png
22526 * @image latex img/widget/colorselector/preview-00.eps
22528 * @brief Widget for user to select a color.
22530 * Signals that you can add callbacks for are:
22531 * "changed" - When the color value changes(event_info is NULL).
22533 * See @ref tutorial_colorselector.
22536 * @brief Add a new colorselector to the parent
22538 * @param parent The parent object
22539 * @return The new object or NULL if it cannot be created
22541 * @ingroup Colorselector
22543 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22545 * Set a color for the colorselector
22547 * @param obj Colorselector object
22548 * @param r r-value of color
22549 * @param g g-value of color
22550 * @param b b-value of color
22551 * @param a a-value of color
22553 * @ingroup Colorselector
22555 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22557 * Get a color from the colorselector
22559 * @param obj Colorselector object
22560 * @param r integer pointer for r-value of color
22561 * @param g integer pointer for g-value of color
22562 * @param b integer pointer for b-value of color
22563 * @param a integer pointer for a-value of color
22565 * @ingroup Colorselector
22567 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22573 * @defgroup Ctxpopup Ctxpopup
22575 * @image html img/widget/ctxpopup/preview-00.png
22576 * @image latex img/widget/ctxpopup/preview-00.eps
22578 * @brief Context popup widet.
22580 * A ctxpopup is a widget that, when shown, pops up a list of items.
22581 * It automatically chooses an area inside its parent object's view
22582 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
22583 * optimally fit into it. In the default theme, it will also point an
22584 * arrow to it's top left position at the time one shows it. Ctxpopup
22585 * items have a label and/or an icon. It is intended for a small
22586 * number of items (hence the use of list, not genlist).
22588 * @note Ctxpopup is a especialization of @ref Hover.
22590 * Signals that you can add callbacks for are:
22591 * "dismissed" - the ctxpopup was dismissed
22593 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
22596 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
22598 typedef enum _Elm_Ctxpopup_Direction
22600 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
22602 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
22603 the clicked area */
22604 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
22605 the clicked area */
22606 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
22608 } Elm_Ctxpopup_Direction;
22611 * @brief Add a new Ctxpopup object to the parent.
22613 * @param parent Parent object
22614 * @return New object or @c NULL, if it cannot be created
22616 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22618 * @brief Set the Ctxpopup's parent
22620 * @param obj The ctxpopup object
22621 * @param area The parent to use
22623 * Set the parent object.
22625 * @note elm_ctxpopup_add() will automatically call this function
22626 * with its @c parent argument.
22628 * @see elm_ctxpopup_add()
22629 * @see elm_hover_parent_set()
22631 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
22633 * @brief Get the Ctxpopup's parent
22635 * @param obj The ctxpopup object
22637 * @see elm_ctxpopup_hover_parent_set() for more information
22639 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22641 * @brief Clear all items in the given ctxpopup object.
22643 * @param obj Ctxpopup object
22645 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22647 * @brief Change the ctxpopup's orientation to horizontal or vertical.
22649 * @param obj Ctxpopup object
22650 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
22652 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22654 * @brief Get the value of current ctxpopup object's orientation.
22656 * @param obj Ctxpopup object
22657 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
22659 * @see elm_ctxpopup_horizontal_set()
22661 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22663 * @brief Add a new item to a ctxpopup object.
22665 * @param obj Ctxpopup object
22666 * @param icon Icon to be set on new item
22667 * @param label The Label of the new item
22668 * @param func Convenience function called when item selected
22669 * @param data Data passed to @p func
22670 * @return A handle to the item added or @c NULL, on errors
22672 * @warning Ctxpopup can't hold both an item list and a content at the same
22673 * time. When an item is added, any previous content will be removed.
22675 * @see elm_ctxpopup_content_set()
22677 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);
22679 * @brief Delete the given item in a ctxpopup object.
22681 * @param item Ctxpopup item to be deleted
22683 * @see elm_ctxpopup_item_append()
22685 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
22687 * @brief Set the ctxpopup item's state as disabled or enabled.
22689 * @param item Ctxpopup item to be enabled/disabled
22690 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
22692 * When disabled the item is greyed out to indicate it's state.
22694 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22696 * @brief Get the ctxpopup item's disabled/enabled state.
22698 * @param item Ctxpopup item to be enabled/disabled
22699 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
22701 * @see elm_ctxpopup_item_disabled_set()
22703 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22705 * @brief Get the icon object for the given ctxpopup item.
22707 * @param item Ctxpopup item
22708 * @return icon object or @c NULL, if the item does not have icon or an error
22711 * @see elm_ctxpopup_item_append()
22712 * @see elm_ctxpopup_item_icon_set()
22714 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22716 * @brief Sets the side icon associated with the ctxpopup item
22718 * @param item Ctxpopup item
22719 * @param icon Icon object to be set
22721 * Once the icon object is set, a previously set one will be deleted.
22722 * @warning Setting the same icon for two items will cause the icon to
22723 * dissapear from the first item.
22725 * @see elm_ctxpopup_item_append()
22727 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
22729 * @brief Get the label for the given ctxpopup item.
22731 * @param item Ctxpopup item
22732 * @return label string or @c NULL, if the item does not have label or an
22735 * @see elm_ctxpopup_item_append()
22736 * @see elm_ctxpopup_item_label_set()
22738 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
22740 * @brief (Re)set the label on the given ctxpopup item.
22742 * @param item Ctxpopup item
22743 * @param label String to set as label
22745 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
22747 * @brief Set an elm widget as the content of the ctxpopup.
22749 * @param obj Ctxpopup object
22750 * @param content Content to be swallowed
22752 * If the content object is already set, a previous one will bedeleted. If
22753 * you want to keep that old content object, use the
22754 * elm_ctxpopup_content_unset() function.
22756 * @deprecated use elm_object_content_set()
22758 * @warning Ctxpopup can't hold both a item list and a content at the same
22759 * time. When a content is set, any previous items will be removed.
22761 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
22763 * @brief Unset the ctxpopup content
22765 * @param obj Ctxpopup object
22766 * @return The content that was being used
22768 * Unparent and return the content object which was set for this widget.
22770 * @deprecated use elm_object_content_unset()
22772 * @see elm_ctxpopup_content_set()
22774 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22776 * @brief Set the direction priority of a ctxpopup.
22778 * @param obj Ctxpopup object
22779 * @param first 1st priority of direction
22780 * @param second 2nd priority of direction
22781 * @param third 3th priority of direction
22782 * @param fourth 4th priority of direction
22784 * This functions gives a chance to user to set the priority of ctxpopup
22785 * showing direction. This doesn't guarantee the ctxpopup will appear in the
22786 * requested direction.
22788 * @see Elm_Ctxpopup_Direction
22790 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);
22792 * @brief Get the direction priority of a ctxpopup.
22794 * @param obj Ctxpopup object
22795 * @param first 1st priority of direction to be returned
22796 * @param second 2nd priority of direction to be returned
22797 * @param third 3th priority of direction to be returned
22798 * @param fourth 4th priority of direction to be returned
22800 * @see elm_ctxpopup_direction_priority_set() for more information.
22802 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);
22810 * @defgroup Transit Transit
22811 * @ingroup Elementary
22813 * Transit is designed to apply various animated transition effects to @c
22814 * Evas_Object, such like translation, rotation, etc. For using these
22815 * effects, create an @ref Elm_Transit and add the desired transition effects.
22817 * Once the effects are added into transit, they will be automatically
22818 * managed (their callback will be called until the duration is ended, and
22819 * they will be deleted on completion).
22823 * Elm_Transit *trans = elm_transit_add();
22824 * elm_transit_object_add(trans, obj);
22825 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
22826 * elm_transit_duration_set(transit, 1);
22827 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
22828 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
22829 * elm_transit_repeat_times_set(transit, 3);
22832 * Some transition effects are used to change the properties of objects. They
22834 * @li @ref elm_transit_effect_translation_add
22835 * @li @ref elm_transit_effect_color_add
22836 * @li @ref elm_transit_effect_rotation_add
22837 * @li @ref elm_transit_effect_wipe_add
22838 * @li @ref elm_transit_effect_zoom_add
22839 * @li @ref elm_transit_effect_resizing_add
22841 * Other transition effects are used to make one object disappear and another
22842 * object appear on its old place. These effects are:
22844 * @li @ref elm_transit_effect_flip_add
22845 * @li @ref elm_transit_effect_resizable_flip_add
22846 * @li @ref elm_transit_effect_fade_add
22847 * @li @ref elm_transit_effect_blend_add
22849 * It's also possible to make a transition chain with @ref
22850 * elm_transit_chain_transit_add.
22852 * @warning We strongly recommend to use elm_transit just when edje can not do
22853 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
22854 * animations can be manipulated inside the theme.
22856 * List of examples:
22857 * @li @ref transit_example_01_explained
22858 * @li @ref transit_example_02_explained
22859 * @li @ref transit_example_03_c
22860 * @li @ref transit_example_04_c
22866 * @enum Elm_Transit_Tween_Mode
22868 * The type of acceleration used in the transition.
22872 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
22873 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
22874 over time, then decrease again
22876 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
22878 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
22880 } Elm_Transit_Tween_Mode;
22883 * @enum Elm_Transit_Effect_Flip_Axis
22885 * The axis where flip effect should be applied.
22889 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
22890 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
22891 } Elm_Transit_Effect_Flip_Axis;
22893 * @enum Elm_Transit_Effect_Wipe_Dir
22895 * The direction where the wipe effect should occur.
22899 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
22900 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
22901 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
22902 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
22903 } Elm_Transit_Effect_Wipe_Dir;
22904 /** @enum Elm_Transit_Effect_Wipe_Type
22906 * Whether the wipe effect should show or hide the object.
22910 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
22912 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
22914 } Elm_Transit_Effect_Wipe_Type;
22917 * @typedef Elm_Transit
22919 * The Transit created with elm_transit_add(). This type has the information
22920 * about the objects which the transition will be applied, and the
22921 * transition effects that will be used. It also contains info about
22922 * duration, number of repetitions, auto-reverse, etc.
22924 typedef struct _Elm_Transit Elm_Transit;
22925 typedef void Elm_Transit_Effect;
22927 * @typedef Elm_Transit_Effect_Transition_Cb
22929 * Transition callback called for this effect on each transition iteration.
22931 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
22933 * Elm_Transit_Effect_End_Cb
22935 * Transition callback called for this effect when the transition is over.
22937 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
22940 * Elm_Transit_Del_Cb
22942 * A callback called when the transit is deleted.
22944 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
22949 * @note Is not necessary to delete the transit object, it will be deleted at
22950 * the end of its operation.
22951 * @note The transit will start playing when the program enter in the main loop, is not
22952 * necessary to give a start to the transit.
22954 * @return The transit object.
22958 EAPI Elm_Transit *elm_transit_add(void);
22961 * Stops the animation and delete the @p transit object.
22963 * Call this function if you wants to stop the animation before the duration
22964 * time. Make sure the @p transit object is still alive with
22965 * elm_transit_del_cb_set() function.
22966 * All added effects will be deleted, calling its repective data_free_cb
22967 * functions. The function setted by elm_transit_del_cb_set() will be called.
22969 * @see elm_transit_del_cb_set()
22971 * @param transit The transit object to be deleted.
22974 * @warning Just call this function if you are sure the transit is alive.
22976 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
22979 * Add a new effect to the transit.
22981 * @note The cb function and the data are the key to the effect. If you try to
22982 * add an already added effect, nothing is done.
22983 * @note After the first addition of an effect in @p transit, if its
22984 * effect list become empty again, the @p transit will be killed by
22985 * elm_transit_del(transit) function.
22989 * Elm_Transit *transit = elm_transit_add();
22990 * elm_transit_effect_add(transit,
22991 * elm_transit_effect_blend_op,
22992 * elm_transit_effect_blend_context_new(),
22993 * elm_transit_effect_blend_context_free);
22996 * @param transit The transit object.
22997 * @param transition_cb The operation function. It is called when the
22998 * animation begins, it is the function that actually performs the animation.
22999 * It is called with the @p data, @p transit and the time progression of the
23000 * animation (a double value between 0.0 and 1.0).
23001 * @param effect The context data of the effect.
23002 * @param end_cb The function to free the context data, it will be called
23003 * at the end of the effect, it must finalize the animation and free the
23007 * @warning The transit free the context data at the and of the transition with
23008 * the data_free_cb function, do not use the context data in another transit.
23010 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);
23013 * Delete an added effect.
23015 * This function will remove the effect from the @p transit, calling the
23016 * data_free_cb to free the @p data.
23018 * @see elm_transit_effect_add()
23020 * @note If the effect is not found, nothing is done.
23021 * @note If the effect list become empty, this function will call
23022 * elm_transit_del(transit), that is, it will kill the @p transit.
23024 * @param transit The transit object.
23025 * @param transition_cb The operation function.
23026 * @param effect The context data of the effect.
23030 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);
23033 * Add new object to apply the effects.
23035 * @note After the first addition of an object in @p transit, if its
23036 * object list become empty again, the @p transit will be killed by
23037 * elm_transit_del(transit) function.
23038 * @note If the @p obj belongs to another transit, the @p obj will be
23039 * removed from it and it will only belong to the @p transit. If the old
23040 * transit stays without objects, it will die.
23041 * @note When you add an object into the @p transit, its state from
23042 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23043 * transit ends, if you change this state whith evas_object_pass_events_set()
23044 * after add the object, this state will change again when @p transit stops to
23047 * @param transit The transit object.
23048 * @param obj Object to be animated.
23051 * @warning It is not allowed to add a new object after transit begins to go.
23053 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23056 * Removes an added object from the transit.
23058 * @note If the @p obj is not in the @p transit, nothing is done.
23059 * @note If the list become empty, this function will call
23060 * elm_transit_del(transit), that is, it will kill the @p transit.
23062 * @param transit The transit object.
23063 * @param obj Object to be removed from @p transit.
23066 * @warning It is not allowed to remove objects after transit begins to go.
23068 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
23071 * Get the objects of the transit.
23073 * @param transit The transit object.
23074 * @return a Eina_List with the objects from the transit.
23078 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23081 * Enable/disable keeping up the objects states.
23082 * If it is not kept, the objects states will be reset when transition ends.
23084 * @note @p transit can not be NULL.
23085 * @note One state includes geometry, color, map data.
23087 * @param transit The transit object.
23088 * @param state_keep Keeping or Non Keeping.
23092 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
23095 * Get a value whether the objects states will be reset or not.
23097 * @note @p transit can not be NULL
23099 * @see elm_transit_objects_final_state_keep_set()
23101 * @param transit The transit object.
23102 * @return EINA_TRUE means the states of the objects will be reset.
23103 * If @p transit is NULL, EINA_FALSE is returned
23107 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23110 * Set the event enabled when transit is operating.
23112 * If @p enabled is EINA_TRUE, the objects of the transit will receives
23113 * events from mouse and keyboard during the animation.
23114 * @note When you add an object with elm_transit_object_add(), its state from
23115 * evas_object_pass_events_get(obj) is saved, and it is applied when the
23116 * transit ends, if you change this state with evas_object_pass_events_set()
23117 * after adding the object, this state will change again when @p transit stops
23120 * @param transit The transit object.
23121 * @param enabled Events are received when enabled is @c EINA_TRUE, and
23122 * ignored otherwise.
23126 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23129 * Get the value of event enabled status.
23131 * @see elm_transit_event_enabled_set()
23133 * @param transit The Transit object
23134 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
23135 * EINA_FALSE is returned
23139 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23142 * Set the user-callback function when the transit is deleted.
23144 * @note Using this function twice will overwrite the first function setted.
23145 * @note the @p transit object will be deleted after call @p cb function.
23147 * @param transit The transit object.
23148 * @param cb Callback function pointer. This function will be called before
23149 * the deletion of the transit.
23150 * @param data Callback funtion user data. It is the @p op parameter.
23154 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
23157 * Set reverse effect automatically.
23159 * If auto reverse is setted, after running the effects with the progress
23160 * parameter from 0 to 1, it will call the effecs again with the progress
23161 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
23162 * where the duration was setted with the function elm_transit_add and
23163 * the repeat with the function elm_transit_repeat_times_set().
23165 * @param transit The transit object.
23166 * @param reverse EINA_TRUE means the auto_reverse is on.
23170 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
23173 * Get if the auto reverse is on.
23175 * @see elm_transit_auto_reverse_set()
23177 * @param transit The transit object.
23178 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
23179 * EINA_FALSE is returned
23183 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23186 * Set the transit repeat count. Effect will be repeated by repeat count.
23188 * This function sets the number of repetition the transit will run after
23189 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
23190 * If the @p repeat is a negative number, it will repeat infinite times.
23192 * @note If this function is called during the transit execution, the transit
23193 * will run @p repeat times, ignoring the times it already performed.
23195 * @param transit The transit object
23196 * @param repeat Repeat count
23200 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
23203 * Get the transit repeat count.
23205 * @see elm_transit_repeat_times_set()
23207 * @param transit The Transit object.
23208 * @return The repeat count. If @p transit is NULL
23213 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23216 * Set the transit animation acceleration type.
23218 * This function sets the tween mode of the transit that can be:
23219 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
23220 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
23221 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
23222 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
23224 * @param transit The transit object.
23225 * @param tween_mode The tween type.
23229 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
23232 * Get the transit animation acceleration type.
23234 * @note @p transit can not be NULL
23236 * @param transit The transit object.
23237 * @return The tween type. If @p transit is NULL
23238 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
23242 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23245 * Set the transit animation time
23247 * @note @p transit can not be NULL
23249 * @param transit The transit object.
23250 * @param duration The animation time.
23254 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
23257 * Get the transit animation time
23259 * @note @p transit can not be NULL
23261 * @param transit The transit object.
23263 * @return The transit animation time.
23267 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23270 * Starts the transition.
23271 * Once this API is called, the transit begins to measure the time.
23273 * @note @p transit can not be NULL
23275 * @param transit The transit object.
23279 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
23282 * Pause/Resume the transition.
23284 * If you call elm_transit_go again, the transit will be started from the
23285 * beginning, and will be unpaused.
23287 * @note @p transit can not be NULL
23289 * @param transit The transit object.
23290 * @param paused Whether the transition should be paused or not.
23294 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
23297 * Get the value of paused status.
23299 * @see elm_transit_paused_set()
23301 * @note @p transit can not be NULL
23303 * @param transit The transit object.
23304 * @return EINA_TRUE means transition is paused. If @p transit is NULL
23305 * EINA_FALSE is returned
23309 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23312 * Get the time progression of the animation (a double value between 0.0 and 1.0).
23314 * The value returned is a fraction (current time / total time). It
23315 * represents the progression position relative to the total.
23317 * @note @p transit can not be NULL
23319 * @param transit The transit object.
23321 * @return The time progression value. If @p transit is NULL
23326 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
23329 * Makes the chain relationship between two transits.
23331 * @note @p transit can not be NULL. Transit would have multiple chain transits.
23332 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
23334 * @param transit The transit object.
23335 * @param chain_transit The chain transit object. This transit will be operated
23336 * after transit is done.
23338 * This function adds @p chain_transit transition to a chain after the @p
23339 * transit, and will be started as soon as @p transit ends. See @ref
23340 * transit_example_02_explained for a full example.
23344 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
23347 * Cut off the chain relationship between two transits.
23349 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
23350 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
23352 * @param transit The transit object.
23353 * @param chain_transit The chain transit object.
23355 * This function remove the @p chain_transit transition from the @p transit.
23359 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
23362 * Get the current chain transit list.
23364 * @note @p transit can not be NULL.
23366 * @param transit The transit object.
23367 * @return chain transit list.
23371 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
23374 * Add the Resizing Effect to Elm_Transit.
23376 * @note This API is one of the facades. It creates resizing effect context
23377 * and add it's required APIs to elm_transit_effect_add.
23379 * @see elm_transit_effect_add()
23381 * @param transit Transit object.
23382 * @param from_w Object width size when effect begins.
23383 * @param from_h Object height size when effect begins.
23384 * @param to_w Object width size when effect ends.
23385 * @param to_h Object height size when effect ends.
23386 * @return Resizing effect context data.
23390 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);
23393 * Add the Translation Effect to Elm_Transit.
23395 * @note This API is one of the facades. It creates translation effect context
23396 * and add it's required APIs to elm_transit_effect_add.
23398 * @see elm_transit_effect_add()
23400 * @param transit Transit object.
23401 * @param from_dx X Position variation when effect begins.
23402 * @param from_dy Y Position variation when effect begins.
23403 * @param to_dx X Position variation when effect ends.
23404 * @param to_dy Y Position variation when effect ends.
23405 * @return Translation effect context data.
23408 * @warning It is highly recommended just create a transit with this effect when
23409 * the window that the objects of the transit belongs has already been created.
23410 * This is because this effect needs the geometry information about the objects,
23411 * and if the window was not created yet, it can get a wrong information.
23413 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);
23416 * Add the Zoom Effect to Elm_Transit.
23418 * @note This API is one of the facades. It creates zoom effect context
23419 * and add it's required APIs to elm_transit_effect_add.
23421 * @see elm_transit_effect_add()
23423 * @param transit Transit object.
23424 * @param from_rate Scale rate when effect begins (1 is current rate).
23425 * @param to_rate Scale rate when effect ends.
23426 * @return Zoom effect context data.
23429 * @warning It is highly recommended just create a transit with this effect when
23430 * the window that the objects of the transit belongs has already been created.
23431 * This is because this effect needs the geometry information about the objects,
23432 * and if the window was not created yet, it can get a wrong information.
23434 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
23437 * Add the Flip Effect to Elm_Transit.
23439 * @note This API is one of the facades. It creates flip effect context
23440 * and add it's required APIs to elm_transit_effect_add.
23441 * @note This effect is applied to each pair of objects in the order they are listed
23442 * in the transit list of objects. The first object in the pair will be the
23443 * "front" object and the second will be the "back" object.
23445 * @see elm_transit_effect_add()
23447 * @param transit Transit object.
23448 * @param axis Flipping Axis(X or Y).
23449 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23450 * @return Flip effect context data.
23453 * @warning It is highly recommended just create a transit with this effect when
23454 * the window that the objects of the transit belongs has already been created.
23455 * This is because this effect needs the geometry information about the objects,
23456 * and if the window was not created yet, it can get a wrong information.
23458 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23461 * Add the Resizable Flip Effect to Elm_Transit.
23463 * @note This API is one of the facades. It creates resizable flip effect context
23464 * and add it's required APIs to elm_transit_effect_add.
23465 * @note This effect is applied to each pair of objects in the order they are listed
23466 * in the transit list of objects. The first object in the pair will be the
23467 * "front" object and the second will be the "back" object.
23469 * @see elm_transit_effect_add()
23471 * @param transit Transit object.
23472 * @param axis Flipping Axis(X or Y).
23473 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
23474 * @return Resizable flip effect context data.
23477 * @warning It is highly recommended just create a transit with this effect when
23478 * the window that the objects of the transit belongs has already been created.
23479 * This is because this effect needs the geometry information about the objects,
23480 * and if the window was not created yet, it can get a wrong information.
23482 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
23485 * Add the Wipe Effect to Elm_Transit.
23487 * @note This API is one of the facades. It creates wipe effect context
23488 * and add it's required APIs to elm_transit_effect_add.
23490 * @see elm_transit_effect_add()
23492 * @param transit Transit object.
23493 * @param type Wipe type. Hide or show.
23494 * @param dir Wipe Direction.
23495 * @return Wipe effect context data.
23498 * @warning It is highly recommended just create a transit with this effect when
23499 * the window that the objects of the transit belongs has already been created.
23500 * This is because this effect needs the geometry information about the objects,
23501 * and if the window was not created yet, it can get a wrong information.
23503 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
23506 * Add the Color Effect to Elm_Transit.
23508 * @note This API is one of the facades. It creates color effect context
23509 * and add it's required APIs to elm_transit_effect_add.
23511 * @see elm_transit_effect_add()
23513 * @param transit Transit object.
23514 * @param from_r RGB R when effect begins.
23515 * @param from_g RGB G when effect begins.
23516 * @param from_b RGB B when effect begins.
23517 * @param from_a RGB A when effect begins.
23518 * @param to_r RGB R when effect ends.
23519 * @param to_g RGB G when effect ends.
23520 * @param to_b RGB B when effect ends.
23521 * @param to_a RGB A when effect ends.
23522 * @return Color effect context data.
23526 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);
23529 * Add the Fade Effect to Elm_Transit.
23531 * @note This API is one of the facades. It creates fade effect context
23532 * and add it's required APIs to elm_transit_effect_add.
23533 * @note This effect is applied to each pair of objects in the order they are listed
23534 * in the transit list of objects. The first object in the pair will be the
23535 * "before" object and the second will be the "after" object.
23537 * @see elm_transit_effect_add()
23539 * @param transit Transit object.
23540 * @return Fade effect context data.
23543 * @warning It is highly recommended just create a transit with this effect when
23544 * the window that the objects of the transit belongs has already been created.
23545 * This is because this effect needs the color information about the objects,
23546 * and if the window was not created yet, it can get a wrong information.
23548 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
23551 * Add the Blend Effect to Elm_Transit.
23553 * @note This API is one of the facades. It creates blend effect context
23554 * and add it's required APIs to elm_transit_effect_add.
23555 * @note This effect is applied to each pair of objects in the order they are listed
23556 * in the transit list of objects. The first object in the pair will be the
23557 * "before" object and the second will be the "after" object.
23559 * @see elm_transit_effect_add()
23561 * @param transit Transit object.
23562 * @return Blend effect context data.
23565 * @warning It is highly recommended just create a transit with this effect when
23566 * the window that the objects of the transit belongs has already been created.
23567 * This is because this effect needs the color information about the objects,
23568 * and if the window was not created yet, it can get a wrong information.
23570 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
23573 * Add the Rotation Effect to Elm_Transit.
23575 * @note This API is one of the facades. It creates rotation effect context
23576 * and add it's required APIs to elm_transit_effect_add.
23578 * @see elm_transit_effect_add()
23580 * @param transit Transit object.
23581 * @param from_degree Degree when effect begins.
23582 * @param to_degree Degree when effect is ends.
23583 * @return Rotation effect context data.
23586 * @warning It is highly recommended just create a transit with this effect when
23587 * the window that the objects of the transit belongs has already been created.
23588 * This is because this effect needs the geometry information about the objects,
23589 * and if the window was not created yet, it can get a wrong information.
23591 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
23594 * Add the ImageAnimation Effect to Elm_Transit.
23596 * @note This API is one of the facades. It creates image animation effect context
23597 * and add it's required APIs to elm_transit_effect_add.
23598 * The @p images parameter is a list images paths. This list and
23599 * its contents will be deleted at the end of the effect by
23600 * elm_transit_effect_image_animation_context_free() function.
23604 * char buf[PATH_MAX];
23605 * Eina_List *images = NULL;
23606 * Elm_Transit *transi = elm_transit_add();
23608 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
23609 * images = eina_list_append(images, eina_stringshare_add(buf));
23611 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
23612 * images = eina_list_append(images, eina_stringshare_add(buf));
23613 * elm_transit_effect_image_animation_add(transi, images);
23617 * @see elm_transit_effect_add()
23619 * @param transit Transit object.
23620 * @param images Eina_List of images file paths. This list and
23621 * its contents will be deleted at the end of the effect by
23622 * elm_transit_effect_image_animation_context_free() function.
23623 * @return Image Animation effect context data.
23627 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
23632 typedef struct _Elm_Store Elm_Store;
23633 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
23634 typedef struct _Elm_Store_Item Elm_Store_Item;
23635 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
23636 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
23637 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
23638 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
23639 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
23640 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
23641 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
23642 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
23644 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
23645 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
23646 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
23647 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
23651 ELM_STORE_ITEM_MAPPING_NONE = 0,
23652 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
23653 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
23654 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
23655 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
23656 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
23657 // can add more here as needed by common apps
23658 ELM_STORE_ITEM_MAPPING_LAST
23659 } Elm_Store_Item_Mapping_Type;
23661 struct _Elm_Store_Item_Mapping_Icon
23663 // FIXME: allow edje file icons
23665 Elm_Icon_Lookup_Order lookup_order;
23666 Eina_Bool standard_name : 1;
23667 Eina_Bool no_scale : 1;
23668 Eina_Bool smooth : 1;
23669 Eina_Bool scale_up : 1;
23670 Eina_Bool scale_down : 1;
23673 struct _Elm_Store_Item_Mapping_Empty
23678 struct _Elm_Store_Item_Mapping_Photo
23683 struct _Elm_Store_Item_Mapping_Custom
23685 Elm_Store_Item_Mapping_Cb func;
23688 struct _Elm_Store_Item_Mapping
23690 Elm_Store_Item_Mapping_Type type;
23695 Elm_Store_Item_Mapping_Empty empty;
23696 Elm_Store_Item_Mapping_Icon icon;
23697 Elm_Store_Item_Mapping_Photo photo;
23698 Elm_Store_Item_Mapping_Custom custom;
23699 // add more types here
23703 struct _Elm_Store_Item_Info
23705 Elm_Genlist_Item_Class *item_class;
23706 const Elm_Store_Item_Mapping *mapping;
23711 struct _Elm_Store_Item_Info_Filesystem
23713 Elm_Store_Item_Info base;
23717 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
23718 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
23720 EAPI void elm_store_free(Elm_Store *st);
23722 EAPI Elm_Store *elm_store_filesystem_new(void);
23723 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
23724 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23725 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23727 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
23729 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
23730 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23731 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23732 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23733 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
23734 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23736 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
23737 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
23738 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
23739 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
23740 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23741 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23742 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
23745 * @defgroup SegmentControl SegmentControl
23746 * @ingroup Elementary
23748 * @image html img/widget/segment_control/preview-00.png
23749 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
23751 * @image html img/segment_control.png
23752 * @image latex img/segment_control.eps width=\textwidth
23754 * Segment control widget is a horizontal control made of multiple segment
23755 * items, each segment item functioning similar to discrete two state button.
23756 * A segment control groups the items together and provides compact
23757 * single button with multiple equal size segments.
23759 * Segment item size is determined by base widget
23760 * size and the number of items added.
23761 * Only one segment item can be at selected state. A segment item can display
23762 * combination of Text and any Evas_Object like Images or other widget.
23764 * Smart callbacks one can listen to:
23765 * - "changed" - When the user clicks on a segment item which is not
23766 * previously selected and get selected. The event_info parameter is the
23767 * segment item index.
23769 * Available styles for it:
23772 * Here is an example on its usage:
23773 * @li @ref segment_control_example
23777 * @addtogroup SegmentControl
23781 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
23784 * Add a new segment control widget to the given parent Elementary
23785 * (container) object.
23787 * @param parent The parent object.
23788 * @return a new segment control widget handle or @c NULL, on errors.
23790 * This function inserts a new segment control widget on the canvas.
23792 * @ingroup SegmentControl
23794 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23797 * Append a new item to the segment control object.
23799 * @param obj The segment control object.
23800 * @param icon The icon object to use for the left side of the item. An
23801 * icon can be any Evas object, but usually it is an icon created
23802 * with elm_icon_add().
23803 * @param label The label of the item.
23804 * Note that, NULL is different from empty string "".
23805 * @return The created item or @c NULL upon failure.
23807 * A new item will be created and appended to the segment control, i.e., will
23808 * be set as @b last item.
23810 * If it should be inserted at another position,
23811 * elm_segment_control_item_insert_at() should be used instead.
23813 * Items created with this function can be deleted with function
23814 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23816 * @note @p label set to @c NULL is different from empty string "".
23818 * only has icon, it will be displayed bigger and centered. If it has
23819 * icon and label, even that an empty string, icon will be smaller and
23820 * positioned at left.
23824 * sc = elm_segment_control_add(win);
23825 * ic = elm_icon_add(win);
23826 * elm_icon_file_set(ic, "path/to/image", NULL);
23827 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23828 * elm_segment_control_item_add(sc, ic, "label");
23829 * evas_object_show(sc);
23832 * @see elm_segment_control_item_insert_at()
23833 * @see elm_segment_control_item_del()
23835 * @ingroup SegmentControl
23837 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
23840 * Insert a new item to the segment control object at specified position.
23842 * @param obj The segment control object.
23843 * @param icon The icon object to use for the left side of the item. An
23844 * icon can be any Evas object, but usually it is an icon created
23845 * with elm_icon_add().
23846 * @param label The label of the item.
23847 * @param index Item position. Value should be between 0 and items count.
23848 * @return The created item or @c NULL upon failure.
23850 * Index values must be between @c 0, when item will be prepended to
23851 * segment control, and items count, that can be get with
23852 * elm_segment_control_item_count_get(), case when item will be appended
23853 * to segment control, just like elm_segment_control_item_add().
23855 * Items created with this function can be deleted with function
23856 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
23858 * @note @p label set to @c NULL is different from empty string "".
23860 * only has icon, it will be displayed bigger and centered. If it has
23861 * icon and label, even that an empty string, icon will be smaller and
23862 * positioned at left.
23864 * @see elm_segment_control_item_add()
23865 * @see elm_segment_control_count_get()
23866 * @see elm_segment_control_item_del()
23868 * @ingroup SegmentControl
23870 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);
23873 * Remove a segment control item from its parent, deleting it.
23875 * @param it The item to be removed.
23877 * Items can be added with elm_segment_control_item_add() or
23878 * elm_segment_control_item_insert_at().
23880 * @ingroup SegmentControl
23882 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
23885 * Remove a segment control item at given index from its parent,
23888 * @param obj The segment control object.
23889 * @param index The position of the segment control item to be deleted.
23891 * Items can be added with elm_segment_control_item_add() or
23892 * elm_segment_control_item_insert_at().
23894 * @ingroup SegmentControl
23896 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23899 * Get the Segment items count from segment control.
23901 * @param obj The segment control object.
23902 * @return Segment items count.
23904 * It will just return the number of items added to segment control @p obj.
23906 * @ingroup SegmentControl
23908 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23911 * Get the item placed at specified index.
23913 * @param obj The segment control object.
23914 * @param index The index of the segment item.
23915 * @return The segment control item or @c NULL on failure.
23917 * Index is the position of an item in segment control widget. Its
23918 * range is from @c 0 to <tt> count - 1 </tt>.
23919 * Count is the number of items, that can be get with
23920 * elm_segment_control_item_count_get().
23922 * @ingroup SegmentControl
23924 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23927 * Get the label of item.
23929 * @param obj The segment control object.
23930 * @param index The index of the segment item.
23931 * @return The label of the item at @p index.
23933 * The return value is a pointer to the label associated to the item when
23934 * it was created, with function elm_segment_control_item_add(), or later
23935 * with function elm_segment_control_item_label_set. If no label
23936 * was passed as argument, it will return @c NULL.
23938 * @see elm_segment_control_item_label_set() for more details.
23939 * @see elm_segment_control_item_add()
23941 * @ingroup SegmentControl
23943 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23946 * Set the label of item.
23948 * @param it The item of segment control.
23949 * @param text The label of item.
23951 * The label to be displayed by the item.
23952 * Label will be at right of the icon (if set).
23954 * If a label was passed as argument on item creation, with function
23955 * elm_control_segment_item_add(), it will be already
23956 * displayed by the item.
23958 * @see elm_segment_control_item_label_get()
23959 * @see elm_segment_control_item_add()
23961 * @ingroup SegmentControl
23963 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
23966 * Get the icon associated to the item.
23968 * @param obj The segment control object.
23969 * @param index The index of the segment item.
23970 * @return The left side icon associated to the item at @p index.
23972 * The return value is a pointer to the icon associated to the item when
23973 * it was created, with function elm_segment_control_item_add(), or later
23974 * with function elm_segment_control_item_icon_set(). If no icon
23975 * was passed as argument, it will return @c NULL.
23977 * @see elm_segment_control_item_add()
23978 * @see elm_segment_control_item_icon_set()
23980 * @ingroup SegmentControl
23982 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
23985 * Set the icon associated to the item.
23987 * @param it The segment control item.
23988 * @param icon The icon object to associate with @p it.
23990 * The icon object to use at left side of the item. An
23991 * icon can be any Evas object, but usually it is an icon created
23992 * with elm_icon_add().
23994 * Once the icon object is set, a previously set one will be deleted.
23995 * @warning Setting the same icon for two items will cause the icon to
23996 * dissapear from the first item.
23998 * If an icon was passed as argument on item creation, with function
23999 * elm_segment_control_item_add(), it will be already
24000 * associated to the item.
24002 * @see elm_segment_control_item_add()
24003 * @see elm_segment_control_item_icon_get()
24005 * @ingroup SegmentControl
24007 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24010 * Get the index of an item.
24012 * @param it The segment control item.
24013 * @return The position of item in segment control widget.
24015 * Index is the position of an item in segment control widget. Its
24016 * range is from @c 0 to <tt> count - 1 </tt>.
24017 * Count is the number of items, that can be get with
24018 * elm_segment_control_item_count_get().
24020 * @ingroup SegmentControl
24022 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24025 * Get the base object of the item.
24027 * @param it The segment control item.
24028 * @return The base object associated with @p it.
24030 * Base object is the @c Evas_Object that represents that item.
24032 * @ingroup SegmentControl
24034 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
24037 * Get the selected item.
24039 * @param obj The segment control object.
24040 * @return The selected item or @c NULL if none of segment items is
24043 * The selected item can be unselected with function
24044 * elm_segment_control_item_selected_set().
24046 * The selected item always will be highlighted on segment control.
24048 * @ingroup SegmentControl
24050 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24053 * Set the selected state of an item.
24055 * @param it The segment control item
24056 * @param select The selected state
24058 * This sets the selected state of the given item @p it.
24059 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24061 * If a new item is selected the previosly selected will be unselected.
24062 * Previoulsy selected item can be get with function
24063 * elm_segment_control_item_selected_get().
24065 * The selected item always will be highlighted on segment control.
24067 * @see elm_segment_control_item_selected_get()
24069 * @ingroup SegmentControl
24071 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
24078 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
24079 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
24080 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
24081 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
24082 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
24083 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
24084 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
24085 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
24088 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
24089 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
24090 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
24092 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
24093 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
24094 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
24095 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
24096 EAPI void elm_video_play(Evas_Object *video);
24097 EAPI void elm_video_pause(Evas_Object *video);
24098 EAPI void elm_video_stop(Evas_Object *video);
24099 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
24100 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
24101 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
24102 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
24103 EAPI double elm_video_audio_level_get(Evas_Object *video);
24104 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
24105 EAPI double elm_video_play_position_get(Evas_Object *video);
24106 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
24107 EAPI double elm_video_play_length_get(Evas_Object *video);
24108 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
24109 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
24110 EAPI const char *elm_video_title_get(Evas_Object *video);
24112 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
24113 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
24116 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24117 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);
24118 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
24119 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
24120 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24121 EAPI void elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24122 EAPI const char *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24123 EAPI void elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24124 EAPI const char *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24125 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24126 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24127 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
24128 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24129 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
24130 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);